Heredan de: : Object

Definido en: : lib/opentok/session.rb

Visión general

Representa una sesión de OpenTok.

Utiliza el método OpenTok.createSession() para crear una sesión de OpenTok. Utiliza la propiedad session_id del objeto Session para obtener el ID de la sesión.

Resumen de atributos de instancia

Resumen de los métodos de instancia

Detalles de los atributos de la instancia

#:resolución_del_archivo ⇒ Cadena (solo lectura)

La resolución de los archivos en una sesión con archivado automático.

Devoluciones:

  • (Cadena) —

    el valor actual de :archive_resolution

#archive_mode ⇒ Cadena (solo lectura)

Si la sesión se archivará automáticamente (:always) o no (:manual).

Devoluciones:

  • (Cadena) —

    el valor actual de «archive_mode»

#nombre_del_archivo ⇒ Cadena (solo lectura)

El nombre que se debe utilizar para los archivos en las sesiones con archivado automático.

Devoluciones:

  • (Cadena) —

    el valor actual de «archive_name»

#resolución del archivo ⇒ Objeto (solo lectura)

Devuelve el valor del atributo «archive_resolution».

#e2ee ⇒ Objeto (solo lectura)

Devuelve el valor del atributo e2ee.

#ubicación ⇒ Cadena (solo lectura)

La dirección IP de referencia de ubicación. Consulta el método OpenTok.createSession().

Devoluciones:

  • (Cadena) —

    el valor actual de la ubicación

#media_mode ⇒ Cadena (solo lectura)

Establece el valor en :routed si la sesión utiliza el OpenTok Media Router, o en :relayed si la sesión intenta transmitir flujos directamente entre clientes.

Devoluciones:

  • (Cadena) —

    el valor actual de «media_mode»

#session_id ⇒ Cadena (solo lectura)

El identificador de sesión.

Devoluciones:

  • (Cadena) —

    el valor actual de session_id

Detalles del método de instancia

#generar_token(opciones) ⇒ cadena

Genera un token.

Parámetros:

  • opciones (Hash)

Hash de opciones (options):

  • :token_type (Cadena)

    -

    El tipo de token que se va a generar. Debe ser «T1» o «JWT». El valor predeterminado es «JWT».

  • :rol (Símbolo)

    -

    La función del token. Establece este valor en uno de los siguientes:

    • :subscriber – Un suscriptor solo puede suscribirse a transmisiones.
    • :publisher – Un editor puede publicar transmisiones, suscribirse a ellas y enviar señales. (Este es el valor predeterminado si no se especifica ningún rol.)
    • :publisheronly – Un cliente conectado con un token exclusivo para editores puede publicar transmisiones, pero no puede suscribirse a ellas.
    • :moderator – Además de los privilegios concedidos a un editor, un moderador puede llevar a cabo funciones de moderación, como obligar a los clientes a desconectarse, detener la publicación de transmisiones o silenciar el audio en las transmisiones publicadas. Consulta la / Guía para desarrolladores sobre moderación.

  • :expire_time (entero)

    -

    El tiempo de caducidad, en segundos desde la época UNIX. Introduce 0 para utilizar el tiempo de caducidad predeterminado de 24 horas tras la hora de creación del token. El tiempo máximo de caducidad es de 30 días tras la hora de creación.

  • :data (Cadena)

    -

    Una cadena que contiene metadatos de conexión que describen al usuario final. Por ejemplo, puedes introducir el ID de usuario, el nombre u otros datos que describan al usuario final. La longitud de la cadena está limitada a 1.000 caracteres. Estos datos no se pueden actualizar una vez establecidos.

  • :initial_layout_class_list (Matriz)

    -

    Una matriz de nombres de clases (cadenas de caracteres) que se utilizarán como clases de diseño iniciales para las transmisiones publicadas por el cliente. Las clases de diseño se utilizan para personalizar el diseño de los vídeos en / retransmisiones en directo y archivos organizados.

Devoluciones:

  • (Cadena) —

    La cadena del token.