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

    Function connect

    • Connect to a Twilio Group Room. The returned promise resolves once the Room emits connected, and rejects with a TwilioError if it emits connectFailure first (the partially-built Room is disposed on failure).

      Parameters

      • token: string

        A Twilio access token with a Video grant.

      • options: ConnectOptions = {}

        Room name, tracks to publish on join, and feature toggles.

      Returns Promise<Room>

      A promise resolving to the connected Room.

      (as a rejection) If token is not a non-empty string, or options is not an object.

      (as a rejection) If options.networkQuality verbosities are out of range.

      const audioTrack = createLocalAudioTrack('mic');
      const room = await connect(token, { name: 'my-room', audioTracks: [audioTrack] });