Table of Contents

Пример видеоконференции

Данный пример может использоваться для организации видеоконференции для трех участников на Web Call Server
Участник видеоконференции может публиковать следующие типы потоков

...

WebRTC поток

На скриншоте ниже представлен пример клиента участника конференции, к которой присоединились два других участника.

Image RemovedImage Added

На странице вопроизводятся воспроизводятся три видео

нижнее - видео с камеры данного участника (Alice)
два верхних - видео от других двух участников (Bob и Cindy)

В поле Invite указана ссылка с именем "комнаты" конференции.

Код примера

Код данного примера находится на WCS-сервере по следующему пути:

...

Здесь host - адрес WCS-сервера.

Работа с кодом примера

Для разбора кода возьмем версию файла conference.js с хешем 66cc393хешем 90771d4, которая находится здесь и доступна для скачивания в соответствующей сборке 2.0.5.28.2753.133218.

Скрипт конференции использует roomApiRoomApi, предназначенное для видеочатов, конференций, вебинаров и других приложений, которые предполагают нахождение пользователей в одной виртуальной "комнате".

При подключении пользователя к конференции, используется метод roomApi.connect(), в отличии от прямого подключения к серверу методом createSession().
При присоединении к новой "комнате" методом roomApi.join(), создается объект room для работы с этой "комнатой". Для работы с участниками конференции используются объекты Participant.

Все события, происходящие в "комнате" (присоединение/выход пользователя, отправленные сообщения), транслируются другим участникам, подключенным к этой "комнате".

Например, в следующем коде подключаемся к "комнате" и запрашиваем список других участников:

Code Block

language	js
theme	RDark

connection.join({name: getRoomName()}).on(ROOM_EVENT.STATE, function(room){
var participants = room.getParticipants();
...

Здесь получаем данные другого участника, который только что присоединился:

Code Block

language	js
theme	RDark

}).on(ROOM_EVENT.JOINED, function(participant){
installParticipant(participant);
addMessage(participant.name(), "joined");
...

...

Flashphoner.init() code

Code Block

language	js
theme	RDark

Flashphoner.init({flashMediaProviderSwfLocation: '../../../../media-provider.swf'});

2. Подключение к серверу.

Flashphoner.roomApi.connect() code

...

Для того, чтобы использовать RoomApi, необходимо подключить скрипт flashphoner-room-api.js

Code Block

language	xml
theme	RDark

    <script type="text/javascript" src="../../../../flashphoner-room-api.js"></script>

При этом для обращения к стандартным методам Flashphoner необходимо использовать объект RoomApi.sdk

Code Block

language	js
theme	RDark

var Flashphoner = RoomApi.sdk;
...
Flashphoner.init();

При подключении пользователя к конференции, используется метод RoomApi.connect(), в отличии от прямого подключения к серверу методом createSession().

При присоединении к новой "комнате" методом connection.join(), создается объект room для работы с этой "комнатой". Для работы с участниками конференции используются объекты Participant.

Все события, происходящие в "комнате" (присоединение/выход пользователя, отправленные сообщения), транслируются другим участникам, подключенным к этой "комнате". Например, в следующем коде подключаемся к "комнате" и запрашиваем список других участников:

Code Block

language	js
theme	RDark

connection = Flashphoner.roomApi.connect.join({urlServername: url, username: usernamegetRoomName()}).on(SESSIONROOM_STATUSEVENT.FAILEDSTATE, function(sessionroom){
var participants   setStatus('#status', session.status());
    onLeft();
= room.getParticipants();
...

Здесь получаем данные другого участника, который только что присоединился:

Code Block

language	js
theme	RDark

}).on(SESSIONROOM_STATUSEVENT.DISCONNECTEDJOINED, function(sessionparticipant) {
    setStatus('#status', session.status());
    onLeft();
}).on(SESSION_STATUS.ESTABLISHED, function(session) {
    setStatus('#status', session.status());
    joinRoom();
});

3. Получение от сервера события, подтверждающего успешное соединение

...

installParticipant(participant);
addMessage(participant.name(), "joined");
...

1. Инициализация API.

Flashphoner.init() code

Code Block

language	js
theme	RDark

Flashphoner.init();

2. Запрос доступа к камере и микрофону

Flashphoner.getMediaAccess() code

Code Block

language	js
theme	RDark

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

43. Присоединение Подключение к конференциисерверу.

connectionRoomApi.joinconnect() code

При присоединении передается имя "комнаты" конференции (берется из параметра в URL страницы клиента, или генерируется случайное имя).

Code Block

language	js
theme	RDark

function createConnection(url, username) {
    connection = RoomApi.joinconnect({nameurlServer: url, username: getRoomName()username}).on(ROOMSESSION_EVENTSTATUS.STATEFAILED, function(roomsession){
     .   ...
    });
}

54. Получение от сервера события, описывающего статус комнаты

RoomStatusEvent STATE code

При получении данного события:

определяется количество участников конференции с помощью метода room.getParticipants(), который возвращает массив объектов participant,
если к конференции уже присоединилось максимально допустимое количество участников, производится выход из "комнаты" при помощи room.leave()
если количество участников меньше максимально допустимого, начинается публикация видеопотока

...

language	js
theme	RDark

...

подтверждающего успешное соединение

ConnectionStatusEvent ESTABLISHED code

Code Block

language	js
theme	RDark

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());
    joinRoom();
});

5. Присоединение к конференции.

connection.join() code

При присоединении передается имя "комнаты" конференции (берется из параметра в URL страницы клиента, или генерируется случайное имя).

Code Block

