LiveKit JS Server SDK - v2.13.3
    Preparing search index...

    Interface CreateIngressOptions

    interface CreateIngressOptions {
        audio?: IngressAudioOptions;
        bypassTranscoding?: boolean;
        enableTranscoding?: boolean;
        name?: string;
        participantIdentity: string;
        participantMetadata?: string;
        participantName?: string;
        roomName?: string;
        url?: string;
        video?: IngressVideoOptions;
    }
    Index

    Properties

    audio? bypassTranscoding? enableTranscoding? name? participantIdentity participantMetadata? participantName? roomName? url? video?

    Properties

    audio?: IngressAudioOptions

    custom audio encoding parameters. optional

    bypassTranscoding?: boolean

    use enableTranscoding instead. whether to skip transcoding and forward the input media directly. Only supported by WHIP

    enableTranscoding?: boolean

    whether to enable transcoding or forward the input media directly. Transcoding is required for all input types except WHIP. For WHIP, the default is to not transcode.

    name?: string

    ingress name. optional

    participantIdentity: string

    unique identity of the participant. required

    participantMetadata?: string

    metadata to attach to the participant

    participantName?: string

    participant display name

    roomName?: string

    name of the room to send media to. required

    url?: string

    url of the media to pull for ingresses of type URL

    video?: IngressVideoOptions

    custom video encoding parameters. optional

    Settings

    Member Visibility

    On This Page

    Properties