Class: RemoteStream

.Base. RemoteStream

Stream sent from a remote endpoint.
Events:

Event Name Argument Type Fired when
ended Event Stream is ended.
updated Event Stream is updated.

new RemoteStream()

Extends

Members


attributes :object

Custom attributes of a stream.

Type:
  • object
Inherited From:

extraCapabilities :Owt.Conference.SubscriptionCapabilities

Extra capabilities remote endpoint provides for subscription. Extra capabilities don't include original settings. This property is only valid in conference mode.

Type:

id :string

Type:
  • string

<nullable> mediaStream :MediaStream

Type:
  • MediaStream
Inherited From:
See:

origin :string

ID of the remote endpoint who published this stream.

Type:
  • string

settings :Owt.Base.PublicationSettings

Original settings for publishing this stream. This property is only valid in conference mode.

Type:

source :Owt.Base.StreamSourceInfo

Source info of a stream.

Type:
Inherited From:

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:

removeEventListener(eventType, listener)

This function removes a registered event listener.

Parameters:
Name Type Description
eventType string

Event string.

listener function

Callback function.

Inherited From: