Class: LocalStream

.Base. LocalStream

Stream captured from current endpoint.


new LocalStream(stream, sourceInfo, attributes)

Parameters:
Name Type Description
stream MediaStream

Underlying MediaStream.

sourceInfo Owt.Base.StreamSourceInfo

Information about stream's source.

attributes object

Custom attributes of the stream.

Extends

Members


attributes :object

Custom attributes of a stream.

Type:
  • object
Inherited From:

id :string

Type:
  • string

<nullable> mediaStream :MediaStream

Type:
  • MediaStream
Inherited From:
See:

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: