This API function allows processing an Auto-Encoding Clip (add encoding tasks to the queue and launch the encoding process).
support, ws.webtv, api, clips, process_auto_encoding_clip
GET vars specific to this request:
Var | Value | Description |
go | clips | The API section |
do | process_auto_encoding_clip | The API action |
iq | Clip ID | Clip ID |
Resulting Request URL:
The resulting request URL would be similar to this (don't forget to append the required info: key, timestamp, salt and signature):
https://....../api.php?go=clips&do=process_auto_encoding_clip&iq={clip_id}&{required information}
The following POST vars are optional.
Var | Value | Description |
generate_thumbnail | (int) 0 | 1 | Whether to generate the thumbnail/poster images. Ops: 0 (No), 1 (Yes). |
generate_sprite | (int) 0 | 1 | Whether to generate the sprite - video preview. Ops: 0 (No), 1 (Yes) |
encode_media | (int) 0 | 1 | Whether to encode the video files. Ops: 0 (No), 1 (Yes) |
start_processing | (int) 0 | 1 | Whether to start processing the tasks right away. Ops: 0 (No, add tasks to queue only), 1 (Yes) |
activate_when_done | (int) 0 | 1 | Whether to activate the Clip after all tasks are completed. Ops: 0 (No), 1 (Yes) |
delete_source_when_done | (int) 0 | 1 | Whether to delete the encoding source video file after all tasks are completed (and succeeded). Ops: 0 (No), 1 (Yes) |
If the request was successful, you'll receive a response containing:
• ok: If the Clip encoding tasks were added to the queue.
Example:
{ "ok" : "The Clip encoding tasks were queued and processing was launched" } |
If the request failed (for example, if the Auto-Encoding Clip does not have encoding source video file), you'll receive a response like the following:
{ "error" : "CLIP_MEDIA_ERROR" , "error_long" : "The Clip does not have an associated encoding source" } |
Possible Error Messages
Besides the general errors, this request can return the following errors:
• REQUEST_ERROR | Invalid Clip ID:
The Clip ID is not valid.
• CLIP_NOT_FOUND | It was not possible to find a Clip with the supplied ID:
The Clip was not found.
• CLIP_TYPE_ERROR | The provided Clip ID corresponds to a non-Auto-Encoding Clip
• CLIP_MEDIA_ERROR | The Clip does not have an associated encoding source
• CLIP_TASKS_BEING_PROCESSED_ERROR | The Clip already has encoding tasks being processed
• CLIP_PENDING_TASKS_ERROR | The Clip has encoding tasks pending processing
• CLIP_OTHER_TASK_ERROR | Other task error occurred
Other unexpected task error occurred.
Preparing GET and POST data.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | // The GET vars $GET_VARS = array ( "go" => "clips" , "do" => "process_auto_encoding_clip" , "iq" => 700 ); // The POST vars $POST_VARS = array ( "generate_thumbnail" => 1, "generate_sprite" => 1, "encode_media" => 1, "start_processing" => 1, "activate_when_done" => 0, "delete_source_when_done" => 0, ); |
Generating the salt, timestamp, signature and sending the request
*** The following code block is common to all signed requests ***
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 | // Collect the API Base URL and Credential info $API_KEY_ID = "1b323a1cb879fd4e66530fbad07a32ee" ; $API_SHARED_SECRET = "MWIzMjNhMWNiODc5ZmQ0ZTY2NTMwZmJhZDA3YTMyZWViOTQ3MDJiOGM2ZTU2NjE3" ; // keep this safe!!! // Generating salt and timestamp $salt = md5(mt_rand()); $timestamp = time(); $signature = base64_encode (hash_hmac( 'sha256' , $salt . $timestamp , $API_SHARED_SECRET , true)); // Generating the validation signature // - Default method: using base64_encode(hash_hmac(...)) $signature = base64_encode (hash_hmac( 'sha256' , $salt . $timestamp , $API_SHARED_SECRET , true)); // comment this line if using the next method // - Simplified method - available since v60: using md5(). // This method requires the variable $API_SIGNATURE_GENERATION_MODE = 1; in the config/Config.inc.php file. // $signature = md5($salt."-".$timestamp."-".$API_SHARED_SECRET); // you must "uncomment" this line when using the simplified method // Append the timestamp, salt, key and signature to the GET vars $GET_VARS [ "timestamp" ] = $timestamp ; // UTC timestamp $GET_VARS [ "salt" ] = $salt ; $GET_VARS [ "key" ] = $API_KEY_ID ; // The API Key ID: This is public and is used by the API to identify the application; $GET_VARS [ "signature" ] = $signature ; // Create the request URL. Please note that if you do not use PHP buit in function // to create the HTTP query then don't forget to URL encode the values $REQUEST_URL = $API_URL . "?" .http_build_query( $GET_VARS ); // The previous will build an URL like .../api.php?go=api_subject&do=api_action&etc... // Create a new cURL resource and set the appropriate options $ch = curl_init(); curl_setopt( $ch , CURLOPT_URL, $REQUEST_URL ); curl_setopt( $ch , CURLOPT_POST, true); curl_setopt( $ch , CURLOPT_RETURNTRANSFER, true); curl_setopt( $ch , CURLOPT_HEADER, false); curl_setopt( $ch , CURLOPT_POSTFIELDS, $POST_VARS ); // If your PHP host does not have a valid SSL certificate, you will need to turn off SSL // Certificate Verification. This is dangerous (!), and should only be done temporarily // until a valid certificate has been installed curl_setopt( $ch , CURLOPT_SSL_VERIFYHOST, false); // Turns off verification of the SSL certificate. curl_setopt( $ch , CURLOPT_SSL_VERIFYPEER, false); // Turns off verification of the SSL certificate. // Sending the request to the API $response = curl_exec( $ch ); // Processing the response if (! $response ) { echo 'API call failed' ; } else { print_r(json_decode( $response ,true)); } |