Configuración del trabajo

api_key

Versiones de API: V2

Valores válidos: Su clave API de Zencoder de https://app.zencoder.com/api

Tipos de trabajo compatibles: VOD

Ejemplo: bcafecadfecabafedac

Descripción:

La clave API de su cuenta de Zencoder. Puede encontrar su clave API en https://app.zencoder.com/api. También puede volver a generar su clave API en esa página.

  {
    "input": "s3://zencodertesting/test.mov",
    "api_key": "bcafecadfecabafedac"
  }

dynamic_profile_options

Versiones de API: V2

Tipos de trabajo compatibles: VOD

Descripción:

Con CAE, el número de salidas y los parámetros de dichas salidas pueden cambiar dinámicamente para cada archivo de entrada. La dynamic_profile_options Los ajustes definen la forma en que deben crearse las representaciones. Ver Configuración CAE para detalles. También debes configurar generate_dynamic_profile igual a true para utilizar esta función.

  {
    "input": "s3://zencodertesting/test.mov",
    "generate_dynamic_profile": true,
    "dynamic_profile_options": {
      "min_renditions": 2,
      "max_renditions": 8
    },
    "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},
      {"dynamic_profile_rendition": 7},
      {"dynamic_profile_rendition": 8}
  ]
  }

generate_dynamic_profile

Versiones de API: V2

Valores válidos: verdadero o falso

Valor por defecto: falso

Tipos de trabajo compatibles: VOD

Descripción:

Con CAE, el número de salidas y los parámetros de dichas salidas pueden cambiar dinámicamente para cada archivo de entrada. Para especificar límites en el número de salidas que se generarán, así como otras restricciones de perfil, la solicitud de trabajo CAE también debe incluir opciones_de_perfil_dinámico objeto. Las salidas reservadas para el uso de CAE no deben incluir resolution ni parámetros relacionados con el códec. bitrate En su lugar, deben incluir etiquetas dynamic_profile_rendition. El número de salidas reservadas para el uso de CAE debe coincidir con el número especificado como max_renditions en dynamic_profile_options.

  {
    "input": "s3://zencodertesting/test.mov",
    "generate_dynamic_profile": true,
    "dynamic_profile_options": {
      "min_renditions": 2,
      "max_renditions": 8
    },
    "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},
       {"dynamic_profile_rendition": 7},
       {"dynamic_profile_rendition": 8}
    ]
  }

input

Versiones de API: V2

Valores válidos: Una URL válida a un archivo multimedia (HTTP / HTTPS, FTP / FTPS, SFTP, Azure, GCS, CF o S3), con o sin autenticación

Tipos de trabajo compatibles: vod

Ejemplo:

• http://example.com/path/to/input.avi
• sftp: // usuario: pass@example.com/path/to/input.mp3
• s3: //my-bucket/video.mp4
• cf: // nombre de usuario: api_key@container/video.wmv
• cf + uk: // nombre de usuario: api_key@container/video.wmv
• azure: // nombre-cuenta: account-key@container/video.wmv
• gcs: // clave_acceso: clave_secreta@gcs-bucket/video.mov
• aspera: // usuario: pase @ host: puerto-ssh / ruta / a / archivo.mp4
• s3 + eu-central-1: //my-bucket/video.mp4

Descripción:

Una URL para el archivo que se transcodificará. Si el servidor remoto requiere autenticación, debe incluir su nombre de usuario y contraseña en la cadena de URL de entrada.

Si la URL contiene autenticación con caracteres especiales, asegúrese de que se hayan escapado correctamente.

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.

Si la URL de S3 se ha firmado previamente (que contiene los parámetros de consulta "Firma", "Expires" y "AWSAccessKeyId"), todos los caracteres deben estar codificados como 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 Azure:

Si la URL contiene autenticación con caracteres especiales, asegúrese de que se hayan escapado correctamente.

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 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.

  {
    "input": "http://example.com/path/to/input.avi"
  }

outputs

Versiones de API: V2

Valores válidos: Una matriz de hash o un solo hash

