Это старая версия документа!

Содержание

TVIP JavaScript API
Описание методов объектов JS API

TVIP JavaScript API

Версия API #1
Доступна на прошивках linux-qt от 3.2.0.

Медиаценты TVIP отображают Web-контент с использованием движка WebKit.

JavaScript API в медиацентрах TVIP базируется на следующих основных объектах:

window.TvipStb - содержит базовые методы для взаимодействия с аппаратной частью;
window.TvipPlayer - содержит методы для управления медиаплеером;
window.TvipRecorder - содержит методы для управления записью эфира;
window.TvipEvent - содержит callback-методы;

Объекты не требуют явного создания или какой-либо инициализации и доступны из любой Web-странцы, открытой в STB-браузере.

Описание методов объектов JS API

TvipStb

int getApiVersion();

Возвращает номер версии API.

String getCurrentLanguageCode();

Возвращает идентификатор текущего активного языка интерфейса ('en', 'ru').

String getCurrentTimezone();

Возвращает текущий часовой пояс (например, Europe/Moscow).

String getDisplayMode();

Возвращает текущий режим дисплея («1080i», «1080p», «720p», «576i», и т.д.).

List getDirectoryDirs(String directory);

Возвращает список имен каталогов в системном каталоге directory.

[ "Dir1", "Dir2", "Dir3" ]

List getDirectoryFiles(String directory);

Возвращает список объектов с данными о файлах (без каталогов) в системном каталоге directory.

[
  {
    "name": "file1",
    "size": 1234567
  },
  
  {
    "name" : "file2",
    "size" : 44444
  }
]

name - имя файла в каталоге, size - размер файла в байтах.

String getEnvValue(String name);

Получить переменную из постоянного хранилища браузера. Если name не найден, вернется пустая строка.

String getMainMacAddress();

Возвращает строку, содержащую основной MAC-адрес приставки. Обычно это MAC-адрес Ethernet.

List getStorageValues();

Возвращает список объектов смонтированных накопителей (локальных и сетевых).

[
 {
   "label": <label>,
   "path" : <ospath>,
   "fstype" : <file_system>
 },

]

