Heredan de: : Object

Definido en: : lib/opentok/broadcast.rb

Visión general

Representa una retransmisión en directo de una sesión de OpenTok. Véase / Retransmisiones en directo.

Resumen de atributos de instancia

Resumen de los métodos de instancia

Manejo dinámico de métodos

Esta clase gestiona los métodos dinámicos a través del método `method_missing`.

#method_missing(método, *args, &block) ⇒ Objeto

Detalles de los atributos de la instancia

#URL de emisión ⇒ Hash

se define de la siguiente manera: Este objeto define los tipos de flujos de retransmisión que deseas iniciar (tanto HLS como RTMP). Puedes incluir HLS, RTMP o ambos como flujos de retransmisión. Si incluyes la retransmisión por RTMP, puedes especificar hasta cinco flujos RTMP de destino (o solo uno). El (:hls) se establece en un objeto [Hash] vacío. La URL HLS se devuelve en la respuesta. La propiedad «hlsStatus» se establece en uno de los siguientes valores:

- "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.

El (:rtmp) La propiedad está definida como un [Array] de propiedades Rtmp [Hash]. Para cada flujo RTMP, especifica (:serverUrl) para la URL del servidor RTMP, (:streamName) como el nombre de la retransmisión en directo de YouTube o la clave de retransmisión de Facebook), y (opcionalmente) (:id), un identificador único para el flujo.

Devoluciones:

  • (Hash) —

    el valor actual de broadcastUrls

#fecha_de_creación ⇒ int

La hora en la que se creó la emisión, en milisegundos desde la época UNIX.

Devoluciones:

  • (int) —

    el valor actual de «created_at»

#hasAudio ⇒ booleano

La emisión tiene el audio activado

Devoluciones:

  • (booleano) —

    el valor actual de hasAudio

#hasVideo ⇒ booleano

La emisión tiene la función de vídeo activada

Devoluciones:

  • (booleano) —

    el valor actual de hasVideo

#id ⇒ cadena

El identificador de emisión.

Devoluciones:

  • (cadena) —

    el valor actual de id

#maxBitRate ⇒ int

La velocidad de transmisión máxima de las señales de emisión, en bits por segundo.

Devoluciones:

  • (int) —

    el valor actual de maxBitRate

#multi_broadcast_tag ⇒ Objeto (solo lectura)

Devuelve el valor del atributo «multi_broadcast_tag».

#id_del_proyecto ⇒ cadena

La clave API asociada a la retransmisión.

Devoluciones:

  • (cadena) —

    el valor actual de «project_id»

#resolución ⇒ cadena

La resolución de la emisión: «640x480» (SD horizontal, la predeterminada), «1280x720» (HD horizontal), «1920x1080» (FHD horizontal), «480x640» (SD vertical), «720x1280» (HD vertical) o «1080x1920» (FHD vertical). Es posible que desees utilizar una relación de aspecto vertical para las retransmisiones que incluyan flujos de vídeo procedentes de dispositivos móviles (que suelen utilizar la relación de aspecto vertical). Esta propiedad es opcional.

Devoluciones:

  • (cadena) —

    el valor actual de la resolución

#session_id ⇒ cadena

El identificador de la sesión de OpenTok asociada a esta retransmisión.

Devoluciones:

  • (cadena) —

    el valor actual de session_id

#estado ⇒ cadena

El estado de la transmisión RTMP.

  • «Conectando»: la plataforma OpenTok está estableciendo la conexión con el servidor RTMP remoto.

    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).

  • «En directo: la plataforma OpenTok se ha conectado correctamente al servidor RTMP remoto y el contenido multimedia se está transmitiendo».

  • «sin conexión»: la plataforma OpenTok no ha podido conectarse al servidor RTMP remoto. Esto se debe a que el servidor no está accesible o a un error en el protocolo de establecimiento de conexión RTMP. Entre las causas se incluyen conexiones RTMP rechazadas, Applications RTMP inexistentes, nombres de transmisión rechazados, errores de autenticación, etc. Comprueba que el servidor esté en línea y que hayas introducido correctamente la URL del servidor y el nombre de la transmisión.

  • «error» – Se ha producido un error en la plataforma OpenTok.

