jitsi 常用 api

---

id: dev-guide-ljm-api
title: lib-jitsi-meet API (low level)

You can use Jitsi Meet API to create Jitsi Meet video conferences with a custom GUI.

Installation

To embed Jitsi Meet API in your application you need to add Jitsi Meet API library

<script src="https://code.jquery.com/jquery-3.5.1.min.js"></script>
<script src="https://meet.jit.si/libs/lib-jitsi-meet.min.js"></script>

Now you can access Jitsi Meet API through the JitsiMeetJS global object.

Getting Started

1. The first thing you must do in order to use Jitsi Meet API is to initialize JitsiMeetJS object:

JitsiMeetJS.init();

2. Then you must create the connection object:

var connection = new JitsiMeetJS.JitsiConnection(null, null, options);

3. Now we can attach some listeners to the connection object and establish the server connection:

connection.addEventListener(JitsiMeetJS.events.connection.CONNECTION_ESTABLISHED, onConnectionSuccess);
connection.addEventListener(JitsiMeetJS.events.connection.CONNECTION_FAILED, onConnectionFailed);
connection.addEventListener(JitsiMeetJS.events.connection.CONNECTION_DISCONNECTED, disconnect);

connection.connect();

4. After you receive the CONNECTION_ESTABLISHED event you are to create the JitsiConference object and
   also you may want to attach listeners for conference events (we are going to add handlers for remote track, conference joined, etc. ):

room = connection.initJitsiConference("conference1", confOptions);
room.on(JitsiMeetJS.events.conference.TRACK_ADDED, onRemoteTrack);
room.on(JitsiMeetJS.events.conference.CONFERENCE_JOINED, onConferenceJoined);

5. You also may want to get your local tracks from the camera and microphone:

JitsiMeetJS.createLocalTracks().then(onLocalTracks);

NOTE: Adding listeners and creating local streams are not mandatory steps.

6. Then you are ready to create / join a conference :

room.join();

After that step you are in the conference. Now you can continue with adding some code that will handle the events and manage the conference.

Components

Jitsi Meet API has the following components:

• JitsiMeetJS

• JitsiConnection

• JitsiConference

• JitsiTrack

• JitsiTrackError

Usage

:::note NOTE
JaaS customers, please follow this example or check out the live demo.
:::

JitsiMeetJS

You can access the following methods and objects through JitsiMeetJS object.

JitsiMeetJS.init

• JitsiMeetJS.init(options) - this method initialized Jitsi Meet API.
  The options parameter is JS object with the following properties:
  • useIPv6 - boolean property
  • disableAudioLevels - boolean property. Enables/disables audio levels.
  • disableSimulcast - boolean property. Enables/disables simulcast.
  • enableWindowOnErrorHandler - boolean property (default false). Enables/disables attaching global onerror handler (window.onerror).
  • disableThirdPartyRequests - if true - callstats will be disabled and the callstats API won’t be included.
  • enableAnalyticsLogging - boolean property (default false). Enables/disables analytics logging.
  • externalStorage - Object that implements the Storage interface. If specified this object will be used for storing data instead of localStorage.
  • callStatsCustomScriptUrl - (optional) custom url to access callstats client script
  • disableRtx - (optional) boolean property (default to false). Enables/disable the use of RTX.
  • disabledCodec - the mime type of the code that should not be negotiated on the peerconnection.
  • preferredCodec - the mime type of the codec that needs to be made the preferred codec for the connection.
  • useTurnUdp - boolean property (default false). Enables use of turn over udp for jvb. It is disabled because not very useful (if the client can use udp, it likely can connect to jvb directly over udp too; but it can be useful to still enable udp turn when an udp turn is known to be whitelisted on a network)

JitsiMeetJS.JitsiConnection

• JitsiMeetJS.JitsiConnection - the JitsiConnection constructor. You can use that to create new server connection.

JitsiMeetJS.setLogLevel

• JitsiMeetJS.setLogLevel - changes the log level for the library. For example to have only error messages you should do:

JitsiMeetJS.setLogLevel(JitsiMeetJS.logLevels.ERROR);

JitsiMeetJS.createLocalTracks

