Methods 1.1:getConversion
From Aviberry API
 |
Language: |
English • Русский |
Contents
Other methods
Still have a question?
getConversion - returns complete information about conversion.
Contents |
Signature
object getConversion( mixed conversion_id )
Parameters
conversion_id
conversion_id - identifier of conversion which information is to get, or identifier array.
Type: mixed.
Return value
Type: object.
Returns object containing matches key=value, where key is conversion identifier, and value - object containing information about conversion and having the following properties:
conversion_id
conversion_id - identifier of conversion which information is returned.
Type: string.
source_url
source_url - value represents source URL array specified at conversion creation.
Type: array.
If at conversion start only one URL was defined as string parameter, then the actual value for source_url is array with one element.
target_url
target_url - value represents target URL array specified at conversion creation.
Type: array.
Target file URLs are always grouped by presets, since they were set in preset parameter at conversion start in startConversion method. Thus, the actual target_url array always has two levels: preset array on first level, target file names for each preset - on second level.
preset
preset - value represents preset settings specified at conversion creation.
Type: array.
If at conversion start preset parameter was set as single object, then array with single object will be returned.
transform
transform - value represents actual object with transformation settings specified at conversion creation.
Type: object.
preview
preview - value represents actual object with preview settings specified at conversion creation.
Type: object.
callback
callback - value represents actual object with callback function settings specified at conversion creation.
Type: object.
params
params - value represents actual object with params execution settings specified at conversion creation.
Type: object.
data
data - object with custom data associated with conversion at its creation.
Type: object.
status
status - conversion status. See Conversion statuses section for possible values.
Type: string.
For more detailed information on actual conversion status, use getProgress method.
time_created
time_created - GMT time of conversion creation and queuing. Time is displayed in format YYYY-MM-DD HH:MM:SS.
Type: string.
time_started
time_started - GMT time of conversion process start. Time is displayed in format YYYY-MM-DD HH:MM:SS.
Type: string.
time_finished
time_finished - GMT time of conversion process completion. Time is displayed in format YYYY-MM-DD HH:MM:SS.
Type: string.
result
result - array with conversion results.
Type: array.
Array has several nesting levels:
- First level is array that represents results grouped by presets specified at conversion creation. Elements in array are located in the same order as presets were specified when calling startConversion method.
- Second level is array grouped by target files, defined at conversion creation. Elements in array are located in the same order as target files were specified when calling startConversion method.
- Third level is array, being a set of parts of which consists the output file. Output file can consist of parts if, for example, Split transformation is used. If output file wasn't split, the array consists of single part and file part array has only one element.
At the last nesting level every part of output file represents an object with two properties:
- result_url - output file URL;
- preview_url - output file image preview URL.
General structure of returned array can be represented by the following scheme:
result presets | files | | parts | | | result_url | | | preview_url | | ... | ... ...
or, if using JSON syntax:
"result": [
0 : [ // Preset index
0 : [ //File index
0 : { // File part index
"result_url" : "..." // Output file URL
"preview_url" : "..." // Image preview URL
},
...
],
...
],
...
]
Let's take an example. We make call startConversion with such "simplest" parameters (pseudocode):
object preset;
preset[ "format_id"] = 16500;
string conversion_id = startConversion( "ftp://example.org/file.flv", "ftp://example.org/file.avi", preset);
I.e. we convert one source file in one target file using single preset (preset by default for AVI format). For successful completion of file conversion we make call via getConversion method (pseudocode):
object conversion = getConversion(conversion_id);Target file URL should be received like this (pseudocode):
string file_url = conversion["result"][0][0][0]["result_url"];I.e. we refer to conversion result ["result"] that used one preset [0] and converted source file in one target file [0], target file in one part [0] (file wasn't split), and we take the URL to this single part ["result_url"].
error_code
error_code - error code. Actual value is kept only for finished status.
Type: integer.
error_message
error_message - detailed error message. Actual value is kept only for finished status.
Type: string.
media_info
media_info - set of parameters containing information about converted file. Can be obtained when using GetMediaInfo flag.
Type: object.
If GetMediaInfo flag is not used, then media_info object is not returned.
Example of media_info content:
"media_info":
{"General":{"VideoCount":"1","Video_Format_List":"AVC","AudioCount":"1","Audio_Format_List":"AAC"},
"Audio":{"Format":"AAC","SamplingRate":"48000"},
"Video":{"Width":"320","Height":"180"}}
Examples
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"
}
}
}Contents
Other methods
Still have a question?
|
Language: |
English • Русский |
