Member Junction
    Preparing search index...

    Class LiveKitMediaPreview

    A live, room-free media preview for a PreJoin screen.

    Index

    Constructors

    constructor

    Accessors

    VideoTrack

    Methods

    ReadMicLevel StartAudio StartVideo Stop StopAudio StopVideo

    Constructors

    Accessors

    • get VideoTrack(): LocalVideoTrack | null

      The current preview video track, if started.

      Returns LocalVideoTrack | null

    Methods

    • Reads the current microphone level (0..1) for a preview meter. Returns 0 when audio is not started.

      Returns number

    • Starts (or restarts) the preview microphone track and wires a live-level analyser.

      Parameters

      • OptionaldeviceId: string

        Optional microphone device id.

      Returns Promise<LocalAudioTrack>

      The preview audio track.

    • Starts (or restarts) the preview camera track, optionally on a specific device.

      Parameters

      • OptionaldeviceId: string

        Optional camera device id.

      Returns Promise<LocalVideoTrack>

      The preview video track.

    • Stops all preview tracks. Call when leaving the PreJoin screen.

      Returns Promise<void>

    • Stops the preview audio track and tears down the analyser.

      Returns Promise<void>

    • Stops the preview video track.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods