Erbt von: : Object

Definiert in: : lib/opentok/renders.rb

Übersicht

Eine Klasse zur Arbeit mit Renderings aus dem OpenTok Experience Composer. Siehe / Experience Composer.

Zusammenfassung der Instanzmethoden

Details zur Instanzmethode

#finden(render_id) ⇒ Rendering

Ruft ein Render-Objekt für die angegebene Render-ID ab.

Parameter:

  • render_id (Zeichenkette) —

    (Erforderlich) Die Render-ID.

Rückgabe:

  • (Rendering) —

    Das Render-Objekt, das Eigenschaften enthält, die das Rendering definieren.

Erhöht:

#Liste(options = {}) ⇒ RenderList

Gibt eine „RenderList“ zurück, bei der es sich um ein Array von Renderings aus dem Experience Composer handelt, die einem Projekt zugeordnet sind.

Parameter:

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

    Ein Hash mit Schlüsseln, die festlegen, welcher Bereich der Renderings abgerufen werden soll.

Options-Hash (options):

  • :offset (Ganzzahl)

    — Standard: Optional —

    . Der Start-Offset für die Liste der vom Experience Composer gerenderten Elemente. Der Standardwert ist 0.

  • :count (Ganzzahl)

    -

    Optional. Die Anzahl der Experience Composer-Renderings, die ab dem angegebenen Offset abgerufen werden sollen. Der Standardwert beträgt 50, der Höchstwert 1000.

Rückgabe:

  • (RenderList) —

    Ein „RenderList“-Objekt, bei dem es sich um ein Array von „Render“-Objekten handelt.

Erhöht:

  • (ArgumentError)

#Start(session_id, options = {}) ⇒ Rendering

Startet einen Experience Composer-Render für eine OpenTok-Sitzung.

Parameter:

  • session_id (Zeichenkette) —

    (Erforderlich) Die Sitzungs-ID der OpenTok-Sitzung, in die der Stream aus dem Experience Composer eingebunden wird.

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

    (Erforderlich) Ein Hash, der die Optionen für die Darstellung definiert.

Options-Hash (options):

  • :token (Zeichenkette)

    — Standard: Erforderlich —

    Ein gültiges OpenTok-Token mit der Rolle „Publisher“ und (optional) Verbindungsdaten, die dem Ausgabestream zugeordnet werden sollen.

  • :url (Zeichenkette)

    — Standard: Erforderlich —

    Eine öffentlich zugängliche URL, die vom Kunden verwaltet wird und die den darzustellenden Inhalt ohne Benutzereingriff generieren kann. Die Mindestlänge der URL beträgt 15 Zeichen, die Höchstlänge 2048 Zeichen.

  • :max_duration (Ganzzahl)

    — Standard: Optional —

    Die maximal zulässige Laufzeit des Experience Composers in Sekunden. Nach Ablauf dieser Zeit wird er automatisch beendet, sofern er noch läuft. Der Maximalwert beträgt 36000 (10 Stunden), der Minimalwert 60 (1 Minute) und der Standardwert 7200 (2 Stunden). Wenn der Experience Composer beendet wird, wird sein Stream deaktiviert und ein Ereignis an die Callback-URL gesendet, sofern diese im Account-Portal konfiguriert wurde.

  • :Auflösung (Zeichenkette)

    -

    Die Auflösung des Experience Composer beträgt entweder „640x480“ (SD im Querformat), „480x640“ (SD im Hochformat), „1280x720“ (HD im Querformat), „720x1280“ (HD-Hochformat), „1920x1080“ (FHD-Querformat) oder „1080x1920“ (FHD-Hochformat). Standardmäßig ist diese Auflösung auf „1280x720“ (HD-Querformat, Standard) eingestellt.

  • :Eigenschaften (Hash)

    — Standard: Optional —

    Die anfängliche Konfiguration der Publisher-Eigenschaften für den zusammengesetzten Ausgabestrom. Das Eigenschaftenobjekt enthält den Schlüssel :name (Zeichenkette), die als Name des zusammengesetzten Ausgabestroms dient, der an die Sitzung veröffentlicht wird. Der Name muss mindestens 1 und höchstens 200 Zeichen lang sein.

Rückgabe:

  • (Rendering) —

    Das Render-Objekt, das Eigenschaften enthält, die das Rendering definieren, einschließlich der Render-ID.

Erhöht:

#stoppen(render_id) ⇒ Rendering

Beendet die Darstellung eines OpenTok Experience Composer.

Parameter:

  • render_id (Zeichenkette) —

    (Erforderlich) Die Render-ID.

Rückgabe:

  • (Rendering) —

    Das Render-Objekt, das Eigenschaften enthält, die das Rendering definieren.

Erhöht: