Usage:

var onBistriConferenceReady = function(){
    // your code goes here
};

Usage:

console.log( BistriConference.version );
➥ "3.0.b-647efef"

Usage:

BistriConference.init( {
    appId: "125...445",
    appKey: "edhh64...99v35",
    userName: "John Doe"
} );

Parameters:

• conf: object, JavaScript SDK settings.
  Configuration keys:
  • appId: string, your application id (mandatory).
  • appKey: string, your application key (mandatory).
  • userId: string, user ID (optional). If no ID is passed, the server will generate its own “technical” ID
  • userName: string, user display name (optional). Default value is ""
  • chromeExtensionId: string, chrome extension id for screen-sharing feature (optional). To learn how to build your own extension please read: https://github.com/bistri/screensharing-extensions/tree/master/chrome-screensharing-extension
  • firefoxExtensionId: string, firefox extension id for screen-sharing feature (optional). To learn how to build your own extension please read: https://github.com/bistri/screensharing-extensions/tree/master/firefox-screensharing-extension
  • extAutoReload: boolean, automatically reload the page once the screen-sharing extension has been installed (optional).
    Default value is true
  • autoCloseOnExit: boolean, automatically close all connections when leaving/reloading the page (optional). Default value is true
  • debug: boolean, allow to log some information (optional). Default value is false

Note: your application ID and application Key could be retreived from your developer account
➥ https://api.developers.bistri.com/admin/applications

Warning: we strongly recommend to set a referrer filter to prevent your application keys from being used by anybody. You can set it when editing your application parameters. Eg: my.domain.com* (don’t forget to add the wildcard suffix to match all your referrers)
➥ Go to applications list

Usage:

BistriConference.connect();

Event onConnected is triggered when the session has been successfully opened, otherwise event onError is triggered.

Usage:

BistriConference.disconnect();

Event onDisconnected is triggered when the session has been closed.

Note:
The maximum number of participants must be adjusted  according to the kind of calls that will be done. We strongly recommend to limit audio/video calls to 4 participants, since most of actual CPUs can’t encode/decode more than 4 video streams at a time. Pure audio conference can be limited to 10 participants. Data-channels are not concerned by those limitations.

Usage:

BistriConference.joinRoom( "my_conference_room", 4 );

Parameters:

• roomName: string, room to join.
• roomMaxCapacity: integer, max room participants (optional).

If the room doesn’t exist, it will be created.

Event onJoinedRoom is triggered when user has successfully joined the room, other members already present into the room will receive an event onPeerJoinedRoom.
Otherwise event onJoinRoomError is triggered

Usage:

BistriConference.quitRoom( "my_conference_room" );

Parameters:

• roomName: string, room to quit

Event onQuittedRoom is triggered when the user has leaved the room, other room members will receive event onPeerQuittedRoom.
Otherwise an event onQuitRoomError is triggered.

Usage:

BistriConference.call( "rfpWEk", "my_conference_room" );

Parameters:

• remoteUserId: string, ID of the remote user to call.
• roomName: string, room where the call take place.
• options: object, optional parameters.
  Available options:
  • stream: MediaStream, stream to use for the call.
  • sendonly: boolean, if true remote streams will be not accepted.
  • audio-codec: string, preferred audio codec: Opus/48000, ISAC/32000, ISAC/16000 (Chrome only).
  • audio-bitrate: integer, audio bitrate kb/s (Chrome only).
  • video-bitrate: integer, video bitrate kb/s (Chrome only).

If the user hasn’t joined the room previously, he will be automatically added to the room and event onJoinedRoom will be triggered

At this point there are 2 cases:

1 – The user you are calling is already present in the room:
the call is processed and event onStreamAdded is triggered shortly after, when the remote audio/video stream is received.

2 – The user you are calling is not present in the room yet, but he is connected to the service:
event onIncomingRequest is triggered on the remote user side to invite him to join the room for a call.

Note: to know if a remote user is connected to the service you can use the getPresence() method and check if he is online or not.

Usage:

BistriConference.openDataChannel( "rfpWEk", "chat_channel", "my_conference_room" );

Parameters:

• remoteUserId: string, ID of the remote user to call.
• label: string, data channel label.
• roomName: string, room where the call take place.

