From 6d836f9e2a3ed162e3d3f899fec896f9d5e3c221 Mon Sep 17 00:00:00 2001 From: davidliu Date: Tue, 24 Jun 2025 15:24:15 +0900 Subject: [PATCH] chore: release 2.7.5 --- docs/classes/AudioSession.html | 16 +++++++-------- docs/classes/RNE2EEManager.html | 4 ++-- docs/classes/RNKeyProvider.html | 8 ++++---- docs/functions/BarVisualizer.html | 4 ++-- docs/functions/LiveKitRoom.html | 4 ++-- docs/functions/VideoTrack.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/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/RoomOptions.html | 4 ++-- docs/interfaces/RoomState.html | 4 ++-- docs/modules.html | 4 ++-- docs/types/AndroidAudioTypeOptions.html | 4 ++-- docs/types/AppleAudioCategory.html | 2 +- docs/types/AppleAudioCategoryOption.html | 2 +- docs/types/AppleAudioConfiguration.html | 2 +- docs/types/AppleAudioMode.html | 2 +- docs/types/AudioConfiguration.html | 4 ++-- docs/types/AudioTrackState.html | 2 +- docs/types/BarVisualizerOptions.html | 4 ++-- docs/types/LogLevel.html | 2 +- docs/types/Props.html | 4 ++-- docs/types/RNKeyProviderOptions.html | 4 ++-- docs/types/SetLogLevelOptions.html | 2 +- docs/types/UseRNE2EEManagerOptions.html | 2 +- docs/types/VideoTrackProps.html | 4 ++-- docs/variables/AndroidAudioTypePresets.html | 4 ++-- docs/variables/log.html | 2 +- example/ios/Podfile.lock | 4 ++-- package.json | 2 +- 45 files changed, 100 insertions(+), 100 deletions(-) diff --git a/docs/classes/AudioSession.html b/docs/classes/AudioSession.html index 18d68183..f838a514 100644 --- a/docs/classes/AudioSession.html +++ b/docs/classes/AudioSession.html @@ -1,4 +1,4 @@ -AudioSession | LiveKit React Native Client SDK - v2.7.4

Class AudioSession

Constructors

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

Class AudioSession

Constructors

constructor

Methods

configureAudio getAudioOutputs selectAudioOutput @@ -9,7 +9,7 @@

Constructors

constructor

Methods

Static configureAudio

  • configureAudio(config): Promise<void>

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

Static getAudioOutputs

Static getAudioOutputs

  • getAudioOutputs(): Promise<string[]>

  • Gets the available audio outputs for use with selectAudioOutput.

    startAudioSession must be called prior to using this method.

    For Android, will return if available:

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

    Returns Promise<string[]>

    the available audio output types

    -

Static selectAudioOutput

Static selectAudioOutput

Static setAppleAudioConfiguration

  • setAppleAudioConfiguration(config): Promise<void>

  • Directly change the AVAudioSession category/mode.

    +

Returns Promise<void>

Static setAppleAudioConfiguration

  • setAppleAudioConfiguration(config): Promise<void>

  • Directly change the AVAudioSession category/mode.

    Parameters

    • config: AppleAudioConfiguration

      The configuration to use. Null values will be omitted and the existing values will be unchanged.

      -

    Returns Promise<void>

Static showAudioRoutePicker

  • showAudioRoutePicker(): Promise<void>

  • iOS only, requires iOS 11+.

    +

Returns Promise<void>

Static showAudioRoutePicker

  • showAudioRoutePicker(): Promise<void>

  • iOS only, requires iOS 11+.

    Displays an AVRoutePickerView for the user to choose their audio output.

    -

    Returns Promise<void>

Static startAudioSession

Static stopAudioSession

Settings

Member Visibility

Theme

On This Page

constructorconfigureAudiogetAudioOutputsselectAudioOutputsetAppleAudioConfigurationshowAudioRoutePickerstartAudioSessionstopAudioSession
\ No newline at end of file +

Returns Promise<void>

Static startAudioSession

Static stopAudioSession

Settings

Member Visibility

Theme

On This Page

constructorconfigureAudiogetAudioOutputsselectAudioOutputsetAppleAudioConfigurationshowAudioRoutePickerstartAudioSessionstopAudioSession
\ No newline at end of file diff --git a/docs/classes/RNE2EEManager.html b/docs/classes/RNE2EEManager.html index a9a29417..09c7b28b 100644 --- a/docs/classes/RNE2EEManager.html +++ b/docs/classes/RNE2EEManager.html @@ -1,6 +1,6 @@ -RNE2EEManager | LiveKit React Native Client SDK - v2.7.4

Class RNE2EEManagerExperimental

Hierarchy

  • TypedEventEmitter<E2EEManagerCallbacks, this>
    • RNE2EEManager

Implements

  • BaseE2EEManager

Constructors

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

Class RNE2EEManagerExperimental

Hierarchy

  • TypedEventEmitter<E2EEManagerCallbacks, this>
    • RNE2EEManager

Implements

  • BaseE2EEManager

Constructors

constructor

Methods

setParticipantCryptorEnabled setSifTrailer setup setupEngine -

Constructors

constructor

Methods

setParticipantCryptorEnabled

  • setParticipantCryptorEnabled(enabled, participantIdentity): void

  • Parameters

    • enabled: boolean
    • participantIdentity: string

    Returns void

setSifTrailer

  • setSifTrailer(trailer): void

  • Parameters

    • trailer: Uint8Array

    Returns void

setup

setupEngine

  • setupEngine(_engine): void

  • Parameters

    • _engine: default

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorsetParticipantCryptorEnabledsetSifTrailersetupsetupEngine
\ No newline at end of file +

Constructors

