Плеер: Интеграции
С чего начать
Интеграции Плеера: с чего начать
Сначала определите, где выполняется интеграция: на отдельном устройстве с Плеер, между несколькими Плеерами или через внешнее оборудование.
Выберите интерфейс
Задача | Инструмент |
Управлять локальным Плеером из приложения | |
Синхронизировать проекты или раздавать файлы между устройствами | |
Отправлять локальные команды Плееру | |
Подключить сканер штрихкодов | |
Управлять звуком по последовательному порту |
Опишите обмен данными
До настройки зафиксируйте:
- какая система инициирует запрос или событие;
- какие данные передаются и в каком формате;
- как выполняется авторизация;
- какой тайм-аут и повтор допустимы;
- что должно произойти при недоступности сети или внешней системы;
- где будут храниться журнал и диагностические данные.
Начните с тестового контура
Проверьте один безопасный сценарий на тестовом устройстве или аккаунте. После успешного запроса проверьте идемпотентность повторов и обработку ошибок, затем переносите интеграцию в рабочую среду.
Для автоматизации операций в CMS используйте отдельную статью PublicAPI.
API
Player API
Player API работает локально на устройстве с Плеером. Он позволяет получать версию и состояние Плеера, сведения о платформе, камерах и настройках, выполнять действия над Плеером или устройством и читать актуальные результаты видеоаналитики.
Подготовьте Плеер
- Включите режим «Специальные и бета возможности».
- Включите Web Server и зафиксируйте его порт. По умолчанию используется порт
55080. - Получите PIN-код в настройках платформы.
Авторизуйте запрос
Передавайте PIN-код в заголовке X-PIN-code. Не публикуйте код и не храните его в общедоступном клиентском приложении.
Полное описание методов и форматов запросите по ссылке «Документация Player API».
Проверьте подключение
Сначала выполните безопасный запрос чтения версии или базовой информации. Если соединение не установлено, проверьте IP-адрес устройства, порт Web Server, межсетевой экран и значение заголовка авторизации.
P2P
Как управлять проектами по p2p? Синхронизация устройств.
В статье раскрыта тема «Как управлять проектами по p2p? Синхронизация устройств».
Настройка P2P
На основе Designer Адвантедж можно создавать проекты, взаимосвязанные друг с другом при помощи команд. Для этого достаточно воспользоваться кнопкой на одном запущенном проекте и отправить команду на другой проект в процессе его трансляции - это может быть переход между сценами, смена контента, отправка формы на аккаунт и т.д. Данная механика взаимодействия между проектами называется p2p (peer-to-peer).
Для качественного использования механизма рекомендуется:
- использовать устройства со средней производительностью или выше (Intel Core i3 и выше, 4 GB RAM или выше, SSD);
- использовать рекомендуемые ОС (это Windows 8.1 или Android 5.0);
- использовать проводное подключение к сети для устройств;
- использовать закрытую сеть на отдельном свитче;
- использовать специально настроенный свитч (сеть) с включённой поддержкой IGMPv2, мультикастом и отключенным контролем трафика (e.g. QoS).
Существует 4 основных вида создания проектов с использованием механики p2p:
1. Синхронизация внутри проекта;
2. Синхронизация внутри локальной сети/управление проектами внутри локальной сети;
3. p2p sharing через личный кабинет Адвантедж.
4. Синхронизация обычных и цикловых рекламных кампаний.
Синхронизация внутри проекта
Для создания данного вида проекта:
1. Создайте и откройте проект в Designer Адвантедж;
2. В правом верхнем углу нажмите на иконку меню;
3. В открывшемся меню компонентов выберите "Interface Editor";
4. Откройте добавленный компонент (нажмите на него 2 раза левой кнопкой мыши);
5. На верхней панели инструментов нажмите на иконку "медиагалерея" (это могут быть как две медиагалереи, так и больше);
6. Разместите добавленные элементы на предназначенном для этого (белом) экране;
7. Нажмите на компонент, который хотите сделать главным (Master);
8. На панели настроек справа в разделе "Слой" нажмите на вкладку под названием "Синх." (Синхронизация);
9. В выпадающем списке меню выберите пункт "Внутри компонента";
10. Рядом напишите номер группы и поставьте галочку у вкладки "Мастер";
11. Теперь перейдите к другим медиагалереям (нажимая на них);
12. Проделайте те же настройки, за исключением галочки у вкладки "Мастер";
ВАЖНО!!! Номер группы медиагалерей должен быть одинаковым.
13. Нажмите в левом нижнем углу кнопку "Окей".
Синхронизация внутри локальной сети/управление проектами внутри локальной сети
Данный вид синхронизации подразумевает отправку от одного проекта к другому команды, согласно которой 2-ой проект выполняет заданное действие.
- Проект, отправляющий команду(ы), - Master;
- Проект, принимающий команду(ы), - Slave.
Для настройки управляющего проекта:
1. Создайте и откройте проект в Designer Адвантедж;
2. В правом верхнем углу нажмите на иконку меню;
3. В открывшемся меню компонентов выберите "Interface Editor";
4. Откройте добавленный компонент (нажмите на него 2 раза левой кнопкой мыши);
5. На верхней панели инструментов выберите нужные вам элементы (это может быть как медиагалерея, так и кнопка и др.);
6. Разместите добавленный элемент(ы) на предназначенном для этого (белом) экране;
7. Нажмите на элемент, для которого хотите задать команду;
8. На панели настроек справа нажмите на вкладку "Действия", затем на "+";
9. В появившемся окне выберите команду "при клике", затем "передача сообщения";
10. Напишите сообщение в предназначенном для этого окне;
11. В левом нижнем углу нажмите кнопку "Ок", затем комбинацию кнопок "Ctrl+Shift+S" и сохраните проект.
Для настройки управляемого проекта:
1. Создайте и откройте проект в Designer Адвантедж;
2. В правом верхнем углу нажмите на иконку меню;
3. В открывшемся меню компонентов выберите "Interface Editor";
4. Откройте добавленный компонент (нажмите на него 2 раза левой кнопкой мыши);
5. На верхней панели инструментов выберите нужные вам элементы (это может быть как медиагалерея, так и кнопка и др.);
6. Разместите добавленный элемент(ы) на предназначенном для этого (белом) экране;
7. Нажмите на саму сцену (т.е. не на элемент сцены, а на пустое пространство);
8. На панели настроек справа нажмите на вкладку "Действия", затем на "+";
9. Выберите действие "при получении команды", затем "перейти" (данный вариант не является обязательным, а наиболее часто используемым);
10. Нажмите на добавленное действие, введите получаемое сообщение в соответствующем поле и выберите одну из иконок "ссылки";
- левая иконка - переход на другую сцену (для такого перехода не забудьте добавить ещё одну сцену, нажав кнопку "Добавить сцену",
- правая иконка - переход на другой компонент.
11. В левом нижнем углу нажмите кнопку "Ок", затем комбинацию кнопок "Ctrl+Shift+S" и сохраните проект.
ВАЖНО!!! В сети не должно быть никаких других проектов, отправляющих команду.
p2p sharing через личный кабинет Адвантедж настраивается в разделе "Устройства" личный кабинет Адвантедж.
Данная настройка полезна для более лёгкой передачи контента между устройствами, что ускоряет загрузку проекта.
Синхронизация обычных и цикловых рекламных кампаний.
- Шаблон должен быть с включенным p2p, как в статье выше.
- У всех устройств, воспроизведение медиапланов которых должно быть синхронизировано, должны быть назначены кастомные атрибуты @mpsync с идентичными значениями группы синхронизации.
- У всех устройств, участвующих в заданной группе синхронизации должен быть идентичный медиаплан и прогружен весь контент.
- Плеер должен быть обновлен до последней версии early access.
- Настройка p2p transportation в Плеере должна быть выставлена на UDP.
- Обязательное условие - подключение устройств в одной сети по свитчу через LAN.
Интерфейсы Плеера
Использование Telnet Server
в Плеере есть возможность мониторинга работы Player при помощи Telnet, для активации Telnet-сервера требуется запустить его в настройках Player. После включения соответствующих настроек Telnet-сервер будет автоматически запускаться при запуске Player.
Включение Telnet-сервера
Использование Telnet можно включить двумя способами: через настройки Player и через Designer Адвантедж.
Для того чтобы запустить Telnet сервер через Designer, выполните следующие шаги:
1. Откройте главный экран Designer Адвантедж
2. Нажмите правой кнопкой на нужном устройстве
3. Выберите пункт "Настройки Telnet-сервера"
4. В открывшемся окне поставьте галочку у поля "Включено", выберите нужный порт и нажмите "Изменить"
Для того чтобы запустить Telnet-сервер в настройках Player, выполните следующие шаги:
- На главном экране Player откройте раздел настроек "Устройства"
- Выберите пункт "Telnet Server"
- Выберите нужный порт и включите Telnet-сервер
После этого при помощи Telnet можно подключиться к запущенному серверу и, при помощи команд, запросить время работы Player и Telnet сервера.
Команды:
- plu - выводит время работы Player (в мс)
- seu - выводит время работы Telnet-сервера (в мс)
Пример подключения к Telnet-серверу
Для подключения к Telnet-серверу выполните следующие действия:
- В ОС Windows откройте командную строку
- Введите "telnet" и нажмите Enter
- Для подключения к Telnet-серверу Player требуется ввести команду "o IP_адрес_устройства порт"
- После подключения к Telnet-серверу можно передавать команды и получать соответствующий ответ в виде числа
Пример команды для подключения к Telnet-серверу:
Пример запросов к Telnet-серверу и ответов:
Из данных ответов можно заключить, что Плеере запущен в течение 70.4 секунд, а Telnet-сервер запущен в течение 72.5 секунд.
Специальные и бета-возможности Плеера
Режим открывает расширенные настройки распознавания, P2P-транспорта и локального сервера Плеера. Изменяйте только параметры, которые требуются выбранной инструкцией интеграции.
Включите режим
- Откройте в Плеере пункт «Устройства».
- Нажмите на него десять раз подряд.
- Включите появившийся переключатель «Специальные и бета возможности».
После настройки
Зафиксируйте изменённые параметры и проверьте основной сценарий на тестовом устройстве. Не включайте экспериментальные настройки массово до проверки воспроизведения, сети и нагрузки Плеера.
Для локальных интеграций продолжите с инструкциями Player API или Web Server Плеера. Для P2P используйте руководство «Как управлять проектами по P2P».
Как включить Web Server в Плеере
Web Server нужен для локального доступа к Player API. Перед настройкой убедитесь, что интеграционная система может обращаться к устройству по сети.
Включите сервер
- Запустите Плеер.
- Откройте пункт «Устройства».
- Включите специальные и бета-возможности, нажав пункт «Устройства» десять раз подряд.
- Откройте «Web Server» и включите переключатель.
- Зафиксируйте порт. Значение по умолчанию —
55080.
Проверьте доступ
Выполните тестовый запрос с устройства в той же сети. Если соединения нет, проверьте IP-адрес, порт, правила межсетевого экрана и сетевую доступность между узлами.
Внешние устройства
Как настроить работу сканеров штрихкодов с помощью Intent объектов?
В статье раскрыта тема «Как настроить работу сканеров штрихкодов с помощью Intent объектов».
Подключение устройства
В версии Player 2.0.339 реализована интеграция со сканерами штрихкодов у прайсчекеров на Android от производителя Motorola/Zebra/Symbol.
В качестве тестовой модели использовался прайсчекер CC5000-10 на Android 5.1.1. Устройство имеет специализированное ПО для настройки работы со сканером штрихкодов под названием Datawedge.
Плеер умеет понимать передаваемые данные со сканеров штрихкодов в режиме клавиатурного буфера, а также при необходимости использования системных intent объектов. Intent представляет собой объект обмена сообщениями, с помощью которого можно запросить выполнение действия у компонента другого приложения.
Плеер может принимать значения по:
- событию (action’у) com.advantage.player.BARCODE_SCAN,
- категории (category) android.intent.category.DEFAULT,
- с тегами сообщений com.advantage.player.barcode или com.motorolasolutions.emdk.datawedge.data_string (данным тегом оперирует устройство CC5000-10).
Пример настройки приложения Datawedge:
Создан отдельный профиль и добавлены все существующие Activity Плеера
Активирован Barcode input, параметры оставлены по-умолчанию
Деактивирован Keystroke output
Активирован Intent output и настроены поля Intent action, Intent category, Intent delivery
Intent action = com.advantage.player.BARCODE_SCAN
Intent category = android.intent.category.DEFAULT
Intent delivery = Broadcast intent
Как управлять звуком через COM/RS-232?
В статье раскрыта тема «Как управлять звуком через COM/RS-232».
Подключение устройства
Для реализации механики необходимо использовать ПО версии не ниже 369.
В Designer Адвантедж нужно создать проект и добавить в него компонент "Sound Panel".
Основной контент можно назначить из любого источника, поддерживаемого Sound Panel, например из личного кабинета Адвантедж или библиотеки проекта.
Звук, который необходимо воспроизводить по команде, добавляется в раздел "Samples" (Семплы). При этом источник не выбирается, а добавляется автоматически в библиотеку проекта ("вшивается").
При выборе любого семпла сверху появляются его настройки, где у основного контента можно указать громкость("Music level"), на которую контент переключится при воспроизведении семпла.
Также указывается RS-232 сообщение (RS-232 message), получив которое, семпл будет воспроизведён. Такое сообщение возможно только для одного семпла.
Важные ограничения:
1. Не использовать несколько компонентов, работающих с RS-232;
2. Работать по RS-232 можно только с 1 семплом;
3. Использовать первый найденный доступный для работы COM порт, т.е. в идеале он должен идти первым в ОС;
4. Параметры подключения:
- Baud rate: 9600,
- Data bits: 8,
- Parity type: None,
- Stop bits: 1,
- End-of-string character: none (отсутствие символа возврата каретки при отправке сообщения).
5. Считывание данных производится 1 раз/сек, в перспективе будет уменьшен интервал опроса.