From 15bcd366adbc8f0cd12f2a4d66482f64421e6f0e Mon Sep 17 00:00:00 2001 From: davidliu Date: Wed, 21 Aug 2024 12:57:06 +0900 Subject: [PATCH] chore: release 2.4.1 --- docs/assets/highlight.css | 15 ++++++++++---- docs/classes/AudioSession.html | 16 +++++++-------- docs/functions/LiveKitRoom.html | 4 ++-- docs/functions/VideoTrack.html | 2 +- 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/useIOSAudioManagement.html | 4 ++-- docs/functions/useParticipant.html | 4 ++-- docs/functions/useRoom.html | 4 ++-- docs/index.html | 13 +++++++----- docs/interfaces/LiveKitRoomProps.html | 20 +++++++++---------- docs/interfaces/ParticipantState.html | 6 +++--- 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/LogLevel.html | 2 +- docs/types/Props.html | 4 ++-- docs/types/SetLogLevelOptions.html | 2 +- docs/types/VideoTrackProps.html | 2 +- docs/variables/AndroidAudioTypePresets.html | 4 ++-- docs/variables/log.html | 2 +- example/ios/Podfile.lock | 4 ++-- package.json | 2 +- 33 files changed, 84 insertions(+), 74 deletions(-) diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index 6b28338..6f6c94e 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -25,10 +25,12 @@ --dark-hl-11: #D4D4D4; --light-hl-12: #098658; --dark-hl-12: #B5CEA8; - --light-hl-13: #800000; - --dark-hl-13: #569CD6; - --light-hl-14: #0000FF; - --dark-hl-14: #CE9178; + --light-hl-13: #000000; + --dark-hl-13: #C8C8C8; + --light-hl-14: #800000; + --dark-hl-14: #569CD6; + --light-hl-15: #0000FF; + --dark-hl-15: #CE9178; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -49,6 +51,7 @@ --hl-12: var(--light-hl-12); --hl-13: var(--light-hl-13); --hl-14: var(--light-hl-14); + --hl-15: var(--light-hl-15); --code-background: var(--light-code-background); } } @@ -68,6 +71,7 @@ --hl-12: var(--dark-hl-12); --hl-13: var(--dark-hl-13); --hl-14: var(--dark-hl-14); + --hl-15: var(--dark-hl-15); --code-background: var(--dark-code-background); } } @@ -87,6 +91,7 @@ --hl-12: var(--light-hl-12); --hl-13: var(--light-hl-13); --hl-14: var(--light-hl-14); + --hl-15: var(--light-hl-15); --code-background: var(--light-code-background); } @@ -106,6 +111,7 @@ --hl-12: var(--dark-hl-12); --hl-13: var(--dark-hl-13); --hl-14: var(--dark-hl-14); + --hl-15: var(--dark-hl-15); --code-background: var(--dark-code-background); } @@ -124,4 +130,5 @@ .hl-12 { color: var(--hl-12); } .hl-13 { color: var(--hl-13); } .hl-14 { color: var(--hl-14); } +.hl-15 { color: var(--hl-15); } pre, code { background: var(--code-background); } diff --git a/docs/classes/AudioSession.html b/docs/classes/AudioSession.html index d95f93a..8f184cc 100644 --- a/docs/classes/AudioSession.html +++ b/docs/classes/AudioSession.html @@ -1,4 +1,4 @@ -AudioSession | LiveKit React Native Client SDK - v2.4.0

Class AudioSession

Constructors

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

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

  • selectAudioOutput(deviceId): Promise<void>

  • Select the provided audio output if available.

    +

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/functions/LiveKitRoom.html b/docs/functions/LiveKitRoom.html index cb7936b..c74df88 100644 --- a/docs/functions/LiveKitRoom.html +++ b/docs/functions/LiveKitRoom.html @@ -1,6 +1,6 @@ -LiveKitRoom | LiveKit React Native Client SDK - v2.4.0

