LiveBroadcasts: control

Hinweis: Die Methode liveBroadcasts.control wurde verworfen und funktioniert ab dem 1. Oktober 2020 nicht mehr. Nach diesem Datum wird bei allen Aufrufen dieser Methode der Fehler „Unzulässig“ (403) zurückgegeben und die Methode wird später vollständig entfernt.

Kunden können weiterhin ihr eigenes SLA implementieren, indem sie dem Video, das an die Datenaufnahmeserver von YouTube gesendet wird, ein Overlay hinzufügen. Siehe Einstellungsankündigung.

Steuert die Einstellungen für ein Slate, das im Broadcast-Stream angezeigt werden kann.

Gängige Anwendungsfälle

Anfragen

HTTP-Anfrage

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/control

Autorisierung

Diese Anfrage benötigt eine Autorisierung mit mindestens einem der folgenden Bereiche (weitere Informationen zu Authentifizierung und Autorisierung).

Bereich
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Parameter

In der folgenden Tabelle sind die Parameter aufgeführt, die von dieser Abfrage unterstützt werden. Alle aufgeführten Parameter sind Abfrageparameter.

Parameter
Erforderliche Parameter
id string
Der Parameter id gibt die ID der YouTube-Liveübertragung an. Damit wird die Übertragung eindeutig identifiziert, in der das Slate aktualisiert wird.
part string
Mit dem Parameter part wird eine durch Kommas getrennte Liste eines oder mehrerer liveBroadcast-Ressourcenattribute angegeben, die in der API-Antwort enthalten sein sollen. Die part-Namen, die Sie in den Parameterwert aufnehmen können, sind id, snippet, contentDetails und status.
Optionale Parameter
displaySlate boolean
Der Parameter displaySlate gibt an, ob das Slate aktiviert oder deaktiviert wird.
offsetTimeMs unsigned long
Der Parameter offsetTimeMs gibt einen positiven Zeitversatz für die angegebene Slate-Änderung an. Der Wert wird in Millisekunden ab Beginn des Monitorstreams der Übertragung gemessen. Das ist die Zeit, zu der die Testphase für die Übertragung begonnen hat. Auch wenn der Wert in Millisekunden angegeben ist, handelt es sich tatsächlich um einen Näherungswert. YouTube führt die angeforderte Aktion so genau wie möglich vor diesem Zeitpunkt aus.

Wenn du keinen Wert für diesen Parameter angibst, führt YouTube die Aktion so schnell wie möglich aus. Weitere Informationen finden Sie im Startleitfaden.

Wichtig: Sie sollten nur dann einen Wert für diesen Parameter angeben, wenn der Broadcast-Stream verzögert ist.
onBehalfOfContentOwner string
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Hinweis: Dieser Parameter ist ausschließlich für YouTube-Contentpartner vorgesehen.

Der Parameter onBehalfOfContentOwner gibt an, dass durch die Autorisierungsanmeldedaten der Anfrage ein YouTube CMS-Nutzer identifiziert wird, der im Namen des im Parameterwert angegebenen Rechteinhabers handelt. Dieser Parameter ist für YouTube-Content-Partner vorgesehen, die viele verschiedene YouTube-Kanäle besitzen und verwalten. Rechteinhaber können sich nur einmal authentifizieren und auf alle ihre Video- und Kanaldaten zugreifen, ohne für jeden einzelnen Kanal Authentifizierungsdaten angeben zu müssen. Das CMS-Konto, mit dem sich der Nutzer authentifiziert, muss mit dem angegebenen YouTube-Rechteinhaber verknüpft sein.
onBehalfOfContentOwnerChannel string
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Hinweis: Dieser Parameter ist ausschließlich für YouTube-Contentpartner vorgesehen.

Der Parameter onBehalfOfContentOwnerChannel gibt die YouTube-Kanal-ID des Kanals an, zu dem ein Video hinzugefügt wird. Dieser Parameter ist erforderlich, wenn in einer Anfrage ein Wert für den Parameter onBehalfOfContentOwner angegeben wird, und kann nur in Verbindung mit diesem Parameter verwendet werden. Außerdem muss die Anfrage über ein CMS-Konto autorisiert werden, das mit dem Rechteinhaber verknüpft ist, der im onBehalfOfContentOwner-Parameter angegeben ist. Schließlich muss der Kanal, den der Parameterwert onBehalfOfContentOwnerChannel angibt, mit dem Rechteinhaber verknüpft sein, der durch den Parameter onBehalfOfContentOwner angegeben wird.

Dieser Parameter ist für YouTube-Contentpartner gedacht, die viele verschiedene YouTube-Kanäle besitzen und verwalten. Damit können sich Rechteinhaber einmal authentifizieren und Aktionen für den im Parameterwert angegebenen Kanal ausführen, ohne für jeden einzelnen Kanal Anmeldedaten zur Authentifizierung angeben zu müssen.
walltime datetime
Der Parameter walltime gibt die tatsächlich verstrichene Zeit an, zu der die angegebene Slate-Änderung erfolgt. Der Wert wird im Format ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) angegeben.

Anfragetext

Geben Sie beim Aufrufen dieser Methode keinen Anfragetext an.

Antwort

Wenn der Vorgang erfolgreich ist, wird mit dieser Methode eine liveBroadcast-Ressource im Antworttext zurückgegeben.

Fehler

In der folgenden Tabelle finden Sie Fehlermeldungen, die die API als Antwort auf einen Aufruf dieser Methode zurückgeben könnte. Weitere Informationen finden Sie in der Dokumentation zu Fehlermeldungen.

Fehlertyp Fehlerdetails Beschreibung
backendError errorDisplaySlate Beim Ausführen der angeforderten Aktion ist ein Fehler aufgetreten.
forbidden (403) liveBroadcastControlNotAllowed Die angeforderte Aktion ist nur zulässig, wenn der Broadcast-Status live ist.
insufficientPermissions insufficientLivePermissions Der Nutzer ist für den angeforderten Vorgang nicht berechtigt, möglicherweise weil er nicht zum Livestreaming berechtigt ist.
insufficientPermissions liveStreamingNotEnabled Der Nutzer, der die Anfrage autorisiert hat, ist nicht berechtigt, Live-Videos auf YouTube zu streamen. Weitere Informationen findet der Nutzer unter https://www.youtube.com/features.
invalidValue (400) conflictingTimeFields Es darf nur offsetTimeMs oder walltime angegeben werden.
invalidValue (400) invalidOffsetTimeMs Der Wert des Parameters offsetTimeMs ist ungültig. Der Parameterwert muss positiv sein, aber der Parameter kann nur angegeben werden, wenn der Überwachungsstream der Übertragung aktiviert ist.
invalidValue (400) invalidWalltime Der Wert des Parameters walltime ist ungültig.
notFound (404) liveBroadcastNotFound Die durch den Parameter id angegebene Übertragung ist nicht vorhanden.
required (400) actionRequired In der API-Anfrage muss mindestens eine Aktion angegeben sein. Derzeit kann nur das Slate aktiviert oder deaktiviert werden.
required (400) idRequired Der erforderliche id-Parameter muss die zu aktualisierende Übertragung identifizieren.

Jetzt testen

Verwenden Sie APIs Explorer, um diese API aufzurufen und die API-Anfrage und -Antwort anzusehen.