Type Alias WhipConfigurationOptions

Defines initial WHIP Client options.

type WhipConfigurationOptions = {
    audioEnabled?: boolean;
    preferredAudioCodecs?: SenderAudioCodecName[];
    preferredVideoCodecs?: SenderVideoCodecName[];
    stunServerUrl?: string;
    videoEnabled?: boolean;
    videoParameters?: VideoParameters;
}

Index

Properties

audioEnabled? preferredAudioCodecs? preferredVideoCodecs? stunServerUrl? videoEnabled? videoParameters?

Properties

`Optional`audioEnabled

audioEnabled?: boolean

A variable deciding whether the audio should be streamed or not. Defaults to true.

`Optional`preferredAudioCodecs

preferredAudioCodecs?: SenderAudioCodecName[]

`Optional`preferredVideoCodecs

preferredVideoCodecs?: SenderVideoCodecName[]

`Optional`stunServerUrl

stunServerUrl?: string

URL address of the STUN server. The default one is stun.l.google.com.

`Optional`videoEnabled

videoEnabled?: boolean

A variable deciding whether the video should be streamed or not. Defaults to true.

`Optional`videoParameters

videoParameters?: VideoParameters

Defines the parameters of the video. Defaults to HD43.