• JitsiMeetJS.createLocalTracks(options) - Creates the media tracks and returns them through Promise object. If rejected, passes JitsiTrackError instance to catch block.
  • options - JS object with configuration options for the local media tracks. You can change the following properties there:
    1. devices - array with the devices - “desktop”, “video” and “audio” that will be passed to GUM. If that property is not set GUM will try to get all available devices.
    2. resolution - the prefered resolution for the local video.
    3. constraints - the prefered encoding properties for the created track (replaces ‘resolution’ in newer releases of browsers)
    4. cameraDeviceId - the deviceID for the video device that is going to be used
    5. micDeviceId - the deviceID for the audio device that is going to be used
    6. minFps - the minimum frame rate for the video stream (passed to GUM)，最小FPS（帧数）
    7. maxFps - the maximum frame rate for the video stream (passed to GUM)，最大FPS（帧数）
    8. desktopSharingSourceDevice - The device id or label for a video input source that should be used for screensharing.
    9. facingMode - facing mode for a camera (possible values - ‘user’, ‘environment’)
    10. firePermissionPromptIsShownEvent - optional boolean parameter. If set to true, JitsiMediaDevicesEvents.PERMISSION_PROMPT_IS_SHOWN will be fired when browser shows gUM permission prompt.
    11. fireSlowPromiseEvent - optional boolean parameter. If set to true, JitsiMediaDevicesEvents.USER_MEDIA_SLOW_PROMISE_TIMEOUT will be fired when browser takes too long to resolve the gUM promise. This event is mutual exclusive with the above JitsiMediaDevicesEvents.PERMISSION_PROMPT_IS_SHOWN event
  • firePermissionPromptIsShownEvent - DEPRECATED. Use options.firePermissionPromptIsShownEvent instead

JitsiMeetJS.createTrackVADEmitter

• JitsiMeetJS.createTrackVADEmitter(localAudioDeviceId, sampleRate, vadProcessor) - Creates a TrackVADEmitter service that connects an audio track to a VAD (voice activity detection) processor in order to obtain VAD scores for individual PCM audio samples.
  • localAudioDeviceId - The target local audio device.
  • sampleRate - Sample rate at which the emitter will operate. Possible values 256, 512, 1024, 4096, 8192, 16384. Passing other values will default to closes neighbor, i.e. Providing a value of 4096 means that the emitter will process bundles of 4096 PCM samples at a time, higher values mean longer calls, lowers values mean more calls but shorter.
  • vadProcessor - VAD Processors that does the actual compute on a PCM sample.The processor needs to implement the following functions:
    • getSampleLength() - Returns the sample size accepted by calculateAudioFrameVAD.
    • getRequiredPCMFrequency() - Returns the PCM frequency at which the processor operates .i.e. (16KHz, 44.1 KHz etc.)
    • calculateAudioFrameVAD(pcmSample) - Process a 32 float pcm sample of getSampleLength size.

JitsiMeetJS.enumerateDevices

JitsiMeetJS.enumerateDevices(callback) - DEPRECATED. Use JitsiMeetJS.mediaDevices.enumerateDevices(callback) instead.

JitsiMeetJS.isDeviceChangeAvailable

JitsiMeetJS.isDeviceChangeAvailable(deviceType) - DEPRECATED. Use

JitsiMeetJS.mediaDevices.isDeviceChangeAvailable

JitsiMeetJS.mediaDevices.isDeviceChangeAvailable(deviceType) instead.

JitsiMeetJS.isDesktopSharingEnabled

JitsiMeetJS.isDesktopSharingEnabled() - returns true if desktop sharing is supported and false otherwise. NOTE: that method can be used after

JitsiMeetJS.init

JitsiMeetJS.init(options) is completed otherwise the result will be always null.

JitsiMeetJS.getActiveAudioDevice

JitsiMeetJS.getActiveAudioDevice() - goes through all audio devices on the system and returns information about one that is active, i.e. has audio signal. Returns a Promise resolving to an Object with the following structure:
- deviceId - string containing the device ID of the audio track found as active.
- deviceLabel - string containing the label of the audio device.

JitsiMeetJS.getGlobalOnErrorHandler

JitsiMeetJS.getGlobalOnErrorHandler() - returns function that can be used to be attached to window.onerror and if options.enableWindowOnErrorHandler is enabled returns the function used by the lib. (function(message, source, lineno, colno, error)).