If the user hasn’t joined the room previously, he will be automatically added to the room and event onJoinedRoom will be triggered

As for the call() method there are 2 cases:

1 – The user you are calling is already present in the room:
the request is processed and event onDataChannelCreated is triggered on the local user side and event onDataChannelRequested is triggered on the remote user side.

2 – The user you are calling is not present in the room yet, but he is connected to the service:
event onIncomingRequest is triggered on the remote user side to invite him to join the room for a call.

Note: to know if a remote user is connected to the service you can use the getPresence() method and check if he is online or not.

Usage:

BistriConference.endCall( "rfpWEk", "my_conference_room" );

Parameters:

• remoteUserId: string, ID of the remote user.
• roomName: string, room where the call take place.

Event onStreamClosed is triggered on the remote side when the call ended.

Usage:

BistriConference.endCalls( "my_conference_room" );

Parameters:

• roomName: string, room where the call take place.

Event onStreamClosed is triggered on the remote side when the call ended.

Usage:

BistriConference.getMediaSources( function( sources ){ console.log( "Sources:", sources ) } );
➥ Sources: [ { facing: "", id: "96d64b0...", kind: "audio", label: "Default" }, { ... }, { ... } ]

Parameters:

• callback: function called when sources have been listed.

Usage:

BistriConference.startStream( "320x240:12", function( stream ){
    // display stream into the page
    BistriConference.attachStream( stream, document.body );
} );

Parameters:

• mediaConstraints: object or string, media constraints.
  Possible values are:
  • { video: true, audio: true }: classical constraints object.
  • pure-audio: audio only stream.
  • {video-width}x{video-height}[:{frame-rate}]: user defined resolution, frame rate is optional.
  • webcam-hd: “1280×720” webcam stream.
  • webcam-sd: “640×480” webcam stream.
  • screen-sharing: screen sharing. This feature is only available for Chrome and Firefox (desktop).
    Both Chrome and Firefox require an add-on to use the screen-sharing
    ➥ Chrome extension sources are available on our GitHub.

  ➥ Firefox extension sources are available on our GitHub.

• callback: function called when the local stream start to flow.

Usage:

BistriConference.stopStream( stream, function(){
    // remove stream from the page
    BistriConference.detachStream( stream );
} );

Parameters:

• localStream: MediaStream, stream to stop.
• callback: function called when the local stream has been stopped.

When no callback has been passed to the method to handle the stopped stream, the event onStreamClosed is triggered on the local side.

Usage:

BistriConference.attachStream( stream, document.body, {
    autoplay: true,
    fullscreen: true,
    controls: true,
    mirror: true
} );

Parameters:

• stream: MediaStream, stream to attach to the DOM node.
• node: object, DOM node in which the media will be inserted.
• options: object, display options, optional
  Available options:
  • autoplay: boolean
    Start to play automatically the stream once inserted into the page.
    Default value is set to true.
  • fullscreen: boolean
    Allow the user to switch to fullscreen mode by clicking on the video.
    Default value is set to false.
  • controls: boolean
    Display video controls.
    Default value is set to false.
  • mirror: boolean
    flip video on vertical axis (like in a mirror).
    Default value is set to false.

Usage:

BistriConference.detachStream( stream );

Parameters:

• stream: MediaStream, stream to remove.

Usage:

BistriConference.getPresence( 'rfpWEk' );

Parameters:

• remoteUserId: string, remote user ID.

Event onPresence is triggered when the presence is received.

Usage:

BistriConference.setPresence( 'away' );

Parameters:

• status: string, local user status.
  Possible values are:
  • online
  • away
  • busy
  • offline

Usage:

BistriConference.muteMicrophone( true );

Parameters:

• status: boolean, microphone status.

Usage:

BistriConference.muteSound( stream, true );

Parameters:

• stream: MediaStream, stream to mute.
• status: boolean, sound status.

Usage:

BistriConference.muteAllSounds( true );

Parameters:

• status: boolean, sound status.

Usage:

BistriConference.muteVideo( stream, true );

Parameters:

• stream: MediaStream, stream to mute.
• status: boolean, video status.

Event onStreamMuteChange is triggered on local and remote sides when the video track is un/muted.

Usage:

console.log( "microphone muted: ", BistriConference.isMicrophoneMuted() );
➥ microphone muted: true

