Class LocalDataTrack

ReadonlyisLocal

ReadonlytrackSymbol

ReadonlytypeSymbol

info

• get info(): DataTrackInfo | undefined

  Metrics about the data track publication.

  Returns DataTrackInfo | undefined

isPublished

• isPublished(): this is { info: DataTrackInfo }

  Returns this is { info: DataTrackInfo }

tryPush

• tryPush(
      frame: DataTrackFrame,
  ): Promise<
      Throws<
          void,
          | DataTrackPushFrameError<TrackUnpublished>
          | DataTrackPushFrameError<Dropped>,
      >,
  >

  Try pushing a frame to subscribers of the track.

  Pushing a frame can fail for several reasons:

  • The track has been unpublished by the local participant or SFU
  • The room is no longer connected

  Parameters

  • frame: DataTrackFrame

  Returns Promise<
      Throws<
          void,
          | DataTrackPushFrameError<TrackUnpublished>
          | DataTrackPushFrameError<Dropped>,
      >,
  >

unpublish

• unpublish(): Promise<void>

  Unpublish the track from the SFU. Once this is called, any further calls to tryPush will fail.

  Returns Promise<void>