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 ein verbotener (403)-Fehler zurückgegeben und die Methode später vollständig entfernt.

Kunden können weiterhin eine eigene Slack-Technologie implementieren, indem sie dem Video, das an die Aufnahmeserver von YouTube gesendet wird, ein Overlay hinzufügen. Siehe Ankündigung.

Steuert die Einstellungen für ein Slate, das im Übertragungsstream 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).

Umfang
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 YouTube-Liveübertragungs-ID an, die den Sender, in dem das Slate aktualisiert wird, eindeutig identifiziert.
part string
Der Parameter part gibt eine durch Kommas getrennte Liste mit einer oder mehreren liveBroadcast-Ressourceneigenschaften an, die in der API-Antwort enthalten sein werden. 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 ist.
offsetTimeMs unsigned long
Der Parameter offsetTimeMs gibt einen positiven Zeitversatz an, zu dem das angegebene Slate geändert wird. Der Wert wird in Millisekunden ab Beginn des Überwachungsstreams der Übertragung gemessen. Dies ist der Zeitpunkt, zu dem die Testphase für die Übertragung begonnen hat. Auch wenn der Wert in Millisekunden angegeben wird, handelt es sich um einen Näherungswert. Die angeforderte Aktion wird von YouTube möglichst zeitnah ausgeführt.

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

Wichtig: Du solltest einen Wert für diesen Parameter nur angeben, wenn dein Übertragungsstream 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-Content-Partner vorgesehen.

Der Parameter onBehalfOfContentOwner gibt an, dass die Autorisierungsanmeldedaten der Anfrage einen YouTube CMS-Nutzer identifizieren, 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 einmalig authentifizieren und auf alle ihre Video- und Kanaldaten zugreifen, ohne für jeden einzelnen Kanal Anmeldedaten zur Authentifizierung 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 nur für YouTube-Content-Partner 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 ist. Er kann nur in Verbindung mit diesem Parameter verwendet werden. Außerdem muss die Anfrage über ein CMS-Konto autorisiert werden, das mit dem im onBehalfOfContentOwner-Parameter angegebenen Rechteinhaber verknüpft ist. Schließlich muss der Kanalwert, den der Parameterwert onBehalfOfContentOwnerChannel angibt, mit dem Rechteinhaber verknüpft sein, den der Parameter onBehalfOfContentOwner angibt.

Dieser Parameter ist für YouTube-Content-Partner vorgesehen, die zahlreiche verschiedene YouTube-Kanäle besitzen und verwalten. Rechteinhaber können sich einmalig 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 Echtzeituhrzeit an, zu der das angegebene Slate geändert wird. Der Wert wird im ISO 8601-Format (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 sind Fehlermeldungen aufgeführt, die von der API möglicherweise als Antwort auf einen Aufruf dieser Methode zurückgegeben werden. 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 Übertragungsstatus live ist.
insufficientPermissions insufficientLivePermissions Der Nutzer ist nicht zum angeforderten Vorgang berechtigt, möglicherweise weil er nicht live streamen kann.
insufficientPermissions liveStreamingNotEnabled Der Nutzer, der die Anfrage autorisiert hat, kann keine Livevideos auf YouTube streamen. Weitere Informationen findest du 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 werden. Derzeit kann nur das Slate aktiviert oder deaktiviert werden.
required (400) idRequired Der erforderliche id-Parameter muss die zu aktualisierende Übertragung angeben.

Testen!

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