Ein Objekt, das eine OpenTok-Live-Streaming-Übertragung repräsentiert.

Rufen Sie nicht die new() Konstruktor. Um eine Live-Streaming-Übertragung zu starten, rufen Sie die OpenTok.startBroadcast() Methode.

Eigenschaften:
Name Typ Beschreibung
id Zeichenfolge Die Sendungs-ID.
sessionId Zeichenfolge Die Sitzungs-ID der OpenTok-Sitzung, die mit dieser Übertragung verknüpft ist.
projectId Zeichenfolge Der mit der Übertragung verknüpfte API-Schlüssel.
createdAt Numbers Der Zeitpunkt, zu dem die Sendung erstellt wurde, in Millisekunden seit der UNIX-Epoche.
resolution Zeichenfolge Die Auflösung der Übertragung: eine der folgenden Optionen: - „640x480“ – „1280x720“ – „1920x1080“ - „480x640“ – „720x1280“ – „1080x1920“ Für Übertragungen, die Videostreams von Mobilgeräten enthalten (die häufig das Hochformat verwenden), empfiehlt es sich, das Hochformat zu verwenden. Diese Eigenschaft ist optional.
broadcastUrls Objekt Ein Objekt, das Details zu den HLS- und RTMP-Übertragungen enthält. - hls (Zeichenkette) — Wenn Sie einen HLS-Endpunkt angegeben haben, enthält das Objekt eine „hls“-Eigenschaft, die auf die URL für die HLS-Übertragung gesetzt ist. Beachten Sie, dass diese HLS-Übertragungs-URL auf eine Indexdatei verweist, eine im .M3U8-Format vorliegende Wiedergabeliste, die eine Liste von URLs zu .ts-Mediensegmentdateien (MPEG-2-Transportstromdateien) enthält. Zwar werden die URLs sowohl der Wiedergabelisten-Indexdatei als auch der Mediensegmentdateien bereitgestellt, sobald die HTTP-Antwort zurückgegeben wird, doch sollte erst 15–20 Sekunden später, nach dem Start der HLS-Übertragung, auf diese URLs zugegriffen werden, da zwischen der HLS-Übertragung und den Live-Streams in der OpenTok-Sitzung eine Verzögerung besteht. Siehe https://developer.apple.com/library/ios/technotes/tn2288/\\_index.html Weitere Informationen zur Playlist-Indexdatei und zu den Mediensegmentdateien für HLS. – hlsStatus (Zeichenkette) — Das Feld „hlsStatus“ kann folgende Zustände annehmen: - „connecting“: Der OpenTok-Server ist gerade dabei, die Transcoder zu starten. Dies ist der Anfangszustand - 'ready': Der OpenTok-Server wurde erfolgreich initialisiert, aber das CDN nimmt keine Medien auf - 'live‘: Der OpenTok-Server wurde erfolgreich initialisiert und das CDN nimmt Medien in Anspruch - ‚ended‘: Der Quellstream ist beendet (wenn DVR aktiviert ist und vorab aufgezeichnete Medien angefordert werden, wechselt der Status zu ‚live‘) - ‚error‘: Es liegt ein Fehler auf der OpenTok-Plattform vor. - rtmp (Objekt-Array) — Wenn Sie RTMP-Stream-Endpunkte angegeben haben, enthält das Objekt eine „rtmp“-Eigenschaft. Dabei handelt es sich um ein Array von Objekten, die Informationen zu jedem der RTMP-Streams enthalten. Jedes dieser Objekte verfügt über die folgenden Eigenschaften: - id Die ID, die Sie dem RTMP-Stream zugewiesen haben - serverUrl Die Server-URL - streamName Der Name des Streams - status Der Status des Streams
maxDuration Numbers Die maximal zulässige Dauer der Übertragung in Sekunden. Nach Ablauf dieser Zeit wird die Übertragung automatisch beendet, sofern sie zu diesem Zeitpunkt noch läuft.
streamMode Zeichenfolge Der Stream-Modus für die Übertragung. Hierfür stehen folgende Optionen zur Auswahl: - „auto“ – Die in die Übertragung einzubeziehenden Streams werden automatisch ausgewählt (Standardeinstellung). - „manual“ – Geben Sie die einzubeziehenden Streams anhand von Aufrufen der OpenTok.addBroadcastStream() und OpenTok.removeBroadcastStream() Methoden.
streams Array Ein Array von Objekten, die den derzeit übertragenen Streams entsprechen. Dies wird nur für eine Übertragung gesetzt, deren Status auf „started“ und deren streamMode auf „manual“ gesetzt ist. Jedes Objekt im Array enthält die folgenden Eigenschaften: - streamId -- Die Stream-ID des in der Übertragung enthaltenen Streams. - hasAudio -- Ob der Ton des Streams in der Übertragung enthalten ist. - hasVideo -- Ob das Video des Streams in der Übertragung enthalten ist.
multiBroadcastTag Zeichenfolge Stellen Sie diese Option ein, um mehrere gleichzeitige Übertragungen derselben Sitzung zu unterstützen. Verwenden Sie hierfür für jede gleichzeitige Übertragung einer laufenden Sitzung eine eindeutige Zeichenfolge. Beachten Sie, dass die multiBroadcastTag Dieser Wert ist in der Antwort der Methoden zum Auflisten von Live-Streaming-Übertragungen und zum Abrufen von Informationen zu einer Live-Streaming-Übertragung nicht enthalten.

Methoden

Name Beschreibung
stop(callback) Beendet die Live-Übertragung.

stop(callback)

Beendet die Live-Übertragung.

Die Aufzeichnung von Übertragungen wird automatisch nach 120 Minuten beendet oder sobald alle Teilnehmer die Verbindung zur übertragenen Sitzung getrennt haben.

Parameter:
Name Typ Beschreibung
callback Funktion Die Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. Der Funktion werden zwei Argumente übergeben: - error — Ein Fehlerobjekt (falls der Aufruf der Methode fehlschlägt). - broadcast — Das Broadcast-Objekt.