Поля объекта: label - имя (метка) смонтированного ресурса для отображения пользователю; path - каталог, в который смонтирован ресурс; fstype - тип файловой системы (варианты: vfat, ntfs, ext2, ext3, nfs, cifs.

bool hasDirectory(String osPath);

Возвращает true, если в системной файловой системе существует каталог с именем osPath, иначе false.

bool hasFile(String osPath);

Возвращает true, если в системной файловой системе существует файл (не каталог) с именем osPath, иначе false.

void launchPreferences();

Запустить системные настройки Tvip.

void logDebug(String message);

Выводит отладочное сообщение в системную консоль (Linux) или logcat (Android).

void setColorKey(int color);

Установка цвета UI, который будет считаться прозрачным. color - цвет в формате RGB.

void setCustomHeader(String header, String value);

Устанавливает HTTP-заголовок для будущих HTTP-запросов браузера. header - имя заголовка, value - значение заголовка. Если value пустая строка, то удаляется ранее установленный заголовок.

void setEnvValue(String name, String value);

Сохранить переменную в постоянном хранилище браузера. Все переменные доступны всем страницам браузера.

void setDirectoryListFilters(String filters);

Задать фильтры имен файлов для getDirectoryFiles и getDirectoryDirs. Фильтры разделяются символом |. Можно использовать символы ? и *****. Например: *.avi|*.mp3

void showVirtualKeyboard(bool show);

Отобразить (show=true) или скрыть (show=false) виртуальную клавиатуру.

void reset();

Сбросить настройки: прозрачного цвета; HTTP-заголовков; фильтра файлов.

TvipPlayer

void reset();

Сбросить воспроизведение. При переходе между страницами, если не требуется продолжение проигрывания, нужно вызывать этот метод.

void playUrl (String url, String mode);

Начать проигрывание видео по заданному URL или непосредственному пути в файловой системе.

Параметр mode может принимать значения:

vod - данный URL содержит VOD-файл (с конечной длиной);

live - дынный URL содержит live ТВ-поток (можно использовать Timeshift и DVR);

Примеры:

playUrl ("udp://239.1.1.1", "live"); // начать проигрывание multicast-потока;
playUrl ("http://domain.tv/movies/movie.mkv", ""); // начать проигрывание видео-файла по http;
playUrl ("http://domain.tv/hls/playlist.m3u8", ""); // начать проигрывание HLS-видео;

void setVideoWindow(int x, int y, int w, int x, boolean onTop);

Устанавливает размер окна видео. Координаты устанавливаются относительно текущего режима видео выхода.

Если w = 0 и h = 0, используется полноэкранный режим.

Если onTop = true, видео окно рисуется поверх UI.

void stop();

Остановить воспроизведение, если оно было запущено.

void pause();

Поставить воспроизведение на паузу.

void unpause();

Продолжить воспроизведение, если оно было поставлено на паузу.

void seek(int position);

Установить позицию воспроизведения на position в миллисекундах. Необходимо учитывать, что начало воспроизведения - это minPosition - см. ниже.

int getCurrentPositionMsec();

Возвращает текущую позицию воспроизведения.

int getMinPositionMsec();

Возвращает минимальную позицию воспроизведения (т.е. начало контента).

int getMaxPositionMsec();

Возвращает максимальную позицию воспроизведения (т.е. конца контента).

void setVolume();

Устанавливает громкость звука в интервале от 0 до 100.

int getVolume();

Возвращает текущую громкость звука в интервале от 0 до 100.

void setMute(bool mute);

Отключает (mute=true) или включает (mute=false) звук.

bool getMute();

Возвращает true, если звук выключен, иначе false;

void setAspectMode(int mode);

Устанавливает режим Aspect Ratio.

int getAspectMode();

Возвращает режим Aspect Ratio.

String getContainerType();

Возвращает тип контейнера последнего проигрываемого контента (например, mpegts, avi, matroska).

int getStreamsCount();

Возвращает количество медиапотоков в последнем проигрываемом контенте (аудио, видео, субтитров, итд).

Object getStreamInfo(int index);

Возвращает объект с информацией о медиапотоке с номером index.

{
  "type": <videotype>,
  "id": <id>,
  "codec": <codec>,
  "lang" : <lang>
}

Здесь: videotype - тип медиапотока:«v» - видео, «a» - аудио, «s» - субтитры; id - внутренний идентификатор (PID); codec - название кодека потока; lang - для аудиопотоков 3 буквенный код языка.

int getCurrentVideoStreamIndex();

Возвращает номер потока с видео-дорожкой, проигрываемой в данный момент.

int getCurrentAudioStreamIndex();

Возвращает номер потока с аудио-дорожкой, проигрываемой в данный момент.

void setCurrentAudioStreamIndex(int index);

Устанавливает номер активной аудио-дорожки (index).

TvipRecorder

String addRecord(String name, String url, String path, String start, String end);

Добавляет новое задание на запись эфира.
Здесь: name - произвольное имя записи, url - URL потока (поддерживаются потоки в формате MPEGTS через UDP, RTP и HTTP, path - локальный путь для записи, start и end - время начала и окончания записи в UNIX TIMESTAMP либо в формате «YYYYMMDDTHHmmss».
Возвращает уникальный идентификатор созданного задания.

bool cancelRecord(String id, bool removeFile);

Удаляет задание на запись с уникальным идентификатором id. Если removeFile=true, удаляется также записанный на диск поток. Возвращает true в случае успешного удаления.

void updateStartEndTime(String id, String start, String end);

Меняет время начала и/или окончания записи с уникальным идентификатором id. Если требуется поменять только одно из значений, то второе - пустая строка. Формат start и end см. в описании addRecord.

List getRecordIds();

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

Object getRecord(id);

Возвращает объект с параметрами записи с уникальным идентификатором id.

{
  "id": <id>,
  "name": <name>,
  "startTime": <start>,
  "endTime" : <end>,
  "url" : <url>,
  "status" : <status>
}

Здесь: <id>, <name>, <start>, <end> - соответствуют параметром метода addRecord; <status> - статус записи: «waiting» - ожидает запись, «recording» - запись в процессе, «finished» - запись завершена, «error» - произошла ошибка.

TvipEvent

TvipEvent содержит Callback функции, которые можно переназначить для получения событий.

onPlayerStateChange(int oldState, int newState);

Вызывается при изменении статуса воспроизведения медиаплеера. oldState - предыдущий статус плеера, newState - новый статус плеера.

Возможные значения статусов плеера:

1 - начало подключения к новому URL;
2 - получение метаданных;
3 - метаданные получены;
4 - подготовка декодеров;
5 - воспроизведение;
6 - достигнут конец контента;
7 - остановка воспроизведения;
8 - воспроизведение остановлено;
9 - воспроизведение поставлено на паузу;
10 - происходит seek на новую позицию;
11 - произошла ошибка;

onSystemEvent();

На данный момент не используется не используется.