constructor

Methods

setParticipantCryptorEnabled

  • setParticipantCryptorEnabled(enabled, participantIdentity): void

  • Parameters

    • enabled: boolean
    • participantIdentity: string

    Returns void

setSifTrailer

  • setSifTrailer(trailer): void

  • Parameters

    • trailer: Uint8Array

    Returns void

setup

setupEngine

  • setupEngine(_engine): void

  • Parameters

    • _engine: default

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorsetParticipantCryptorEnabledsetSifTrailersetupsetupEngine
\ No newline at end of file diff --git a/docs/classes/RNKeyProvider.html b/docs/classes/RNKeyProvider.html index 6a0c4b9e..1f1c6d55 100644 --- a/docs/classes/RNKeyProvider.html +++ b/docs/classes/RNKeyProvider.html @@ -1,4 +1,4 @@ -RNKeyProvider | LiveKit React Native Client SDK - v2.7.4

Class RNKeyProviderExperimental

Hierarchy

  • BaseKeyProvider
    • RNKeyProvider

Constructors

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

Class RNKeyProviderExperimental

Hierarchy

  • BaseKeyProvider
    • RNKeyProvider

Constructors

constructor

Methods

dispose getLatestKeyIndex ratchetKey @@ -6,6 +6,6 @@ setKey setSharedKey setSifTrailer -

Constructors

constructor

Methods

dispose

getLatestKeyIndex

ratchetKey

  • ratchetKey(participantIdentity?, keyIndex?): Promise<void>

  • Parameters

    • Optional participantIdentity: string
    • Optional keyIndex: number

    Returns Promise<void>

ratchetSharedKey

setKey

  • setKey(participantId, key, keyIndex?): Promise<any>

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

    -

    Parameters

    • participantId: string
    • key: string | Uint8Array
    • Optional keyIndex: number

    Returns Promise<any>

setSharedKey

  • setSharedKey(key, keyIndex?): Promise<any>

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

    -

    Parameters

    • key: string | Uint8Array
    • Optional keyIndex: number

    Returns Promise<any>

setSifTrailer

Settings

Member Visibility

Theme

On This Page

constructordisposegetLatestKeyIndexratchetKeyratchetSharedKeysetKeysetSharedKeysetSifTrailer
\ No newline at end of file +

Constructors

constructor

Methods

dispose

getLatestKeyIndex

ratchetKey

  • ratchetKey(participantIdentity?, keyIndex?): Promise<void>

  • Parameters

    • Optional participantIdentity: string
    • Optional keyIndex: number

    Returns Promise<void>

ratchetSharedKey

setKey

  • setKey(participantId, key, keyIndex?): Promise<any>

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

    +

    Parameters

    • participantId: string
    • key: string | Uint8Array
    • Optional keyIndex: number

    Returns Promise<any>

setSharedKey

  • setSharedKey(key, keyIndex?): Promise<any>

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

    +

    Parameters

    • key: string | Uint8Array
    • Optional keyIndex: number

    Returns Promise<any>

setSifTrailer

Settings

Member Visibility

Theme

On This Page

constructordisposegetLatestKeyIndexratchetKeyratchetSharedKeysetKeysetSharedKeysetSifTrailer
\ No newline at end of file diff --git a/docs/functions/BarVisualizer.html b/docs/functions/BarVisualizer.html index 6fcb4464..52b3aded 100644 --- a/docs/functions/BarVisualizer.html +++ b/docs/functions/BarVisualizer.html @@ -1,6 +1,6 @@ -BarVisualizer | LiveKit React Native Client SDK - v2.7.4

Function BarVisualizer

  • BarVisualizer(__namedParameters): Element
  • Beta

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

    Function BarVisualizer

    • BarVisualizer(__namedParameters): Element
    • Beta

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

      Parameters

      Returns Element

      Remarks

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

      Example

      function SimpleVoiceAssistant() {
        const { state, audioTrack } = useVoiceAssistant();
        return (
         <BarVisualizer
           state={state}
           trackRef={audioTrack}
         />
        );
      }
      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/LiveKitRoom.html b/docs/functions/LiveKitRoom.html index 238fd471..5d89dfaf 100644 --- a/docs/functions/LiveKitRoom.html +++ b/docs/functions/LiveKitRoom.html @@ -1,6 +1,6 @@ -LiveKitRoom | LiveKit React Native Client SDK - v2.7.4

Function LiveKitRoom

  • LiveKitRoom(props): Element

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

    Function LiveKitRoom

    • LiveKitRoom(props): Element

    • 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

      Example

      <LiveKitRoom
       token='<livekit-token>'
       serverUrl='<url-to-livekit-server>'
       connect={true}
      >
          ...
      </LiveKitRoom>
      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/VideoTrack.html b/docs/functions/VideoTrack.html index b178770a..c02d5654 100644 --- a/docs/functions/VideoTrack.html +++ b/docs/functions/VideoTrack.html @@ -1,5 +1,5 @@ -VideoTrack | LiveKit React Native Client SDK - v2.7.4

Function VideoTrack

  • VideoTrack(props): null | ReactElement<any, string | JSXElementConstructor<any>>

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

    Function VideoTrack

    • VideoTrack(props): null | ReactElement<any, string | JSXElementConstructor<any>>

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

      Parameters

      • props: VideoTrackProps & RefAttributes<Component<{}, {}, any>>

        See VideoTrackProps for details.

      Returns null | ReactElement<any, string | JSXElementConstructor<any>>

      A React component that renders the given video track.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/VideoView.html b/docs/functions/VideoView.html index bf6a4796..147d54cb 100644 --- a/docs/functions/VideoView.html +++ b/docs/functions/VideoView.html @@ -1,2 +1,2 @@ -VideoView | LiveKit React Native Client SDK - v2.7.4

