Interface CreateIngressOptions

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

Properties

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

Properties

Optionalaudio

audio?: IngressAudioOptions

custom audio encoding parameters. optional

OptionalbypassTranscoding

bypassTranscoding?: boolean

Deprecated

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

OptionalenableTranscoding

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.

Optionalname

name?: string

ingress name. optional

participantIdentity

participantIdentity: string

unique identity of the participant. required

OptionalparticipantMetadata

participantMetadata?: string

metadata to attach to the participant

OptionalparticipantName

participantName?: string

participant display name

OptionalroomName

roomName?: string

name of the room to send media to. required

Optionalurl

url?: string

url of the media to pull for ingresses of type URL

Optionalvideo

video?: IngressVideoOptions

custom video encoding parameters. optional

Settings

Member Visibility

On This Page

Properties