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

    Module index

    Server-side Node.js SDK for Twilio Video Group Rooms with raw media frame access.

    connect joins a Group Room and resolves with a Room. From there, Room.localParticipant publishes tracks and Room.participants exposes the remote participants whose tracks can be subscribed to. Local tracks come from createLocalVideoTrack, createLocalAudioTrack, createLocalDataTrack, and createLocalTracks.

    Video frames are I420 planar and audio is 48 kHz mono S16LE PCM, in both directions. Timestamps are plain numbers of microseconds. Receive frames with for await (const frame of track.frames()); awaiting each frame is what applies backpressure. Call Room.dispose when finished to release native resources.

    Participant
    Room
    Track
    AccessTokenExpiredError
    AccessTokenGrantsInvalidError
    AccessTokenHeaderInvalidError
    AccessTokenInvalidError
    AccessTokenIssuerInvalidError
    AccessTokenNotYetValidError
    AccessTokenSignatureInvalidError
    DataTrackSendError
    LocalAudioTrackPublication
    LocalDataTrackPublication
    LocalParticipant
    LocalTrackPublication
    LocalVideoTrackPublication
    MediaClientLocalDescFailedError
    MediaClientRemoteDescFailedError
    MediaConnectionError
    MediaNoSupportedCodecError
    MediaServerLocalDescFailedError
    MediaServerRemoteDescFailedError
    NativeBindingLoadError
    ParticipantDuplicateIdentityError
    ParticipantMaxTracksExceededError
    RemoteAudioTrack
    RemoteAudioTrackPublication
    RemoteDataTrack
    RemoteDataTrackPublication
    RemoteParticipant
    RemoteTrackPublication
    RemoteVideoTrack
    RemoteVideoTrackPublication
    Room
    RoomCompletedError
    RoomConnectFailedError
    RoomConnectTimeoutError
    RoomMaxParticipantsExceededError
    RoomNotFoundError
    SignalingConnectionDisconnectedError
    SignalingConnectionError
    SignalingConnectionTimeoutError
    TrackInvalidError
    TrackNameCharsInvalidError
    TrackNameInvalidError
    TrackNameTooLongError
    TrackPublication
    TwilioError
    TypedEventEmitter
    UnsupportedPlatformError
    AudioFrame
    AudioFrameInput
    AudioTrackOptions
    BandwidthProfileOptions
    ConnectOptions
    CreateLocalAudioTrackOptions
    CreateLocalTracksOptions
    CreateLocalVideoTrackOptions
    DataTrackSendResult
    DeliveryStats
    EncodingParameters
    FrameDeliveryOptions
    I420Plane
    IceOptions
    IceServer
    LocalAudioTrack
    LocalAudioTrackStats
    LocalDataTrack
    LocalDataTrackOptions
    LocalTrackStats
    LocalVideoTrack
    LocalVideoTrackStats
    NetworkQualityConfiguration
    RawAudioSourceOptions
    RawVideoSourceOptions
    RemoteAudioTrackStats
    RemoteTrackStats
    RemoteVideoTrackStats
    StatsReport
    StatsVideoDimensions
    TrackStats
    TwilioErrorClass
    VideoBandwidthProfileOptions
    VideoContentPreferences
    VideoFrame
    VideoFrameInput
    VideoRenderDimensions
    VideoTrackOptions
    WriteStats
    AudioCodec
    BackpressureMode
    BandwidthProfileMode
    ClientTrackSwitchOffControl
    LocalParticipantEvents
    LocalTrack
    LogLevel
    NetworkQualityVerbosity
    ParticipantState
    RemoteDataTrackEvents
    RemoteMediaTrackEvents
    RemoteParticipantEvents
    RemoteTrack
    RoomEvents
    RoomState
    TrackKind
    TrackSwitchOffMode
    VideoCodec
    VideoContentPreferencesMode
    VideoEncodingMode
    ErrorCode
    MAX_QUEUE_CEILING
    SDK_LOCAL_CODE
    connect
    createLocalAudioTrack
    createLocalDataTrack
    createLocalTracks
    createLocalVideoTrack
    getVersion
    setLogLevel
    twilioErrorFromCode