Function VideoView

  • VideoView(__namedParameters): Element

  • Parameters

    Returns Element

    Deprecated

    use VideoTrack and VideoTrackProps instead.

    -

Settings

Member Visibility

Theme

\ No newline at end of file +VideoView | LiveKit React Native Client SDK - v2.7.5

Function VideoView

  • VideoView(__namedParameters): Element

  • Parameters

    Returns Element

    Deprecated

    use VideoTrack and VideoTrackProps instead.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/getDefaultAppleAudioConfigurationForMode.html b/docs/functions/getDefaultAppleAudioConfigurationForMode.html index 1d71c5bc..e61e78a6 100644 --- a/docs/functions/getDefaultAppleAudioConfigurationForMode.html +++ b/docs/functions/getDefaultAppleAudioConfigurationForMode.html @@ -1 +1 @@ -getDefaultAppleAudioConfigurationForMode | LiveKit React Native Client SDK - v2.7.4

Function getDefaultAppleAudioConfigurationForMode

Settings

Member Visibility

Theme

\ No newline at end of file +getDefaultAppleAudioConfigurationForMode | LiveKit React Native Client SDK - v2.7.5

Function getDefaultAppleAudioConfigurationForMode

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/registerGlobals.html b/docs/functions/registerGlobals.html index 741b1025..0aa425ff 100644 --- a/docs/functions/registerGlobals.html +++ b/docs/functions/registerGlobals.html @@ -1,3 +1,3 @@ -registerGlobals | LiveKit React Native Client SDK - v2.7.4

Function registerGlobals

  • registerGlobals(): void

  • Registers the required globals needed for LiveKit to work.

    +registerGlobals | LiveKit React Native Client SDK - v2.7.5

    Function registerGlobals

    • registerGlobals(): void

    • Registers the required globals needed for LiveKit to work.

      Must be called before using LiveKit.

      -

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/setLogLevel.html b/docs/functions/setLogLevel.html index dea0705a..fc2208b7 100644 --- a/docs/functions/setLogLevel.html +++ b/docs/functions/setLogLevel.html @@ -1,3 +1,3 @@ -setLogLevel | LiveKit React Native Client SDK - v2.7.4

Function setLogLevel

  • setLogLevel(level, options?): void

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

    Function setLogLevel

    • setLogLevel(level, options?): void

    • 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: "error" | "trace" | "debug" | "info" | "warn" | "silent" | LogLevel
      • options: SetLogLevelOptions = {}

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

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

    Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/sortParticipants.html b/docs/functions/sortParticipants.html index 82d644a8..a968daaf 100644 --- a/docs/functions/sortParticipants.html +++ b/docs/functions/sortParticipants.html @@ -1,4 +1,4 @@ -sortParticipants | LiveKit React Native Client SDK - v2.7.4

Function sortParticipants

  • sortParticipants(participants, localParticipant?): void

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

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

    Function sortParticipants

    • sortParticipants(participants, localParticipant?): void

    • 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 @@
      3. participants with video on
      4. by joinedAt
      -

      Parameters

      • participants: default[]
      • Optional localParticipant: default

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    • participants: default[]
    • Optional localParticipant: default

    Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/useBarAnimator.html b/docs/functions/useBarAnimator.html index 71135069..8f522794 100644 --- a/docs/functions/useBarAnimator.html +++ b/docs/functions/useBarAnimator.html @@ -1 +1 @@ -useBarAnimator | LiveKit React Native Client SDK - v2.7.4

Function useBarAnimator

  • useBarAnimator(state, columns, interval): number[]

  • Parameters

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

    Returns number[]

Settings

Member Visibility

Theme

\ No newline at end of file +useBarAnimator | LiveKit React Native Client SDK - v2.7.5

Function useBarAnimator

  • useBarAnimator(state, columns, interval): number[]

  • Parameters

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

    Returns number[]

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/useIOSAudioManagement.html b/docs/functions/useIOSAudioManagement.html index ea1d9997..cc7e7b20 100644 --- a/docs/functions/useIOSAudioManagement.html +++ b/docs/functions/useIOSAudioManagement.html @@ -1,4 +1,4 @@ -useIOSAudioManagement | LiveKit React Native Client SDK - v2.7.4

Function useIOSAudioManagement

Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/useMultibandTrackVolume.html b/docs/functions/useMultibandTrackVolume.html index 761ededf..58b1ee13 100644 --- a/docs/functions/useMultibandTrackVolume.html +++ b/docs/functions/useMultibandTrackVolume.html @@ -1,3 +1,3 @@ -useMultibandTrackVolume | LiveKit React Native Client SDK - v2.7.4

Function useMultibandTrackVolume

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/useParticipant.html b/docs/functions/useParticipant.html index d5fc4815..70da2660 100644 --- a/docs/functions/useParticipant.html +++ b/docs/functions/useParticipant.html @@ -1,2 +1,2 @@ -useParticipant | LiveKit React Native Client SDK - v2.7.4

Function useParticipant

Settings

Member Visibility

Theme

\ No newline at end of file +useParticipant | LiveKit React Native Client SDK - v2.7.5

Function useParticipant

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/useRNE2EEManager.html b/docs/functions/useRNE2EEManager.html index 1f0dcd9d..4f917f5d 100644 --- a/docs/functions/useRNE2EEManager.html +++ b/docs/functions/useRNE2EEManager.html @@ -1 +1 @@ -useRNE2EEManager | LiveKit React Native Client SDK - v2.7.4

Function useRNE2EEManager

Settings

Member Visibility

Theme

\ No newline at end of file +useRNE2EEManager | LiveKit React Native Client SDK - v2.7.5

Function useRNE2EEManager

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/useRoom.html b/docs/functions/useRoom.html index 8dd69bfc..734ee2b4 100644 --- a/docs/functions/useRoom.html +++ b/docs/functions/useRoom.html @@ -1,2 +1,2 @@ -useRoom | LiveKit React Native Client SDK - v2.7.4

Function useRoom

  • useRoom(room, options?): RoomState

  • Parameters

    Returns RoomState

    Deprecated

    wrap your components in a component instead and use more granular hooks to track state you're interested in

    -

Settings

Member Visibility

Theme

\ No newline at end of file +useRoom | LiveKit React Native Client SDK - v2.7.5

Function useRoom

  • useRoom(room, options?): RoomState

  • Parameters

    Returns RoomState

    Deprecated

    wrap your components in a component instead and use more granular hooks to track state you're interested in

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/useTrackVolume.html b/docs/functions/useTrackVolume.html index a42770f7..b7a64833 100644 --- a/docs/functions/useTrackVolume.html +++ b/docs/functions/useTrackVolume.html @@ -1,3 +1,3 @@ -useTrackVolume | LiveKit React Native Client SDK - v2.7.4

Function useTrackVolume

  • useTrackVolume(trackOrTrackReference?): number

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

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

    Function useTrackVolume

    • useTrackVolume(trackOrTrackReference?): number

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

      Parameters

      • Optional trackOrTrackReference: TrackReferenceOrPlaceholder | default | default

      Returns number

      A number between 0-1 representing the volume.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index f1939e5f..2585cabf 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -LiveKit React Native Client SDK - v2.7.4

LiveKit React Native Client SDK - v2.7.4

+LiveKit React Native Client SDK - v2.7.5

LiveKit React Native Client SDK - v2.7.5

@@ -129,4 +129,4 @@ ResourcesDocs · Example apps · Cloud · Self-hosting · CLI -

Settings

Member Visibility

Theme

On This Page

livekit-react-native
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

livekit-react-native
\ No newline at end of file diff --git a/docs/interfaces/BarVisualizerProps.html b/docs/interfaces/BarVisualizerProps.html index 5bbb6975..1e4db126 100644 --- a/docs/interfaces/BarVisualizerProps.html +++ b/docs/interfaces/BarVisualizerProps.html @@ -1,9 +1,9 @@ -BarVisualizerProps | LiveKit React Native Client SDK - v2.7.4

Interface BarVisualizerPropsBeta

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

Properties

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

Interface BarVisualizerPropsBeta

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

Properties

barCount? options? state? style? trackRef?

Properties

Optional barCount

barCount?: number

Number of bars that show up in the visualizer

-

Optional options

options?: BarVisualizerOptions

Optional state

state?: AgentState

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

-

Optional style

style?: ViewStyle

Custom React Native styles for the container.

-

Optional trackRef

trackRef?: TrackReferenceOrPlaceholder

Settings

Member Visibility

Theme

On This Page

barCountoptionsstatestyletrackRef
\ No newline at end of file +

Optional options

options?: BarVisualizerOptions

Optional state

state?: AgentState

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

+

Optional style

style?: ViewStyle

Custom React Native styles for the container.

+

Optional trackRef

trackRef?: TrackReferenceOrPlaceholder

Settings

Member Visibility

Theme

On This Page

barCountoptionsstatestyletrackRef
\ No newline at end of file diff --git a/docs/interfaces/LiveKitRoomProps.html b/docs/interfaces/LiveKitRoomProps.html index c272ec3a..a7138d3e 100644 --- a/docs/interfaces/LiveKitRoomProps.html +++ b/docs/interfaces/LiveKitRoomProps.html @@ -1,4 +1,4 @@ -LiveKitRoomProps | LiveKit React Native Client SDK - v2.7.4

Interface LiveKitRoomProps

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

Properties

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

Interface LiveKitRoomProps

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

Properties

audio? connect? connectOptions? featureFlags? @@ -17,28 +17,28 @@

Properties

Optional audio

audio?: boolean | AudioCaptureOptions

Publish audio immediately after connecting to your LiveKit room.

Default Value

false

See

https://docs.livekit.io/client-sdk-js/interfaces/AudioCaptureOptions.html

-

Optional connect

connect?: boolean

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

+

Optional connect

connect?: boolean

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

Default Value

false

-

Optional connectOptions

connectOptions?: RoomConnectOptions

Define options how to connect to the LiveKit server.

+

Optional connectOptions

connectOptions?: RoomConnectOptions

Define options how to connect to the LiveKit server.

See

https://docs.livekit.io/client-sdk-js/interfaces/RoomConnectOptions.html

-

Optional Experimental featureFlags

featureFlags?: FeatureFlags

Optional onConnected

onConnected?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onDisconnected

onDisconnected?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onEncryptionError

onEncryptionError?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      • error: Error

      Returns void

Optional onError

onError?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      • error: Error

      Returns void

Optional onMediaDeviceFailure

onMediaDeviceFailure?: ((failure?) => void)

Type declaration

    • (failure?): void

    • Parameters

      • Optional failure: MediaDeviceFailure

      Returns void

Optional options

options?: RoomOptions

Options for when creating a new room. +

Optional Experimental featureFlags

featureFlags?: FeatureFlags

Optional onConnected

onConnected?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onDisconnected

onDisconnected?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onEncryptionError

onEncryptionError?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      • error: Error

      Returns void

Optional onError

onError?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      • error: Error

      Returns void

Optional onMediaDeviceFailure

onMediaDeviceFailure?: ((failure?) => void)

Type declaration

    • (failure?): void

    • Parameters

      • Optional failure: MediaDeviceFailure

      Returns void

