@@ -2,17 +2,14 @@ name: AudioRecorder
22type : class
33memory_category : Internal
44summary : |
5- Record audio streams in-experience.
5+ Records audio streams in-experience.
66description : |
7- The ** AudioRecorder** can be used to record audio streams in-experience.
8- The results can be loaded back into an `Class.AudioPlayer| AudioPlayer` for playback.
7+ ` AudioRecorder` records audio streams in-experience with a fixed time limit of 60 seconds. The
8+ results can be loaded into an `Class.AudioPlayer` for playback.
99
10- There's a fixed time limit on how long a recording can be, which is **`60` seconds**.
11-
12-
13- At the moment `Class.AudioDeviceInput|AudioDeviceInput` can not be recorded.
14- The method `Class.AudioRecorder.GetUnrecordableInstancesAsync()|GetUnrecordableInstancesAsync()` can be used
15- to check specifically which instances aren't recordable.
10+ At this time, `Class.AudioDeviceInput` cannot be recorded. The
11+ `Class.AudioRecorder.GetUnrecordableInstancesAsync()|GetUnrecordableInstancesAsync()` method
12+ can be used to check specifically which instances aren't recordable.
1613code_samples : []
1714inherits :
1815 - Instance
@@ -64,7 +61,7 @@ methods:
6461 - name : AudioRecorder:Clear
6562 summary : ' '
6663 description : |
67- Clears out the recording from the `Class.AudioRecorder| AudioRecorder`.
64+ Clears out the recording from the `AudioRecorder`.
6865 code_samples : []
6966 parameters : []
7067 returns :
@@ -129,7 +126,7 @@ methods:
129126 - name : AudioRecorder:GetTemporaryContent
130127 summary : ' '
131128 description : |
132- Returns recorded content that can be played back with `Class.AudioPlayer|AudioPlayer `.
129+ Returns recorded content that can be played back with `Class.AudioPlayer`.
133130 The content retrieved from this method is only valid in the current session.
134131 code_samples : []
135132 parameters : []
@@ -162,8 +159,9 @@ methods:
162159 - name : AudioRecorder:CanRecordAsync
163160 summary : ' '
164161 description : |
165- Returns whether the `Class.AudioRecorder|AudioRecorder` can currently record. For instance, this will return `false`
166- if the current recording data has reached the recording time limit. To clear the recording use `Class.AudioRecorder:Clear()|:Clear()`
162+ Returns whether the `AudioRecorder` can currently record. For instance, this will return `false`
163+ if the current recording data has reached the recording time limit. To clear the recording, use
164+ `Class.AudioRecorder:Clear()|Clear()`.
167165 code_samples : []
168166 parameters : []
169167 returns :
@@ -198,7 +196,8 @@ methods:
198196 - name : AudioRecorder:RecordAsync
199197 summary : ' '
200198 description : |
201- If `Class.AudioRecorder:CanRecordAsync` returns true, begins recording. If recording cannot begin, this method produces an error.
199+ If `Class.AudioRecorder:CanRecordAsync()|CanRecordAsync()` returns `true`, recording begins.
200+ If recording cannot begin, this method produces an error.
202201 code_samples : []
203202 parameters : []
204203 returns :
0 commit comments