EventEmitterVoxeet is the main Object for the sdk, providing methods and events to interact with voxeet servers.\nThe SDK is asynchronous and uses promise at his core.
\nErrorGeneric error for conferences
\nError names:
\nErrorErrors on peer operations
\nError names:
\nErrorErrors happening when a stream cannot be captured from a device
\nError names:
\nBrowser specific errors
\nError names:
\nServer return by voxeet servers
\nfunctionCallback to retreive a user's audio level
\nfunctionCallback to retreive if a user is speaking
\nEventEmitter\nVoxeet is the main Object for the sdk, providing methods and events to interact with voxeet servers.\nThe SDK is asynchronous and uses promise at his core.\n\n**Kind**: global class \n**Extends**: EventEmitter \n\n* [VoxeetSdk](#VoxeetSdk) ⇐ EventEmitter\n * _instance_\n * [.userId](#VoxeetSdk+userId) : String\n * [.userToken](#VoxeetSdk+userToken) : String\n * [.initialize(consumerKey, consumerSecret, [userInfo])](#VoxeetSdk+initialize) ⇒ Promise.<(userdId\\|Error)>\n * [.initializeToken(accessToken, [userInfo], refreshTokenCb)](#VoxeetSdk+initializeToken) ⇒ Promise.<(userdId\\|Error)>\n * [.enumerateAudioDevices()](#VoxeetSdk+enumerateAudioDevices) ⇒ Promise.<(Array.<MediaDeviceInfo>\\|Error)>\n * [.enumerateVideoDevices()](#VoxeetSdk+enumerateVideoDevices) ⇒ Promise.<(Array.<MediaDeviceInfo>\\|Error)>\n * [.selectAudioInput(deviceId)](#VoxeetSdk+selectAudioInput) ⇒ Promise.<Error>\n * [.selectVideoInput(deviceId, constraints)](#VoxeetSdk+selectVideoInput) ⇒ Promise.<Error>\n * [.createDemoConference()](#VoxeetSdk+createDemoConference)\n * [.replayConference(conferenceId, offset)](#VoxeetSdk+replayConference) ⇒ Promise.<Error>\n * [.createConference([options])](#VoxeetSdk+createConference) ⇒ Promise.<(String\\|Error)>\n * [.joinConference(conferenceId, [options])](#VoxeetSdk+joinConference) ⇒ Promise.<(ConferenceInfo\\|Error)>\n * [.leaveConference()](#VoxeetSdk+leaveConference) ⇒ Promise.<Error>\n * [.invite(conferenceId, externalIds)](#VoxeetSdk+invite)\n * [.subscribeConferenceStatus(conferenceId)](#VoxeetSdk+subscribeConferenceStatus) ⇒ Promise.<Error>\n * [.unsubscribeConferenceStatus(conferenceId)](#VoxeetSdk+unsubscribeConferenceStatus) ⇒ Promise.<Error>\n * [.sendConferenceMessage(message)](#VoxeetSdk+sendConferenceMessage) ⇒ Promise.<Error>\n * [.setUserPosition(userId, x, y)](#VoxeetSdk+setUserPosition)\n * [.muteUser(userId, isMuted)](#VoxeetSdk+muteUser)\n * [.toggleMute(userId)](#VoxeetSdk+toggleMute) ⇒ Boolean\n * [.getUserLevel(userId, callback)](#VoxeetSdk+getUserLevel)\n * [.isUserSpeaking(userId, callback)](#VoxeetSdk+isUserSpeaking)\n * [.startVideoForUser(userId, constraints)](#VoxeetSdk+startVideoForUser) ⇒ Promise.<Error>\n * [.stopVideoForUser(userId)](#VoxeetSdk+stopVideoForUser) ⇒ Promise.<Error>\n * [.startAudioForUser(userId)](#VoxeetSdk+startAudioForUser) ⇒ Promise.<Error>\n * [.stopAudioForUser(userId)](#VoxeetSdk+stopAudioForUser) ⇒ Promise.<Error>\n * [.startScreenShare(options)](#VoxeetSdk+startScreenShare) ⇒ Promise.<Error>\n * [.startRecording()](#VoxeetSdk+startRecording) ⇒ Promise.<Error>\n * [.stopRecording()](#VoxeetSdk+stopRecording) ⇒ Promise.<Error>\n * [.stopScreenShare()](#VoxeetSdk+stopScreenShare) ⇒ Promise.<Error>\n * [.setMode(mode)](#VoxeetSdk+setMode) ⇒ Promise.<Error>\n * [.reserve(conferenceId)](#VoxeetSdk+reserve) ⇒ Promise.<Error>\n * [.stats(conferenceId)](#VoxeetSdk+stats) ⇒ Promise.<(Stats\\|Error)>\n * [.convertFile(file)](#VoxeetSdk+convertFile) ⇒ Promise.<Error>\n * [.startFilePresentation(config)](#VoxeetSdk+startFilePresentation) ⇒ Promise.<Error>\n * [.updateFilePresentation(fileId, position)](#VoxeetSdk+updateFilePresentation) ⇒ Promise.<Error>\n * [.stopFilePresentation(fileId)](#VoxeetSdk+stopFilePresentation) ⇒ Promise.<Error>\n * [.getThumbnail(fileId, page)](#VoxeetSdk+getThumbnail) ⇒ Promise.<String>\n * [.getImage(fileId, page)](#VoxeetSdk+getImage) ⇒ Promise.<String>\n * [\"conferenceJoined\"](#VoxeetSdk+event_conferenceJoined)\n * [\"conferenceLeft\"](#VoxeetSdk+event_conferenceLeft)\n * [\"conferenceEnded\"](#VoxeetSdk+event_conferenceEnded)\n * [\"conferenceStatusUpdated\" (conferenceInfo)](#VoxeetSdk+event_conferenceStatusUpdated)\n * [\"participantAdded\" (userId, userInfo)](#VoxeetSdk+event_participantAdded)\n * [\"participantStatusUpdated\" (userId, status)](#VoxeetSdk+event_participantStatusUpdated)\n * [\"participantJoined\" (userId, stream)](#VoxeetSdk+event_participantJoined)\n * [\"participantUpdated\" (userId, stream)](#VoxeetSdk+event_participantUpdated)\n * [\"participantLeft\" (userId)](#VoxeetSdk+event_participantLeft)\n * [\"messageReceived\" (data)](#VoxeetSdk+event_messageReceived)\n * [\"screenShareStarted\" (userId, stream)](#VoxeetSdk+event_screenShareStarted)\n * [\"screenShareUpdated\" (userId, stream)](#VoxeetSdk+event_screenShareUpdated)\n * [\"screenShareStopped\"](#VoxeetSdk+event_screenShareStopped)\n * [\"qualityIndicators\" (indicators, mos)](#VoxeetSdk+event_qualityIndicators)\n * [\"speakerChanged\"](#VoxeetSdk+event_speakerChanged)\n * [\"renegociationEnded\"](#VoxeetSdk+event_renegociationEnded)\n * [\"error\"](#VoxeetSdk+event_error)\n * [\"fileConverted\" ([file])](#VoxeetSdk+event_fileConverted)\n * [\"filePresentationStarted\" ([file])](#VoxeetSdk+event_filePresentationStarted)\n * [\"filePresentationUpdated\" ([file])](#VoxeetSdk+event_filePresentationUpdated)\n * [\"filePresentationStopped\"](#VoxeetSdk+event_filePresentationStopped)\n * [\"invitationReceived\" (data)](#VoxeetSdk+event_invitationReceived)\n * _static_\n * [.ScreenShareOptions](#VoxeetSdk.ScreenShareOptions) : enum\n\n\n\n### voxeetSdk.userId : String\nThe current user id\n\n**Kind**: instance property of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.userToken : String\nThe current user token\n\n**Kind**: instance property of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.initialize(consumerKey, consumerSecret, [userInfo]) ⇒ Promise.<(userdId\\|Error)>\nOpens a session to Voxeet server (websocket included)\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Async**: \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| consumerKey | String | | The consumer key |\n| consumerSecret | String | | The consumer Secret |\n| [userInfo] | Object | {} | A Json object containing custom user informations |\n| [userInfo.name] | String | | A Name for the user |\n| [userInfo.externalId] | String | | An externalId for the user |\n| [userInfo.avatarUrl] | String | | An avatar url for the user |\n\n**Example** \n```js\nvar voxeet = new VoxeetSdk();\nvoxeet.initialize('ConsumerKey', 'ConsumerSecret', {name: 'John Doe'})\n .then((myUserId) => {\n // VoxeetSdk is now initialized, you can create/join a conference\n })\n .catch((error) => {\n // An Error has occured, see Error Types\n });\n```\n\n\n### voxeetSdk.initializeToken(accessToken, [userInfo], refreshTokenCb) ⇒ Promise.<(userdId\\|Error)>\nOpens a session to Voxeet server (websocket included)\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Async**: \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| accessToken | String | | An access token retreived from the customer server |\n| [userInfo] | Object | {} | A Json object containing custom user informations |\n| [userInfo.name] | String | | A Name for the user |\n| [userInfo.externalId] | String | | An externalId for the user |\n| [userInfo.avatarUrl] | String | | An avatar url for the user |\n| refreshTokenCb | function | | A function called to refresh the access token, must return a Promise |\n\n**Example** \n```js\nvoxeet.initializeToken(\"accessToken\", {name: \"John Doe\"}, () => {\n return Promise.resolve(\"Refresh accessed Token\");\n})\n.then((myUserId) => {\n\n})\n.catch((error) => {\n\n});\n```\n\n\n### voxeetSdk.enumerateAudioDevices() ⇒ Promise.<(Array.<MediaDeviceInfo>\\|Error)>\nEnumerates all audio input devices on the computer, allowing you to further change it\nwhile in conference.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Example** \n```js\nvoxeet.enumerateAudioDevices()\n .then((devices) => {\n console.log(devices) // Will output [{label: \"device1\", ...}, {label: \"device2\", ...}]\n });\n```\n\n\n### voxeetSdk.enumerateVideoDevices() ⇒ Promise.<(Array.<MediaDeviceInfo>\\|Error)>\nEnumerates all video input devices on the computer, allowing you to further change it\nwhile in conference.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Example** \n```js\nvoxeet.enumerateVideoDevices()\n .then((devices) => {\n console.log(devices) // Will output [{label: \"device1\", ...}, {label: \"device2\", ...}]\n });\n```\n\n\n### voxeetSdk.selectAudioInput(deviceId) ⇒ Promise.<Error>\nAllows to select an audio device input while in conference.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| deviceId | String | The select device id (provided with [enumerateAudioDevices](#VoxeetSdk+enumerateAudioDevices)) |\n\n\n\n### voxeetSdk.selectVideoInput(deviceId, constraints) ⇒ Promise.<Error>\nAllows to select a video device input while in conference.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| deviceId | String | The select device id (provided with [enumerateVideoDevices](#VoxeetSdk+enumerateVideoDevices)) |\n| constraints | Object | Webrtc Video constraints |\n\n**Example** \n```js\nconst video = {\n mandatory: {\n minWidth: 160,\n minHeight: 120,\n maxWidth: 320,\n maxHeight: 240,\n minFrameRate: 10,\n maxFrameRate: 30,\n }\n};\n\nvoxeet.selectVideoInput(deviceId, constraints)\n .then(() => {\n\n });\n```\n\n\n### voxeetSdk.createDemoConference()\nCreates a conference demo.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.replayConference(conferenceId, offset) ⇒ Promise.<Error>\nReplays a previously recorded conference.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| conferenceId | UUID | | The conference id returned when joining a conference |\n| offset | Number | 0 | Replays the conference from this offset in milliseconds |\n\n\n\n### voxeetSdk.createConference([options]) ⇒ Promise.<(String\\|Error)>\nCreates a conference. If conferenceAlias is empty, an id will be generated. \n\nIf the conference already exists, the current conference id is returned.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Returns**: Promise.<(String\\|Error)> - The corresponding conference id \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [options] | object | {} | Information of the conference to be created |\n| [options.alias] | string | "\\"\\"" | An alias for the conference or empty |\n| [options.params] | object | {} | Parameters for this conference |\n| [options.params.ttl] | boolean | 0 | The conference time to live in seconds, default to 0 |\n| [options.params.rtcpMode] | string | "\\"worst\\"" | The conference RTC Mode (best/worst) for quality control |\n| [options.params.mode] | string | "\\"standard\\"" | The conference mode (push/standard) |\n| [options.params.videoCodec] | string | "\\"VP8\\"" | The conference video codec (VP8/H264) |\n\n\n\n### voxeetSdk.joinConference(conferenceId, [options]) ⇒ Promise.<(ConferenceInfo\\|Error)>\nJoins a conference. If the conference doesn't exist, it will be created\n\nNote that if you used createConference beforehand, the conference params in the following object\nare ignored.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| conferenceId | string | | The conference id or alias to be joined |\n| [options] | object | {} | Options for the conference |\n| [options.constraints] | object | {audio: true, video: true} | WebRTC constraints |\n| [options.audio3D] | boolean | true | Activate/Deactivate 3D audio |\n| [options.user] | object | {} | User options |\n| [options.user.name] | string | | The user name |\n| [options.user.type] | string | "\\"user\\"" | The user type |\n| [options.conference] | object | {} | The conference options |\n| [options.conference.params] | object | {} | Parameters for this conference |\n| [options.conference.params.ttl] | boolean | 0 | The conference time to live in seconds, default to 0 |\n| [options.conference.params.rtcpMode] | string | "\\"worst\\"" | The conference RTC Mode (best/worst) for quality control |\n| [options.conference.params.mode] | string | "\\"standard\\"" | The conference mode (push/standard) |\n| [options.conference.params.videoCodec] | string | "\\"VP8\\"" | The conference video codec (VP8/H264) |\n\n**Example** \n```js\n// For example\nvar constraints = {\n audio: {\n mandatory: {\n sourceId: \"audioDeviceId\" // If you want to specifie an audio deviceId\n }\n },\n video: {\n mandatory: {\n minWidth: 160,\n minHeight: 120,\n maxWidth: 320,\n maxHeight: 240,\n minFrameRate: 10,\n maxFrameRate: 30\n sourceId: \"videoDeviceId\" // If you want to specifie an video deviceId\n }\n }\n};\n\nA simplest example of constraints would be: \n\nvar constraints = {audio: true, video: true};\n\nvoxeet.joinConference(conferenceId, {constraints: constraints})\n .then((info) => {\n\n })\n .catch((error) => {\n\n });\n```\n\n\n### voxeetSdk.leaveConference() ⇒ Promise.<Error>\nLeaves the currently running conference\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.invite(conferenceId, externalIds)\nAllows to invite users in a conference, they will receive the invitationReceived event\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| conferenceId | String | The corresponding conferenceId or Alias |\n| externalIds | Array | An array of external ids to be invited |\n\n\n\n### voxeetSdk.subscribeConferenceStatus(conferenceId) ⇒ Promise.<Error>\nSubscribe to receive updates on the conference status.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| conferenceId | String | The conference id or alias |\n\n\n\n### voxeetSdk.unsubscribeConferenceStatus(conferenceId) ⇒ Promise.<Error>\nUnsubscribe to the conference status event.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| conferenceId | String | The conference id or alias |\n\n\n\n### voxeetSdk.sendConferenceMessage(message) ⇒ Promise.<Error>\nAllows you to broadcast raw messages of any type (Json, Xml, simple string) to all participants of a conference\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| message | String | The message to be send as a raw string (can be json, xml, ...) |\n\n\n\n### voxeetSdk.setUserPosition(userId, x, y)\nSets the user position\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user to be moved |\n| x | Float | The user's x position, between -1.0 and 1.0 |\n| y | Float | The user's y position, between 0.0 and 1.0 |\n\n\n\n### voxeetSdk.muteUser(userId, isMuted)\nAllows to mute a user\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id to be muted |\n| isMuted | boolean | Mute On/Off |\n\n\n\n### voxeetSdk.toggleMute(userId) ⇒ Boolean\nAllows to toggle mute on a user\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Returns**: Boolean - State of the user \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id to be muted |\n\n\n\n### voxeetSdk.getUserLevel(userId, callback)\nAllows to get the user's current audio level normalized between 0.0 and 1.0\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | userId | The user's id of the level to be retreived |\n| callback | [getUserLevelCallback](#getUserLevelCallback) | The callback to retreive the audio level |\n\n\n\n### voxeetSdk.isUserSpeaking(userId, callback)\nAllows to get the user's current speech status\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | userId | The user's id of the status to be retreived |\n| callback | [isUserSpeakingCallback](#isUserSpeakingCallback) | The callback to retreive the status |\n\n\n\n### voxeetSdk.startVideoForUser(userId, constraints) ⇒ Promise.<Error>\nStarts the video stream for a user\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | userId | |\n| constraints | Object | Webrtc Video contraints |\n\n**Example** \n```js\nconst video = {\n mandatory: {\n minWidth: 160,\n minHeight: 120,\n maxWidth: 320,\n maxHeight: 240,\n minFrameRate: 10,\n maxFrameRate: 30,\n }\n};\n\nvoxeet.startVideoForUser(userId, constraints)\n .then(() => {\n\n });\n```\n\n\n### voxeetSdk.stopVideoForUser(userId) ⇒ Promise.<Error>\nStops the video stream for a user\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type |\n| --- | --- |\n| userId | userId | \n\n\n\n### voxeetSdk.startAudioForUser(userId) ⇒ Promise.<Error>\nStarts the audio stream for a user\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type |\n| --- | --- |\n| userId | userId | \n\n\n\n### voxeetSdk.stopAudioForUser(userId) ⇒ Promise.<Error>\nStops the audio stream for a user\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type |\n| --- | --- |\n| userId | userId | \n\n\n\n### voxeetSdk.startScreenShare(options) ⇒ Promise.<Error>\nStarts a screen sharing session\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Returns**: Promise.<Error> - VoxeetSdk.ScreenShareOptions is an enum containing different possibilities for those options :\n- VoxeetSdk.ScreenShareOptions.SCREEN\n- VoxeetSdk.ScreenShareOptions.WINDOW_AND_TAB\n- VoxeetSdk.ScreenShareOptions.ALL\n\nYou can also use a simple array with string value, like: ['screen', 'tab']\n\nNote that on Firefox, the array can't contain more than one value. \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| options | Array | ['screen' | An optional array to choose what type of capture options will presented to the user. |\n\n**Example** \n```js\nvoxeet.startScreenShare(['screen'])\n .then(() => {\n\n })\n .catch(e => {\n\n });\n```\n\n\n### voxeetSdk.startRecording() ⇒ Promise.<Error>\nStarts the current conference recording\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.stopRecording() ⇒ Promise.<Error>\nStops the current recording\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.stopScreenShare() ⇒ Promise.<Error>\nStops the screen sharing session\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.setMode(mode) ⇒ Promise.<Error>\nSets the mode of the conference: \n\nmode can be: \n - STANDARD\n - PUSH\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| mode | String | The mode to be set |\n\n\n\n### voxeetSdk.reserve(conferenceId) ⇒ Promise.<Error>\nReserves a slot in the corresponding conference\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| conferenceId | String | The conference id or alias |\n\n\n\n### voxeetSdk.stats(conferenceId) ⇒ Promise.<(Stats\\|Error)>\nReturns the stats for a specific conference.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| conferenceId | String | The conference Id |\n\n\n\n### voxeetSdk.convertFile(file) ⇒ Promise.<Error>\nAllows to convert a file selected throught an input file box. A `fileConverted` event will be fired\nwhen the file is ready\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| file | String | The file to convert |\n\n**Example** \n```js\nvoxeet.on('fileConverted' (file) => {\n\n});\n\nvoxeet.convertFile(...)\n .catch(e => error(e));\n```\n\n\n### voxeetSdk.startFilePresentation(config) ⇒ Promise.<Error>\nStarts a file presentation\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| config | Object | The json object received from `fileConverted` event containing the fileId |\n| config.fileId | String | The fileId of the converted file |\n| [config.fileName] | String | The fileName of the converted file |\n| config.imageCount | String | The number of images of the converted file |\n\n**Example** \n```js\nvoxeet.startFilePresentation({fileId: 'fileId'})\n .catch(e => error(e));\n```\n\n\n### voxeetSdk.updateFilePresentation(fileId, position) ⇒ Promise.<Error>\nUpdates the current file presentation page\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fileId | String | The corresponding fileId |\n| position | Integer | The page to present |\n\n\n\n### voxeetSdk.stopFilePresentation(fileId) ⇒ Promise.<Error>\nStops the current file presentation\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fileId | String | The Corresponding fileId |\n\n\n\n### voxeetSdk.getThumbnail(fileId, page) ⇒ Promise.<String>\nAllows to get a thumbnail for a page file\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Returns**: Promise.<String> - - The url of the thumbnail \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fileId | String | The corresponding fileId |\n| page | Integer | The page number to be retreived |\n\n\n\n### voxeetSdk.getImage(fileId, page) ⇒ Promise.<String>\nAllows to get an image for a page file\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Returns**: Promise.<String> - - The url of the image \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fileId | String | The corresponding fileId |\n| page | Integer | The page number to be retreived |\n\n\n\n### \"conferenceJoined\"\nEmitted when the conference has been successfully joined\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"conferenceLeft\"\nEmitted when the conference has been successfully left\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"conferenceEnded\"\nEmitted when the replayed conference has ended\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"conferenceStatusUpdated\" (conferenceInfo)\nEmitted when a conference status is received\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| conferenceInfo | Object | A Json object containing conference informations |\n| [conferenceInfo.conferenceAlias] | String | The conference alias |\n| [conferenceInfo.conferenceId] | String | The conference id |\n| [conferenceInfo.isLive] | boolean | The conference status |\n\n\n\n### \"participantAdded\" (userId, userInfo)\nEmitted when a participant (user) has been added to the conference\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id |\n| userInfo | Object | A Json object containing custom user informations |\n| [userInfo.name] | String | A Name for the user |\n| [userInfo.externalId] | String | An externalId for the user |\n| [userInfo.avatarUrl] | String | An avatar url for the user |\n\n\n\n### \"participantStatusUpdated\" (userId, status)\nEmitted when the status of a participant has changed\n\nStatus can be one if those values:\n- Reserved\n- Decline\n- Connecting\n- Connected\n- Inactive\n- Left\n- Warning\n- Error\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id |\n| status | String | The corresponding status |\n\n\n\n### \"participantJoined\" (userId, stream)\nEmitted when the participant has joined the conference\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id |\n| stream | MediaStream | The webrtc stream correponding to this participant |\n\n\n\n### \"participantUpdated\" (userId, stream)\nEmitted when a participant (user) stream has been updated\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id |\n| stream | MediaStream | The webrtc stream correponding to this participant |\n\n\n\n### \"participantLeft\" (userId)\nEmitted when a participant has left the conference\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id |\n\n\n\n### \"messageReceived\" (data)\nEmitted when a broadcast message is received\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| data | String | the received message |\n\n\n\n### \"screenShareStarted\" (userId, stream)\nEmitted when a screen share has been started\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id that started the screensharing |\n| stream | MediaStream | The screenshare stream |\n\n\n\n### \"screenShareUpdated\" (userId, stream)\nEmitted when the stream of the screen share has changed\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id that started the screensharing |\n| stream | MediaStream | The new screenshare stream |\n\n\n\n### \"screenShareStopped\"\nEmitted when a screen share has been stopped\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"qualityIndicators\" (indicators, mos)\nEmitted when a new quality indicator is available\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| indicators | object | Call quality indicators |\n| mos | Integer | The Mean Opinion Score, a value from 1 to 5 indicating the average call quality |\n\n\n\n### \"speakerChanged\"\nEmitted when the user that is speaking has changed.\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"renegociationEnded\"\nEmitted when all peers (local and remote ones) have been successfully renegociated\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"error\"\nEmitted when an error occured during a conference\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"fileConverted\" ([file])\nEmitted when a file has been converted\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| [file] | Object | A Json Object describing the converted file |\n| [file.fileId] | String | The fileId of the presentation |\n| [file.imageCount] | String | The number of page in this presentation |\n\n\n\n### \"filePresentationStarted\" ([file])\nEmitted when a file presentation has started\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| [file] | Object | A Json Object containing file presentation information |\n| [file.conferenceId] | String | The conferenceId of the presentation |\n| [file.fileId] | String | The fileId of the presentation |\n| [file.userId] | String | The userId that has started the presentation |\n| [file.position] | String | The current page of the presentation |\n| [file.imageCount] | String | The number of page in this presentation |\n\n\n\n### \"filePresentationUpdated\" ([file])\nEmitted when the file presentation has been updated (page changed)\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| [file] | Object | A Json Object containing file presentation information |\n| [file.conferenceId] | String | The conferenceId of the presentation |\n| [file.fileId] | String | The fileId of the presentation |\n| [file.userId] | String | The userId that has started the presentation |\n| [file.position] | String | The current page of the presentation |\n\n\n\n### \"filePresentationStopped\"\nEmitted when the file presentation has been stopped\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"invitationReceived\" (data)\nEmitted when an invitation is received.\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| data | Object | Informations about the conference invitation |\n\n\n\n### VoxeetSdk.ScreenShareOptions : enum\nEnum for screen sharing options\n\n**Kind**: static enum of [VoxeetSdk](#VoxeetSdk) \n**Read only**: true \n\n\n## ConferenceError ⇐ Error\nGeneric error for conferences\n\nError names:\n - UninitializedError - The conference isn't initialized yet.\n\n**Kind**: global class \n**Extends**: Error \n\n\n## PeerError ⇐ Error\nErrors on peer operations\n\nError names:\n - PeerNotFoundError - The peer could not be found for this operation.\n - RemoteDescriptionError - Failed to set remote description.\n - CreateAnswerError - Failed to create answer.\n - ConnectionFailedError - The peer connection failed to connect. (Only send for your own peer connection)\n - DisconnectedError - The peer connection has been disconnected. (Only send for your own peer connection)\n\n**Kind**: global class \n**Extends**: Error \n\n\n## MediaStreamError ⇐ Error\nErrors happening when a stream cannot be captured from a device\n\nError names:\n - NotSupportedError - The operation is not supported.\n - PermissionDeniedError - The user did not grant permission for the operation.\n - ConstraintNotSatisfiedError - One of the mandatory constraints could not be satisfied.\n - NotFoundError - The object can not be found.\n - AbortError - The operatoin was aborted\n - SourceUnavailableError - The source of the MediaStream could not be accessed dure to a hardware error.\n\n**Kind**: global class \n**Extends**: Error \n\n\n## BrowserError\nBrowser specific errors\n\nError names:\n - NotSupportedError - Operation not supported on this browser\n\n**Kind**: global class \n\n\n## ServerError\nServer return by voxeet servers\n\n- code : The specific error code, HTTP ones\n- reason : The error reason\n- description; the error long description\n\n**Kind**: global class \n\n\n## getUserLevelCallback : function\nCallback to retreive a user's audio level\n\n**Kind**: global typedef \n\n| Param | Type | Description |\n| --- | --- | --- |\n| level | float | the user's current audio level normalized between 0.0 and 1.0 |\n\n\n\n## isUserSpeakingCallback : function\nCallback to retreive if a user is speaking\n\n**Kind**: global typedef \n\n| Param | Type | Description |\n| --- | --- | --- |\n| isSpeaking | Boolean | The state of the user |\n\n\n# Sample Application\n\nA sample application is available on this [public repository][sample] on GitHub.\n\n [sample]: EventEmitterVoxeet is the main Object for the sdk, providing methods and events to interact with voxeet servers.\nThe SDK is asynchronous and uses promise at his core.
\nErrorGeneric error for conferences
\nError names:
\nErrorErrors on peer operations
\nError names:
\nErrorErrors happening when a stream cannot be captured from a device
\nError names:
\nBrowser specific errors
\nError names:
\nServer return by voxeet servers
\nfunctionCallback to retreive a user's audio level
\nfunctionCallback to retreive if a user is speaking
\nEventEmitter\nVoxeet is the main Object for the sdk, providing methods and events to interact with voxeet servers.\nThe SDK is asynchronous and uses promise at his core.\n\n**Kind**: global class \n**Extends**: EventEmitter \n\n* [VoxeetSdk](#VoxeetSdk) ⇐ EventEmitter\n * _instance_\n * [.userId](#VoxeetSdk+userId) : String\n * [.userToken](#VoxeetSdk+userToken) : String\n * [.initialize(consumerKey, consumerSecret, [userInfo])](#VoxeetSdk+initialize) ⇒ Promise.<(userdId\\|Error)>\n * [.initializeToken(accessToken, [userInfo], refreshTokenCb)](#VoxeetSdk+initializeToken) ⇒ Promise.<(userdId\\|Error)>\n * [.enumerateAudioDevices()](#VoxeetSdk+enumerateAudioDevices) ⇒ Promise.<(Array.<MediaDeviceInfo>\\|Error)>\n * [.enumerateVideoDevices()](#VoxeetSdk+enumerateVideoDevices) ⇒ Promise.<(Array.<MediaDeviceInfo>\\|Error)>\n * [.selectAudioInput(deviceId)](#VoxeetSdk+selectAudioInput) ⇒ Promise.<Error>\n * [.selectVideoInput(deviceId, constraints)](#VoxeetSdk+selectVideoInput) ⇒ Promise.<Error>\n * [.createDemoConference()](#VoxeetSdk+createDemoConference)\n * [.replayConference(conferenceId, offset)](#VoxeetSdk+replayConference) ⇒ Promise.<Error>\n * [.createConference([options])](#VoxeetSdk+createConference) ⇒ Promise.<(String\\|Error)>\n * [.joinConference(conferenceId, [options])](#VoxeetSdk+joinConference) ⇒ Promise.<(ConferenceInfo\\|Error)>\n * [.leaveConference()](#VoxeetSdk+leaveConference) ⇒ Promise.<Error>\n * [.invite(conferenceId, externalIds)](#VoxeetSdk+invite)\n * [.subscribeConferenceStatus(conferenceId)](#VoxeetSdk+subscribeConferenceStatus) ⇒ Promise.<Error>\n * [.unsubscribeConferenceStatus(conferenceId)](#VoxeetSdk+unsubscribeConferenceStatus) ⇒ Promise.<Error>\n * [.sendConferenceMessage(message)](#VoxeetSdk+sendConferenceMessage) ⇒ Promise.<Error>\n * [.setUserPosition(userId, x, y)](#VoxeetSdk+setUserPosition)\n * [.muteUser(userId, isMuted)](#VoxeetSdk+muteUser)\n * [.toggleMute(userId)](#VoxeetSdk+toggleMute) ⇒ Boolean\n * [.getUserLevel(userId, callback)](#VoxeetSdk+getUserLevel)\n * [.isUserSpeaking(userId, callback)](#VoxeetSdk+isUserSpeaking)\n * [.startVideoForUser(userId, constraints)](#VoxeetSdk+startVideoForUser) ⇒ Promise.<Error>\n * [.stopVideoForUser(userId)](#VoxeetSdk+stopVideoForUser) ⇒ Promise.<Error>\n * [.startAudioForUser(userId)](#VoxeetSdk+startAudioForUser) ⇒ Promise.<Error>\n * [.stopAudioForUser(userId)](#VoxeetSdk+stopAudioForUser) ⇒ Promise.<Error>\n * [.startScreenShare(options)](#VoxeetSdk+startScreenShare) ⇒ Promise.<Error>\n * [.startRecording()](#VoxeetSdk+startRecording) ⇒ Promise.<Error>\n * [.stopRecording()](#VoxeetSdk+stopRecording) ⇒ Promise.<Error>\n * [.stopScreenShare()](#VoxeetSdk+stopScreenShare) ⇒ Promise.<Error>\n * [.setMode(mode)](#VoxeetSdk+setMode) ⇒ Promise.<Error>\n * [.reserve(conferenceId)](#VoxeetSdk+reserve) ⇒ Promise.<Error>\n * [.stats(conferenceId)](#VoxeetSdk+stats) ⇒ Promise.<(Stats\\|Error)>\n * [.convertFile(file)](#VoxeetSdk+convertFile) ⇒ Promise.<Error>\n * [.startFilePresentation(config)](#VoxeetSdk+startFilePresentation) ⇒ Promise.<Error>\n * [.updateFilePresentation(fileId, position)](#VoxeetSdk+updateFilePresentation) ⇒ Promise.<Error>\n * [.stopFilePresentation(fileId)](#VoxeetSdk+stopFilePresentation) ⇒ Promise.<Error>\n * [.getThumbnail(fileId, page)](#VoxeetSdk+getThumbnail) ⇒ Promise.<String>\n * [.getImage(fileId, page)](#VoxeetSdk+getImage) ⇒ Promise.<String>\n * [\"conferenceJoined\"](#VoxeetSdk+event_conferenceJoined)\n * [\"conferenceLeft\"](#VoxeetSdk+event_conferenceLeft)\n * [\"conferenceEnded\"](#VoxeetSdk+event_conferenceEnded)\n * [\"conferenceStatusUpdated\" (conferenceInfo)](#VoxeetSdk+event_conferenceStatusUpdated)\n * [\"participantAdded\" (userId, userInfo)](#VoxeetSdk+event_participantAdded)\n * [\"participantStatusUpdated\" (userId, status)](#VoxeetSdk+event_participantStatusUpdated)\n * [\"participantJoined\" (userId, stream)](#VoxeetSdk+event_participantJoined)\n * [\"participantUpdated\" (userId, stream)](#VoxeetSdk+event_participantUpdated)\n * [\"participantLeft\" (userId)](#VoxeetSdk+event_participantLeft)\n * [\"messageReceived\" (data)](#VoxeetSdk+event_messageReceived)\n * [\"screenShareStarted\" (userId, stream)](#VoxeetSdk+event_screenShareStarted)\n * [\"screenShareUpdated\" (userId, stream)](#VoxeetSdk+event_screenShareUpdated)\n * [\"screenShareStopped\"](#VoxeetSdk+event_screenShareStopped)\n * [\"qualityIndicators\" (indicators, mos)](#VoxeetSdk+event_qualityIndicators)\n * [\"speakerChanged\"](#VoxeetSdk+event_speakerChanged)\n * [\"renegociationEnded\"](#VoxeetSdk+event_renegociationEnded)\n * [\"error\"](#VoxeetSdk+event_error)\n * [\"fileConverted\" ([file])](#VoxeetSdk+event_fileConverted)\n * [\"filePresentationStarted\" ([file])](#VoxeetSdk+event_filePresentationStarted)\n * [\"filePresentationUpdated\" ([file])](#VoxeetSdk+event_filePresentationUpdated)\n * [\"filePresentationStopped\"](#VoxeetSdk+event_filePresentationStopped)\n * [\"invitationReceived\" (data)](#VoxeetSdk+event_invitationReceived)\n * _static_\n * [.ScreenShareOptions](#VoxeetSdk.ScreenShareOptions) : enum\n\n\n\n### voxeetSdk.userId : String\nThe current user id\n\n**Kind**: instance property of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.userToken : String\nThe current user token\n\n**Kind**: instance property of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.initialize(consumerKey, consumerSecret, [userInfo]) ⇒ Promise.<(userdId\\|Error)>\nOpens a session to Voxeet server (websocket included)\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Async**: \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| consumerKey | String | | The consumer key |\n| consumerSecret | String | | The consumer Secret |\n| [userInfo] | Object | {} | A Json object containing custom user informations |\n| [userInfo.name] | String | | A Name for the user |\n| [userInfo.externalId] | String | | An externalId for the user |\n| [userInfo.avatarUrl] | String | | An avatar url for the user |\n\n**Example** \n```js\nvar voxeet = new VoxeetSdk();\nvoxeet.initialize('ConsumerKey', 'ConsumerSecret', {name: 'John Doe'})\n .then((myUserId) => {\n // VoxeetSdk is now initialized, you can create/join a conference\n })\n .catch((error) => {\n // An Error has occured, see Error Types\n });\n```\n\n\n### voxeetSdk.initializeToken(accessToken, [userInfo], refreshTokenCb) ⇒ Promise.<(userdId\\|Error)>\nOpens a session to Voxeet server (websocket included)\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Async**: \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| accessToken | String | | An access token retreived from the customer server |\n| [userInfo] | Object | {} | A Json object containing custom user informations |\n| [userInfo.name] | String | | A Name for the user |\n| [userInfo.externalId] | String | | An externalId for the user |\n| [userInfo.avatarUrl] | String | | An avatar url for the user |\n| refreshTokenCb | function | | A function called to refresh the access token, must return a Promise |\n\n**Example** \n```js\nvoxeet.initializeToken(\"accessToken\", {name: \"John Doe\"}, () => {\n return Promise.resolve(\"Refresh accessed Token\");\n})\n.then((myUserId) => {\n\n})\n.catch((error) => {\n\n});\n```\n\n\n### voxeetSdk.enumerateAudioDevices() ⇒ Promise.<(Array.<MediaDeviceInfo>\\|Error)>\nEnumerates all audio input devices on the computer, allowing you to further change it\nwhile in conference.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Example** \n```js\nvoxeet.enumerateAudioDevices()\n .then((devices) => {\n console.log(devices) // Will output [{label: \"device1\", ...}, {label: \"device2\", ...}]\n });\n```\n\n\n### voxeetSdk.enumerateVideoDevices() ⇒ Promise.<(Array.<MediaDeviceInfo>\\|Error)>\nEnumerates all video input devices on the computer, allowing you to further change it\nwhile in conference.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Example** \n```js\nvoxeet.enumerateVideoDevices()\n .then((devices) => {\n console.log(devices) // Will output [{label: \"device1\", ...}, {label: \"device2\", ...}]\n });\n```\n\n\n### voxeetSdk.selectAudioInput(deviceId) ⇒ Promise.<Error>\nAllows to select an audio device input while in conference.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| deviceId | String | The select device id (provided with [enumerateAudioDevices](#VoxeetSdk+enumerateAudioDevices)) |\n\n\n\n### voxeetSdk.selectVideoInput(deviceId, constraints) ⇒ Promise.<Error>\nAllows to select a video device input while in conference.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| deviceId | String | The select device id (provided with [enumerateVideoDevices](#VoxeetSdk+enumerateVideoDevices)) |\n| constraints | Object | Webrtc Video constraints |\n\n**Example** \n```js\nconst video = {\n mandatory: {\n minWidth: 160,\n minHeight: 120,\n maxWidth: 320,\n maxHeight: 240,\n minFrameRate: 10,\n maxFrameRate: 30,\n }\n};\n\nvoxeet.selectVideoInput(deviceId, constraints)\n .then(() => {\n\n });\n```\n\n\n### voxeetSdk.createDemoConference()\nCreates a conference demo.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.replayConference(conferenceId, offset) ⇒ Promise.<Error>\nReplays a previously recorded conference.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| conferenceId | UUID | | The conference id returned when joining a conference |\n| offset | Number | 0 | Replays the conference from this offset in milliseconds |\n\n\n\n### voxeetSdk.createConference([options]) ⇒ Promise.<(String\\|Error)>\nCreates a conference. If conferenceAlias is empty, an id will be generated. \n\nIf the conference already exists, the current conference id is returned.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Returns**: Promise.<(String\\|Error)> - The corresponding conference id \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [options] | object | {} | Information of the conference to be created |\n| [options.alias] | string | "\\"\\"" | An alias for the conference or empty |\n| [options.params] | object | {} | Parameters for this conference |\n| [options.params.ttl] | boolean | 0 | The conference time to live in seconds, default to 0 |\n| [options.params.rtcpMode] | string | "\\"worst\\"" | The conference RTC Mode (best/worst) for quality control |\n| [options.params.mode] | string | "\\"standard\\"" | The conference mode (push/standard) |\n| [options.params.videoCodec] | string | "\\"VP8\\"" | The conference video codec (VP8/H264) |\n\n\n\n### voxeetSdk.joinConference(conferenceId, [options]) ⇒ Promise.<(ConferenceInfo\\|Error)>\nJoins a conference. If the conference doesn't exist, it will be created\n\nNote that if you used createConference beforehand, the conference params in the following object\nare ignored.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| conferenceId | string | | The conference id or alias to be joined |\n| [options] | object | {} | Options for the conference |\n| [options.constraints] | object | {audio: true, video: true} | WebRTC constraints |\n| [options.audio3D] | boolean | true | Activate/Deactivate 3D audio |\n| [options.user] | object | {} | User options |\n| [options.user.name] | string | | The user name |\n| [options.user.type] | string | "\\"user\\"" | The user type |\n| [options.conference] | object | {} | The conference options |\n| [options.conference.params] | object | {} | Parameters for this conference |\n| [options.conference.params.ttl] | boolean | 0 | The conference time to live in seconds, default to 0 |\n| [options.conference.params.rtcpMode] | string | "\\"worst\\"" | The conference RTC Mode (best/worst) for quality control |\n| [options.conference.params.mode] | string | "\\"standard\\"" | The conference mode (push/standard) |\n| [options.conference.params.videoCodec] | string | "\\"VP8\\"" | The conference video codec (VP8/H264) |\n\n**Example** \n```js\n// For example\nvar constraints = {\n audio: {\n mandatory: {\n sourceId: \"audioDeviceId\" // If you want to specifie an audio deviceId\n }\n },\n video: {\n mandatory: {\n minWidth: 160,\n minHeight: 120,\n maxWidth: 320,\n maxHeight: 240,\n minFrameRate: 10,\n maxFrameRate: 30\n sourceId: \"videoDeviceId\" // If you want to specifie an video deviceId\n }\n }\n};\n\nA simplest example of constraints would be: \n\nvar constraints = {audio: true, video: true};\n\nvoxeet.joinConference(conferenceId, {constraints: constraints})\n .then((info) => {\n\n })\n .catch((error) => {\n\n });\n```\n\n\n### voxeetSdk.leaveConference() ⇒ Promise.<Error>\nLeaves the currently running conference\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.invite(conferenceId, externalIds)\nAllows to invite users in a conference, they will receive the invitationReceived event\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| conferenceId | String | The corresponding conferenceId or Alias |\n| externalIds | Array | An array of external ids to be invited |\n\n\n\n### voxeetSdk.subscribeConferenceStatus(conferenceId) ⇒ Promise.<Error>\nSubscribe to receive updates on the conference status.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| conferenceId | String | The conference id or alias |\n\n\n\n### voxeetSdk.unsubscribeConferenceStatus(conferenceId) ⇒ Promise.<Error>\nUnsubscribe to the conference status event.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| conferenceId | String | The conference id or alias |\n\n\n\n### voxeetSdk.sendConferenceMessage(message) ⇒ Promise.<Error>\nAllows you to broadcast raw messages of any type (Json, Xml, simple string) to all participants of a conference\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| message | String | The message to be send as a raw string (can be json, xml, ...) |\n\n\n\n### voxeetSdk.setUserPosition(userId, x, y)\nSets the user position\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user to be moved |\n| x | Float | The user's x position, between -1.0 and 1.0 |\n| y | Float | The user's y position, between 0.0 and 1.0 |\n\n\n\n### voxeetSdk.muteUser(userId, isMuted)\nAllows to mute a user\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id to be muted |\n| isMuted | boolean | Mute On/Off |\n\n\n\n### voxeetSdk.toggleMute(userId) ⇒ Boolean\nAllows to toggle mute on a user\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Returns**: Boolean - State of the user \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id to be muted |\n\n\n\n### voxeetSdk.getUserLevel(userId, callback)\nAllows to get the user's current audio level normalized between 0.0 and 1.0\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | userId | The user's id of the level to be retreived |\n| callback | [getUserLevelCallback](#getUserLevelCallback) | The callback to retreive the audio level |\n\n\n\n### voxeetSdk.isUserSpeaking(userId, callback)\nAllows to get the user's current speech status\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | userId | The user's id of the status to be retreived |\n| callback | [isUserSpeakingCallback](#isUserSpeakingCallback) | The callback to retreive the status |\n\n\n\n### voxeetSdk.startVideoForUser(userId, constraints) ⇒ Promise.<Error>\nStarts the video stream for a user\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | userId | |\n| constraints | Object | Webrtc Video contraints |\n\n**Example** \n```js\nconst video = {\n mandatory: {\n minWidth: 160,\n minHeight: 120,\n maxWidth: 320,\n maxHeight: 240,\n minFrameRate: 10,\n maxFrameRate: 30,\n }\n};\n\nvoxeet.startVideoForUser(userId, constraints)\n .then(() => {\n\n });\n```\n\n\n### voxeetSdk.stopVideoForUser(userId) ⇒ Promise.<Error>\nStops the video stream for a user\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type |\n| --- | --- |\n| userId | userId | \n\n\n\n### voxeetSdk.startAudioForUser(userId) ⇒ Promise.<Error>\nStarts the audio stream for a user\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type |\n| --- | --- |\n| userId | userId | \n\n\n\n### voxeetSdk.stopAudioForUser(userId) ⇒ Promise.<Error>\nStops the audio stream for a user\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type |\n| --- | --- |\n| userId | userId | \n\n\n\n### voxeetSdk.startScreenShare(options) ⇒ Promise.<Error>\nStarts a screen sharing session\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Returns**: Promise.<Error> - VoxeetSdk.ScreenShareOptions is an enum containing different possibilities for those options :\n- VoxeetSdk.ScreenShareOptions.SCREEN\n- VoxeetSdk.ScreenShareOptions.WINDOW_AND_TAB\n- VoxeetSdk.ScreenShareOptions.ALL\n\nYou can also use a simple array with string value, like: ['screen', 'tab']\n\nNote that on Firefox, the array can't contain more than one value. \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| options | Array | ['screen' | An optional array to choose what type of capture options will presented to the user. |\n\n**Example** \n```js\nvoxeet.startScreenShare(['screen'])\n .then(() => {\n\n })\n .catch(e => {\n\n });\n```\n\n\n### voxeetSdk.startRecording() ⇒ Promise.<Error>\nStarts the current conference recording\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.stopRecording() ⇒ Promise.<Error>\nStops the current recording\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.stopScreenShare() ⇒ Promise.<Error>\nStops the screen sharing session\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.setMode(mode) ⇒ Promise.<Error>\nSets the mode of the conference: \n\nmode can be: \n - STANDARD\n - PUSH\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| mode | String | The mode to be set |\n\n\n\n### voxeetSdk.reserve(conferenceId) ⇒ Promise.<Error>\nReserves a slot in the corresponding conference\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| conferenceId | String | The conference id or alias |\n\n\n\n### voxeetSdk.stats(conferenceId) ⇒ Promise.<(Stats\\|Error)>\nReturns the stats for a specific conference.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| conferenceId | String | The conference Id |\n\n\n\n### voxeetSdk.convertFile(file) ⇒ Promise.<Error>\nAllows to convert a file selected throught an input file box. A `fileConverted` event will be fired\nwhen the file is ready\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| file | String | The file to convert |\n\n**Example** \n```js\nvoxeet.on('fileConverted' (file) => {\n\n});\n\nvoxeet.convertFile(...)\n .catch(e => error(e));\n```\n\n\n### voxeetSdk.startFilePresentation(config) ⇒ Promise.<Error>\nStarts a file presentation\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| config | Object | The json object received from `fileConverted` event containing the fileId |\n| config.fileId | String | The fileId of the converted file |\n| [config.fileName] | String | The fileName of the converted file |\n| config.imageCount | String | The number of images of the converted file |\n\n**Example** \n```js\nvoxeet.startFilePresentation({fileId: 'fileId'})\n .catch(e => error(e));\n```\n\n\n### voxeetSdk.updateFilePresentation(fileId, position) ⇒ Promise.<Error>\nUpdates the current file presentation page\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fileId | String | The corresponding fileId |\n| position | Integer | The page to present |\n\n\n\n### voxeetSdk.stopFilePresentation(fileId) ⇒ Promise.<Error>\nStops the current file presentation\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fileId | String | The Corresponding fileId |\n\n\n\n### voxeetSdk.getThumbnail(fileId, page) ⇒ Promise.<String>\nAllows to get a thumbnail for a page file\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Returns**: Promise.<String> - - The url of the thumbnail \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fileId | String | The corresponding fileId |\n| page | Integer | The page number to be retreived |\n\n\n\n### voxeetSdk.getImage(fileId, page) ⇒ Promise.<String>\nAllows to get an image for a page file\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Returns**: Promise.<String> - - The url of the image \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fileId | String | The corresponding fileId |\n| page | Integer | The page number to be retreived |\n\n\n\n### \"conferenceJoined\"\nEmitted when the conference has been successfully joined\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"conferenceLeft\"\nEmitted when the conference has been successfully left\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"conferenceEnded\"\nEmitted when the replayed conference has ended\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"conferenceStatusUpdated\" (conferenceInfo)\nEmitted when a conference status is received\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| conferenceInfo | Object | A Json object containing conference informations |\n| [conferenceInfo.conferenceAlias] | String | The conference alias |\n| [conferenceInfo.conferenceId] | String | The conference id |\n| [conferenceInfo.isLive] | boolean | The conference status |\n\n\n\n### \"participantAdded\" (userId, userInfo)\nEmitted when a participant (user) has been added to the conference\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id |\n| userInfo | Object | A Json object containing custom user informations |\n| [userInfo.name] | String | A Name for the user |\n| [userInfo.externalId] | String | An externalId for the user |\n| [userInfo.avatarUrl] | String | An avatar url for the user |\n\n\n\n### \"participantStatusUpdated\" (userId, status)\nEmitted when the status of a participant has changed\n\nStatus can be one if those values:\n- Reserved\n- Decline\n- Connecting\n- Connected\n- Inactive\n- Left\n- Warning\n- Error\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id |\n| status | String | The corresponding status |\n\n\n\n### \"participantJoined\" (userId, stream)\nEmitted when the participant has joined the conference\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id |\n| stream | MediaStream | The webrtc stream correponding to this participant |\n\n\n\n### \"participantUpdated\" (userId, stream)\nEmitted when a participant (user) stream has been updated\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id |\n| stream | MediaStream | The webrtc stream correponding to this participant |\n\n\n\n### \"participantLeft\" (userId)\nEmitted when a participant has left the conference\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id |\n\n\n\n### \"messageReceived\" (data)\nEmitted when a broadcast message is received\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| data | String | the received message |\n\n\n\n### \"screenShareStarted\" (userId, stream)\nEmitted when a screen share has been started\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id that started the screensharing |\n| stream | MediaStream | The screenshare stream |\n\n\n\n### \"screenShareUpdated\" (userId, stream)\nEmitted when the stream of the screen share has changed\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id that started the screensharing |\n| stream | MediaStream | The new screenshare stream |\n\n\n\n### \"screenShareStopped\"\nEmitted when a screen share has been stopped\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"qualityIndicators\" (indicators, mos)\nEmitted when a new quality indicator is available\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| indicators | object | Call quality indicators |\n| mos | Integer | The Mean Opinion Score, a value from 1 to 5 indicating the average call quality |\n\n\n\n### \"speakerChanged\"\nEmitted when the user that is speaking has changed.\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"renegociationEnded\"\nEmitted when all peers (local and remote ones) have been successfully renegociated\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"error\"\nEmitted when an error occured during a conference\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"fileConverted\" ([file])\nEmitted when a file has been converted\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| [file] | Object | A Json Object describing the converted file |\n| [file.fileId] | String | The fileId of the presentation |\n| [file.imageCount] | String | The number of page in this presentation |\n\n\n\n### \"filePresentationStarted\" ([file])\nEmitted when a file presentation has started\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| [file] | Object | A Json Object containing file presentation information |\n| [file.conferenceId] | String | The conferenceId of the presentation |\n| [file.fileId] | String | The fileId of the presentation |\n| [file.userId] | String | The userId that has started the presentation |\n| [file.position] | String | The current page of the presentation |\n| [file.imageCount] | String | The number of page in this presentation |\n\n\n\n### \"filePresentationUpdated\" ([file])\nEmitted when the file presentation has been updated (page changed)\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| [file] | Object | A Json Object containing file presentation information |\n| [file.conferenceId] | String | The conferenceId of the presentation |\n| [file.fileId] | String | The fileId of the presentation |\n| [file.userId] | String | The userId that has started the presentation |\n| [file.position] | String | The current page of the presentation |\n\n\n\n### \"filePresentationStopped\"\nEmitted when the file presentation has been stopped\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"invitationReceived\" (data)\nEmitted when an invitation is received.\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| data | Object | Informations about the conference invitation |\n\n\n\n### VoxeetSdk.ScreenShareOptions : enum\nEnum for screen sharing options\n\n**Kind**: static enum of [VoxeetSdk](#VoxeetSdk) \n**Read only**: true \n\n\n## ConferenceError ⇐ Error\nGeneric error for conferences\n\nError names:\n - UninitializedError - The conference isn't initialized yet.\n\n**Kind**: global class \n**Extends**: Error \n\n\n## PeerError ⇐ Error\nErrors on peer operations\n\nError names:\n - PeerNotFoundError - The peer could not be found for this operation.\n - RemoteDescriptionError - Failed to set remote description.\n - CreateAnswerError - Failed to create answer.\n - ConnectionFailedError - The peer connection failed to connect. (Only send for your own peer connection)\n - DisconnectedError - The peer connection has been disconnected. (Only send for your own peer connection)\n\n**Kind**: global class \n**Extends**: Error \n\n\n## MediaStreamError ⇐ Error\nErrors happening when a stream cannot be captured from a device\n\nError names:\n - NotSupportedError - The operation is not supported.\n - PermissionDeniedError - The user did not grant permission for the operation.\n - ConstraintNotSatisfiedError - One of the mandatory constraints could not be satisfied.\n - NotFoundError - The object can not be found.\n - AbortError - The operatoin was aborted\n - SourceUnavailableError - The source of the MediaStream could not be accessed dure to a hardware error.\n\n**Kind**: global class \n**Extends**: Error \n\n\n## BrowserError\nBrowser specific errors\n\nError names:\n - NotSupportedError - Operation not supported on this browser\n\n**Kind**: global class \n\n\n## ServerError\nServer return by voxeet servers\n\n- code : The specific error code, HTTP ones\n- reason : The error reason\n- description; the error long description\n\n**Kind**: global class \n\n\n## getUserLevelCallback : function\nCallback to retreive a user's audio level\n\n**Kind**: global typedef \n\n| Param | Type | Description |\n| --- | --- | --- |\n| level | float | the user's current audio level normalized between 0.0 and 1.0 |\n\n\n\n## isUserSpeakingCallback : function\nCallback to retreive if a user is speaking\n\n**Kind**: global typedef \n\n| Param | Type | Description |\n| --- | --- | --- |\n| isSpeaking | Boolean | The state of the user |\n\n\n# Sample Application\n\nA sample application is available on this [public repository][sample] on GitHub.\n\n [sample]: EventEmitterVoxeet is the main Object for the sdk, providing methods and events to interact with voxeet servers.\nThe SDK is asynchronous and uses promise at his core.
\nErrorGeneric error for conferences
\nError names:
\nErrorErrors on peer operations
\nError names:
\nErrorErrors happening when a stream cannot be captured from a device
\nError names:
\nBrowser specific errors
\nError names:
\nServer return by voxeet servers
\nfunctionCallback to retreive a user's audio level
\nfunctionCallback to retreive if a user is speaking
\nEventEmitter\nVoxeet is the main Object for the sdk, providing methods and events to interact with voxeet servers.\nThe SDK is asynchronous and uses promise at his core.\n\n**Kind**: global class \n**Extends**: EventEmitter \n\n* [VoxeetSdk](#VoxeetSdk) ⇐ EventEmitter\n * _instance_\n * [.userId](#VoxeetSdk+userId) : String\n * [.userToken](#VoxeetSdk+userToken) : String\n * [.initialize(consumerKey, consumerSecret, [userInfo])](#VoxeetSdk+initialize) ⇒ Promise.<(userdId\\|Error)>\n * [.initializeToken(accessToken, [userInfo], refreshTokenCb)](#VoxeetSdk+initializeToken) ⇒ Promise.<(userdId\\|Error)>\n * [.enumerateAudioDevices()](#VoxeetSdk+enumerateAudioDevices) ⇒ Promise.<(Array.<MediaDeviceInfo>\\|Error)>\n * [.enumerateVideoDevices()](#VoxeetSdk+enumerateVideoDevices) ⇒ Promise.<(Array.<MediaDeviceInfo>\\|Error)>\n * [.selectAudioInput(deviceId)](#VoxeetSdk+selectAudioInput) ⇒ Promise.<Error>\n * [.selectVideoInput(deviceId, constraints)](#VoxeetSdk+selectVideoInput) ⇒ Promise.<Error>\n * [.createDemoConference()](#VoxeetSdk+createDemoConference)\n * [.replayConference(conferenceId, offset)](#VoxeetSdk+replayConference) ⇒ Promise.<Error>\n * [.createConference([options])](#VoxeetSdk+createConference) ⇒ Promise.<(String\\|Error)>\n * [.joinConference(conferenceId, [options])](#VoxeetSdk+joinConference) ⇒ Promise.<(ConferenceInfo\\|Error)>\n * [.leaveConference()](#VoxeetSdk+leaveConference) ⇒ Promise.<Error>\n * [.invite(conferenceId, externalIds)](#VoxeetSdk+invite)\n * [.subscribeConferenceStatus(conferenceId)](#VoxeetSdk+subscribeConferenceStatus) ⇒ Promise.<Error>\n * [.unsubscribeConferenceStatus(conferenceId)](#VoxeetSdk+unsubscribeConferenceStatus) ⇒ Promise.<Error>\n * [.sendConferenceMessage(message)](#VoxeetSdk+sendConferenceMessage) ⇒ Promise.<Error>\n * [.setUserPosition(userId, x, y)](#VoxeetSdk+setUserPosition)\n * [.muteUser(userId, isMuted)](#VoxeetSdk+muteUser)\n * [.toggleMute(userId)](#VoxeetSdk+toggleMute) ⇒ Boolean\n * [.getUserLevel(userId, callback)](#VoxeetSdk+getUserLevel)\n * [.isUserSpeaking(userId, callback)](#VoxeetSdk+isUserSpeaking)\n * [.startVideoForUser(userId, constraints)](#VoxeetSdk+startVideoForUser) ⇒ Promise.<Error>\n * [.stopVideoForUser(userId)](#VoxeetSdk+stopVideoForUser) ⇒ Promise.<Error>\n * [.startAudioForUser(userId)](#VoxeetSdk+startAudioForUser) ⇒ Promise.<Error>\n * [.stopAudioForUser(userId)](#VoxeetSdk+stopAudioForUser) ⇒ Promise.<Error>\n * [.startScreenShare(options)](#VoxeetSdk+startScreenShare) ⇒ Promise.<Error>\n * [.startRecording()](#VoxeetSdk+startRecording) ⇒ Promise.<Error>\n * [.stopRecording()](#VoxeetSdk+stopRecording) ⇒ Promise.<Error>\n * [.stopScreenShare()](#VoxeetSdk+stopScreenShare) ⇒ Promise.<Error>\n * [.setMode(mode)](#VoxeetSdk+setMode) ⇒ Promise.<Error>\n * [.reserve(conferenceId)](#VoxeetSdk+reserve) ⇒ Promise.<Error>\n * [.stats(conferenceId)](#VoxeetSdk+stats) ⇒ Promise.<(Stats\\|Error)>\n * [.convertFile(file)](#VoxeetSdk+convertFile) ⇒ Promise.<Error>\n * [.startFilePresentation(config)](#VoxeetSdk+startFilePresentation) ⇒ Promise.<Error>\n * [.updateFilePresentation(fileId, position)](#VoxeetSdk+updateFilePresentation) ⇒ Promise.<Error>\n * [.stopFilePresentation(fileId)](#VoxeetSdk+stopFilePresentation) ⇒ Promise.<Error>\n * [.getThumbnail(fileId, page)](#VoxeetSdk+getThumbnail) ⇒ Promise.<String>\n * [.getImage(fileId, page)](#VoxeetSdk+getImage) ⇒ Promise.<String>\n * [\"conferenceJoined\"](#VoxeetSdk+event_conferenceJoined)\n * [\"conferenceLeft\"](#VoxeetSdk+event_conferenceLeft)\n * [\"conferenceEnded\"](#VoxeetSdk+event_conferenceEnded)\n * [\"conferenceStatusUpdated\" (conferenceInfo)](#VoxeetSdk+event_conferenceStatusUpdated)\n * [\"participantAdded\" (userId, userInfo)](#VoxeetSdk+event_participantAdded)\n * [\"participantStatusUpdated\" (userId, status)](#VoxeetSdk+event_participantStatusUpdated)\n * [\"participantJoined\" (userId, stream)](#VoxeetSdk+event_participantJoined)\n * [\"participantUpdated\" (userId, stream)](#VoxeetSdk+event_participantUpdated)\n * [\"participantLeft\" (userId)](#VoxeetSdk+event_participantLeft)\n * [\"messageReceived\" (data)](#VoxeetSdk+event_messageReceived)\n * [\"screenShareStarted\" (userId, stream)](#VoxeetSdk+event_screenShareStarted)\n * [\"screenShareUpdated\" (userId, stream)](#VoxeetSdk+event_screenShareUpdated)\n * [\"screenShareStopped\"](#VoxeetSdk+event_screenShareStopped)\n * [\"qualityIndicators\" (indicators, mos)](#VoxeetSdk+event_qualityIndicators)\n * [\"speakerChanged\"](#VoxeetSdk+event_speakerChanged)\n * [\"renegociationEnded\"](#VoxeetSdk+event_renegociationEnded)\n * [\"error\"](#VoxeetSdk+event_error)\n * [\"fileConverted\" ([file])](#VoxeetSdk+event_fileConverted)\n * [\"filePresentationStarted\" ([file])](#VoxeetSdk+event_filePresentationStarted)\n * [\"filePresentationUpdated\" ([file])](#VoxeetSdk+event_filePresentationUpdated)\n * [\"filePresentationStopped\"](#VoxeetSdk+event_filePresentationStopped)\n * [\"invitationReceived\" (data)](#VoxeetSdk+event_invitationReceived)\n * _static_\n * [.ScreenShareOptions](#VoxeetSdk.ScreenShareOptions) : enum\n\n\n\n### voxeetSdk.userId : String\nThe current user id\n\n**Kind**: instance property of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.userToken : String\nThe current user token\n\n**Kind**: instance property of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.initialize(consumerKey, consumerSecret, [userInfo]) ⇒ Promise.<(userdId\\|Error)>\nOpens a session to Voxeet server (websocket included)\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Async**: \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| consumerKey | String | | The consumer key |\n| consumerSecret | String | | The consumer Secret |\n| [userInfo] | Object | {} | A Json object containing custom user informations |\n| [userInfo.name] | String | | A Name for the user |\n| [userInfo.externalId] | String | | An externalId for the user |\n| [userInfo.avatarUrl] | String | | An avatar url for the user |\n\n**Example** \n```js\nvar voxeet = new VoxeetSdk();\nvoxeet.initialize('ConsumerKey', 'ConsumerSecret', {name: 'John Doe'})\n .then((myUserId) => {\n // VoxeetSdk is now initialized, you can create/join a conference\n })\n .catch((error) => {\n // An Error has occured, see Error Types\n });\n```\n\n\n### voxeetSdk.initializeToken(accessToken, [userInfo], refreshTokenCb) ⇒ Promise.<(userdId\\|Error)>\nOpens a session to Voxeet server (websocket included)\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Async**: \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| accessToken | String | | An access token retreived from the customer server |\n| [userInfo] | Object | {} | A Json object containing custom user informations |\n| [userInfo.name] | String | | A Name for the user |\n| [userInfo.externalId] | String | | An externalId for the user |\n| [userInfo.avatarUrl] | String | | An avatar url for the user |\n| refreshTokenCb | function | | A function called to refresh the access token, must return a Promise |\n\n**Example** \n```js\nvoxeet.initializeToken(\"accessToken\", {name: \"John Doe\"}, () => {\n return Promise.resolve(\"Refresh accessed Token\");\n})\n.then((myUserId) => {\n\n})\n.catch((error) => {\n\n});\n```\n\n\n### voxeetSdk.enumerateAudioDevices() ⇒ Promise.<(Array.<MediaDeviceInfo>\\|Error)>\nEnumerates all audio input devices on the computer, allowing you to further change it\nwhile in conference.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Example** \n```js\nvoxeet.enumerateAudioDevices()\n .then((devices) => {\n console.log(devices) // Will output [{label: \"device1\", ...}, {label: \"device2\", ...}]\n });\n```\n\n\n### voxeetSdk.enumerateVideoDevices() ⇒ Promise.<(Array.<MediaDeviceInfo>\\|Error)>\nEnumerates all video input devices on the computer, allowing you to further change it\nwhile in conference.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Example** \n```js\nvoxeet.enumerateVideoDevices()\n .then((devices) => {\n console.log(devices) // Will output [{label: \"device1\", ...}, {label: \"device2\", ...}]\n });\n```\n\n\n### voxeetSdk.selectAudioInput(deviceId) ⇒ Promise.<Error>\nAllows to select an audio device input while in conference.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| deviceId | String | The select device id (provided with [enumerateAudioDevices](#VoxeetSdk+enumerateAudioDevices)) |\n\n\n\n### voxeetSdk.selectVideoInput(deviceId, constraints) ⇒ Promise.<Error>\nAllows to select a video device input while in conference.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| deviceId | String | The select device id (provided with [enumerateVideoDevices](#VoxeetSdk+enumerateVideoDevices)) |\n| constraints | Object | Webrtc Video constraints |\n\n**Example** \n```js\nconst video = {\n mandatory: {\n minWidth: 160,\n minHeight: 120,\n maxWidth: 320,\n maxHeight: 240,\n minFrameRate: 10,\n maxFrameRate: 30,\n }\n};\n\nvoxeet.selectVideoInput(deviceId, constraints)\n .then(() => {\n\n });\n```\n\n\n### voxeetSdk.createDemoConference()\nCreates a conference demo.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.replayConference(conferenceId, offset) ⇒ Promise.<Error>\nReplays a previously recorded conference.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| conferenceId | UUID | | The conference id returned when joining a conference |\n| offset | Number | 0 | Replays the conference from this offset in milliseconds |\n\n\n\n### voxeetSdk.createConference([options]) ⇒ Promise.<(String\\|Error)>\nCreates a conference. If conferenceAlias is empty, an id will be generated. \n\nIf the conference already exists, the current conference id is returned.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Returns**: Promise.<(String\\|Error)> - The corresponding conference id \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [options] | object | {} | Information of the conference to be created |\n| [options.alias] | string | "\\"\\"" | An alias for the conference or empty |\n| [options.params] | object | {} | Parameters for this conference |\n| [options.params.ttl] | boolean | 0 | The conference time to live in seconds, default to 0 |\n| [options.params.rtcpMode] | string | "\\"worst\\"" | The conference RTC Mode (best/worst) for quality control |\n| [options.params.mode] | string | "\\"standard\\"" | The conference mode (push/standard) |\n| [options.params.videoCodec] | string | "\\"VP8\\"" | The conference video codec (VP8/H264) |\n\n\n\n### voxeetSdk.joinConference(conferenceId, [options]) ⇒ Promise.<(ConferenceInfo\\|Error)>\nJoins a conference. If the conference doesn't exist, it will be created\n\nNote that if you used createConference beforehand, the conference params in the following object\nare ignored.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| conferenceId | string | | The conference id or alias to be joined |\n| [options] | object | {} | Options for the conference |\n| [options.constraints] | object | {audio: true, video: true} | WebRTC constraints |\n| [options.audio3D] | boolean | true | Activate/Deactivate 3D audio |\n| [options.user] | object | {} | User options |\n| [options.user.name] | string | | The user name |\n| [options.user.type] | string | "\\"user\\"" | The user type |\n| [options.conference] | object | {} | The conference options |\n| [options.conference.params] | object | {} | Parameters for this conference |\n| [options.conference.params.ttl] | boolean | 0 | The conference time to live in seconds, default to 0 |\n| [options.conference.params.rtcpMode] | string | "\\"worst\\"" | The conference RTC Mode (best/worst) for quality control |\n| [options.conference.params.mode] | string | "\\"standard\\"" | The conference mode (push/standard) |\n| [options.conference.params.videoCodec] | string | "\\"VP8\\"" | The conference video codec (VP8/H264) |\n\n**Example** \n```js\n// For example\nvar constraints = {\n audio: {\n mandatory: {\n sourceId: \"audioDeviceId\" // If you want to specifie an audio deviceId\n }\n },\n video: {\n mandatory: {\n minWidth: 160,\n minHeight: 120,\n maxWidth: 320,\n maxHeight: 240,\n minFrameRate: 10,\n maxFrameRate: 30\n sourceId: \"videoDeviceId\" // If you want to specifie an video deviceId\n }\n }\n};\n\nA simplest example of constraints would be: \n\nvar constraints = {audio: true, video: true};\n\nvoxeet.joinConference(conferenceId, {constraints: constraints})\n .then((info) => {\n\n })\n .catch((error) => {\n\n });\n```\n\n\n### voxeetSdk.leaveConference() ⇒ Promise.<Error>\nLeaves the currently running conference\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.invite(conferenceId, externalIds)\nAllows to invite users in a conference, they will receive the invitationReceived event\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| conferenceId | String | The corresponding conferenceId or Alias |\n| externalIds | Array | An array of external ids to be invited |\n\n\n\n### voxeetSdk.subscribeConferenceStatus(conferenceId) ⇒ Promise.<Error>\nSubscribe to receive updates on the conference status.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| conferenceId | String | The conference id or alias |\n\n\n\n### voxeetSdk.unsubscribeConferenceStatus(conferenceId) ⇒ Promise.<Error>\nUnsubscribe to the conference status event.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| conferenceId | String | The conference id or alias |\n\n\n\n### voxeetSdk.sendConferenceMessage(message) ⇒ Promise.<Error>\nAllows you to broadcast raw messages of any type (Json, Xml, simple string) to all participants of a conference\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| message | String | The message to be send as a raw string (can be json, xml, ...) |\n\n\n\n### voxeetSdk.setUserPosition(userId, x, y)\nSets the user position\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user to be moved |\n| x | Float | The user's x position, between -1.0 and 1.0 |\n| y | Float | The user's y position, between 0.0 and 1.0 |\n\n\n\n### voxeetSdk.muteUser(userId, isMuted)\nAllows to mute a user\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id to be muted |\n| isMuted | boolean | Mute On/Off |\n\n\n\n### voxeetSdk.toggleMute(userId) ⇒ Boolean\nAllows to toggle mute on a user\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Returns**: Boolean - State of the user \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id to be muted |\n\n\n\n### voxeetSdk.getUserLevel(userId, callback)\nAllows to get the user's current audio level normalized between 0.0 and 1.0\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | userId | The user's id of the level to be retreived |\n| callback | [getUserLevelCallback](#getUserLevelCallback) | The callback to retreive the audio level |\n\n\n\n### voxeetSdk.isUserSpeaking(userId, callback)\nAllows to get the user's current speech status\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | userId | The user's id of the status to be retreived |\n| callback | [isUserSpeakingCallback](#isUserSpeakingCallback) | The callback to retreive the status |\n\n\n\n### voxeetSdk.startVideoForUser(userId, constraints) ⇒ Promise.<Error>\nStarts the video stream for a user\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | userId | |\n| constraints | Object | Webrtc Video contraints |\n\n**Example** \n```js\nconst video = {\n mandatory: {\n minWidth: 160,\n minHeight: 120,\n maxWidth: 320,\n maxHeight: 240,\n minFrameRate: 10,\n maxFrameRate: 30,\n }\n};\n\nvoxeet.startVideoForUser(userId, constraints)\n .then(() => {\n\n });\n```\n\n\n### voxeetSdk.stopVideoForUser(userId) ⇒ Promise.<Error>\nStops the video stream for a user\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type |\n| --- | --- |\n| userId | userId | \n\n\n\n### voxeetSdk.startAudioForUser(userId) ⇒ Promise.<Error>\nStarts the audio stream for a user\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type |\n| --- | --- |\n| userId | userId | \n\n\n\n### voxeetSdk.stopAudioForUser(userId) ⇒ Promise.<Error>\nStops the audio stream for a user\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type |\n| --- | --- |\n| userId | userId | \n\n\n\n### voxeetSdk.startScreenShare(options) ⇒ Promise.<Error>\nStarts a screen sharing session\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Returns**: Promise.<Error> - VoxeetSdk.ScreenShareOptions is an enum containing different possibilities for those options :\n- VoxeetSdk.ScreenShareOptions.SCREEN\n- VoxeetSdk.ScreenShareOptions.WINDOW_AND_TAB\n- VoxeetSdk.ScreenShareOptions.ALL\n\nYou can also use a simple array with string value, like: ['screen', 'tab']\n\nNote that on Firefox, the array can't contain more than one value. \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| options | Array | ['screen' | An optional array to choose what type of capture options will presented to the user. |\n\n**Example** \n```js\nvoxeet.startScreenShare(['screen'])\n .then(() => {\n\n })\n .catch(e => {\n\n });\n```\n\n\n### voxeetSdk.startRecording() ⇒ Promise.<Error>\nStarts the current conference recording\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.stopRecording() ⇒ Promise.<Error>\nStops the current recording\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.stopScreenShare() ⇒ Promise.<Error>\nStops the screen sharing session\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n\n### voxeetSdk.setMode(mode) ⇒ Promise.<Error>\nSets the mode of the conference: \n\nmode can be: \n - STANDARD\n - PUSH\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| mode | String | The mode to be set |\n\n\n\n### voxeetSdk.reserve(conferenceId) ⇒ Promise.<Error>\nReserves a slot in the corresponding conference\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| conferenceId | String | The conference id or alias |\n\n\n\n### voxeetSdk.stats(conferenceId) ⇒ Promise.<(Stats\\|Error)>\nReturns the stats for a specific conference.\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| conferenceId | String | The conference Id |\n\n\n\n### voxeetSdk.convertFile(file) ⇒ Promise.<Error>\nAllows to convert a file selected throught an input file box. A `fileConverted` event will be fired\nwhen the file is ready\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| file | String | The file to convert |\n\n**Example** \n```js\nvoxeet.on('fileConverted' (file) => {\n\n});\n\nvoxeet.convertFile(...)\n .catch(e => error(e));\n```\n\n\n### voxeetSdk.startFilePresentation(config) ⇒ Promise.<Error>\nStarts a file presentation\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| config | Object | The json object received from `fileConverted` event containing the fileId |\n| config.fileId | String | The fileId of the converted file |\n| [config.fileName] | String | The fileName of the converted file |\n| config.imageCount | String | The number of images of the converted file |\n\n**Example** \n```js\nvoxeet.startFilePresentation({fileId: 'fileId'})\n .catch(e => error(e));\n```\n\n\n### voxeetSdk.updateFilePresentation(fileId, position) ⇒ Promise.<Error>\nUpdates the current file presentation page\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fileId | String | The corresponding fileId |\n| position | Integer | The page to present |\n\n\n\n### voxeetSdk.stopFilePresentation(fileId) ⇒ Promise.<Error>\nStops the current file presentation\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fileId | String | The Corresponding fileId |\n\n\n\n### voxeetSdk.getThumbnail(fileId, page) ⇒ Promise.<String>\nAllows to get a thumbnail for a page file\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Returns**: Promise.<String> - - The url of the thumbnail \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fileId | String | The corresponding fileId |\n| page | Integer | The page number to be retreived |\n\n\n\n### voxeetSdk.getImage(fileId, page) ⇒ Promise.<String>\nAllows to get an image for a page file\n\n**Kind**: instance method of [VoxeetSdk](#VoxeetSdk) \n**Returns**: Promise.<String> - - The url of the image \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fileId | String | The corresponding fileId |\n| page | Integer | The page number to be retreived |\n\n\n\n### \"conferenceJoined\"\nEmitted when the conference has been successfully joined\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"conferenceLeft\"\nEmitted when the conference has been successfully left\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"conferenceEnded\"\nEmitted when the replayed conference has ended\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"conferenceStatusUpdated\" (conferenceInfo)\nEmitted when a conference status is received\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| conferenceInfo | Object | A Json object containing conference informations |\n| [conferenceInfo.conferenceAlias] | String | The conference alias |\n| [conferenceInfo.conferenceId] | String | The conference id |\n| [conferenceInfo.isLive] | boolean | The conference status |\n\n\n\n### \"participantAdded\" (userId, userInfo)\nEmitted when a participant (user) has been added to the conference\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id |\n| userInfo | Object | A Json object containing custom user informations |\n| [userInfo.name] | String | A Name for the user |\n| [userInfo.externalId] | String | An externalId for the user |\n| [userInfo.avatarUrl] | String | An avatar url for the user |\n\n\n\n### \"participantStatusUpdated\" (userId, status)\nEmitted when the status of a participant has changed\n\nStatus can be one if those values:\n- Reserved\n- Decline\n- Connecting\n- Connected\n- Inactive\n- Left\n- Warning\n- Error\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id |\n| status | String | The corresponding status |\n\n\n\n### \"participantJoined\" (userId, stream)\nEmitted when the participant has joined the conference\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id |\n| stream | MediaStream | The webrtc stream correponding to this participant |\n\n\n\n### \"participantUpdated\" (userId, stream)\nEmitted when a participant (user) stream has been updated\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id |\n| stream | MediaStream | The webrtc stream correponding to this participant |\n\n\n\n### \"participantLeft\" (userId)\nEmitted when a participant has left the conference\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id |\n\n\n\n### \"messageReceived\" (data)\nEmitted when a broadcast message is received\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| data | String | the received message |\n\n\n\n### \"screenShareStarted\" (userId, stream)\nEmitted when a screen share has been started\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id that started the screensharing |\n| stream | MediaStream | The screenshare stream |\n\n\n\n### \"screenShareUpdated\" (userId, stream)\nEmitted when the stream of the screen share has changed\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| userId | String | The user's id that started the screensharing |\n| stream | MediaStream | The new screenshare stream |\n\n\n\n### \"screenShareStopped\"\nEmitted when a screen share has been stopped\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"qualityIndicators\" (indicators, mos)\nEmitted when a new quality indicator is available\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| indicators | object | Call quality indicators |\n| mos | Integer | The Mean Opinion Score, a value from 1 to 5 indicating the average call quality |\n\n\n\n### \"speakerChanged\"\nEmitted when the user that is speaking has changed.\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"renegociationEnded\"\nEmitted when all peers (local and remote ones) have been successfully renegociated\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"error\"\nEmitted when an error occured during a conference\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"fileConverted\" ([file])\nEmitted when a file has been converted\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| [file] | Object | A Json Object describing the converted file |\n| [file.fileId] | String | The fileId of the presentation |\n| [file.imageCount] | String | The number of page in this presentation |\n\n\n\n### \"filePresentationStarted\" ([file])\nEmitted when a file presentation has started\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| [file] | Object | A Json Object containing file presentation information |\n| [file.conferenceId] | String | The conferenceId of the presentation |\n| [file.fileId] | String | The fileId of the presentation |\n| [file.userId] | String | The userId that has started the presentation |\n| [file.position] | String | The current page of the presentation |\n| [file.imageCount] | String | The number of page in this presentation |\n\n\n\n### \"filePresentationUpdated\" ([file])\nEmitted when the file presentation has been updated (page changed)\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| [file] | Object | A Json Object containing file presentation information |\n| [file.conferenceId] | String | The conferenceId of the presentation |\n| [file.fileId] | String | The fileId of the presentation |\n| [file.userId] | String | The userId that has started the presentation |\n| [file.position] | String | The current page of the presentation |\n\n\n\n### \"filePresentationStopped\"\nEmitted when the file presentation has been stopped\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n\n### \"invitationReceived\" (data)\nEmitted when an invitation is received.\n\n**Kind**: event emitted by [VoxeetSdk](#VoxeetSdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| data | Object | Informations about the conference invitation |\n\n\n\n### VoxeetSdk.ScreenShareOptions : enum\nEnum for screen sharing options\n\n**Kind**: static enum of [VoxeetSdk](#VoxeetSdk) \n**Read only**: true \n\n\n## ConferenceError ⇐ Error\nGeneric error for conferences\n\nError names:\n - UninitializedError - The conference isn't initialized yet.\n\n**Kind**: global class \n**Extends**: Error \n\n\n## PeerError ⇐ Error\nErrors on peer operations\n\nError names:\n - PeerNotFoundError - The peer could not be found for this operation.\n - RemoteDescriptionError - Failed to set remote description.\n - CreateAnswerError - Failed to create answer.\n - ConnectionFailedError - The peer connection failed to connect. (Only send for your own peer connection)\n - DisconnectedError - The peer connection has been disconnected. (Only send for your own peer connection)\n\n**Kind**: global class \n**Extends**: Error \n\n\n## MediaStreamError ⇐ Error\nErrors happening when a stream cannot be captured from a device\n\nError names:\n - NotSupportedError - The operation is not supported.\n - PermissionDeniedError - The user did not grant permission for the operation.\n - ConstraintNotSatisfiedError - One of the mandatory constraints could not be satisfied.\n - NotFoundError - The object can not be found.\n - AbortError - The operatoin was aborted\n - SourceUnavailableError - The source of the MediaStream could not be accessed dure to a hardware error.\n\n**Kind**: global class \n**Extends**: Error \n\n\n## BrowserError\nBrowser specific errors\n\nError names:\n - NotSupportedError - Operation not supported on this browser\n\n**Kind**: global class \n\n\n## ServerError\nServer return by voxeet servers\n\n- code : The specific error code, HTTP ones\n- reason : The error reason\n- description; the error long description\n\n**Kind**: global class \n\n\n## getUserLevelCallback : function\nCallback to retreive a user's audio level\n\n**Kind**: global typedef \n\n| Param | Type | Description |\n| --- | --- | --- |\n| level | float | the user's current audio level normalized between 0.0 and 1.0 |\n\n\n\n## isUserSpeakingCallback : function\nCallback to retreive if a user is speaking\n\n**Kind**: global typedef \n\n| Param | Type | Description |\n| --- | --- | --- |\n| isSpeaking | Boolean | The state of the user |\n\n\n# Sample Application\n\nA sample application is available on this [public repository][sample] on GitHub.\n\n [sample]: