From afd49166424b310613b50f289c20883f0d0fcadd Mon Sep 17 00:00:00 2001 From: karl-police Date: Wed, 14 May 2025 00:09:34 +0200 Subject: [PATCH 1/8] Add AudioRecorder descriptions --- .../engine/classes/AudioRecorder.yaml | 40 ++++++++++++++----- 1 file changed, 30 insertions(+), 10 deletions(-) diff --git a/content/en-us/reference/engine/classes/AudioRecorder.yaml b/content/en-us/reference/engine/classes/AudioRecorder.yaml index 0c24bc7c7..d6c3c3700 100644 --- a/content/en-us/reference/engine/classes/AudioRecorder.yaml +++ b/content/en-us/reference/engine/classes/AudioRecorder.yaml @@ -1,8 +1,19 @@ name: AudioRecorder type: class memory_category: Internal -summary: '' -description: '' +summary: | + Record audio streams in-experience. +description: | + The **AudioRecorder** can be used to record audio streams in-experience. + The results can be loaded back into an `Class.AudioPlayer|AudioPlayer` for playback. + + There's a fixed time limit on how long a recording can be, which is **`60` seconds**. + + The recordings from the `Class.AudioRecorder|AudioRecorder` have a sample rate of 96 kHz and the format `f32le`. + + At the moment `Class.AudioDeviceInput|AudioDeviceInput` can not be recorded. + The method `Class.AudioRecorder.GetUnrecordableInstancesAsync()|GetUnrecordableInstancesAsync()` can be used + to check specifically which instances aren't recordable. code_samples: [] inherits: - Instance @@ -12,7 +23,8 @@ deprecation_message: '' properties: - name: AudioRecorder.IsRecording summary: '' - description: '' + description: | + Returns whether the `Class.AudioRecorder|AudioRecorder` is currently recording. code_samples: [] type: boolean tags: [] @@ -30,7 +42,8 @@ properties: writeCapabilities: [] - name: AudioRecorder.TimeLength summary: '' - description: '' + description: | + Returns the current length of the recording. code_samples: [] type: double tags: @@ -51,7 +64,8 @@ properties: methods: - name: AudioRecorder:Clear summary: '' - description: '' + description: | + Clears out the recording from the `Class.AudioRecorder|AudioRecorder`. code_samples: [] parameters: [] returns: @@ -115,7 +129,8 @@ methods: writeCapabilities: [] - name: AudioRecorder:GetTemporaryContent summary: '' - description: '' + description: | + Returns recorded content that can be played back with `Class.AudioPlayer|AudioPlayer`. code_samples: [] parameters: [] returns: @@ -130,7 +145,8 @@ methods: writeCapabilities: [] - name: AudioRecorder:Stop summary: '' - description: '' + description: | + Stops recording. code_samples: [] parameters: [] returns: @@ -145,7 +161,9 @@ methods: writeCapabilities: [] - name: AudioRecorder:CanRecordAsync summary: '' - description: '' + description: | + Returns whether the `Class.AudioRecorder|AudioRecorder` can currently record. For instance, this will return `false` + if the current recording data has reached the recording time limit. To clear the recording use `Class.AudioRecorder:Clear()|:Clear()` code_samples: [] parameters: [] returns: @@ -161,7 +179,8 @@ methods: writeCapabilities: [] - name: AudioRecorder:GetUnrecordableInstancesAsync summary: '' - description: '' + description: | + A method that traverses the audio graph to find unrecordable instances. code_samples: [] parameters: [] returns: @@ -177,7 +196,8 @@ methods: writeCapabilities: [] - name: AudioRecorder:RecordAsync summary: '' - description: '' + description: | + Starts recording. code_samples: [] parameters: [] returns: From b87d11a1f1dd8d4f4e6f34a8c47d88fca9e1f99c Mon Sep 17 00:00:00 2001 From: IgnisRBX <43388550+IgnisRBX@users.noreply.github.com> Date: Wed, 14 May 2025 07:58:23 -1000 Subject: [PATCH 2/8] Update content/en-us/reference/engine/classes/AudioRecorder.yaml Co-authored-by: rbxphogen <89100144+rbxphogen@users.noreply.github.com> --- content/en-us/reference/engine/classes/AudioRecorder.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioRecorder.yaml b/content/en-us/reference/engine/classes/AudioRecorder.yaml index d6c3c3700..a85537862 100644 --- a/content/en-us/reference/engine/classes/AudioRecorder.yaml +++ b/content/en-us/reference/engine/classes/AudioRecorder.yaml @@ -43,7 +43,7 @@ properties: - name: AudioRecorder.TimeLength summary: '' description: | - Returns the current length of the recording. + Returns the current length of the recording in seconds. code_samples: [] type: double tags: From 10c8f8f73b528d03a7cf426fdbdcb9f8f3a2ca43 Mon Sep 17 00:00:00 2001 From: karl-police Date: Thu, 15 May 2025 00:25:37 +0200 Subject: [PATCH 3/8] Update content/en-us/reference/engine/classes/AudioRecorder.yaml Co-authored-by: rbxphogen <89100144+rbxphogen@users.noreply.github.com> --- content/en-us/reference/engine/classes/AudioRecorder.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioRecorder.yaml b/content/en-us/reference/engine/classes/AudioRecorder.yaml index a85537862..f9071ff16 100644 --- a/content/en-us/reference/engine/classes/AudioRecorder.yaml +++ b/content/en-us/reference/engine/classes/AudioRecorder.yaml @@ -9,7 +9,6 @@ description: | There's a fixed time limit on how long a recording can be, which is **`60` seconds**. - The recordings from the `Class.AudioRecorder|AudioRecorder` have a sample rate of 96 kHz and the format `f32le`. At the moment `Class.AudioDeviceInput|AudioDeviceInput` can not be recorded. The method `Class.AudioRecorder.GetUnrecordableInstancesAsync()|GetUnrecordableInstancesAsync()` can be used From 9fd9ab462db5f9e90bf1cfc73f27bc97fc633518 Mon Sep 17 00:00:00 2001 From: karl-police Date: Thu, 15 May 2025 00:27:05 +0200 Subject: [PATCH 4/8] Update content/en-us/reference/engine/classes/AudioRecorder.yaml Co-authored-by: rbxphogen <89100144+rbxphogen@users.noreply.github.com> --- content/en-us/reference/engine/classes/AudioRecorder.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/content/en-us/reference/engine/classes/AudioRecorder.yaml b/content/en-us/reference/engine/classes/AudioRecorder.yaml index f9071ff16..906c52b89 100644 --- a/content/en-us/reference/engine/classes/AudioRecorder.yaml +++ b/content/en-us/reference/engine/classes/AudioRecorder.yaml @@ -130,6 +130,7 @@ methods: summary: '' description: | Returns recorded content that can be played back with `Class.AudioPlayer|AudioPlayer`. + The content retrieved from this method is only valid in the current session. code_samples: [] parameters: [] returns: From 2d019da8819358916b9240ae2d8c95d2d6d6a3f3 Mon Sep 17 00:00:00 2001 From: karl-police Date: Thu, 15 May 2025 00:50:26 +0200 Subject: [PATCH 5/8] Update content/en-us/reference/engine/classes/AudioRecorder.yaml Co-authored-by: rbxphogen <89100144+rbxphogen@users.noreply.github.com> --- content/en-us/reference/engine/classes/AudioRecorder.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioRecorder.yaml b/content/en-us/reference/engine/classes/AudioRecorder.yaml index 906c52b89..57ce5154f 100644 --- a/content/en-us/reference/engine/classes/AudioRecorder.yaml +++ b/content/en-us/reference/engine/classes/AudioRecorder.yaml @@ -197,7 +197,7 @@ methods: - name: AudioRecorder:RecordAsync summary: '' description: | - Starts recording. + If `Class.AudioRecorder:CanRecordAsync` returns true, begins recording. If recording cannot begin, this method produces an error. code_samples: [] parameters: [] returns: From 8a300b1c89b53061cbdea6c5dee53e1ee997af26 Mon Sep 17 00:00:00 2001 From: karl-police Date: Thu, 15 May 2025 00:51:28 +0200 Subject: [PATCH 6/8] Update content/en-us/reference/engine/classes/AudioRecorder.yaml Co-authored-by: rbxphogen <89100144+rbxphogen@users.noreply.github.com> --- content/en-us/reference/engine/classes/AudioRecorder.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioRecorder.yaml b/content/en-us/reference/engine/classes/AudioRecorder.yaml index 57ce5154f..aaf5de9b1 100644 --- a/content/en-us/reference/engine/classes/AudioRecorder.yaml +++ b/content/en-us/reference/engine/classes/AudioRecorder.yaml @@ -180,7 +180,8 @@ methods: - name: AudioRecorder:GetUnrecordableInstancesAsync summary: '' description: | - A method that traverses the audio graph to find unrecordable instances. + Traverses the audio graph, starting from this recorder's inputs, to find unrecordable instances. + Currently, `Class.AudioDeviceInput` is not recordable. code_samples: [] parameters: [] returns: From 8016879e9393589970f0e71d705d54a4cd4722eb Mon Sep 17 00:00:00 2001 From: IgnisRBX <43388550+IgnisRBX@users.noreply.github.com> Date: Thu, 15 May 2025 06:14:38 -1000 Subject: [PATCH 7/8] Apply suggestions from code review --- .../engine/classes/AudioRecorder.yaml | 27 +++++++++---------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/content/en-us/reference/engine/classes/AudioRecorder.yaml b/content/en-us/reference/engine/classes/AudioRecorder.yaml index aaf5de9b1..06e84f540 100644 --- a/content/en-us/reference/engine/classes/AudioRecorder.yaml +++ b/content/en-us/reference/engine/classes/AudioRecorder.yaml @@ -2,17 +2,14 @@ name: AudioRecorder type: class memory_category: Internal summary: | - Record audio streams in-experience. + Records audio streams in-experience. description: | - The **AudioRecorder** can be used to record audio streams in-experience. - The results can be loaded back into an `Class.AudioPlayer|AudioPlayer` for playback. + `AudioRecorder` records audio streams in-experience with a fixed time limit of 60 seconds. The + results can be loaded into an `Class.AudioPlayer` for playback. - There's a fixed time limit on how long a recording can be, which is **`60` seconds**. - - - At the moment `Class.AudioDeviceInput|AudioDeviceInput` can not be recorded. - The method `Class.AudioRecorder.GetUnrecordableInstancesAsync()|GetUnrecordableInstancesAsync()` can be used - to check specifically which instances aren't recordable. + At this time, `Class.AudioDeviceInput` cannot be recorded. The + `Class.AudioRecorder.GetUnrecordableInstancesAsync()|GetUnrecordableInstancesAsync()` method + can be used to check specifically which instances aren't recordable. code_samples: [] inherits: - Instance @@ -64,7 +61,7 @@ methods: - name: AudioRecorder:Clear summary: '' description: | - Clears out the recording from the `Class.AudioRecorder|AudioRecorder`. + Clears out the recording from the `AudioRecorder`. code_samples: [] parameters: [] returns: @@ -129,7 +126,7 @@ methods: - name: AudioRecorder:GetTemporaryContent summary: '' description: | - Returns recorded content that can be played back with `Class.AudioPlayer|AudioPlayer`. + Returns recorded content that can be played back with `Class.AudioPlayer`. The content retrieved from this method is only valid in the current session. code_samples: [] parameters: [] @@ -162,8 +159,9 @@ methods: - name: AudioRecorder:CanRecordAsync summary: '' description: | - Returns whether the `Class.AudioRecorder|AudioRecorder` can currently record. For instance, this will return `false` - if the current recording data has reached the recording time limit. To clear the recording use `Class.AudioRecorder:Clear()|:Clear()` + Returns whether the `AudioRecorder` can currently record. For instance, this will return `false` + if the current recording data has reached the recording time limit. To clear the recording, use + `Class.AudioRecorder:Clear()|Clear()`. code_samples: [] parameters: [] returns: @@ -198,7 +196,8 @@ methods: - name: AudioRecorder:RecordAsync summary: '' description: | - If `Class.AudioRecorder:CanRecordAsync` returns true, begins recording. If recording cannot begin, this method produces an error. + If `Class.AudioRecorder:CanRecordAsync()|CanRecordAsync()` returns `true`, recording begins. + If recording cannot begin, this method produces an error. code_samples: [] parameters: [] returns: From a58be309dad6284be46b4f3296c89b23d39f5bfa Mon Sep 17 00:00:00 2001 From: IgnisRBX <43388550+IgnisRBX@users.noreply.github.com> Date: Thu, 15 May 2025 11:06:52 -1000 Subject: [PATCH 8/8] Update content/en-us/reference/engine/classes/AudioRecorder.yaml --- content/en-us/reference/engine/classes/AudioRecorder.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/AudioRecorder.yaml b/content/en-us/reference/engine/classes/AudioRecorder.yaml index 06e84f540..3e94207c9 100644 --- a/content/en-us/reference/engine/classes/AudioRecorder.yaml +++ b/content/en-us/reference/engine/classes/AudioRecorder.yaml @@ -20,7 +20,7 @@ properties: - name: AudioRecorder.IsRecording summary: '' description: | - Returns whether the `Class.AudioRecorder|AudioRecorder` is currently recording. + Returns whether the `AudioRecorder` is currently recording. code_samples: [] type: boolean tags: []