Function LiveKitRoom

  • LiveKitRoom(props): Element

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

    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 c37f9c7..e0561db 100644 --- a/docs/functions/VideoTrack.html +++ b/docs/functions/VideoTrack.html @@ -1 +1 @@ -VideoTrack | LiveKit React Native Client SDK - v2.4.0

Function VideoTrack

Settings

Member Visibility

Theme

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

Function VideoTrack

Settings

Member Visibility

Theme

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

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

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 744b37b..7c01507 100644 --- a/docs/functions/getDefaultAppleAudioConfigurationForMode.html +++ b/docs/functions/getDefaultAppleAudioConfigurationForMode.html @@ -1 +1 @@ -getDefaultAppleAudioConfigurationForMode | LiveKit React Native Client SDK - v2.4.0

Function getDefaultAppleAudioConfigurationForMode

Settings

Member Visibility

Theme

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

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 c4b1a43..45e97c2 100644 --- a/docs/functions/registerGlobals.html +++ b/docs/functions/registerGlobals.html @@ -1,3 +1,3 @@ -registerGlobals | LiveKit React Native Client SDK - v2.4.0

Function registerGlobals

  • registerGlobals(): void

  • Registers the required globals needed for LiveKit to work.

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

    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 d05b768..c296b00 100644 --- a/docs/functions/setLogLevel.html +++ b/docs/functions/setLogLevel.html @@ -1,3 +1,3 @@ -setLogLevel | LiveKit React Native Client SDK - v2.4.0

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

    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 93312c1..36a36ef 100644 --- a/docs/functions/sortParticipants.html +++ b/docs/functions/sortParticipants.html @@ -1,4 +1,4 @@ -sortParticipants | LiveKit React Native Client SDK - v2.4.0

Function sortParticipants

  • sortParticipants(participants, localParticipant?): void

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

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

    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/useIOSAudioManagement.html b/docs/functions/useIOSAudioManagement.html index d708021..d26a8ac 100644 --- a/docs/functions/useIOSAudioManagement.html +++ b/docs/functions/useIOSAudioManagement.html @@ -1,4 +1,4 @@ -useIOSAudioManagement | LiveKit React Native Client SDK - v2.4.0

Function useIOSAudioManagement

Returns void

Settings

Member Visibility

Theme

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

Function useParticipant

Settings

Member Visibility

Theme

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

Function useParticipant

Settings

Member Visibility

Theme

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

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

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/index.html b/docs/index.html index 1d26e58..74f6477 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -LiveKit React Native Client SDK - v2.4.0

LiveKit React Native Client SDK - v2.4.0

+LiveKit React Native Client SDK - v2.4.1

LiveKit React Native Client SDK - v2.4.1

@@ -70,7 +70,10 @@ hook is advised over just configuring the audio session once for the entire audio session.

Screenshare

Enabling screenshare requires extra installation steps:

Android

Android screenshare requires a foreground service with type mediaProjection to be present.

-

From version 2.4.0 onwards, this is handled internally and no extra setup is required.

+

From version 2.4.0 onwards, the foreground service is handled internally, +but you must declare the permission yourself in your app's AndroidManifest.xml file.

+
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION" />
+

iOS

iOS screenshare requires adding a Broadcast Extension to your iOS project. Follow the integration instructions here:

https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-ios-sdk/#screen-sharing-integration

It involves copying the files found in this sample project @@ -86,10 +89,10 @@

Background Processing

Android

To support staying connected to LiveKit in the background, you will need a foreground service on Android.

The example app uses @supersami/rn-foreground-service for this.

Add the following permissions to your AndroidManifest.xml file:

-
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_CAMERA" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MICROPHONE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK" />
+
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_CAMERA" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MICROPHONE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK" />
 

 
Declare the the service and ensure it's labelled a mediaProjection service like so:

