Skip to content

Commit 742a8c7

Browse files
metatablecatIgnisRBXrbxphogen
authored
Update documentation for GetWaveformAsync (#1158)
## Changes These are both live but it looks like the documentation was never filled in for them. ## Checks By submitting your pull request for review, you agree to the following: - [x] This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses. - [x] I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses. - [x] To the best of my knowledge, all proposed changes are accurate. --------- Co-authored-by: IgnisRBX <[email protected]> Co-authored-by: rbxphogen <[email protected]>
1 parent 22370bf commit 742a8c7

File tree

2 files changed

+24
-12
lines changed

2 files changed

+24
-12
lines changed

content/en-us/reference/engine/classes/AudioPlayer.yaml

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -444,18 +444,24 @@ methods:
444444
- Audio
445445
writeCapabilities: []
446446
- name: AudioPlayer:GetWaveformAsync
447-
summary: ''
448-
description: ''
447+
summary: |
448+
Returns a list of samples across a time range for the given audio.
449+
description: |
450+
Returns a list of samples across a time range for the given audio. Each call can return up to 8192
451+
samples.
449452
code_samples: []
450453
parameters:
451454
- name: timeRange
452455
type: NumberRange
453-
default:
454-
summary: ''
456+
default:
457+
summary: |
458+
A `DataType.NumberRange` which represents the start and end point of where
459+
to sample the audio.
455460
- name: samples
456461
type: int
457-
default: ''
458-
summary: ''
462+
default:
463+
summary: |
464+
The number of samples to return.
459465
returns:
460466
- type: Array
461467
summary: ''

content/en-us/reference/engine/classes/AudioTextToSpeech.yaml

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -350,18 +350,24 @@ methods:
350350
- Audio
351351
writeCapabilities: []
352352
- name: AudioTextToSpeech:GetWaveformAsync
353-
summary: ''
354-
description: ''
353+
summary: |
354+
Returns a list of samples across a time range for the given audio.
355+
description: |
356+
Returns a list of samples across a time range for the given audio. Each call can return up to 8192
357+
samples.
355358
code_samples: []
356359
parameters:
357360
- name: timeRange
358361
type: NumberRange
359-
default:
360-
summary: ''
362+
default:
363+
summary: |
364+
A `DataType.NumberRange` which represents the start and end point of where
365+
to sample the audio.
361366
- name: samples
362367
type: int
363-
default: ''
364-
summary: ''
368+
default:
369+
summary: |
370+
The number of samples to return.
365371
returns:
366372
- type: Array
367373
summary: ''

0 commit comments

Comments
 (0)