Heredan de: : Object

Definido en: : lib/opentok/streams.rb

Visión general

Una clase para trabajar con transmisiones de OpenTok. Incluye métodos para obtener información sobre las transmisiones de OpenTok, para establecer clases de diseño para las transmisiones y para silenciar las transmisiones.

Resumen de los métodos de instancia

Detalles del método de instancia

#todos(session_id) ⇒ Lista de reproducción

Utiliza este método para obtener información sobre todas las transmisiones de OpenTok de una sesión.

Por ejemplo, puedes llamar a este método para obtener información sobre las clases de diseño que utilizan las transmisiones de OpenTok. Las clases de diseño definen cómo se muestra la transmisión en el diseño de una emisión en directo o de un archivo montado. Para obtener más información, consulta Asignación de clases de diseño a las transmisiones en las retransmisiones en directo y Personalización del diseño de vídeo para los archivos compuestos.

Parámetros:

  • session_id (Cadena) —

    El identificador de la sesión de OpenTok.

Devoluciones:

Aumentos:

  • (ArgumentError) —

    El «stream_id» o el «session_id» no es válido.

  • (OpenTokAuthenticationError) —

    No tienes autorización para recuperar la información de la transmisión. Comprueba tus credenciales de autenticación.

  • (OpenTokError) —

    Un error del servidor OpenTok.

#desactivar_silenciamiento_forzado(session_id) ⇒ Objeto

Desactiva el estado de silencio activo de la sesión. Una vez que se llame a este método, las nuevas transmisiones publicadas en la sesión ya no tendrán el audio silenciado.

Una vez que hayas llamado al método `force_mute_all()`, todas las transmisiones publicadas tras dicha llamada se publicarán con el audio silenciado. Llama al método `disable_force_mute()` para eliminar el estado de silencio de una sesión, de modo que las nuevas transmisiones publicadas no se silencien automáticamente.

Parámetros:

  • session_id (Cadena) —

    El identificador de sesión.

#encontrar(session_id, stream_id) ⇒ Transmisión

Utiliza este método para obtener información sobre una transmisión de OpenTok.

Por ejemplo, puedes llamar a este método para obtener información sobre las clases de diseño utilizadas por una transmisión de OpenTok. Las clases de diseño definen cómo se muestra la transmisión en el diseño de una transmisión en directo. Para obtener más información, consulta Asignación de clases de diseño a las transmisiones en las retransmisiones en directo y Personalización del diseño de vídeo para los archivos compuestos.

Parámetros:

  • session_id (Cadena) —

    El identificador de la sesión de OpenTok.

  • stream_id (Cadena) —

    El identificador de la transmisión dentro de la sesión.

Devoluciones:

Aumentos:

  • (ArgumentError) —

    El «stream_id» o el «session_id» no es válido.

  • (OpenTokAuthenticationError) —

    No tienes autorización para recuperar la información de la transmisión. Comprueba tus credenciales de autenticación.

  • (OpenTokError) —

    Un error del servidor OpenTok.

#force_mute(session_id, stream_id) ⇒ Objeto

Forzar que una transmisión concreta conectada a una sesión de OpenTok se silencie automáticamente.

Parámetros:

  • session_id (Cadena) —

    El identificador de la sesión de OpenTok.

  • stream_id (Cadena) —

    El identificador de la transmisión de la sesión.

#force_mute_all(session_id, opts = {}) ⇒ Objeto

Forzar a todas las transmisiones conectadas a una sesión de OpenTok (excepto a una lista opcional de transmisiones) a silenciar el audio publicado.

Además de las transmisiones existentes, cualquier transmisión que se publique tras llamar a este método se publicará con el audio silenciado. Puedes desactivar el estado de silencio de una sesión llamando al método disable_force_mute().

Esta propiedad es opcional. Si no se especifica, se silenciará todas las transmisiones de la sesión.

Parámetros:

  • session_id (Cadena) —

    El identificador de sesión.

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

    Un hash opcional que define las opciones para la acción de silenciamiento. Por ejemplo:

    "excluded_streams" => [
  "excludedStreamId1",
  "excludedStreamId2"
]

Hash de opciones (opts):

  • :excluded_streams (Matriz)

    -

    Los identificadores de las transmisiones que no deben silenciarse.

#diseño(session_id, opts) ⇒ Objeto

Utiliza este método para configurar el diseño de una transmisión de OpenTok compuesta (de archivo o en directo).

Por ejemplo, puedes llamar a este método para configurar las clases de diseño de una transmisión de OpenTok. Las clases de diseño definen cómo se muestra la transmisión en el diseño de una emisión en directo o de un archivo montado. Para obtener más información, consulta Asignación de clases de diseño a las transmisiones en las retransmisiones en directo y Personalización del diseño de vídeo para los archivos compuestos.

Para obtener más información, consulta «Diseño»<https://tokbox.com/developer/rest/#change-stream-layout-classes-composed>

Parámetros:

  • session_id (Cadena) —

    El identificador de la sesión de OpenTok.

  • opts (Hash) —

    Un hash con una clave items y un valor en forma de matriz de objetos que contiene stream_id y layoutClassList propiedades.

Aumentos:

  • (ArgumentError) —

    El «session_id» no es válido.

  • (OpenTokAuthenticationError) —

    No tienes autorización para recuperar la información de la transmisión. Comprueba tus credenciales de autenticación.

  • (OpenTokStreamLayoutError) —

    No se ha podido realizar la operación de maquetación debido a valores de maquetación incorrectos.

  • (OpenTokError) —

    Un error del servidor OpenTok.