LiveKit React Native Client SDK - v3.1.0
    Preparing search index...

    Interface LiveKitRoomProps

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

    Properties

    audio?: boolean | AudioCaptureOptions

    Publish audio immediately after connecting to your LiveKit room.

    connect?: boolean

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

    true

    connectOptions?: RoomConnectOptions

    Define options how to connect to the LiveKit server.

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

    Options for when creating a new room. When you pass your own room instance to this component, these options have no effect. Instead, set the options directly in the room instance.

    room?: Room

    Optional room instance. By passing your own room instance you overwrite the options parameter, make sure to set the options directly on the room instance itself.

    screen?: boolean | ScreenShareCaptureOptions

    Publish screen share immediately after connecting to your LiveKit room.

    serverUrl: string | undefined

    URL to the LiveKit server. For example: wss://<domain>.livekit.cloud To simplify the implementation, undefined is also accepted as an intermediate value, but only with a valid string url can the connection be established.

    simulateParticipants?: number
    token: string | undefined

    A user specific access token for a client to authenticate to the room. This token is necessary to establish a connection to the room. To simplify the implementation, undefined is also accepted as an intermediate value, but only with a valid string token can the connection be established.

    video?: boolean | VideoCaptureOptions

    Publish video immediately after connecting to your LiveKit room.