Justify Engine: Main Namespace: Device

Пространство имен для слоя взаимодействия с API устройства

Source:: device.js

Members

<static> onDeviceInfoLoadedCallback

Метод, который будет вызван после загрузки информации об устройстве

Source:: device.js

Methods

<static> deinit()

Позволяет корректно завершить работу с устройством перед перезагрузкой приложения или устройства

Source:: device.js

<static> deleteAllCookies()

Удаление всех cookies устройства

Source:: device.js

<static> emptyKeyHandler(event)

Обрабатывает нестандартные ситуации, связанные с цифровым кодом кнопок пульта (например: код отрицальный или равен 0)

Parameters:

Name	Type	Description
`event`		событие нажатия кнопки

Source:: device.js

<static> exitToPortal()

Выход из приложения в стандартный интерфейс устройства. в зависимости от устройства может быть: список приложений, встроенный портал, настройки и т.д.

Source:: device.js

<static> getAPIVersion()

Возвращает версию API устройства (при наличии поддержки со стороны устройства)

Source:: device.js

Returns:

Type: *

<static> getAspectRatioList()

Возвращает список режимов соотношения сторон, доступных на устройстве (при наличии поддержки со стороны устройства)

Source:: device.js

Returns:

Type: Array

<static> getAspectRatioName()

Возвращает название текущего режима соотношения сторон для видео

Source:: device.js

Returns:

Type: String

<static> getAudioOutMode()

Возвращает аудиоформат, который используется в данный момент устройством (при наличии поддержки со стороны устройства)

Source:: device.js

Returns:

название аудиоформата

Type: String

<static> getAudioOutModeList()

Возвращает список аудиоформатов поддерживаемых устройством (при наличии поддержки со стороны устройства)

Source:: device.js

Returns:

Type: Array

<static> getAudioTracksInfo()

Возвращает список аудиодорожек потока

Source:: device.js

Returns:

Type: Array

<static> getBufferLoad()

Возвращает текущую загрузку буфера для потока (при наличии поддержки со стороны устройства)

Source:: device.js

Returns:

Type: Number

<static> getDeviceKind()

Возвращает название устройства, на котором запущен портал

Source:: device.js

Returns:

Type: String

<static> getDeviceModel()

Возвращает модель устройства

Source:: device.js

Returns:

Type: String

<static> getDeviceReleaseYear()

Возвращает год выпуска устройства (при наличии поддержки со стороны устройства)

Source:: device.js

Returns:

Type: *

<static> getDeviceType()

Возвращает тип устройства: Set Top Box, Smart TV и т.д.

Source:: device.js

Returns:

Type: String

<static> getDeviceUID()

В зависимости от поддержки со стороны устройства возвращает либо уникальный идентификатор устройства, либо его MAC-адрес

Source:: device.js

Returns:

Type: String

<static> getDeviceVersion()

Возвращает версию устройства (при наличии поддержки со стороны устройства)

Source:: device.js

Returns:

Type: String

<static> getDisplayHeight()

Возвращает высоту слоя/окна с интерфейсом приложения

Source:: device.js

Returns:

Type: Number

<static> getDisplayWidth()

Возвращает ширину слоя/окна с интерфейсом приложения

Source:: device.js

Returns:

Type: Number

<static> getFirmwareVersion()

Возвращает версию прошивки (при наличии поддержки со стороны устройства)

Source:: device.js

Returns:

Type: String

<static> getIndexOfSelectedAudioTrack()

Возвращает индекс выбранной на устройстве аудиодорожки

Source:: device.js

Returns:

Type: Number

<static> getKeyCodeName(keyCode)

Возвращает название кнопки по ее цифровому коду

Parameters:

Name	Type	Description
`keyCode`		цифровой код кнопки

Source:: device.js

Returns:

Type: String

<static> getLanLinkStatus()

Возвращает состояние подключения к сети через проводной интерфейс (при наличии поддержки со стороны устройства)

Source:: device.js

Returns:

true - подключение активно, false - подключение отсутствует

Type: Boolean

<static> getMacAddress()

Возвращает MAC-адрес устройства

Source:: device.js

Returns:

Type: String

<static> getNetworkLinkStatus()

Возвращает состояние подключения к сети вне зависимости от интерфейса (при наличии поддержки со стороны устройства)

Source:: device.js

Returns:

true - подключение активно, false - подключение отсутствует

Type: Boolean

<static> getPictureHeight()

Возвращает высоту видео

Source:: device.js

Returns:

Type: Number

<static> getPictureWidth()

Возвращает ширину видео

Source:: device.js

Returns:

Type: Number

<static> getPlayingTime()

Возвращает текущее время воспроизведения (в случае поддержки со стороны потока/устройства)

Source:: device.js

