Sendung

Stellt eine Übertragung einer OpenTok-Sitzung dar.

Inhaltsverzeichnis

$broadcastUrls  : Objekt

$createdAt  : int

$id  : Zeichenfolge

$isDvr  : bool

$isHls  : bool

$isLowLatency  : bool

$isStopped  : bool

$maxBitRate  : Zeichenfolge

$multiBroadcastTag  : Zeichenfolge

$partnerId  : Zeichenfolge

$resolution  : Zeichenfolge

$sessionId  : Zeichenfolge

$status  : Zeichenfolge

$streamMode  : Zeichenfolge

$updatedAt  : int

__construct()  : gemischt

addStreamToBroadcast()  : bool : Fügt einen Stream zu einer aktuell laufenden Übertragung hinzu, die mit dem StreamMode „StreamMode.Manual“ gestartet wurde. Sie können die Methode wiederholt mit derselben Stream-ID aufrufen, um die Audio- oder Videoübertragung des Streams in der Sendung ein- bzw. auszuschalten.

jsonSerialize()  : gemischt

removeStreamFromBroadcast()  : bool : Entfernt einen Stream aus einer aktuell laufenden Übertragung, die mit dem StreamMode „StreamMode.Manual“ gestartet wurde.

stop()  : gemischt : Beendet die Übertragung.

updateLayout()  : gemischt : Aktualisiert das Layout der Sendung.

Eigenschaften

$broadcastUrls

public object $broadcastUrls

Details zu den HLS- und RTMP-Übertragungsströmen. Für einen HLS-Stream wird die URL angegeben. Siehe die OpenTok-Entwicklerhandbuch für Live-Streaming Weitere Informationen zur Verwendung dieser URL finden Sie hier. Für jeden RTMP-Stream werden die RTMP-Server-URL und der Stream-Name sowie der Status des RTMP-Streams angegeben.

$createdAt

public int $createdAt

Der Zeitstempel zum Zeitpunkt der Erstellung der Übertragung, ausgedrückt in Sekunden seit der Unix-Epoche.

$id

public string $id

Die eindeutige ID für die Übertragung.

$isDvr

public bool $isDvr

Ob die Übertragung die DVR-Funktionalität für den HLS-Stream unterstützt.

$isHls

public bool $isHls

Ob die Übertragung HLS unterstützt.

$isLowLatency

public bool $isLowLatency

Ob die Übertragung den Modus mit geringer Latenz für den HLS-Stream unterstützt.

$isStopped

public bool $isStopped

Ob die Übertragung beendet ist (true) oder noch läuft (false).

$maxBitRate

public string $maxBitRate

Maximal zulässige Bitrate für die Übertragung. Muss zwischen 400.000 und 2.000.000 liegen.

$multiBroadcastTag

public string $multiBroadcastTag

Ob „Multiple Broadcast“ aktiviert ist; dabei handelt es sich um eine eindeutige Zeichenfolge für jede gleichzeitige Übertragung einer laufenden Sitzung. Siehe https://tokbox.com/developer/guides/archiving/#simultaneous-archives für weitere Informationen.

$partnerId

public string $partnerId

Ihr OpenTok-API-Schlüssel.

$resolution

public string $resolution

Die Auflösung des Archivs beträgt 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 Archive, die Videostreams von Mobilgeräten enthalten (die häufig das Hochformat verwenden), empfiehlt sich die Verwendung des Hochformats.

$sessionId

public string $sessionId

Die OpenTok-Sitzungs-ID.

$status

public string $status

Übertragungsstatus. Entweder started oder stopped

$streamMode

public string $streamMode

Ob die in der Übertragung enthaltenen Streams automatisch ausgewählt werden (StreamMode.AUTO) oder manuell (StreamMode.MANUAL). Wenn Streams automatisch ausgewählt werden (StreamMode.AUTO), können alle Streams der Sitzung in die Übertragung einbezogen werden. Wenn Streams manuell ausgewählt werden (StreamMode.MANUAL), geben Sie die einzubindenden Streams anhand von Aufrufen der Broadcast.addStreamToBroadcast() und Broadcast.removeStreamFromBroadcast() Methoden. Im manuellen Modus können Sie festlegen, ob Audio, Video oder beides eines Streams in die Übertragung einbezogen werden soll. Sowohl im automatischen als auch im manuellen Modus bezieht der Übertragungs-Composer Streams auf der Grundlage von Stream Priorisierungsregeln.

$updatedAt

public int $updatedAt

Der Zeitpunkt, zu dem die Übertragung gestartet oder beendet wurde, ausgedrückt in Sekunden seit der Unix-Epoche.

Methoden

__construct()

public __construct(mixed $broadcastData[, mixed $options = array() ]) : mixed

Parameter

$broadcastData : mixed

$options : mixed = array()

Rückgabewerte

gemischt —

addStreamToBroadcast()

Fügt einen Stream zu einer aktuell laufenden Übertragung hinzu, die mit der Einstellung „streamMode“ auf „StreamMode.Manual“ gestartet wurde. Sie können die Methode wiederholt mit derselben Stream-ID aufrufen, um die Audio- oder Videoübertragung des Streams in der Sendung umzuschalten.

public addStreamToBroadcast(string $streamId, bool $hasAudio, bool $hasVideo) : bool

Parameter

$streamId : string : Die Stream-ID.

$hasAudio : bool : Gibt an, ob die Übertragung den Ton des Streams enthalten soll (true, Standard) oder nicht (false).

$hasVideo : bool : Gibt an, ob die Übertragung das Video des Streams enthalten soll (true, Standard) oder nicht (false).

Rückgabewerte

bool —

Gibt bei Erfolg „true“ zurück.

jsonSerialize()

public jsonSerialize() : mixed

Rückgabewerte

gemischt —

removeStreamFromBroadcast()

Entfernt einen Stream aus einer aktuell laufenden Übertragung, die mit dem StreamMode „StreamMode.Manual“ gestartet wurde.

public removeStreamFromBroadcast(string $streamId) : bool

Parameter

$streamId : string : Die Stream-ID.

Rückgabewerte

bool —

Gibt bei Erfolg „true“ zurück.

stop()

Beendet die Übertragung.

public stop() : mixed

Rückgabewerte

gemischt —

updateLayout()

Aktualisiert das Layout der Sendung.

public updateLayout(Layout $layout) : mixed

Siehe Konfigurieren des Video-Layouts für OpenTok-Live-Streaming-Übertragungen.

Parameter

$layout : Layout : Ein Objekt, das den Layout-Typ für die Sendung definiert.

Rückgabewerte

gemischt —