Skip to content
Roblox API Reference

AudioRecorder

Records audio streams in-experience.
  • Not browsable
Memory category
Internal
Own members
12
Inherited members
75
Subclasses
0
Siblings
608

Properties25

Inherited fromObject2

Property categoryData

Inherited fromInstance21

Property categoryBehavior

Property categoryData

Property categoryPermissions

Defined byAudioRecorder2

Property categoryData

  • AudioRecorder.TimeLength: number = 0
    The current length of the recording in seconds.
    • Read only
    • Read capabilities: Audio
    • Save only

Property categoryState

  • AudioRecorder.IsRecording: boolean = false
    Whether the AudioRecorder is currently recording.
    • Write: Roblox engine security
    • Read capabilities: Audio

Methods51

Inherited fromObject3
  • Get an event that fires when a given property of the object changes.
    Parameters
    ParameterDescription
    property: string
    The property to connect to.
    Returns
    TypeDescription
    RBXScriptSignal
    A signal that fires whenever the property changes.
  • Object:IsA(className: string): boolean
    Returns true if an object's class matches or inherits from a given class.
    • Custom Lua state
    • Thread safe
    Parameters
    ParameterDescription
    className: string
    The class against which the Object's class will be checked. Case-sensitive.
    Returns
    TypeDescription
    boolean
    Describes whether the Object's class matched or is a subclass of the given class.
  • Object:isA(className: string): boolean
    Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
    • Deprecated
    • Custom Lua state
    Parameters
    Parameter
    className: string
    Returns
    Type
    boolean

    Use IsA instead.

Inherited fromInstance39
Defined byAudioRecorder9
  • AudioRecorder:CanRecordAsync(): boolean
    Returns whether the AudioRecorder can currently record.
    • Yields
    • Capabilities: Audio
    Returns
    TypeDescription
    boolean
    true if recording is possible, false otherwise.
  • AudioRecorder:Clear()
    Clears out the recording from the AudioRecorder.
    • Capabilities: Audio
  • AudioRecorder:GetConnectedWires(pin: string): { Instance }
    Returns an array of Wires that are connected to the specified pin.
    • Capabilities: Audio
    Parameters
    ParameterDescription
    pin: string
    An input or output pin on this instance
    Returns
    TypeDescription
    { Instance }
    An array of Wires
  • AudioRecorder:GetInputPins(): { any }
    Gets the list of pins that Wire can use in Wire.TargetName to connect to this instance via its Wire.TargetInstance property.
    • Capabilities: Audio
    Returns
    TypeDescription
    { any }
    An array of strings representing valid pin names.
  • AudioRecorder:GetOutputPins(): { any }
    Gets the list of pins that Wire can use in Wire.SourceName to connect to this instance via its Wire.SourceInstance property.
    • Capabilities: Audio
    Returns
    TypeDescription
    { any }
    An array of strings representing valid pin names.
  • AudioRecorder:GetTemporaryContent(): Content
    Returns a Content object representing the current audio recording.
    • Capabilities: Audio
    Returns
    TypeDescription
    Content
    A temporary Content ID that can be used with AudioPlayer.
  • AudioRecorder:GetUnrecordableInstancesAsync(): { Instance }
    Returns any instances which cannot be recorded.
    • Yields
    • Capabilities: Audio
    Returns
    TypeDescription
    { Instance }
    A table of Instances that are not recordable.
  • AudioRecorder:RecordAsync()
    Starts recording audio.
    • Yields
    • Capabilities: Audio
  • AudioRecorder:Stop()
    Stops recording audio.
    • Capabilities: Audio

Events11

Inherited fromObject1
Inherited fromInstance9
Defined byAudioRecorder1