Support Kontakt Support | Systemstatus Systemstatus

Überblick: Ingest Profiles API

In diesem Thema erhalten Sie einen Überblick über das Ingest Profiles APIdem „Vermischten Geschmack“. Seine Ingest Profiles API ermöglicht das Erstellen, Abrufen, Aktualisieren und Löschen von Wiedergabeprofilen für Ihre Video Cloud Konto.

Ingest-Profile verwalten

Aufnahmeprofile werden als Spezifikation für die Transkodierung verwendet, wenn Sie Videos hochladen oder umkodieren. Sie können diese Profile mit verwalten Ingest Profiles API.

Glossar der Begriffe

Profil JSON

Der Begriff "Profil-JSON" bezeichnet die JSON-Darstellung eines Profilobjekts. Sie enthalten Profilfelder der obersten Ebene und eine Sammlung von Wiedergabeobjekten als Liste. Sehen Standardprofile um den JSON für die Standardprofile zu sehen, die in jedem Konto enthalten sind und Inhaltssicherheit (DRM und HLSe) für Beispielprofile, die DRM-Pakete enthalten.

Profil ID

A profile id kann entweder der sein id or name Feld auf oberster Ebene in einem Profil. In diesem Beispiel (ein Fragment eines Profils):

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

"screencast-1280" oder "5591b5ede4b0f7138939ad8c" sind beide gültige Profil-IDs. Wenn Sie ein Profil zum ersten Mal erstellen, geben Sie ein Profil mit einem Namen ohne ID an, und die Antwort enthält das erstellte Profil einschließlich seiner ID. Sie können diese dann für jeden nachfolgenden API-Aufruf verwenden.

Referenz ID

A reference_id identifiziert eine Wiedergabe in einem Profil eindeutig. Referenz-IDs werden für das DRM-Packen verwendet und können in Zukunft für andere Zwecke verwendet werden. Abgesehen davon, dass sie innerhalb des Profils eindeutig sind, können Referenz-IDs eine beliebige Zeichenfolge sein - sie sollte keine Leerzeichen enthalten. Wir empfehlen, ein Schema zu verwenden, mit dem sich das Format der Wiedergabe leicht identifizieren lässt, zum Beispiel: mp4_1, mp4_2, hls1, hls2, usw.

Profilversion

A version ist die Revisionsnummer eines Profils für ein Konto. Es wird durch einen langen Ganzzahlwert dargestellt. Hinweis: Es wird nicht in der JSON-Darstellung zitiert.

Aktives Profil

Ein Profil ist active wenn es für Uploads verwendet werden kann. Wenn Sie beispielsweise ein Profil aktualisieren, erhalten Sie ein neues Profil mit einer erhöhten Versionsnummer, die aktiv ist, und die alte Version wird inaktiv.

Standardprofil

Ein Profil ist standard wenn es für die Verwendung durch Brightcove bereitgestellt wird (dh es ist kein benutzerdefiniertes Profil, das für ein einzelnes Konto spezifisch ist).

Standard Profil

Ein Profil ist default wenn es verwendet wird, wenn kein Profil explizit ausgewählt ist. Wenn Sie keine Kontokonfiguration haben oder in Ihrer Konfiguration kein Standardprofil festlegen, wird eines der Brightcove-Profile verwendet standard Profile werden in Übereinstimmung mit Ihrem Kontotyp verwendet.

Basis-URL

Die Service-URL lautet:

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

Genehmigung

Die Autorisierung für die API erfolgt über die OAuth2-Implementierung von Brightcove. Sie benötigen Client-Anmeldeinformationen (eine Client-ID und ein Client-Geheimnis), die über Berechtigungen für die folgenden Vorgänge für Ihre Konten verfügen:

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

Um eine zu bekommen client_id und client_secret, müssen Sie zur OAuth-Benutzeroberfläche gehen und eine App registrieren:

Sie können Ihre Anmeldeinformationen auch über CURL oder Postman erhalten - siehe:

Sie verwenden Ihre Clientanmeldeinformationen, um Zugriffstoken zu erhalten, mit denen Sie Aufrufe an die API senden können. Zugriffstoken werden in einem Autorisierungsheader übergeben:

    Authorization: Bearer {your_access_token}

Siehe die Oauth Abschnitt .

Maximale Wiedergabe

Die maximale Anzahl an Darstellungen, die Sie in einem Aufnahmeprofil definieren können, ist 25. Wenn Sie mehr als diese Zahl definieren, gibt die Anforderung eine Fehler-409-Antwort zurück: Die Profilwiedergabefähigkeit überschreitet das konfigurierte Renditionslimit.

