AudioRecorder and Issue Request

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

@@ -1,8 +1,15 @@
 name: AudioRecorder
 type: class
 memory_category: Internal
-summary: ''
-description: ''
+summary: |
+  Records audio streams in-experience.
+description: |
+  `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.
+
+  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
@@ -12,7 +19,8 @@ deprecation_message: ''
 properties:
   - name: AudioRecorder.IsRecording
     summary: ''
-    description: ''
+    description: |
+      Returns whether the `AudioRecorder` is currently recording.
     code_samples: []
     type: boolean
     tags: []
@@ -30,7 +38,8 @@ properties:
     writeCapabilities: []
   - name: AudioRecorder.TimeLength
     summary: ''
-    description: ''
+    description: |
+      Returns the current length of the recording in seconds.
     code_samples: []
     type: double
     tags:
@@ -51,7 +60,8 @@ properties:
 methods:
   - name: AudioRecorder:Clear
     summary: ''
-    description: ''
+    description: |
+      Clears out the recording from the `AudioRecorder`.
     code_samples: []
     parameters: []
     returns:
@@ -115,7 +125,9 @@ methods:
     writeCapabilities: []
   - name: AudioRecorder:GetTemporaryContent
     summary: ''
-    description: ''
+    description: |
+      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: []
     returns:
@@ -130,7 +142,8 @@ methods:
     writeCapabilities: []
   - name: AudioRecorder:Stop
     summary: ''
-    description: ''
+    description: |
+      Stops recording.
     code_samples: []
     parameters: []
     returns:
@@ -145,7 +158,10 @@ methods:
     writeCapabilities: []
   - name: AudioRecorder:CanRecordAsync
     summary: ''
-    description: ''
+    description: |
+      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:
@@ -161,7 +177,9 @@ methods:
     writeCapabilities: []
   - name: AudioRecorder:GetUnrecordableInstancesAsync
     summary: ''
-    description: ''
+    description: |
+      Traverses the audio graph, starting from this recorder's inputs, to find unrecordable instances.
+      Currently, `Class.AudioDeviceInput` is not recordable.
     code_samples: []
     parameters: []
     returns:
@@ -177,7 +195,9 @@ methods:
     writeCapabilities: []
   - name: AudioRecorder:RecordAsync
     summary: ''
-    description: ''
+    description: |
+      If `Class.AudioRecorder:CanRecordAsync()|CanRecordAsync()` returns `true`, recording begins.
+      If recording cannot begin, this method produces an error.
     code_samples: []
     parameters: []
     returns: