From e15799e576e964c227044829434b288d6c115a63 Mon Sep 17 00:00:00 2001 From: davidliu Date: Thu, 6 Nov 2025 19:15:07 +0900 Subject: [PATCH] chore: release 2.9.4 --- docs/classes/AudioSession.html | 18 ++++++++--------- docs/classes/RNE2EEManager.html | 4 ++-- docs/classes/RNKeyProvider.html | 8 ++++---- docs/functions/BarVisualizer.html | 4 ++-- docs/functions/LiveKitRoom.html | 4 ++-- docs/functions/VideoView.html | 4 ++-- ...DefaultAppleAudioConfigurationForMode.html | 2 +- docs/functions/registerGlobals.html | 4 ++-- docs/functions/setLogLevel.html | 4 ++-- docs/functions/sortParticipants.html | 4 ++-- docs/functions/useBarAnimator.html | 2 +- docs/functions/useIOSAudioManagement.html | 4 ++-- docs/functions/useMultibandTrackVolume.html | 4 ++-- docs/functions/useParticipant.html | 4 ++-- docs/functions/useRNE2EEManager.html | 2 +- docs/functions/useRoom.html | 4 ++-- docs/functions/useTrackVolume.html | 4 ++-- docs/hierarchy.html | 2 +- docs/index.html | 4 ++-- docs/interfaces/BarVisualizerProps.html | 8 ++++---- docs/interfaces/LiveKitRoomProps.html | 20 +++++++++---------- .../MultiBandTrackVolumeOptions.html | 12 +++++------ docs/interfaces/ParticipantState.html | 6 +++--- docs/interfaces/RNE2EEManagerState.html | 4 ++-- docs/interfaces/RegisterGlobalsOptions.html | 4 ++-- docs/interfaces/RoomOptions.html | 4 ++-- docs/interfaces/RoomState.html | 4 ++-- docs/modules.html | 2 +- docs/types/AndroidAudioTypeOptions.html | 16 +++++++-------- docs/types/AppleAudioCategory.html | 2 +- docs/types/AppleAudioCategoryOption.html | 2 +- docs/types/AppleAudioConfiguration.html | 4 ++-- docs/types/AppleAudioMode.html | 2 +- docs/types/AudioConfiguration.html | 6 +++--- docs/types/AudioTrackState.html | 2 +- docs/types/BarVisualizerOptions.html | 8 ++++---- docs/types/LogLevel.html | 2 +- docs/types/Props.html | 6 +++--- docs/types/RNKeyProviderOptions.html | 4 ++-- docs/types/SetLogLevelOptions.html | 4 ++-- docs/types/UseRNE2EEManagerOptions.html | 4 ++-- docs/types/VideoTrackProps.html | 16 +++++++-------- docs/variables/AndroidAudioTypePresets.html | 4 ++-- docs/variables/VideoTrack.html | 4 ++-- docs/variables/log.html | 2 +- example/ios/Podfile.lock | 4 ++-- package.json | 2 +- 47 files changed, 122 insertions(+), 122 deletions(-) diff --git a/docs/classes/AudioSession.html b/docs/classes/AudioSession.html index 8dcb717..781622b 100644 --- a/docs/classes/AudioSession.html +++ b/docs/classes/AudioSession.html @@ -1,4 +1,4 @@ -AudioSession | LiveKit React Native Client SDK - v2.9.3

Class AudioSession

Index

Constructors

constructor +AudioSession | LiveKit React Native Client SDK - v2.9.4

Class AudioSession

Index

Constructors

Methods

Constructors

Methods

  • 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 useIOSAudioManagement for automatic configuration of iOS audio options.

    -

    Parameters

    Returns Promise<void>

  • Gets the available audio outputs for use with selectAudioOutput.

    startAudioSession must be called prior to using this method.

    For Android, will return if available:

      @@ -30,18 +30,18 @@ or use a library like react-native-avroutepicker for a native platform control.

    Returns Promise<string[]>

    the available audio output types

    -
  • Directly change the AVAudioSession category/mode.

    +

Returns Promise<void>

  • Set default audio track volume when new tracks are subscribed. +

Returns Promise<void>

  • Set default audio track volume when new tracks are subscribed. Does not affect any existing tracks.

    Parameters

    • volume: number

      A number between 0.0 and 1.0, where 0.0 represents 0% volume and 1.0 represents full volume.

      -

    Returns Promise<void>

  • iOS only, requires iOS 11+.

    +

Returns Promise<void>

+

Returns Promise<void>

diff --git a/docs/classes/RNE2EEManager.html b/docs/classes/RNE2EEManager.html index 95c1ac2..61ffa56 100644 --- a/docs/classes/RNE2EEManager.html +++ b/docs/classes/RNE2EEManager.html @@ -1,4 +1,4 @@ -RNE2EEManager | LiveKit React Native Client SDK - v2.9.3

Class RNE2EEManagerExperimental

Hierarchy

  • TypedEventEmitter<E2EEManagerCallbacks, this>
    • RNE2EEManager

Implements

  • BaseE2EEManager
Index

Constructors

constructor +RNE2EEManager | LiveKit React Native Client SDK - v2.9.4

Class RNE2EEManagerExperimental

Hierarchy

  • TypedEventEmitter<E2EEManagerCallbacks, this>
    • RNE2EEManager

Implements

  • BaseE2EEManager
Index

Constructors

Accessors

  • get isDataChannelEncryptionEnabled(): boolean
    Experimental

    Returns boolean

  • set isDataChannelEncryptionEnabled(value: boolean): void
    Experimental

    Parameters

    • value: boolean

    Returns void

Methods

  • Experimental

    Parameters

    • data: Uint8Array

    Returns Promise<{}>

  • Experimental

    Parameters

    • payload: Uint8Array
    • iv: Uint8Array
    • participantIdentity: string
    • keyIndex: number

    Returns Promise<{}>

  • Experimental

    Parameters

    • enabled: boolean
    • participantIdentity: string

    Returns void

  • Experimental

    Parameters

    • trailer: Uint8Array

    Returns void

  • Experimental

    Parameters

    • room: Room

    Returns void

  • Experimental

    Parameters

    • _engine: RTCEngine

    Returns void

+

Constructors

Accessors

  • get isDataChannelEncryptionEnabled(): boolean
    Experimental

    Returns boolean

  • set isDataChannelEncryptionEnabled(value: boolean): void
    Experimental

    Parameters

    • value: boolean

    Returns void

Methods

  • Experimental

    Parameters

    • data: Uint8Array

    Returns Promise<{}>

  • Experimental

    Parameters

    • payload: Uint8Array
    • iv: Uint8Array
    • participantIdentity: string
    • keyIndex: number

    Returns Promise<{}>

  • Experimental

    Parameters

    • enabled: boolean
    • participantIdentity: string

    Returns void

  • Experimental

    Parameters

    • trailer: Uint8Array

    Returns void

  • Experimental

    Parameters

    • room: Room

    Returns void

  • Experimental

    Parameters

    • _engine: RTCEngine

    Returns void

diff --git a/docs/classes/RNKeyProvider.html b/docs/classes/RNKeyProvider.html index 83ac4a0..f0b66df 100644 --- a/docs/classes/RNKeyProvider.html +++ b/docs/classes/RNKeyProvider.html @@ -1,4 +1,4 @@ -RNKeyProvider | LiveKit React Native Client SDK - v2.9.3

Class RNKeyProviderExperimental

Hierarchy

  • BaseKeyProvider
    • RNKeyProvider
Index

Constructors

constructor +RNKeyProvider | LiveKit React Native Client SDK - v2.9.4

Class RNKeyProviderExperimental

Hierarchy

  • BaseKeyProvider
    • RNKeyProvider
Index

Constructors

Methods

  • Experimental

    Parameters

    • participantId: string

    Returns number

  • Experimental

    Parameters

    • OptionalparticipantIdentity: string
    • OptionalkeyIndex: number

    Returns Promise<void>

  • Experimental

    Parameters

    • OptionalkeyIndex: number

    Returns Promise<void>

  • Experimental

    Accepts a passphrase that's used to create the crypto keys for a participant's stream.

    -

    Parameters

    • participantId: string
    • key: string | Uint8Array<ArrayBufferLike>
    • OptionalkeyIndex: number

    Returns Promise<any>

  • Experimental

    Accepts a passphrase that's used to create the crypto keys.

    -

    Parameters

    • key: string | Uint8Array<ArrayBufferLike>
    • OptionalkeyIndex: number

    Returns Promise<any>

  • Experimental

    Parameters

    • trailer: Uint8Array

    Returns Promise<any>

+

Constructors

Methods

  • Experimental

    Parameters

    • participantId: string

    Returns number

  • Experimental

    Parameters

    • OptionalparticipantIdentity: string
    • OptionalkeyIndex: number

    Returns Promise<void>

  • Experimental

    Parameters

    • OptionalkeyIndex: number

    Returns Promise<void>

  • Experimental

    Accepts a passphrase that's used to create the crypto keys for a participant's stream.

    +

    Parameters

    • participantId: string
    • key: string | Uint8Array<ArrayBufferLike>
    • OptionalkeyIndex: number

    Returns Promise<any>

  • Experimental

    Accepts a passphrase that's used to create the crypto keys.

    +

    Parameters

    • key: string | Uint8Array<ArrayBufferLike>
    • OptionalkeyIndex: number

    Returns Promise<any>

  • Experimental

    Parameters

    • trailer: Uint8Array

    Returns Promise<any>

diff --git a/docs/functions/BarVisualizer.html b/docs/functions/BarVisualizer.html index ba75045..b551d3e 100644 --- a/docs/functions/BarVisualizer.html +++ b/docs/functions/BarVisualizer.html @@ -1,7 +1,7 @@ -BarVisualizer | LiveKit React Native Client SDK - v2.9.3

Function BarVisualizer

Visualizes audio signals from a TrackReference as bars. +BarVisualizer | LiveKit React Native Client SDK - v2.9.4

Function BarVisualizer

Visualizes audio signals from a TrackReference as bars. If the state prop is set, it automatically transitions between VoiceAssistant states.

For VoiceAssistant state transitions this component requires a voice assistant agent running with livekit-agents >= 0.9.0

function SimpleVoiceAssistant() {
const { state, audioTrack } = useVoiceAssistant();
return (
<BarVisualizer
state={state}
trackRef={audioTrack}
/>
);
}
-
+
diff --git a/docs/functions/LiveKitRoom.html b/docs/functions/LiveKitRoom.html index 0b20e2a..9a7ffdf 100644 --- a/docs/functions/LiveKitRoom.html +++ b/docs/functions/LiveKitRoom.html @@ -1,7 +1,7 @@ -LiveKitRoom | LiveKit React Native Client SDK - v2.9.3

Function LiveKitRoom

  • The LiveKitRoom component provides the room context to all its child components. +LiveKitRoom | LiveKit React Native Client SDK - v2.9.4

    Function LiveKitRoom

    • 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.

      Parameters

      Returns Element

      <LiveKitRoom
      token='<livekit-token>'
      serverUrl='<url-to-livekit-server>'
      connect={true}
      >
      ...
      </LiveKitRoom>
      -
    +
diff --git a/docs/functions/VideoView.html b/docs/functions/VideoView.html index 8c6b0e3..ba7a1eb 100644 --- a/docs/functions/VideoView.html +++ b/docs/functions/VideoView.html @@ -1,2 +1,2 @@ -VideoView | LiveKit React Native Client SDK - v2.9.3

Function VideoView

+VideoView | LiveKit React Native Client SDK - v2.9.4

Function VideoView

diff --git a/docs/functions/getDefaultAppleAudioConfigurationForMode.html b/docs/functions/getDefaultAppleAudioConfigurationForMode.html index 005861e..b81297e 100644 --- a/docs/functions/getDefaultAppleAudioConfigurationForMode.html +++ b/docs/functions/getDefaultAppleAudioConfigurationForMode.html @@ -1 +1 @@ -getDefaultAppleAudioConfigurationForMode | LiveKit React Native Client SDK - v2.9.3

Function getDefaultAppleAudioConfigurationForMode

+getDefaultAppleAudioConfigurationForMode | LiveKit React Native Client SDK - v2.9.4

Function getDefaultAppleAudioConfigurationForMode

diff --git a/docs/functions/registerGlobals.html b/docs/functions/registerGlobals.html index fdfedb6..0816d1b 100644 --- a/docs/functions/registerGlobals.html +++ b/docs/functions/registerGlobals.html @@ -1,4 +1,4 @@ -registerGlobals | LiveKit React Native Client SDK - v2.9.3

Function registerGlobals

Returns void

diff --git a/docs/functions/setLogLevel.html b/docs/functions/setLogLevel.html index 9cba502..52143ff 100644 --- a/docs/functions/setLogLevel.html +++ b/docs/functions/setLogLevel.html @@ -1,3 +1,3 @@ -setLogLevel | LiveKit React Native Client SDK - v2.9.3

Function setLogLevel

  • Set the log level for both the @livekit/react-native package and the @livekit-client package. +setLogLevel | LiveKit React Native Client SDK - v2.9.4

    Function setLogLevel

    • 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.

      -

      Parameters

      • level: "trace" | "debug" | "info" | "warn" | "error" | "silent" | LogLevel
      • options: SetLogLevelOptions = {}

      Returns void

    +

    Parameters

    • level: "trace" | "debug" | "info" | "warn" | "error" | "silent" | LogLevel
    • options: SetLogLevelOptions = {}

    Returns void

diff --git a/docs/functions/sortParticipants.html b/docs/functions/sortParticipants.html index e20de4d..017475b 100644 --- a/docs/functions/sortParticipants.html +++ b/docs/functions/sortParticipants.html @@ -1,4 +1,4 @@ -sortParticipants | LiveKit React Native Client SDK - v2.9.3

