Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AudioRecorder

Records audio streams in-experience.

This class is not browsable. It is not visible in Studio's object browser.
Memory categoryInternal
Tags: [NotBrowsable]

Member index 12

HistoryMember
671IsRecording: bool
671TimeLength: double
671CanRecordAsync(): bool
671Clear(): null
671GetConnectedWires(pin: string): Instances
671GetInputPins(): Array
671GetOutputPins(): Array
671GetTemporaryContent(): Content
671GetUnrecordableInstancesAsync(): Instances
671RecordAsync(): null
671Stop(): null
671WiringChanged(connected: bool, pin: string, wire: Wire, instance: Instance)
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
670Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

AudioRecorder records audio streams in-experience with a fixed time limit of 60 seconds. The results can be loaded into an AudioPlayer for playback.

At this time, AudioDeviceInput cannot be recorded. The GetUnrecordableInstancesAsync() method can be used to check specifically which instances aren't recordable.

History 13

Members 12

CanRecordAsync

Parameters (0)
No parameters.
Returns (1)
bool

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 Clear().

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

Clear

Parameters (0)
No parameters.
Returns (1)
null

Clears out the recording from the AudioRecorder.

Thread safetyUnsafe

History 1

GetConnectedWires

Parameters (1)
pinstring
Returns (1)
Instances
Thread safetyUnsafe

History 1

GetInputPins

Parameters (0)
No parameters.
Returns (1)
Array
Thread safetyUnsafe

History 1

GetOutputPins

Parameters (0)
No parameters.
Returns (1)
Array
Thread safetyUnsafe

History 1

GetTemporaryContent

Parameters (0)
No parameters.
Returns (1)
Content

Returns recorded content that can be played back with AudioPlayer. The content retrieved from this method is only valid in the current session.

Thread safetyUnsafe

History 1

GetUnrecordableInstancesAsync

Parameters (0)
No parameters.
Returns (1)
Instances

Traverses the audio graph, starting from this recorder's inputs, to find unrecordable instances. Currently, AudioDeviceInput is not recordable.

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

IsRecording

TypeDefault
boolfalse

Returns whether the AudioRecorder is currently recording.

Write securityRobloxSecurity
Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 1

RecordAsync

Parameters (0)
No parameters.
Returns (1)
null

If CanRecordAsync() returns true, recording begins. If recording cannot begin, this method produces an error.

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

Stop

Parameters (0)
No parameters.
Returns (1)
null

Stops recording.

Thread safetyUnsafe

History 1

TimeLength

TypeDefault
double0

Returns the current length of the recording in seconds.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 1

Tags: [ReadOnly, NotReplicated]

WiringChanged

Parameters (4)
connectedbool
pinstring
wireWire
instanceInstance
Thread safetyUnsafe

History 1

Settings