Bedingte Ausgaben

Wenn die von Ihnen aufgenommenen Videos in ihrer Qualität stark variieren - Ihre Videos können beispielsweise von Nutzern erstellte Inhalte enthalten, die auf Handys mit Kameras geringer Qualität erstellt wurden - möchten Sie möglicherweise die Generierung einiger Wiedergaben von der Bitrate oder einer anderen Eigenschaft der abhängig machen Quellvideo. Dies verhindert das Erstellen und Speichern redundanter Wiedergaben. Sehen Bedingte Ausgaben Details dazu finden Sie hier.

Kontovorgänge

Auf Kontoebene können Sie alle Profile für das Konto abrufen und neue erstellen.

Endpunkt

    /accounts/{account_id}/profiles

Alle Profile abrufen

Um alle Profile für das Konto (einschließlich Standardprofile), senden Sie eine GET-Anfrage an den oben gezeigten Endpunkt.

Erstellen Sie ein Profil

Um ein neues Profil zu erstellen, senden Sie eine POST-Anforderung an den oben gezeigten Endpunkt, einschließlich JSON-Daten für das Profil als Anfragetext. Siehe die Beispielprofil unten für ein Beispiel der JSON-Daten und der Profilfelder Referenz für die zulässigen Felder.

Einzelprofil-Operationen

Für einzelne Profile können Sie das Profil nach Name oder ID abrufen, ein Profil ersetzen und ein Profil löschen.

Endpunkt

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

Für die profile_idSie können entweder Folgendes verwenden:

  • Name (zB balanced-high-definition)
  • generated id (e.g. 54de14cce4b0a6d2bf9cb08a)

Erhalte ein Profil nach ID

Um ein einzelnes Profil abzurufen, führen Sie eine GET-Anfrage an den oben gezeigten Endpunkt aus.

Aktualisieren Sie ein Profil

Um ein Profil zu aktualisieren, führen Sie eine PUT-Anforderung an den obigen Endpunkt aus, einschließlich der abschließen JSON-Daten für das Profil im Anfragetext.

Löschen Sie ein Profil

Um ein Profil zu löschen, führen Sie eine DELETE-Anforderung an den oben genannten Endpunkt aus.

Diese Aktion ist irreversibel

Standardprofil-Operationen

Sie können die standardmäßigen Video-on-Demand- und Live-Video-Profile für Ihr Konto mithilfe des Endpunkts abrufen, festlegen oder aktualisieren:

    /accounts/{account_id}/configuration

Holen Sie sich das Standardprofil

Rufen Sie das Standardprofil für Ihr Konto ab, indem Sie oben eine GET-Anforderung an den Endpunkt stellen.

Wenn kein Standardprofil festgelegt wurde, wird das Systemstandardprofil zurückgegeben.

Legen Sie das Standardprofil fest

Um das Standardprofil festzulegen, führen Sie eine POST-Anforderung an den oben gezeigten Endpunkt aus, einschließlich des JSON im Anfragetext.

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

Für die default_profile_idkönnen Sie eines der folgenden Elemente verwenden:

  • Name (zB balanced-high-definition)
  • generated id (e.g. 54de14cce4b0a6d2bf9cb08a)

Aktualisieren Sie das Standardprofil

Um das Standardprofil zu aktualisieren, machen Sie eine PUT-Anfrage an den oben gezeigten Endpunkt, einschließlich dieses JSON im Anfragetext:

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

Bekommen das configuration_id von der Antwort auf eine GET- oder POST-Anfrage.

Festlegen des Standard-Live-Profils

Das Festlegen des Standard-Live-Profils entspricht genau dem Festlegen des Standard-Video-on-Demand-Profils, mit Ausnahme dieser Änderung im Anfragetext:

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

Anmerkungen:

  • Wenn Sie ein nicht vorhandenes Profil angeben, schlägt die Anforderung fehl

Beispielprofil

Unser Standardprofile Das Dokument zeigt Ihnen alle Standardprofile an, die derzeit für alle vorhanden sind Video Cloud Konten.

Wasserzeichen

Wenn Sie Ihren Videos Wasserzeichen (oder ein Logo-Bild) hinzufügen möchten, können Sie die Wasserzeichenfelder in Ihrem Aufnahmeprofil verwenden.

Hier ist ein Beispiel für ein Wiedergabe-Profil mit Wasserzeichen:

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

Siehe die


Seite zuletzt aktualisiert am 12. Juni 2020