Function sortParticipants

  • Default sort for participants, it'll order participants by:

    +sortParticipants | LiveKit React Native Client SDK - v2.9.4

    Function sortParticipants

    • Default sort for participants, it'll order participants by:

      1. dominant speaker (speaker with the loudest audio level)
      2. local participant
      3. @@ -6,4 +6,4 @@
      4. participants with video on
      5. by joinedAt
      -

      Parameters

      • participants: Participant[]
      • OptionallocalParticipant: LocalParticipant

      Returns void

    +

    Parameters

    • participants: Participant[]
    • OptionallocalParticipant: LocalParticipant

    Returns void

diff --git a/docs/functions/useBarAnimator.html b/docs/functions/useBarAnimator.html index 6943d26..3cb6195 100644 --- a/docs/functions/useBarAnimator.html +++ b/docs/functions/useBarAnimator.html @@ -1 +1 @@ -useBarAnimator | LiveKit React Native Client SDK - v2.9.3

Function useBarAnimator

  • Parameters

    • state: AgentState | undefined
    • columns: number
    • interval: number

    Returns number[]

+useBarAnimator | LiveKit React Native Client SDK - v2.9.4

Function useBarAnimator

  • Parameters

    • state: AgentState | undefined
    • columns: number
    • interval: number

    Returns number[]

diff --git a/docs/functions/useIOSAudioManagement.html b/docs/functions/useIOSAudioManagement.html index 3081519..89814a1 100644 --- a/docs/functions/useIOSAudioManagement.html +++ b/docs/functions/useIOSAudioManagement.html @@ -1,4 +1,4 @@ -useIOSAudioManagement | LiveKit React Native Client SDK - v2.9.3

Function useIOSAudioManagement

  • Handles setting the appropriate AVAudioSession options automatically +useIOSAudioManagement | LiveKit React Native Client SDK - v2.9.4

    Function useIOSAudioManagement

    • Handles setting the appropriate AVAudioSession options automatically depending on the audio track states of the Room.

      Parameters

      • room: Room
      • preferSpeakerOutput: boolean = true
      • OptionalonConfigureNativeAudio: (
            trackState: AudioTrackState,
            preferSpeakerOutput: boolean,
        ) => AppleAudioConfiguration

        A custom method for determining options used.

        -

      Returns void

    +

Returns void

diff --git a/docs/functions/useMultibandTrackVolume.html b/docs/functions/useMultibandTrackVolume.html index 794b1e8..b912237 100644 --- a/docs/functions/useMultibandTrackVolume.html +++ b/docs/functions/useMultibandTrackVolume.html @@ -1,3 +1,3 @@ -useMultibandTrackVolume | LiveKit React Native Client SDK - v2.9.3

Function useMultibandTrackVolume

  • A hook for tracking the volume of an audio track across multiple frequency bands.

    +useMultibandTrackVolume | LiveKit React Native Client SDK - v2.9.4

    Function useMultibandTrackVolume

    • A hook for tracking the volume of an audio track across multiple frequency bands.

      Parameters

      • OptionaltrackOrTrackReference: LocalAudioTrack | RemoteAudioTrack | TrackReferenceOrPlaceholder
      • Optionaloptions: MultiBandTrackVolumeOptions

      Returns number[]

      A number array containing the volume for each frequency band.

      -
    +
diff --git a/docs/functions/useParticipant.html b/docs/functions/useParticipant.html index a9af824..e3707d2 100644 --- a/docs/functions/useParticipant.html +++ b/docs/functions/useParticipant.html @@ -1,2 +1,2 @@ -useParticipant | LiveKit React Native Client SDK - v2.9.3

Function useParticipant

+useParticipant | LiveKit React Native Client SDK - v2.9.4

Function useParticipant

diff --git a/docs/functions/useRNE2EEManager.html b/docs/functions/useRNE2EEManager.html index b351135..1322084 100644 --- a/docs/functions/useRNE2EEManager.html +++ b/docs/functions/useRNE2EEManager.html @@ -1 +1 @@ -useRNE2EEManager | LiveKit React Native Client SDK - v2.9.3

Function useRNE2EEManager

+useRNE2EEManager | LiveKit React Native Client SDK - v2.9.4

Function useRNE2EEManager

diff --git a/docs/functions/useRoom.html b/docs/functions/useRoom.html index 5fa59e3..9acb64c 100644 --- a/docs/functions/useRoom.html +++ b/docs/functions/useRoom.html @@ -1,2 +1,2 @@ -useRoom | LiveKit React Native Client SDK - v2.9.3

Function useRoom

+useRoom | LiveKit React Native Client SDK - v2.9.4

Function useRoom

diff --git a/docs/functions/useTrackVolume.html b/docs/functions/useTrackVolume.html index 4a7e8ef..9967aa1 100644 --- a/docs/functions/useTrackVolume.html +++ b/docs/functions/useTrackVolume.html @@ -1,3 +1,3 @@ -useTrackVolume | LiveKit React Native Client SDK - v2.9.3

Function useTrackVolume

  • A hook for tracking the volume of an audio track.

    +useTrackVolume | LiveKit React Native Client SDK - v2.9.4

    Function useTrackVolume

    • A hook for tracking the volume of an audio track.

      Parameters

      • OptionaltrackOrTrackReference: LocalAudioTrack | RemoteAudioTrack | TrackReferenceOrPlaceholder

      Returns number

      A number between 0-1 representing the volume.

      -
    +
diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 2fd4b98..7949999 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -LiveKit React Native Client SDK - v2.9.3

LiveKit React Native Client SDK - v2.9.3

Hierarchy Summary

+LiveKit React Native Client SDK - v2.9.4

LiveKit React Native Client SDK - v2.9.4

Hierarchy Summary

diff --git a/docs/index.html b/docs/index.html index f0b1e63..e43bad1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -LiveKit React Native Client SDK - v2.9.3

LiveKit React Native Client SDK - v2.9.3

+LiveKit React Native Client SDK - v2.9.4
+
diff --git a/docs/interfaces/BarVisualizerProps.html b/docs/interfaces/BarVisualizerProps.html index 571eb2b..e3d041c 100644 --- a/docs/interfaces/BarVisualizerProps.html +++ b/docs/interfaces/BarVisualizerProps.html @@ -1,9 +1,9 @@ -BarVisualizerProps | LiveKit React Native Client SDK - v2.9.3

Interface BarVisualizerPropsBeta

interface BarVisualizerProps {
    barCount?: number;
    options?: BarVisualizerOptions;
    state?: AgentState;
    style?: ViewStyle;
    trackRef?: TrackReferenceOrPlaceholder;
}
Index

Properties

barCount? +BarVisualizerProps | LiveKit React Native Client SDK - v2.9.4

Interface BarVisualizerPropsBeta

interface BarVisualizerProps {
    barCount?: number;
    options?: BarVisualizerOptions;
    state?: AgentState;
    style?: ViewStyle;
    trackRef?: TrackReferenceOrPlaceholder;
}
Index

Properties

barCount?: number

Number of bars that show up in the visualizer

-
state?: AgentState

If set, the visualizer will transition between different voice assistant states

-
style?: ViewStyle

Custom React Native styles for the container.

-
trackRef?: TrackReferenceOrPlaceholder
+
state?: AgentState

If set, the visualizer will transition between different voice assistant states

+
style?: ViewStyle

Custom React Native styles for the container.

+
trackRef?: TrackReferenceOrPlaceholder
diff --git a/docs/interfaces/LiveKitRoomProps.html b/docs/interfaces/LiveKitRoomProps.html index e434c5b..2c2bdea 100644 --- a/docs/interfaces/LiveKitRoomProps.html +++ b/docs/interfaces/LiveKitRoomProps.html @@ -1,4 +1,4 @@ -LiveKitRoomProps | LiveKit React Native Client SDK - v2.9.3

Interface LiveKitRoomProps

interface LiveKitRoomProps {
    audio?: boolean | AudioCaptureOptions;
    connect?: boolean;
    connectOptions?: RoomConnectOptions;
    featureFlags?: FeatureFlags;
    onConnected?: () => void;
    onDisconnected?: () => void;
    onEncryptionError?: (error: Error) => void;
    onError?: (error: Error) => void;
    onMediaDeviceFailure?: (failure?: MediaDeviceFailure) => void;
    options?: RoomOptions;
    room?: Room;
    screen?: boolean | ScreenShareCaptureOptions;
    serverUrl: string | undefined;
    simulateParticipants?: number;
    token: string | undefined;
    video?: boolean | VideoCaptureOptions;
}
Index

Properties

audio? +LiveKitRoomProps | LiveKit React Native Client SDK - v2.9.4

Interface LiveKitRoomProps

interface LiveKitRoomProps {
    audio?: boolean | AudioCaptureOptions;
    connect?: boolean;
    connectOptions?: RoomConnectOptions;
    featureFlags?: FeatureFlags;
    onConnected?: () => void;
    onDisconnected?: () => void;
    onEncryptionError?: (error: Error) => void;
    onError?: (error: Error) => void;
    onMediaDeviceFailure?: (failure?: MediaDeviceFailure) => void;
    options?: RoomOptions;
    room?: Room;
    screen?: boolean | ScreenShareCaptureOptions;
    serverUrl: string | undefined;
    simulateParticipants?: number;
    token: string | undefined;
    video?: boolean | VideoCaptureOptions;
}
Index

Properties

Properties

audio?: boolean | AudioCaptureOptions

Publish audio immediately after connecting to your LiveKit room.

connect?: boolean

If set to true a connection to LiveKit room is initiated.

+
connect?: boolean

If set to true a connection to LiveKit room is initiated.

true

-
connectOptions?: RoomConnectOptions

Define options how to connect to the LiveKit server.

+
connectOptions?: RoomConnectOptions

Define options how to connect to the LiveKit server.

featureFlags?: FeatureFlags
onConnected?: () => void
onDisconnected?: () => void
onEncryptionError?: (error: Error) => void
onError?: (error: Error) => void
onMediaDeviceFailure?: (failure?: MediaDeviceFailure) => void
options?: RoomOptions

Options for when creating a new room. +

featureFlags?: FeatureFlags
onConnected?: () => void
onDisconnected?: () => void
onEncryptionError?: (error: Error) => void
onError?: (error: Error) => void
onMediaDeviceFailure?: (failure?: MediaDeviceFailure) => void
options?: RoomOptions

Options 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.

room?: Room

Optional room instance. +

room?: Room

Optional 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.

-
screen?: boolean | ScreenShareCaptureOptions

Publish screen share immediately after connecting to your LiveKit room.

+
screen?: boolean | ScreenShareCaptureOptions

Publish screen share immediately after connecting to your LiveKit room.

serverUrl: string | undefined

URL to the LiveKit server. +

serverUrl: string | undefined

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.

-
simulateParticipants?: number
token: string | undefined

A user specific access token for a client to authenticate to the room. +

simulateParticipants?: number
token: string | undefined

A 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.

video?: boolean | VideoCaptureOptions

Publish video immediately after connecting to your LiveKit room.

+
video?: boolean | VideoCaptureOptions

Publish video immediately after connecting to your LiveKit room.

+
diff --git a/docs/interfaces/MultiBandTrackVolumeOptions.html b/docs/interfaces/MultiBandTrackVolumeOptions.html index 7c0399c..e39f45e 100644 --- a/docs/interfaces/MultiBandTrackVolumeOptions.html +++ b/docs/interfaces/MultiBandTrackVolumeOptions.html @@ -1,10 +1,10 @@ -MultiBandTrackVolumeOptions | LiveKit React Native Client SDK - v2.9.3

Interface MultiBandTrackVolumeOptionsAlpha

Interface for configuring options for the useMultibandTrackVolume hook.

-
interface MultiBandTrackVolumeOptions {
    bands?: number;
    maxFrequency?: number;
    minFrequency?: number;
    updateInterval?: number;
}
Index

Properties

bands? +MultiBandTrackVolumeOptions | LiveKit React Native Client SDK - v2.9.4

Interface MultiBandTrackVolumeOptionsAlpha

Interface for configuring options for the useMultibandTrackVolume hook.

+
interface MultiBandTrackVolumeOptions {
    bands?: number;
    maxFrequency?: number;
    minFrequency?: number;
    updateInterval?: number;
}
Index

Properties

bands?: number

the number of bands to split the audio into

-
maxFrequency?: number

cut off frequency on the higher end

-
minFrequency?: number

cut off frequency on the lower end

-
updateInterval?: number

update should run every x ms

-
+
maxFrequency?: number

cut off frequency on the higher end

+
minFrequency?: number

cut off frequency on the lower end

+
updateInterval?: number

update should run every x ms

+
diff --git a/docs/interfaces/ParticipantState.html b/docs/interfaces/ParticipantState.html index 1857ee1..791bf35 100644 --- a/docs/interfaces/ParticipantState.html +++ b/docs/interfaces/ParticipantState.html @@ -1,5 +1,5 @@ -ParticipantState | LiveKit React Native Client SDK - v2.9.3

Interface ParticipantState

use useRemoteParticipant or useLocalParticipant instead

-
interface ParticipantState {
    cameraPublication?: TrackPublication;
    connectionQuality: ConnectionQuality;
    isLocal: boolean;
    isSpeaking: boolean;
    metadata?: string;
    microphonePublication?: TrackPublication;
    publications: TrackPublication[];
    screenSharePublication?: TrackPublication;
    subscribedTracks: TrackPublication[];
}
Index

Properties

cameraPublication? +ParticipantState | LiveKit React Native Client SDK - v2.9.4

Interface ParticipantState

use useRemoteParticipant or useLocalParticipant instead

+
interface ParticipantState {
    cameraPublication?: TrackPublication;
    connectionQuality: ConnectionQuality;
    isLocal: boolean;
    isSpeaking: boolean;
    metadata?: string;
    microphonePublication?: TrackPublication;
    publications: TrackPublication[];
    screenSharePublication?: TrackPublication;
    subscribedTracks: TrackPublication[];
}
Index

Properties

cameraPublication?: TrackPublication
connectionQuality: ConnectionQuality
isLocal: boolean
isSpeaking: boolean
metadata?: string
microphonePublication?: TrackPublication
publications: TrackPublication[]
screenSharePublication?: TrackPublication
subscribedTracks: TrackPublication[]
+

Properties

