Überblick: API für Ingest-Profile

In diesem Thema erhalten Sie einen Überblick über die Ingest Profiles API. Mit der Ingest Profiles API können Sie Wiedergabeprofile für Ihr Video Cloud-Konto erstellen, abrufen, aktualisieren und löschen.

Verwalten von Aufnahmeprofilen

Beachten Sie, dass Brightcove-Konten möglicherweise auch für die kontextabhängige Kodierung aktiviert sind oder nicht.

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

Siehe auch die API-Referenz.

Glossar der Begriffe

Profil JSON

Der nachstehende Begriff "Profil-JSON" bezeichnet die JSON-Darstellung eines Profilobjekts. Sie enthalten Profilfelder der obersten Ebene und eine Sammlung von Wiedergabeobjekten als Liste.

Profil ID

EIN profile id kann entweder das sein id oder name Feld der obersten Ebene in einem Profil. In diesem Beispiel (ein Fragment eines Profils):

{
		"id": "f1b16093e2dc4f81810f1488",
		"version": 1,
		"name": "multi-platform-extended-static",
		"description": "Deliver high quality content for a wide range content types and screen sizes including mobile, desktop and large screens.", ...

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

Referenz ID

EIN reference_id identifiziert eine Darstellung innerhalb eines Profils eindeutig. Referenz-IDs werden für die DRM-Verpackung 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, das die Identifizierung des Formats der Formatvariante erleichtert, z. B.: mp4_1 mp4_2, hls1, hls2, , usw.

Profilversion

EIN version ist die Revisionsnummer eines Profils für ein Konto. Er wird durch einen langen Integer-Wert dargestellt. Hinweis: Es wird in der JSON-Darstellung nicht 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, das aktiv ist, und die alte Version wird inaktiv.

Standardprofil

Ein Profil ist standard wenn es von Brightcove zur Verfügung gestellt wird (dh es handelt sich nicht um ein benutzerdefiniertes Profil speziell für ein einzelnes Konto).

Standard Profil

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

Basis-URL

Die Dienst-URL lautet:

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

Autorisierung

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 Ihr(e) Konto(n) 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 Antwort client_id zu erhalten client_secret, müssen Sie zur OAuth-Benutzeroberfläche gehen und eine App registrieren:

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

Sie verwenden Ihre Client-Anmeldeinformationen, um Zugriffstoken zu erhalten, mit denen Sie die API aufrufen können. Zugriffstoken werden in einem Authorization-Header übergeben:

Authorization: Bearer {your_access_token}

Siehe die OAuth-Bereich für mehr Informationen.

Maximale Wiedergaben

Sehen Best Practices für Aufnahmeprofile.

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) zu erhalten, senden Sie eine GET-Anfrage an den oben angegebenen Endpunkt.

Erstelle ein Profil

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

 

Erstellen Sie ein Live-Profil

Um ein benutzerdefiniertes Aufnahmeprofil für Live zu erstellen, müssen Sie lediglich HLS-Darstellungen mit angeben live_stream einstellen true:

{
  "media_type": "video",
  "format": "ts",
  "segment_seconds": 6,
  "label": "hls1080p",
  "live_stream": true,
  "video_codec": "h264",
  "video_bitrate": 4000,
  "keyframe_interval": 60,
  "width": 1920,
  "height": 1080,
  "h264_profile": "high"
}

Beachten Sie, dass Sie nur die Legacy-Aufnahme verwenden sollten rendition Einstellungen für Live-Profile, nicht das dynamic_origin Einstellungen für Dynamic Delivery-Profile.

Einzelprofiloperationen

Bei einzelnen Profilen 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_id können Sie verwenden entweder das:

  • Name (z. B. Multi-Plattform-Standard-Static)
  • generierte ID (zB f1b16093e2dc4f81810f1488)

Holen Sie sich ein Profil von id

Um ein einzelnes Profil abzurufen, stellen Sie eine GET-Anfrage an den oben gezeigten Endpunkt.

Aktualisieren Sie ein Profil

Um ein Profil zu aktualisieren, stellen Sie eine PUT-Anforderung an den oben genannten Endpunkt, einschließlich des Komplett JSON-Daten für das Profil im Anforderungshauptteil.

Profil löschen

Um ein Profil zu löschen, stellen Sie eine DELETE-Anfrage an den obigen Endpunkt.

Diese Aktion ist irreversibel

Standardprofiloperationen

Sie können die Standard-Video-on-Demand- und Live-Videoprofile 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 eine GET-Anfrage an den obigen Endpunkt senden.

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

Legen Sie das Standardprofil fest

Um das Standardprofil festzulegen, stellen Sie eine POST-Anfrage an den oben gezeigten Endpunkt, einschließlich der JSON im Anfragetext:

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

Für die default_profile_id können Sie eine der folgenden Optionen verwenden:

  • Name (z. B. Multi-Plattform-Standard-Static)
  • generierte ID (zB f1b16093e2dc4f81810f1488)

Aktualisieren Sie das Standardprofil

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

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

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

Festlegen des Standard-Live-Profils

Das Festlegen des Standard-Live-Profils ist mit dem Festlegen des Standard-Video-on-Demand-Profils identisch, mit Ausnahme dieser Änderung im Anforderungstext:

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

Festlegen des standardmäßigen Social Clipping-Profils

Das Festlegen des Standardprofils für Social Clipping entspricht genau dem Festlegen des Standardprofils für Video-on-Demand, mit Ausnahme dieser Änderung im Anforderungstext:

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

Hinweise:

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

Beispielprofil

Die Standardprofile document zeigt Ihnen alle Standardprofile an, die derzeit für alle Video Cloud-Konten vorhanden sind.

Wasserzeichen

Wenn Sie Ihren Videos Wasserzeichen (oder ein Logobild) hinzufügen möchten, Brightcove-Support kontaktieren.