Devoluciones:

  • (cadena) —

    el valor actual del estado

#streamMode ⇒ cadena

Si las transmisiones incluidas en la emisión se seleccionan automáticamente («auto», la opción predeterminada) o manualmente («manual»).

Devoluciones:

  • (cadena) —

    el valor actual de streamMode

#actualizado_el ⇒ int

En este método de inicio, esta marca de tiempo coincide con la marca de tiempo «createdAt».

Devoluciones:

  • (int) —

    el valor actual de «updated_at»

Detalles del método de instancia

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

Añade una transmisión a la emisión que se está realizando actualmente y que se inició con el parámetro `streamMode` establecido en «manual». Para obtener una descripción de esta función, consulta <https://tokbox.com/developer/rest/#selecting-broadcast-streams>.

Puedes llamar al método varias veces con `add_stream` establecido en el mismo ID de transmisión para activar o desactivar el audio o el vídeo de la transmisión. Si estableces tanto `has_audio` como `has_video` en «false», recibirás una respuesta de error.

Parámetros:

  • stream_id (Cadena) —

    El ID de la transmisión que se va a añadir a la emisión

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

    un conjunto de opciones personalizables

Hash de opciones (opts):

  • :has_audio (verdadero, falso)

    — por defecto: Booleano, opcional —

    — Si la retransmisión debe incluir el audio de la transmisión (verdadero, valor por defecto) o no (falso).

  • :has_video (verdadero, falso)

    — por defecto: Booleano, opcional —

    — Si la retransmisión debe incluir el vídeo de la transmisión (verdadero, valor por defecto) o no (falso).

Aumentos:

  • (OpenTokBroadcastError) —

    El parámetro «streamMode» de la retransmisión no está configurado en «manual».

#diseño(opts = {}) ⇒ Objeto

Establece el diseño de la retransmisión de OpenTok.

Puedes cambiar dinámicamente el tipo de diseño de una emisión mientras esta se está retransmitiendo. Para obtener más información, consulta Configuración del diseño de vídeo para las retransmisiones en directo de OpenTok.

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

Parámetros:

  • opciones (Hash) —

    un conjunto de opciones personalizables

Aumentos:

  • (OpenTokBroadcastError) —

    No se ha podido actualizar la configuración de la emisión.

  • (OpenTokAuthenticationError) —

    Error de autenticación. Clave o secreto de API no válido.

  • (OpenTokError) —

    Error del servidor de OpenTok.

  • (ArgumentError) —

    El parámetro «broadcast_id» u «options» está vacío.

  • (ArgumentError) —

    Se ha especificado el tipo «personalizado» sin ninguna opción de hoja de estilo.

  • (ArgumentError) —

    Se ha pasado una hoja de estilo para un tipo distinto de «custom». O bien se ha pasado un tipo no válido.

  • (ArgumentError) —

    Se ha introducido un tipo de diseño no válido.

#eliminar_flujo(stream_id) ⇒ Objeto

Elimina una transmisión de la emisión que se está realizando actualmente y que se inició con el parámetro `streamMode` establecido en «manual». Para obtener una descripción de esta función, consulta <https://tokbox.com/developer/rest/#selecting-broadcast-streams>.

Parámetros:

  • stream_id (Cadena) —

    El ID de la transmisión que se va a eliminar de la emisión

Aumentos:

  • (OpenTokBroadcastError) —

    El parámetro «streamMode» de la retransmisión no está configurado en «manual».

#stop ⇒ Objeto

Detiene la retransmisión de OpenTok.

#to_json ⇒ Objeto

Una representación en forma de cadena codificada en JSON de la emisión.