Interface ILocalDynamicMediaStream

The local dynamic media stream interface.

interface ILocalDynamicMediaStream {
    addTrack(track: MediaStreamTrack): void;
    getLabel(): string;
    getMediaStream(): MediaStream;
    getOwnerId(): string;
    removeTrack(param: MediaStreamTrack | MediaTrackKind): null | MediaStreamTrack;
    replaceTrack(track: MediaStreamTrack): void;
    setPriority(priority: MediaStreamPriority): void;
    setTransformations(transformations: MediaStreamTransformer[]): void;
    unpublish(): void;
}

Hierarchy (view full)

ILocalMediaStream
IDynamicMediaStream
- ILocalDynamicMediaStream

Index

Methods

addTrack getLabel getMediaStream getOwnerId removeTrack replaceTrack setPriority setTransformations unpublish

Methods

addTrack

addTrack(track): void
Add a track to the stream. This will replace any existing track of the same kind.
Parameters
- track: MediaStreamTrack
  The track to add.
Returns void

getLabel

getLabel(): string
Get the label of the stream.

Returns string
The label of the stream.

Inherited from IDynamicMediaStream.getLabel

getMediaStream

getMediaStream(): MediaStream
Get the media stream.

Returns MediaStream
The media stream.

Inherited from IDynamicMediaStream.getMediaStream

getOwnerId

getOwnerId(): string
Get the owner ID of the stream.

Returns string
The owner ID of the stream.

Inherited from IDynamicMediaStream.getOwnerId

removeTrack

removeTrack(param): null | MediaStreamTrack
Remove a track from the stream.
Parameters
- param: MediaStreamTrack | MediaTrackKind
  The track or kind of track to remove.
Returns null | MediaStreamTrack
The removed track or null if the track was not found.

replaceTrack

replaceTrack(track): void
Replace the track with same kind as the new track in the stream.
Parameters
- track: MediaStreamTrack
  The track to replace.
Returns void

setPriority

setPriority(priority): void
Set the priority of the stream.
Parameters
- priority: MediaStreamPriority
  The priority of the stream.
Returns void
Inherited from ILocalMediaStream.setPriority

setTransformations

setTransformations(transformations): void
Set the transformations to apply to the stream.
Parameters
- transformations: MediaStreamTransformer[]
  The transformations to apply to the stream.
Returns void
Inherited from IDynamicMediaStream.setTransformations

unpublish

unpublish(): void
Unpublish the stream.

Returns void
Inherited from ILocalMediaStream.unpublish