API reference
IAudioInputSource Interface
This interface defines the methods and properties required for an audio input source. It is used to start and stop recording, check if recording is in progress, and handle events related to recording.
Events
Action OnStartRecording
Invoked when the instance starts Recording.
Action OnStartRecordingFailed
Invoked when an AudioClip couldn't be created to start recording.
Action< int, float[], float > OnSampleReady
Invoked everytime an audio frame is collected. Includes the frame.
Action OnStopRecording
Invoked when the instance stop Recording.
Action OnMicMuted
Invoked when the user mutes their input to this audio source
Action OnMicUnmuted
Invoked when the user unmutes their input to this audio source
Properties
bool IsRecording[Get]
Returns true if the audio input source is currently recording.
AudioEncoding AudioEncoding[Get]
Settings determining how audio is encoded by the source.
NOTE: Default values for AudioEncoding are server optimized to reduce latency.
bool IsMuted[Get]
Returns true if the audio source is currently muted
Member Functions
void StartRecording
( int sampleLen )
Starts recording audio with the specified sample length.
Parameters
sampleLen
The length of the audio sample to record.
void StopRecording ( )
Stops recording audio.
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta