Methods 1.1:getConversion/ru
From Aviberry API
К содержанию
Другие методы
Возникли вопросы?
getConversion - Метод возвращает полную информацию о задаче.
Contents |
Сигнатура
object getConversion( mixed conversion_id )
Параметры
conversion_id
conversion_id - Идентификатор задачи, информацию о которой необходимо получить, или массив таких идентификаторов.
Тип: mixed.
Возвращаемое значение
Тип: object.
Результат вызова метода - объект, содержащий пары ключ=значение, где ключ - это идентификатор задачи, а значение - объект, содержащий информацию о задаче и имеющий следующий набор свойств:
conversion_id
conversion_id - Идентификатор задачи.
Тип: string.
source_url
source_url - Массив ссылок на исходное видео, указанный при постановке задачи и преобразованный к тому виду, в каком он попадает на обработку.
Тип: array.
Если при постановке задачи была задана только одна ссылка как строковый параметр, то она будет преобразована в массив из одного элемента.
target_url
target_url - Массив ссылок на сконвертированные файлы, указанный при постановке задачи и преобразованный к тому виду, в каком он попадает на обработку.
Тип: array.
Ссылки в массиве target_url всегда группируются по профилям, заданным в параметре preset при вызове метода startConversion. Таким образом, подготовленный к обработке массив target_url всегда является двухуровневым: на первом уровне - массив профилей, на втором - массивы имен файлов назначения для каждого профиля.
preset
preset - Массив профилей, указанный при постановке задачи и преобразованный к тому виду, в каком он попадает на обработку.
Тип: array.
Если при постановке задачи параметр preset был задан как единственный объект, то он будет преобразован в массив из одного элемента.
transform
transform - Настройки трансформации, указанные при постановке задачи и преобразованные к тому виду, в каком они попадают на обработку.
Тип: object.
preview
preview - Настройки стоп-кадра, указанные при постановке задачи и преобразованные к тому виду, в каком они попадают на обработку.
Тип: object.
callback
callback - Настройки функции обратного вызова, указанные при постановке задачи и преобразованные к тому виду, в каком они попадают на обработку.
Тип: object.
params
params - Дополнительные параметры, указанные при постановке задачи и преобразованные к тому виду, в каком они попадают на обработку.
Тип: object.
data
data - Объект с пользовательскими данными, ассоциированный с задачей при её создании.
Тип: object.
status
status - Статус конвертации. Может иметь одно из значений указанных в разделе Статусы конвертации.
Тип: string.
Для получения более подробной информации о текущем статусе конвертации следует использовать метод getProgress.
time_created
time_created - GMT-время создания задачи и постановки её в общую очередь ожидания свободного сервера конвертаций. Время представляется в формате YYYY-MM-DD HH:MM:SS.
Тип: string.
time_started
time_started - GMT-время постановки задачи в локальную очередь на сервере конвертаций. Время представляется в формате YYYY-MM-DD HH:MM:SS.
Тип: string.
time_finished
time_finished - GMT-время завершения обработки задачи. Время представляется в формате YYYY-MM-DD HH:MM:SS.
Тип: string.
result
result - Массив с результатами конвертации.
Тип: array.
Массив имеет несколько уровней вложенности:
- Первый уровень - группировка по профилям (preset), заданным при постановке задачи, с сохранением того же порядка, который был указан при вызове метода startConversion.
- Второй уровень - группировка по файлам назначения (target_url), заданным при постановке задачи, с сохранением того же порядка, который был указан при вызове метода startConversion.
- Третий уровень - результирующий файл или его части (если было задано преобразование Разделение). В случае, если преобразование Разделение не использовалось, то данный массив состоит из единственного элемента - результата конвертации.
На последнем уровне вложенности каждый файл представляется объектом со следующими свойствами:
- result_url - ссылка на сконвертированный файл;
- preview_url - ссылка на соответствующий стоп-кадр.
- media_info - набор параметров с информацией о сконвертированном файле, полученных в результате использования флага GetMediaInfo. Если флаг GetMediaInfo не использовался, или результата конвертации нет (конвертация не завершилась или завершилась с ошибкой), то свойство media_info не передается (в этом случае объект будет содержать только два свойства).
Структуру возвращаемого массива в общем виде можно представить следующей схемой:
result presets | files | | parts | | | result_url | | | preview_url | | | media_info | | ... | ... ...
или, если воспользоваться синтаксисом JSON:
"result": [
0 : [ // Индекс профиля
0 : [ //Индекс файла
0 : { // Индекс части файла
"result_url" : "..." // URL файла-результата
"preview_url" : "..." // URL картинки-предпросмотра
"media_info" : "..." // набор параметров с информацией о сконвертированном файле
},
...
],
...
],
...
]
error_code
error_code - Код ошибки (только для статуса finished).
Тип: integer.
error_message
error_message - Расширенное сообщение об ошибке (только для статуса finished).
Тип: string.
Примеры
XML-RPC
Вызов getConversion
<methodCall>
<methodName>getConversion</methodName>
<params>
<param>
<value>
<string>2011_12-29_22_3210-36661800</string>
</value>
</param>
</params>
</methodCall>Возвращаемое значение
<methodResponse>
<params>
<param><value><struct><member>
<name>2012_01-09_22_5131-49845800</name>
<value><struct>
<member>
<name>conversion_id</name>
<value>
<string>2012_01-09_22_5131-49845800</string>
</value>
</member>
<member>
<name>status</name>
<value>
<string>canceled</string>
</value>
</member>
<member>
<name>error_code</name>
<value>
<i4>0</i4>
</value>
</member>
<member>
<name>error_message</name>
<value>
<string/>
</value>
</member>
<member>
<name>source_url</name>
<value>
<array>
<data>
<value>
<string>ftp://user:password@host/path/src.mp4</string>
</value>
</data>
</array>
</value>
</member>
<member>
<name>target_url</name>
<value>
<array>
<data>
<value>
<array>
<data>
<value>
<string>ftp://user:password@host/path/res.mp4</string>
</value>
</data>
</array>
</value>
</data>
</array>
</value>
</member>
<member>
<name>preset</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>format_id</name>
<value>
<i4>16500</i4>
</value>
</member>
<member>
<name>preset_id</name>
<value>
<i4>442</i4>
</value>
</member>
<member>
<name>preset_data</name>
<value>
<string/>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
<member>
<name>transform</name>
<value>
<struct>
<member>
<name>stdClass</name>
<value/>
</member>
</struct>
</value>
</member>
<member>
<name>preview</name>
<value>
<struct>
<member>
<name>resize_method</name>
<value>
<i4>1</i4>
</value>
</member>
<member>
<name>resize_quality</name>
<value>
<i4>1</i4>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>callback</name>
<value>
<struct>
<member>
<name>url</name>
<value>
<string/>
</value>
</member>
<member>
<name>method</name>
<value>
<string/>
</value>
</member>
<member>
<name>protocol</name>
<value>
<string>json</string>
</value>
</member>
<member>
<name>associate_with</name>
<value>
<string>PARENT</string>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>params</name>
<value>
<struct>
<member>
<name>target_filename_policy</name>
<value>
<string>OVERWRITE_EXTENSION</string>
</value>
</member>
<member>
<name>overwrite_target_file</name>
<value>
<boolean>0</boolean>
</value>
</member>
<member>
<name>join_source_files</name>
<value>
<boolean>0</boolean>
</value>
</member>
<member>
<name>source_url_encoding</name>
<value>
<string>UTF-8</string>
</value>
</member>
<member>
<name>source_url_check_file_exists</name>
<value>
<boolean>1</boolean>
</value>
</member>
<member>
<name>source_filename_encoding</name>
<value>
<string>UTF-8</string>
</value>
</member>
<member>
<name>target_url_encoding</name>
<value>
<string>UTF-8</string>
</value>
</member>
<member>
<name>target_url_add_folder_preset</name>
<value>
<boolean>0</boolean>
</value>
</member>
<member>
<name>target_url_check_file_exists</name>
<value>
<boolean>1</boolean>
</value>
</member>
<member>
<name>target_filename_encoding</name>
<value>
<string>UTF-8</string>
</value>
</member>
<member>
<name>target_filename_add_task_id</name>
<value>
<boolean>0</boolean>
</value>
</member>
<member>
<name>s3_storage_class</name>
<value>
<string>STANDARD</string>
</value>
</member>
<member>
<name>priority</name>
<value>
<string>5</string>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>data</name>
<value>
<struct>
<member>
<name>stdClass</name>
<value>
<string/>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>result</name>
<value>
<array>
<data>
<value>
<array>
<data>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>result_url</name>
<value>
<string>ftp://user:password@host/path/res.mp4</string>
</value>
</member>
<member>
<name>preview_url</name>
<value>
<string>ftp://user:password@host/path/res.mp4.jpg</string>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</data>
</array>
</value>
</data>
</array>
</value>
</member>
<member>
<name>time_created</name>
<value>
<string>2012-01-30 16:35:54</string>
</value>
</member>
<member>
<name>time_started</name>
<value>
<string>2012-01-30 16:36:04</string>
</value>
</member>
<member>
<name>time_finished</name>
<value>
<string>2012-01-30 16:36:18</string>
</value>
</member>
</struct></value>
</member></struct></value></param>
</params>
</methodResponse>JSON-RPC
Вызов getConversion
{
"version":"1.1",
"method":"getConversion",
"id":1,
"params":
{
"conversion_id":"2011_12-29_22_3210-36661800"
}
}Возвращаемое значение
{
"version":"1.1",
"id":1,
"result":
{
"2012_01-09_22_5131-49845800":
{
"conversion_id":"2012_01-09_22_5131-49845800",
"status":"canceled",
"error_code":0,
"error_message":"",
"source_url":["ftp:\/\/user:password@host\/path\/src.mp4"],
"target_url":[["ftp:\/\/user:password@host\/path\/res.mp4"]],
"preset":[
{
"format_id":16500,
"preset_id":442,
"preset_data":""
}]
"transform":{},
"preview":
{
"resize_method":1,
"resize_quality":1
},
"callback":
{
"url":"",
"method":"",
"protocol":"json",
"associate_with":"PARENT"
},
"params":
{
"target_filename_policy":"OVERWRITE_EXTENSION",
"overwrite_target_file":false,
"join_source_files":false,
"source_url_encoding":"UTF-8",
"source_url_check_file_exists":true,
"source_filename_encoding":"UTF-8",
"target_url_encoding":"UTF-8",
"target_url_add_folder_preset":false,
"target_url_check_file_exists":true,
"target_filename_encoding":"UTF-8",
"target_filename_add_task_id":false,
"s3_storage_class":"STANDARD",
"priority":"5"
},
"data":{},
"result":[[[
{
"result_url":"ftp:\/\/user:password@host\/path\/res.mp4",
"preview_url":"ftp:\/\/user:password@host\/path\/res.mp4.jpg"
}]]],
"time_created":"2012-01-30 16:35:54",
"time_started":"2012-01-30 16:36:04",
"time_finished":"2012-01-30 16:36:18"
}
}
}