Returns:

Type: Number

<static> getSerialNumber()

Возвращает серийный номер устройства (при наличии поддержки со стороны устройства)

Source:: device.js

Returns:

Type: String

<static> getSettingsValue(valueName, defaultValue)

Возвращает текущее значение настройки абонента, которое хранится в памяти устройства

Parameters:

Name	Type	Description
`valueName`		название настройки, значение которой необходимо получить
`defaultValue`		значение по умолчанию, которое будет возвращено в случае отсутствия сохраненного значения

Source:: device.js

<static> getVideoDuration()

Возвращает длительность видео (в случае поддержки со стороны потока/устройства)

Source:: device.js

Returns:

Type: Number

<static> getVideoMode()

Возвращает разрешение и режим для видеовыхода, которые установлены на устройстве

Source:: device.js

Returns:

Type: String

<static> getVolume()

Возвращает установленный на устройстве уровень звука

Source:: device.js

<static> getWebEngine()

Возвращает название движка встроенного браузера

Source:: device.js

Returns:

Type: String

<static> getWifiLinkStatus()

Возвращает состояние подключения к сети через Wi-Fi интерфейс (при наличии поддержки со стороны устройства)

Source:: device.js

Returns:

true - подключение активно, false - подключение отсутствует

Type: Boolean

<static> init()

Инициализация, при которой для устройства применяются все необходимые настройки для корректной работы портала

Source:: device.js

<static> initDevice(pathPrefix, callbackInit)

Инициализация устройства в шаблоне, при которой происходит подключение к слою взаимодействия с API устройства

Parameters:

Name	Type	Description
`pathPrefix`		префикс для пути, который необходимо добавить, чтобы обратиться из HTML-файла шаблона к файлам engine (например: "../../../")
`callbackInit`		метод, который будет вызван после инициализации, принимает аргументы: deviceKind - название устройства

Source:: device.js

<static> initDisplay()

Установка настроек дисплея, графики и видео на уровне устройства, для корректного отображения интерфейса приложения и воспроизведения видео

Source:: device.js

<static> initPlayer()

Используется при загрузке приложения для применения настроек, необходимых для корректной работы плеера

Source:: device.js

<static> keyDown(event)

Обработка нажатия кнопки пульта на уровне устройства

Parameters:

Name	Type	Description
`event`		событие нажатия кнопки

Source:: device.js

<static> loadAudioTracksInfo()

Сохранение локально информации о списке аудиодорожек потока

Source:: device.js

<static> loadSettings(filename, onSettingsLoadedCallback)

Получение настроек абонента из памяти устройства

Parameters:

Name	Type	Description
`filename`		имя/путь файла, в котором хранятся настройки абонента
`onSettingsLoadedCallback`		метод, который будет выполнен после получения настроек

Source:: device.js

<static> onAuthenticationFailed()

Произошла ошибка аутентификации

Source:: device.js

<static> onBufferingComplete()

Окончание буферизации потока

Source:: device.js

<static> onBufferingProgress()

Используется для получения прогресса буферизации потока

Source:: device.js

<static> onBufferingStart()

Начало буферизации потока

Source:: device.js

<static> onChangePlayerSize()

Событие изменения размера области воспроизведения видео

Source:: device.js

<static> onConnectionFailed()

Произошла ошибка подключения к серверу

Source:: device.js

<static> onCurrentPlayTime()

Используется для обновления текущего времени плеера

Source:: device.js

<static> onEvent(eventCode)

Используется для прослушивания и обработки событий от устройства (зависит от особенностей событийной модели устройства)

Parameters:

Name	Type	Description
`eventCode`		код события

Source:: device.js

<static> onFoldApp()

Событие сворачивания приложения

Source:: device.js

<static> onNetworkConnected()

Соединение на уровне сетевых интерфейсов устройства восстановлено

Source:: device.js

<static> onNetworkDisconnected()

Потеряно соединение на уровне сетевых интерфейсов устройства

Source:: device.js

<static> onRenderError(code)

Ошибка открытия потока, связанная с характеристиками контента (кодек, разрешение, формат)

Parameters:

Name	Type	Description
`code`		код ошибки

Source:: device.js

<static> onRenderingComplete()

Достигнуто окончание потока (то же что и onStreamEnd, использование зависит от устройства)

Source:: device.js

<static> onStreamEnd()

Достигнуто окончание потока

Source:: device.js

<static> onStreamError()

Ошибка открытия потока

Source:: device.js

<static> onStreamInfoReady()

В плеер загружена информация о потоке

Source:: device.js

<static> onStreamNotFound()

Поток с таким адресом не найден на сервере

Source:: device.js

<static> onStreamPlayingBegin()

Началось воспроизведение потока

Source:: device.js