Tipos de trabajo compatibles: VOD

Ejemplo:

• "salidas": [{}]
• "producción": {}

Descripción:

Nuestra salida predeterminada es un solo archivo de video con la siguiente configuración:

• Vídeo H.264, audio AAC, formato de archivo MP4
• Video: calidad media
• Audio: estéreo, calidad media (aproximadamente 112 kbps), 44100 Hz

Si no especifica una ubicación de salida, el archivo será alojado temporalmente por Zencoder. Después de 24 horas, el archivo ya no estará disponible.

  {
    "input": "s3://zencodertesting/test.mov",
    "outputs": [
      {
        "url": "s3://my-output-bucket/final-1.mp4"
      },
      {
        "url": "s3://my-output-bucket/final-2.webm"
      }
    ]
  }

region

Versiones de API: V2

Defecto: nosotros

Valores válidos: nosotros, europa, asia, sa, australia, us-virginia, us-oregon, us-n-california, eu-dublin, asia-singapur, asia-tokyo, sa-saopaulo, australia-sydney, us-central-gce, eu-west-gce o asia-east-gce

Tipos de trabajo compatibles: VOD

Ejemplo: us-virginia

Descripción:

Puede especificar una región de Amazon AWS para utilizarla para codificar un trabajo y procesaremos el trabajo en los servidores de la región especificada.

Se puede especificar una región de todo el continente: EE. UU., Europa, Asia, sa o australia. Cuando se utiliza uno de estos, se puede utilizar cualquier región del continente para procesar el trabajo.

Se puede usar una región más específica para apuntar a una región de AWS específica: us-virginia, us-oregon, us-n-california, eu-dublin, asia-singapore, asia-tokyo, sa-saopaulo y australia-sydney.

  {
    "input": "s3://zencodertesting/test.mov",
    "region": "us-virginia"
  }

test

Versiones de API: V2

Defecto: falso

Valores válidos: verdadero o falso

Tipos de trabajo compatibles: VOD

Descripción:

Habilite el modo de prueba para un trabajo ("Modo de integración"). En el modo de integración, todos los archivos codificados se reducirán a 5 segundos y no se le cobrará por el trabajo.

  {
    "input": "s3://zencodertesting/test.mov",
    "test": true
  }

private

Versiones de API: V2

Defecto: falso

Valores válidos: verdadero o falso

Tipos de trabajo compatibles: VOD

Descripción:

El modo de privacidad aplicará ciertos parámetros de la API para proteger su contenido de vistas no autorizadas y ocultar cualquier información potencialmente sensible. Zencoder los empleados no verán archivos privados por ningún motivo.

  {
    "input": "s3://zencodertesting/test.mov",
    "private": true
  }

download_connections

Versiones de API: V2

Defecto: 5

Valores válidos: Un número entero entre 0 y 25

Tipos de trabajo compatibles: vod

Descripción:

Puede especificar el número de conexiones que se utilizarán para descargar un input expediente. Esto puede acelerar los tiempos de transferencia de descarga, 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 descarga o desea evitar que Zencoder use demasiado ancho de banda al recuperar un archivo, establezca esto en 1.

  {
    "input": "s3://zencodertesting/test.mov",
    "download_connections": 3
  }

pass_through

Versiones de API: V2

Valores válidos: Cualquier cadena de hasta 255 caracteres.

Tipos de trabajo compatibles: VOD

Ejemplo: my-custom-pass-through-value

Descripción:

Información opcional para almacenar junto con este trabajo.

  {
    "input": "s3://zencodertesting/test.mov",
    "pass_through": "my-custom-pass-through-value"
  }

mock

Versiones de API: V2

Defecto: falso

Valores válidos: verdadero o falso

Tipos de trabajo compatibles: VOD

Descripción:

Simula una solicitud de trabajo y devuelve la respuesta normal sin crear realmente un trabajo. Los ID de trabajo y salida serán nulos.

  {
    "input": "s3://zencodertesting/test.mov",
    "mock": true
  }

grouping

Versiones de API: V2

Valores válidos: Cualquier cuerda.

Tipos de trabajo compatibles: VOD

Ejemplo: my-custom-pass-through-value

Descripción:

Puede pasar aquí cualquier cadena arbitraria para crear una agrupación con fines de generación de informes. Esto recopilará información estadística para cada grupo que se puede recuperar a través del API de informes.

Las agrupaciones de informes se pueden utilizar para realizar un seguimiento del uso de minutos para cada uno de sus proyectos, clientes o departamentos.

  {
    "input": "s3://zencodertesting/test.mov",
    "grouping": "my-custom-pass-through-value"
  }

aspera_transfer_policy

Versiones de API: V2

Defecto: justo

Valores válidos: regular o bajo

Tipos de trabajo compatibles: vod

Descripción:

Establece cómo Zencoder utilizará el ancho de banda disponible del servidor de codificación al transferir archivos desde su servidor Aspera.

Justo divide el ancho de banda de manera uniforme entre todos los trabajos en ejecución en el servidor de codificación.

Bajo utiliza cualquier ancho de banda disponible en el servidor de codificación, pero dará prioridad a otros trabajos. Bajo es útil si le preocupa sobrecargar su servidor con demasiado tráfico.

Nota: La opción Alta en Aspera no es compatible con Zencoder. De forma predeterminada, usaremos tanto ancho de banda como sea posible, pero no daremos prioridad al acceso al ancho de banda para un trabajo sobre todos los demás en un servidor de codificación.

  {
    "input": "s3://zencodertesting/test.mov",
    "aspera_transfer_policy": "fair"
  }

Ver también: transfer_minimum_rate y transfer_maximum_rate

transfer_minimum_rate

Versiones de API: V2

Defecto: 1000

Valores válidos: 1000-249999

Tipos de trabajo compatibles: vod

Descripción:

Establece un piso de tasa de transferencia para usar durante la transferencia de archivos con Aspera. Esto no garantiza que se alcance la velocidad, pero si el ancho de banda está disponible, la transferencia de archivos no será inferior a esta velocidad.

Esto debe ser menor que transfer_maximum_rate.

  {
    "input": "s3://zencodertesting/test.mov",
    "transfer_minimum_rate": 2500
  }

Ver también: transfer_maximum_rate y aspera_transfer_policy

transfer_maximum_rate

Versiones de API: V2

Defecto: 250000

Valores válidos: 1001-250000

Tipos de trabajo compatibles: vod

Descripción:

Establece un límite de velocidad de transferencia para usar durante la transferencia de archivos con Aspera. Esto no garantiza que se alcance la velocidad, pero si hay ancho de banda disponible, la transferencia de archivos no superará esta velocidad.

Se recomienda establecer la velocidad de transferencia máxima al codificar una gran cantidad de trabajos simultáneamente, para evitar abrumar los servidores de origen y destino con tráfico.

Esto debe ser mayor que transfer_minimum_rate.

  {
    "input": "s3://zencodertesting/test.mov",
    "transfer_maximum_rate": 25000
  }

Ver también: transfer_minimum_rate y aspera_transfer_policy

expected_md5_checksum

Versiones de API: V2

Tipos de trabajo compatibles: vod

Descripción:

La suma de comprobación MD5 esperada del archivo de entrada. Si la suma de comprobación del archivo no coincide con la suma de comprobación proporcionada, el trabajo fallará.

  {
    "input": "s3://zencodertesting/test.mov",
    "expected_md5_checksum": "d5ed34b6b49f57a4a5f4be72fc0a2cd4"
  }

credentials

Versiones de API: V2

Tipos de trabajo compatibles: vod

Ejemplo: ftp_dev_server

Descripción:

Hace referencia al apodo de las credenciales guardadas que se usarán para la transferencia, que se administran en el Sección de credenciales de cuenta.

Esto se puede utilizar para FTP, SFTP, FTPS, S3, GCS o CF.

  {
    "input": "ftp://ftp.example.com/file.mp4",
    "credentials": "ftp_dev_server"
  }

Ver también: input