cameraPublication?: TrackPublication
connectionQuality: ConnectionQuality
isLocal: boolean
isSpeaking: boolean
metadata?: string
microphonePublication?: TrackPublication
publications: TrackPublication[]
screenSharePublication?: TrackPublication
subscribedTracks: TrackPublication[]
diff --git a/docs/interfaces/RNE2EEManagerState.html b/docs/interfaces/RNE2EEManagerState.html index 5e38231..8932ca4 100644 --- a/docs/interfaces/RNE2EEManagerState.html +++ b/docs/interfaces/RNE2EEManagerState.html @@ -1,3 +1,3 @@ -RNE2EEManagerState | LiveKit React Native Client SDK - v2.9.3

Interface RNE2EEManagerState

interface RNE2EEManagerState {
    e2eeManager: BaseE2EEManager;
    keyProvider: RNKeyProvider;
}
Index

Properties

e2eeManager +RNE2EEManagerState | LiveKit React Native Client SDK - v2.9.4

Interface RNE2EEManagerState

interface RNE2EEManagerState {
    e2eeManager: BaseE2EEManager;
    keyProvider: RNKeyProvider;
}
Index

Properties

e2eeManager: BaseE2EEManager
keyProvider: RNKeyProvider
+

Properties

e2eeManager: BaseE2EEManager
keyProvider: RNKeyProvider
diff --git a/docs/interfaces/RegisterGlobalsOptions.html b/docs/interfaces/RegisterGlobalsOptions.html index 2b6ef23..a1ea203 100644 --- a/docs/interfaces/RegisterGlobalsOptions.html +++ b/docs/interfaces/RegisterGlobalsOptions.html @@ -1,8 +1,8 @@ -RegisterGlobalsOptions | LiveKit React Native Client SDK - v2.9.3

Interface RegisterGlobalsOptions

interface RegisterGlobalsOptions {
    autoConfigureAudioSession?: boolean;
}
Index

Properties

autoConfigureAudioSession? +RegisterGlobalsOptions | LiveKit React Native Client SDK - v2.9.4

Interface RegisterGlobalsOptions

interface RegisterGlobalsOptions {
    autoConfigureAudioSession?: boolean;
}
Index

Properties

autoConfigureAudioSession?: boolean

Automatically configure audio session before accessing microphone. When enabled, sets the iOS audio category to 'playAndRecord' before getUserMedia. Has no effect on non-iOS platforms.

true
 
-
+
diff --git a/docs/interfaces/RoomOptions.html b/docs/interfaces/RoomOptions.html index fb4dcf0..50d5f81 100644 --- a/docs/interfaces/RoomOptions.html +++ b/docs/interfaces/RoomOptions.html @@ -1,2 +1,2 @@ -RoomOptions | LiveKit React Native Client SDK - v2.9.3

Interface RoomOptions

interface RoomOptions {
    sortParticipants?: (participants: Participant[]) => void;
}
Index

Properties

Properties

sortParticipants?: (participants: Participant[]) => void
+RoomOptions | LiveKit React Native Client SDK - v2.9.4

Interface RoomOptions

interface RoomOptions {
    sortParticipants?: (participants: Participant[]) => void;
}
Index

Properties

Properties

sortParticipants?: (participants: Participant[]) => void
diff --git a/docs/interfaces/RoomState.html b/docs/interfaces/RoomState.html index 15ba86d..1f63289 100644 --- a/docs/interfaces/RoomState.html +++ b/docs/interfaces/RoomState.html @@ -1,5 +1,5 @@ -RoomState | LiveKit React Native Client SDK - v2.9.3

Interface RoomState

interface RoomState {
    audioTracks: AudioTrack[];
    error?: Error;
    participants: Participant[];
    room?: Room;
}
Index

Properties

audioTracks +RoomState | LiveKit React Native Client SDK - v2.9.4

Interface RoomState

interface RoomState {
    audioTracks: AudioTrack[];
    error?: Error;
    participants: Participant[];
    room?: Room;
}
Index

Properties

audioTracks: AudioTrack[]
error?: Error
participants: Participant[]
room?: Room
+

Properties

audioTracks: AudioTrack[]
error?: Error
participants: Participant[]
room?: Room
diff --git a/docs/modules.html b/docs/modules.html index 836a2f1..87a3010 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1 +1 @@ -LiveKit React Native Client SDK - v2.9.3
+LiveKit React Native Client SDK - v2.9.4
diff --git a/docs/types/AndroidAudioTypeOptions.html b/docs/types/AndroidAudioTypeOptions.html index 939ead9..13a527a 100644 --- a/docs/types/AndroidAudioTypeOptions.html +++ b/docs/types/AndroidAudioTypeOptions.html @@ -1,4 +1,4 @@ -AndroidAudioTypeOptions | LiveKit React Native Client SDK - v2.9.3

Type Alias AndroidAudioTypeOptions

type AndroidAudioTypeOptions = {
    audioAttributesContentType?:
        | "movie"
        | "music"
        | "sonification"
        | "speech"
        | "unknown";
    audioAttributesUsageType?: | "alarm"
    | "assistanceAccessibility"
    | "assistanceNavigationGuidance"
    | "assistanceSonification"
    | "assistant"
    | "game"
    | "media"
    | "notification"
    | "notificationEvent"
    | "notificationRingtone"
    | "unknown"
    | "voiceCommunication"
    | "voiceCommunicationSignalling";
    audioFocusMode?: | "gain"
    | "gainTransient"
    | "gainTransientExclusive"
    | "gainTransientMayDuck";
    audioMode?: | "normal"
    | "callScreening"
    | "inCall"
    | "inCommunication"
    | "ringtone";
    audioStreamType?: | "accessibility"
    | "alarm"
    | "dtmf"
    | "music"
    | "notification"
    | "ring"
    | "system"
    | "voiceCall";
    forceHandleAudioRouting?: boolean;
    manageAudioFocus?: boolean;
}
Index

Properties

audioAttributesContentType? +AndroidAudioTypeOptions | LiveKit React Native Client SDK - v2.9.4

Type Alias AndroidAudioTypeOptions

type AndroidAudioTypeOptions = {
    audioAttributesContentType?:
        | "movie"
        | "music"
        | "sonification"
        | "speech"
        | "unknown";
    audioAttributesUsageType?: | "alarm"
    | "assistanceAccessibility"
    | "assistanceNavigationGuidance"
    | "assistanceSonification"
    | "assistant"
    | "game"
    | "media"
    | "notification"
    | "notificationEvent"
    | "notificationRingtone"
    | "unknown"
    | "voiceCommunication"
    | "voiceCommunicationSignalling";
    audioFocusMode?: | "gain"
    | "gainTransient"
    | "gainTransientExclusive"
    | "gainTransientMayDuck";
    audioMode?: | "normal"
    | "callScreening"
    | "inCall"
    | "inCommunication"
    | "ringtone";
    audioStreamType?: | "accessibility"
    | "alarm"
    | "dtmf"
    | "music"
    | "notification"
    | "ring"
    | "system"
    | "voiceCall";
    forceHandleAudioRouting?: boolean;
    manageAudioFocus?: boolean;
}
Index

Properties