<static> onUnfoldApp()

Событие открытия приложения после того, как оно было свернуто

Source:: device.js

<static> pause()

Ставит поток на паузу

Source:: device.js

<static> play(streamUrl, live)

Запускает воспроизведение потока

Parameters:

Name	Type	Description
`streamUrl`		адрес потока
`live`		флаг, который в случае live-потока (трансляция канала, радио) должен принимать значение true, и значение false в случае записи (отложенный просмотр, VoD)

Source:: device.js

<static> reboot()

Перезагрузка устройства

Source:: device.js

<static> reload()

Перезагрузка приложения

Source:: device.js

<static> resume()

Восстанавливает воспроизведение потока с места паузы

Source:: device.js

<static> rewind(playingTime, rewindStep)

Перемотка средствами плеера устройства

Parameters:

Name	Type	Description
`playingTime`		текущее время воспроизведения
`rewindStep`		шаг перемотки, на который нужно перейти от текущего времени

Source:: device.js

<static> saveSettings(filename)

Сохраняет настройки абонента в памяти устройства

Parameters:

Name	Type	Description
`filename`		имя/путь файла, в котором хранятся настройки абонента

Source:: device.js

<static> setAspectRatioMode(modeName)

Устанавливает режим соотношения сторон для видео

Parameters:

Name	Type	Description
`modeName`		название режима соотношения сторон, который необходимо установить

Source:: device.js

<static> setAudioOutMode(audioMode)

Устанавливает аудиоформат для устройства (при наличии поддержки со стороны устройства)

Parameters:

Name	Type	Description
`audioMode`		название аудиоформата

Source:: device.js

<static> setBufferSize(ms, mb, maxMb)

Установка размера буфера для потока (при наличии поддержки со стороны устройства)

Parameters:

Name	Type	Description
`ms`		значение буфера в милисекундах
`mb`		значение буфера в мегабайтах
`maxMb`		максимальное значение буфера в мегабайтах

Source:: device.js

<static> setDisplayResolutionAsDefaultTemplateSize()

Устанавливает разрешение экрана равным разрешению по умолчанию используемого шаблона (указывается в настройках client.js)

Source:: device.js

<static> setOnDeviceInfoLoadedCallback(callbackFunc)

Установка метода onDeviceInfoLoadedCallback

Parameters:

Name	Type	Description
`callbackFunc`		метод

Source:: device.js

<static> setPlayerSize(x, y, w, h, scale)

Устанавливает положение и размер области воспроизведения видео

Parameters:

Name	Type	Description
`x`		положение от левого края экрана
`y`		положение от верхнего края экрана
`w`		ширина области
`h`		высота области
`scale`		коэффициент масштабирования. Если задан, то аргументы w и h игнорируются, а расчет ширины и высоты происходит путем умножения scale на текущие ширину и высоту

Source:: device.js

<static> setPlayerSizeFullscreen()

Устанавливает отображение области воспроизведения видео во весь экран

Source:: device.js

<static> setSelectedAudioTrack(index)

Устанавливает аудиодорожку на устройстве

Parameters:

Name	Type	Description
`index`		индекс выбранной аудиодорожки

Source:: device.js

<static> setSettingsValue(valueName, value)

Устанавливает настройку абонента, которая будет храниться в памяти устройства. Для сохранения установленных настроек используется saveSettings

Parameters:

Name	Type	Description
`valueName`		название настройки
`value`		значение настройки

Source:: device.js

<static> setStandByMode(callback)

Переводит устройство в режим StandBy (при наличии поддержки со стороны устройства)

Parameters:

Name	Type	Description
`callback`		метод, который будет вызван перед переходом устройства в режим StandBy

Source:: device.js

<static> setVolume(volume)

Устанавливает уровень звука на устройстве

Parameters:

Name	Type	Description
`volume`		значение уровня звука

Source:: device.js

<static> setWindowTransparencyLevel(level)

Устанавливает уровень прозрачности интерфейса

Parameters:

Name	Type	Description
`level`		уровень прозрачности

Source:: device.js

<static> showAppsMenu()

Переход в список приложений устройства

Source:: device.js

<static> showSystemSettings()

Переход в системные настройки устройства

Source:: device.js

<static> stop()

Останавливает поток

Source:: device.js

<static> switchAspectRatio()

Переключение между режимами соотношения сторон для видео

Source:: device.js

<static> switchStandBy(callbackBefore, callbackAfter)

Реализует переключение устройства между обычным режимом и StandBy (при наличии поддержки со стороны устройства)

Parameters:

Name	Type	Description
`callbackBefore`		метод, который будет вызван перед переходом в режим StandBy
`callbackAfter`		метод, который будет вызван после выхода из режима StandBy

Source:: device.js