@videosdk.live/server-sdk
    Preparing search index...

    Interface EgressHandle

    A handle to a running egress. Returned by start(); pass it (or a bare roomId) to stop().

    Recording, HLS, and RTMP stop by roomId (an id is only an optional disambiguator); composite stop requires the id (its recordingId), which its start response provides.

    interface EgressHandle {
        id?: string;
        raw?: unknown;
        roomId: string;
        sessionId?: string;
        type: EgressType;
    }
    Index
    id? raw? roomId sessionId? type
    id?: string

    Server id when the start response provides one (composite recordingId, HLS id).

    raw?: unknown

    The raw start response (a confirmation string, or an object).

    roomId: string

    The room the egress runs in — the primary stop key.

    sessionId?: string

    Session correlation id when the start response provides one (composite).

    type: EgressType

    Which egress this handle refers to.

    Settings
    Member Visibility

    On This Page
    Properties