import Room from 'webcom-reach/src/core/Room.js'

public class | source

Room

Room information

Member Summary

Public Members
public	extra: Object Additional room informations
public	localStream: Local The local stream of the room
public	name: string The room name
public	owner: string The room owner uid
public	status: string The room status: OPENED CLOSED
public	uid: string The room unique id

Method Summary

Public Methods
public	close(): Promise Leaves & close the Room.
public	getLocalVideo(type: string, localStreamContainer: Element, constraints: MediaStreamConstraints): Promise<Local, Error> get a local stream in video tag
public	invite(users: User[], role: string, message: string): Promise<{room: Room, invites: Invite[]}, Error> Invite users to the room.
public	join(): Promise Join the room.
public	leave(): Promise Leave the room.
public	localStreams(): Promise<Local[], Error> Get the list of locally published streams.
public	messages(): Promise<Message[], Error> Get the list of messages.
public	on(event: string, callback: function, cancelCallback: Webcom/api.Query~cancelCallback) Register a callback for a specific event
public	participants(): Promise<Participant[], Error> Get the list of participants.
public	publish(): Local publish a local stream
public	remoteStreams(): Promise<Remote[], Error> Get the list of remotely published streams.
public	sendMessage(message: string): Promise<Message> Send an instant message
public	share(type: string, localStreamContainer: Element, constraints: MediaStreamConstraints): Promise<Local, Error> Publish a local stream

Public Members

public extra: Object source

Additional room informations

public localStream: Local source

The local stream of the room

public name: string source

The room name

public owner: string source

The room owner uid

public status: string source

The room status:

OPENED
CLOSED

public uid: string source

The room unique id

Public Methods

public close(): Promise source

Leaves & close the Room. Only the owner/moderator can close a room.

Return:

Promise

public getLocalVideo(type: string, localStreamContainer: Element, constraints: MediaStreamConstraints): Promise<Local, Error> source

get a local stream in video tag

Params:

Name	Type	Attribute	Description
type	string		The stream type, see StreamTypes for possible values
localStreamContainer	Element	optional	The element the stream is attached to. Can be null if already specified in Config.
constraints	MediaStreamConstraints	optional	The stream constraints. If not defined, the constraints defined in Config will be used.

Return:

Promise<Local, Error>

public invite(users: User[], role: string, message: string): Promise<{room: Room, invites: Invite[]}, Error> source

Invite users to the room. This will only work if the current User is the owner or a moderator of this Room. This will create the invitation and add the user to the participants list.

Params:

Name	Type	Attribute	Description
users	User[]		the users to invite
role	string	optional default: 'NONE'	the role of the invitee
message	string	optional	a message to add to the invite

Return:

Promise<{room: Room, invites: Invite[]}, Error>

public join(): Promise source

Join the room. Sets the connected status of the current participant to CONNECTED.

Return:

Promise

public leave(): Promise source

Leave the room. Sets the connected status of the current participant to WAS_CONNECTED, deletes medias and callbacks, closes WebRTC stacks in use.

Return:

Promise

public localStreams(): Promise<Local[], Error> source

Get the list of locally published streams. The streams published with another device won't be visible here This will only work if the user is either a participant or the owner of the room.

Return:

Promise<Local[], Error>

public messages(): Promise<Message[], Error> source

Get the list of messages. This will only work if the user is either a participant or the owner of the room.

Return:

Promise<Message[], Error>

public on(event: string, callback: function, cancelCallback: Webcom/api.Query~cancelCallback) source

Params:

Name	Type	Attribute	Description
event	string		The event name (Events/Room): PARTICIPANT_ADDED: a participant is added to the room PARTICIPANT_CHANGED: a participant changes his status (join) PARTICIPANT_REMOVED: a participant leave the room MESSAGE_ADDED: new instant message MESSAGE_CHANGED: an existing message has been modified (moderation) MESSAGE_REMOVED: a message has been removed (moderation) STREAM_PUBLISHED: a participant published a new Stream STREAM_CHANGED: a participant changes his published Stream (moderation, type, mute...) STREAM_UNPUBLISHED: a participant stops the publication of his Stream
callback	function		The callback for the event, the arguments depends on the type of event: PARTICIPANT_* : callback(Participant p [, Error e]) MESSAGE_* : callback(Message m [, Error e]) STREAM_* : callback(Remote s [, Error e])
cancelCallback	Webcom/api.Query~cancelCallback		The error callback for the event, takes an Error as only argument

public participants(): Promise<Participant[], Error> source

Get the list of participants. This will only work if the user is either a participant or the owner of the room.

Return:

Promise<Participant[], Error>

public publish(): Local source

publish a local stream

Return:

Local

public remoteStreams(): Promise<Remote[], Error> source

Get the list of remotely published streams. This will only work if the user is either a participant or the owner of the room.

Return:

Promise<Remote[], Error>

public sendMessage(message: string): Promise<Message> source

Send an instant message

Params:

Name	Type	Attribute	Description
message	string		The message to send

Return:

Promise<Message>

Publish a local stream

Params:

Name	Type	Attribute	Description
type	string		The stream type, see StreamTypes for possible values
localStreamContainer	Element	optional	The element the stream is attached to. Can be null if already specified in Config.
constraints	MediaStreamConstraints	optional	The stream constraints. If not defined, the constraints defined in Config will be used.

Return:

Promise<Local, Error>

Room

Member Summary

Method Summary

Public Members

public extra: Object source

public localStream: Local source

public name: string source

public owner: string source

public status: string source

public uid: string source

Public Methods

public close(): Promise source

Return:

public getLocalVideo(type: string, localStreamContainer: Element, constraints: MediaStreamConstraints): Promise<Local, Error> source

Params:

Return:

public invite(users: User[], role: string, message: string): Promise<{room: Room, invites: Invite[]}, Error> source

Params:

Return:

public join(): Promise source

Return:

public leave(): Promise source

Return:

public localStreams(): Promise<Local[], Error> source

Return:

public messages(): Promise<Message[], Error> source

Return:

public on(event: string, callback: function, cancelCallback: Webcom/api.Query~cancelCallback) source

Params:

public participants(): Promise<Participant[], Error> source

Return:

public publish(): Local source

Return:

public remoteStreams(): Promise<Remote[], Error> source

Return:

public sendMessage(message: string): Promise<Message> source

Params:

Return:

public share(type: string, localStreamContainer: Element, constraints: MediaStreamConstraints): Promise<Local, Error> source

Params:

Return: