From b07767927b654da6c9bd27eef1452987e4c57247 Mon Sep 17 00:00:00 2001 From: T 'Filtered' C <132796135+metatablecat@users.noreply.github.com> Date: Wed, 16 Jul 2025 17:56:31 +0100 Subject: [PATCH 1/7] Update AudioPlayer.yaml --- .../reference/engine/classes/AudioPlayer.yaml | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/content/en-us/reference/engine/classes/AudioPlayer.yaml b/content/en-us/reference/engine/classes/AudioPlayer.yaml index b390452e2..6aaae7480 100644 --- a/content/en-us/reference/engine/classes/AudioPlayer.yaml +++ b/content/en-us/reference/engine/classes/AudioPlayer.yaml @@ -444,18 +444,23 @@ 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 8000 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: '' + summary: 'The number of samples to return.' returns: - type: Array summary: '' From fd90c04ffce78eb7b0d2ec45b3bec2341cc9778a Mon Sep 17 00:00:00 2001 From: T 'Filtered' C <132796135+metatablecat@users.noreply.github.com> Date: Wed, 16 Jul 2025 17:57:53 +0100 Subject: [PATCH 2/7] Update AudioTextToSpeech.yaml --- .../engine/classes/AudioTextToSpeech.yaml | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml b/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml index 8bfb90e2a..f663913ac 100644 --- a/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml +++ b/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml @@ -350,18 +350,23 @@ 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 8000 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: '' + summary: 'The number of samples to return.' returns: - type: Array summary: '' From d553542d8a7e82395038a64e5899f96ed851b34b Mon Sep 17 00:00:00 2001 From: T 'Filtered' C <132796135+metatablecat@users.noreply.github.com> Date: Wed, 16 Jul 2025 20:49:52 +0100 Subject: [PATCH 3/7] Fix Default parameters --- content/en-us/reference/engine/classes/AudioPlayer.yaml | 4 ++-- content/en-us/reference/engine/classes/AudioTextToSpeech.yaml | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/en-us/reference/engine/classes/AudioPlayer.yaml b/content/en-us/reference/engine/classes/AudioPlayer.yaml index 6aaae7480..e9d46b918 100644 --- a/content/en-us/reference/engine/classes/AudioPlayer.yaml +++ b/content/en-us/reference/engine/classes/AudioPlayer.yaml @@ -453,13 +453,13 @@ methods: parameters: - name: timeRange type: NumberRange - default: '' + default: summary: | A `DataType.NumberRange` which represents the start and end point of where to sample the audio. - name: samples type: int - default: '' + default: summary: 'The number of samples to return.' returns: - type: Array diff --git a/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml b/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml index f663913ac..deb033cb4 100644 --- a/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml +++ b/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml @@ -359,13 +359,13 @@ methods: parameters: - name: timeRange type: NumberRange - default: '' + default: summary: | A `DataType.NumberRange` which represents the start and end point of where to sample the audio. - name: samples type: int - default: '' + default: summary: 'The number of samples to return.' returns: - type: Array From bf3bfc33f6a764a6de8109ba8dfac10af24f8759 Mon Sep 17 00:00:00 2001 From: IgnisRBX <43388550+IgnisRBX@users.noreply.github.com> Date: Wed, 16 Jul 2025 14:18:08 -0700 Subject: [PATCH 4/7] Update content/en-us/reference/engine/classes/AudioPlayer.yaml Co-authored-by: rbxphogen <89100144+rbxphogen@users.noreply.github.com> --- content/en-us/reference/engine/classes/AudioPlayer.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioPlayer.yaml b/content/en-us/reference/engine/classes/AudioPlayer.yaml index e9d46b918..5db2f5c64 100644 --- a/content/en-us/reference/engine/classes/AudioPlayer.yaml +++ b/content/en-us/reference/engine/classes/AudioPlayer.yaml @@ -448,7 +448,7 @@ methods: description: | Returns a list of samples across a time range for the given audio. - Each call can return up to 8000 samples. + Each call can return up to 8192 samples. code_samples: [] parameters: - name: timeRange From 2ccaefcb46bd040f626f127de815d43926dd46a6 Mon Sep 17 00:00:00 2001 From: IgnisRBX <43388550+IgnisRBX@users.noreply.github.com> Date: Wed, 16 Jul 2025 14:18:14 -0700 Subject: [PATCH 5/7] Update content/en-us/reference/engine/classes/AudioTextToSpeech.yaml Co-authored-by: rbxphogen <89100144+rbxphogen@users.noreply.github.com> --- content/en-us/reference/engine/classes/AudioTextToSpeech.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml b/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml index deb033cb4..0b74042de 100644 --- a/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml +++ b/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml @@ -354,7 +354,7 @@ methods: description: | Returns a list of samples across a time range for the given audio. - Each call can return up to 8000 samples. + Each call can return up to 8192 samples. code_samples: [] parameters: - name: timeRange From 62c6a97df49c9fa1495f465ca94fdedeb9780313 Mon Sep 17 00:00:00 2001 From: IgnisRBX <43388550+IgnisRBX@users.noreply.github.com> Date: Wed, 16 Jul 2025 14:20:35 -0700 Subject: [PATCH 6/7] Apply suggestions from code review --- .../en-us/reference/engine/classes/AudioPlayer.yaml | 11 ++++++----- .../reference/engine/classes/AudioTextToSpeech.yaml | 8 ++++---- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/content/en-us/reference/engine/classes/AudioPlayer.yaml b/content/en-us/reference/engine/classes/AudioPlayer.yaml index 5db2f5c64..3d4722a39 100644 --- a/content/en-us/reference/engine/classes/AudioPlayer.yaml +++ b/content/en-us/reference/engine/classes/AudioPlayer.yaml @@ -444,11 +444,11 @@ methods: - Audio writeCapabilities: [] - name: AudioPlayer:GetWaveformAsync - summary: 'Returns a list of samples across a time range for the given audio.' - description: | + summary: | Returns a list of samples across a time range for the given audio. - - Each call can return up to 8192 samples. + 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 @@ -460,7 +460,8 @@ methods: - name: samples type: int default: - summary: 'The number of samples to return.' + summary: | + The number of samples to return. returns: - type: Array summary: '' diff --git a/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml b/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml index 0b74042de..a6d50d917 100644 --- a/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml +++ b/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml @@ -352,9 +352,8 @@ methods: - name: AudioTextToSpeech:GetWaveformAsync 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. + 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 @@ -366,7 +365,8 @@ methods: - name: samples type: int default: - summary: 'The number of samples to return.' + summary: | + The number of samples to return. returns: - type: Array summary: '' From c26ae15e9ad34c675592105ef109b0adbc2ebb0b Mon Sep 17 00:00:00 2001 From: IgnisRBX <43388550+IgnisRBX@users.noreply.github.com> Date: Wed, 16 Jul 2025 14:21:14 -0700 Subject: [PATCH 7/7] Update content/en-us/reference/engine/classes/AudioTextToSpeech.yaml --- content/en-us/reference/engine/classes/AudioTextToSpeech.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml b/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml index a6d50d917..e656d31d1 100644 --- a/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml +++ b/content/en-us/reference/engine/classes/AudioTextToSpeech.yaml @@ -350,7 +350,8 @@ methods: - Audio writeCapabilities: [] - name: AudioTextToSpeech:GetWaveformAsync - summary: 'Returns a list of samples across a time range for the given audio.' + 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.