Esta función del API le permite procesar un Clip Auto-Compresión (añadir tareas de compresión a la cola y lanzar el proceso de compresión).
soporte, ws.webtv, api, clips, process_auto_encoding_clip
Variables GET específicas para esta solicitud:
Var | Valor | Descripción |
go | clips | La sección del API |
do | process_auto_encoding_clip | La acción del API |
iq | ID Clip | ID del Clip |
URL Resultante:
La URL de solicitud resultante sería similar a la siguiente (no se olvide de añadir la información requerida key, timestamp, salt and signature):
https://....../api.php?go=clips&do=process_auto_encoding_clip&iq={id_clip}&{información requerida}
La siguientes variables POST son opcionales.
Var | Value | Description |
generate_thumbnail | (int) 0 | 1 | Si se desea generar las imágenes miniatura/poster. Ops: 0 (No), 1 (Sí). |
generate_sprite | (int) 0 | 1 | Si se desea generar el sprite - previsualización de vídeo. Ops: 0 (No), 1 (Sí) |
encode_media | (int) 0 | 1 | Si se desea comprimir los archivos de vídeo. Ops: 0 (No), 1 (Sí) |
start_processing | (int) 0 | 1 | Si se desea comenzar a procesar las tareas de compresión de inmediato. Ops: 0 (No, añadir las tareas a la cola solamente), 1 (Sí) |
activate_when_done | (int) 0 | 1 | Si se desea activar el Clip después de que todas las tareas hayan finalizado. Ops: 0 (No), 1 (Sí) |
delete_source_when_done | (int) 0 | 1 | Si se desea eliminar el archivo de vídeo fuente después de que todas las tareas hayan finalizado (y hayan sido exitosas). Ops: 0 (No), 1 (Sí) |
Si la solicitud es exitosa, recibirá una respuesta conteniendo:
• ok: Si las tareas de compresión fueron añadidas a la cola.
Ejemplo:
{ "ok": "The Clip encoding tasks were queued and processing was launched" }
Si la solicitud no es exitosa (por ejemplo, si el Clip Auto-Compresión no tiene archivo de vídeo fuente), recibirá una respuesta como la siguiente:
{ "error": "CLIP_MEDIA_ERROR", "error_long": "The Clip does not have an associated encoding source" }
Posibles Mensajes de Error
Además de los errores generales, esta solicitud puede devolver los siguientes errores:
• REQUEST_ERROR | Invalid Clip ID:
El ID del Clip no es válido.
• CLIP_NOT_FOUND | It was not possible to find a Clip with the supplied ID:
No se encontró el Clip con el ID especificado.
• CLIP_TYPE_ERROR | The provided Clip ID corresponds to a non-Auto-Encoding Clip
El ID de Clip suministrado corresponde a un Clip que no es del tipo Auto-Compresión.
• CLIP_MEDIA_ERROR | The Clip does not have an associated encoding source
El Clip no tiene archivo de vídeo fuente asociado.
• CLIP_TASKS_BEING_PROCESSED_ERROR | The Clip already has encoding tasks being processed
El Clip ya tiene tareas de compresión que se están procesando.
• CLIP_PENDING_TASKS_ERROR | The Clip has encoding tasks pending processing
El Clip tiene tareas de compresión pendientes de procesar.
• CLIP_OTHER_TASK_ERROR | Other task error occurred
Ocurrió otro error inesperado.
Preparando los datos GET y POST.
// 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, );
Generando salt, timestamp, signature y enviando la solicitud
*** El siguiente bloque de código es común para todas las solicitudes firmadas ***
// Recopilando la información del API y URL Base $API_URL = "https://www.midominiowebtv.tv/api.php"; $API_KEY_ID = "1b323a1cb879fd4e66530fbad07a32ee"; $API_SHARED_SECRET = "MWIzMjNhMWNiODc5ZmQ0ZTY2NTMwZmJhZDA3YTMyZWViOTQ3MDJiOGM2ZTU2NjE3"; // Mantenga esto en un lugar seguro!!! // Generando salt y timestamp $salt = md5(mt_rand()); $timestamp = time(); // Generando la firma de validación // - Método por defecto: usando base64_encode(hash_hmac(...)) $signature = base64_encode(hash_hmac('sha256', $salt.$timestamp, $API_SHARED_SECRET, true)); // comentar esta línea si se utiliza el otro método // - Método simplificado - disponible desde v60: usando md5(). // Este método requiere que la variable $API_SIGNATURE_GENERATION_MODE = 1; en el archivo config/Config.inc.php.
// $signature = md5($salt."-".$timestamp."-".$API_SHARED_SECRET); // debe "des-comentar" esta línea si se utiliza el método simplificado // Añadiendo timestamp, salt, key y signature a las variables GET $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; // Creando la URL de la solicitud. Tenga presente que si no utiliza la función interna de PHP // para crear la solicitud HTTP entonces no se olvide de codificar los valores con URL Encode $REQUEST_URL = $API_URL."?".http_build_query($GET_VARS); // Lo anterior construirá una URL del como .../api.php?go=api_subject&do=api_action&etc... // Creando un recurso cURL con las opciones apropiadas $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. // Enviando la solicitud al API $response = curl_exec($ch); // Procesando la respuesta if (!$response) { echo 'Llamada al API falló'; } else { print_r(json_decode($response,true)); }