audioAttributesContentType?:
    | "movie"
    | "music"
    | "sonification"
    | "speech"
    | "unknown"

Corresponds to Android's AndroidAttributes content type.

Defaults to 'speech'.

See also https://developer.android.com/reference/android/media/AudioAttributes

-
audioAttributesUsageType?:
    | "alarm"
    | "assistanceAccessibility"
    | "assistanceNavigationGuidance"
    | "assistanceSonification"
    | "assistant"
    | "game"
    | "media"
    | "notification"
    | "notificationEvent"
    | "notificationRingtone"
    | "unknown"
    | "voiceCommunication"
    | "voiceCommunicationSignalling"

Corresponds to Android's AudioAttributes usage type.

+
audioAttributesUsageType?:
    | "alarm"
    | "assistanceAccessibility"
    | "assistanceNavigationGuidance"
    | "assistanceSonification"
    | "assistant"
    | "game"
    | "media"
    | "notification"
    | "notificationEvent"
    | "notificationRingtone"
    | "unknown"
    | "voiceCommunication"
    | "voiceCommunicationSignalling"

Corresponds to Android's AudioAttributes usage type.

Defaults to 'voiceCommunication'.

See also https://developer.android.com/reference/android/media/AudioAttributes

-
audioFocusMode?:
    | "gain"
    | "gainTransient"
    | "gainTransientExclusive"
    | "gainTransientMayDuck"

Corresponds to the duration hint when requesting audio focus.

+
audioFocusMode?:
    | "gain"
    | "gainTransient"
    | "gainTransientExclusive"
    | "gainTransientMayDuck"

Corresponds to the duration hint when requesting audio focus.

Defaults to 'gain'.

See also https://developer.android.com/reference/android/media/AudioManager#AUDIOFOCUS_GAIN

-
audioMode?:
    | "normal"
    | "callScreening"
    | "inCall"
    | "inCommunication"
    | "ringtone"
audioMode?:
    | "normal"
    | "callScreening"
    | "inCall"
    | "inCommunication"
    | "ringtone"
audioStreamType?:
    | "accessibility"
    | "alarm"
    | "dtmf"
    | "music"
    | "notification"
    | "ring"
    | "system"
    | "voiceCall"

Corresponds to the stream type when requesting audio focus. Used on pre-O devices.

+
audioStreamType?:
    | "accessibility"
    | "alarm"
    | "dtmf"
    | "music"
    | "notification"
    | "ring"
    | "system"
    | "voiceCall"

Corresponds 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

-
forceHandleAudioRouting?: boolean

On certain Android devices, audio routing does not function properly and +

forceHandleAudioRouting?: boolean

On 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.

-
manageAudioFocus?: boolean

Whether LiveKit should handle managing the audio focus or not.

+
manageAudioFocus?: boolean

Whether LiveKit should handle managing the audio focus or not.

Defaults to true.

-
+
diff --git a/docs/types/AppleAudioCategory.html b/docs/types/AppleAudioCategory.html index 76c4b61..6eb4ed6 100644 --- a/docs/types/AppleAudioCategory.html +++ b/docs/types/AppleAudioCategory.html @@ -1 +1 @@ -AppleAudioCategory | LiveKit React Native Client SDK - v2.9.3

Type Alias AppleAudioCategory

AppleAudioCategory:
    | "soloAmbient"
    | "playback"
    | "record"
    | "playAndRecord"
    | "multiRoute"
+AppleAudioCategory | LiveKit React Native Client SDK - v2.9.4

Type Alias AppleAudioCategory

AppleAudioCategory:
    | "soloAmbient"
    | "playback"
    | "record"
    | "playAndRecord"
    | "multiRoute"
diff --git a/docs/types/AppleAudioCategoryOption.html b/docs/types/AppleAudioCategoryOption.html index 97f87fd..2fb6de3 100644 --- a/docs/types/AppleAudioCategoryOption.html +++ b/docs/types/AppleAudioCategoryOption.html @@ -1 +1 @@ -AppleAudioCategoryOption | LiveKit React Native Client SDK - v2.9.3

Type Alias AppleAudioCategoryOption

AppleAudioCategoryOption:
    | "mixWithOthers"
    | "duckOthers"
    | "interruptSpokenAudioAndMixWithOthers"
    | "allowBluetooth"
    | "allowBluetoothA2DP"
    | "allowAirPlay"
    | "defaultToSpeaker"
+AppleAudioCategoryOption | LiveKit React Native Client SDK - v2.9.4

Type Alias AppleAudioCategoryOption

AppleAudioCategoryOption:
    | "mixWithOthers"
    | "duckOthers"
    | "interruptSpokenAudioAndMixWithOthers"
    | "allowBluetooth"
    | "allowBluetoothA2DP"
    | "allowAirPlay"
    | "defaultToSpeaker"
diff --git a/docs/types/AppleAudioConfiguration.html b/docs/types/AppleAudioConfiguration.html index 52356c8..5e20742 100644 --- a/docs/types/AppleAudioConfiguration.html +++ b/docs/types/AppleAudioConfiguration.html @@ -1,4 +1,4 @@ -AppleAudioConfiguration | LiveKit React Native Client SDK - v2.9.3

Type Alias AppleAudioConfiguration

type AppleAudioConfiguration = {
    audioCategory?: AppleAudioCategory;
    audioCategoryOptions?: AppleAudioCategoryOption[];
    audioMode?: AppleAudioMode;
}
Index

Properties

audioCategory? +AppleAudioConfiguration | LiveKit React Native Client SDK - v2.9.4

Type Alias AppleAudioConfiguration

type AppleAudioConfiguration = {
    audioCategory?: AppleAudioCategory;
    audioCategoryOptions?: AppleAudioCategoryOption[];
    audioMode?: AppleAudioMode;
}
Index

Properties

audioCategory?: AppleAudioCategory
audioCategoryOptions?: AppleAudioCategoryOption[]
audioMode?: AppleAudioMode
+

Properties

audioCategory?: AppleAudioCategory
audioCategoryOptions?: AppleAudioCategoryOption[]
audioMode?: AppleAudioMode
diff --git a/docs/types/AppleAudioMode.html b/docs/types/AppleAudioMode.html index 002720d..3bfd0fe 100644 --- a/docs/types/AppleAudioMode.html +++ b/docs/types/AppleAudioMode.html @@ -1 +1 @@ -AppleAudioMode | LiveKit React Native Client SDK - v2.9.3

Type Alias AppleAudioMode

AppleAudioMode:
    | "default"
    | "gameChat"
    | "measurement"
    | "moviePlayback"
    | "spokenAudio"
    | "videoChat"
    | "videoRecording"
    | "voiceChat"
    | "voicePrompt"
+AppleAudioMode | LiveKit React Native Client SDK - v2.9.4

Type Alias AppleAudioMode

AppleAudioMode:
    | "default"
    | "gameChat"
    | "measurement"
    | "moviePlayback"
    | "spokenAudio"
    | "videoChat"
    | "videoRecording"
    | "voiceChat"
    | "voicePrompt"
