soporte Contactar con asistencia técnica | estado del sistema Estado del Sistema

Características: Ingest Profiles API

En este tema, obtendrá una visión general de la Ingest Profiles API. El Ingest Profiles API le permite crear, recuperar, actualizar y eliminar perfiles de representación para su Video Cloud cuenta.

Administrar perfiles de ingestión

Los perfiles de ingesta se utilizan como una especificación para la transcodificación cuando se cargan o vuelven a transcodificar videos. Puede gestionar estos perfiles utilizando el Ingest Profiles API.

Glosario de términos

Perfil JSON

El término "perfil JSON" a continuación significa la representación JSON de un objeto de perfil. Contienen campos de perfil de nivel superior y una colección de objetos de representación como una lista. Ver Perfiles estándar para ver el JSON para los perfiles estándar incluidos en cada cuenta y Seguridad de contenido (DRM y HLSe) para perfiles de muestra que incluyen empaque DRM.

Perfil Id

A profile id puede ser el id or name campo de nivel superior en un perfil. En este ejemplo (un fragmento de un perfil):

    {
        "id": "5591b5ede4b0f7138939ad8c",
        "version": 4,
        "name": "screencast-1280",
        "description": "A high resolution profile optimized for screencasts with 1280 x 720 resolution.", ...

"screencast-1280" o "5591b5ede4b0f7138939ad8c" son identificadores de perfil válidos. Cuando cree un perfil por primera vez, proporcionará un perfil con un nombre pero sin una identificación, y la respuesta contendrá el perfil creado, incluida su identificación. Luego puede usar cualquiera de las siguientes llamadas a la API.

Identificación de referencia

A reference_id identifica de forma única una rendición dentro de un perfil. Los identificadores de referencia se utilizan para el empaquetado de DRM y pueden usarse para otros fines en el futuro. Además de ser único dentro del perfil, los ID de referencia pueden ser cualquier cadena; no debe incluir espacios. Recomendamos utilizar algún esquema que facilite la identificación del formato de la representación, por ejemplo: mp4_1, mp4_2, hls1, hls2, etc.

Versión de perfil

A version es el número de revisión de un perfil para una cuenta. Está representado por un valor entero largo. Nota: no se cita en la representación JSON.

Perfil activo

Un perfil es active si se puede usar para cargas. Por ejemplo, si actualiza un perfil, obtiene un nuevo perfil con un número de versión incrementado que está activo y la versión anterior queda inactiva.

Perfil estándar

Un perfil es standard si se proporciona para su uso por Brightcove (es decir, no es un perfil personalizado específico para una sola cuenta).

Perfil por defecto

Un perfil es default si se usa cuando no se elige explícitamente ningún perfil. Si no tiene una configuración de cuenta o no establece un perfil predeterminado en su configuración, uno de los Brightcove standard Los perfiles se usarán de acuerdo con su tipo de cuenta.

URL base

La URL del servicio es:

    https://ingestion.api.brightcove.com/v1/

Autorización

La autorización para la API se realiza a través de la implementación OAuth2 de Brightcove. Necesitará credenciales de cliente (una identificación de cliente y un secreto de cliente) que tenga permisos para las siguientes operaciones en su (s) cuenta (s):

  • video-cloud/ingest-profiles/profile/read
  • video-cloud/ingest-profiles/profile/write
  • video-cloud/ingest-profiles/account/read
  • video-cloud/ingest-profiles/account/write

Conseguir un client_id y client_secret, deberás dirigirte a la interfaz de usuario de OAuth y registrar una aplicación:

También puede obtener sus credenciales a través de CURL o cartero, consulte:

Utilizará las credenciales de su cliente para obtener tokens de acceso que le permitirán hacer llamadas a la API. Los tokens de acceso se pasan en un encabezado de Autorización:

    Authorization: Bearer {your_access_token}

ver el Sección Oauth .

Máximas interpretaciones

El número máximo de representaciones que puede definir en un perfil de ingesta es 25. Si define más que ese número, la solicitud devolverá un error de respuesta 409: el recuento de representaciones de perfil excede el límite de entregas configurado.

Salidas condicionales

Si los videos que ingiere varían ampliamente en calidad, por ejemplo, sus videos pueden incluir contenido generado por el usuario creado en teléfonos con cámaras de baja calidad, es posible que desee que la generación de algunas reproducciones dependa de la tasa de bits o de alguna otra propiedad de fuente de video. Esto evitará la creación y el almacenamiento de representaciones redundantes. Ver Salidas condicionales para detalles sobre cómo hacer esto.

Operaciones de cuenta

En el nivel de la cuenta, puede obtener todos los perfiles de la cuenta y crear nuevos.

Punto final

    /accounts/{account_id}/profiles

Obtener todos los perfiles

Para obtener todos los perfiles de la cuenta (incluidos perfiles estándar), envía una solicitud GET al punto final que se muestra arriba.

Crear un perfil

Para crear un nuevo perfil, envíe una solicitud POST al punto final que se muestra arriba, incluidos los datos JSON para el perfil como el cuerpo de la solicitud. Ver el perfil de muestra a continuación para un ejemplo de los datos JSON, y el Referencia de campos de perfil para los campos permitidos.

Operaciones de perfil único

Para perfiles individuales, puede obtener el perfil por nombre o id., Reemplazar un perfil y eliminar un perfil.

Punto final

    /accounts/{account_id}/profiles/{profile_id}

Para la profile_id, puedes usar:

  • nombre (p. ej., alta definición equilibrada)
  • generated id (e.g. 54de14cce4b0a6d2bf9cb08a)

Obtener un perfil por id

Para recuperar un único perfil, realice una solicitud GET al punto final que se muestra arriba.

Actualizar un perfil

Para actualizar un perfil, realice una solicitud PUT al punto final anterior, incluido el completar Datos JSON para el perfil en el cuerpo de la solicitud.

Eliminar un perfil

Para eliminar un perfil, realice una solicitud DELETE al punto final anterior.

Esta acción es irreversible

Operaciones de perfil predeterminadas

Puede obtener, establecer o actualizar los perfiles predeterminados de video en demanda y video en vivo para su cuenta usando el punto final:

    /accounts/{account_id}/configuration

Obtener el perfil predeterminado

Recupere el perfil predeterminado para su cuenta haciendo una solicitud GET al punto final anterior.

Si no se ha establecido un perfil predeterminado, se devolverá el perfil predeterminado del sistema.

Establecer el perfil predeterminado

Para establecer el perfil predeterminado, realice una solicitud POST al punto final que se muestra arriba, incluido el JSON en el cuerpo de la solicitud:

    {
      "account_id": {account_id},
      "default_profile_id": {default_profile_id}
    }

Para la default_profile_id, puedes usar cualquiera de los siguientes:

  • nombre (p. ej., alta definición equilibrada)
  • generated id (e.g. 54de14cce4b0a6d2bf9cb08a)

Actualiza el perfil predeterminado

Para actualizar el perfil predeterminado, realice una solicitud PUT al punto final que se muestra arriba, incluido este JSON en el cuerpo de la solicitud:

    {
      "id": {configuration_id},
      "account_id": {account_id},
      "default_profile_id": {default_profile_id}
    }

Consiga el configuration_id de la respuesta a una solicitud GET o POST.

Establecer el perfil en vivo predeterminado

Establecer el perfil en vivo predeterminado es exactamente lo mismo que establecer el perfil predeterminado de video a pedido, a excepción de este cambio en el cuerpo de la solicitud:

    {
      "id": {configuration_id},
      "account_id": {account_id},
      "default_live_profile_id": {default_live_profile_id}
    }

Notas

  • Si especifica un perfil inexistente, la solicitud fallará

Perfil de muestra

La Perfiles estándar El documento le mostrará todos los perfiles predeterminados que existen actualmente para todos Video Cloud cuentas.

Marcas de agua

Si desea agregar marcas de agua (o una imagen de logotipo) a sus videos, puede usar los campos de marca de agua en su perfil de ingestión.

Aquí hay un ejemplo de un perfil de representación con marcas de agua:

    ...
    "renditions": [
        {
          "media_type": "video",
          "id": "559697ece4b072e9641b8404",
          "reference_id": "mp0",
          "format": "mp4",
          "audio_codec": "aac",
          "audio_bitrate": 64,
          "video_codec": "h264",
          "speed": 3,
          "video_bitrate": 450,
          "decoder_bitrate_cap": 771,
          "decoder_buffer_size": 1028,
          "keyframe_rate": 0.5,
          "max_frame_rate": 30,
          "width": 480,
          "height": 270,
          "h264_profile": "baseline",
          "watermarks": [
            {
              "y": "70%",
              "width": "20%",
              "url": "http://learning-services-media.brightcove.com/images/bc_logo.png"
            }
          ]
      }, ...

ver el


Página actualizada por última vez el 12 jun 2020