LiveCuepoints

Die Ressource liveCuepoint und die Methode liveCuepoints.insert wurden verworfen und durch die Methode liveBroadcasts.cuepoint ersetzt.

Eine Ressource vom Typ liveCuepoint fügt einen Cue-Punkt in den Videostream der Übertragung ein, der möglicherweise eine Werbeunterbrechung auslöst.

Hinweis: Dieser API-Befehl ist tatsächlich Teil der YouTube Content ID API und stellt andere Autorisierungsanforderungen als Anfragen zum Verwalten von liveBroadcast- und liveStream-Ressourcen.

Methoden

Die API unterstützt die folgenden Methoden für liveCuepoints-Ressourcen:

Einfügen
Fügt einen Cue-Punkt in eine Liveübertragung ein. Derzeit müssen Anfragen an diese Methode von einem Konto autorisiert werden, das mit einem YouTube-Rechteinhaber verknüpft ist. Hier kannst du die Funktion ausprobieren.

Ressourcendarstellung

Die folgende JSON-Struktur zeigt das Format einer liveCuepoints-Ressource:

{
  "id": string,
  "kind": "youtubePartner#liveCuepoint",
  "broadcastId": string,
  "settings": {
    "offsetTimeMs": long,
    "walltime": datetime,
    "cueType": string,
    "durationSecs": unsigned integer
  }
}

Attribute

In der folgenden Tabelle werden die Attribute definiert, die in dieser Ressource angezeigt werden:

Attribute
id string
Ein Wert, den YouTube zur eindeutigen Identifizierung des Cue-Punkts zuweist.
kind string
Der Typ der API-Ressource. Für liveCuepoint-Ressourcen ist der Wert youtubePartner#liveCuepoint.
broadcastId string
Die ID, die YouTube zur eindeutigen Identifizierung des Broadcasts verwendet, in den der Cuepoint eingefügt wird.
settings object
Das Objekt settings definiert die Einstellungen des Cue-Punkts.
settings.offsetTimeMs long
Dieser Wert gibt einen Zeitpunkt im Video an, zu dem Zuschauer eine Anzeige oder ein In-Stream-Slate sehen sollten. Der Property-Wert gibt einen Zeitversatz in Millisekunden vom Beginn des Monitoring-Streams an an. Obwohl der Wert in Millisekunden gemessen wird, handelt es sich tatsächlich um einen Näherungswert. Der Cue-Punkt wird von YouTube möglichst genau zu diesem Zeitpunkt eingefügt. Du solltest keinen Wert für diesen Parameter angeben, wenn deine Übertragung keinen Monitorstream hat.

Der Standardwert dieses Attributs ist 0. Dies bedeutet, dass der Cue so bald wie möglich eingefügt werden soll. Wenn sich der Übertragungsstream nicht verzögert, ist 0 ebenfalls der einzige gültige Wert. Wenn der Broadcast-Stream jedoch verzögert ist, kann mit dem Property-Wert die Zeit angegeben werden, zu der der Cuepoint eingefügt werden soll. Weitere Informationen finden Sie im Startleitfaden.

Hinweis:Wenn Ihre Übertragung eine Testphase hatte, wird der Offset ab dem Beginn des Testzeitraums gemessen.
settings.walltime datetime
Dieser Wert gibt die Uhrzeit der Echtzeit an, zu der der Cue-Punkt eingefügt werden soll. Der Wert wird im ISO 8601-Format (YYYY-MM-DDThh:mm:ss.sssZ) angegeben.

Die API gibt einen Fehler zurück, wenn bei einer Anfrage versucht wird, einen Cue-Punkt einzufügen, der einen Wert für diese Property und für die Property settings.offsetTimeMs angibt.
settings.cueType string
Der Typ des Cue-Points. Eine Erläuterung der verschiedenen Arten von Cue-Punkten finden Sie im Startleitfaden. Im Abschnitt Lebensdauer einer Übertragung finden Sie außerdem Best Practices zum Einfügen von Cue-Punkten während der Übertragung.

Für diese Property sind folgende Werte gültig:
  • ad
settings.durationSecs unsigned integer
Die Dauer des Cue-Punkts in Sekunden. Dieser Wert muss angegeben werden, wenn cueType den Wert ad hat. Andernfalls wird er ignoriert.