Type alias ConnectionOptions

ConnectionOptions: {
    audio?: boolean;
    audioBitRate?: number;
    audioCodecType?: AudioCodecType;
    audioOpusParamsChannels?: number;
    audioOpusParamsMaxplaybackrate?: number;
    audioOpusParamsMinptime?: number;
    audioOpusParamsPtime?: number;
    audioOpusParamsSpropStereo?: boolean;
    audioOpusParamsStereo?: boolean;
    audioOpusParamsUsedtx?: boolean;
    audioOpusParamsUseinbandfec?: boolean;
    audioStreamingLanguageCode?: string;
    bundleId?: string;
    clientId?: string;
    connectionTimeout?: number;
    dataChannelSignaling?: boolean;
    dataChannels?: DataChannelConfiguration[];
    disconnectWaitTimeout?: number;
    e2ee?: boolean;
    forwardingFilter?: JSONType;
    ignoreDisconnectWebSocket?: boolean;
    multistream?: boolean;
    signalingCandidateTimeout?: number;
    signalingNotifyMetadata?: JSONType;
    simulcast?: boolean;
    simulcastRid?: SimulcastRid;
    spotlight?: boolean;
    spotlightFocusRid?: SpotlightFocusRid;
    spotlightNumber?: number;
    spotlightUnfocusRid?: SpotlightFocusRid;
    timeout?: number;
    video?: boolean;
    videoAV1Params?: JSONType;
    videoBitRate?: number;
    videoCodecType?: VideoCodecType;
    videoH264Params?: JSONType;
    videoH265Params?: JSONType;
    videoVP9Params?: JSONType;
}

Type declaration

  • Optional audio?: boolean
  • Optional audioBitRate?: number
  • Optional audioCodecType?: AudioCodecType
  • Optional audioOpusParamsChannels?: number
  • Optional audioOpusParamsMaxplaybackrate?: number
  • Optional audioOpusParamsMinptime?: number
  • Optional audioOpusParamsPtime?: number
  • Optional audioOpusParamsSpropStereo?: boolean
  • Optional audioOpusParamsStereo?: boolean
  • Optional audioOpusParamsUsedtx?: boolean
  • Optional audioOpusParamsUseinbandfec?: boolean
  • Optional audioStreamingLanguageCode?: string
  • Optional bundleId?: string
  • Optional clientId?: string
  • Optional connectionTimeout?: number
  • Optional dataChannelSignaling?: boolean
  • Optional dataChannels?: DataChannelConfiguration[]
  • Optional disconnectWaitTimeout?: number
  • Optional e2ee?: boolean
  • Optional forwardingFilter?: JSONType
  • Optional ignoreDisconnectWebSocket?: boolean
  • Optional multistream?: boolean
  • Optional signalingCandidateTimeout?: number
  • Optional signalingNotifyMetadata?: JSONType
  • Optional simulcast?: boolean
  • Optional simulcastRid?: SimulcastRid
  • Optional spotlight?: boolean
  • Optional spotlightFocusRid?: SpotlightFocusRid
  • Optional spotlightNumber?: number
  • Optional spotlightUnfocusRid?: SpotlightFocusRid
  • Optional timeout?: number
  • Optional video?: boolean
  • Optional videoAV1Params?: JSONType
  • Optional videoBitRate?: number
  • Optional videoCodecType?: VideoCodecType
  • Optional videoH264Params?: JSONType
  • Optional videoH265Params?: JSONType
  • Optional videoVP9Params?: JSONType