Type Alias WhipConfigurationOptions

Defines initial WHIP Client options.

type WhipConfigurationOptions = {
    audioEnabled?: boolean;
    stunServerUrl?: string;
    videoDeviceId?: CameraId;
    videoEnabled?: boolean;
    videoParameters?: VideoParameters;
}

Properties

audioEnabled?: boolean

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

stunServerUrl?: string

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

videoDeviceId?: CameraId

ID of the camera.

videoEnabled?: boolean

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

videoParameters?: VideoParameters

Defines the parameters of the video. Defaults to HD43.