StaticconfigureStaticgetGets the available audio outputs for use with selectAudioOutput.
+StaticgetGets the available audio outputs for use with selectAudioOutput.
startAudioSession must be called prior to using this method.
For Android, will return if available:
react-native-avroutepicker for a native platform
control.
the available audio output types
-StaticselectSelect the provided audio output if available.
+StaticselectSelect the provided audio output if available.
startAudioSession must be called prior to using this method.
A deviceId retrieved from getAudioOutputs
-StaticsetDirectly change the AVAudioSession category/mode.
+StaticsetDirectly change the AVAudioSession category/mode.
The configuration to use. Null values will be omitted and the existing values will be unchanged.
-StaticsetSet default audio track volume when new tracks are subscribed. +
StaticsetSet default audio track volume when new tracks are subscribed. Does not affect any existing tracks.
A number between 0.0 and 1.0, where 0.0 represents 0% volume and 1.0 represents full volume.
-StaticshowiOS only, requires iOS 11+.
+StaticshowiOS only, requires iOS 11+.
Displays an AVRoutePickerView for the user to choose their audio output.
-StaticstartStarts an AudioSession.
-StaticstopStops the existing AudioSession.
-StaticstartStarts an AudioSession.
+StaticstopStops the existing AudioSession.
+ExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalExperimentalOptionalparticipantIdentity: stringOptionalkeyIndex: numberExperimentalOptionalkeyIndex: numberExperimentalAccepts a passphrase that's used to create the crypto keys for a participant's stream.
-OptionalkeyIndex: numberExperimentalAccepts a passphrase that's used to create the crypto keys.
-OptionalkeyIndex: numberExperimentalExperimentalExperimentalExperimentalOptionalparticipantIdentity: stringOptionalkeyIndex: numberExperimentalOptionalkeyIndex: numberExperimentalAccepts a passphrase that's used to create the crypto keys for a participant's stream.
+OptionalkeyIndex: numberExperimentalAccepts a passphrase that's used to create the crypto keys.
+OptionalkeyIndex: numberExperimentalVisualizes audio signals from a TrackReference as bars. +
Visualizes audio signals from a TrackReference as bars.
If the state prop is set, it automatically transitions between VoiceAssistant states.
The LiveKitRoom component provides the room context to all its child components.
+
The LiveKitRoom component provides the room context to all its child components.
It is generally the starting point of your LiveKit app and the root of the LiveKit component tree.
It provides the room state as a React context to all child components, so you don't have to pass it yourself.
Use the default behavior of setupIOSAudioManagement instead.
Registers the required globals needed for LiveKit to work.
+Registers the required globals needed for LiveKit to work.
Must be called before using LiveKit.
Optionaloptions: RegisterGlobalsOptionsOptional configuration for global registration
-Set the log level for both the @livekit/react-native package and the @livekit-client package.
+
Set the log level for both the @livekit/react-native package and the @livekit-client package.
To set the @livekit-client log independently, use the liveKitClientLogLevel prop on the options object.
Sets up automatic iOS audio session management based on audio engine state.
+Sets up automatic iOS audio session management based on audio engine state.
Call this once at app startup (e.g. in index.js). registerGlobals()
invokes it for you by default unless autoConfigureAudioSession: false
is passed.
Whether to prefer speaker output. Defaults to true.
-OptionalonConfigureNativeAudio: (configurationState: AudioEngineConfigurationState) => AppleAudioConfigurationOptional custom callback for determining audio configuration.
-A cleanup function that removes the event handlers.
-By default the audio session is configured and activated natively as the +audio engine changes state, with no JavaScript involvement per transition.
+For custom categories/modes, pass a static IOSAudioSessionPolicy. +That policy is pushed to native once and applied on the audio worker thread.
+Calling this again replaces the previous setup, including switching +between the default and custom paths. Switch while disconnected; a switch +during an active call is unsupported. In particular, switching away from a +custom callback setup mid-call abandons the audio session activation that +the custom handlers took, so the session may stay active after the call ends.
+OptionalpreferSpeakerOutput: booleanWhether to prefer speaker output. Defaults to true.
+A cleanup function that removes the installed handlers or native +configuration. A cleanup function from a superseded setup is a no-op.
+Sets up automatic iOS audio session management with a static native policy.
+Unused when a full policy is provided; kept for +call-site consistency with the default overload.
+Static recording/playout configuration applied natively.
+setupIOSAudioManagement for the default native path and usage notes.
+The onConfigureNativeAudio callback is unsafe. It runs inside
+the audio engine's lifecycle callbacks while native code waits for the
+result (bounded at a few seconds). The callback must return quickly and
+must not call APIs that enter the WebRTC engine or a peer connection
+(for example addTransceiver, getUserMedia, or device enumeration):
+those can block on the same engine operation the callback is holding up.
+Prefer the default native path, or pass an IOSAudioSessionPolicy.
Default sort for participants, it'll order participants by:
+Default sort for participants, it'll order participants by:
OptionallocalParticipant: LocalParticipantOptionallocalParticipant: LocalParticipantOptionalonConfigureNativeAudio: (Use setupIOSAudioManagement instead. +
OptionalonConfigureNativeAudio: (Use setupIOSAudioManagement instead.
The room parameter is ignored — audio session is now managed
via audio engine events, not room track counts.
The onConfigureNativeAudio callback is also deprecated and unsafe: it
+runs under a bounded native wait on the audio worker thread. Prefer the
+default native path, or pass an IOSAudioSessionPolicy to
+setupIOSAudioManagement.
Note: the trackState passed to onConfigureNativeAudio is now
derived from the audio engine's playout/recording state, not from
publication counts. Edge cases can differ. For example, a
published-but-muted local audio track that previously yielded
-localOnly may now appear as remoteOnly or none. Callers with
-nuanced per-state logic should migrate to setupIOSAudioManagement.
localOnly may now appear as remoteOnly or none.
+A hook for tracking the volume of an audio track across multiple frequency bands.
+A hook for tracking the volume of an audio track across multiple frequency bands.
OptionaltrackOrTrackReference: LocalAudioTrack | RemoteAudioTrack | TrackReferenceOrPlaceholderOptionaloptions: MultiBandTrackVolumeOptionsA number array containing the volume for each frequency band.
-Optionaloptions: RoomOptionsOptionaloptions: RoomOptionsA hook for tracking the volume of an audio track.
+A hook for tracking the volume of an audio track.
OptionaltrackOrTrackReference: LocalAudioTrack | RemoteAudioTrack | TrackReferenceOrPlaceholderA number between 0-1 representing the volume.
-For custom automatic behavior, disable the default setup and call
-setupIOSAudioManagement once during app startup:
import { registerGlobals, setupIOSAudioManagement } from '@livekit/react-native';
registerGlobals({ autoConfigureAudioSession: false });
const cleanup = setupIOSAudioManagement(true, (state) => ({
audioCategory: state.isRecordingEnabled ? 'playAndRecord' : 'playback',
audioCategoryOptions: ['mixWithOthers'],
audioMode: state.preferSpeakerOutput ? 'videoChat' : 'voiceChat',
}));
+For custom categories/modes, disable the default setup and pass a static
+policy to setupIOSAudioManagement once during app startup:
+import { registerGlobals, setupIOSAudioManagement } from '@livekit/react-native';
registerGlobals({ autoConfigureAudioSession: false });
const cleanup = setupIOSAudioManagement(true, {
recording: {
audioCategory: 'playAndRecord',
audioCategoryOptions: ['allowBluetooth', 'mixWithOthers'],
audioMode: 'videoChat',
},
playout: {
audioCategory: 'playback',
audioCategoryOptions: ['mixWithOthers'],
audioMode: 'spokenAudio',
},
});
The older useIOSAudioManagement(room, ...) hook is still exported for
@@ -194,4 +194,4 @@
LicenseDeveloper Community · Slack · X · YouTube
-
BetaBetaOptional BetabarNumber of bars that show up in the visualizer
-Optional BetaoptionsOptional BetastateIf set, the visualizer will transition between different voice assistant states
-Optional BetastyleCustom React Native styles for the container.
-Optional BetatrackOptional BetaoptionsOptional BetastateIf set, the visualizer will transition between different voice assistant states
+Optional BetastyleCustom React Native styles for the container.
+Optional BetatrackOptionalconnectIf set to true a connection to LiveKit room is initiated.
OptionalconnectDefine options how to connect to the LiveKit server.
+OptionalconnectDefine options how to connect to the LiveKit server.
Optional ExperimentalfeatureOptionalonOptionalonOptionalonOptionalonOptionalonOptionaloptionsOptions for when creating a new room. +
Optional ExperimentalfeatureOptionalonOptionalonOptionalonOptionalonOptionalonOptionaloptionsOptions for when creating a new room. When you pass your own room instance to this component, these options have no effect. Instead, set the options directly in the room instance.
OptionalroomOptional room instance. +
OptionalroomOptional room instance.
By passing your own room instance you overwrite the options parameter,
make sure to set the options directly on the room instance itself.
OptionalscreenPublish screen share immediately after connecting to your LiveKit room.
+OptionalscreenPublish screen share immediately after connecting to your LiveKit room.
URL to the LiveKit server. +
URL to the LiveKit server.
For example: wss://<domain>.livekit.cloud
To simplify the implementation, undefined is also accepted as an intermediate value, but only with a valid string url can the connection be established.
OptionalsimulateA user specific access token for a client to authenticate to the room. +
OptionalsimulateA user specific access token for a client to authenticate to the room.
This token is necessary to establish a connection to the room.
To simplify the implementation, undefined is also accepted as an intermediate value, but only with a valid string token can the connection be established.
OptionalvideoPublish video immediately after connecting to your LiveKit room.
+OptionalvideoPublish video immediately after connecting to your LiveKit room.
AlphaInterface for configuring options for the useMultibandTrackVolume hook.
-AlphaInterface for configuring options for the useMultibandTrackVolume hook.
+Optional Alphabandsthe number of bands to split the audio into
-Optional Alphamaxcut off frequency on the higher end
-Optional Alphamincut off frequency on the lower end
-Optional Alphaupdateupdate should run every x ms
-Optional Alphamaxcut off frequency on the higher end
+Optional Alphamincut off frequency on the lower end
+Optional Alphaupdateupdate should run every x ms
+OptionalcameraOptionalmetadataOptionalmicrophoneOptionalscreenOptionalcameraOptionalmetadataOptionalmicrophoneOptionalscreenOptionalaudioCorresponds to Android's AndroidAttributes content type.
Defaults to 'speech'.
See also https://developer.android.com/reference/android/media/AudioAttributes
-OptionalaudioCorresponds to Android's AudioAttributes usage type.
+OptionalaudioCorresponds to Android's AudioAttributes usage type.
Defaults to 'voiceCommunication'.
See also https://developer.android.com/reference/android/media/AudioAttributes
-OptionalaudioCorresponds to the duration hint when requesting audio focus.
+OptionalaudioCorresponds to the duration hint when requesting audio focus.
Defaults to 'gain'.
See also https://developer.android.com/reference/android/media/AudioManager#AUDIOFOCUS_GAIN
-OptionalaudioOptionalaudioCorresponds to https://developer.android.com/reference/android/media/AudioManager#setMode(int)
Defaults to 'inCommunication'.
-OptionalaudioCorresponds to the stream type when requesting audio focus. Used on pre-O devices.
+OptionalaudioCorresponds to the stream type when requesting audio focus. Used on pre-O devices.
Defaults to 'voiceCall'
See also https://developer.android.com/reference/android/media/AudioManager#STREAM_VOICE_CALL
-OptionalforceOn certain Android devices, audio routing does not function properly and +
OptionalforceOn certain Android devices, audio routing does not function properly and
bluetooth microphones will not work unless audio mode is set to
inCommunication or inCall. Audio routing is turned off those cases.
If this set to true, will attempt to do audio routing regardless of audio mode.
Defaults to false.
-OptionalmanageWhether LiveKit should handle managing the audio focus or not.
+OptionalmanageWhether LiveKit should handle managing the audio focus or not.
Defaults to true.
-Configuration for the underlying AudioSession.
+Configuration for the underlying AudioSession.
Android specific options:
By default, this is set to "speaker"
OptionalandroidOptionaliosOptionalandroidOptionaliosRetained only for the legacy useIOSAudioManagement hook and
-getDefaultAppleAudioConfigurationForMode. New code should pass an
-onConfigureNativeAudio callback to setupIOSAudioManagement, which
-receives an AudioEngineConfigurationState (playout/recording/speaker
-booleans). That shape has no direct AudioTrackState equivalent.
Retained only for the legacy useIOSAudioManagement hook and
+getDefaultAppleAudioConfigurationForMode. New code should use
+setupIOSAudioManagement (optionally with an IOSAudioSessionPolicy).
+That API is driven by playout/recording engine state, which has no direct
+AudioTrackState equivalent.
Static recording/playout policy for setupIOSAudioManagement.
+Unsafe. Prefer IOSAudioSessionPolicy or the default +native path. See setupIOSAudioManagement.
+Options for construction an RNKeyProvider
-Options for construction an RNKeyProvider
+Props for the VideoTrack component.
-Props for the VideoTrack component.
+import { startIOSPIP, stopIOSPIP } from '@livekit/react-native-webrtc';
// Obtain a ref to the view
const videoRef = useRef<Component>(null);
const videoView = (
<VideoTrack
ref={videoRef}
iosPIP={{
enabled: true,
startAutomatically: true,
preferredSize: {
width: 9,
height: 16,
},
}}
...
/>
);
// Start/stop manually
startIOSPIP(videoRef);
stopIOSPIP(videoRef);
OptionalmirrorIndicates whether the video should be mirrored during rendering. +
OptionalmirrorIndicates whether the video should be mirrored during rendering. This is commonly used for front-facing cameras.
-OptionalobjectSpecifies how the video content should be resized to fit its container. +
OptionalobjectSpecifies how the video content should be resized to fit its container. 'cover' (default): The video will fill the entire container, potentially cropping the video. 'contain': The entire video will be visible within the container, potentially leaving empty space.
-OptionalstyleCustom React Native styles for the video container.
-The track reference to display. This should be a TrackReference object +
OptionalstyleCustom React Native styles for the video container.
+The track reference to display. This should be a TrackReference object or undefined if no track is available.
-OptionalzSpecifies the depth-stacking order of this video view in the stacking space of all video views. +
OptionalzSpecifies the depth-stacking order of this video view in the stacking space of all video views. A larger zOrder value generally causes the view to cover those with lower values.
The support for zOrder is platform-dependent and/or implementation-specific. Thus, specifying a value for zOrder is to be @@ -38,4 +38,4 @@ application usually needs a maximum of two zOrder values: 0 for the remote video(s) which appear in the background, and 1 for the local video(s) which appear above the remote video(s).
-ConstA pre-configured AndroidAudioConfiguration for voice communication.
+ConstA pre-configured AndroidAudioConfiguration for voice communication.
A pre-configured AndroidAudioConfiguration for media playback.
-ConstVideoTrack component for displaying video tracks in a React Native application. +
ConstVideoTrack component for displaying video tracks in a React Native application. It supports both local and remote video tracks from LiveKit, and handles adaptive streaming for remote tracks.
ConstConst
Applies the provided audio configuration to the underlying AudioSession.
Must be called prior to connecting to a Room for the configuration to apply correctly.
See also
-setupIOSAudioManagementfor automatic configuration of iOS audio options.