Typedef

Static Public Summary
public	Browser: Object The current browser's infos
public	Codec/audio: Object Audio codec presets to use for
public	Codec/video: Object Video codec presets to use for
public	CommunicationQuality/bitrate: Object communicationQuality presets to use for
public	Events/Invite: Object The events supported by Invite#on
public	Events/Local: Object The events supported by Local#on.
public	Events/Reach: Object The events supported by Reach#on
public	Events/Room: Object The events supported by Room#on
public	Events/Stream: Object The events supported by Remote#on.
public	ICEServer: Object TURN/STUN server configuration
public	StreamTypes: Object The available stream types

Static Public

The current browser's infos

Name	Type	Attribute	Description
name	string		current browser's name
version	number	optional	current browser's version
minVersion	number	optional	current browser's minimum supported version
compatible	boolean		is current browser supported ?

Audio codec presets to use for

Name	Type	Attribute	Description
OPUS	RegExp		Opus audio codec http://opus-codec.org/. Only choice for high-quality audio.
G722	RegExp		G.722 audio codec
G711	RegExp		G.711 audio codec
ISAC	RegExp		iSAC audio codec. Good for voice data, but not suitable for high-quality audio streams.
ISAC_16	RegExp		iSAC audio codec (16kHz)
ISAC_32	RegExp		iSAC audio codec (32kHz)
ILBC	RegExp		iLBC audio codec. For bad channels & low bandwidth.
ILBC	RegExp		iLBC audio codec. For bad channels & low bandwidth.

Video codec presets to use for

Name	Type	Attribute	Description
VP8	RegExp		VP8 is the only video codec officially supported by WebRTC
VP9	RegExp		VP8's successor.
H264	RegExp		MPEG-4 part 10. Only Firefox.
VP10	RegExp		Suited for UHD video. No support yet
H265	RegExp		H.264's successor. No support yet

communicationQuality presets to use for

The events supported by Invite#on

Name	Type	Attribute	Description
ACCEPTED	string		Fired when the invite has been accepted
REJECTED	string		Fired when the invite has been accepted
CANCELED	string		Fired when the invite has been canceled

The events supported by Local#on.

Name	Type	Attribute	Description
SUBSCRIBED	string		Fired when the is subcribed by remote
WEBRTC_ERROR	string		Fired when an error is raised on webrtc call.

The events supported by Reach#on

Name	Type	Attribute	Description
USER_ADDED	string		Fired when a new user is registered
USER_CHANGED	string		Fired when an existing user logs in or out or changes is status
USER_REMOVED	string		Fired when a user is unregistered
ROOM_ADDED	string		Fired when a room is created
ROOM_CHANGED	string		Fired when a room status is changing
ROOM_REMOVED	string		Fired when a room is closed definitely
INVITE_ADDED	string		Fired when an invite is received
INVITE_CHANGED	string		Fired when an invite status is modified

The events supported by Room#on

Name	Type	Attribute	Description
PARTICIPANT_ADDED	string		Fired when a new participant is added to the room. Does not mean he's connected but that he's invited to
PARTICIPANT_CHANGED	string		Fired when a participant changes is status (enter/leaves the room)
PARTICIPANT_REMOVED	string		Fired when a user leaves definitely or is banned
MESSAGE_ADDED	string		Fired when a new instant message is sent to the room
MESSAGE_CHANGED	string		Fired when an instant message is edited
MESSAGE_REMOVED	string		Fired when an instant message is removed
STREAM_PUBLISHED	string		Fired when a participant publishes a stream
STREAM_UNPUBLISHED	string		Fired when a participant stops the publishing of his stream

The events supported by Remote#on.

Name	Type	Attribute	Description
MUTE	string		Fired when the mute status of the stream changes
SIZE	string		Fired when the size of the stream changes
WEBRTC_ERROR	string		Fired when an error is raised on webrtc call.

TURN/STUN server configuration

Name	Type	Attribute	Description
urls	string \| string[]		The server url. (stun:<ip\|hostname>:<port> or turn:<ip\|hostname>:<port?>)
username	string	optional	The user name for this server
credential	string	optional	The password for this server

The available stream types

Name	Type	Attribute	Description
AUDIO	string	default: 'audio'	Audio communication service
VIDEO	string	default: 'video'	Video communication service
AUDIO_VIDEO	string	default: 'audio-video'	Audio and video communication service
SCREEN_SHARING	string	default: 'screen-sharing'	Screen-sharing communication service