diff --git a/docs/types/AudioConfiguration.html b/docs/types/AudioConfiguration.html index 2feb945..f0ef080 100644 --- a/docs/types/AudioConfiguration.html +++ b/docs/types/AudioConfiguration.html @@ -1,4 +1,4 @@ -AudioConfiguration | LiveKit React Native Client SDK - v2.9.3

Type Alias AudioConfiguration

Configuration for the underlying AudioSession.

+AudioConfiguration | LiveKit React Native Client SDK - v2.9.4

Type Alias AudioConfiguration

Configuration for the underlying AudioSession.


Android specific options:

    @@ -27,6 +27,6 @@

    By default, this is set to "speaker"

-
type AudioConfiguration = {
    android?: {
        audioTypeOptions: AndroidAudioTypeOptions;
        preferredOutputList?: ("speaker" | "earpiece" | "headset" | "bluetooth")[];
    };
    ios?: { defaultOutput?: "speaker"
    | "earpiece" };
}
Index

Properties

type AudioConfiguration = {
    android?: {
        audioTypeOptions: AndroidAudioTypeOptions;
        preferredOutputList?: ("speaker" | "earpiece" | "headset" | "bluetooth")[];
    };
    ios?: { defaultOutput?: "speaker"
    | "earpiece" };
}
Index

Properties

Properties

android?: {
    audioTypeOptions: AndroidAudioTypeOptions;
    preferredOutputList?: ("speaker" | "earpiece" | "headset" | "bluetooth")[];
}
ios?: { defaultOutput?: "speaker" | "earpiece" }
+

Properties

android?: {
    audioTypeOptions: AndroidAudioTypeOptions;
    preferredOutputList?: ("speaker" | "earpiece" | "headset" | "bluetooth")[];
}
ios?: { defaultOutput?: "speaker" | "earpiece" }
diff --git a/docs/types/AudioTrackState.html b/docs/types/AudioTrackState.html index 47acd79..8415d16 100644 --- a/docs/types/AudioTrackState.html +++ b/docs/types/AudioTrackState.html @@ -1 +1 @@ -AudioTrackState | LiveKit React Native Client SDK - v2.9.3

Type Alias AudioTrackState

AudioTrackState: "none" | "remoteOnly" | "localOnly" | "localAndRemote"
+AudioTrackState | LiveKit React Native Client SDK - v2.9.4

Type Alias AudioTrackState

AudioTrackState: "none" | "remoteOnly" | "localOnly" | "localAndRemote"
diff --git a/docs/types/BarVisualizerOptions.html b/docs/types/BarVisualizerOptions.html index 0ade4ae..841e3d3 100644 --- a/docs/types/BarVisualizerOptions.html +++ b/docs/types/BarVisualizerOptions.html @@ -1,8 +1,8 @@ -BarVisualizerOptions | LiveKit React Native Client SDK - v2.9.3

Type Alias BarVisualizerOptions

type BarVisualizerOptions = {
    barBorderRadius?: number;
    barColor?: ColorValue;
    barWidth?: DimensionValue;
    maxHeight?: number;
    minHeight?: number;
}
Index

Properties

barBorderRadius? +BarVisualizerOptions | LiveKit React Native Client SDK - v2.9.4

Type Alias BarVisualizerOptions

type BarVisualizerOptions = {
    barBorderRadius?: number;
    barColor?: ColorValue;
    barWidth?: DimensionValue;
    maxHeight?: number;
    minHeight?: number;
}
Index

Properties

barBorderRadius?: number
barColor?: ColorValue
barWidth?: DimensionValue
maxHeight?: number

decimal values from 0 to 1

-
minHeight?: number

decimal values from 0 to 1

-
+

Properties

barBorderRadius?: number
barColor?: ColorValue
barWidth?: DimensionValue
maxHeight?: number

decimal values from 0 to 1

+
minHeight?: number

decimal values from 0 to 1

+
diff --git a/docs/types/LogLevel.html b/docs/types/LogLevel.html index 1e2c303..3cdb014 100644 --- a/docs/types/LogLevel.html +++ b/docs/types/LogLevel.html @@ -1 +1 @@ -LogLevel | LiveKit React Native Client SDK - v2.9.3

Type Alias LogLevel

LogLevel: Parameters<typeof setClientSdkLogLevel>[0]
+LogLevel | LiveKit React Native Client SDK - v2.9.4

Type Alias LogLevel

LogLevel: Parameters<typeof setClientSdkLogLevel>[0]
diff --git a/docs/types/Props.html b/docs/types/Props.html index 701325f..899f6c8 100644 --- a/docs/types/Props.html +++ b/docs/types/Props.html @@ -1,7 +1,7 @@ -Props | LiveKit React Native Client SDK - v2.9.3

Type Alias Props

use VideoTrack and VideoTrackProps instead.

-
type Props = {
    mirror?: boolean;
    objectFit?: "cover" | "contain";
    style?: ViewStyle;
    videoTrack?: VideoTrack;
    zOrder?: number;
}
Index

Properties

mirror? +Props | LiveKit React Native Client SDK - v2.9.4

Type Alias Props

use VideoTrack and VideoTrackProps instead.

+
type Props = {
    mirror?: boolean;
    objectFit?: "cover" | "contain";
    style?: ViewStyle;
    videoTrack?: VideoTrack;
    zOrder?: number;
}
Index

Properties

mirror?: boolean
objectFit?: "cover" | "contain"
style?: ViewStyle
videoTrack?: VideoTrack
zOrder?: number
+

Properties

mirror?: boolean
objectFit?: "cover" | "contain"
style?: ViewStyle
videoTrack?: VideoTrack
zOrder?: number
diff --git a/docs/types/RNKeyProviderOptions.html b/docs/types/RNKeyProviderOptions.html index f0ed1a7..64a4a4a 100644 --- a/docs/types/RNKeyProviderOptions.html +++ b/docs/types/RNKeyProviderOptions.html @@ -1,2 +1,2 @@ -RNKeyProviderOptions | LiveKit React Native Client SDK - v2.9.3

Type Alias RNKeyProviderOptions

RNKeyProviderOptions: KeyProviderOptions & {
    uncryptedMagicBytes?: string | Uint8Array;
}

Options for construction an RNKeyProvider

-
+RNKeyProviderOptions | LiveKit React Native Client SDK - v2.9.4

Type Alias RNKeyProviderOptions

RNKeyProviderOptions: KeyProviderOptions & {
    uncryptedMagicBytes?: string | Uint8Array;
}

Options for construction an RNKeyProvider

+
diff --git a/docs/types/SetLogLevelOptions.html b/docs/types/SetLogLevelOptions.html index d869185..ec10381 100644 --- a/docs/types/SetLogLevelOptions.html +++ b/docs/types/SetLogLevelOptions.html @@ -1,2 +1,2 @@ -SetLogLevelOptions | LiveKit React Native Client SDK - v2.9.3

Type Alias SetLogLevelOptions

type SetLogLevelOptions = {
    liveKitClientLogLevel?: LogLevel;
}
Index

Properties

liveKitClientLogLevel?: LogLevel
+SetLogLevelOptions | LiveKit React Native Client SDK - v2.9.4

Type Alias SetLogLevelOptions

