Type Alias ConfigurationOptions

Defines initial connection and stream options.

type ConfigurationOptions = {
    audioEnabled?: boolean;
    authToken?: string;
    stunServerUrl?: string;
    videoEnabled?: boolean;
    videoParameters?: VideoParameters;
}

Properties

audioEnabled?: boolean

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

authToken?: string

Authorization token that might be required to access the server.

stunServerUrl?: string

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

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.