Skip to content

Update documentation for GetWaveformAsync #1158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 16, 2025
Merged

Update documentation for GetWaveformAsync #1158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b077679
Update AudioPlayer.yaml
metatablecat Jul 16, 2025
fd90c04
Update AudioTextToSpeech.yaml
metatablecat Jul 16, 2025
d553542
Fix Default parameters
metatablecat Jul 16, 2025
bf3bfc3
Update content/en-us/reference/engine/classes/AudioPlayer.yaml
IgnisRBX Jul 16, 2025
2ccaefc
Update content/en-us/reference/engine/classes/AudioTextToSpeech.yaml
IgnisRBX Jul 16, 2025
62c6a97
Apply suggestions from code review
IgnisRBX Jul 16, 2025
c26ae15
Update content/en-us/reference/engine/classes/AudioTextToSpeech.yaml
IgnisRBX Jul 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions content/en-us/reference/engine/classes/AudioPlayer.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,18 +444,24 @@ methods:
- Audio
writeCapabilities: []
- name: AudioPlayer:GetWaveformAsync
summary: ''
description: ''
summary: |
Returns a list of samples across a time range for the given audio.
description: |
Returns a list of samples across a time range for the given audio. Each call can return up to 8192
samples.
code_samples: []
parameters:
- name: timeRange
type: NumberRange
default:
summary: ''
default:
summary: |
A `DataType.NumberRange` which represents the start and end point of where
to sample the audio.
- name: samples
type: int
default: ''
summary: ''
default:
summary: |
The number of samples to return.
returns:
- type: Array
summary: ''
Expand Down
18 changes: 12 additions & 6 deletions content/en-us/reference/engine/classes/AudioTextToSpeech.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,18 +350,24 @@ methods:
- Audio
writeCapabilities: []
- name: AudioTextToSpeech:GetWaveformAsync
summary: ''
description: ''
summary: |
Returns a list of samples across a time range for the given audio.
description: |
Returns a list of samples across a time range for the given audio. Each call can return up to 8192
samples.
code_samples: []
parameters:
- name: timeRange
type: NumberRange
default:
summary: ''
default:
summary: |
A `DataType.NumberRange` which represents the start and end point of where
to sample the audio.
- name: samples
type: int
default: ''
summary: ''
default:
summary: |
The number of samples to return.
returns:
- type: Array
summary: ''
Expand Down
Loading