@twilio/video-node-sdk - v1.0.0-beta.2
    Preparing search index...

    Interface ConnectOptions

    Options for connect. All fields are optional; omitted feature toggles fall back to Room/server defaults.

    interface ConnectOptions {
        audioTracks?: LocalAudioTrack[];
        bandwidthProfile?: BandwidthProfileOptions;
        connectionTimeout?: number;
        dataTracks?: LocalDataTrack[];
        enableAutomaticSubscription?: boolean;
        enableDominantSpeaker?: boolean;
        enableInsights?: boolean;
        encodingParameters?: EncodingParameters;
        iceOptions?: IceOptions;
        name?: string;
        networkQuality?: boolean | NetworkQualityConfiguration;
        preferredAudioCodecs?: AudioCodec[];
        preferredVideoCodecs?: "VP8"[];
        receiveTranscriptions?: boolean;
        region?: string;
        videoEncodingMode?: "auto";
        videoTracks?: LocalVideoTrack[];
    }
    Index
    audioTracks? bandwidthProfile? connectionTimeout? dataTracks? enableAutomaticSubscription? enableDominantSpeaker? enableInsights? encodingParameters? iceOptions? name? networkQuality? preferredAudioCodecs? preferredVideoCodecs? receiveTranscriptions? region? videoEncodingMode? videoTracks?
    audioTracks?: LocalAudioTrack[]

    Local audio tracks to publish on join.

    bandwidthProfile?: BandwidthProfileOptions

    Limits on incoming media, controlling how subscribed tracks share bandwidth.

    connectionTimeout?: number

    Milliseconds to wait for the Room to connect before giving up. On expiry the promise rejects with a RoomConnectTimeoutError and the partially built Room is disposed. Defaults to 30000. Pass 0 to wait indefinitely.

    dataTracks?: LocalDataTrack[]

    Local data tracks to publish on join.

    enableAutomaticSubscription?: boolean

    Automatically subscribe to remote participants' tracks. When false, tracks must be subscribed to explicitly.

    enableDominantSpeaker?: boolean

    Enable dominant-speaker detection, which powers Room.dominantSpeaker and the dominantSpeakerChanged event.

    enableInsights?: boolean

    Enable Twilio Insights telemetry for this Room.

    encodingParameters?: EncodingParameters

    Initial send-bitrate limits; equivalent to calling LocalParticipant.setEncodingParameters after connect.

    iceOptions?: IceOptions

    Overrides for ICE candidate gathering and transport policy.

    name?: string

    Room name to connect to. When omitted, the Room SID is used as its name.

    networkQuality?: boolean | NetworkQualityConfiguration

    Enable network-quality reporting. Pass true for default verbosity (local=1, remote=0) or an object to set verbosities individually. Setting false (or omitting) disables reporting.

    preferredAudioCodecs?: AudioCodec[]

    Preferred audio codecs in descending priority.

    preferredVideoCodecs?: "VP8"[]

    Preferred video codecs in descending priority.

    receiveTranscriptions?: boolean

    Subscribe to live transcriptions, delivered via the Room's transcription event.

    region?: string

    Signaling region to connect through (e.g. us1, gll for lowest-latency).

    videoEncodingMode?: "auto"

    How outgoing video encodings are selected.

    videoTracks?: LocalVideoTrack[]

    Local video tracks to publish on join.

    Settings
    Member Visibility

    On This Page
    Properties