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

    Type Alias LocalParticipantEvents

    Listener signatures for every event a LocalParticipant can emit.

    type LocalParticipantEvents = {
        networkQualityLevelChanged: (level: number) => void;
        trackPublicationFailed: (
            error: TwilioError,
            localTrack?: LocalTrack,
        ) => void;
        trackPublished: (publication: LocalTrackPublication) => void;
    }
    Index
    networkQualityLevelChanged: (level: number) => void

    The local participant's network quality changed. Emitted only when the Room was joined with network quality enabled for the local participant.

    Type Declaration

      • (level: number): void
      • Parameters

        • level: number

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

        Returns void

    trackPublicationFailed: (error: TwilioError, localTrack?: LocalTrack) => void

    Publishing a local track failed. The track is not published, and remote participants never see it.

    Type Declaration

      • (error: TwilioError, localTrack?: LocalTrack): void
      • Parameters

        • error: TwilioError

          Why publishing failed.

        • OptionallocalTrack: LocalTrack

          The track that failed to publish, or undefined if the failure could not be attributed to a track this participant still holds. Resolved by name, since a failed publication has no SID. If the name was re-published while the failure was in flight, this is the newer track.

        Returns void

    trackPublished: (publication: LocalTrackPublication) => void

    A local track finished publishing and remote participants can now subscribe to it.

    Type Declaration