Home Manual Reference Source 
import Remote from 'webcom-reach/src/core/stream/Remote.js'
public class | source

Remote

A published Stream

Member Summary

Public Members
public

[key]: *

public

The local DOM container element where the Local~media is displayed
public
public

The uid of the publisher of the stream
public
public

muted: {audio: boolean, video: boolean}

public get

DOM element where the MediaStream is displayed
public

PeerConnections associated to this remote stream
public

The uid of the room the stream is published in
public

The type of the stream
public

The uid of this stream
public

the user agent of the publisher of the stream
public

Method Summary

Public Methods
public

off(event: string, callback: function)

Register a callback for a specific event
public

on(event: string, callback: function)

Register a callback for a specific event
public

subscribe(remoteStreamContainer: Element): Promise

Subscribe to the stream
public

Unsubscribe from the stream

Public Members

public [key]: * source

public container: Element source

The local DOM container element where the Local~media is displayed

public device: string source

public from: string source

The uid of the publisher of the stream

public height: string source

public muted: {audio: boolean, video: boolean} source

public get node: Element: * source

DOM element where the MediaStream is displayed

Return:

Element

public peerConnection: PeerConnection source

PeerConnections associated to this remote stream

public roomId: string source

The uid of the room the stream is published in

public type: string source

The type of the stream

public uid: string source

The uid of this stream

public userAgent: string source

the user agent of the publisher of the stream

public width: string source

Public Methods

public off(event: string, callback: function) source

Register a callback for a specific event

Params:

NameTypeAttributeDescription
event string
  • optional

The event name (Events/Stream)
callback function
  • optional

The callback for the event

public on(event: string, callback: function) source

Register a callback for a specific event

Params:

NameTypeAttributeDescription
event string

The event name (Events/Stream)
callback function

The callback for the event

public subscribe(remoteStreamContainer: Element): Promise source

Subscribe to the stream

Params:

NameTypeAttributeDescription
remoteStreamContainer Element
  • optional

The element the stream is attached to. Can be null if already specified in ReachConfig.

Return:

Promise

public unSubscribe(): Promise source

Unsubscribe from the stream

Return:

Promise