-
<service android:name="com.supersami.foregroundservice.ForegroundService" android:foregroundServiceType="camera|microphone|mediaPlayback" />
<service android:name="com.supersami.foregroundservice.ForegroundServiceTask" />
+
<service android:name="com.supersami.foregroundservice.ForegroundService" android:foregroundServiceType="camera|microphone|mediaPlayback" />
<service android:name="com.supersami.foregroundservice.ForegroundServiceTask" />
 

 
The camera and microphone permissions/foreground service types can be omitted if you are not using those.

 
Once setup, start the foreground service to keep the app alive in the background.

@@ -125,4 +128,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/LiveKitRoomProps.html b/docs/interfaces/LiveKitRoomProps.html index ccf7660..c9d8d26 100644 --- a/docs/interfaces/LiveKitRoomProps.html +++ b/docs/interfaces/LiveKitRoomProps.html @@ -1,4 +1,4 @@ -LiveKitRoomProps | LiveKit React Native Client SDK - v2.4.0

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

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/ParticipantState.html b/docs/interfaces/ParticipantState.html index b935477..e9ac4f2 100644 --- a/docs/interfaces/ParticipantState.html +++ b/docs/interfaces/ParticipantState.html @@ -1,5 +1,5 @@ -ParticipantState | LiveKit React Native Client SDK - v2.4.0

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

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/RoomOptions.html b/docs/interfaces/RoomOptions.html index 2b153de..30d8902 100644 --- a/docs/interfaces/RoomOptions.html +++ b/docs/interfaces/RoomOptions.html @@ -1,2 +1,2 @@ -RoomOptions | LiveKit React Native Client SDK - v2.4.0

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

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 4a1ad9a..8eb5e59 100644 --- a/docs/interfaces/RoomState.html +++ b/docs/interfaces/RoomState.html @@ -1,5 +1,5 @@ -RoomState | LiveKit React Native Client SDK - v2.4.0

Interface RoomState

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

Properties

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

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 6a078cc..1a5fed9 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,4 +1,4 @@ -LiveKit React Native Client SDK - v2.4.0

LiveKit React Native Client SDK - v2.4.0

Index

Classes

AudioSession +LiveKit React Native Client SDK - v2.4.1

LiveKit React Native Client SDK - v2.4.1

Index

Classes

AudioSession

Interfaces

LiveKitRoomProps ParticipantState RoomOptions @@ -26,4 +26,4 @@ useIOSAudioManagement useParticipant useRoom -

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 5cdc988..ed3fb5b 100644 --- a/docs/types/AndroidAudioTypeOptions.html +++ b/docs/types/AndroidAudioTypeOptions.html @@ -1,4 +1,4 @@ -AndroidAudioTypeOptions | LiveKit React Native Client SDK - v2.4.0

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

    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 4454689..ddaddf0 100644 --- a/docs/types/AppleAudioCategory.html +++ b/docs/types/AppleAudioCategory.html @@ -1 +1 @@ -AppleAudioCategory | LiveKit React Native Client SDK - v2.4.0

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

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 728d518..c90dadf 100644 --- a/docs/types/AppleAudioCategoryOption.html +++ b/docs/types/AppleAudioCategoryOption.html @@ -1 +1 @@ -AppleAudioCategoryOption | LiveKit React Native Client SDK - v2.4.0

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

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 d9115fe..26e279d 100644 --- a/docs/types/AppleAudioConfiguration.html +++ b/docs/types/AppleAudioConfiguration.html @@ -1 +1 @@ -AppleAudioConfiguration | LiveKit React Native Client SDK - v2.4.0

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

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 a25a2ce..dca8053 100644 --- a/docs/types/AppleAudioMode.html +++ b/docs/types/AppleAudioMode.html @@ -1 +1 @@ -AppleAudioMode | LiveKit React Native Client SDK - v2.4.0

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

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 f79c909..1fda2e9 100644 --- a/docs/types/AudioConfiguration.html +++ b/docs/types/AudioConfiguration.html @@ -1,4 +1,4 @@ -AudioConfiguration | LiveKit React Native Client SDK - v2.4.0

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

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 70d491f..71b6838 100644 --- a/docs/types/AudioTrackState.html +++ b/docs/types/AudioTrackState.html @@ -1 +1 @@ -AudioTrackState | LiveKit React Native Client SDK - v2.4.0

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