Usage:

console.log( "all sounds muted: ", BistriConference.isAllSoundsMuted() );
➥ all sounds muted: true

Usage:

console.log( "local video muted: ", BistriConference.isVideoMuted() );
➥ all sounds muted: true

Usage:

console.log( BistriConference.getLocalStreams() );
➥ [ MediaStream, MediaStream, ... ]

Usage:

console.log( BistriConference.getRemoteStreams() );
➥ { 'St9d9JU7': MediaStream, 'xHoYffVm': MediaStream, ... }

Parameters:

• roomName: string, room name. Use this optional parameter to get the streams of a particular room.

Usage:

console.log( BistriConference.getDataChannels( roomName ) );
➥ { 'St9d9JU7': { 'chat': DataChannel, 'filetransfert': DataChannel }, ... }

Parameters:

• roomName: string, room name.

Usage:

console.log( BistriConference.getRoomMembers( roomName ) );
➥ [ { id: 'St9d9JU7', name: 'Jane Smith' }, ... ]

Parameters:

• roomName: string, room name.

Usage:

            BistriConference.addStream( 'St9d9JU7', 'my_conference_room', stream );

Parameters:

• remoteUserId: string, ID of the remote user.
• roomName: string, room where the call take place.
• stream: MediaStream, stream to add.

Event onStreamAdded is triggered on the remote user side once the stream has been added.

Usage:

BistriConference.removeStream( 'St9d9JU7', 'my_conference_room', stream );

Parameters:

• remoteUserId: string, ID of the remote user.
• roomName: string, room where the call take place.
• stream: MediaStream, stream to remove.

Event onStreamClosed is triggered on the remote user side once the stream has been removed.

Usage:

BistriConference.monitorAudioActivity( stream, function( audioLevel ){
    console.log( 'level:', audioLevel );
} );
➥ level: 34
➥ level: 67

Parameters:

• stream: MediaStream, stream to monitor.
• callback: function, executed when an audio activity is detected.

Usage:

console.log( "is connected to api server:", BistriConference.isConnected() );
➥ is connected to api server: true

Usage:

console.log( "is browser compatible:", BistriConference.isCompatible() );
➥ is browser compatible: true

Usage:

console.log( "is screen-sharing compatible:", BistriConference.isScreenSharingCompatible() );
➥ is screen-sharing compatible: true

Usage:

console.log( "plugin URL:", BistriConference.getWebRTCPluginURL() );
➥ plugin URL: https://temasys.atlassian.net/wiki/display/TWPP/WebRTC+Plugins

Usage:

console.log( "is WebRTC plugin used:", BistriConference.isWebRTCPluginUsed() );
➥ is WebRTC plugin used: true

Usage:

console.log( "is WebRTC plugin available:", BistriConference.isWebRTCPluginAvailable() );
➥ is WebRTC plugin available: true

Usage:

BistriConference.signaling.bind( 'onConnected', function( sessionData ){
    ...
} );

Parameters:

• eventName: string, event name.
• callback: function executed when the related event is triggered.

Events:

onError, onConnected, onJoinedRoom,
onJoinRoomError, onQuittedRoom, onQuitRoomError,
onPeerJoinedRoom, onPeerQuittedRoom, onDisconnected,
onIncomingRequest, onPresence, onStreamMuteChange,
onClientUpdateRequired.

Usage:

var handler = BistriConference.signaling.bind( 'onConnected', function(){...} );
...
BistriConference.signaling.unbind( handler );

Parameters:

• handler: object returned by bind() method.

Usage:

BistriConference.streams.bind( 'onStreamAdded', function( stream, id ){
    ...
} );

Parameters:

• eventName: string, event name.
• callback: function executed when the related event is triggered.

Events:

onStreamAdded, onStreamClosed, onStreamRemoved, onStreamError, onStreamStatsUpdated.

Usage:

var handler = BistriConference.streams.bind( 'onStreamAdded', function(){...} );
...
BistriConference.streams.unbind( handler );

Parameters:

• handler: object returned by bind() method.

Usage:

BistriConference.channels.bind( 'onDataChannelRequested', function( dataChannel ){
    ...
} );

Parameters:

• eventName: string, event name.
• callback: function executed when the related event is triggered.

Events:

