Heredan de: : Object

Definido en: : lib/opentok/renders.rb

Visión general

Una clase para trabajar con las representaciones de OpenTok Experience Composer. Véase / Experience Composer.

Resumen de los métodos de instancia

Detalles del método de instancia

#encontrar(render_id) ⇒ Render

Obtiene un objeto «Render» para el ID de renderizado indicado.

Parámetros:

  • render_id (Cadena) —

    (Obligatorio) El ID de la representación.

Devoluciones:

  • (Render) —

    El objeto de renderizado, que incluye las propiedades que definen el renderizado.

Aumentos:

#lista(options = {}) ⇒ RenderList

Devuelve un RenderList, que es una matriz de representaciones de Experience Composers asociadas a un proyecto.

Parámetros:

  • opciones (Hash) (valor por defecto: {}) —

    Un hash con claves que definen qué rango de representaciones se deben recuperar.

Hash de opciones (options):

  • :offset (entero)

    — por defecto: Opcional —

    . El desplazamiento inicial de la lista de representaciones de Experience Composer. El valor por defecto es 0.

  • :count (entero)

    -

    Opcional. El número de representaciones de Experience Composer que se van a recuperar a partir del desplazamiento indicado. El valor por defecto es 50 y el máximo es 1000.

Devoluciones:

  • (RenderList) —

    Un objeto `RenderList`, que es una matriz de objetos `Render`.

Aumentos:

  • (ArgumentError)

#iniciar(session_id, options = {}) ⇒ Render

Inicia un renderizado de Experience Composer para una sesión de OpenTok.

Parámetros:

  • session_id (Cadena) —

    (Obligatorio) El ID de la sesión de OpenTok que incluirá la transmisión de Experience Composer.

  • opciones (Hash) (valor por defecto: {}) —

    (Obligatorio) Un hash que defina las opciones para la representación.

Hash de opciones (options):

  • :token (Cadena)

    — por defecto: Obligatorio —

    Un token válido de OpenTok con el rol de «Publisher» y (opcionalmente) los datos de conexión que se asociarán a la transmisión de salida.

  • :url (cadena de caracteres)

    — por defecto: Obligatorio —

    Una URL accesible públicamente, controlada por el cliente y capaz de generar el contenido que se va a mostrar sin intervención del usuario. La longitud mínima de la URL es de 15 caracteres y la máxima, de 2048 caracteres.

  • :max_duration (Número entero)

    — por defecto: Opcional —

    El tiempo máximo permitido para el Experience Composer, en segundos. Transcurrido este tiempo, se detendrá automáticamente si aún se está ejecutando. El valor máximo es 36 000 (10 horas), el mínimo es 60 (1 minuto) y el valor predeterminado es 7 200 (2 horas). Cuando el Experience Composer finaliza, su transmisión se retira de la publicación y se envía un evento a la URL de devolución de llamada, si se ha configurado en el Portal de la cuenta.

  • :resolución (Cadena)

    -

    La resolución del Experience Composer puede ser «640x480» (SD horizontal), «480x640» (SD vertical), «1280x720» (HD horizontal), «720x1280» (HD vertical), «1920x1080» (FHD horizontal) o «1080x1920» (FHD vertical). Por defecto, esta resolución es «1280x720» (HD horizontal, la predeterminada).

  • :propiedades (Hash)

    — por defecto: Opcional —

    La configuración inicial de las propiedades de Publisher para el flujo de salida compuesto. El objeto de propiedades contiene la clave :name (Cadena) que sirve como nombre del flujo de salida compuesto que se publica en la sesión. El nombre debe tener una longitud mínima de 1 y una máxima de 200.

Devoluciones:

  • (Render) —

    El objeto de renderizado, que incluye propiedades que definen el renderizado, entre ellas el identificador del renderizado.

Aumentos:

#stop(render_id) ⇒ Render

Detiene el renderizado de OpenTok Experience Composer.

Parámetros:

  • render_id (Cadena) —

    (Obligatorio) El ID de la representación.

Devoluciones:

  • (Render) —

    El objeto de renderizado, que incluye las propiedades que definen el renderizado.

Aumentos: