Interface IRemoteMediaStream

The remote media stream interface.

interface IRemoteMediaStream {
    getAvailableTrackKinds(): MediaTrackKind[];
    getLabel(): string;
    getMediaStream(): MediaStream;
    getOwnerId(): string;
    onProviderChange(callback: ((providerId: undefined | string) => void)): Unsubscribe;
    subscribe(params?: MediaSubscriptionParams): void;
    unsubscribe(trackKinds?: MediaTrackKind | MediaTrackKind[]): void;
    update(params: MediaSubscriptionParams): void;
}

Hierarchy (view full)

Methods

getAvailableTrackKinds getLabel getMediaStream getOwnerId onProviderChange subscribe unsubscribe update

Methods

getAvailableTrackKinds

getLabel

  • getLabel(): string

  • Get the label of the stream.

    Returns string

    The label of the stream.

getMediaStream

getOwnerId

  • getOwnerId(): string

  • Get the owner ID of the stream.

    Returns string

    The owner ID of the stream.

onProviderChange

  • onProviderChange(callback): Unsubscribe

  • Subscribe to when the provider of the stream changes.

    Parameters

    • callback: ((providerId: undefined | string) => void)

      The callback to invoke when the provider changes.

        • (providerId): void

        • Parameters

          • providerId: undefined | string

          Returns void

    Returns Unsubscribe

subscribe

unsubscribe

  • unsubscribe(trackKinds?): void

  • Unsubscribe from track kinds of the stream. Passing no track kinds will unsubscribe from all subscribed track kinds.

    Parameters

    Returns void

update

Settings

Member Visibility

On This Page

Methods