Skip to content

Commit afd4916

Browse files
authored
Add AudioRecorder descriptions
1 parent 0c501b6 commit afd4916

File tree

1 file changed

+30
-10
lines changed

1 file changed

+30
-10
lines changed

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

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
11
name: AudioRecorder
22
type: class
33
memory_category: Internal
4-
summary: ''
5-
description: ''
4+
summary: |
5+
Record audio streams in-experience.
6+
description: |
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.
9+
10+
There's a fixed time limit on how long a recording can be, which is **`60` seconds**.
11+
12+
The recordings from the `Class.AudioRecorder|AudioRecorder` have a sample rate of 96 kHz and the format `f32le`.
13+
14+
At the moment `Class.AudioDeviceInput|AudioDeviceInput` can not be recorded.
15+
The method `Class.AudioRecorder.GetUnrecordableInstancesAsync()|GetUnrecordableInstancesAsync()` can be used
16+
to check specifically which instances aren't recordable.
617
code_samples: []
718
inherits:
819
- Instance
@@ -12,7 +23,8 @@ deprecation_message: ''
1223
properties:
1324
- name: AudioRecorder.IsRecording
1425
summary: ''
15-
description: ''
26+
description: |
27+
Returns whether the `Class.AudioRecorder|AudioRecorder` is currently recording.
1628
code_samples: []
1729
type: boolean
1830
tags: []
@@ -30,7 +42,8 @@ properties:
3042
writeCapabilities: []
3143
- name: AudioRecorder.TimeLength
3244
summary: ''
33-
description: ''
45+
description: |
46+
Returns the current length of the recording.
3447
code_samples: []
3548
type: double
3649
tags:
@@ -51,7 +64,8 @@ properties:
5164
methods:
5265
- name: AudioRecorder:Clear
5366
summary: ''
54-
description: ''
67+
description: |
68+
Clears out the recording from the `Class.AudioRecorder|AudioRecorder`.
5569
code_samples: []
5670
parameters: []
5771
returns:
@@ -115,7 +129,8 @@ methods:
115129
writeCapabilities: []
116130
- name: AudioRecorder:GetTemporaryContent
117131
summary: ''
118-
description: ''
132+
description: |
133+
Returns recorded content that can be played back with `Class.AudioPlayer|AudioPlayer`.
119134
code_samples: []
120135
parameters: []
121136
returns:
@@ -130,7 +145,8 @@ methods:
130145
writeCapabilities: []
131146
- name: AudioRecorder:Stop
132147
summary: ''
133-
description: ''
148+
description: |
149+
Stops recording.
134150
code_samples: []
135151
parameters: []
136152
returns:
@@ -145,7 +161,9 @@ methods:
145161
writeCapabilities: []
146162
- name: AudioRecorder:CanRecordAsync
147163
summary: ''
148-
description: ''
164+
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()`
149167
code_samples: []
150168
parameters: []
151169
returns:
@@ -161,7 +179,8 @@ methods:
161179
writeCapabilities: []
162180
- name: AudioRecorder:GetUnrecordableInstancesAsync
163181
summary: ''
164-
description: ''
182+
description: |
183+
A method that traverses the audio graph to find unrecordable instances.
165184
code_samples: []
166185
parameters: []
167186
returns:
@@ -177,7 +196,8 @@ methods:
177196
writeCapabilities: []
178197
- name: AudioRecorder:RecordAsync
179198
summary: ''
180-
description: ''
199+
description: |
200+
Starts recording.
181201
code_samples: []
182202
parameters: []
183203
returns:

0 commit comments

Comments
 (0)