Erbt von: : Object

Definiert in: : lib/opentok/broadcast.rb

Übersicht

Bezeichnet eine Live-Streaming-Übertragung einer OpenTok-Sitzung. Siehe / Live-Streaming-Übertragungen.

Übersicht über Instanzattribute

Zusammenfassung der Instanzmethoden

Dynamische Methodenbehandlung

Diese Klasse verarbeitet dynamische Methoden mithilfe der Methode `method_missing`.

#method_missing(Methode, *args, &block) ⇒ Objekt

Details zu Instanzattributen

#broadcastUrls ⇒ Hash

ist wie folgt definiert: Dieses Objekt definiert die Arten von Broadcast-Streams, die Sie starten möchten (sowohl HLS als auch RTMP). Sie können HLS, RTMP oder beides als Broadcast-Streams einbinden. Wenn Sie RTMP-Streaming einbinden, können Sie bis zu fünf Ziel-RTMP-Streams (oder auch nur einen) angeben. Das (:hls) wird auf ein leeres [Hash]-Objekt gesetzt. Die HLS-URL wird in der Antwort zurückgegeben. Die Eigenschaft „hlsStatus“ wird auf einen der folgenden Werte gesetzt:

- "connecting" — The OpenTok server is in the process of starting transcoders. This is the initial state.
- "ready" — The OpenTok server has succesfully initialized but the CDN is not consuming media.
- "live" — The OpenTok server has succesfully initialized and the CDN is consuming media.
- "ended" — The source stream has ended. If DVR is enabled and pre-recorded media is requested, then the status will transition to "live".
- "error" — There is an error in the OpenTok platform.

Die (:rtmp) Die Eigenschaft ist auf ein [Array] von Rtmp-[Hash]-Eigenschaften gesetzt. Geben Sie für jeden RTMP-Stream Folgendes an: (:serverUrl) für die RTMP-Server-URL, (:streamName) wie beispielsweise den Namen des YouTube-Live-Streams oder den Facebook-Stream-Schlüssel) sowie (optional) (:id), eine eindeutige ID für den Stream.

Rückgabe:

  • (Hash) —

    der aktuelle Wert von „broadcastUrls“

#created_at ⇒ int

Der Zeitpunkt, zu dem die Sendung erstellt wurde, in Millisekunden seit der UNIX-Epoche.

Rückgabe:

  • (int) —

    der aktuelle Wert von „created_at“

#hasAudio ⇒ boolesch

Die Sendung ist mit Ton ausgestattet

Rückgabe:

  • (bool) —

    der aktuelle Wert von hasAudio

#hasVideo ⇒ boolesch

Die Sendung ist mit Video ausgestattet

Rückgabe:

  • (bool) —

    der aktuelle Wert von hasVideo

#id ⇒ Zeichenkette

Die Sendungs-ID.

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert von id

#maxBitRate ⇒ int

Die maximale Bitrate für den/die Übertragungsstrom(e) in Bit pro Sekunde.

Rückgabe:

  • (int) —

    der aktuelle Wert von maxBitRate

#multi_broadcast_tag ⇒ Objekt (schreibgeschützt)

Gibt den Wert des Attributs „multi_broadcast_tag“ zurück.

#Projekt-ID ⇒ Zeichenkette

Der mit der Übertragung verknüpfte API-Schlüssel.

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert von „project_id“

#Entschließung ⇒ Zeichenkette

Die Auflösung der Übertragung: entweder „640x480“ (SD im Querformat, Standardeinstellung), „1280x720“ (HD im Querformat), „1920x1080“ (FHD Querformat), „480x640“ (SD Hochformat), „720x1280“ (HD Hochformat) oder „1080x1920“ (FHD Hochformat). Für Übertragungen, die Videostreams von Mobilgeräten enthalten (die häufig das Hochformat verwenden), empfiehlt sich die Verwendung des Hochformats. Diese Eigenschaft ist optional.

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert der Auflösung

#session_id ⇒ Zeichenkette

Die Sitzungs-ID der OpenTok-Sitzung, die mit dieser Übertragung verknüpft ist.

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert von session_id

#Status ⇒ Zeichenkette

Der Status des RTMP-Streams.

  • „Verbindung wird hergestellt“ – Die OpenTok-Plattform stellt gerade eine Verbindung zum entfernten RTMP-Server her.

    This is the initial state, and it is the status if you start when there are no streams published in the session.