language	js
theme	RDark

connection.join({name: getRoomName(), record: isRecord()}).on(ROOM_EVENT.STATE, function(room){
    ...
});

6. Получение от сервера события, описывающего статус комнаты

RoomStatusEvent STATE code

При получении данного события:

определяется количество участников конференции с помощью метода room.getParticipants(), который возвращает массив объектов participant,
если к конференции уже присоединилось максимально допустимое количество участников, производится выход из "комнаты" при помощи room.leave()
если количество участников меньше максимально допустимого, начинается публикация видеопотока

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 при публикации на мобильном устройстве

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. Публикация видеопотока.

room.publish() code

При публикации передаем div-элемент, в котором будет отображаться видео с камеры.

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. Получение от сервера события, сигнализирующего о присоединении пользователя к чат-комнате

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. Получение от сервера события, сигнализирующего о публикации видеопотока другим участником

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 при воспроизведении на мобильном устройстве

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("CurrentCan't numberatomatically of participants in the room: play participant" + participantsparticipant.lengthname();
 + " stream, if (participants.length >= _participants) {
use Play button");
         console.warn("Current room is full");
        $("#failedInfo").text("Current room is full.");
 for (var i = 0; i < roompDisplay.leave().then(onLeft, onLeft);children.length; i++) {
        return false;
            }
    setInviteAddress(room.name());
    if (participants.length > 0pDisplay.children[i]) {
        var chatState = "participants: ";
        for (var i = 0; i < participants.length; i++) {
      console.log("remove cached instance id "  installParticipant(participants+ pDisplay.children[i].id);

                    chatState += participants[i].name();
         if pDisplay.removeChild(pDisplay.children[i]);
 != participants.length - 1) {
            chatState += ",";
         }
     }
         addMessage("chat", chatState);
     } else {
  }
       addMessage("chat", " room is empty");
     }
     publishLocalMedia(room);
     onJoinedonParticipantStopped(roomparticipant);
}).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){
          }

12. Воспроизведение видеопотока.

...

6. Публикация видеопотока.

room.publish() code

При публикации передаем div-элемент, в котором будет отображаться видео с камеры.

participant.play() code

В метод передаются следующие параметры:

display - div-элемент, в котором будет отображаться видео;
options.unmutePlayOnStart - параметр, разрешающий (по умолчанию) или запрещающий (например, в Android Edge) автоматическое включение звука при проигрывании
options.constraints.audio.deviceId - устройство вывода звука (в примере указано устройство по умолчанию)

Если автоматическое включение звука запрещено, пользователь должен нажать кнопку для включения звука

Code Block

language	js
theme	RDark

        room.publish(var options = {
        display    unmutePlayOnStart: displaytrue,
            constraints: constraints,{
        record: false,
        audio: {
    receiveVideo: false,
        receiveAudio: false
    }).on(STREAM_STATUS.FAILED, function (stream) {
deviceId: 'default'
         console.warn("Local stream failed!");
     }
   setStatus("#localStatus", stream.status());
        onMediaStopped(room);}
     }).on(STREAM_STATUS.PUBLISHING, function (stream) {};
        setStatus("#localStatus", stream.status());
   // Leave participant stream muted in Android Edge browser #WCS-3445
     onMediaPublished(stream);
   if })(Browser.on(STREAM_STATUS.UNPUBLISHED, function(streamisChromiumEdge() && Browser.isAndroid()) {
         setStatus("#localStatus", stream.status())   options.unmutePlayOnStart = false;
        onMediaStopped(room);}
     });

7. Получение от сервера события, сигнализирующего о присоединении пользователя к чат-комнате

RoomStatusEvent JOINED code

Code Block

language	js
theme	RDark

connection.join({name: getRoomName()}).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){
     ...
});

...

RoomStatusEvent PUBLISHED code

Code Block

language	js
theme	RDark

connection.join({name: getRoomName()}).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. Воспроизведение видеопотока.

participant.play() code

Параметром передается div-элемент, в котором будет отображаться видео.

Code Block

language	js
theme	RDark

function playParticipantsStream(participant) {
    if (participant.play) {   participant.getStreams()[0].play(display, options).on(STREAM_STATUS.PLAYING, function (playingStream) {
            var video = 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) {
                $(audioBtn).text("Audio").off('click').click(function() {
                    if (playingStream.isRemoteAudioMuted()) {
                        playingStream.unmuteRemoteAudio();
        $("[id$=Name]").each(function (index, value) {
         } else {
 if ($(value).text() == participant.name()) {
                var p = valueplayingStream.id.replace('Name', ''muteRemoteAudio();
                var pDisplay = p + 'Display';}
                participant.play(document.getElementById(pDisplay)).on(STREAM_STATUS.PLAYING, function (playingStream) {}).prop('disabled', false);
              }
      document.getElementById(playingStream.id()).addEventListener('resize', function (event) {
   // 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. Остановка публикации видеопотока.

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. Получение от сервера события, подтверждающего остановку публикации.

StreamStatusEvent UNPUBLISHED code

Code Block

language	js
theme	RDark

room.publish(document.getElementById("localDisplay"){
    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. Выход из комнаты конференции.

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. Включение/выключение аудио и видео для публикуемого потока.

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. Отправка текстового сообщения.

participant.sendMessage() code

При нажатии на кнопку Send

...

Space shortcuts

Page tree

Versions Compared

Old Version 8

New Version Current

Key

Пример видеоконференции

Код примера

Работа с кодом примера

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 8

New Version Current

Key

Пример видеоконференции

Код примера

Работа с кодом примера