Class LocalTrackPublication

constructor

• new LocalTrackPublication(
      kind: Kind,
      ti: TrackInfo,
      track?: LocalTrack<Kind>,
      loggerOptions?: LoggerOptions,
  ): LocalTrackPublication

  Parameters

  • kind: Kind
  • ti: TrackInfo
  • Optionaltrack: LocalTrack<Kind>
  • OptionalloggerOptions: LoggerOptions

  Returns LocalTrackPublication

Optionaloptions

Optionaltrack

audioTrack

• get audioTrack(): undefined | LocalAudioTrack

  an [AudioTrack] if this publication holds an audio track

  Returns undefined | LocalAudioTrack

isLocal

• get isLocal(): boolean

  Returns boolean

isMuted

• get isMuted(): boolean

  Returns boolean

isUpstreamPaused

• get isUpstreamPaused(): undefined | boolean

  Returns undefined | boolean

videoTrack

• get videoTrack(): undefined | LocalVideoTrack

  an [VideoTrack] if this publication holds a video track

  Returns undefined | LocalVideoTrack

getTrackFeatures

• getTrackFeatures(): AudioTrackFeature[]

  Returns AudioTrackFeature[]

handleTrackEnded

• handleTrackEnded(): void

  Returns void

mute

• mute(): Promise<undefined | LocalTrack<Kind>>

  Mute the track associated with this publication

  Returns Promise<undefined | LocalTrack<Kind>>

pauseUpstream

• pauseUpstream(): Promise<void>

  Pauses the media stream track associated with this publication from being sent to the server and signals "muted" event to other participants Useful if you want to pause the stream without pausing the local media stream track

  Returns Promise<void>

resumeUpstream

• resumeUpstream(): Promise<void>

  Resumes sending the media stream track associated with this publication to the server after a call to [[pauseUpstream()]] and signals "unmuted" event to other participants (unless the track is explicitly muted)

  Returns Promise<void>

unmute

• unmute(): Promise<undefined | LocalTrack<Kind>>

  Unmute track associated with this publication

  Returns Promise<undefined | LocalTrack<Kind>>