Engine API/en

Материал из Ace Stream
(Различия между версиями)
Перейти к: навигация, поиск
(Примеры)
(Incoming commands)
Строка 50: Строка 50:
 
<tt>'''HELLOBG'''</tt>
 
<tt>'''HELLOBG'''</tt>
   
Используется в рамках процедуры "рукопожатия" между клиентом и TS Engine.
+
Used as a part of "handshake" procedure between client and TS Engine.
   
Эта команда должна быть отправлена клиентом сразу после установления tcp-соединения с TS Engine.
+
This commend must be sent by client right after establishing tcp-connection with TS Engine.
   
 
Соединение с TS Engine считается успешным после того, как клиент получил от TS Engine ответ на "рукопожатие" - команду HELLOTS
 
Соединение с TS Engine считается успешным после того, как клиент получил от TS Engine ответ на "рукопожатие" - команду HELLOTS
Строка 59: Строка 59:
 
<tt>'''READY'''</tt>
 
<tt>'''READY'''</tt>
   
Информирует TS Engine о том, что клиент готов принимать исходящие команды
+
Informs TS Engine that client is ready to receive outgoing commands
   
   
Строка 78: Строка 78:
 
'''LOADASYNC''' <request_id> '''RAW''' <torrent_data> <developer_id> <affiliate_id> <zone_id></tt>
 
'''LOADASYNC''' <request_id> '''RAW''' <torrent_data> <developer_id> <affiliate_id> <zone_id></tt>
   
Данные команды выполняют загрузку содержимого торрент-файла и используются для того, чтобы клиент мог получить список названий
+
These commands perform loading torrent-file's content. They are used to allow client to get a list of files' names in file of interest. LOAD commands are performed synchronously, LOADASYNC commands - asynchronously (response comes in outgoing command LOADRESP).
файлов в интересующем торрент-файле. Команды LOAD выполняются синхронно, команды LOADASYNC - асинхронно (ответ приходит в исходящей команде LOADRESP).
 
   
Более предпочтительным методом является асинхронная загрузка.
+
Preferred method is asynchronous loading.
   
'''Параметры:'''
+
'''Parameters:'''
   
 
<tt>'''request_id'''</tt> - случайное целое число - идентификатор запроса LOADASYNC; этот же идентификатор будет отослан клиенту в команде LOADRESP после того,как будет получен список файлов; данный идентификатор служит для того, чтобы клиент в случае отправки нескольких запросов LOAD точно знал, на какой из этих запросов получен ответ
 
<tt>'''request_id'''</tt> - случайное целое число - идентификатор запроса LOADASYNC; этот же идентификатор будет отослан клиенту в команде LOADRESP после того,как будет получен список файлов; данный идентификатор служит для того, чтобы клиент в случае отправки нескольких запросов LOAD точно знал, на какой из этих запросов получен ответ
Строка 113: Строка 113:
 
Данные команды используются для начала загрузки определенного файла из торрент-файла либо для начала загрузки файла по прямой ссылке (START URL)
 
Данные команды используются для начала загрузки определенного файла из торрент-файла либо для начала загрузки файла по прямой ссылке (START URL)
   
'''Параметры:'''
+
'''Parameters:'''
   
<tt>'''file_indexes'''</tt> - список индексов файлов из торрент-файла, которые необходимо загружать. Индексы файлов клиент получает в сообщении LOADRESP разделенных запятой. Индексы начинаются с нуля и соответствуют списку файлов,
+
<tt>'''file_indexes'''</tt> - a list of file's indexes from torrent file, which have to be loaded. Client receives file's indexes in a LOADRESP message, separated by commas. Indexes start with zero and match a list of files that was received by LOAD command. For example, if there is only one video file in torrent file, then 0 index has to be sent.
который был получен в результате выполнения команды LOAD. Например, если в торрент-файле всего один видео-файл, то необходимо отправлять индекс 0.
 
   
Если в торренте пять видео-файлов и необходимо начать проигрывание первого, но при это загружать остальные, то отправляется 0,1,2,3,4.
+
If there are 5 video files in torrent and playback has to start from the first one, but others have to be loaded, then 0,1,2,3,4 have to be sent.
   
Если нужно проиграть третий файл, и не загружать другие, отправляется 2.
+
If the third file has to be played, without loading others, 2 has to be sent.
   
