Skip to content

Commit 0c8b0f0

Browse files
karl-policeIgnisRBXrbxphogen
authored
AudioRecorder and Issue Request (#1104)
## Changes In-reality I wanted to ask question. To find a valid way to do it, I've updated ``AudioRecorder``, so that now I can use this text field here, and type my question. **Because issue requests are disabled.** Info is from <https://create.roblox.com/docs/en-us/release-notes/release-notes-671> and <https://devforum.roblox.com/t/release-notes-for-671> and own testing in the current public version through Fast Flags. * <https://devforum.roblox.com/t/release-notes-for-671/3634028/50> * <https://devforum.roblox.com/t/release-notes-for-671/3634028/61> ## Checks By submitting your pull request for review, you agree to the following: - [x] This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses. - [x] I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses. - [x] To the best of my knowledge, all proposed changes are accurate. &nbsp; # Issue Alright. Now, to the issue. In https://create.roblox.com/docs/en-us/reference/engine/classes/ProximityPrompt for instance, you can find a text that says > The example below generates a custom which is in a Code Sample, and that's currently not a thing But what I am trying to say is, that there are pages, that aren't in this Repository. And they can not be edited :( There were moments where I wanted to edit something. I've probably forgotten. But where do I go then? 🤔 Do I actually just go on the Developer Forums with a Bug Report for everything? Please fix. --------- Co-authored-by: IgnisRBX <[email protected]> Co-authored-by: rbxphogen <[email protected]>
1 parent f7fb200 commit 0c8b0f0

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,15 @@
11
name: AudioRecorder
22
type: class
33
memory_category: Internal
4-
summary: ''
5-
description: ''
4+
summary: |
5+
Records audio streams in-experience.
6+
description: |
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.
9+
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.
613
code_samples: []
714
inherits:
815
- Instance
@@ -12,7 +19,8 @@ deprecation_message: ''
1219
properties:
1320
- name: AudioRecorder.IsRecording
1421
summary: ''
15-
description: ''
22+
description: |
23+
Returns whether the `AudioRecorder` is currently recording.
1624
code_samples: []
1725
type: boolean
1826
tags: []
@@ -30,7 +38,8 @@ properties:
3038
writeCapabilities: []
3139
- name: AudioRecorder.TimeLength
3240
summary: ''
33-
description: ''
41+
description: |
42+
Returns the current length of the recording in seconds.
3443
code_samples: []
3544
type: double
3645
tags:
@@ -51,7 +60,8 @@ properties:
5160
methods:
5261
- name: AudioRecorder:Clear
5362
summary: ''
54-
description: ''
63+
description: |
64+
Clears out the recording from the `AudioRecorder`.
5565
code_samples: []
5666
parameters: []
5767
returns:
@@ -115,7 +125,9 @@ methods:
115125
writeCapabilities: []
116126
- name: AudioRecorder:GetTemporaryContent
117127
summary: ''
118-
description: ''
128+
description: |
129+
Returns recorded content that can be played back with `Class.AudioPlayer`.
130+
The content retrieved from this method is only valid in the current session.
119131
code_samples: []
120132
parameters: []
121133
returns:
@@ -130,7 +142,8 @@ methods:
130142
writeCapabilities: []
131143
- name: AudioRecorder:Stop
132144
summary: ''
133-
description: ''
145+
description: |
146+
Stops recording.
134147
code_samples: []
135148
parameters: []
136149
returns:
@@ -145,7 +158,10 @@ methods:
145158
writeCapabilities: []
146159
- name: AudioRecorder:CanRecordAsync
147160
summary: ''
148-
description: ''
161+
description: |
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()`.
149165
code_samples: []
150166
parameters: []
151167
returns:
@@ -161,7 +177,9 @@ methods:
161177
writeCapabilities: []
162178
- name: AudioRecorder:GetUnrecordableInstancesAsync
163179
summary: ''
164-
description: ''
180+
description: |
181+
Traverses the audio graph, starting from this recorder's inputs, to find unrecordable instances.
182+
Currently, `Class.AudioDeviceInput` is not recordable.
165183
code_samples: []
166184
parameters: []
167185
returns:
@@ -177,7 +195,9 @@ methods:
177195
writeCapabilities: []
178196
- name: AudioRecorder:RecordAsync
179197
summary: ''
180-
description: ''
198+
description: |
199+
If `Class.AudioRecorder:CanRecordAsync()|CanRecordAsync()` returns `true`, recording begins.
200+
If recording cannot begin, this method produces an error.
181201
code_samples: []
182202
parameters: []
183203
returns:

0 commit comments

Comments
 (0)