User-Funktionen
Unten finden Sie Funktionen im Zusammenhang mit Video Cloud dass Sie möglicherweise Benutzer Ihres CMS bereitstellen möchten:
- Neue Videos hinzufügen zu Video Cloud
- Ersetzen Sie a Video Cloud Video mit einer neuen Version
- Aktualisiere Metadaten für Videos, wie Titel, Beschreibung und Tags
- Videos löschen
- Erstellen von Playlists
- Ändern Sie die Videos in einer Playlist
- Wiedergabelisten löschen
- Erstellen von Videoplayern
- Ändern Sie die Eigenschaften von Videoplayern wie Abmessungen oder Styling
- Fügen Sie Video-Playern über Plugins spezielle Funktionen hinzu
- Veröffentlichen Sie einzelne Videos oder Playlists
- Stellen Sie Analysedaten zu Videoladungen, Ansichten, Wiedergaberaten, Interaktionen usw. bereit.
Möglicherweise möchten Sie all diese Funktionen nicht Ihren Endbenutzern zur Verfügung stellen - Sie möchten sie beispielsweise keine Videos löschen lassen. Einer der Vorteile der Integration Video Cloud mit Ihrem CMS, anstatt Benutzer direkt zu gehen Video Cloud In Studio können Sie genau auswählen, welche Funktionen den Benutzern über die Brightcove-APIs zur Verfügung gestellt werden sollen.
Authentifizierung
Für alle Brightcove API-Anfragen basiert die Authentifizierung auf OAuth2-Zugriffstoken. Es gibt einen zweistufigen Prozess zum Beschaffen von Zugriffstoken:
- Erstellen Sie Client-Anmeldeinformationen mit Berechtigungen für die benötigten API-Operationen
- Verwenden Sie die Client-Anmeldeinformationen, um ein temporäres Zugriffstoken zur Authentifizierung einer API-Anfrage zu
Erstellen von Client-Anmelde
Das Erstellen von Client-Anmeldeinformationen ist eine einmalige Operation, die ausgeführt werden kann Video Cloud Studio oder der OAuth API . Wie auch immer Sie es tun, client_id
und client_secret
werden zurückgegeben, die Sie speichern müssen, um Zugriffstoken anzufordern.
Erstellen eines Zugriffstoken
Temporäre Zugriffstoken werden mit dem erstellt OAuth API . Das client_id
und client_secret
muss Base64-codiert sein und als Basic
Autorisierungszeichenfolge übergeben werden.
Die access_token
Rücksendung wird in einem Authorization-Header mit dem API-Aufruf übergeben:
>Authorization: Bearer your_access_token
Zugangstoken sind 5 Minuten lang gültig. Wenn Sie keine Art von Batch-Operation ausführen, die Hunderte von aufeinanderfolgenden API-Aufrufen tätigt, ist es sinnvoll, für jeden API-Aufruf nur einen neuen anzufordern, anstatt zu versuchen, den Timeout im Auge zu behalten.
Videos hinzufügen
Wenn Sie möchten, dass Benutzer Videos hinzufügen Video Cloud Von Ihrem CMS aus können Sie dies mit dem tun Dynamic Ingest API . Wir empfehlen, dass Benutzer Videos in Ihr Repository hochladen lassen, was ein S3-Bucket oder nur ein öffentlicher Server sein könnte. Das Dynamic Ingest-System kann die Videos abrufen und zum hinzufügen Video Cloud System durch einen zweistufigen Prozess, der unten beschrieben wird.
Hinzufügen eines Videoobjekts zu Video Cloud
Der erste Schritt besteht darin, ein Videoobjekt in der zu erstellen Video Cloud System durch die Herstellung eines POST Anfrage an die CMS API::
https://cms.api.brightcove.com/v1/accounts/:account_id/videos
Der Anforderungshauptteil enthält grundlegende Videoeigenschaften in a JSON Objekt - minimal das Video name
Sie können jedoch auch zusätzliche Metadaten wie a description
und tags
::
{
"name": "Woodpecker",
"description": "A bird that hunts insects inside wood",
"reference_id": "Bird_Woodpecker.mp4",
"tags": ["bird", "air", "nature"]
}
Einnehmen des Videos
Wenn Sie das Videoobjekt erstellen, wird das CMS API wird a zurückgeben JSON Objekt mit den Videoeigenschaften. Sie werden das Video extrahieren id
von dem JSON und verwenden Sie es, um einen Anruf bei der Dynamic Ingest API um die Aufnahme und Transcodierung des Videos anzufordern:
https://ingest.api.brightcove.com/v1/accounts/ACCOUNT_ID/videos/VIDEO_ID/ingest-requests
Wieder wirst du senden JSON im Anforderungshauptteil, der den Speicherort der Videodatei angibt:
{
"master":{
"url":"http://learning-services-media.brightcove.com/videos/mp4/Bird_Woodpecker.mp4"
},
"profile":"multi-platform-extended-static",
"capture-images": true
}
Das profile
hier ist das Ingest-Profil, das angibt, welche Formatvarianten im Transcodierungsprozess erstellt werden sollen. In den meisten Fällen sollte eines der folgenden Standardprofile angemessen sein:
Dynamische Lieferprofile
multi-platform-extended-static
multi-platform-standard-static
Legacy-Ingest-Profile
videocloud-default-v1 (the default)
screencast-1280
smart-player-transition
single-bitrate-high
audio-only
single-bitrate-standard
high-resolution
Sie können jedoch bei Bedarf mithilfe der Option zusätzliche benutzerdefinierte Aufnahmeprofile erstellen Ingest Profiles API oder mit Video Cloud Studio.
Hinzufügen von Poster- und Vorschaubildern
Das capture-images
Option im obigen Code anweist Video Cloud um Poster- und Miniaturbilder für das Video in der Mitte des Transcodierungsprozesses aufzunehmen. Alternativ können Sie einstellen capture-images
zu false
und nehmen Sie stattdessen Bilder auf, entweder zur gleichen Zeit, zu der Sie das Video aufnehmen, oder später:
{
"master":{
"url":"http://learning-services-media.brightcove.com/videos/mp4/Bird_Woodpecker.mp4"
},
"profile":"multi-platform-extended-static",
"capture-images": false,
"poster": {
"url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-poster.png",
"width": 640,
"height": 360
},
"thumbnail": {
"url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-thumbnail.png",
"width": 160,
"height": 90
}
}
Sehen Bilder und die Dynamic Ingest API für mehr Details.
Hinzufügen von Textspuren für Beschriftungen oder Kapitel
Sie können den auch verwenden Dynamic Ingest API , um Textspuren in WebVTT-Dateien zu Videos hinzuzufügen, entweder zum Zeitpunkt der Aufnahme oder später. Textspuren werden verwendet, um einem Video Untertitel oder Kapitel hinzuzufügen.
{
"master":{
"url":"http://learning-services-media.brightcove.com/videos/mp4/Bird_Woodpecker.mp4"
},
"profile":"multi-platform-extended-static",
"capture-images": false,
"poster": {
"url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-poster.png",
"width": 640,
"height": 360
},
"thumbnail": {
"url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-thumbnail.png",
"width": 160,
"height": 90
},
"text_tracks": [
{
"url": "http://learning-services-media.brightcove.com/captions/for_video/Water-in-Motion.vtt",
"srclang": "en",
"kind": "captions",
"label": "English",
"default": true
}
]
}
Sehen WebVTT-Dateien aufnehmen für mehr Details.
Verwalten von Videos
Die CMS API ermöglicht es Ihnen, Videodaten für ein Konto zurückzuholen. (Wie oben gezeigt, wird es auch verwendet, um Videoobjekte im Rahmen des Videoaufgabe-Prozesses zu erstellen.) Die grundlegendste Anfrage ist wie folgt:
https://cms.api.brightcove.com/v1/accounts/account_id/videos
Standardmäßig gibt diese Anforderung a zurück JSON Array von 20 Videoobjekten mit einer Vielzahl von Metadaten, einschließlich Name, Beschreibung, Tags, benutzerdefinierten Feldern, Erstellungsdatum und zuletzt geänderter Daten, URLs für Poster und Miniaturansicht und vielem mehr.
Sie können die Ergebnisse der Anfrage verfeinern, indem Sie der Anfrage einen oder mehrere der folgenden Parameter hinzufügen:
limit
- dies bestimmt die Anzahl der zurückzugebenden Videoobjekte und kann auf eine beliebige Zahl bis zu 100 festgelegt werden - der Standardwert ist 20
offset
- dies bestimmt die Anzahl der zu überspringenden Elemente und wird daher zusammen mit dem
limit
Durchblättern des Videokatalogs verwendet - der Standardwert ist 0 sort
- dies bestimmt das Video-Metadatenfeld, um das Ergebnis zu sortieren - standardmäßig werden die Ergebnisse nach sortiert
updated_at
(absteigend, um zuerst die zuletzt aktualisierten Videos anzuzeigen)
Sehen CMS API Übersicht - Parameter Für detaillierte Informationen zu diesen Parametern.
Suchen nach Videos
Mithilfe des q
Parameters können Sie auch nach einer Vielzahl von Kriterien nach Videos suchen. Sie können nach bestimmten Feldern wie Name, Beschreibung und Tags sowie nach Daten und dem Status der Videos suchen:
https://cms.api.brightcove.com/v1/accounts/account_id/videos?q=tags:sea,mammal
Einzelheiten und alle Suchoptionen finden Sie unter Suche nach Videos.
Ein bestimmtes Video abrufen und aktualisieren
So rufen Sie ein bestimmtes Video anhand seiner ID oder Referenz-ID ab:
https://cms.api.brightcove.com/v1/accounts/account_id/videos/id
or
https://cms.api.brightcove.com/v1/accounts/account_id/videos/ref:reference_id
EIN GET Anfrage gibt das Videoobjekt zurück. Ändern Sie zum Aktualisieren die JSON und geben Sie es mit a zurück PATCH Anfrage an die gleiche URL.
Wiedergabelisten
Playlist-Informationen werden auch auf die CMS API gleiche Weise verwaltet wie Videoinformationen. Beachten Sie, dass Video Cloud unterstützt acht Arten von Wiedergabelisten in zwei Kategorien:
- Manuelle (oder
EXPLICIT
) Wiedergabelisten - enthält eine bestimmte Reihe von Videos - bis zu 100 Videos können enthalten sein
- Intelligente Wiedergabelisten
- dynamisch zur Laufzeit basierend auf Suchkriterien erstellt - es gibt sieben Arten von Smart Playlists, die der Art und Weise entsprechen, wie die Videos in der Liste bestellt werden:
ACTIVATEDOLDESTTONEWEST
ACTIVATEDNEWESTTOOLDEST
ALPHABETICAL
PLAYSTOTAL
PLAYSTRAILINGWEEK
STARTDATEOLDESTTONEWEST
STARTDATENEWESTTO_OLDEST
Die Begrenzung der Anzahl der Videos kann auf eine beliebige Zahl bis zu 100 festgelegt werden.
Wie bei Videos können Sie alle Wiedergabelisten abrufen, indem Sie Ergebnisse verwenden limit
und offset
durchblättern, wenn das Konto eine große Anzahl von Wiedergabelisten hat:
https://cms.api.brightcove.com/v1/accounts/account_id/playlists
Das zurückgegebene Array von Playlist-Objekten enthält Metadaten für die Wiedergabeliste, einschließlich des type
entsprechenden der oben beschriebenen Typen. Wenn der Typ ist EXPLICIT
, wird es auch ein video_ids
Array geben, das die IDs der enthaltenen Videos enthält. Wenn der Typ einer der Smart-Playlist-Typen ist, wird es eine search
Eigenschaft geben, die die Suchzeichenfolge enthält, die die Videos abruft, etwa so:
q=tags:fish,birds
Sie können eine einzelne Wiedergabeliste auch abrufen, indem Sie id
Folgendes verwenden:
https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id
Wenn Sie die vollständigen Videoobjekte für eine Wiedergabeliste abrufen müssen (um Informationen zu den Videos auf einer Seite anzuzeigen), fügen Sie einfach diese URL /videos
hinzu:
https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id/videos
Beachten Sie, dass die Anfrage bei einer intelligenten Wiedergabeliste die Videos zurückgibt, die derzeit den Suchkriterien entsprechen, dies kann sich jedoch ändern.
Erstellen von Playern
Brightcove-Player können über das erstellt werden Player Management API . Die API ermöglicht es Ihnen, Spieler zu erstellen, ihre Eigenschaften zu aktualisieren und den Einbettungscode in Form einer URL, eines iframe
Tags oder eines HTML-Blocks abzurufen, der in die Seite eingebettet werden soll.
Sie können bis zu 200 Spieler pro Konto haben, aber es ist im Allgemeinen weniger verwirrend für Benutzer, so wenige Spieler zu haben, wie Sie unbedingt benötigen. Sie sollten separate Player zum Abspielen einzelner Videos oder Wiedergabelisten haben, ansonsten benötigen Sie jedoch nur verschiedene Player, wenn sie anders gestaltet werden oder unterschiedliche Funktionen über Plugins hinzugefügt werden.
Um einen Spieler zu erstellen, erstellen Sie einfach einen POST Anfrage an die Player Management API::
https://players.api.brightcove.com/v2/accounts/account_id/players
Fügen Sie im Hauptteil der Anfrage die Spielerkonfiguration - Das einzige, was benötigt wird, ist a name
::
{
"name": "Single video player for blog posts"
}
Die Antwort gibt Ihnen die Spieler-ID sowie den Einbettungscode in mehreren Formen:
{
"embed_code": "<iframe src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>",
"embed_in_page": "http://players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/in_page.embed",
"id": "de055fa4-4f09-45af-8531-419c6794ad04",
"preview_embed_code": "<iframe src='//preview-players.brightcove.net/v1/accounts/57838016001/players/de055fa4-4f09-45af-8531-419c6794ad04/preview/embeds/default/master/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>",
"preview_url": "http://preview-players.brightcove.net/v1/accounts/57838016001/players/de055fa4-4f09-45af-8531-419c6794ad04/preview/embeds/default/master/index.html",
"url": "http://players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html"
}
Um die vollständige Player-Konfiguration zu erhalten, stellen Sie eine Anfrage an den /players
Endpoint, fügen jedoch die Player-ID hinzu, die in der obigen Antwort zurückgegeben wird:
https://players.api.brightcove.com/v2/accounts/account_id/players/de055fa4-4f09-45af-8531-419c6794ad04
Sie können eine machen PATCH Fordern Sie denselben Endpunkt an, die Player-Konfiguration zu aktualisieren.
Sie werden in der obigen Antwort das preview_embed_code
und bemerken preview_url
. Um das Testen neuer Spieler oder Spieler-Updates zu ermöglichen, werden neu erstellte oder aktualisierte Spieler im Vorschaumodus festgelegt, damit Sie sie sehen können, bevor Sie Änderungen an bestehende Spieler übertragen. Um Änderungen in die Produktion zu bringen, müssen Sie den Player mit dieser Anfrage veröffentlichen :
https://players.api.brightcove.com/v2/accounts/account_id/players/de055fa4-4f09-45af-8531-419c6794ad04/publish
Anpassen von Spielern
Der Brightcove Player ist mit Standard-Webtechnologien gebaut: HTML, CSS und JavaScript. Sie können den Player mit denselben Technologien anpassen. Dies kann auf der Seite erfolgen, auf der der Player veröffentlicht wird. Es wird jedoch empfohlen, Ihre Anpassungen über den Player zum Player selbst hinzuzufügen Aufbau , Aktualisieren des Players über a PATCH Anfrage an die Player Management API wie im vorherigen Abschnitt erläutert.
Sie können dem Player auch zusätzliche Features und Funktionen hinzufügen JavaScript Plugins und es gibt eine umfangreiche Player-API um Ihnen zu helfen, Ihren Code in den Player zu integrieren. Brightcove bietet eine Reihe von vorgefertigten Plugins für das Aktivieren von Werbung, das Anpassen des Endbildschirms und das Hinzufügen von Overlays.
Veröffentlichen von Videos
In dem Spielerbereich erstellen oben haben wir gesehen, dass, wenn Sie das Player-Konfigurationsobjekt mit dem Player Management API Die zurückgegebenen Daten enthalten ein Iframe-Tag zum Einbetten des Players in eine HTML-Seite sowie eine URL für das vollständige HTML, wenn Sie den Player direkt in eine Seite einbetten möchten.
Für jede Einbettung, die Sie auswählen, müssen Sie eine hinzufügen Video Cloud Video-ID oder Wiedergabelisten-ID zum Einbettungscode, um dem Player Inhalte hinzuzufügen. Der iframe-Einbettungscode sieht folgendermaßen aus:
<iframe
src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html'
allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>
An die URL für den Player müssen Sie den Parameter anhängen videoId={}video_id
, damit der vollständige Einbettungscode wie folgt aussieht:
<iframe
src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html?videoId=4483119716001'
allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>
Wenn dies ein Playlist-Player ist, verwenden Sie playlistId={playlist_id}
stattdessen den Parameter. Die Änderung des In-Page-Einbettungscodes ist ähnlich.
Sofern die Spielerdimensionen nicht in der Player-Konfiguration festgelegt sind, müssen Sie auch die Größe des Players anpassen, indem Sie Breite und Höhe in einem style
Attribut hinzufügen:
<iframe
src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html?videoId=4483119716001'
allowfullscreen webkitallowfullscreen mozallowfullscreen
style=width:640px;height:360px;></iframe>
Analytics-Berichte erhalten
Das Analytics API ermöglicht es Ihnen, Analyseberichte von vielen verschiedenen zu erstellen dimensions
. Siehe die Bemaßungsleitfäden für mehr Informationen.
Sie können den Datumsbereich für den Bericht und die zurückzugebenden Metriken angeben und die Daten abrufen JSON , csv , oder xlxs Format
Für Zeiträume innerhalb des letzten Monats können Sie auch detaillierte Informationen generieren Engagement-Berichte das zeigt Ansichten für jeden hundertsten Teil des Videos.
Beschreibung von APIs
Hier ist eine Zusammenfassung der APIs, die für die Integration in nützlich sind Video Cloud.
- OAuth API
- Wird verwendet, um Client-Anmeldedaten und Zugriffstoken für den Zugriff auf die anderen APIs zu erstellen.
- Medienverwaltung
-
- Ingest Profiles API
- Wird verwendet, um benutzerdefinierte Aufnahmeprofile zu erstellen, in denen die Wiedergaben angegeben sind, die für hinzugefügte Videos erstellt werden sollen Video Cloud
- Dynamic Ingest API
- Wird verwendet, um Videos und verwandte Medienelemente hinzuzufügen Video Cloud
- CMS API
- Wird verwendet, um Videoobjekte für die Aufnahme zu erstellen und Videos und Wiedergabelisten zu verwalten
- Brightcove-Player
-
- Der Brightcove Spieler
- Der Spieler enthält a JavaScript API zur Interaktion mit dem Player zur Laufzeit
- Player Management API
- Wird verwendet, um Spieler zu erstellen und zu konfigurieren und den Einbettungscode des Spielers zu erhalten
- Analytics API
- Wird verwendet, um Analyseberichte über die Videoleistung