import Local from 'webcom-reach/src/core/stream/Local.js'

public class | source

Local

The local stream

Member Summary

Public Members
public get	constraints: MediaConstraints The Media Constraints.
public set	constraints(constraints: MediaConstraints) The Media Constraints.
public	container: Element The local DOM container element where the Local~media is displayed
public	isVideoLoaded: boolean is the video is loaded int the local DOM media element
public get	media: MediaStream The associated MediaStream
public set	media: MediaStream The associated MediaStream
public	muted: {audio: boolean, video: boolean} Indicates if a track is muted
public	node: Element The local DOM media element where the Local~media is displayed
public	peerConnections: PeerConnection[] List of the PeerConnections associated to this local stream
public	roomId: string The uid of the room the stream is published in
public	status: string Local stream status
public	type: string The type of the stream
public	uid: string The uid of this stream

Method Summary

Public Methods
public	close(): Promise Removes stream for published list, closes associated PeerConnections and stops current MediaStream
public	mute(track: string, state: boolean) Mute a track of a Stream
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	switchCamera(deviceId: string): Promise<Local, Error> Switch video input device
public	switchMicrophone(deviceId: string): Promise<Local, Error> Switch audio input device
public	unMute(track: string) Un-mute a track of a Stream
public	updateConstraints(constraints: ): \| Promise<TResult> Updates the stream constraints and retrieve the new MediaStream

Public Members

public get constraints: MediaConstraints source

The Media Constraints. (defaults to global config)

public set constraints(constraints: MediaConstraints) source

The Media Constraints. (defaults to global config)

public container: Element source

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

public isVideoLoaded: boolean source

is the video is loaded int the local DOM media element

public get media: MediaStream source

The associated MediaStream

public set media: MediaStream source

The associated MediaStream

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

Indicates if a track is muted

public node: Element source

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

public peerConnections: PeerConnection[] source

List of the PeerConnections associated to this local stream

public roomId: string source

The uid of the room the stream is published in

public status: string source

Local stream status

public type: string source

The type of the stream

public uid: string source

The uid of this stream

Public Methods

public close(): Promise source

Removes stream for published list, closes associated PeerConnections and stops current MediaStream

Return:

Promise

public mute(track: string, state: boolean) source

Mute a track of a Stream

Params:

Name	Type	Attribute	Description
track	string	optional default: AUDIO	The track to mute. (AUDIO, VIDEO, AUDIO_VIDEO)
state	boolean	optional default: true	true for mute & false for un-mute

Example:

mute video

stream.mute(Reach.t.VIDEO)

mute audio

stream.mute(Reach.t.AUDIO)
// or
stream.mute()

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

Params:

Name	Type	Attribute	Description
event	string	optional	The event name (Events/Stream)
callback	function	optional	The callback for the event

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

Params:

Name	Type	Attribute	Description
event	string		The event name (Events/Stream)
callback	function		The callback for the event

public switchCamera(deviceId: string): Promise<Local, Error> source

Switch video input device

Params:

Name	Type	Attribute	Description
deviceId	string	optional	A video input device Id or the `facingMode` value

Return:

Promise<Local, Error>

public switchMicrophone(deviceId: string): Promise<Local, Error> source

Switch audio input device

Params:

Name	Type	Attribute	Description
deviceId	string	optional	A audio input device Id

Return:

Promise<Local, Error>

public unMute(track: string) source

Un-mute a track of a Stream

Params:

Name	Type	Attribute	Description
track	string	optional default: AUDIO	The track to mute. (AUDIO, VIDEO, AUDIO_VIDEO)

Example:

Un-mute video

stream.unMute(Reach.t.VIDEO)

Un-mute audio

stream.unMute(Reach.t.AUDIO)
// or
stream.unMute()

public updateConstraints(constraints: ): | Promise<TResult> source

Updates the stream constraints and retrieve the new MediaStream

Params:

Name	Type	Attribute	Description
constraints	*

Return:

* | Promise<TResult>

Local

Member Summary

Method Summary

Public Members

public get constraints: MediaConstraints source

public set constraints(constraints: MediaConstraints) source

public container: Element source

public isVideoLoaded: boolean source

public get media: MediaStream source

public set media: MediaStream source

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

public node: Element source

public peerConnections: PeerConnection[] source

public roomId: string source

public status: string source

public type: string source

public uid: string source

Public Methods

public close(): Promise source

Return:

public mute(track: string, state: boolean) source

Params:

Example:

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

Params:

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

Params:

public switchCamera(deviceId: string): Promise<Local, Error> source

Params:

Return:

public switchMicrophone(deviceId: string): Promise<Local, Error> source

Params:

Return:

public unMute(track: string) source

Params:

Example:

public updateConstraints(constraints: *): * | Promise<TResult> source

Params:

Return:

public updateConstraints(constraints: ): | Promise<TResult> source