Type alias AudioTrackState

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

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/LogLevel.html b/docs/types/LogLevel.html index 8e1262e..00a4868 100644 --- a/docs/types/LogLevel.html +++ b/docs/types/LogLevel.html @@ -1 +1 @@ -LogLevel | LiveKit React Native Client SDK - v2.4.0

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

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 e484810..5231052 100644 --- a/docs/types/Props.html +++ b/docs/types/Props.html @@ -1,2 +1,2 @@ -Props | LiveKit React Native Client SDK - v2.4.0

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

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/SetLogLevelOptions.html b/docs/types/SetLogLevelOptions.html index 4bf45c3..b1b6e6f 100644 --- a/docs/types/SetLogLevelOptions.html +++ b/docs/types/SetLogLevelOptions.html @@ -1 +1 @@ -SetLogLevelOptions | LiveKit React Native Client SDK - v2.4.0

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

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/VideoTrackProps.html b/docs/types/VideoTrackProps.html index c996537..a5741fb 100644 --- a/docs/types/VideoTrackProps.html +++ b/docs/types/VideoTrackProps.html @@ -1 +1 @@ -VideoTrackProps | LiveKit React Native Client SDK - v2.4.0

Type alias VideoTrackProps

VideoTrackProps: {
    mirror?: boolean;
    objectFit?: "cover" | "contain";
    style?: ViewStyle;
    trackRef: TrackReference | undefined;
    zOrder?: number;
}

Type declaration

  • Optional mirror?: boolean
  • Optional objectFit?: "cover" | "contain"
  • Optional style?: ViewStyle
  • trackRef: TrackReference | undefined
  • Optional zOrder?: number

Settings

Member Visibility

Theme

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

Type alias VideoTrackProps

VideoTrackProps: {
    mirror?: boolean;
    objectFit?: "cover" | "contain";
    style?: ViewStyle;
    trackRef: TrackReference | undefined;
    zOrder?: number;
}

Type declaration

  • Optional mirror?: boolean
  • Optional objectFit?: "cover" | "contain"
  • Optional style?: ViewStyle
  • trackRef: TrackReference | undefined
  • Optional zOrder?: number

Settings

Member Visibility

Theme

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

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 94fb0d0..1bf3bae 100644 --- a/docs/variables/log.html +++ b/docs/variables/log.html @@ -1 +1 @@ -log | LiveKit React Native Client SDK - v2.4.0

Variable logConst

log: Logger = ...

Settings

Member Visibility

Theme

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

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 0563fb9..123cb8d 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.4.0): + - livekit-react-native (2.4.1): - livekit-react-native-webrtc - React-Core - livekit-react-native-webrtc (125.0.3): @@ -1406,7 +1406,7 @@ SPEC CHECKSUMS: fmt: 4c2741a687cc09f0634a2e2c72a838b99f1ff120 glog: fdfdfe5479092de0c4bdbebedd9056951f092c4f hermes-engine: 01d3e052018c2a13937aca1860fbedbccd4a41b7 - livekit-react-native: f068b322636636e783771e7bea6cd9a0daa81b93 + livekit-react-native: b7f6b4b46b4fbd82cf97208d3dcfb64fb702ab0b livekit-react-native-webrtc: 33a7d7e4f0d321208d1a86e2c33f266654e83eb3 RCT-Folly: 02617c592a293bd6d418e0a88ff4ee1f88329b47 RCTDeprecation: b03c35057846b685b3ccadc9bfe43e349989cdb2 diff --git a/package.json b/package.json index c7aad76..611a317 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@livekit/react-native", - "version": "2.4.0", + "version": "2.4.1", "description": "LiveKit for React Native", "main": "lib/commonjs/index", "module": "lib/module/index",