JitsiMeetJS.mediaDevices

JitsiMeetJS.mediaDevices - JS object that contains methods for interaction with media devices. Following methods are available:
- isDeviceListAvailable() - returns true if retrieving the device list is supported and false - otherwise
- isDeviceChangeAvailable(deviceType) - returns true if changing the input (camera / microphone) or output (audio) device is supported and false if not. deviceType is a type of device to change. Undefined or ‘input’ stands for input devices, ‘output’ - for audio output devices.
- enumerateDevices(callback) - returns list of the available devices as a parameter to the callback function. Every device is a MediaDeviceInfo object with the following properties:
- label - the name of the device
- kind - “audioinput”, “videoinput” or “audiooutput”
- deviceId - the id of the device
- groupId - group identifier, two devices have the same group identifier if they belong to the same physical device; for example a monitor with both a built-in camera and microphone
- setAudioOutputDevice(deviceId) - sets current audio output device. deviceId - id of ‘audiooutput’ device from JitsiMeetJS.enumerateDevices(), ‘’ is for default device.
- getAudioOutputDevice() - returns currently used audio output device id, ‘’ stands for default device.
- isDevicePermissionGranted(type) - returns a Promise which resolves to true if user granted permission to media devices. type - ‘audio’, ‘video’ or undefined. In case of undefined will check if both audio and video permissions were granted.
- addEventListener(event, handler) - attaches an event handler.
- removeEventListener(event, handler) - removes an event handler.

JitsiMeetJS.events

JitsiMeetJS.events - JS object that contains all events used by the API. You will need that JS object when you try to subscribe for connection or conference events.
We have two event types - connection and conference. You can access the events with the following code JitsiMeetJS.events.<event_type>.<event_name>.
For example if you want to use the conference event that is fired when somebody leave conference you can use the following code - JitsiMeetJS.events.conference.USER_LEFT.
We support the following events:
1. conference
- TRACK_ADDED - stream received. (parameters - JitsiTrack)
- TRACK_REMOVED - stream removed. (parameters - JitsiTrack)
- TRACK_MUTE_CHANGED - JitsiTrack was muted or unmuted. (parameters - JitsiTrack)
- TRACK_AUDIO_LEVEL_CHANGED - audio level of JitsiTrack has changed. (parameters - participantId(string), audioLevel(number))
- DOMINANT_SPEAKER_CHANGED - the dominant speaker is changed. (parameters - id(string), previousSpeakers(Array<string>))
- USER_JOINED - new user joined a conference. (parameters - id(string), user(JitsiParticipant))
- USER_LEFT - a participant left conference. (parameters - id(string), user(JitsiParticipant))
- MESSAGE_RECEIVED - new text message received. (parameters - id(string), text(string), ts(number))
- DISPLAY_NAME_CHANGED - user has changed his display name. (parameters - id(string), displayName(string))
- SUBJECT_CHANGED - notifies that subject of the conference has changed (parameters - subject(string))
- LAST_N_ENDPOINTS_CHANGED - last n set was changed (parameters - leavingEndpointIds(array) ids of users leaving lastN, enteringEndpointIds(array) ids of users entering lastN)
- CONFERENCE_JOINED - notifies the local user that he joined the conference successfully. (no parameters)
- CONFERENCE_LEFT - notifies the local user that he left the conference successfully. (no parameters)
- CONFERENCE_UNIQUE_ID_SET - notifies the local user that the unique id for a meeting has been set. (parameters - meetingId(string))
- DTMF_SUPPORT_CHANGED - notifies if at least one user supports DTMF. (parameters - supports(boolean))
- USER_ROLE_CHANGED - notifies that role of some user changed. (parameters - id(string), role(string))
- USER_STATUS_CHANGED - notifies that status of some user changed. (parameters - id(string), status(string))
- CONFERENCE_FAILED - notifies that user failed to join the conference. (parameters - errorCode(JitsiMeetJS.errors.conference))
- CONFERENCE_ERROR - notifies that error occurred. (parameters - errorCode(JitsiMeetJS.errors.conference))
- KICKED - notifies that user has been kicked from the conference. (parameters - actorParticipant(JitsiParticipant), reason(string))
- PARTICIPANT_KICKED - notifies that participant has been kicked from the conference by another participant. (parameters - actorParticipant(JitsiParticipant), kickedParticipant(JitsiParticipant), reason(string))
- START_MUTED_POLICY_CHANGED - notifies that all new participants will join with muted audio/video stream (parameters - JS object with 2 properties - audio(boolean), video(boolean))
- STARTED_MUTED - notifies that the local user has started muted
- CONNECTION_STATS - DEPRECATED. Use JitsiMeetJS.events.connectionQuality.LOCAL_STATS_UPDATED instead.
- BEFORE_STATISTICS_DISPOSED - fired just before the statistics module is disposed and it’s the last chance to submit some logs to the statistics service, before it gets disconnected
- AUTH_STATUS_CHANGED - notifies that authentication is enabled or disabled, or local user authenticated (logged in). (parameters - isAuthEnabled(boolean), authIdentity(string))
- ENDPOINT_MESSAGE_RECEIVED - notifies that a new message
from another participant is received on a data channel.
- TALK_WHILE_MUTED - notifies that a local user is talking while having the microphone muted.
- NO_AUDIO_INPUT - notifies that the current selected input device has no signal.
- AUDIO_INPUT_STATE_CHANGE - notifies that the current conference audio input switched between audio input states i.e. with or without audio input.
- NOISY_MIC - notifies that the current microphone used by the conference is noisy.
- PARTICIPANT_PROPERTY_CHANGED - notifies that user has changed his custom participant property. (parameters - user(JitsiParticipant), propertyKey(string), oldPropertyValue(string), propertyValue(string))

