type
type:String
Versiones de API: V1, V2
Padre: outputs
Defecto: estándar
Valores válidos: standard
, segmented
, captions
playlist
, y transfer-only
Tipos de trabajo compatibles: Todas
Ejemplo: segmented
Descripción:
Por defecto, Zencoder considerará las salidas como archivos de audio o video estándar. Actualmente, existen dos tipos especiales de salidas: segmented
y playlist
.
segmented
: El caso de uso típico para la segmentación es para Live HTTP Streaming de Apple (consulte Streaming segmentado). Para las salidas segmentadas, el formato predeterminado se cambiará a ts en lugar de mp4.captions
: Solo API V2
El tipo de salida de subtítulos crea un archivo que contiene solo los subtítulos del video de origen, en lugar de un video con subtítulos agregados. Nota: las salidas del tipo de subtítulos pueden no ser las únicas salidas para un trabajo.
Los subtítulos se pueden proporcionar a Zencoder como un archivo separado (usando el caption_url opción), o se extraerá del vídeo de origen de forma predeterminada.
Los formatos admitidos para extraer subtítulos del video de origen son MP4 y TS. En un archivo MP4, los subtítulos pueden ubicarse en una pista separada (en formato CEA-608); de lo contrario, los subtítulos en un archivo MP4 o TS deben estar incrustados en un flujo de video MPEG2 o AVC, que cumpla con los estándares A / 53 o SCTE-128 (CC1 y CC3).
Formatos de salida admitidos para salidas de tipo subtítulos: 'mp4
','scc
','webvtt
','vtt
','m3u8
','dfxp
'.- lista de reproducción: El tipo de salida de lista de reproducción se utiliza en flujos de salida de varias tasas de bits para generar el archivo de lista de reproducción maestro M3U8. Nota: las salidas del tipo de lista de reproducción pueden no ser las únicas salidas para un trabajo.
transfer-only
: Solo API V2
Atransfer-only
la salida omite la codificación y envía el video original a un url.
Atransfer-only
la salida también puede usar source para transferir el video de otra salida al especificado url , en lugar de utilizar la entrada.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"type": "segmented"
}
]
}
Ver también: source y caption_url
label
label:String
Versiones de API: V1, V2
Padre: outputs
Valores válidos: Una cuerda
Tipos de trabajo compatibles: Todas
Ejemplo: iphone4
Descripción:
Una etiqueta opcional para la salida. A partir de API v2, las etiquetas deben ser únicas (no distinguen entre mayúsculas y minúsculas) por trabajo cuando se utilizan en varias salidas.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"label": "iphone4"
}
]
}
Ver también: source
dynamic_profile_rendition
dynamic_profile_rendition:Integer
Versiones de API: V2
Padre: outputs
Tipos de trabajo compatibles: Todas
Descripción:
La dynamic_profile_rendition
configuración especifica que esta Salida debe usar la configuración del perfil CAE generado dinámicamente, y específicamente desde qué interpretación del perfil usar la configuración. Cuando dynamic_profile_rendition
está configurado, no es necesario especificar la configuración de codificación resolution
, como, bitrate
, etc. (Ver el Guía CAE para obtener la lista completa de configuraciones que CAE establece automáticamente).
{
"input": "s3://zencodertesting/test.mov",
"generate_dynamic_profile": true,
"dynamic_profile_options":{ "max_renditions": 6 },
"outputs" :[
{"dynamic_profile_rendition": 1},
{"dynamic_profile_rendition": 2},
{"dynamic_profile_rendition": 3},
{"dynamic_profile_rendition": 4},
{"dynamic_profile_rendition": 5},
{"dynamic_profile_rendition": 6}
]
}
Ver también: source
url
url:String
Versiones de API: V1, V2
Padre: outputs
Valores válidos: Una dirección válida de S3, Cloud Files, GCS, FTP, FTPS, SFTP, Aspera, Azure o HTTP.
Tipos de trabajo compatibles: Todas
Ejemplo:
- s3://my-output-bucket/final.mp4
- cf://username:api_key@container/object
- cf+uk://username:api_key@container/object
- gcs://access_key:secret_key@gcs-bucket/object
- ftp://user:password@ftp.example.com/final.mp4
- sftp://user:password@sftp.example.com/final.mp4
- aspera://user:password@host:ssh-port/path/to/file.mp4
Descripción:
Una URL completa, incluido un nombre de archivo, en el que se cargará el archivo de salida. Por favor mira base_url para obtener más información sobre los proveedores.
Admitimos oficialmente la carga HTTP a S3, GCS, Cloud Files y Akamai.
Notas sobre S3:
Debes conceder escribir permisos para Zencoder en el depósito de salida antes de enviar un trabajo a Zencoder. Tenga en cuenta que es el bucket de S3, y no la "ruta" de S3, la que necesita permiso de escritura. Por ejemplo, un activo en http://s3.amazonaws.com/my_files/0000/video.mp4
necesita acceso de escritura agregado a "my_files" (el nombre del depósito), no a "my_files / 0000" (la ruta).
Para crear claves que contengan caracteres especiales que no sean válidos en las URL (? O #), debe codificarlas en la URL (% 3F y% 23, respectivamente). Todos los demás caracteres no deben estar codificados en URL.
Puede proporcionar la región del bucket de S3 configurando el protocolo de la URL en s3+region-name
, donde este documento define "nombre de región». Por ejemplo, para acceder a un archivo desde un depósito en la región de Asia Pacífico (Singapur), establezca la URL en s3+ap-southeast-1://my-bucket/file.mp4
.
Notas sobre archivos en la nube:
Puede especificar la región a usar (DFW, ORD o Reino Unido) agregándola al protocolo, como cf+ord://username:api_key@container/object
. Actualmente, las únicas regiones de Cloud Files compatibles son DFW, ORD y UK. La región DFW se utilizará de forma predeterminada.
Cualquier carácter especial en el nombre del contenedor debe estar codificado en URL.
Notas sobre Google Cloud Storage:
Las claves de acceso de GCS se pueden encontrar en la sección "Acceso interoperable" en el Consola de API de Google. Las claves de acceso deben ser apropiadamente escapado.
No se admiten los nombres de depósito de GCS que incluyen puntos.
Notas sobre Azure:
Si la URL contiene autenticación con caracteres especiales, asegúrese de que se hayan escapado correctamente.
Notas sobre FTP:
Si la URL contiene autenticación con caracteres especiales, asegúrese de que se hayan escapado correctamente.
Intentamos escribir desde la raíz de su servidor, así que use una ruta absoluta para su URL para asegurarnos de que podamos escribir en su servidor con éxito.
Notas sobre Aspera:
La parte del puerto ssh de la URL no es necesaria y estará predeterminada en 22.
Zencoder ejecuta un Aspera Client en los servidores de codificación de vídeo, que se conecta a Aspera Enterprise o Connect Server, que aloja los archivos.
Esta es una situación similar a la que tiene cuando ejecuta un servidor FTP para que sus archivos estén disponibles y Zencoder usa un cliente FTP para la transferencia de archivos.
Notas sobre Akamai NetStorage a través de HTTPS:
Zencoder puede cargar contenido en Akamai NetStorage a través de FTP o HTTPS. Para cargar contenido a través de HTTPS, construya una URL de salida como https://[Host]-nsu.akamaihd.net/[CPCode]/[path]/[file.ext]
.
Puede hacer referencia a su nombre de clave y clave de Akamai NetStorage como Servidor externo cartas credenciales configurando el Usuario de servidor externo campo al nombre de clave de Akamai NetStorage y el Contraseña del servidor externo a la clave de NetStorage de Akamai.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"url": "s3://my-output-bucket/final.mp4"
}
]
}
Ver también: secondary_url
secondary_url
secondary_url:String
Versiones de API: V2
Padre: outputs
Valores válidos: Una URL válida de S3, Cloud Files, GCS, FTP, FTPS, SFTP, Aspera, Azure o HTTP.
Tipos de trabajo compatibles: Todas
Ejemplo: Ver documentación de URL
Descripción:
Para trabajos de VOD
Una URL completa, incluido un nombre de archivo, al que se cargará el archivo de salida si se transfiere a url falla.
Ver también: url
base_url
base_url:String
Versiones de API: V1, V2
Padre: outputs
Valores válidos: Una URL válida de S3, Cloud Files, GCS, Aspera, FTP, FTPS o SFTP, sin un nombre de archivo.
Tipos de trabajo compatibles: Todas
Ejemplo:
- s3://my-output-bucket/
- cf://username:api_key@container/
- gcs://access_key:secret_key@gcs-bucket/
- ftp://user:password@ftp.example.com/path/to
- http://s3.amazonaws.com/my-output-bucket/
- aspera://user:password@host:ssh-port/path/to/
Descripción:
Una URL de directorio base S3, Cloud Files, GCS, FTP, FTPS o SFTP donde se cargará el archivo transcodificado, sin un nombre de archivo. Si Nombre del archivo no se especifica, se generará un nombre de archivo aleatorio más una extensión apropiada.
Notas sobre S3:
Debes conceder escribir permisos para Zencoder en el depósito de salida antes de enviar un trabajo a Zencoder. Tenga en cuenta que es el bucket de S3, y no la "ruta" de S3, la que necesita permiso de escritura. Por ejemplo, un activo en http://s3.amazonaws.com/my_files/0000/video.mp4
necesita acceso de escritura agregado a "my_files" (el nombre del depósito), no a "my_files / 0000" (la ruta).
Puede proporcionar la región del bucket de S3 configurando el protocolo de la URL en s3+region-name
, donde este documento define «nombre de región». Por ejemplo, para acceder a un archivo desde un depósito en la región de Asia Pacífico (Singapur), establezca la URL en s3+ap-southeast-1://my-bucket/
.
Notas sobre archivos en la nube:
Puede especificar la región a usar (DFW, ORD o Reino Unido) agregándola al protocolo, como cf+ord://username:api_key@container/object
. Actualmente, las únicas regiones de Cloud Files compatibles son DFW, ORD y UK. La región DFW se utilizará de forma predeterminada.
Cualquier carácter especial en el nombre del contenedor debe estar codificado en URL.
Notas sobre Google Cloud Storage:
Las claves de acceso de GCS se pueden encontrar en la sección "Acceso interoperable" en el Consola de API de Google. Las claves de acceso deben ser apropiadamente escapado.
No se admiten los nombres de depósito de GCS que incluyen puntos.
Notas sobre Azure:
Si la URL contiene autenticación con caracteres especiales, asegúrese de que se hayan escapado correctamente.
Notas sobre FTP:
Si la URL contiene autenticación con caracteres especiales, asegúrese de que se hayan escapado correctamente.
Intentamos escribir desde la raíz de su servidor, así que use una ruta absoluta para su URL para asegurarnos de que podamos escribir en su servidor con éxito.
Notas sobre Aspera:
La parte del puerto ssh de la URL no es necesaria y estará predeterminada en 22.
Notas sobre HTTP:
Admitimos oficialmente la carga HTTP a S3, GCS, Cloud Files y Akamai.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"base_url": "s3://my-output-bucket/"
}
]
}
Ver también: filename
filename
filename:String
Versiones de API: V1, V2
Padre: outputs
Valores válidos: Un nombre de archivo de audio o video válido.
Tipos de trabajo compatibles: Todas
Ejemplo: final.mp4
Descripción:
La filename
de un archivo terminado. Si proporciona un archivo filename
pero no un base_url
, almacenaremos el archivo con este nombre de archivo en un depósito de S3 temporalmente para que lo descargue.
Notas sobre S3:
Para crear claves que contengan caracteres especiales que no sean válidos en las URL (? O #), debe codificarlas en la URL (% 3F y% 23, respectivamente). Todos los demás caracteres no deben estar codificados en URL.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"filename": "final.mp4"
}
]
}
Ver también: base_url
package_filename
package_filename:String
Versiones de API: V1, V2
Padre: outputs
Valores válidos: Un nombre de archivo de paquete válido.
Tipos de trabajo compatibles: Todas
Ejemplo: final.zip
Descripción:
El nombre de archivo de una salida empaquetada. Si la extensión coincide con una package_format , esto también establecerá el valor predeterminado para package_format. Cuando se especifica, este valor se utiliza en combinación con base_url para generar una URL de salida, en lugar de filename. Si filename no está especificado, por defecto será el mismo que package_filename
, pero con la extensión de archivo correcta para el tipo de medio.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"package_filename": "final.zip"
}
]
}
Ver también: base_url y Nombre del archivo
package_format
package_format:String
Versiones de API: V1, V2
Padre: outputs
Valores válidos: zip
y tar
Tipos de trabajo compatibles: Todas
Ejemplo: zip
Descripción:
Crea un zip
o tar
que contiene todos los archivos multimedia de una salida y carga este paquete único en lugar de todos los archivos individuales. Miniaturas sin un base_url también se incluirá en subdirectorios dentro del archivo del paquete.
Si package_filename no especificado, el nombre de archivo del paquete se generará en función de Nombre del archivo (pero con el formato del paquete como extensión). Ver package_filename para obtener detalles sobre el manejo de URL.
Nota: Cuando se incluyen miniaturas en el archivo del paquete, las rutas dentro del paquete se devolverán a través de la API como su URL, en lugar de una URL completa.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"package_format": "zip"
}
]
}
Ver también: package_filename
device_profile
device_profile:String
Versiones de API: V1, V2
Valores válidos: mobile/advanced
, mobile/baseline
, mobile/legacy
, v1/mobile/advanced
, v1/mobile/baseline
, v1/mobile/legacy
, v2/mobile/advanced
v2/mobile/baseline
, y v2/mobile/legacy
Tipos de trabajo compatibles: Todas
Ejemplo: mobile/advanced
Descripción:
Los perfiles de dispositivo de Zencoder son accesos directos a un conjunto de opciones que apuntan a la capacidad de reproducción de un dispositivo en particular o un conjunto de dispositivos. La configuración de un perfil de dispositivo no hará más que cambiar los valores predeterminados utilizados en la llamada a la API. Eso significa que puede anular completamente la configuración individual de un perfil para adaptarse a sus necesidades particulares con mucha facilidad.
Los perfiles de dispositivos con versiones están disponibles y se enumeran a continuación. Especificar una versión (v1/mobile/baseline
) garantizará que siempre obtendrás el mismo perfil, mientras que los perfiles no específicos de la versión (mobile/baseline
) se pueden cambiar de nuevo tiempo a medida que se disponga de mejores opciones.
Perfiles y sus valores predeterminados:
mobile/advanced
:{"size": "1280x720", "audio_bitrate": 56, "max_audio_sample_rate": 48000, "max_frame_rate": 30, "max_video_bitrate": 5000, "video_codec_level": 3.1, "videoe_codec_profile": "main"}
mobile/baseline
:{"size": "480x320", "audio_bitrate": 96, "max_audio_sample_rate": 44100, "max_frame_rate": 30, "max_video_bitrate": 1500, "video_reference_frames": 1}
mobile/legacy
:{"size": "320x240", "audio_bitrate": 96, "max_audio_sample_rate": 44100, "max_frame_rate": 30, "max_video_bitrate": 768, "video_codec_level": 1.3, "video_reference_frames": 1}
v1/mobile/advanced
:{"size": "1280x720", "audio_bitrate": 128, "max_audio_sample_rate": 48000, "max_frame_rate": 30, "max_video_bitrate": 5000, "video_codec_level": 3.1, "videoe_codec_profile": "main"}
v1/mobile/baseline
:{"size": "480x320", "audio_bitrate": 96, "max_audio_sample_rate": 44100, "max_frame_rate": 30, "max_video_bitrate": 1500}
v1/mobile/legacy
:{"size": "320x240", "audio_bitrate": 24, "max_audio_sample_rate": 16000, "max_frame_rate": 15, "max_video_bitrate": 192, "video_bitrate": 192, "bitrate_cap": 192, "upscale": true, "aspect_mode": "pad", "format": "3gp", "video_codec": "mpeg4"}
- v2/móvil/avanzado:
{"size": "1280x720", "audio_bitrate": 56, "max_audio_sample_rate": 48000, "max_frame_rate": 30, "max_video_bitrate": 5000, "video_codec_level": 3.1, "videoe_codec_profile": "main"}
v2/mobile/baseline
:{"size": "480x320", "audio_bitrate": 96, "max_audio_sample_rate": 44100, "max_frame_rate": 30, "max_video_bitrate": 1500, "video_reference_frames": 1}
v2/mobile/legacy
:{"size": "320x240", "audio_bitrate": 96, "max_audio_sample_rate": 44100, "max_frame_rate": 30, "max_video_bitrate": 768, "video_codec_level": 1.3, "video_reference_frames": 1}
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"device_profile": "mobile/advanced"
}
]
}
Ver también: format
strict
strict:Boolean
Versiones de API: V1, V2
Padre: outputs
Defecto: false
Valores válidos: true
o false
Tipos de trabajo compatibles: Todas
Ejemplo: true
Descripción:
Habilita el modostrict
" ». De forma predeterminada, intentaremos corregir los problemas de codificación por usted. Esto se denomina modocompatible
" ". Por ejemplo, si establece una tasa de bits de video que es demasiado baja para nuestro codificador, corregiremos automáticamente y usaremos la tasa de bits más baja posible. Entonces, si solicita una tasa de bits de 150 kbps, pero el codificador no puede hacer nada por debajo de 200 kbps, codificaremos automáticamente el video a 200 kbps por usted.
Si habilita el modostrict
" ", no corregiremos la configuración de codificación como esta. En cambio, fallaremos en el trabajo, porque no podemos cumplir con su especificación objetivo.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"strict": true
}
]
}
skip_video
skip_video:Boolean
Versiones de API: V1, V2
Padre: outputs
Defecto: false
Valores válidos: true
o false
Tipos de trabajo compatibles: Todas
Ejemplo: cierto
Descripción:
Paso skip_video
quitará o eliminará la pista de video de la entrada y el archivo resultante solo contendrá audio.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"skip_video": true
}
]
}
skip_audio
skip_audio:Boolean
Versiones de API: V1, V2
Padre: outputs
Defecto: false
Valores válidos: true
o false
Tipos de trabajo compatibles: Todas
Ejemplo: cierto
Descripción:
Paso skip_audio
quitará o eliminará la pista de audio de la entrada y el archivo resultante solo contendrá video.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"skip_audio": true
}
]
}
source
source:String
Versiones de API: V2
Padre: outputs
Tipos de trabajo compatibles: Todas
Ejemplo: parent
Descripción:
Hace referencia a una etiqueta en otra salida y usa el video creado por esa salida para procesar en lugar del archivo de entrada.
El uso de la fuente junto con un type de "solo transferencia" permite transferir un video de salida única a un segundo url. Útil para enviar un solo video a múltiples destinos.
{
"input": "s3://zencodertesting/test.mov",
"output": [
{
"label": "parent",
"url": "s3://bucket/video.mp4"
},
{
"source": "parent",
"url": "s3://other-bucket/video.mp4",
"type": "transfer-only"
}
]
}
credentials
credentials:String
Versiones de API: V2
Padre: outputs
Tipos de trabajo compatibles: Todas
Ejemplo: s3_production
Descripción:
Hace referencia al apodo de saved credentials utilizar para la transferencia.
Las credenciales solo se pueden usar con URL que coincidan con su tipo; por ejemplo, se rechazarán las credenciales de S3 emparejadas con una URL de FTP.
Nota: Las credenciales más "precisas" especificadas tienen prioridad. Por ejemplo, las credenciales pasadas en la URL tendrán prioridad sobre el parámetro de credenciales, al igual que el parámetro de credenciales tiene prioridad sobre las credenciales predeterminadas.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"url": "s3://bucket/video.mp4",
"credentials": "s3_production"
}
]
}
generate_md5_checksum
generate_md5_checksum:Boolean
Versiones de API: V2
Defecto: false
Valores válidos: true
o false
Tipos de trabajo compatibles: Todas
Descripción:
Genera una suma de comprobación MD5 para el archivo de salida generado.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"generate_md5_checksum": true
}
]
}
parallel_upload_limit
parallel_upload_limit:Integer
Versiones de API: V1, V2
Defecto: 30 para S3, 10 para todos los demás destinos.
Valores válidos: Un número entero entre 1 y 30
Tipos de trabajo compatibles: vod
Ejemplo: 5
Descripción:
El número máximo de cargas simultáneas realizadas al cargar salidas de varias partes, principalmente segmentos HLS.
parallel_upload_limit
debe configurarse para salidas individuales, no para todo el trabajo.
Esto puede acelerar los tiempos de transferencia, dependiendo del ancho de banda en su servidor remoto. Tenga en cuenta que más conexiones pueden suponer una carga más pesada en el servidor. Si tiene problemas con los tiempos de espera de carga o desea evitar que Zencoder use demasiado ancho de banda al cargar archivos, establezca esto en 1.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"parallel_upload_limit": 5,
"url": "s3://my-output-bucket/final.mp4",
"credentials": "s3_production"
},
{
"parallel_upload_limit": 5,
"device_profile": "mobile/advanced",
"url": "s3://my-output-bucket/mobile.mp4",
"credentials": "s3_production"
}
]
}
headers
headers:Hash
Versiones de API: V1, V2
Padres: salidas O miniaturas
Tipos de trabajo compatibles: Todas
Ejemplo: { "Content-Type": "binary/octet-stream" }
Descripción:
Encabezados HTTP para enviar con su archivo cuando lo cargamos. Actualmente, esta función es compatible con S3, GCS y Cloud Files.
Zencoder admite la configuración de un subconjunto limitado de estos encabezados: Cache-Control
, Content-Disposition
, Content-Encoding
, Content-Type
, Expires
, x-amz-acl
, x-amz-storage-class
, x-amz-server-side-encryption
x-amz-meta-*
, x-goog-acl y x-goog-meta-*
.
Los encabezados se ignorarán cuando no se especifique una ubicación de salida.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"url": "s3://my-bucket/file.mp4",
"headers": {
"Content-Type": "binary/octet-stream",
"x-amz-acl": "public-read-write"
}
}
]
}