OTSession
El primer paso para utilizar el SDK de OpenTok para iOS es inicializar un OTSession objeto con tu clave de API y una ID de sesión Utiliza el OTSession objeto para conectarte a OpenTok utilizando tu cuenta de desarrollador Clave API y una ficha.
Propiedades
sessionConnectionStatus
Tipo: OTSessionConnectionStatus
El estado de esto OTSession instancia. Útil para consultas puntuales sobre el estado de la sesión.
Los valores válidos se definen en OTSessionConnectionStatus:
OTSessionConnectionStatusNotConnected- La sesión no está conectada.OTSessionConnectionStatusConnected- La sesión está conectada.OTSessionConnectionStatusConnecting- La sesión se está conectando.OTSessionConnectionStatusDisconnecting- La sesión se está desconectando.OTSessionConnectionStatusFailed- Se ha producido un error grave en la sesión
Al crear una instancia, se espera que el sessionConnectionStatus tener el valor OTSessionConnectionStatusNotConnected.
Puedes utilizar un observador de clave-valor para supervisar esta propiedad. Sin embargo, el [OTSessionDelegate sessionDidConnect:] y [OTSessionDelegate Los mensajes [sessionDidDisconnect:] se envían al delegado de la sesión cuando esta se conecta y se desconecta.
sessionId
Tipo: NSString *
El ID de sesión de esta instancia. Se trata de un valor inmutable.
streams
Tipo: NSDictionary<NSString *, OTStream *> *
Las transmisiones que forman parte de esta sesión, identificadas por su «streamId».
connection
Tipo: OTConnection *
El OTConnection objeto para esta sesión. La propiedad de conexión solo está disponible una vez que el [OTSessionDelegate Se envía el mensaje [sessionDidConnect:]. Si la sesión no se conecta, esta propiedad seguirá siendo nil.
delegate
Tipo: id<OTSessionDelegate>
El OTSessionDelegate objeto que actúa como objeto delegado para esto OTSession objeto que gestiona los mensajes en nombre de esta sesión.
apiQueue
Tipo: dispatch_queue_t
La cola de devoluciones de llamada del delegado puede definirla la propia aplicación. La cola de GCD para enviar devoluciones de llamada al delegado puede sobrescribirse para permitir la integración con XCTest (novedad de XCode 5) u otros marcos de trabajo que requieran funcionar en el hilo principal.
capabilities
Tipo: OTSessionCapabilities *
Un OTSessionCapabilities objeto que indica si el cliente puede publicar y suscribirse a flujos en la sesión, en función del rol asignado al token utilizado para conectarse a la sesión. Esta propiedad se establece en nil hasta que te hayas conectado a una sesión y el [OTSessionDelegate Se ha llamado al método [sessionDidConnect:].
Métodos
| Nombre | Descripción |
|---|---|
initWithApiKey:sessionId:delegate:(apiKey, sessionId, delegate) → {id} |
Inicia esta sesión con tu clave API de OpenTok, una ID de sesión, y delegar antes de conectarse a OpenTok. |
initWithApiKey:sessionId:delegate:settings:(apiKey, sessionId, delegate, settings) → {id} |
Inicializar el OTSession objeto con propiedades definidas por un OTSessionSettings objeto. |
connectWithToken:error:(token, error) |
Una vez que tu solicitud tenga una ficha, conecta con tu Clave API para empezar a participar en una sesión de OpenTok. |
disconnect:(error) |
Desconectarse de una sesión activa de OpenTok. |
disconnect() |
|
publish:error:(publisher, error) |
Añade un editor a la sesión. |
publish:(publisher) |
|
unpublish:error:(publisher, error) |
Elimina a un editor de la sesión. |
unpublish:(publisher) |
|
subscribe:error:(subscriber, error) |
Conecta esta instancia de suscriptor a la sesión e inicia la suscripción. |
subscribe:(subscriber) |
|
unsubscribe:error:(subscriber, error) |
Desconecta esta instancia de suscriptor de la sesión e inicia la limpieza de objetos. |
unsubscribe:(subscriber) |
|
signalWithType:string:connection:error:(type, string, connection, error) |
Envía una señal a uno o varios clientes en una sesión. |
signalWithType:string:connection:retryAfterReconnect:error:(type, string, connection, retryAfterReconnect, error) |
Envía una señal a uno o varios clientes en una sesión. |
forceMuteAll:error:(excludedStreams, error) |
Obliga a todos los emisores de la sesión (excepto a aquellos que emiten transmisiones excluidas) a silenciar el audio. |
disableForceMute:(error) |
Desactiva el estado de silencio activo de la sesión. |
forceMuteStream:error:(stream, error) |
Obliga al emisor de una transmisión determinada a silenciar su audio. |
forceDisconnect:error:(connection, error) |
Obliga a un cliente a desconectarse de la sesión. |
reportIssue:(issueId) |
Informa de que tu aplicación ha tenido un problema. |
setEncryptionSecret:error:(secret, error) |
Establece la clave de cifrado de extremo a extremo que utilizan todos los emisores y suscriptores. |
init() → {instancetype} |
initWithApiKey:sessionId:delegate:(apiKey, sessionId, delegate) → {id}
Inicia esta sesión con tu clave API de OpenTok, una ID de sesión, y delega antes de conectarte a OpenTok. Envía el [OTSession Mensaje [connectWithToken:error:] al intentar conectarse a la sesión.
Importante: Si utilizas una aplicación de Vonage (en lugar de un proyecto de OpenTok), introduce el ID de la aplicación (no una clave de la API de OpenTok) en este parámetro.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
apiKey |
NSString * | Tu clave API de OpenTok. |
sessionId |
NSString * | El identificador de sesión de esta instancia. |
delegate |
id<OTSessionDelegate> | El delegado (OTSessionDelegate) que gestiona los mensajes en nombre de esta sesión. |
Devoluciones:
El OTSession objeto, o nil si falla la inicialización.
initWithApiKey:sessionId:delegate:settings:(apiKey, sessionId, delegate, settings) → {id}
Inicializar el OTSession objeto con propiedades definidas por un OTSessionSettings objeto.
Importante: Si estás utilizando la Video API con una aplicación de Vonage (en lugar de un proyecto de OpenTok), introduce el ID de la aplicación (no una clave de API de OpenTok) en este parámetro.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
apiKey |
NSString * | Tu clave API de OpenTok. |
sessionId |
NSString * | El identificador de sesión de esta instancia. |
delegate |
id<OTSessionDelegate> | El delegado (OTSessionDelegate) para la sesión. |
settings |
OTSessionSettings * | El (OTSessionSettings) objeto que define la configuración de la sesión. |
Devoluciones:
connectWithToken:error:(token, error)
Una vez que tu solicitud tenga una ficha, conecta con tu Clave API para empezar a participar en una sesión de OpenTok.
Cuando la sesión se conecta correctamente, el [OTSessionDelegate Se envía el mensaje [sessionDidConnect:] al delegado de la sesión.
Si la sesión no puede conectarse, el [OTSessionDelegate Se envía el mensaje [session:didFailWithError:] al delegado de la sesión.
Cuando se interrumpe la sesión, el [OTSessionDelegate Se envía el mensaje [sessionDidDisconnect:] al delegado de la sesión.
Ten en cuenta que las sesiones se desconectan automáticamente cuando se suspende la aplicación.
Asegúrate de configurar un método delegado para el [OTSessionDelegate mensaje [session:didFailWithError:].
Si se produce un error asíncrono, el [OTSessionDelegate Se envía el mensaje [session:didFailWithError:] al delegado de la sesión.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
token |
NSString * | El token generado para esta conexión. |
error |
OTError * * | Se establece si se produce un error de forma sincrónica durante el procesamiento de la solicitud. El OTSessionErrorCode La enumeración (definida en el archivo OTError.h) define los valores para la code propiedad de este objeto. Este objeto es NULL si no se produce ningún error sincrónico. |
desconectar:(error)
Desconectarse de una sesión activa de OpenTok.
Este método elimina todos los OTPublisher y OTSuscriptor objetos que se han inicializado.
Como buena práctica, antes de llamar a este método, llama al [OTSession [unpublish:error:]> método para todos los editores y esperar a que el [OTPublisherKitDelegate mensaje «publisher:streamDestroyed:». Esto garantiza la eliminación completa de los editores, especialmente si los problemas de conectividad de red impiden dicha eliminación debido a la función de reconexión, que puede mantener activos los flujos de los editores a la espera de una posible reconexión.
Cuando se interrumpe la sesión, el [OTSessionDelegate Se envía el mensaje [sessionDidDisconnect:] al delegado de la sesión.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
error |
OTError * * | Se establece si se produce un error de forma sincrónica durante el procesamiento de la solicitud. El OTSessionErrorCode La enumeración (definida en el archivo OTError.h) define los valores para la code propiedad de este objeto. Este objeto es NULL si no se produce ningún error. |
disconnect()
publish:error:(editor, error)
Añade un editor a la sesión.
Cuando el editor comienza a transmitir datos, el [OTPublisherKitDelegate Se envía el mensaje [«editor:streamCreated:»] al delegado del editor.
Si falla la publicación, [OTPublisherKitDelegate [publisher:didFailWithError:] se envía al delegado del editor y no se transmitirá ningún mensaje del delegado de sesión.
Ten en cuenta que no se admiten varios editores.
Si se produce un error asíncrono, el [OTPublisherKitDelegate Se envía el mensaje [publisher:didFailWithError:] al delegado del editor.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
publisher |
OTPublisherKit * | El OTPublisherKit objeto con el que transmitir. |
error |
OTError * * | Se establece si se produce un error de forma sincrónica durante el procesamiento de la solicitud. El OTPublisherErrorCode La enumeración (definida en el archivo OTError.h) define los valores para la code propiedad de este objeto. Este objeto es NULL si no se produce ningún error. |
publicar:(editor)
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
publisher |
OTPublisherKit * |
despublicar:error:(editor, error)
Elimina a un editor de la sesión.
Al eliminar el editor, el [OTPublisherKitDelegate El mensaje [publisher:streamDestroyed:] se envía al delegado del editor una vez que se ha detenido la transmisión.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
publisher |
OTPublisherKit * | El OTPublisher objeto que se va a eliminar de la sesión. |
error |
OTError * * | Se establece si se produce un error de forma sincrónica durante el procesamiento de la solicitud. El OTPublisherErrorCode La enumeración (definida en el archivo OTError.h) define los valores para la code propiedad de este objeto. Este objeto es NULL si no se produce ningún error. |
retirar de la publicación: (editor)
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
publisher |
OTPublisherKit * |
subscribe:error:(suscriptor, error)
Conecta esta instancia de suscriptor a la sesión e inicia la suscripción. Si el suscriptor pasado se ha creado a partir de un OTStream instancia de un otro OTSession En este caso, el comportamiento de esta función es indefinido.
Si se produce un error asíncrono, el [OTSubscriberKitDelegate El mensaje [suscriptor:didFailWithError:] se envía al delegado del suscriptor.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
OTSubscriberKit * | El suscriptor debe conectarse y empezar a suscribirse. |
error |
OTError * * | Se establece si se produce un error de forma sincrónica durante el procesamiento de la solicitud. El OTSubscriberErrorCode La enumeración (definida en el archivo OTError.h) define los valores para la code propiedad de este objeto. Este objeto es NULL si no se produce ningún error. |
suscribirse: (suscriptor)
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
OTSubscriberKit * |
cancelar suscripción: error: (suscriptor, error)
Desconecta esta instancia de suscriptor de la sesión e inicia la limpieza de objetos.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
OTSubscriberKit * | Se va a desconectar al suscriptor y se le va a eliminar de esta sesión. |
error |
OTError * * | Se establece si se produce un error de forma sincrónica durante el procesamiento de la solicitud. El OTSubscriberErrorCode La enumeración (definida en el archivo OTError.h) define los valores para la code propiedad de este objeto. Este objeto es NULL si no se produce ningún error. |
darse de baja: (suscriptor)
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
OTSubscriberKit * |
signalWithType:cadena:conexión:error:(tipo, cadena, conexión, error)
Envía una señal a uno o varios clientes en una sesión.
Véase [OTSession signalWithType:string:connection:retryAfterReconnect:error:] y [OTSessionDelegate [session:typeDeSeñalRecibida:desdeConexión:conCadena:].
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
type |
NSString * | El tipo de señal. El tipo también se configura en el [OTSessionDelegate Mensaje [session:receivedSignalType:fromConnection:withString:]. La longitud máxima de la cadena de tipo es de 128 caracteres, y solo debe contener letras (A-Z y a-z), números (0-9), «-», «_» y «~». |
string |
NSString * | Los datos que se van a enviar. El límite de tamaño de los datos es de 8 KB. |
connection |
OTConnection * | Un destino OTConnection objeto. Establece este parámetro en nil para avisar a todos los participantes de la sesión. |
error |
OTError * * | Si falla el envío de una señal, este valor se establece en un OTError objeto. La enumeración OTSessionErrorCode (en OTError.h) incluye las constantes OTSessionInvalidSignalType y OTSessionSignalDataTooLong para estos errores. Ten en cuenta que el éxito indica que las opciones pasadas al método son válidas y que la señal se ha enviado. No indica que la señal haya sido recibida correctamente por ninguno de los destinatarios previstos. |
signalWithType:cadena:conexión:reintentoTrasReconexión:error:(tipo, cadena, conexión, reintentoTrasReconexión, error)
Envía una señal a uno o varios clientes en una sesión. Esta versión del método incluye un retryAfterReconnect parámetro.
Véase [OTSession signalWithType:string:connection:retryAfterReconnect:error:], [OTSessionDelegate session:receivedSignalType:fromConnection:withString:], y [OTSessionDelegate sessionDidBeginReconnecting:].
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
type |
NSString * | El tipo de señal. El tipo también se configura en el [OTSessionDelegate Mensaje [session:receivedSignalType:fromConnection:withString:]. La longitud máxima de la cadena de tipo es de 128 caracteres, y solo debe contener letras (A-Z y a-z), números (0-9), «-», «_» y «~». |
string |
NSString * | Los datos que se van a enviar. El límite de tamaño de los datos es de 8 KB. |
connection |
OTConnection * | Un destino OTConnection objeto. Establece este parámetro en nil para avisar a todos los participantes de la sesión. |
retryAfterReconnect |
BOOL | Al volver a conectarse a la sesión, se debe decidir si se envían las señales que se iniciaron mientras se estaba desconectado. Si el cliente pierde la conexión con la sesión de OpenTok debido a una interrupción en la conectividad de red, el cliente intenta volver a conectarse a la sesión, y el [OTSessionDelegate Se envía el mensaje [sessionDidBeginReconnecting:]. De forma predeterminada, las señales iniciadas mientras se está desconectado se envían cuando (y si) el cliente se vuelve a conectar a la sesión de OpenTok. Puedes evitarlo configurando el retryAfterReconnect parámetro a false. (El valor por defecto es true.) |
error |
OTError * * | Si falla el envío de una señal, este valor se establece en un OTError objeto. La enumeración OTSessionErrorCode (en OTError.h) incluye las constantes OTSessionInvalidSignalType y OTSessionSignalDataTooLong para estos errores. Ten en cuenta que el éxito indica que las opciones pasadas al método son válidas y que la señal se ha enviado. No indica que la señal haya sido recibida correctamente por ninguno de los destinatarios previstos. |
forceMuteAll:error:(excludedStreams, error)
Obliga a todos los emisores de la sesión (excepto a aquellos que emiten transmisiones excluidas) a silenciar el audio.
Además, cualquier flujo que se publique después de la llamada a la función [OTSession forceMuteAll:error:]> Los métodos se publican con el audio silenciado. Puedes desactivar el silencio de una sesión llamando al [OTSession Método [disableForceMute:]. Una vez que hayas llamado al [OTSession Con el método [disableForceMute:], las nuevas transmisiones publicadas en la sesión ya no tendrán el audio silenciado.
Al llamar a este método, se produce el OTSessionDelegate sesión:muteForced:muteForcedInfo: mensaje que se enviará a cada cliente conectado a la sesión, con el active propiedad del muteForcedInfo objeto establecido en YES.
Compruebe el canForceMute propiedad de [OTSession [capacidades] para comprobar si puedes llamar a esta función correctamente. Esto está reservado para los clientes que se hayan conectado con un token al que se le haya asignado el rol de moderador (consulta el Descripción general de la creación de tokens).
Véase [OTSession forceMuteStream:error:], [OTSession capacidades], [OTSessionDelegate session:muteForced:], [OTPublisherKitDelegate muteForced:], y Silenciar el audio de los flujos de una sesión.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
excludedStreams |
NSArray<OTStream *> * | Flujos que se excluirán de la solicitud de silenciamiento. Establece este valor en null para silenciar todos los flujos de la sesión (incluidos los publicados por el cliente local). |
error |
OTError * * | Si la acción falla, este valor se establece en un OTError objeto. Ten en cuenta que el valor «success» indica que las opciones pasadas al método son válidas y que se ha enviado la solicitud para silenciar las transmisiones. No indica que los clientes de destino hayan procesado correctamente la solicitud. |
disableForceMute:(error)
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 [OTSession Método [forceMuteAll:error:] (o cuando un moderador de otro cliente realiza una llamada para silenciar todas las transmisiones), cualquier transmisión publicada tras la llamada de moderación se publica con el audio silenciado. Llama al disableForceMute() Método para desactivar el estado de silencio de una sesión (de modo que las nuevas transmisiones publicadas no se silencien automáticamente).
Al llamar a este método, se produce el OTSessionDelegate sesión:muteForced:muteForcedInfo: mensaje que se enviará a cada cliente conectado a la sesión, con el active propiedad del muteForcedInfo objeto establecido en NO.
Compruebe el canForceMute propiedad de [OTSession [capacidades] para comprobar si puedes llamar a esta función correctamente. Esto está reservado para los clientes que se hayan conectado con un token al que se le haya asignado el rol de moderador (consulta el Descripción general de la creación de tokens).
Véase [OTSession forceMuteAll:error:], [OTSession capacidades], [OTSessionDelegate session:muteForced:], y Silenciar el audio de los flujos de una sesión.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
error |
OTError * * | Si la acción falla, se establece en un OTError objeto. |
forceMuteStream:error:(stream, error)
Obliga al emisor de una transmisión determinada a silenciar su audio.
Compruebe el canForceMute propiedad de [OTSession [capacidades] para comprobar si puedes llamar a esta función correctamente. Esto está reservado para los clientes que se hayan conectado con un token al que se le haya asignado el rol de moderador (consulta el Descripción general de la creación de tokens).
Véase [OTSession forceMuteAll:error:], [OTSession capacidades], [OTSessionDelegate session:muteForced:], [OTPublisherKitDelegate muteForced:], y Silenciar el audio de los flujos de una sesión.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
stream |
OTStream * | La transmisión que se va a silenciar. |
error |
OTError * * | Si la acción falla, este valor se establece en un OTError objeto. Ten en cuenta que el valor «success» indica que las opciones pasadas al método son válidas y que se ha enviado la solicitud para silenciar las transmisiones. No indica que los clientes de destino hayan procesado correctamente la solicitud. |
forceDisconnect:error:(conexión, error)
Obliga a un cliente a desconectarse de la sesión.
Aunque puedes utilizar el [OTSession método [forceDisconnect:error:] para cerrar tu propia conexión, llamando al [OTSession El método [disconnect:] es más sencillo. Se devuelve un error si el rol del cliente no incluye los permisos necesarios para forzar la desconexión de otros usuarios. El rol del cliente se define al crear el token de usuario. Cuando se interrumpe una conexión mediante este método, [OTSessionDelegate sessionDidDisconnect:], [OTSessionDelegate [session:connectionDestroyed:] y [OTPublisherKitDelegate Los mensajes [publisher:streamDestroyed:] se envían de la misma forma que si la conexión se hubiera cerrado por sí misma utilizando [OTSession desconectar:]
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
connection |
OTConnection * | El OTConnection para desconectarse. |
error |
OTError * * | Si falla la desconexión forzada, este valor se establece en un OTError objeto. La enumeración OTSessionErrorCode (en OTError.h) incluye OTSessionUnableToForceDisconnect para estos errores. |
reportIssue:(issueId)
Informa de que tu aplicación ha tenido un problema. Puedes utilizar el ID del problema con el Inspector o cuando se trate un asunto con el equipo de asistencia técnica de la Video API de Vonage.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
issueId |
NSString * * | Un puntero a una cadena que se establecerá como identificador único del problema notificado. Si la llamada al método falla (por ejemplo, debido a la falta de conexión a la red), este valor se establece en nil. |
setEncryptionSecret:error:(secret, error)
Establece la clave de cifrado de extremo a extremo que utilizan todos los emisores y suscriptores.
Véase el Cifrado de extremo a extremo guía del desarrollador.
La sesión debe haberse configurado con cifrado de extremo a extremo mediante el SDK del servidor. Si ya se sabe que la sesión no cuenta con cifrado de extremo a extremo, este método devuelve el error «OTSessionEncryptionNotEnabled» y todos los editores y suscriptores existentes reciben el mismo error y se eliminan. Si aún no se sabe (por ejemplo, cuando el secreto se establece antes de que se conecte la sesión), este método se ejecuta correctamente y el error se notifica más tarde, al publicar o suscribirse.
Si se pasa «nil» o una cadena vacía, se restablece (se borra) el secreto de cifrado establecido anteriormente. Siempre está permitido restablecer el secreto, incluso en una sesión de la que se sabe que no está cifrada de extremo a extremo.
Cualquier otro secreto debe tener una longitud comprendida entre 8 y 256 bytes cuando esté codificado en UTF-8; de lo contrario, se generará el error «OTSessionInvalidEncryptionSecret».
Se aplica un nuevo secreto a los editores y suscriptores que ya están en funcionamiento, así como a los que se creen a partir de ese momento. Sin embargo, el restablecimiento del secreto solo surte efecto para los editores y suscriptores creados a partir de ese momento: los que ya están en funcionamiento siguen cifrando y descifrando con el secreto anterior hasta que se vuelvan a crear.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
secret |
NSString * | Valor del secreto de cifrado, o «nil» o una cadena vacía para restablecer el secreto de cifrado establecido anteriormente. |
error |
OTError * * | Si la acción falla, este parámetro se establece en un OTError objeto. |