Class JitsiTrack

constructor

• new JitsiTrack(
      conference: JitsiConference,
      stream: MediaStream,
      track: MediaStreamTrack,
      streamInactiveHandler: (this: MediaStreamTrack, ev: Event) => void,
      trackMediaType: MediaType,
      videoType?: VideoType,
  ): JitsiTrack

  Represents a single media track (either audio or video).

  Parameters

  • conference: JitsiConference

    the rtc instance
  • stream: MediaStream

    the WebRTC MediaStream instance
  • track: MediaStreamTrack

    the WebRTC MediaStreamTrack instance, must be part of the given stream.
  • streamInactiveHandler: (this: MediaStreamTrack, ev: Event) => void

    the function that will handle onended/oninactive events of the stream.
  • trackMediaType: MediaType

    the media type of the JitsiTrack
  • OptionalvideoType: VideoType

    the VideoType for this track if any

  Returns JitsiTrack

conference

disposed

videoType

attach

• attach(container: HTMLElement): Promise<void>

  Attaches the MediaStream of this track to an HTML container. Adds the container to the list of containers that are displaying the track.

  Parameters

  • container: HTMLElement

    the HTML container which can be 'video' or 'audio' element.

  Returns Promise<void>

detach

• detach(container?: HTMLElement): void

  Removes this JitsiTrack from the passed HTML container.

  Parameters

  • Optionalcontainer: HTMLElement

    the HTML container to detach from this JitsiTrack. If null or undefined, all containers are removed. A container can be a 'video', 'audio' or 'object' HTML element instance to which this JitsiTrack is currently attached.

  Returns void

dispose

• dispose(): Promise<void>

  Removes attached event listeners.

  Returns Promise<void>

getHeight

• getHeight(): number

  Returns the height of the track in normalized landscape format.

  Returns number

getId

• getId(): string

  Returns id of the track.

  Returns string

  id of the track or null if this is fake track.

getOriginalStream

• getOriginalStream(): MediaStream

  Returns the WebRTC MediaStream instance.

  Returns MediaStream

getSourceName

• getSourceName(): string

  Returns the source name of the track.

  Returns string

getSsrc

• getSsrc(): number

  Returns the primary SSRC associated with the track.

  Returns number

getStreamId

• getStreamId(): string

  Returns the ID of the underlying WebRTC Media Stream(if any)

  Returns string

getTrack

• getTrack(): MediaStreamTrack

  Return the underlying WebRTC MediaStreamTrack

  Returns MediaStreamTrack

getTrackId

• getTrackId(): string

  Returns the ID of the underlying WebRTC MediaStreamTrack(if any)

  Returns string

getTrackLabel

• getTrackLabel(): string

  Return the underlying WebRTC MediaStreamTrack label

  Returns string

getType

• getType(): MediaType

  Returns the type (audio or video) of this track.

  Returns MediaType

getUsageLabel

• getUsageLabel(): string

  Return meaningful usage label for this track depending on it's media and eventual video type.

  Returns string

getVideoType

• getVideoType(): VideoType

  Returns the video type (camera or desktop) of this track.

  Returns VideoType

getWidth

• getWidth(): number

  Returns the width of the track in normalized landscape format.

  Returns number

isActive

• isActive(): boolean

  Checks whether the MediaStream is active/not ended. When there is no check for active we don't have information and so will return that stream is active (in case of FF).

  Returns boolean

  whether MediaStream is active.

isAudioTrack

• isAudioTrack(): boolean

  Check if this is an audio track.

  Returns boolean

AbstractisLocal

• isLocal(): boolean

  Checks whether this is a local track.

  Returns boolean

  'true' if it's a local track or 'false' otherwise.

isLocalAudioTrack

• isLocalAudioTrack(): boolean

  Check whether this is a local audio track.

  Returns boolean

  • true if track represents a local audio track, false otherwise.

AbstractisMuted

• isMuted(): boolean

  Checks whether this track is muted.

  Returns boolean

isVideoTrack

• isVideoTrack(): boolean

  Check if this is a video track.

  Returns boolean

setAudioLevel

• setAudioLevel(audioLevel: number, tpc?: TraceablePeerConnection): void

  Sets the audio level for the stream

  Parameters

  • audioLevel: number

    value between 0 and 1
  • Optionaltpc: TraceablePeerConnection

    the peerconnection instance which is source for the audio level. It can be undefined for a local track if the audio level was measured outside of the peerconnection (see /modules/statistics/LocalStatsCollector.js).

  Returns void

setAudioOutput

• setAudioOutput(audioOutputDeviceId: string): Promise<void>

  Sets new audio output device for track's DOM elements. Video tracks are ignored. Emits JitsiTrackEvents.TRACK_AUDIO_OUTPUT_CHANGED.

  Parameters

  • audioOutputDeviceId: string

    id of 'audiooutput' device from navigator.mediaDevices.enumerateDevices(), '' for default device

  Returns Promise<void>

setSourceName

• setSourceName(_name: string): void

  Assigns the source name to a track.

  Parameters

  • _name: string

    The name to be assigned to the track.

  Returns void