Class: Publication

.Base. Publication

Publication represents a sender for publishing a stream. It
handles the actions on a LocalStream published to a conference.

Events:

Event Name Argument Type Fired when
ended Event Publication is ended.
error ErrorEvent An error occurred on the publication.
mute MuteEvent Publication is muted. Client stopped sending audio and/or video data to remote endpoint.
unmute MuteEvent Publication is unmuted. Client continued sending audio and/or video data to remote endpoint.

ended event may not be fired on Safari after calling Publication.stop().


new Publication()

Extends

Members


id :string

Type:
  • string

Methods


addEventListener(eventType, listener)

This function registers a callback function as a handler for the corresponding event. It's shortened form is on(eventType, listener). See the event description in the following table.

Parameters:
Name Type Description
eventType string

Event string.

listener function

Callback function.

Inherited From:

clearEventListener(eventType)

This function removes all event listeners for one type.

Parameters:
Name Type Description
eventType string

Event string.

Inherited From:

getStats()

Get stats of underlying PeerConnection.

Returns:
Type
Promise.<RTCStatsReport, Error>

mute(kind)

Stop sending data to remote endpoint.

Parameters:
Name Type Description
kind Owt.Base.TrackKind

Kind of tracks to be muted.

Returns:
Type
Promise.<undefined, Error>

removeEventListener(eventType, listener)

This function removes a registered event listener.

Parameters:
Name Type Description
eventType string

Event string.

listener function

Callback function.

Inherited From:

stop()

Stop certain publication. Once a subscription is stopped, it cannot be recovered.

Returns:
Type
undefined

unmute(kind)

Continue sending data to remote endpoint.

Parameters:
Name Type Description
kind Owt.Base.TrackKind

Kind of tracks to be unmuted.

Returns:
Type
Promise.<undefined, Error>