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

    Type Alias RemoteParticipantEvents

    Listener signatures for every event a RemoteParticipant can emit.

    The track events here are also re-emitted by the Room, with the participant appended as the last argument. See RoomEvents. networkQualityLevelChanged is not re-emitted, so it must be listened for on each participant.

    type RemoteParticipantEvents = {
        networkQualityLevelChanged: (level: number) => void;
        trackDisabled: (publication: RemoteTrackPublication) => void;
        trackEnabled: (publication: RemoteTrackPublication) => void;
        trackPublished: (publication: RemoteTrackPublication) => void;
        trackSubscribed: (
            track: RemoteVideoTrack | RemoteAudioTrack | RemoteDataTrack,
            publication: RemoteTrackPublication,
        ) => void;
        trackSubscriptionFailed: (
            error: TwilioError,
            publication: RemoteTrackPublication,
        ) => void;
        trackUnpublished: (publication: RemoteTrackPublication) => void;
        trackUnsubscribed: (
            track: RemoteVideoTrack | RemoteAudioTrack | RemoteDataTrack,
            publication: RemoteTrackPublication,
        ) => void;
        videoTrackSwitchedOff: (track: RemoteVideoTrack) => void;
        videoTrackSwitchedOn: (track: RemoteVideoTrack) => void;
    }
    Index
    networkQualityLevelChanged trackDisabled trackEnabled trackPublished trackSubscribed trackSubscriptionFailed trackUnpublished trackUnsubscribed videoTrackSwitchedOff videoTrackSwitchedOn
    networkQualityLevelChanged: (level: number) => void

    This participant's network quality changed. Emitted only when the Room was joined with network quality enabled for remote participants.

    Type Declaration

      • (level: number): void

      • Parameters

        • level: number

          Quality from 0 (worst) to 5 (best).

        Returns void

    trackDisabled: (publication: RemoteTrackPublication) => void

    This participant muted a track they publish. The track stays subscribed but stops delivering media.

    Type Declaration

    trackEnabled: (publication: RemoteTrackPublication) => void

    This participant unmuted a track they publish.

    Type Declaration

    trackPublished: (publication: RemoteTrackPublication) => void

    This participant published a track. Subscription follows separately, and trackSubscribed reports it.

    Type Declaration

    trackSubscribed: (
        track: RemoteVideoTrack | RemoteAudioTrack | RemoteDataTrack,
        publication: RemoteTrackPublication,
    ) => void

    One of this participant's tracks was subscribed to and is now delivering media or messages.

    A participant already publishing when connect resolved emits this afterwards. Subscriptions that completed before the listener was attached are not replayed; they appear in RemoteParticipant.tracks with isSubscribed set to true.

    Type Declaration

    trackSubscriptionFailed: (
        error: TwilioError,
        publication: RemoteTrackPublication,
    ) => void

    Subscribing to one of this participant's tracks failed. The track stays unsubscribed.

    Type Declaration

    trackUnpublished: (publication: RemoteTrackPublication) => void

    This participant unpublished a track.

    Type Declaration

    trackUnsubscribed: (
        track: RemoteVideoTrack | RemoteAudioTrack | RemoteDataTrack,
        publication: RemoteTrackPublication,
    ) => void

    One of this participant's tracks was unsubscribed from and stops delivering media. Its frame and message callbacks will not fire again.

    Type Declaration

    videoTrackSwitchedOff: (track: RemoteVideoTrack) => void

    The server stopped delivering a subscribed video track, typically to stay within the Room's bandwidth profile. The track stays subscribed and its isSwitchedOff reads true.

    Type Declaration

    videoTrackSwitchedOn: (track: RemoteVideoTrack) => void

    The server resumed delivering a video track that was switched off.

    Type Declaration

    Settings
    Member Visibility

    On This Page
    Properties