С экрана компьютера (screen sharing) в браузере по WebRTC¶
Описание¶
Поддерживаемые платформы и браузеры¶
Chrome | Firefox | Safari | |
---|---|---|---|
Windows | ✅ | ✅ | ❌ |
Linux | ✅ | ✅ | ❌ |
Mac OS | ✅ | ✅ | ✅ |
Android | ❌ | ❌ | ❌ |
iOS | ❌ | ❌ | ❌ |
Схема работы¶
- Браузер соединяется с сервером по протоколу Websocket и отправляет команду
publishStream
. - Браузер захватывает экран и отправляет WebRTC поток на сервер.
- Второй браузер устанавливает соединение также по Websocket и отправляет команду
playStream
. - Второй браузер получает WebRTC поток и воспроизводит этот поток на странице.
Краткое руководство по тестированию¶
-
Для теста используем демо-сервер
demo.flashphoner.com
и веб-приложение Screen Sharing в браузере Chromehttps://demo.flashphoner.com/client2/examples/demo/streaming/screen-sharing/screen-sharing.html
-
Нажмите кнопку
Start
. Браузер запросит доступ к экрану, и начнется захват экрана и трансляция видеопотока:
-
Убедитесь, что поток отправляется на сервер и система работает нормально, откройте
chrome://webrtc-internals
-
Откройте Two Way Streaming в отдельном окне, нажмите
Connect
и укажите идентификатор потока, затем нажмитеPlay
-
Графики воспроизведения
chrome://webrtc-internals
Последовательность выполнения операций¶
Ниже описана последовательность вызовов при использовании примера Screen Sharing
-
Проверка необходимости установки расширения
Browser.isFirefox()
,Browser.isChrome()
code
if (Browser.isFirefox()) { $("#installExtensionButton").show(); ... } else if (Browser.isChrome()) { $('#mediaSourceForm').hide(); interval = setInterval(function() { chrome.runtime.sendMessage(extensionId, {type: "isInstalled"}, function (response) { if (response) { $("#extension").hide(); clearInterval(interval); onExtensionAvailable(); } else { (inIframe()) ? $("#installFromMarket").show() : $("#installExtensionButton").show(); } }); }, 500); } else { $("#notify").modal('show'); return false; }
-
Установка соединения с сервером
Flashphoner.createSession()
code
Flashphoner.createSession({urlServer: url}).on(SESSION_STATUS.ESTABLISHED, function(session){ //session connected, start streaming startStreaming(session); }).on(SESSION_STATUS.DISCONNECTED, function(){ setStatus(SESSION_STATUS.DISCONNECTED); onStopped(); }).on(SESSION_STATUS.FAILED, function(){ setStatus(SESSION_STATUS.FAILED); onStopped(); });
-
Получение от сервера события, подтверждающего успешное соединение
SESSION_STATUS.ESTABLISHED
code
-
Publishing the stream
Stream.publish()
code
-
Получение от сервера события, подтверждающего успешную публикацию потока
STREAM_STATUS.PUBLISHING
code
session.createStream({ name: streamName, display: localVideo, constraints: constraints }).on(STREAM_STATUS.PUBLISHING, function(publishStream){ ... setStatus(STREAM_STATUS.PUBLISHING); //play preview session.createStream({ name: streamName, display: remoteVideo }).on(STREAM_STATUS.PLAYING, function(previewStream){ document.getElementById(previewStream.id()).addEventListener('resize', function(event){ resizeVideo(event.target); }); //enable stop button onStarted(publishStream, previewStream); }).on(STREAM_STATUS.STOPPED, function(){ publishStream.stop(); }).on(STREAM_STATUS.FAILED, function(stream){ //preview failed, stop publishStream if (publishStream.status() == STREAM_STATUS.PUBLISHING) { setStatus(STREAM_STATUS.FAILED, stream); publishStream.stop(); } }).play(); }).on(STREAM_STATUS.UNPUBLISHED, function(){ ... }).on(STREAM_STATUS.FAILED, function(stream){ ... }).publish();
-
Отправка аудио-видео потока по WebRTC
-
Остановка публикации потока
Stream.stop()
code
session.createStream({ name: streamName, display: localVideo, constraints: constraints }).on(STREAM_STATUS.PUBLISHING, function(publishStream){ /* * User can stop sharing screen capture using Chrome "stop" button. * Catch onended video track event and stop publishing. */ document.getElementById(publishStream.id()).srcObject.getVideoTracks()[0].onended = function (e) { publishStream.stop(); }; ... setStatus(STREAM_STATUS.PUBLISHING); //play preview session.createStream({ name: streamName, display: remoteVideo }).on(STREAM_STATUS.PLAYING, function(previewStream){ ... }).on(STREAM_STATUS.STOPPED, function(){ publishStream.stop(); }).on(STREAM_STATUS.FAILED, function(stream){ //preview failed, stop publishStream if (publishStream.status() == STREAM_STATUS.PUBLISHING) { setStatus(STREAM_STATUS.FAILED, stream); publishStream.stop(); } }).play(); ... }).publish();
-
Получение от сервера события, подтверждающего остановку публикации потока
STREAM_STATUS.UNPUBLISHED
code
session.createStream({ name: streamName, display: localVideo, constraints: constraints }).on(STREAM_STATUS.PUBLISHING, function(publishStream){ ... }).on(STREAM_STATUS.UNPUBLISHED, function(){ setStatus(STREAM_STATUS.UNPUBLISHED); //enable start button onStopped(); }).on(STREAM_STATUS.FAILED, function(stream){ ... }).publish();
Разработчику¶
Функция демонстрации экрана может быть использована для публикации видеопотока, демонстрирующего рабочий стол или окно приложения.
Большинству современных браузеров не требуется расширение для публикации экрана, окна или вкладки. В целях обратной совместимости, WCS Javascript API может использовать браузерное расширение демонстрации экрана. Ниже приводится пример публикации собственного расширения для Chromium браузеров в Chrome Store.
Расширение для Google Chrome с публикацией в Chrome Store¶
Исходный код расширения для сборки доступен по ссылке: Chrome Screen Sharing Extension
Создание аккаунта Google¶
-
Зайдите на google.com и нажмите кнопку
Sign in
-
Нажмите ссылку
Create account
на страницеSign in
-
Будет открыта страница
Create your Google Account
. Заполните необходимые поля и нажмите кнопкуNext step
, чтобы создать аккаунт
Регистрация разработчика Chrome Web Store¶
-
Войдите в Chrome Developer Dashboard, используя созданный аккаунт Google
-
Внесите единовременную плату в размере US$5, чтобы подтвердить аккаунт
Адаптация расширения к своему домену¶
Выполните действия, описанные ниже, чтобы использовать расширения со своим доменом.
Отредактируйте файл манифеста manifest.json
расширения для Chrome.
Измените:
- имя (
name
) - автора (
author
) - описание (
description
) - адрес домашней страницы (
homepage_url
) - в
"externally_connectable":"matches"
заменитеflashphoner.com
на свой домен
Добавьте свои иконки в директорию chrome-extension
и отредактируйте имена файлов в icons
и web_accessible_resources
. (Для дополнительной информации см. Manifest - Icons и Supplying Images)
Упаковка расширения¶
Упакуйте файлы из каталога chrome-extension
в ZIP архив.
Публикация расширения в Chrome Web Store¶
-
Войдите в Chrome Developer Dashboard
-
Нажмите кнопку
Add new item
-
Примите соглашение разработчика
-
Выберите файл
chrome-extension.zip
и нажмите кнопкуUpload
на страницеUpload
-
После загрузки расширения будет открыта страница для редактирования опций. Выберите необходимые опции и нажмите кнопку
Save draft and return to dashboard
внизу страницы
-
Расширение появится в панели разработчика. Для публикации расширения нажмите ссылку
Publish
Опубликованное расширение будет иметь статус Published
, как на изображении ниже.
Для дополнительной информации см. Chrome Web Store Publishing Tutorial.
Встроенная установка расширения¶
Встроенная установка позволяет инициировать установку расширения для демонстрации экрана нажатием ссылки или кнопки на странице клиента.
Для работы встроенной установки расширение должно быть адаптировано, опубликовано и одобрено.
Выполните действия, описанные ниже, чтобы использовать клиент со своими расширениями.
-
При публикации выберите опцию
Inline Install
-
Подтвердите и привяжите к расширению сайт со свойм доменом
- Нажмите
Add a New Site
- В новой вкладке браузера будет открыта страница Google Search Console. Введите URL со своим доменом
- Будет открыта страница с инструкцией для подтверждения сайта. Выполните требуемые шаги и нажмите кнопку
Verify
.
- Если проверка пройдена, будет открыта страницa с подтверждением успешной проверки
- Подтвержденный сайт появится в списке в опциях расширения; далее расширение может быть проассоциировано с этим сайтом
- Нажмите
Настройка клиента¶
Отредактируйте Screen-sharing.html
и Screen-sharing.js
- В
Screen-sharing.html
параметрchrome-webstore-item
должен указывать на ваше расширение в интернет-магазине Chrome - В
Screen-sharing.js
замените значение переменнойchromeScreenSharingExtensionId
на ID вашего расширения
Чтобы узнать ID расширения, нажмите More info
для этого расширения в Chrome Developer Dashboard.
Параметры источника медиа¶
Для конфигурации параметров источника медиа экрана могут быть использованы параметры объекта Configuration, передаваемые методу init()
при инициализации экземпляра Flashphoner API.
var f = Flashphoner.getInstance();
var configuration = new Configuration();
....
configuration.screenSharingVideoWidth = 1920;
configuration.screenSharingVideoHeight = 1080;
configuration.screenSharingVideoFps = 10;
f.init(configuration);
Список параметров¶
Параметр | Описание |
---|---|
screenSharingVideoWidth |
Ширина источника медиа экрана |
screenSharingVideoHeight |
Высота источника медиа экрана |
screenSharingVideoFps |
Частота кадров источника медиа экран |
Данные параметры задают предельные значения разрешения и количество кадров в секунду (FPS). Например, screenSharingVideoWidth = 1080
означает, что ширина исходного видео не может быть более 1080 пикселей, но может быть меньше (например, в случае передачи потока с изображением окна приложения с шириной 720 пикселей)
Захват системного звука в браузере Chrome¶
В браузере Chrome существует возможность при захвате экрана транслировать аудиопоток из системного источника звука. Такая возможность полезна, например, при скринкастинге. Для захвата системного звука при выборе окна или вкладки в диалоговом окне Chrome установите опцию Share audio
:
Код расширения code:
Управление источником захвата (экран или окно) в браузере Firefox¶
В старых версиях браузера Firefox можно выбрать экран или окно программы в качестве источника видео при помощи параметра constraints.video.mediaSource
code:
constraints.video.type = "screen";
if (Browser.isFirefox()){
constraints.video.mediaSource = $('#mediaSource').val();
}
session.createStream({
name: streamName,
display: localVideo,
constraints: constraints
})
Пример интерфейса для выбора источника
Attention
В новых версиях браузера Firefox, источник захвата может быть выбран только в диалоговом окна браузера
Захват окна программы
Захват экрана
Демонстрация экрана без использования расширения¶
Браузер Firefox¶
Браузер Firefox не использует расширение для захвата экрана
Браузеры на основе Chrome¶
Начиная с версии Chrome 73 и версии Flashphoner WebSDK 0.5.28.2753.86 возможна демонстрация экрана без использования расширения. Для этого необходимо при создании потока передать
параметр constraints.video.withoutExtension
Браузер Safari для MacOS¶
Начиная с версии Safari 13 и версии Flashphoner WebSDK 0.5.28.2753.152 возможна демонстрация экрана без использования расширения. Для этого необходимо при создании потока передать
параметр constraints.video.withoutExtension
if ($("#woChromeExtension").prop('checked') || Browser.isSafari()) {
constraints.video.withoutExtension = true;
}
Известные ограничения¶
-
При публикации из Chrome, разрешение и FPS устанавливаются не в соответствии с заданными в
constraints
при создании потока, а по размерам источника (экрана, окна или вкладки браузера) и по реальной частоте изменения картинки. Эта проблема исправлена, начиная со сборки Web SDK 0.5.28.2753.152 -
Захват системного звука работает начиная с версии Chrome 74
Известные проблемы¶
1. Если веб-приложение расположено внутри iframe элемента, публикация видеопотока может не пройти¶
Симптомы
Ошибки IceServer error в консоли браузера
Решение
Вынести приложение из iframe на отдельную страницу
2. Если публикация потока идет с Windows 8 или 10, и в браузере Google Chrome включено аппаратное ускорение, могут быть проблемы с битрейтом¶
Симптомы
Качество видео плохое, мутное, битрейт в chrome://webrtc-internals
показывает меньше 100 kbps
Решение
Отключите аппаратное ускорение в браузере, используйте кодек VP8 для публикации
3. Остановка всех потоков, захваченных с экрана, при остановке одного из них¶
Симптомы
При создании нескольких потоков, захваченных с экрана, из одной вкладки браузера Chrome, и последующей остановке одного из них, останавливаются все потоки.
Решение
Кешировать дорожки по источнику видео, и останавливать их вместе с последним потоком, использующим этот источник, например
var handleUnpublished = function(stream) {
console.log("Stream unpublished with status " + stream.status());
//get track label
var video = document.getElementById(stream.id() + LOCAL_CACHED_VIDEO);
var track = video.srcObject.getVideoTracks()[0];
var label = track.label;
//see if someone using this source
if (countDisplaysWithVideoLabel(label) > 1) {
//remove srcObject but don't stop tracks
pushTrack(track);
video.srcObject = null;
} else {
var tracks = popTracks(track);
for (var i = 0; i < tracks.length; i++) {
tracks[i].stop();
}
}
//release resources
Flashphoner.releaseLocalMedia(streamVideoDisplay);
//remove stream display
display.removeChild(streamDisplay);
session.disconnect();
};
4. При сворачивании окна, с которогого захватывается поток, браузер Chrome перестает высылать трафик¶
Симптомы
Если окно, с которого захватывается видеопоток, свернуто на панель задач, на стороне подписчика виден фриз, поток может завершиться по отсутствию трафика: Failed by RTP activity