Aperçu: Ingest Profiles API

Dans cette rubrique, vous obtiendrez un aperçu de la Ingest Profiles API. le Ingest Profiles API vous permet de créer, récupérer, mettre à jour et supprimer des profils de rendu pour votre Video Cloud compte.

Gestion des profils d'acquisition

Les profils d'acquisition sont utilisés comme spécification pour le transcodage lorsque vous téléchargez ou recodulez des vidéos. Vous pouvez gérer ces profils en utilisant le Ingest Profiles API.

Glossaire des termes

Profil JSON

Le terme "profil JSON" ci-dessous signifie la représentation JSON d'un objet de profil. Ils contiennent des champs de profil de niveau supérieur et une collection d'objets de rendu sous la forme d'une liste. Voir Profils standards pour voir le JSON pour les profils standard inclus dans chaque compte et Sécurité du contenu (DRM et HLSe) pour les exemples de profils incluant l'emballage DRM.

Carte d'indentité

A profile id peut être soit le id or name champ de premier niveau dans un profil. Dans cet exemple (un fragment d'un profil):

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

"screencast-1280" ou "5591b5ede4b0f7138939ad8c" sont tous les deux des identifiants de profil valides. Lorsque vous créez un profil pour la première fois, vous fournissez un profil avec un nom mais sans identifiant, et la réponse contiendra le profil créé, y compris son identifiant. Vous pouvez ensuite utiliser n'importe quel appel d'API ultérieur.

Pièce d'identité

A reference_id identifie de manière unique une interprétation dans un profil. Les identifiants de référence sont utilisés pour l'emballage DRM et peuvent être utilisés à d'autres fins à l'avenir. En plus d'être uniques dans le profil, les identifiants de référence peuvent être n'importe quelle chaîne - ils ne doivent pas inclure d'espaces. Nous vous recommandons d'utiliser un schéma qui facilitera l'identification du format du rendu, par exemple: mp4_1, mp4_2, hls1, hls2, Etc.

Version du profil

A version est le numéro de révision d'un profil pour un compte. Il est représenté par une valeur entière longue. Note: il n'est pas cité dans la représentation JSON.

Profil actif

Un profil est active s'il peut être utilisé pour les téléchargements. Par exemple, si vous mettez à jour un profil, vous obtenez un nouveau profil avec un numéro de version incrémenté qui est actif et l'ancienne version devient inactive.

Profil standard

Un profil est standard s'il est fourni pour être utilisé par Brightcove (c'est-à-dire qu'il ne s'agit pas d'un profil personnalisé spécifique à un seul compte).

Profil par défaut

Un profil est default s'il est utilisé alors qu'aucun profil n'est choisi explicitement. Si vous n'avez pas de configuration de compte ou si vous ne définissez pas de profil par défaut dans votre configuration, l'un des Brightcove standard les profils seront utilisés en fonction de votre type de compte.

URL de base

L'URL du service est:

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

Autorisation

L'autorisation pour l'API se fait via l'implémentation OAuth2 de Brightcove. Vous aurez besoin des informations d'identification du client (un identifiant client et un secret client) qui dispose des autorisations pour les opérations suivantes sur vos comptes:

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

Pour obtenir une client_id et client_secret, vous devrez aller à l'interface utilisateur OAuth et enregistrer une application:

Gestion des informations d'identification de l'API

Vous pouvez également obtenir vos informations d'identification via CURL ou Postman - voir:

Vous utiliserez vos informations d'identification client pour obtenir des jetons d'accès qui vous permettront d'effectuer des appels à l'API. Les jetons d'accès sont transmis dans un en-tête Authorization:

    Authorization: Bearer {your_access_token}

Voir le Section Oauth pour plus d’informations.

Rendements maximum

Le nombre maximal de rendus que vous pouvez définir dans un profil d'intégration est 25. Si vous définissez plus que ce nombre, la requête renvoie une réponse 409 d'erreur: le nombre de rendus de profil dépasse la limite de rendu configurée.

Sorties conditionnelles

Si la qualité des vidéos varie considérablement (par exemple, si elles contiennent du contenu généré par l'utilisateur créé sur des téléphones dotés d'appareils photo de qualité médiocre), vous souhaiterez peut-être que la génération de certains rendus dépende du débit ou de toute autre propriété du système. source vidéo. Cela empêchera la création et le stockage de rendus redondants. Voir Sorties conditionnelles Pour plus de détails sur la façon de le faire.

Opérations de compte

Au niveau du compte, vous pouvez obtenir tous les profils du compte et en créer de nouveaux.

Endpoint

    /accounts/{account_id}/profiles

Obtenez tous les profils

Pour obtenir tous les profils du compte (y compris profils standards), vous soumettez une requête GET au point de terminaison indiqué ci-dessus.

Créer un profil

Pour créer un nouveau profil, vous devez soumettre une demande POST au point de terminaison indiqué ci-dessus, y compris les données JSON pour le profil en tant que corps de la demande. Voir le exemple de profil ci-dessous pour un exemple de données JSON, et Référence des champs de profil pour les champs autorisés.

Opérations à profil unique

Pour les profils individuels, vous pouvez obtenir le profil par nom ou ID, remplacer un profil et supprimer un profil.

Endpoint

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

Pour le profile_id, vous pouvez utiliser soit:

nom (par exemple, équilibré-haute définition)
generated id (e.g. 54de14cce4b0a6d2bf9cb08a)

Obtenir un profil par id

Pour récupérer un seul profil, envoyez une requête GET au noeud final indiqué ci-dessus.

Mettre à jour un profil

Pour mettre à jour un profil, faites une demande PUT au point de terminaison ci-dessus, y compris complet Données JSON pour le profil dans le corps de la requête.

Note: le JSON pour le profil mis à jour doivent inclure id propriété.

Supprimer un profil

Pour supprimer un profil, effectuez une demande DELETE sur le point de terminaison ci-dessus.

Cette action est irréversible

Opérations de profil par défaut

Vous pouvez obtenir, définir ou mettre à jour la vidéo à la demande par défaut et live profils vidéo de votre compte utilisant le point de terminaison:

    /accounts/{account_id}/configuration

Obtenir le profil par défaut

Récupérez le profil par défaut de votre compte en faisant une demande GET au point de terminaison ci-dessus.

Si aucun profil par défaut n'a été défini, le profil par défaut du système sera renvoyé.

Définir le profil par défaut

Pour définir le profil par défaut, envoyez une requête POST au noeud final indiqué ci-dessus, y compris le corps JSON dans la requête:

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

Pour le default_profile_id, vous pouvez utiliser l'un des:

nom (par exemple, équilibré-haute définition)
generated id (e.g. 54de14cce4b0a6d2bf9cb08a)

Mettre à jour le profil par défaut

Pour mettre à jour le profil par défaut, faites une demande PUT au point de terminaison indiqué ci-dessus, y compris ce JSON dans le corps de la requête:

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

Obtenez le configuration_id à partir de la réponse à une requête GET ou POST.

Définir la valeur par défaut live profil

Définir la valeur par défaut live profile est exactement le même que la définition du profil de vidéo à la demande par défaut, à l'exception de cette modification dans le corps de la demande:

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

À noter :

Si vous spécifiez un profil inexistant, la requête échouera

Exemple de profil

La Profils standards document vous montrera tous les profils par défaut qui existent actuellement pour tous Video Cloud comptes.

Filigranes

Si vous souhaitez ajouter des filigranes (ou une image de logo) à vos vidéos, vous pouvez utiliser les champs de filigrane dans votre profil d'acquisition.

Voici un exemple de profil de rendu avec des filigranes:

    ...
    "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"
            }
          ]
      }, ...

Voir le

Contenu de la page

Aperçu: Ingest Profiles API

Gestion des profils d'acquisition

Glossaire des termes

URL de base

Autorisation

Rendements maximum

Sorties conditionnelles

Opérations de compte

Endpoint

Obtenez tous les profils

Créer un profil

Opérations à profil unique

Endpoint

Obtenir un profil par id

Mettre à jour un profil

Supprimer un profil

Opérations de profil par défaut

Obtenir le profil par défaut

Définir le profil par défaut

Mettre à jour le profil par défaut

Définir la valeur par défaut live profil

À noter :

Exemple de profil

Filigranes