Un objeto que representa una retransmisión en directo de OpenTok.

No llames al new() constructor. Para iniciar una retransmisión en directo, llama a la función OpenTok.startBroadcast() método.

Características:
Nombre Tipo Descripción
id Cadena El identificador de emisión.
sessionId Cadena El identificador de la sesión de OpenTok asociada a esta retransmisión.
projectId Cadena La clave API asociada a la retransmisión.
createdAt Numbers La hora en la que se creó la emisión, en milisegundos desde la época UNIX.
resolution Cadena La resolución de la emisión: una de las siguientes: - «640x480» - «1280x720» - «1920x1080» - «480x640» - «720x1280» - «1080x1920» Es posible que desees utilizar una relación de aspecto vertical para las retransmisiones que incluyan secuencias de vídeo procedentes de dispositivos móviles (que suelen utilizar la relación de aspecto vertical). Esta propiedad es opcional.
broadcastUrls Objeto Un objeto que contiene información sobre las transmisiones HLS y RTMP. - hls (Cadena) — Si has especificado un punto final HLS, el objeto incluye una propiedad «hls», cuyo valor es la URL de la emisión HLS. Tenga en cuenta que esta URL de emisión HLS apunta a un archivo de índice, una lista de reproducción con formato .M3U8 que contiene una lista de URL a archivos de segmentos multimedia .ts (archivos de flujo de transporte MPEG-2). Aunque las URL tanto del archivo de índice de la lista de reproducción como de los archivos de segmentos multimedia se facilitan en cuanto se devuelve la respuesta HTTP, no se debe acceder a ellas hasta 15-20 segundos después, una vez iniciada la emisión HLS, debido al retraso entre la emisión HLS y las transmisiones en directo de la sesión de OpenTok. Véase https://developer.apple.com/library/ios/technotes/tn2288/\\_index.html Para obtener más información sobre el archivo de índice de la lista de reproducción y los archivos de segmentos multimedia para HLS. - hlsStatus (cadena) — Los estados posibles del campo «hlsStatus» son los siguientes: - «connecting»: el servidor de OpenTok está iniciando los transcodificadores. Este es el estado inicial - «ready»: el servidor de OpenTok se ha inicializado correctamente, pero la CDN no está reproduciendo el contenido multimedia - «en directo»: el servidor de OpenTok se ha inicializado correctamente y la CDN está reproduciendo el contenido multimedia - «finalizado»: la transmisión de origen ha finalizado (si el DVR está activado y se solicita contenido pregrabado, el estado pasará a «en directo») - «error»: se ha producido un error en la plataforma de OpenTok. - rtmp (Matriz de objetos) — Si has especificado puntos finales de transmisión RTMP, el objeto incluye una propiedad «rtmp». Se trata de una matriz de objetos que contiene información sobre cada una de las transmisiones RTMP. Cada uno de estos objetos tiene las siguientes propiedades: - id El ID que has asignado a la transmisión RTMP - serverUrl La URL del servidor - streamName El nombre del arroyo - status El estado del arroyo
maxDuration Numbers El tiempo máximo permitido para la retransmisión, en segundos. Transcurrido este tiempo, la retransmisión se detendrá automáticamente, si aún está en marcha.
streamMode Cadena El modo de transmisión de la emisión. Se puede configurar en una de las siguientes opciones: - «auto»: las transmisiones incluidas en la emisión se seleccionan automáticamente (opción predeterminada). - «manual»: especifica las transmisiones que se van a incluir mediante llamadas a la OpenTok.addBroadcastStream() y OpenTok.removeBroadcastStream() métodos.
streams Matriz Una matriz de objetos que corresponden a las transmisiones que se están emitiendo en ese momento. Solo se establece para una emisión cuyo estado sea «iniciada» y cuyo «streamMode» esté configurado en «manual». Cada objeto de la matriz incluye las siguientes propiedades: - streamId -- El ID de la transmisión incluida en la emisión. - hasAudio -- Si el audio de la transmisión se incluye en la emisión. - hasVideo -- Si el vídeo de la transmisión se incluye en la emisión.
multiBroadcastTag Cadena Configura este parámetro para permitir varias retransmisiones simultáneas de la misma sesión. Asigna una cadena única a cada retransmisión simultánea de una sesión en curso. Ten en cuenta que el multiBroadcastTag Este valor no se incluye en la respuesta de los métodos destinados a mostrar una lista de retransmisiones en directo y a obtener información sobre una retransmisión en directo.

Métodos

Nombre Descripción
stop(callback) Detiene la retransmisión en directo.

stop(callback)

Detiene la retransmisión en directo.

Las retransmisiones dejan de grabarse automáticamente tras 120 minutos o cuando todos los clientes se han desconectado de la sesión que se está retransmitiendo.

Parámetros:
Nombre Tipo Descripción
callback función La función que se debe llamar al finalizar la operación. Se pasan dos argumentos a la función: - error — Un objeto de error (si la llamada al método falla). - broadcast — El objeto «Broadcast».