<tt>'''torrent_url'''</tt> - ссылка на торрент файл (например, http://sometracker.com/torrent/12345)
+
<tt>'''torrent_url'''</tt> - link to torrent file (for example, http://sometracker.com/torrent/12345)
   
<tt>'''torrent_infohash'''</tt> - infohash торрента
+
<tt>'''torrent_infohash'''</tt> - torrent's infohash
   
<tt>'''player_id'''</tt> - код плеера
+
<tt>'''player_id'''</tt> - player's code
   
<tt>'''torrent_data'''</tt> - содержимое торрент-файла в кодировке base64
+
<tt>'''torrent_data'''</tt> - torrent-file's content, encoded in base64
   
<tt>'''direct_url'''</tt> - прямая ссылка на файл (например, http://somesite.com/files/video.mp4)
+
<tt>'''direct_url'''</tt> - direct link to file (for example, http://somesite.com/files/video.mp4)
   
<tt>'''developer_id'''</tt> - код разработчика (если неизвестно, необходимо передавать 0)
+
<tt>'''developer_id'''</tt> - developer's code (if unknown, 0 must be sent)
   
<tt>'''affiliate_id'''</tt> - код партнера (если неизвестно, необходимо передавать 0)
+
<tt>'''affiliate_id'''</tt> - partner's code (if unknown, 0 must be sent)
   
<tt>'''zone_id'''</tt> - код зоны партнера (если неизвестно, необходимо передавать 0)
+
<tt>'''zone_id'''</tt> - code of partner's zone (if unknown, 0 must be sent)
   
   
 
<tt>'''GETPID''' <infohash> <developer_id> <affiliate_id> <zone_id></tt>
 
<tt>'''GETPID''' <infohash> <developer_id> <affiliate_id> <zone_id></tt>
   
Получение кода плеера по набору параметров. Эта команда является синхронной командой (см.ниже). В ответ отправляется код плеера, либо пустая строка, если код плеера не может быть получен
+
Getting code of the player through a set of parameters. This command is a synchronous command (see below). In response player's code or empty string (if player's code can't be received) is sent.
   
   
 
<tt>'''SHUTDOWN'''</tt>
 
<tt>'''SHUTDOWN'''</tt>
   
Закрыть соединение с клиентом.
+
Close connection with client.
   
   
 
<tt>'''STOP'''</tt>
 
<tt>'''STOP'''</tt>
   
Остановить загрузку файла, который загружается в данный момент.
+
Stop loading file that is being loaded at this moment.
   
   
 
<tt>'''DUR''' <video_url> <duration></tt>
 
<tt>'''DUR''' <video_url> <duration></tt>
   
Сообщить TS Engine о длительности видео-файла, который в данный момент проигрывается клиентом.
+
Inform TS Engine about duration of video file that is being played by client at this moment. This command must be sent right after client had determined content duration.
Данная команда должна отправлять сразу после того, как клиент определил длительность контента.
 
   
'''Параметры:'''
+
'''Parameters:'''
   
<tt>'''video_url'''</tt> - ссылка на видео, которая была отправлена клиенту после окончания пребуферизации
+
<tt>'''video_url'''</tt> - link to video, which was sent to client after the end of pre-buffering
   
<tt>'''duration'''</tt> - длительность в миллисекундах
+
<tt>'''duration'''</tt> - duration in milliseconds
   
   
 
<tt>'''PLAYBACK''' <video_url> <event></tt>
 
<tt>'''PLAYBACK''' <video_url> <event></tt>
   
Сообщить TS Engine о процентном соотношении проигранного видео
+
Inform TS Engine about percentage of played video
   
Данная команда особенно важна, когда идет прогрывание рекламных роликов - переход к основному видео происходит только после того,
+
This command is especially important when playing advertising video - transition to the main video happens only after TS Engine gets command PLAYBACK 100 (after client has played advertising video till the end)
как TS Engine получил команду PLAYBACK 100 (т.е. после того, как клиент полность проиграл рекламный ролик)
 
   
'''Параметры:'''
+
'''Parameters:'''
   
<tt>'''video_url'''</tt> - ссылка на видео, которая была отправлена клиенту после окончания пребуферизации
+
<tt>'''video_url'''</tt> - link to video, which was sent to client after the end of pre-buffering
   
<tt>'''event'''</tt> - одно из данных событий:
+
<tt>'''event'''</tt> - one of these events:
   
0 - начало проигрывания
+
0 - starting playback
   
25 - проиграно 25% видео
+
25 - 25% of video has been played
   
50 - проиграно 50% видео
+
50 - 50% of video has been played
   
75 - проиграно 75% видео
+
75 - 75% of video has been played
   
100 - проиграно 100% видео
+
100 - 100% of video has been played
   
 
== Исходящие команды ==
 
== Исходящие команды ==

Версия 15:08, 24 декабря 2012

Data exchange with TS Engine happens via TCP protocol.

By default TS Engine accepts incoming connections in port 62062.


Содержание

General form of commands

Each command must consist of a string terminated by a separator \r\n

Most of commands have such form:

CMD [param1] [param2] ...

where

CMD - predefined command name

param1, param2 ... - command's parameters, separated by a space

Commands' types

All commands are divided into incoming and outgoing.

Incoming commands are sent from a client to TS Engine. Client is any software that uses TS Engine functions. Using incoming commands the client controls TS Engine.

Outgoing commends are sent from TS Engine to the client. This type of commands is used to inform the client about work of TS Engine.

Synchronous commands

Most of incoming commands are performed asynchronously, ie. for these commands there is no such thing as "response to command".

Examples of asynchronous commands:

- client sends LOADASYNC, after loading content TS Engine sends LOADRESP after a while

- client sends START, after the end of pre-buffering TS Engine sends PLAY


But there are also commands that are performed synchronously, in "request-response" mode. At the moment, there are two such commands: LOAD and GETPID.

Synchronous command assumes the response, sent from TS Engine to the client as a string, starting with ##.

Processing of synchronous commands from client's side should look like this:

- client sends a command (for example, "GETPID qwerty 0 0 0") and waits for response from TS Engine

- if a message starting with ## is received from TS Engine, this message is considered as response to synchronous command (for example, ##12345)

Incoming commands

HELLOBG

Used as a part of "handshake" procedure between client and TS Engine.

This commend must be sent by client right after establishing tcp-connection with TS Engine.

Соединение с TS Engine считается успешным после того, как клиент получил от TS Engine ответ на "рукопожатие" - команду HELLOTS


READY

Informs TS Engine that client is ready to receive outgoing commands


LOAD TORRENT <torrent_url> <developer_id> <affiliate_id> <zone_id>

LOAD INFOHASH <torrent_infohash> <developer_id> <affiliate_id> <zone_id>

LOAD PID <player_id>

LOAD RAW <torrent_data> <developer_id> <affiliate_id> <zone_id>

LOADASYNC <request_id> TORRENT <torrent_url> <developer_id> <affiliate_id> <zone_id>

LOADASYNC <request_id> INFOHASH <torrent_infohash> <developer_id> <affiliate_id> <zone_id>

LOADASYNC <request_id> PID <player_id>

LOADASYNC <request_id> RAW <torrent_data> <developer_id> <affiliate_id> <zone_id>

These commands perform loading torrent-file's content. They are used to allow client to get a list of files' names in file of interest. LOAD commands are performed synchronously, LOADASYNC commands - asynchronously (response comes in outgoing command LOADRESP).

Preferred method is asynchronous loading.

Parameters:

request_id - случайное целое число - идентификатор запроса LOADASYNC; этот же идентификатор будет отослан клиенту в команде LOADRESP после того,как будет получен список файлов; данный идентификатор служит для того, чтобы клиент в случае отправки нескольких запросов LOAD точно знал, на какой из этих запросов получен ответ

torrent_url - ссылка на торрент файл (например, http://sometracker.com/torrent/12345)

torrent_infohash - infohash торрента

player_id - код плеера

torrent_data - содержимое торрент-файла в кодировке base64

developer_id - код разработчика (если неизвестно, необходимо передавать 0)

affiliate_id - код партнера (если неизвестно, необходимо передавать 0)

zone_id - код зоны партнера (если неизвестно, необходимо передавать 0)


START TORRENT <torrent_url> <file_indexes> <developer_id> <affiliate_id> <zone_id>

START INFOHASH <torrent_infohash> <file_indexes> <developer_id> <affiliate_id> <zone_id>

START PID <player_id> <file_indexes>

START RAW <torrent_data> <file_indexes> <developer_id> <affiliate_id> <zone_id>

START URL <direct_url> <file_indexes> <developer_id> <affiliate_id> <zone_id>)

Данные команды используются для начала загрузки определенного файла из торрент-файла либо для начала загрузки файла по прямой ссылке (START URL)

Parameters:

file_indexes - a list of file's indexes from torrent file, which have to be loaded. Client receives file's indexes in a LOADRESP message, separated by commas. Indexes start with zero and match a list of files that was received by LOAD command. For example, if there is only one video file in torrent file, then 0 index has to be sent.

If there are 5 video files in torrent and playback has to start from the first one, but others have to be loaded, then 0,1,2,3,4 have to be sent.

If the third file has to be played, without loading others, 2 has to be sent.

torrent_url - link to torrent file (for example, http://sometracker.com/torrent/12345)

torrent_infohash - torrent's infohash

player_id - player's code

torrent_data - torrent-file's content, encoded in base64

direct_url - direct link to file (for example, http://somesite.com/files/video.mp4)

developer_id - developer's code (if unknown, 0 must be sent)

affiliate_id - partner's code (if unknown, 0 must be sent)

zone_id - code of partner's zone (if unknown, 0 must be sent)


GETPID <infohash> <developer_id> <affiliate_id> <zone_id>

Getting code of the player through a set of parameters. This command is a synchronous command (see below). In response player's code or empty string (if player's code can't be received) is sent.


SHUTDOWN

Close connection with client.


STOP

Stop loading file that is being loaded at this moment.


DUR <video_url> <duration>

Inform TS Engine about duration of video file that is being played by client at this moment. This command must be sent right after client had determined content duration.

Parameters:

video_url - link to video, which was sent to client after the end of pre-buffering

duration - duration in milliseconds


PLAYBACK <video_url> <event>

Inform TS Engine about percentage of played video

This command is especially important when playing advertising video - transition to the main video happens only after TS Engine gets command PLAYBACK 100 (after client has played advertising video till the end)

Parameters:

video_url - link to video, which was sent to client after the end of pre-buffering

event - one of these events:

0 - starting playback

25 - 25% of video has been played

50 - 50% of video has been played

75 - 75% of video has been played

100 - 100% of video has been played

Исходящие команды

HELLOTS

ответная команда в рамках процедуры рукопожатия


AUTH <auth_level>

Уровень доступа пользователя

auth_level - целое число - уровень доступа

На данный момент возможны два значения уровня доступа:

0 - пользователю не доступны расширенные функции (перемотка и проигрывание файлов из торрента с несколькими видео-файлами)

1 - пользователю доступны расширенные функции


STATE <state_id>

Информация о текущем статусе TS Engine


SHUTDOWN

TS Engine завершил работу


PLAY <video_url>

PLAYAD <video_url>

PLAYADI <video_url>

Начать проигрывание видео по ссылке video_url (данная ссылка ведет на http-сервер, встроенный в TS Engine).

PLAY - проигрывание основного видео

PLAYAD - проигрывание непрерываемого рекламного ролика (пользователь не может перемотать либо пропустить данный рекламный ролик)

PLAYADI - проигрывание прерываемого рекламного ролика (пользователь может перемотать либо пропустить данный рекламный ролик)


PAUSE

TS Engine начал буферизацию, так как недостаточно данных для проигрывания видео без остановки


RESUME

TS Engine завершил буферизацию


LOADRESP <request_id> <response>

Ответ на команду LOAD

request_id - идентификатор запроса

response - список файлов в формате json в такого вида:

{
 "status": 1,
 "infohash": "abcd1234",
 "files": [
   ["file1.mp4", 0],
   ["file2.avi", 1],
   ["file3.mkv", 5]
 ]
}

status - 0: в торренте нет видео файлов, 1 - в торренте один видео файл, 2 - в торренте более одного видео файла

infohash - infohash торрента

files - список файлов; это массив, каждый элемент в котором состоит из массива из двух элементов: первый - название файла, второй - позиция файла в торренте (эта позиция должна отправляться в команде START для указания, какой именно файл необходимо загружать, если их несколько).

Имена файлов передаются в кодировке UTF-8 в urlencoded виде.


INFO <message_id>;<message_text>

Информационное сообщение

message_id - код сообщения

message_text - текст сообщения


STATUS <status_string>

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

status_string - строка описанного ниже формата


Если идет проигрывание основного контента

STATUS main:status_string


Если идет проигрывание рекламного ролика:

STATUS main:status_string|ad:status_string


status_string:

TS Engine ничего не делает - idle

ошибка - err;error_id;error_message (код и описание)

проверка - check;progress

пребуферизация - prebuf;progress;time

закачка - dl

буферизация - buf;progress;time

ожидание достаточной скорости - wait;time


Ко всем status_string (кроме idle, err, check) добавляются общие данные:

total_progress;immediate_progress;speed_down;http_speed_down;speed_up;peers;http_peers;downloaded;http_downloaded;uploaded

total_progress - сколько всего закачано по данному файлу

immediate_progress - сколько непрерывных данных закачано начиная с текущей позиции (для отображения кол-ва закачанного в бегунке)


Все числа передаются как integer.

Все progress принимают значение от 0 до 100.


Примеры:

STATUS main:prebuf;45;30|ad:buf;69
STATUS main:dl|ad:dl

Пример трансформация статусов в текстовые сообщения, понятные пользователю:

check - Checking xx%
prebuf - Prebuffering xx%
buf - Buffering xx%
wait - Waiting sufficient download speed
err - выводим сообщение об ошибке
dl, idle - ничего не выводим

События

EVENT event_name param1_name=param1_value param2_name=param2_value ...

Параметры не обязательны.

Значения параметров - urlencoded utf-8


Examples

>> - messages from client to TS Engine

<< - messages from TS Engine to client


1) Playback of torrent-file by link without commercials (TS Engine determines whether it's needed to play commercials).

Asynchronous command LOADASYNC is used to load torrent's content.

Torrent file contains one video file.


handshake

>>HELLOBG
<<HELLOTS

client is ready to receive messages

>>READY

advanced functions are available for user

<<AUTH 1

load torrent by link

>>LOADASYNC 467763 TORRENT http://rutor.org/download/67346 0 0 0
<<LOADRESP 467763 {"status": 1, "files": [["Prey%202_%20E3%202011%20Official%20Trailer_2.mp4", 0]], "infohash":  
"4c78e1cf0df23b4f5a16a106829ebed710cb52e0"}

get player's code (for example, to show it to user)

>>GETPID 4c78e1cf0df23b4f5a16a106829ebed710cb52e0 0 0 0
<<##36ae4c89ab45b4010b1461c513da38d007356195

start video pre-buffering

>>START TORRENT http://rutor.org/download/67346 0 0 0 0

pre-buffering is in the process

<<STATE 1
<<STATUS main:prebuf;0;2147483447;0;0;0;0;0;0;0;0;0;0
<<STATUS main:prebuf;0;2132;0;0;29;0;0;8;0;131072;0;0
<<STATUS main:prebuf;8;942;0;0;60;0;0;9;0;393216;0;0
<<STATUS main:prebuf;50;591;0;0;87;0;0;8;0;835584;0;0
<<STATUS main:prebuf;75;497;0;0;98;0;0;8;0;1146880;0;0
<<STATUS main:prebuf;91;448;0;0;105;0;0;8;0;1441792;0;0

pre-buffering is finished, client gets a link for content playback

<<PLAY http://127.0.0.1:6878/content/4c78e1cf0df23b4f5a16a106829ebed710cb52e0/0.673752283974
<<STATE 2

client sends content duration (~201 seconds)

>>DUR http://127.0.0.1:6878/content/4c78e1cf0df23b4f5a16a106829ebed710cb52e0/0.673752283974 201964

client informs that playback was started

>>PLAYBACK http://127.0.0.1:6878/content/4c78e1cf0df23b4f5a16a106829ebed710cb52e0/0.673752283974 0

TS Engine loads content

<<STATUS main:dl;0;0;110;0;0;8;0;1622016;0;0
<<STATUS main:dl;0;0;128;0;0;8;0;2965504;0;0
<<STATUS main:dl;0;0;130;0;0;8;0;3129344;0;0

TS Engine doesn't have enough data for playback, starts buffering

<<PAUSE
<<STATE 3
<<STATUS main:buf;0;315;0;0;130;0;0;8;0;3260416;0;0
<<STATUS main:buf;90;299;0;0;133;0;0;8;0;3866624;0;0
<<STATUS main:buf;90;278;0;0;138;0;0;8;0;4390912;0;0

buffering is finished

<<RESUME
<<STATE 2
<<STATUS main:dl;0;0;141;0;0;8;0;4898816;0;0

client lost 25% of content

>>PLAYBACK http://127.0.0.1:6878/content/4c78e1cf0df23b4f5a16a106829ebed710cb52e0/0.673752283974 25
<<STATUS main:dl;0;0;141;0;0;8;0;4898816;0;0
<<STATUS main:dl;0;0;146;0;0;7;0;8388608;0;0

client lost 50% of content

>>PLAYBACK http://127.0.0.1:6878/content/4c78e1cf0df23b4f5a16a106829ebed710cb52e0/0.673752283974 50
<<STATUS main:dl;0;0;145;0;0;7;0;9404416;0;0

client lost 75% of content

>>PLAYBACK http://127.0.0.1:6878/content/4c78e1cf0df23b4f5a16a106829ebed710cb52e0/0.673752283974 75
<<STATUS main:dl;0;0;146;0;0;7;0;9568256;0;0

stop content loading

>>STOP
<<STATE 0

disconnect

>>SHUTDOWN
<<SHUTDOWN
Персональные инструменты
На других языках