Optional options

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.

See

https://docs.livekit.io/client-sdk-js/interfaces/RoomOptions.html

-

Optional room

room?: Room

Optional room instance. +

Optional room

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.

-

Optional screen

screen?: boolean | ScreenShareCaptureOptions

Publish screen share immediately after connecting to your LiveKit room.

+

Optional screen

screen?: boolean | ScreenShareCaptureOptions

Publish screen share immediately after connecting to your LiveKit room.

Default Value

false

See

https://docs.livekit.io/client-sdk-js/interfaces/ScreenShareCaptureOptions.html

-

serverUrl

serverUrl: undefined | string

URL to the LiveKit server. +

serverUrl

serverUrl: undefined | string

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.

-

Optional simulateParticipants

simulateParticipants?: number

token

token: undefined | string

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

Optional simulateParticipants

simulateParticipants?: number

token

token: undefined | string

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.

See

https://docs.livekit.io/cloud/project-management/keys-and-tokens/#generating-access-tokens

-

Optional video

video?: boolean | VideoCaptureOptions

Publish video immediately after connecting to your LiveKit room.

+

Optional video

video?: boolean | VideoCaptureOptions

Publish video immediately after connecting to your LiveKit room.

Default Value

false

See

https://docs.livekit.io/client-sdk-js/interfaces/VideoCaptureOptions.html

-

Settings

Member Visibility

Theme

On This Page

audioconnectconnectOptionsfeatureFlagsonConnectedonDisconnectedonEncryptionErroronErroronMediaDeviceFailureoptionsroomscreenserverUrlsimulateParticipantstokenvideo
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

audioconnectconnectOptionsfeatureFlagsonConnectedonDisconnectedonEncryptionErroronErroronMediaDeviceFailureoptionsroomscreenserverUrlsimulateParticipantstokenvideo
\ No newline at end of file diff --git a/docs/interfaces/MultiBandTrackVolumeOptions.html b/docs/interfaces/MultiBandTrackVolumeOptions.html index 80cd7b43..a761e0e2 100644 --- a/docs/interfaces/MultiBandTrackVolumeOptions.html +++ b/docs/interfaces/MultiBandTrackVolumeOptions.html @@ -1,10 +1,10 @@ -MultiBandTrackVolumeOptions | LiveKit React Native Client SDK - v2.7.4

Interface MultiBandTrackVolumeOptionsAlpha

Interface for configuring options for the useMultibandTrackVolume hook.

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

Properties

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

Interface MultiBandTrackVolumeOptionsAlpha

Interface for configuring options for the useMultibandTrackVolume hook.

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

Properties

bands? maxFrequency? minFrequency? updateInterval?

Properties

Optional bands

bands?: number

the number of bands to split the audio into

-

Optional maxFrequency

maxFrequency?: number

cut off frequency on the higher end

-

Optional minFrequency

minFrequency?: number

cut off frequency on the lower end

-

Optional updateInterval

updateInterval?: number

update should run every x ms

-

Settings

Member Visibility

Theme

On This Page

bandsmaxFrequencyminFrequencyupdateInterval
\ No newline at end of file +

Optional maxFrequency

maxFrequency?: number

cut off frequency on the higher end

+

Optional minFrequency

minFrequency?: number

cut off frequency on the lower end

+

Optional updateInterval

updateInterval?: number

update should run every x ms

+

Settings

Member Visibility

Theme

On This Page

bandsmaxFrequencyminFrequencyupdateInterval
\ No newline at end of file diff --git a/docs/interfaces/ParticipantState.html b/docs/interfaces/ParticipantState.html index 66c1ba0d..840c3fd1 100644 --- a/docs/interfaces/ParticipantState.html +++ b/docs/interfaces/ParticipantState.html @@ -1,5 +1,5 @@ -ParticipantState | LiveKit React Native Client SDK - v2.7.4

Interface ParticipantState

Deprecated

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[];
}

Properties

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

Interface ParticipantState

Deprecated

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[];
}

Properties

cameraPublication? connectionQuality isLocal isSpeaking @@ -8,4 +8,4 @@ publications screenSharePublication? subscribedTracks -

Properties

Optional cameraPublication

cameraPublication?: TrackPublication

connectionQuality

connectionQuality: ConnectionQuality

isLocal

isLocal: boolean

isSpeaking

isSpeaking: boolean

Optional metadata

metadata?: string

Optional microphonePublication

microphonePublication?: TrackPublication

publications

publications: TrackPublication[]

Optional screenSharePublication

screenSharePublication?: TrackPublication

subscribedTracks

subscribedTracks: TrackPublication[]

Settings

Member Visibility

Theme

On This Page

cameraPublicationconnectionQualityisLocalisSpeakingmetadatamicrophonePublicationpublicationsscreenSharePublicationsubscribedTracks
\ No newline at end of file +

Properties

Optional cameraPublication

cameraPublication?: TrackPublication

connectionQuality

connectionQuality: ConnectionQuality

isLocal

isLocal: boolean

isSpeaking

isSpeaking: boolean

Optional metadata

metadata?: string

Optional microphonePublication

microphonePublication?: TrackPublication

publications

publications: TrackPublication[]

Optional screenSharePublication

screenSharePublication?: TrackPublication

subscribedTracks

subscribedTracks: TrackPublication[]

Settings

Member Visibility

Theme

On This Page

cameraPublicationconnectionQualityisLocalisSpeakingmetadatamicrophonePublicationpublicationsscreenSharePublicationsubscribedTracks
\ No newline at end of file diff --git a/docs/interfaces/RNE2EEManagerState.html b/docs/interfaces/RNE2EEManagerState.html index 010c4632..fa973abe 100644 --- a/docs/interfaces/RNE2EEManagerState.html +++ b/docs/interfaces/RNE2EEManagerState.html @@ -1,3 +1,3 @@ -RNE2EEManagerState | LiveKit React Native Client SDK - v2.7.4