It changes to "live" when there are streams (or it changes to one of the other states).

  • „live – Die OpenTok-Plattform hat erfolgreich eine Verbindung zum externen RTMP-Server hergestellt, und die Medien werden gestreamt.

  • „offline“ – Die OpenTok-Plattform konnte keine Verbindung zum entfernten RTMP-Server herstellen. Dies liegt an einem nicht erreichbaren Server oder einem Fehler beim RTMP-Handshake. Mögliche Ursachen sind abgelehnte RTMP-Verbindungen, nicht vorhandene RTMP-Applications, abgelehnte Stream-Namen, Authentifizierungsfehler usw. Überprüfen Sie, ob der Server online ist und ob Sie die richtige Server-URL und den richtigen Stream-Namen angegeben haben.

  • „Fehler“ – Auf der OpenTok-Plattform ist ein Fehler aufgetreten.

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert des Status

#streamMode ⇒ Zeichenkette

Ob die in der Übertragung enthaltenen Streams automatisch („auto“, Standardeinstellung) oder manuell („manual“) ausgewählt werden.

Rückgabe:

  • (Zeichenkette) —

    der aktuelle Wert von streamMode

#aktualisiert_am ⇒ int

Bei dieser Startmethode stimmt dieser Zeitstempel mit dem „createdAt“-Zeitstempel überein.

Rückgabe:

  • (int) —

    der aktuelle Wert von „updated_at“

Details zur Instanzmethode

#add_stream(stream_id, opts = {}) ⇒ Objekt

Fügt der aktuell laufenden Übertragung einen Stream hinzu, der mit der Einstellung „manual“ für den StreamMode gestartet wurde. Eine Beschreibung dieser Funktion finden Sie unter <https://tokbox.com/developer/rest/#selecting-broadcast-streams>.

Sie können die Methode wiederholt aufrufen, wobei Sie für „add_stream“ dieselbe Stream-ID angeben, um den Audio- oder Videostream in der Übertragung ein- bzw. auszuschalten. Wenn Sie sowohl „has_audio“ als auch „has_video“ auf „false“ setzen, erhalten Sie eine Fehlermeldung.

Parameter:

  • stream_id (Zeichenkette) —

    Die ID des Streams, der zur Übertragung hinzugefügt werden soll

  • opts (Hash) (Standardwert: {}) —

    eine individuell anpassbare Auswahl an Optionen

Options-Hash (opts):

  • :has_audio (true, false)

    — Standard: Boolescher Wert, optional —

    — Ob die Übertragung den Ton des Streams enthalten soll (true, Standardeinstellung) oder nicht (false).

  • :has_video (true, false)

    — Standard: Boolescher Wert, optional —

    — Ob die Übertragung das Video des Streams enthalten soll (true, Standardeinstellung) oder nicht (false).

Erhöht:

  • (OpenTokBroadcastError) —

    Der „streamMode“ für die Übertragung ist nicht auf „manual“ eingestellt.

#Layout(opts = {}) ⇒ Objekt

Legt das Layout der OpenTok-Übertragung fest.

Sie können den Layouttyp einer Sendung während der Ausstrahlung dynamisch ändern. Weitere Informationen finden Sie unter Konfiguration des Video-Layouts für OpenTok-Live-Streaming-Übertragungen.

Siehe <https://tokbox.com/developer/rest/#change_composed_archive_layout>

Parameter:

  • Optionen (Hash) —

    eine individuell anpassbare Auswahl an Optionen

Erhöht:

  • (OpenTokBroadcastError) —

    Das Sendeformat konnte nicht aktualisiert werden.

  • (OpenTokAuthenticationError) —

    Die Authentifizierung ist fehlgeschlagen. Ungültiger API-Schlüssel oder ungültiges API-Geheimnis.

  • (OpenTok-Fehler) —

    OpenTok-Serverfehler.

  • (ArgumentError) —

    Der Parameter „broadcast_id“ oder „options“ ist leer.

  • (ArgumentError) —

    Der Typ „custom“ wurde ohne Stylesheet-Option angegeben.

  • (ArgumentError) —

    Es wurde ein Stylesheet für einen anderen Typ als „custom“ übergeben. Oder es wurde ein ungültiger Typ übergeben.

  • (ArgumentError) —

    Es wurde ein ungültiger Layouttyp übergeben.

#remove_stream(stream_id) ⇒ Objekt

Entfernt einen Stream aus der aktuell laufenden Übertragung, der mit der Einstellung „manual“ für den StreamMode gestartet wurde. Eine Beschreibung dieser Funktion finden Sie unter <https://tokbox.com/developer/rest/#selecting-broadcast-streams>.

Parameter:

  • stream_id (Zeichenkette) —

    Die ID des Streams, der aus der Übertragung entfernt werden soll

Erhöht:

  • (OpenTokBroadcastError) —

    Der „streamMode“ für die Übertragung ist nicht auf „manual“ eingestellt.

#stoppen ⇒ Objekt

Beendet die OpenTok-Übertragung.

#to_json ⇒ Objekt

Eine JSON-kodierte Zeichenfolgenrepräsentation der Sendung.