onDataChannelCreated, onDataChannelRequested.

Usage:

var handler = BistriConference.channels.bind( 'onDataChannelRequested', function(){...} );
...
BistriConference.channels.unbind( handler );

Parameters:

• handler: object returned by bind() method.

Usage:

console.log( "data channel label:", dataChannel.label );
➥ data channel label: chat_channel

Usage:

    dataChannel.send( "my message" );

Parameters:

• message: string, message to send.

onMessage callback is invoked on the remote user side when the message is received.

Usage:

            dataChannel.close();

onClosed callback is invoked on the remote user side when the data channel is closed.

Usage:

dataChannel.onOpen = function(){
    console.log( "Data Channel open" );
};

Usage:

dataChannel.onMessage = function( event ){
    console.log( "New Message:", event.data );
};

Arguments:

• event: object, message received.

Usage:

dataChannel.onClose = function(){
    console.log( "Data Channel closed" );
};

Usage:

dataChannel.onError = function( error ){
    console.log( "Data Channel error:", error );
};

Arguments:

• error: string, error message.

Arguments:

• error: JSON, error object.
  Object detail:

  {
      "code": "xxx", // error code
      "text": "..." // error reason
  }

Error codes:

• 000: api access not authorized
• 301: no room found
• 401: failed to save user data

Arguments:

• session: JSON, session data.
  Object detail:

  {
      "clientVersion": "3.0.b-647efef", // last JavaScript SDK version available
      "id": "rfpWEk" // user session id
  }

Arguments:

• room: JSON, room data.
  Object detail:

  {
  	"room": "aUpS45g7J0w" // room id
  	"members":[ // array of remote users already connected to room
  		{
  			id: "aVlxUi", // remote user id
  			name: "Jane Doe" // remote user display name
  		},
  		...
  	],
  }

Arguments:

• error: JSON, error data.
  Object detail:

  {
  	"code": "xxx", // error code
  	"text": "..." // error reason
  }

Error codes:

• 101: user is already present in room
• 102: the room reached its max capacity
• 103: the room doesn\’t exists
• 104: user is not present in room
• 105: forbidden chars in room name
• 106: maximum simultaneous joined rooms reached

Arguments:

• room: JSON, room data.
  Object detail:

  {
  	"room": "aUpS45g7J0w" // room id
  }

Arguments:

• error: JSON, error data.
  Object detail:

  {
  	"code": "xxx", // error code
  	"text": "..." // error reason
  }

Error codes:

• 201: no room found

Arguments:

• peer: JSON, peer data.
  Object detail:

  {
  	"room":"aUpS45g7J0w", // room id
  	"name":"John Doe", // peer display name
  	"pid":"rfpWEk" // peer id
  }

Arguments:

• peer: JSON, peer data.
  Object detail:

  {
  	"room":"aUpS45g7J0w", // room id
  	"pid":"rfpWEk" // peer id
  }

Arguments:

• request: JSON, request data.
  Object detail:

  {
  	"room":"aUpS45g7J0w", // room id
  	"pid":"rfpWEk", // peer id
          "event": "call" // request: "call" for a call request, "call-stop": to end a call, "datachannel": for a datachannel request
  }

Arguments:

• presence: JSON, presence data.
  Object detail:

  {
  	id: "rfpWEk", // contact id
  	presence: "online" // contact presence status
  }

Arguments:

• version: JSON, version data.
  Object detail:

  {
  	clientVersion: "3.0.b-647efef", // new client version
  }

Arguments:

• stream: MediaStream, remote stream.
• id: string, remote user id.

Arguments:

• stream: MediaStream, remote stream.
• id: string, remote user id.

Arguments:

• stream: MediaStream, remote stream.
• id: string, remote user id.

Arguments:

• error: Object, error information.

Arguments:

• streamStatus: Boolean, video stream status, true if mute.
• pid: String, peer id.

Arguments:

• stats: JSON, stats data.
  Object detail:

  {
  	"local":{ ... }, // sent stream stats
  	"remote":{ ... } // received stream stats
  }

• id: string, remote user id.

Arguments:

• dataChannel: object, Data Channel. More about Data Channel
• id: string, remote user id.

Arguments:

• dataChannel: object, Data Channel. More about Data Channel
• id: string, remote user id.