Interface RNE2EEManagerState

interface RNE2EEManagerState {
    e2eeManager: RNE2EEManager;
    keyProvider: RNKeyProvider;
}

Properties

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

Interface RNE2EEManagerState

interface RNE2EEManagerState {
    e2eeManager: RNE2EEManager;
    keyProvider: RNKeyProvider;
}

Properties

e2eeManager keyProvider -

Properties

e2eeManager

e2eeManager: RNE2EEManager

keyProvider

keyProvider: RNKeyProvider

Settings

Member Visibility

Theme

On This Page

e2eeManagerkeyProvider
\ No newline at end of file +

Properties

e2eeManager

e2eeManager: RNE2EEManager

keyProvider

keyProvider: RNKeyProvider

Settings

Member Visibility

Theme

On This Page

e2eeManagerkeyProvider
\ No newline at end of file diff --git a/docs/interfaces/RoomOptions.html b/docs/interfaces/RoomOptions.html index ecfe91ec..9a74a770 100644 --- a/docs/interfaces/RoomOptions.html +++ b/docs/interfaces/RoomOptions.html @@ -1,2 +1,2 @@ -RoomOptions | LiveKit React Native Client SDK - v2.7.4

Interface RoomOptions

interface RoomOptions {
    sortParticipants?: ((participants) => void);
}

Properties

sortParticipants? -

Properties

Optional sortParticipants

sortParticipants?: ((participants) => void)

Type declaration

    • (participants): void

    • Parameters

      • participants: default[]

      Returns void

Settings

Member Visibility

Theme

On This Page

sortParticipants
\ No newline at end of file +RoomOptions | LiveKit React Native Client SDK - v2.7.5

Interface RoomOptions

interface RoomOptions {
    sortParticipants?: ((participants) => void);
}

Properties

sortParticipants? +

Properties

Optional sortParticipants

sortParticipants?: ((participants) => void)

Type declaration

    • (participants): void

    • Parameters

      • participants: default[]

      Returns void

Settings

Member Visibility

Theme

On This Page

sortParticipants
\ No newline at end of file diff --git a/docs/interfaces/RoomState.html b/docs/interfaces/RoomState.html index 7727f07e..d491cfd9 100644 --- a/docs/interfaces/RoomState.html +++ b/docs/interfaces/RoomState.html @@ -1,5 +1,5 @@ -RoomState | LiveKit React Native Client SDK - v2.7.4

Interface RoomState

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

Properties

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

Interface RoomState

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

Properties

audioTracks error? participants room? -

Properties

audioTracks

audioTracks: AudioTrack[]

Optional error

error?: Error

participants

participants: default[]

Optional room

room?: Room

Settings

Member Visibility

Theme

On This Page

audioTrackserrorparticipantsroom
\ No newline at end of file +

Properties

audioTracks

audioTracks: AudioTrack[]

Optional error

error?: Error

participants

participants: default[]

Optional room

room?: Room

Settings

Member Visibility

Theme

On This Page

audioTrackserrorparticipantsroom
\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index 0755e486..1523125d 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,4 +1,4 @@ -LiveKit React Native Client SDK - v2.7.4

LiveKit React Native Client SDK - v2.7.4

Index

Classes

AudioSession +LiveKit React Native Client SDK - v2.7.5

LiveKit React Native Client SDK - v2.7.5

Index

Classes

AudioSession RNE2EEManager RNKeyProvider

Interfaces

BarVisualizerProps @@ -39,4 +39,4 @@ useRNE2EEManager useRoom useTrackVolume -

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/AndroidAudioTypeOptions.html b/docs/types/AndroidAudioTypeOptions.html index 8ccf0472..0a3d9638 100644 --- a/docs/types/AndroidAudioTypeOptions.html +++ b/docs/types/AndroidAudioTypeOptions.html @@ -1,4 +1,4 @@ -AndroidAudioTypeOptions | LiveKit React Native Client SDK - v2.7.4

Type alias AndroidAudioTypeOptions

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;
}

Type declaration

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

    Corresponds to Android's AndroidAttributes content type.

    +AndroidAudioTypeOptions | LiveKit React Native Client SDK - v2.7.5

    Type alias AndroidAudioTypeOptions

    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;
    }

    Type declaration

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

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

      Corresponds to Android's AudioAttributes usage type.

      @@ -19,4 +19,4 @@

      Defaults to false.

    • Optional manageAudioFocus?: boolean

      Whether LiveKit should handle managing the audio focus or not.

      Defaults to true.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/AppleAudioCategory.html b/docs/types/AppleAudioCategory.html index 1a49daee..d26b4022 100644 --- a/docs/types/AppleAudioCategory.html +++ b/docs/types/AppleAudioCategory.html @@ -1 +1 @@ -AppleAudioCategory | LiveKit React Native Client SDK - v2.7.4

Type alias AppleAudioCategory

AppleAudioCategory: "soloAmbient" | "playback" | "record" | "playAndRecord" | "multiRoute"

Settings

Member Visibility

Theme

\ No newline at end of file +AppleAudioCategory | LiveKit React Native Client SDK - v2.7.5

Type alias AppleAudioCategory

AppleAudioCategory: "soloAmbient" | "playback" | "record" | "playAndRecord" | "multiRoute"

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/AppleAudioCategoryOption.html b/docs/types/AppleAudioCategoryOption.html index c8c904aa..2f73bb55 100644 --- a/docs/types/AppleAudioCategoryOption.html +++ b/docs/types/AppleAudioCategoryOption.html @@ -1 +1 @@ -AppleAudioCategoryOption | LiveKit React Native Client SDK - v2.7.4

