LiveKit JS Client SDK - v2.23.0
    Preparing search index...

    Interface TrackProcessor<T, U>

    A processor is bound to the track it was set on, not to the room, and it does not survive the track being stopped: unpublishing a track or disconnecting from a room destroys its processor. Both paths stop the track by default, so after reconnecting or republishing, call setProcessor again on the new track to put the processor back.

    The exception is stopLocalTrackOnUnpublish: false, which keeps the track alive across an unpublish or disconnect. A video processor then survives with it. An audio processor only survives if the audio context came from the application, because a context the SDK created is closed on disconnect and the processor goes with it.

    interface TrackProcessor<
        T extends Kind,
        U extends ProcessorOptions<T> = ProcessorOptions<T>,
    > {
        destroy: () => Promise<void>;
        init: (opts: U) => Promise<void>;
        name: string;
        onPublish?: (room: Room) => Promise<void>;
        onUnpublish?: () => Promise<void>;
        processedTrack?: MediaStreamTrack;
        restart: (opts: U) => Promise<void>;
    }

    Type Parameters

    Index
    destroy init name onPublish? onUnpublish? processedTrack? restart
    destroy: () => Promise<void>
    init: (opts: U) => Promise<void>
    name: string
    onPublish?: (room: Room) => Promise<void>
    onUnpublish?: () => Promise<void>
    processedTrack?: MediaStreamTrack
    restart: (opts: U) => Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties