Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

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

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

...

WebRTC поток

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

Image RemovedImage Added

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

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

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

Код примера

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

...

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

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

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

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

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

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

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

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

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

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

Code Block
languagejs
themeRDark
connection.join({name: getRoomName()}).on(ROOM_EVENT.STATE, function(room){
var participantsFlashphoner = roomRoomApi.getParticipants()sdk;
...

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

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

...


Flashphoner.init();

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

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

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

Code Block
languagejs
themeRDark
Flashphonerconnection.initjoin({flashMediaProviderSwfLocationname: '../../../../media-provider.swf'});

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

...

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

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

Code Block
languagejs
themeRDark
connection = Flashphoner.roomApi.connect({urlServer: url, username: username}).on(SESSION_STATUS.FAILED}).on(ROOM_EVENT.JOINED, function(sessionparticipant){
    setStatus('#status', session.status());
    onLeft();
}).on(SESSION_STATUS.DISCONNECTED, function(session) {
    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
languagejs
themeRDark
Flashphoner.init();

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

Flashphoner.getMediaAccess() code

Code Block
languagejs
themeRDark
    Flashphoner.getMediaAccess(null, localDisplay).then(function() {
        createConnection(url, username);
    }).catch(function(error) {
        console.error("User not allowed media access: "+error);
        $("#failedInfo").text("User not allowed media access. Refresh the page");
        onLeft();
    });

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

RoomApi.connect() code

Code Block
languagejs
themeRDark
connection = Flashphoner.roomApi.function createConnection(url, username) {
    connection = RoomApi.connect({urlServer: url, username: username}).on(SESSION_STATUS.FAILED, function(session){
    setStatus('#status', session.status());
    onLeft();
}).on(SESSION_STATUS.DISCONNECTED, function(session) {...
    ...});
}).on(SESSION_STATUS.ESTABLISHED

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

ConnectionStatusEvent ESTABLISHED code

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

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

connection.join() код

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

Code Block
languagejs
themeRDark
connection.join({name: getRoomName().on(SESSION_STATUS.DISCONNECTED, function(session) {
    ...
}).on(ROOMSESSION_EVENTSTATUS.STATEESTABLISHED, function(roomsession) {
    ...setStatus('#status', session.status());
    joinRoom();
});

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

RoomStatusEvent STATE код

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

...

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

connection.join() code

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

Code Block
languagejs
themeRDark
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()...
});

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

RoomStatusEvent STATE code

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

  • определяется количество участников конференции с помощью метода room.getParticipants(), который возвращает массив объектов participant,
  • если к конференции уже присоединилось максимально допустимое количество участников, производится выход из "комнаты" при помощи room.leave()
  • если количество участников меньше максимально допустимого, начинается публикация видеопотока
Code Block
languagejs
themeRDark
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 >= 0_participants) {
        var chatState = "participants: "console.warn("Current room is full");
        for (var i = 0; i < participants.length; i++) {$("#failedInfo").text("Current room is full.");
        room.leave().then(onLeft, onLeft);
        return false;
    }
    setInviteAddress(room.name());
    if (participants.length > 0) {
 installParticipant(participants[i]);
       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
languagejs
themeRDark
    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
languagejs
themeRDark
    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
languagejs
themeRDark
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
languagejs
themeRDark
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
languagejs
themeRDark
                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++) {
                            if (pDisplay.children[i]) {
                                console.log("remove cached instance id " + pDisplay.children[i].id);
                                pDisplay.removeChild(pDisplay.children[i]);
                            }
                        }
                        onParticipantStopped(participant);
                    });
                }

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

participant.play() code

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

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

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

Code Block
languagejs
themeRDark
        var options   chatState += participants[i].name();{
         if (i != participants.length - 1) { unmutePlayOnStart: true,
            chatState += ",";
      constraints: {
   }
     }
         addMessage("chat", chatState);
audio: {
      } else {
         addMessage("chat", " room is empty");deviceId: 'default'
     }
     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. Публикация видеопотока.

room.publish() код

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

Code Block
languagejs
themeRDark
room.publish(document.getElementById("localDisplay")).on(STREAM_STATUS.FAILED, function (stream// Leave participant stream muted in Android Edge browser #WCS-3445
        if (Browser.isChromiumEdge() && Browser.isAndroid()) {
    console.warn("Local stream failed!");
       setStatus("#localStatus", stream.status()) options.unmutePlayOnStart = false;
    onMediaStopped(room);
}).on(STREAM_STATUS.PUBLISHING, function (stream) {
    }
       setStatus("#localStatus", stream.status());
    onMediaPublished(stream);
}) participant.getStreams()[0].play(display, options).on(STREAM_STATUS.UNPUBLISHEDPLAYING, function (streamplayingStream) {
    setStatus("#localStatus", stream.status());
    onMediaStopped(room);
});

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

RoomStatusEvent JOINED код

Code Block
languagejs
themeRDark
connection.join({name: getRoomName()}).on(ROOM_EVENT.STATE, function(room)        var video = document.getElementById(playingStream.id())
            video.addEventListener('resize', function (event) {
     ...
}).on(ROOM_EVENT.JOINED, function(participant){
           resizeVideo(event.target);
      installParticipant(participant      });
     addMessage(participant.name(), "joined");
}).on(ROOM_EVENT.LEFT, function(participant){
       // Set up participant Stop/Play button
            ...
}).on(ROOM_EVENT.PUBLISHED, function(participant){
if (playBtn) {
       ...
}).on(ROOM_EVENT.FAILED, function(room, info){
         $(playBtn)...
}).on(ROOM_EVENT.MESSAGE, function(message)text("Stop").off('click').click(function() {
     ...
});

...

RoomStatusEvent PUBLISHED код

Code Block
languagejs
themeRDark
connection.join({name: getRoomName()}).on(ROOM_EVENT.STATE, function(room){               $(this).prop('disabled', true);
     ...
}).on(ROOM_EVENT.JOINED, function(participant){               playingStream.stop();
     ...
}).on(ROOM_EVENT.LEFT, function(participant){
           ...
}).on(ROOM_EVENT.PUBLISHED, function(participant){
 prop('disabled', false);
    playParticipantsStream(participant);
}).on(ROOM_EVENT.FAILED, function(room, info){
     ...
}).on(ROOM_EVENT.MESSAGE, function(message){
 }
        ...
});

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

participant.play() код

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

Code Block
languagejs
themeRDark
function playParticipantsStream(participant) {
    // Set up participant audio toggle button #WCS-3445
            if (participant.playaudioBtn) {
                $(audioBtn).text("[id$=Name]").each(function (index, valueAudio").off('click').click(function() {
            if ($(value).text() == participant.name        if (playingStream.isRemoteAudioMuted()) {
                   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()}).addEventListenerprop('resizedisabled', function (event) {
false);
            }
            // Start  resizeVideo(event.target);participant audio state checking timer #WCS-3445
            participantState.startMutedCheck(playingStream);
        });
   .on(STREAM_STATUS.STOPPED, function () {
             }onParticipantStopped(participant);
        }).on(STREAM_STATUS.FAILED, function () {
    }
        }onParticipantStopped(participant);
    }
}

...

    });

13. Остановка публикации видеопотока.

stream.stop() код code

Code Block
languagejs
themeRDark
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
languagejs
themeRDark
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
languagejs
themeRDark
function onJoined(room) {
    $("#joinBtn").text("Leave").off('click').click(function(){
        $(this).prop('disabled', true);
        room.leave().then(onLeft, onLeft);
    }).prop('disabled', false);
    ...
}

1316. Включение/выключение аудио и видео для публикуемого потока. line 187, line 196.

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

Code Block
languagejs
themeRDark
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()) {
     ', false);
       $(this"#localVideoToggle").text("Mute V");.off('click').click(function() {
        if    (stream.unmuteVideoisVideoMuted();
        } else )) {
            $(this).text("UnmuteMute V");
            stream.muteVideo(");
        }
    })stream.propunmuteVideo('disabled',false);
}

14. Отправка текстового сообщения.

participant.sendMessage() код

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

  • определяется массив участников конференции с помощью метода room.getParticipants()
  • отправляется сообщение каждому участнику
Code Block
languagejs
themeRDark
function onJoined(room) {
    $("#joinBtn");
        } else {
            $(this).text("Leave").off('click').click(function(){
Unmute V");
            $(this).prop('disabled', truestream.muteVideo();
        room.leave().then(onLeft, onLeft);}
    }).prop('disabled', false);
}

17. Отправка текстового сообщения.

participant.sendMessage() code

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

  • определяется массив участников конференции с помощью метода room.getParticipants()
  • отправляется сообщение каждому участнику
Code Block
languagejs
themeRDark
function onJoined(room) {
    ...
    $('#sendMessageBtn').off('click').click(function(){
        var message = field('message');
        addMessage(connection.username(), message);
        $('#message').val("");
        //broadcast message
        var participants = room.getParticipants();
        for (var i = 0; i < participants.length; i++) {
            participants[i].sendMessage(message);
        }
    }).prop('disabled',false);
    $('#failedInfo').text("");
}