2. `connection`
    - `CONNECTION_FAILED` - indicates that the server connection failed.
    - `CONNECTION_ESTABLISHED` - indicates that we have successfully established server connection.
    - `CONNECTION_DISCONNECTED` - indicates that we are disconnected.
    - `WRONG_STATE` - indicates that the user has performed action that can't be executed because the connection is in wrong state.

3. `detection`
    - `VAD_SCORE_PUBLISHED` - event generated by a TackVADEmitter when it computed a VAD score for an audio PCM sample.

4. `track`
    - `LOCAL_TRACK_STOPPED` - indicates that a local track was stopped. This
    event can be fired when `dispose()` method is called or for other reasons.
    - `TRACK_AUDIO_OUTPUT_CHANGED` - indicates that audio output device for track was changed (parameters - deviceId (string) - new audio output device ID).
    - `TRACK_VIDEOTYPE_CHANGED` -  indicates that the video type("camera" or "desktop") of the track was changed

5. `mediaDevices`
    - `DEVICE_LIST_CHANGED` - indicates that list of currently connected devices has changed (parameters - devices(MediaDeviceInfo[])).
    - `PERMISSION_PROMPT_IS_SHOWN` - Indicates that the environment is currently showing permission prompt to access camera and/or microphone (parameters - environmentType ('chrome'|'opera'|'firefox'|'safari'|'nwjs'|'react-native'|'android').

6. `connectionQuality`
    - `LOCAL_STATS_UPDATED` - New local connection statistics are received. (parameters - stats(object))
    - `REMOTE_STATS_UPDATED` - New remote connection statistics are received. (parameters - id(string), stats(object))

JitsiMeetJS.errors

JitsiMeetJS.errors - JS object that contains all errors used by the API. You can use that object to check the reported errors from the API
We have three error types - connection, conference and track. You can access the events with the following code JitsiMeetJS.errors.<error_type>.<error_name>.
For example if you want to use the conference event that is fired when somebody leave conference you can use the following code - JitsiMeetJS.errors.conference.PASSWORD_REQUIRED.
We support the following errors:
1. conference
- CONNECTION_ERROR - the connection with the conference is lost.
- SETUP_FAILED - conference setup failed
- AUTHENTICATION_REQUIRED - user must be authenticated to create this conference
- PASSWORD_REQUIRED - that error can be passed when the connection to the conference failed. You should try to join the conference with password.
- PASSWORD_NOT_SUPPORTED - indicates that conference cannot be locked
- VIDEOBRIDGE_NOT_AVAILABLE - video bridge issues.
- RESERVATION_ERROR - error in reservation system
- GRACEFUL_SHUTDOWN - graceful shutdown
- JINGLE_FATAL_ERROR - error in jingle (the orriginal error is attached as parameter.)
- CONFERENCE_DESTROYED - conference has been destroyed
- CHAT_ERROR - chat error happened
- FOCUS_DISCONNECTED - focus error happened
- FOCUS_DISCONNECTED - focus left the conference
- CONFERENCE_MAX_USERS - The maximum users limit has been reached
2. connection
- CONNECTION_DROPPED_ERROR - indicates that the connection was dropped with an error which was most likely caused by some networking issues.
- PASSWORD_REQUIRED - passed when the connection to the server failed. You should try to authenticate with password.
- SERVER_ERROR - indicates too many 5XX errors were received from the server.
- OTHER_ERROR - all other errors
3. track
- GENERAL - generic getUserMedia-related error.
- UNSUPPORTED_RESOLUTION - getUserMedia-related error, indicates that requested video resolution is not supported by camera.
- PERMISSION_DENIED - getUserMedia-related error, indicates that user denied permission to share requested device.
- NOT_FOUND - getUserMedia-related error, indicates that requested device was not found.
- CONSTRAINT_FAILED - getUserMedia-related error, indicates that some of requested constraints in getUserMedia call were not satisfied.
- TRACK_IS_DISPOSED - an error which indicates that track has been already disposed and cannot be longer used.
- TRACK_NO_STREAM_FOUND - an error which indicates that track has no MediaStream associated.
- SCREENSHARING_GENERIC_ERROR - generic error for screensharing.
- SCREENSHARING_USER_CANCELED - an error which indicates that user canceled screen sharing window selection dialog.

• JitsiMeetJS.errorTypes - constructors for Error instances that can be produced by library. Are useful for checks like error instanceof JitsiMeetJS.errorTypes.JitsiTrackError. Following Errors are available:

  1. JitsiTrackError - Error that happened to a JitsiTrack.

• JitsiMeetJS.logLevels - object with the log levels:

  1. TRACE
  2. DEBUG
  3. INFO
  4. LOG
  5. WARN
  6. ERROR

JitsiConnection

This objects represents the server connection. You can create new JitsiConnection object with the constructor JitsiMeetJS.JitsiConnection. JitsiConnection has the following methods:

1. JitsiConnection

JitsiConnection(appID, token, options) - constructor. Creates the conference object.

- `appID` - identification for the provider of Jitsi Meet video conferencing services. **NOTE: not implemented yet. You can safely pass `null`**
- `token` - secret generated by the provider of Jitsi Meet video conferencing services. The token will be send to the provider from the Jitsi Meet server deployment for authorization of the current client.
- `options` - JS object with configuration options for the server connection. You can change the following properties there:
    1. `serviceUrl` - XMPP service URL. For  example 'wss://server.com/xmpp-websocket' for Websocket or '//server.com/http-bind' for BOSH.
    2. `bosh` - DEPRECATED, use serviceUrl to specify either BOSH or Websocket URL.
    3. `hosts` - JS Object
        - `domain`
        - `muc`
        - `anonymousdomain`
    4. `enableLipSync` - (optional) boolean property which enables the lipsync feature. Currently works only in Chrome and is disabled by default.
    5. `clientNode` - The name of client node advertised in XEP-0115 'c' stanza
    6. xmppPing - (optional) JS Object - xmpp ping options
        - `interval` - how often to send ping requests, default: 10000 (10 seconds)
        - `timeout` - the time to wait for ping responses, default: 5000 (5 seconds)
        - `threshold` - how many ping failures will be tolerated before the connection is killed, default: 2
    7. websocketKeepAlive - (optional) Setting the interval of websocket keepalive GET requests. By default, the value is 1 minute(which means a minute + a minute of jitter).
       Used for certain deployments where a stick table entry needs to be kept alive we use those GET requests.
    8. websocketKeepAliveUrl - (optional) Specific Url to use for the websocket keepalive GET requests.

2. connect(options)

connect(options) - establish server connection
- options - JS Object with id and password properties.

3. disconnect

disconnect() - destroys the server connection

4. initJitsiConference

initJitsiConference(name, options) - creates new JitsiConference object.
- name - the name of the conference
- options - JS object with configuration options for the conference. You can change the following properties there:
- recordingType - the type of recording to be used
- callStatsID - callstats credentials
- callStatsSecret - callstats credentials
- enableTalkWhileMuted - boolean property. Enables/disables talk while muted detection, by default the value is false/disabled.
- ignoreStartMuted - ignores start muted events coming from jicofo.
- startSilent - enables silent mode, will mark audio as inactive will not send/receive audio
- confID - Used for statistics to identify conference, if tenants are supported will contain tenant and the non lower case variant for the room name.
- siteID - (optional) Used for statistics to identify the site where the user is coming from, if tenants are supported it will contain a unique identifier for that tenant. If not provided, the value will be infered from confID
- statisticsId - The id to be used as stats instead of default callStatsUsername.
- statisticsDisplayName - The display name to be used for stats, used for callstats.
- focusUserJid - The real JID of focus participant - can be overridden here
- enableNoAudioDetection
- enableNoisyMicDetection
- enableRemb
- enableTcc
- useRoomAsSharedDocumentName
- channelLastN
- startBitrate
- stereo
- forceJVB121Ratio - “Math.random() < forceJVB121Ratio” will determine whether a 2 people conference should be moved to the JVB instead of P2P. The decision is made on the responder side, after ICE succeeds on the P2P connection.
- hiddenDomain
- startAudioMuted
- startVideoMuted
- enableLayerSuspension - if set to ‘true’, we will cap the video send bitrate when we are told we have not been selected by any endpoints (and therefore the non-thumbnail streams are not in use).
- deploymentInfo
- shard
- userRegion
- p2p - Peer to peer related options
- enabled - enables or disable peer-to-peer connection, if disabled all media will be routed through the Jitsi Videobridge.
- stunServers - list of STUN servers e.g. { urls: 'stun:meet-jit-si-turnrelay.jitsi.net:443' }
- backToP2PDelay - a delay given in seconds, before the conference switches back to P2P, after the 3rd participant has left the room.
- disabledCodec - the mime type of the code that should not be negotiated on the peerconnection.
- preferredCodec the mime type of the codec that needs to be made the preferred codec for the connection.
- rttMonitor
- enabled
- initialDelay
- getStatsInterval
- analyticsInterval
- stunServers
- e2eping
- pingInterval
- abTesting - A/B testing related options
- enableSuspendVideoTest
- testing
- p2pTestMode
- octo
- probability

    **NOTE: if 4 and 5 are set the library is going to send events to callstats. Otherwise the callstats integration will be disabled.**

5. addEventListener

addEventListener(event, listener) - Subscribes the passed listener to the event.
- event - one of the events from JitsiMeetJS.events.connection object.
- listener - handler for the event.

6. removeEventListener

removeEventListener(event, listener) - Removes event listener.
- event - the event
- listener - the listener that will be removed.

7. addFeature

addFeature - Adds new feature to the list of supported features for the local participant
- feature - string, the name of the feature
- submit - boolean, default false, if true - the new list of features will be immediately submitted to the others.

8. removeFeature

removeFeature - Removes a feature from the list of supported features for the local participant
- feature - string, the name of the feature
- submit - boolean, default false, if true - the new list of features will be immediately submitted to the others.

JitsiConference

The object represents a conference. We have the following methods to control the conference:

1. join

join(password) - Joins the conference
- password - string of the password. This parameter is not mandatory.

2. leave

leave() - leaves the conference. Returns Promise.

3. myUserId

myUserId() - get local user ID.

4. getLocalTracks

getLocalTracks() - Returns array with JitsiTrack objects for the local streams.

5. addEventListener

addEventListener(event, listener) - Subscribes the passed listener to the event.
- event - one of the events from JitsiMeetJS.events.conference object.
- listener - handler for the event.

6. removeEventListener

removeEventListener(event, listener) - Removes event listener.
- event - the event
- listener - the listener that will be removed.

7. on

on(event, listener) - alias for addEventListener

8. off

off(event, listener) - alias for removeEventListener

9. sendTextMessage

sendTextMessage(text) - sends the given string to other participants in the conference.

10. setDisplayName

setDisplayName(name) - changes the display name of the local participant.
- name - the new display name.

11. sendCommand

sendCommand(name, values) - sends user defined system command to the other participants
- name - the name of the command.
- values - JS object. The object has the following structure:

            {


                value: the_value_of_the_command,


                attributes: {}, // map with keys the name of the attribute and values - the values of the attributes.


                children: [] // array with JS object with the same structure.
            }

NOTE: When you use that method the passed object will be added in every system message that is sent to the other participants. It might be sent more than once.

12. sendCommandOnce

sendCommandOnce(name, values) - Sends only one time a user defined system command to the other participants

13. removeCommand

removeCommand(name) - removes a command for the list of the commands that are sent to the ther participants
- name - the name of the command

14. addCommandListener

addCommandListener(command, handler) - adds listener
- command - string for the name of the command
- handler(values) - the listener that will be called when a command is received from another participant.

15. removeCommandListener

removeCommandListener(command) - removes the listeners for the specified command
- command - the name of the command

16. addTrack

addTrack(track) - Adds JitsiLocalTrack object to the conference. Throws an error if adding second video stream of the same videoType. camera and desktop are considered as two separate video sources. Therefore, when adding a video source (camera or desktop) for the first time to the conference, addTack needs to be called and after that only replaceTrack needs to be used to replace the existing track with another track of the same video type or for removing it from the conference. Returns a promise.
- track - the JitsiLocalTrack

17. removeTrack

removeTrack(track) - Removes JitsiLocalTrack object to the conference. Returns Promise. This does not fire TRACK_REMOVED event anymore on the remote end. The same SSRC will be re-used when another track of the same kind is added back to the conference to keep signaling messages to a minimum.
- track - the JitsiLocalTrack

18. isDTMFSupported

isDTMFSupported() - Check if at least one user supports DTMF.

19. getRole

getRole() - returns string with the local user role (“moderator” or “none”)

20. isModerator

isModerator() - checks if local user has “moderator” role

21. lock

lock(password) - set password for the conference; returns Promise
- password - string password

Note: available only for moderator

22. unlock

unlock() - unset conference password; returns Promise

Note: available only for moderator

23. kickParticipant

kickParticipant(id, reason) - Kick participant from the conference
- id - string participant id
- reason - (optional) string, default ‘You have been kicked.’ - reason of the participant to kick

24. setStartMutedPolicy

setStartMutedPolicy(policy) - make all new participants join with muted audio/video
- policy - JS object with following properties
- audio - boolean if audio stream should be muted
- video - boolean if video stream should be muted

Note: available only for moderator

25. getStartMutedPolicy

getStartMutedPolicy() - returns the current policy with JS object:
- policy - JS object with following properties
- audio - boolean if audio stream should be muted
- video - boolean if video stream should be muted

26. isStartAudioMuted

isStartAudioMuted() - check if audio is muted on join

27. isStartVideoMuted

isStartVideoMuted() - check if video is muted on join

28. sendFeedback

sendFeedback(overallFeedback, detailedFeedback) - Sends the given feedback through CallStats if enabled.
- overallFeedback - an integer between 1 and 5 indicating the user feedback
- detailedFeedback - detailed feedback from the user. Not yet used

29. setSubject

setSubject(subject) - change subject of the conference
- subject - string new subject

Note: available only for moderator

30. sendEndpointMessage

sendEndpointMessage(to, payload) - Sends message via the data channels.
- to - the id of the endpoint that should receive the message. If “” the message will be sent to all participants.
- payload - JSON object - the payload of the message.

Throws NetworkError or InvalidStateError or Error if the operation fails.

31. sendEndpointStatsMessage

sendEndpointStatsMessage(payload) - Sends a EndpointStats Colibri message on the bridge channel. This should be used instead of broadcastEndpointMessage for relaying local stats to all the remote endpoints.
- payload - JSON object - the payload of the message.

Throws NetworkError, InvalidStateError or Error if the operation fails.

32. broadcastEndpointMessage

broadcastEndpointMessage(payload) - Sends broadcast message via the datachannels.
- payload - JSON object - the payload of the message.

Throws NetworkError or InvalidStateError or Error if the operation fails.

33. replaceTrack

replaceTrack - replaces the track currently being used as the sender’s source with a new MediaStreamTrack. The new track must be of the same media kind (audio, video, etc) and switching the track should not require negotiation. replaceTrack(oldTrack, newTrack)

Throws NetworkError or InvalidStateError or Error if the operation fails.

34. setReceiverConstraints

setReceiverConstraints - set the constraints for the video that is requested from the bridge. This single message should be used in lieu of setLastN, setReceiverVideoConstraint and selectParticipants methods. These constraints are applicable to bridge connection only. More information about the signaling message format and how the Jitsi Videobridge allocates bandwidth can be found here.
- videoConstraints - Object that specifies the constraints in the following format.
javascript { 'lastN': 20, // Number of videos requested from the bridge. 'selectedSources': ['A', 'B', 'C'], // The source names of the video tracks that are prioritized first. 'onStageSources': ['A'], // The source names of the video tracks that are prioritized up to a higher resolution. 'defaultConstraints': { 'maxHeight': 180 }, // Default resolution requested for all endpoints. 'constraints': { // Source specific resolution. 'A': { 'maxHeight': 720 } } }

35. setSenderVideoConstraint

setSenderVideoConstraint(resolution) - set the desired resolution to send to JVB or the peer (180, 360, 720).

36. isHidden

isHidden - checks if local user has joined as a “hidden” user. This is a specialized role used for integrations.

37. setLocalParticipantProperty

setLocalParticipantProperty(propertyKey, propertyValue) - used to set a custom propery to the local participant(“fullName”: “Full Name”, favoriteColor: “red”, “userId”: 234). Also this can be used to modify an already set custom property.
- propertyKey - string - custom property name
- propertyValue - string - custom property value

38. getParticipants

getParticipants() - Retrieves an array of all participants in this conference.

39. revokeOwner

revokeOwner(participantId) - Revokes owner’s rights to the participant. The particiapnt that invokes the function should have same or more rights than the targeted participant. This rights check is done at the XMPP server level.

JitsiTrack

The object represents single track - video or audio. They can be remote tracks ( from the other participants in the call) or local tracks (from the devices of the local participant).
We have the following methods for controling the tracks:

1. getType

getType() - returns string with the type of the track( “video” for the video tracks and “audio” for the audio tracks)

2. mute

mute() - mutes the track. Returns Promise.

Note: This method is implemented only for the local tracks.

3. unmute

unmute() - unmutes the track. Returns Promise.

Note: This method is implemented only for the local tracks.

4. isMuted

isMuted() - check if track is muted

5. attach

attach(container) - attaches the track to the given container，将该track挂载到container（一个DOM节点）上

6. detach

detach(container) - removes the track from the container，将该track从container（一个DOM节点）上取消挂载

7. dispose

dispose() - disposes the track. If the track is added to a conference the track will be removed. Returns Promise，停止该轨道的流

Note: This method is implemented only for the local tracks.

8. getId

getId() - returns unique string for the track.

9. getParticipantId

getParticipantId() - returns id(string) of the track owner

Note: This method is implemented only for the remote tracks.

10. getSourceName

getSourceName() - returns the source name of the track.

11. setAudioOutput

setAudioOutput(audioOutputDeviceId) - sets new audio output device for track’s DOM elements. Video tracks are ignored.

12. getDeviceId

getDeviceId() - returns device ID associated with track (for local tracks only)

13. isEnded

isEnded() - returns true if track is ended

14. setEffect

setEffect(effect) - Applies the effect by swapping out the existing MediaStream on the JitsiTrack with the new

MediaStream which has the desired effect. "undefined" is passed to this function for removing the effect and for

restoring the original MediaStream on the `JitsiTrack`.

The following methods have to be defined for the effect instance.

`startEffect()` - Starts the effect and returns a new MediaStream that is to be swapped with the existing one.

`stopEffect()` - Stops the effect.

`isEnabled()` - Checks if the local track supports the effect.

Note: This method is implemented only for the local tracks.

JitsiTrackError

The object represents error that happened to a JitsiTrack. Is inherited from JavaScript base Error object,
so "name", "message" and "stack" properties are available. For GUM-related errors,
exposes additional "gum" property, which is an object with following properties:

• error - original GUM error
• constraints - GUM constraints object used for the call
• devices - array of devices requested in GUM call (possible values - “audio”, “video”, “screen”, “desktop”, “audiooutput”)