Type alias AppleAudioCategoryOption

AppleAudioCategoryOption: "mixWithOthers" | "duckOthers" | "interruptSpokenAudioAndMixWithOthers" | "allowBluetooth" | "allowBluetoothA2DP" | "allowAirPlay" | "defaultToSpeaker"

Settings

Member Visibility

Theme

\ No newline at end of file +AppleAudioCategoryOption | LiveKit React Native Client SDK - v2.7.5

Type alias AppleAudioCategoryOption

AppleAudioCategoryOption: "mixWithOthers" | "duckOthers" | "interruptSpokenAudioAndMixWithOthers" | "allowBluetooth" | "allowBluetoothA2DP" | "allowAirPlay" | "defaultToSpeaker"

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/AppleAudioConfiguration.html b/docs/types/AppleAudioConfiguration.html index 9ab993a2..13d706d5 100644 --- a/docs/types/AppleAudioConfiguration.html +++ b/docs/types/AppleAudioConfiguration.html @@ -1 +1 @@ -AppleAudioConfiguration | LiveKit React Native Client SDK - v2.7.4

Type alias AppleAudioConfiguration

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

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file +AppleAudioConfiguration | LiveKit React Native Client SDK - v2.7.5

Type alias AppleAudioConfiguration

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

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/AppleAudioMode.html b/docs/types/AppleAudioMode.html index ccc91858..6cbc6584 100644 --- a/docs/types/AppleAudioMode.html +++ b/docs/types/AppleAudioMode.html @@ -1 +1 @@ -AppleAudioMode | LiveKit React Native Client SDK - v2.7.4

Type alias AppleAudioMode

AppleAudioMode: "default" | "gameChat" | "measurement" | "moviePlayback" | "spokenAudio" | "videoChat" | "videoRecording" | "voiceChat" | "voicePrompt"

Settings

Member Visibility

Theme

\ No newline at end of file +AppleAudioMode | LiveKit React Native Client SDK - v2.7.5

Type alias AppleAudioMode

AppleAudioMode: "default" | "gameChat" | "measurement" | "moviePlayback" | "spokenAudio" | "videoChat" | "videoRecording" | "voiceChat" | "voicePrompt"

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/AudioConfiguration.html b/docs/types/AudioConfiguration.html index 99118674..5f87f7f8 100644 --- a/docs/types/AudioConfiguration.html +++ b/docs/types/AudioConfiguration.html @@ -1,4 +1,4 @@ -AudioConfiguration | LiveKit React Native Client SDK - v2.7.4

Type alias AudioConfiguration

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

Configuration for the underlying AudioSession.

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

Type alias AudioConfiguration

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

Configuration for the underlying AudioSession.

Android specific options:

    @@ -24,4 +24,4 @@

    By default, this is set to "speaker"

-

Type declaration

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

Settings

Member Visibility

Theme

\ No newline at end of file +

Type declaration

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

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/AudioTrackState.html b/docs/types/AudioTrackState.html index a37b10fc..e779f5c2 100644 --- a/docs/types/AudioTrackState.html +++ b/docs/types/AudioTrackState.html @@ -1 +1 @@ -AudioTrackState | LiveKit React Native Client SDK - v2.7.4

Type alias AudioTrackState

AudioTrackState: "none" | "remoteOnly" | "localOnly" | "localAndRemote"

Settings

Member Visibility

Theme

\ No newline at end of file +AudioTrackState | LiveKit React Native Client SDK - v2.7.5

Type alias AudioTrackState

AudioTrackState: "none" | "remoteOnly" | "localOnly" | "localAndRemote"

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/BarVisualizerOptions.html b/docs/types/BarVisualizerOptions.html index 4154a0be..173d214d 100644 --- a/docs/types/BarVisualizerOptions.html +++ b/docs/types/BarVisualizerOptions.html @@ -1,3 +1,3 @@ -BarVisualizerOptions | LiveKit React Native Client SDK - v2.7.4

Type alias BarVisualizerOptions

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

Type declaration

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

    decimal values from 0 to 1

    +BarVisualizerOptions | LiveKit React Native Client SDK - v2.7.5

    Type alias BarVisualizerOptions

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

    Type declaration

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

      decimal values from 0 to 1

    • Optional minHeight?: number

      decimal values from 0 to 1

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/LogLevel.html b/docs/types/LogLevel.html index 3345cba4..8f30f131 100644 --- a/docs/types/LogLevel.html +++ b/docs/types/LogLevel.html @@ -1 +1 @@ -LogLevel | LiveKit React Native Client SDK - v2.7.4

Type alias LogLevel

LogLevel: Parameters<typeof setClientSdkLogLevel>[0]

Settings

Member Visibility

Theme

\ No newline at end of file +LogLevel | LiveKit React Native Client SDK - v2.7.5

Type alias LogLevel

LogLevel: Parameters<typeof setClientSdkLogLevel>[0]

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/Props.html b/docs/types/Props.html index a87e1d11..81e7981a 100644 --- a/docs/types/Props.html +++ b/docs/types/Props.html @@ -1,2 +1,2 @@ -Props | LiveKit React Native Client SDK - v2.7.4

Type alias Props

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

Type declaration

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

Deprecated

use VideoTrack and VideoTrackProps instead.

-

Settings

Member Visibility

Theme

\ No newline at end of file +Props | LiveKit React Native Client SDK - v2.7.5

Type alias Props

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

Type declaration

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

Deprecated

