import Reach from 'webcom-reach/src/Reach.js'

public class | source

Reach

Entry point for Reach SDK

Static Member Summary

Static Public Members
public static get	audioBitrateMax: audioBitrateMax: * static get audioBitrateMax() { The audio bitrate maximum Config#audioBitrateMax
public static get	browser: Browser: * The browser's details
public static get	codecs: {audio: Codec/audio, video: Codec/video}: {"audio": , "video": } The codec presets to use when setting Config#preferredAudioCodec or Config#preferredVideoCodec
public static get	communicationQuality: communicationQuality: * The bitrate presets to use when setting Config#communicationQuality
public static get	events: { room: Events/Room, reach: Events/Reach, stream: Events/Stream, invite: Events/Invite, local: Events/Local }: {"room": , "reach": , "stream": , "invite": , "local": *} The supported events
public static get	media: Media: * Media utility functions
public static get	types: StreamTypes: * The supported stream types
public static get	version: {sdk: string, schema: string}: {"sdk": , "schema": } Get versions of SDK and DataModel.
public static get	videoBitrateMax: videoBitrateMax: * static get videoBitrateMax() { The audio bitrate maximum Config#videoBitrateMax

Constructor Summary

Public Constructor
public	constructor(url: string \| Webcom, cfg: Config) Create Reach's data structure where the url points to (might not be the root of your namespace)

Member Summary

Public Members
public get	base: Webcom DataSync reference
public get	config: Config The configuration
public get	current: User The connected User
public get	peerConnections: : Get a list of all opened PeerConnections

Method Summary

Public Methods
public	anonymous(name: string): Promise<User> Sign-in an anonymous user
public	createRoom(name: string, extra: object, publicRoom: boolean): Promise<Room> Create a new room
public	getRoom(uid: string): Promise<Room> Get a Room from its `uid`
public	getUser(uid: string): Promise<User> Get a User from its `uid`
public	invites(): Promise<Invite[], Error> Get the list of invites
public	login(email: string, password: string, name: string, rememberMe: boolean): Promise<User> Sign-in an existing user
public	logout(): Promise Logout current user
public	on(event: string, callback: function, cancelCallback: Webcom/api.Query~cancelCallback) Register a callback for a specific event
public	register(email: string, password: string, name: string, rememberMe: boolean): Promise<User> Register & Sign-in as a new user
public	resume(): Promise<User> Resume previous session

Static Public Members

public static get audioBitrateMax: audioBitrateMax: * source

static get audioBitrateMax() { The audio bitrate maximum Config#audioBitrateMax

Return:

audioBitrateMax

public static get browser: Browser: * source

The browser's details

Return:

Browser

public static get codecs: {audio: Codec/audio, video: Codec/video}: {"audio": , "video": } source

The codec presets to use when setting Config#preferredAudioCodec or Config#preferredVideoCodec

Return:

{audio: Codec/audio, video: Codec/video}

public static get communicationQuality: communicationQuality: * source

The bitrate presets to use when setting Config#communicationQuality

Return:

communicationQuality

public static get events: { room: Events/Room, reach: Events/Reach, stream: Events/Stream, invite: Events/Invite, local: Events/Local }: {"room": , "reach": , "stream": , "invite": , "local": *} source

The supported events

Return:

{ room: Events/Room, reach: Events/Reach, stream: Events/Stream, invite: Events/Invite, local: Events/Local }

public static get media: Media: * source

Media utility functions

Return:

Media

public static get types: StreamTypes: * source

The supported stream types

Return:

StreamTypes

public static get version: {sdk: string, schema: string}: {"sdk": , "schema": } source

Get versions of SDK and DataModel. The Schema version can be used to determine compatibility with the Android & iOS SDK.

Return:

{sdk: string, schema: string}

public static get videoBitrateMax: videoBitrateMax: * source

static get videoBitrateMax() { The audio bitrate maximum Config#videoBitrateMax

Return:

videoBitrateMax

Public Constructors

public constructor(url: string | Webcom, cfg: Config) source

Create Reach's data structure where the url points to (might not be the root of your namespace)

Params:

Name	Type	Attribute	Description
url	string \| Webcom		The url of your namespace or an existing Webcom reference.
cfg	Config	optional	Reach configuration. You can pass constraints here

Example:

Init with the default configuration

var myReach = new Reach('https://io.datasync.orange.com/base/<my_namespace>');

Init and set constraints for SD video and logLevel to 'info'

var myReach = new Reach('https://io.datasync.orange.com/base/<my_namespace>', {
 constraints: Reach.media.constraints('SD'),
 logLevel: 'INFO'
});

Public Members

public get base: Webcom source

DataSync reference

public get config: Config source

The configuration

public get current: User source

The connected User

public get peerConnections: : source

Get a list of all opened PeerConnections

Return:

Public Methods

public anonymous(name: string): Promise<User> source

Sign-in an anonymous user

Params:

Name	Type	Attribute	Description
name	string		The display name of the user

Return:

Promise<User>

public createRoom(name: string, extra: object, publicRoom: boolean): Promise<Room> source

Create a new room

Params:

Name	Type	Attribute	Description
name	string	optional	The room name
extra	object	optional	Extra informations
publicRoom	boolean	optional default: false	Indicates public room

Return:

Promise<Room>

public getRoom(uid: string): Promise<Room> source

Get a Room from its uid

Params:

Name	Type	Attribute	Description
uid	string		The room's UID

Return:

Promise<Room>

public getUser(uid: string): Promise<User> source

Get a User from its uid

Params:

Name	Type	Attribute	Description
uid	string		The user's UID

Return:

Promise<User>

public invites(): Promise<Invite[], Error> source

Get the list of invites

Return:

Promise<Invite[], Error>

Sign-in an existing user

Params:

Name	Type	Attribute	Description
email	string		The email of the user
password	string		The password of the user
name	string	optional	The name of the user. Defaults to the value in base.
rememberMe	boolean	optional default: false	keep user connected ?

Return:

Promise<User>

public logout(): Promise source

Logout current user

Return:

Promise

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

Params:

Name	Type	Attribute	Description
event	string		The event name (Events/Reach). Can be: USER_ADDED USER_CHANGED USER_REMOVED ROOM_ADDED ROOM_CHANGED ROOM_REMOVED INVITE_ADDED INVITE_CHANGED
callback	function		The callback for the event, the arguments depends on the type of event: USER_: callback(User u) ROOM_: callback(Room r) INVITE_*: callback(Invite i)
cancelCallback	Webcom/api.Query~cancelCallback	optional	The error callback for the event, takes an Error as only argument

public register(email: string, password: string, name: string, rememberMe: boolean): Promise<User> source

Params:

Name	Type	Attribute	Description
email	string		The email of the user
password	string		The password of the user
name	string	optional	The display name of the user (defaults to email)
rememberMe	boolean	optional default: false	keep user connected ?

Return:

Promise<User>

public resume(): Promise<User> source

Resume previous session

Return:

Promise<User>

Reach

Static Member Summary

Constructor Summary

Member Summary

Method Summary

Static Public Members

public static get audioBitrateMax: audioBitrateMax: * source

Return:

public static get browser: Browser: * source

Return:

public static get codecs: {audio: Codec/audio, video: Codec/video}: {"audio": *, "video": *} source

Return:

public static get communicationQuality: communicationQuality: * source

Return:

public static get events: { room: Events/Room, reach: Events/Reach, stream: Events/Stream, invite: Events/Invite, local: Events/Local }: {"room": *, "reach": *, "stream": *, "invite": *, "local": *} source

Return:

public static get media: Media: * source

Return:

public static get types: StreamTypes: * source

Return:

public static get version: {sdk: string, schema: string}: {"sdk": *, "schema": *} source

Return:

public static get videoBitrateMax: videoBitrateMax: * source

Return:

Public Constructors

public constructor(url: string | Webcom, cfg: Config) source

Params:

Example:

Public Members

public get base: Webcom source

public get config: Config source

public get current: User source

public get peerConnections: *: * source

Return:

Public Methods

public anonymous(name: string): Promise<User> source

Params:

Return:

public createRoom(name: string, extra: object, publicRoom: boolean): Promise<Room> source

Params:

Return:

public getRoom(uid: string): Promise<Room> source

Params:

Return:

public getUser(uid: string): Promise<User> source

Params:

Return:

public invites(): Promise<Invite[], Error> source

Return:

public login(email: string, password: string, name: string, rememberMe: boolean): Promise<User> source

Params:

Return:

public logout(): Promise source

Return:

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

Params:

public register(email: string, password: string, name: string, rememberMe: boolean): Promise<User> source

Params:

Return:

public resume(): Promise<User> source

Return:

public static get codecs: {audio: Codec/audio, video: Codec/video}: {"audio": , "video": } source

public static get events: { room: Events/Room, reach: Events/Reach, stream: Events/Stream, invite: Events/Invite, local: Events/Local }: {"room": , "reach": , "stream": , "invite": , "local": *} source

public static get version: {sdk: string, schema: string}: {"sdk": , "schema": } source

public get peerConnections: : source