Table of Contents

Example of video conference

This example can be used to organize video conference for three participants on Web Call Server.
Each participant can publish a stream of one of the following types

WebRTC
RTMFP
RTMP

WebRTC stream

On the screenshot below the participant is connected, publishing a stream and playing streams from the other two participants.

Image RemovedImage Added

Three videos are played on the page

video from the camera of this participant (Alice) - the lower one
videos from the other participants (Bob and Cindy)

...

Code of the example

The path to the source code of the example on WCS server is:

...

Here host is the address of the WCS server.

...

Analyzing the code

To analyze the code, let's take the version of file conference.js with hash 456b1c790771d4, which is available here and can be downloaded with corresponding build 2.0.201218.

Script for video conference uses roomApi designed for video chats, video conferences, webinars and other applications that involve presence of users in one virtual "room". To use RoomApi, the script flashphoner-room-api.js should be included

...

1. Initialization of the API.

Flashphoner.init() code

Code Block

language	js
theme	RDark

Flashphoner.init();

2. Connection to server.RoomApi.connectCamera and microphone access request

Flashphoner.getMediaAccess() code

Code Block

language	js
theme	RDark

connection   = RoomApiFlashphoner.connect({urlServer: url, username: username}).on(SESSION_STATUS.FAILED, function(session){
getMediaAccess(null, localDisplay).then(function() {
      setStatus('#status', session.status())  createConnection(url, username);
    onLeft();
}).on(SESSION_STATUS.DISCONNECTED, catch(function(sessionerror) {
    setStatus('#status', session.status());
    onLeft();
}).on(SESSION_STATUS.ESTABLISHED, function(session) {
    setStatus('#status', session.status())    console.error("User not allowed media access: "+error);
        $("#failedInfo").text("User not allowed media access. Refresh the page");
    joinRoom    onLeft();
    });

3. Receiving the event confirming successful connectionConnectionStatusEvent ESTABLISHED Connection to server.

RoomApi.connect() code

Code Block

language	js
theme	RDark

function createConnection(url, username) {
    connection = RoomApi.connect({urlServer: url, username: username}).on(SESSION_STATUS.FAILED, function(session){
    ...
}).on(SESSION_STATUS.DISCONNECTED, function(session) {
    ...
}).on(SESSION_STATUS.ESTABLISHED, function(session) {
    setStatus('#status', session.status());});
}

4. Receiving the event confirming successful connection

ConnectionStatusEvent ESTABLISHED code

Code Block

language	js
theme	RDark

connection = RoomApi.connect({urlServer: url, username: username}).on(SESSION_STATUS.FAILED, function(session){
    joinRoom();...
});

4. Joining a conference.

connection.join() code

To join, name of the conference room is passed to the method. (The name can be specified as parameter in the URL of the client page; otherwise, random name will be generated.)

Code Block

language	js
theme	RDark

connection.join({name: getRoomName(), record: isRecord()}).on(ROOM_EVENT.STATE, function(room){
    ....on(SESSION_STATUS.DISCONNECTED, function(session) {
    ...
}).on(SESSION_STATUS.ESTABLISHED, function(session) {
    setStatus('#status', session.status());
    joinRoom();
});

5. Receiving the event describing chat room state

RoomStatusEvent STATE code

On this event:

...

Joining a conference.

connection.join() code

To join, name of the conference room is passed to the method. (The name can be specified as parameter in the URL of the client page; otherwise, random name will be generated.)

Code Block

language	js
theme	RDark

connection.join({name: getRoomName(), record: isRecord()}).on(ROOM_EVENT.STATE, function(room){
    var participants = room.getParticipants();
    console.log("Current number of participants in the room: " + participants.length);
    if (participants.length >= _participants...
});

6. Receiving the event describing chat room state

RoomStatusEvent STATE code

On this event:

the length of the array of Participant objects returned by method Room.getParticipants() is determined to get the number of already connected participants
if the maximum allowed number of participants had already been reached, the user leaves the "room" (line 85)
otherwise, the user starts publishing video stream

Code Block

language	js
theme	RDark

connection.join({name: getRoomName(), record: isRecord()}).on(ROOM_EVENT.STATE, function(room){
    var participants = room.getParticipants();
    console.log("Current number of participants in the room: " + participants.length);
    if (participants.length >= _participants) {
        console.warn("Current room is full");
        $("#failedInfo").text("Current room is full.");
        room.leave().then(onLeft, onLeft);
        return false;
    }
    setInviteAddress(room.name());
    if (participants.length > 0) {
        var chatState = "participants: ";
        for (var i = 0; i < participants.length; i++) {
            installParticipant(participants[i]);
            chatState += participants[i].name();
         if (i != participants.length - 1) {
            chatState += ",";
         }
     }
         addMessage("chat", chatState);
     } else {
         addMessage("chat", " room is empty");
     }
     publishLocalMedia(room);
     onJoined(room);
}).on(ROOM_EVENT.JOINED, function(participant){
     ...
}).on(ROOM_EVENT.LEFT, function(participant){
     ...
}).on(ROOM_EVENT.PUBLISHED, function(participant){
     ...
}).on(ROOM_EVENT.FAILED, function(room, info){
     ...
}).on(ROOM_EVENT.MESSAGE, function(message){
     ...
});

7. Low Power Mode checking before publishing on mobile device

Flashphoner.playFirstVideo() code

Code Block

language	js
theme	RDark

    if (Browser.isSafariWebRTC()) {
        var display = document.getElementById("localDisplay");
        Flashphoner.playFirstVideo(display, true, PRELOADER_URL).then(function() {
            publishLocalMedia(room);
        }).catch(function (error) {
            console.log("Can't atomatically publish local stream, use Publish button");
            for (var i = 0; i < display.children.length; i++) {
                if (display.children[i]) {
                    console.log("remove cached instance id " + display.children[i].id);
                    display.removeChild(display.children[i]);
                }
            }
            onMediaStopped(room);
        });
    }

8. Video streaming.

room.publish() code

<div> element 'localDisplay', in which video from camera will be displayed, is passed to the room.publish() method

Code Block

language	js
theme	RDark

    room.publish({
        display: display,
        constraints: constraints,
        record: false,
        receiveVideo: false,
        receiveAudio: false
    }).on(STREAM_STATUS.FAILED, function (stream) {
        console.warn("Local stream failed!");
        setStatus("#localStatus", stream.status());
        onMediaStopped(room);
    }).on(STREAM_STATUS.PUBLISHING, function (stream) {
        setStatus("#localStatus", stream.status());
        onMediaPublished(stream);
    }).on(STREAM_STATUS.UNPUBLISHED, function(stream) {
        setStatus("#localStatus", stream.status());
        onMediaStopped(room);
    });

9. Receiving the event notifying that other participant joined to the room

RoomStatusEvent JOINED code

Code Block

language	js
theme	RDark

connection.join({name: getRoomName(), record: isRecord()}).on(ROOM_EVENT.STATE, function(room){
     ...
}).on(ROOM_EVENT.JOINED, function(participant){
     installParticipant(participant);
     addMessage(participant.name(), "joined");
}).on(ROOM_EVENT.LEFT, function(participant){
     ...
}).on(ROOM_EVENT.PUBLISHED, function(participant){
     ...
}).on(ROOM_EVENT.FAILED, function(room, info){
     ...
}).on(ROOM_EVENT.MESSAGE, function(message){
     ...
});

10. Receiving the event notifying that other participant published video stream

RoomStatusEvent PUBLISHED code

Code Block

language	js
theme	RDark

connection.join({name: getRoomName(), record: isRecord()}).on(ROOM_EVENT.STATE, function(room){
     ...
}).on(ROOM_EVENT.JOINED, function(participant){
     ...
}).on(ROOM_EVENT.LEFT, function(participant){
     ...
}).on(ROOM_EVENT.PUBLISHED, function(participant){
     playParticipantsStream(participant);
}).on(ROOM_EVENT.FAILED, function(room, info){
     ...
}).on(ROOM_EVENT.MESSAGE, function(message){
     ...
});

11. Low Power Mode checking before playback on mobile device

Flashphoner.playFirstVideo() code

Code Block

language	js
theme	RDark

                if (Browser.isSafariWebRTC()) {
                    Flashphoner.playFirstVideo(pDisplay, false, PRELOADER_URL).then(function() {
                        playStream(participant, pDisplay);
                    }).catch(function (error) {
                        // Low Power Mode detected, user action is needed to start playback in this mode #WCS-2639
                        console.log("Can't atomatically play participant" + participant.name() + " stream, use Play button");
                        for (var i = 0; i < pDisplay.children.length; i++) {
        console.warn("Current room is full");
        $("#failedInfo").text("Current room is full.");
       if room.leave().then(onLeft, onLeft);(pDisplay.children[i]) {
        return false;
    }
    setInviteAddress(room.name());
    if (participants.length > 0) {
        var chatState = "participants: ";
console.log("remove cached instance id " + pDisplay.children[i].id);
          for  (var i = 0; i < participants.length; i++) {
            installParticipant(participantspDisplay.removeChild(pDisplay.children[i]);
            chatState += participants[i].name();
         if (i != participants.length - 1) {}
            chatState  += ",";
         }
             }
          addMessage("chat", chatState onParticipantStopped(participant);
     } else {
         addMessage("chat", " room is empty"});
     }
      publishLocalMedia(room);
     onJoined(room);
}).on(ROOM_EVENT.JOINED, function(participant){
     ...
}).on(ROOM_EVENT.LEFT, function(participant){
     ...
}).on(ROOM_EVENT.PUBLISHED, function(participant){
     ...
}).on(ROOM_EVENT.FAILED, function(room, info){
     ...
}).on(ROOM_EVENT.MESSAGE, function(message){
     ...
});

6. Video streaming.

room.publish() code

<div> element 'localDisplay', in which video from camera will be displayed, is passed to the room.publish() method

Code Block

language	js
theme	RDark

    room.publish({
}

12. Playback of video stream.

participant.play() code

The following parameters are passed to the method:

display - div element to display remote video;
options.unmutePlayOnStart - enables (by default) or disables (for example, in Android Edge) automatic audio unmuting while starting playback;
options.constraints.audio.deviceId - audio output device Id (the example uses default audio device)

A user must click a button if automatic audio playback is disabled

Code Block

language	js
theme	RDark

        var options = {
            unmutePlayOnStart: true,
            constraints: {
                displayaudio: display,
{
             constraints       deviceId: constraints,
'default'
                }
  record: false,
        receiveVideo: false,}
        receiveAudio: false};
    }).on(STREAM_STATUS.FAILED, function (stream) {
 // Leave participant stream muted in  console.warn("Local stream failed!");Android Edge browser #WCS-3445
        setStatus("#localStatus", stream.statusif (Browser.isChromiumEdge() && Browser.isAndroid()); {
        onMediaStopped(room);
    }).on(STREAM_STATUS.PUBLISHING, function (stream) {options.unmutePlayOnStart = false;
        setStatus("#localStatus", stream.status());}
        onMediaPublishedparticipant.getStreams(stream);
    })[0].play(display, options).on(STREAM_STATUS.UNPUBLISHEDPLAYING, function (streamplayingStream) {
        setStatus("#localStatus", stream.status());
   var video    onMediaStopped(room);
    });

7. Receiving the event notifying that other participant joined to the room

RoomStatusEvent JOINED code

Code Block

language	js
theme	RDark

connection.join({name: getRoomName(), record: isRecord()}).on(ROOM_EVENT.STATE, function(room){
     ...
}).on(ROOM_EVENT.JOINED, function(participant){
     installParticipant(participant);
     addMessage(participant.name(), "joined");
}).on(ROOM_EVENT.LEFT, function(participant){
     ...
}).on(ROOM_EVENT.PUBLISHED, function(participant){
     ...
}).on(ROOM_EVENT.FAILED, function(room, info){
     ...
}).on(ROOM_EVENT.MESSAGE, function(message){
     ...
});

8. Receiving the event notifying that other participant published video stream

RoomStatusEvent PUBLISHED code

Code Block

language	js
theme	RDark

connection.join({name: getRoomName(), record: isRecord()}).on(ROOM_EVENT.STATE, function(room){
     ...
}).on(ROOM_EVENT.JOINED, function(participant){
     ...
}).on(ROOM_EVENT.LEFT, function(participant){
     ...
}).on(ROOM_EVENT.PUBLISHED, function(participant){
     playParticipantsStream(participant);
}).on(ROOM_EVENT.FAILED, function(room, info){
     ...
}).on(ROOM_EVENT.MESSAGE, function(message){
     ...
});

9. Playback of video stream.

participant.play() code
<div> element, in which the video will be displayed, is passed to the participant.play() method.

Code Block

language	js
theme	RDark

function playParticipantsStream(participant) {
    if (participant.play) {
= document.getElementById(playingStream.id())
            video.addEventListener('resize', function (event) {
                resizeVideo(event.target);
            });
            // Set up participant Stop/Play button
            if (playBtn) {
                $(playBtn).text("Stop").off('click').click(function() {
                    $(this).prop('disabled', true);
                    playingStream.stop();
                }).prop('disabled', false);
            }
            // Set up participant audio toggle button #WCS-3445
            if (audioBtn) {
                $("[id$=Name]").each(function (index, valueaudioBtn).text("Audio").off('click').click(function() {
                    if ($playingStream.isRemoteAudioMuted(value).text() {
 == participant.name()) {
                    var p = valueplayingStream.id.replace('Name', ''unmuteRemoteAudio();
                var  pDisplay = p} + 'Display';
else {
                    participant.play(document.getElementById(pDisplay)).on(STREAM_STATUS.PLAYING, function (playingStream) {
    playingStream.muteRemoteAudio();
                    }
                document.getElementById(playingStream.id()).addEventListener('resize', function (event) {
}).prop('disabled', false);
            }
            // Start participant audio state checking timer #WCS-3445
            resizeVideo(event.targetparticipantState.startMutedCheck(playingStream);
        }).on(STREAM_STATUS.STOPPED, function () {
            }onParticipantStopped(participant);
        }).on(STREAM_STATUS.FAILED, function       });() {
            }onParticipantStopped(participant);
        });
    }
}

...

13. Stop of streaming.

stream.stop() code

Code Block

language	js
theme	RDark

function onMediaPublished(stream) {
    $("#localStopBtn").text("Stop").off('click').click(function(){
        $(this).prop('disabled', true);
        stream.stop();
    }).prop('disabled', false);
    ...
}

1114. Receiving Receiving the event confirming successful streaming stop

StreamStatusEvent UNPUBLISHED code

Code Block

language	js
theme	RDark

room.publish({
    display: display,
    constraints: constraints,
    record: false,
    receiveVideo: false,
    receiveAudio: false
}).on(STREAM_STATUS.FAILED, function (stream) {
    ...
}).on(STREAM_STATUS.PUBLISHING, function (stream) {
    ...
}).on(STREAM_STATUS.UNPUBLISHED, function(stream) {
    setStatus("#localStatus", stream.status());
    onMediaStopped(room);
});

1215. Leaving conference room

room.leave() code

Code Block

language	js
theme	RDark

function onJoined(room) {
    $("#joinBtn").text("Leave").off('click').click(function(){
        $(this).prop('disabled', true);
        room.leave().then(onLeft, onLeft);
    }).prop('disabled', false);
    ...
}

1316. Mute/unmute audio and video of the published stream

stream.isAudioMuted(), stream.isVideoMuted(), stream.muteAudio(), stream.unmuteAudio(), stream.muteVideo(), stream.unmuteVideo() code

Code Block

language	js
theme	RDark

function onMediaPublished(stream) {
    ...
    $("#localAudioToggle").text("Mute A").off('click').click(function(){
        if (stream.isAudioMuted()) {
            $(this).text("Mute A");
            stream.unmuteAudio();
        } else {
            $(this).text("Unmute A");
            stream.muteAudio();
        }
    }).prop('disabled', false);
    $("#localVideoToggle").text("Mute V").off('click').click(function() {
        if (stream.isVideoMuted()) {
            $(this).text("Mute V");
            stream.unmuteVideo();
        } else {
            $(this).text("Unmute V");
            stream.muteVideo();
        }
    }).prop('disabled',false);
}

1417. Sending text message.

participant.sendMessage() code

When Send button is clicked,

...

Space shortcuts

Page tree

Versions Compared

Old Version 5

New Version Current

Key

Example of video conference

Code of the example

Analyzing the code

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 5

New Version Current

Key

Example of video conference

Code of the example

Analyzing the code