use VideoTrack and VideoTrackProps instead.

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/RNKeyProviderOptions.html b/docs/types/RNKeyProviderOptions.html index 24efcab2..345699cf 100644 --- a/docs/types/RNKeyProviderOptions.html +++ b/docs/types/RNKeyProviderOptions.html @@ -1,2 +1,2 @@ -RNKeyProviderOptions | LiveKit React Native Client SDK - v2.7.4

Type alias RNKeyProviderOptions

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

Options for construction an RNKeyProvider

-

Type declaration

  • Optional uncryptedMagicBytes?: string | Uint8Array

Settings

Member Visibility

Theme

\ No newline at end of file +RNKeyProviderOptions | LiveKit React Native Client SDK - v2.7.5

Type alias RNKeyProviderOptions

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

Options for construction an RNKeyProvider

+

Type declaration

  • Optional uncryptedMagicBytes?: string | Uint8Array

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/SetLogLevelOptions.html b/docs/types/SetLogLevelOptions.html index 3bad48a7..8c751ebe 100644 --- a/docs/types/SetLogLevelOptions.html +++ b/docs/types/SetLogLevelOptions.html @@ -1 +1 @@ -SetLogLevelOptions | LiveKit React Native Client SDK - v2.7.4

Type alias SetLogLevelOptions

SetLogLevelOptions: {
    liveKitClientLogLevel?: LogLevel;
}

Type declaration

  • Optional liveKitClientLogLevel?: LogLevel

Settings

Member Visibility

Theme

\ No newline at end of file +SetLogLevelOptions | LiveKit React Native Client SDK - v2.7.5

Type alias SetLogLevelOptions

SetLogLevelOptions: {
    liveKitClientLogLevel?: LogLevel;
}

Type declaration

  • Optional liveKitClientLogLevel?: LogLevel

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/UseRNE2EEManagerOptions.html b/docs/types/UseRNE2EEManagerOptions.html index 1b52d37a..56b0e595 100644 --- a/docs/types/UseRNE2EEManagerOptions.html +++ b/docs/types/UseRNE2EEManagerOptions.html @@ -1 +1 @@ -UseRNE2EEManagerOptions | LiveKit React Native Client SDK - v2.7.4

Type alias UseRNE2EEManagerOptions

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

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file +UseRNE2EEManagerOptions | LiveKit React Native Client SDK - v2.7.5

Type alias UseRNE2EEManagerOptions

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

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/VideoTrackProps.html b/docs/types/VideoTrackProps.html index 17ca25e9..3c766f36 100644 --- a/docs/types/VideoTrackProps.html +++ b/docs/types/VideoTrackProps.html @@ -1,4 +1,4 @@ -VideoTrackProps | LiveKit React Native Client SDK - v2.7.4

Type alias VideoTrackProps

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

Props for the VideoTrack component.

+VideoTrackProps | LiveKit React Native Client SDK - v2.7.5

Type alias VideoTrackProps

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

Props for the VideoTrack component.

Type declaration

  • Optional iosPIP?: RTCIOSPIPOptions & {
        fallbackView?: ReactNode;
        preferredSize: {
            height: number;
            width: number;
        };
    }

    Picture in picture options for this view. Disabled if not supplied.

    iOS only. Requires iOS 15.0 or above, and the PIP background mode capability.

    If iosPIP.enabled is true, the methods startIOSPIP and stopIOSPIP @@ -31,4 +31,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).

    -

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/AndroidAudioTypePresets.html b/docs/variables/AndroidAudioTypePresets.html index c40b0d07..c34ae0d6 100644 --- a/docs/variables/AndroidAudioTypePresets.html +++ b/docs/variables/AndroidAudioTypePresets.html @@ -1,3 +1,3 @@ -AndroidAudioTypePresets | LiveKit React Native Client SDK - v2.7.4

Variable AndroidAudioTypePresetsConst

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

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/log.html b/docs/variables/log.html index ff515085..297af9bb 100644 --- a/docs/variables/log.html +++ b/docs/variables/log.html @@ -1 +1 @@ -log | LiveKit React Native Client SDK - v2.7.4

Variable logConst

log: Logger = ...

Settings

Member Visibility

Theme

\ No newline at end of file +log | LiveKit React Native Client SDK - v2.7.5

Variable logConst

log: Logger = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/example/ios/Podfile.lock b/example/ios/Podfile.lock index 5abf09ce..e61d68e2 100644 --- a/example/ios/Podfile.lock +++ b/example/ios/Podfile.lock @@ -7,7 +7,7 @@ PODS: - hermes-engine (0.74.2): - hermes-engine/Pre-built (= 0.74.2) - hermes-engine/Pre-built (0.74.2) - - livekit-react-native (2.7.4): + - livekit-react-native (2.7.5): - DoubleConversion - glog - hermes-engine @@ -1425,7 +1425,7 @@ SPEC CHECKSUMS: fmt: 4c2741a687cc09f0634a2e2c72a838b99f1ff120 glog: fdfdfe5479092de0c4bdbebedd9056951f092c4f hermes-engine: 01d3e052018c2a13937aca1860fbedbccd4a41b7 - livekit-react-native: e8b3cd059f54f0bc9af114e091403c87d75f9ce3 + livekit-react-native: dddab6768c9f3a823299c2a041676d966ad737b5 livekit-react-native-webrtc: 8f554b78de521a0f4e919a1180bc993775aed93a RCT-Folly: 02617c592a293bd6d418e0a88ff4ee1f88329b47 RCTDeprecation: b03c35057846b685b3ccadc9bfe43e349989cdb2 diff --git a/package.json b/package.json index 005d209d..1d405fad 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@livekit/react-native", - "version": "2.7.4", + "version": "2.7.5", "description": "LiveKit for React Native", "main": "lib/commonjs/index", "module": "lib/module/index",