type SetLogLevelOptions = {
    liveKitClientLogLevel?: LogLevel;
}
Index

Properties

liveKitClientLogLevel?: LogLevel
diff --git a/docs/types/UseRNE2EEManagerOptions.html b/docs/types/UseRNE2EEManagerOptions.html index df1d6b1..87fe64b 100644 --- a/docs/types/UseRNE2EEManagerOptions.html +++ b/docs/types/UseRNE2EEManagerOptions.html @@ -1,3 +1,3 @@ -UseRNE2EEManagerOptions | LiveKit React Native Client SDK - v2.9.3

Type Alias UseRNE2EEManagerOptions

type UseRNE2EEManagerOptions = {
    keyProviderOptions?: RNKeyProviderOptions;
    sharedKey: string | Uint8Array;
}
Index

Properties

keyProviderOptions? +UseRNE2EEManagerOptions | LiveKit React Native Client SDK - v2.9.4

Type Alias UseRNE2EEManagerOptions

type UseRNE2EEManagerOptions = {
    keyProviderOptions?: RNKeyProviderOptions;
    sharedKey: string | Uint8Array;
}
Index

Properties

keyProviderOptions?: RNKeyProviderOptions
sharedKey: string | Uint8Array
+

Properties

keyProviderOptions?: RNKeyProviderOptions
sharedKey: string | Uint8Array
diff --git a/docs/types/VideoTrackProps.html b/docs/types/VideoTrackProps.html index 8a0aa93..d5c262b 100644 --- a/docs/types/VideoTrackProps.html +++ b/docs/types/VideoTrackProps.html @@ -1,5 +1,5 @@ -VideoTrackProps | LiveKit React Native Client SDK - v2.9.3

Type Alias VideoTrackProps

Props for the VideoTrack component.

-
type VideoTrackProps = {
    iosPIP?: RTCIOSPIPOptions & {
        fallbackView?: ReactNode;
        preferredSize: { height: number; width: number };
    };
    mirror?: boolean;
    objectFit?: "cover"
    | "contain";
    style?: ViewStyle;
    trackRef: TrackReference | undefined;
    zOrder?: number;
}
Index

Properties

iosPIP? +VideoTrackProps | LiveKit React Native Client SDK - v2.9.4

Type Alias VideoTrackProps

Props for the VideoTrack component.

+
type VideoTrackProps = {
    iosPIP?: RTCIOSPIPOptions & {
        fallbackView?: ReactNode;
        preferredSize: { height: number; width: number };
    };
    mirror?: boolean;
    objectFit?: "cover"
    | "contain";
    style?: ViewStyle;
    trackRef: TrackReference | undefined;
    zOrder?: number;
}
Index

Properties

iosPIP? mirror? objectFit? style? @@ -15,15 +15,15 @@
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);
-
mirror?: boolean

Indicates whether the video should be mirrored during rendering. +

mirror?: boolean

Indicates whether the video should be mirrored during rendering. This is commonly used for front-facing cameras.

-
objectFit?: "cover" | "contain"

Specifies how the video content should be resized to fit its container. +

objectFit?: "cover" | "contain"

Specifies 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.

-
style?: ViewStyle

Custom React Native styles for the video container.

-
trackRef: TrackReference | undefined

The track reference to display. This should be a TrackReference object +

style?: ViewStyle

Custom React Native styles for the video container.

+
trackRef: TrackReference | undefined

The track reference to display. This should be a TrackReference object or undefined if no track is available.

-
zOrder?: number

Specifies the depth-stacking order of this video view in the stacking space of all video views. +

zOrder?: number

Specifies 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).

-
+
diff --git a/docs/variables/AndroidAudioTypePresets.html b/docs/variables/AndroidAudioTypePresets.html index 7d910e0..6919e1a 100644 --- a/docs/variables/AndroidAudioTypePresets.html +++ b/docs/variables/AndroidAudioTypePresets.html @@ -1,3 +1,3 @@ -AndroidAudioTypePresets | LiveKit React Native Client SDK - v2.9.3

Variable AndroidAudioTypePresetsConst

AndroidAudioTypePresets: {
    communication: AndroidAudioTypeOptions;
    media: AndroidAudioTypeOptions;
} = ...

Type Declaration

diff --git a/docs/variables/VideoTrack.html b/docs/variables/VideoTrack.html index e1b8e4c..82c0bf8 100644 --- a/docs/variables/VideoTrack.html +++ b/docs/variables/VideoTrack.html @@ -1,5 +1,5 @@ -VideoTrack | LiveKit React Native Client SDK - v2.9.3

Variable VideoTrackConst

VideoTrack: ForwardRefExoticComponent<
    VideoTrackProps & RefAttributes<
        Component<RTCVideoViewProps, {}, any> & NativeMethods,
    >,
> = ...

VideoTrack component for displaying video tracks in a React Native application. +VideoTrack | LiveKit React Native Client SDK - v2.9.4

Variable VideoTrackConst

VideoTrack: ForwardRefExoticComponent<
    VideoTrackProps & RefAttributes<
        Component<RTCVideoViewProps, {}, any> & NativeMethods,
    >,
> = ...

VideoTrack 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.

See VideoTrackProps for details.

A React component that renders the given video track.

-
+
diff --git a/docs/variables/log.html b/docs/variables/log.html index d231829..d44f68f 100644 --- a/docs/variables/log.html +++ b/docs/variables/log.html @@ -1 +1 @@ -log | LiveKit React Native Client SDK - v2.9.3

Variable logConst

log: Logger = ...
+log | LiveKit React Native Client SDK - v2.9.4

Variable logConst

log: Logger = ...
diff --git a/example/ios/Podfile.lock b/example/ios/Podfile.lock index 1e31a6a..0815ad4 100644 --- a/example/ios/Podfile.lock +++ b/example/ios/Podfile.lock @@ -8,7 +8,7 @@ PODS: - hermes-engine (0.82.0): - hermes-engine/Pre-built (= 0.82.0) - hermes-engine/Pre-built (0.82.0) - - livekit-react-native (2.9.3): + - livekit-react-native (2.9.4): - boost - DoubleConversion - fast_float @@ -2764,7 +2764,7 @@ SPEC CHECKSUMS: fmt: a40bb5bd0294ea969aaaba240a927bd33d878cdd glog: 5683914934d5b6e4240e497e0f4a3b42d1854183 hermes-engine: 8642d8f14a548ab718ec112e9bebdfdd154138b5 - livekit-react-native: 358861143b3c4eeaf2939187065b0d0053bb6167 + livekit-react-native: 476b0f45ace56d48b75e9e282bfd9ccd6d489dc7 livekit-react-native-webrtc: 3bb1be767c4e489f69bca662eba1c5e7b1e1be0d RCT-Folly: 59ec0ac1f2f39672a0c6e6cecdd39383b764646f RCTDeprecation: 22bf66112da540a7d40e536366ddd8557934fca1 diff --git a/package.json b/package.json index 8f6e937..0d595d5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@livekit/react-native", - "version": "2.9.3", + "version": "2.9.4", "description": "LiveKit for React Native", "main": "lib/commonjs/index", "module": "lib/module/index",