Mithilfe der Video Cloud-Medien-Schreib-API können einem Video Cue-Points hinzugefügt werden. Ein Cue-Point markiert einen genauen Zeitpunkt während der Dauer eines Videos. Mithilfe von Cue-Points können Sie Mid-Roll-Anzeigen auslösen oder Kapitel bzw. Szenen in langen Videos unterteilen.
Die Medien-Schreib-APIs stehen nur Kunden von Video Cloud Pro und Enterprise zur Verfügung. Wenn Sie Ihr Video Cloud-Konto heraufstufen möchten, nehmen Sie Kontakt mit Brightcove auf, um weitere Informationen zu erhalten.
Cue-Points können auch im Video Cloud-Werbemodul oder mittels FTP-Batch-Bereitstellung unter Verwendung des <cuepoint>-XML-Elements im Batch-Bereitstellungsmanifest hinzugefügt werden. Weitere Informationen über die verschiedenen Methoden zum Hinzufügen von Cue-Points finden Sie unter Hinzufügen von Cue-Points zu Videos.
Erstellen von Cue-Points
Cue-Points werden mithilfe der create_video-Methode der Medien-API erstellt. Die create_video-Methode hat diese Signatur:
create_video(token:String, video:Video, filename:String,
maxsize:Long, file:InputStream, file_checksum:String,
create_multiple_renditions:Boolean, cuePoints:List):Long
Zur Verwendung der create_video-Methode übergeben Sie die folgenden Komponenten:
- das Schreibtoken für die Medien-API;
- die ID oder Referenz-ID des Videos, dem ein Cue-Point zugewiesen werden soll;
- eine Liste mit Cue-Points, einschließlich der folgenden Eigenschaften für jeden Cue-Point:
Cue-Point-Eigenschaften
| Name |
Erforderlich? |
Beschreibung |
| name |
Erforderlich |
Ein Name für den Cue-Point, mit dem Sie darauf verweisen können. Der Name eines Cue-Points darf maximal 128 Zeichen umfassen. |
| time |
Erforderlich |
Die Zeit des Cue-Points, gemessen in Millisekunden ab dem Beginn des Videos. |
| forceStop |
Optional |
Wenn dieser Parameter auf „true“ eingestellt ist, wird die Wiedergabe des Videos am Cue-Point gestoppt. Diese Einstellung gilt nur für Anzeigen-Cue-Points. |
| type |
Erforderlich |
Ein ganzzahliger Code, der den Typ des Cue-Points angibt. Entweder 0 (AD, Anzeige) oder 1 (CODE). Ein Anzeigen-Cue-Point dient zum Auslösen von Mid-Roll-Anzeigenanforderungen. Ein CODE-Cue-Point kann ein neues Kapitel oder eine neue Szene im Video markieren. |
| metadata |
Optional |
Ein String, der mit einem CODE-Cue-Point übergeben werden kann. Die Metadaten eines Cue-Points dürfen maximal 512 Zeichen umfassen. |
Für ein Video mit der ID 123 könnten Sie zum Festlegen eines CODE-Cue-Points nach 1 Sekunde Laufzeit, eines CODE-Cue-Points nach 48 Sekunden Laufzeit und eines Anzeigen-Cue-Points nach 120 Sekunden Laufzeit beispielsweise den folgenden Code unter http://api.brightcove.com/services/ bereitstellen:
{"method": "create_video",
"params": {
"token": "riBRb-rHGiBBouSAXs-Q8Nmz04kE.",
"video": {
"name": "Der Name ist erforderlich.",
"shortDescription": "Die Kurzbeschreibung ebenfalls.",
"cuePoints": [
{"name": "cp_code_1", "time": 1000, "type": 1},
{"name": "cp_code_2", "time": 48000, "type": 1, "metadata": "einige Daten"},
{"name": "cp_ad_1", "time": 120000, "type": 0, "forceStop": "true"}
]
}
}
}
Aktualisieren von Cue-Points
Vorhandene Cue-Points können mithilfe der update_video-Methode der Medien-API aktualisiert oder gelöscht werden. Bei Verwendung des optionalen cuePoints-Parameters mit der update_video-Methode werden alle vorhandenen Cue-Points für das entsprechende Video überschrieben. Alle Cue-Points, die Sie nicht explizit in den cuePoints-Parameter einfügen, werden entfernt.
Wenn Sie bereits Cue-Points für das Video mit der ID 123 wie im vorherigen Beispiel festgelegt haben, könnten Sie beispielsweise den folgenden Code unter http://api.brightcove.com/services/ bereitstellen, um einen zusätzlichen CODE-Cue-Point nach 360 Sekunden Laufzeit festzulegen und den CODE-Cue-Point nach 48 Sekunden Laufzeit zu löschen:
{"method": "update_video",
"params": {
"token" : "riBRb-rHGiBBouSAXs-Q8Nmz04kE.",
"video" : {
"id": 123,
"cuePoints":[
{"name": "cp_code_1", "time": 1000, "type": 1},
{"name": "cp_code_3", "time": 360000, "type": 1},
{"name": "cp_ad_1", "time": 120000, "type": 0, "forceStop": "true"}
]
}
}
}
