| Está em conformidade com | NSObject |
| Declarado em | OTSession.h |
Visão geral
Usado para enviar mensagens para uma instância da OTSession. A classe OTSession
inclui um
delegate propriedade. Quando você envia o
[OTSession initWithApiKey:sessionId:delegate:] mensagem,
você especifica um objeto OTSessionDelegate.
Conectando-se a uma sessão
– sessionDidConnect: método obrigatório
Enviado quando o cliente se conecta à sessão.
- (void)sessionDidConnect:(nonnull OTSession *)session
Parâmetros
session |
O OTSession instância que enviou esta mensagem. |
Declarado em
OTSession.h
– sessionDidDisconnect: método obrigatório
Enviado quando o cliente se desconecta da sessão.
- (void)sessionDidDisconnect:(nonnull OTSession *)session
Parâmetros
session |
O OTSession instância que enviou esta mensagem. |
Declarado em
OTSession.h
– session:didFailWithError: método obrigatório
É enviada se a tentativa de conexão com a sessão falhar ou se a conexão com a sessão for interrompida devido a um erro após uma conexão bem-sucedida.
- (void)session:(nonnull OTSession *)session didFailWithError:(nonnull OTError *)error
Parâmetros
session |
O OTSession instância que enviou esta mensagem. |
error |
Um OTError objeto que descreve o problema. O OTSessionErrorCode A enum define valores para o code propriedade deste objeto. |
Discussão
Esta mensagem é enviada depois que seu aplicativo chama [OTSession connectWithToken:error:].
Se essa mensagem for enviada porque a conexão com a sessão é interrompida após uma conexão bem-sucedida, a mensagem é enviada imediatamente antes do [OTSessionDelegate sessionDidDisconnect:] A mensagem é enviada.
Declarado em
OTSession.h
Monitoramento de fluxos em uma sessão
– session:streamCreated: método obrigatório
Enviado quando um novo stream é criado nesta sessão.
- (void)session:(nonnull OTSession *)session streamCreated:(nonnull OTStream *)stream
Parâmetros
session |
A instância OTSession que enviou esta mensagem. |
stream |
A transmissão associada a este evento. |
Discussão
Observe que, se seu aplicativo publicar nesta sessão, seu próprio delegado de sessão não receberá a mensagem [OTSessionDelegate session:streamCreated:] para o próprio stream publicado. Para esse evento, consulte o callback do delegado [OTPublisherKitDelegate publisher:streamCreated:].
Declarado em
OTSession.h
– session:streamDestroyed: método obrigatório
Enviado quando um stream deixa de ser publicado na sessão.
- (void)session:(nonnull OTSession *)session streamDestroyed:(nonnull OTStream *)stream
Parâmetros
session |
O OTSession instância que enviou esta mensagem. |
stream |
A transmissão associada a este evento. |
Declarado em
OTSession.h
Monitoramento de conexões em uma sessão
– session:connectionCreated:
Enviado quando outro cliente se conecta à sessão. O connection objeto
representa a conexão do cliente.
- (void)session:(nonnull OTSession *)session connectionCreated:(nonnull OTConnection *)connection
Parâmetros
session |
O OTSession instância que enviou esta mensagem. |
connection |
O novo OTConnection objeto. |
Discussão
Essa mensagem não é enviada quando o próprio cliente se conecta à sessão. Em vez disso, o [OTSessionDelegate sessionDidConnect:] A mensagem é enviada quando o seu próprio cliente se conecta à sessão.
Declarado em
OTSession.h
– session:connectionDestroyed:
Enviado quando outro cliente se desconecta da sessão. O connection
O objeto representa a conexão que o cliente tinha com a sessão.
- (void)session:(nonnull OTSession *)session connectionDestroyed:(nonnull OTConnection *)connection
Parâmetros
session |
O OTSession instância que enviou esta mensagem. |
connection |
O OTConnection objeto correspondente ao cliente que se desconectou da sessão. |
Discussão
Essa mensagem não é enviada quando o próprio cliente se desconecta da sessão. Em vez disso, o [OTSessionDelegate sessionDidDisconnect:] A mensagem é enviada quando o seu próprio cliente se conecta à sessão.
Declarado em
OTSession.h
– session:receivedSignalType:fromConnection:withString:
Enviado quando uma mensagem é recebida na sessão.
- (void)session:(nonnull OTSession *)session receivedSignalType:(NSString *_Nullable)type fromConnection:(OTConnection *_Nullable)connection withString:(NSString *_Nullable)string
Parâmetros
session |
O OTSession instância que enviou esta mensagem. |
type |
A string de tipo do sinal. |
connection |
A conexão que identifica o cliente que enviou a mensagem. Esse valor pode ser nil. |
string |
Os dados do sinal. |
Declarado em
OTSession.h
Monitoramento de eventos de arquivamento
– session:archiveStartedWithId:name:
Enviada quando uma gravação arquivada de uma sessão é iniciada. Se você se conectar a uma sessão em que a gravação já esteja em andamento, essa mensagem será enviada no momento da conexão.
- (void)session:(nonnull OTSession *)session archiveStartedWithId:(nonnull NSString *)archiveId name:(NSString *_Nullable)name
Parâmetros
session |
O OTSession instância que enviou esta mensagem. |
archiveId |
O ID exclusivo do arquivo. |
name |
O nome do arquivo (caso tenha sido fornecido no momento da criação do arquivo). |
Discussão
Em resposta a essa mensagem, talvez seja interessante adicionar uma notificação na interface do usuário (como um ícone na visualização do Publisher) que indique que a sessão está sendo gravada.
Para mais informações, consulte o OpenTok Visão geral do arquivamento.
Declarado em
OTSession.h
– session:archiveStoppedWithId:
Enviado quando a reprodução de uma gravação arquivada de uma sessão é interrompida.
- (void)session:(nonnull OTSession *)session archiveStoppedWithId:(nonnull NSString *)archiveId
Parâmetros
session |
O OTSession instância que enviou esta mensagem. |
archiveId |
O ID exclusivo do arquivo. |
Discussão
Em resposta a esta mensagem, talvez você queira alterar ou remover uma notificação da interface do usuário (como um ícone na visualização do Publisher) que indique que a sessão está sendo gravada.
Para obter mais informações, consulte o OpenTok Visão geral do arquivamento.
Declarado em
OTSession.h
Reconectando-se a uma sessão
– sessionDidBeginReconnecting:
Enviado quando o cliente local perde a conexão com uma sessão do OpenTok e está tentando se reconectar. Isso ocorre devido a uma perda de conectividade de rede. Se o cliente conseguir se reconectar à sessão, o [OTSessionDelegate sessionDidReconnect:] a mensagem é enviada. Caso contrário, se o cliente não conseguir se reconectar, o [OTSessionDelegate sessionDidDisconnect:] A mensagem é enviada.
- (void)sessionDidBeginReconnecting:(nonnull OTSession *)session
Parâmetros
session |
O OTSession instância que enviou esta mensagem. |
Discussão
Em resposta ao envio desta mensagem, talvez seja interessante exibir uma notificação na interface do usuário, para informar ao usuário que o aplicativo está tentando se reconectar à sessão e que os fluxos de áudio e vídeo estão temporariamente desconectados.
Declarado em
OTSession.h
– sessionDidReconnect:
Enviado quando o cliente local se reconecta à sessão do OpenTok após a
perda temporária da conexão de rede. Quando a conexão é perdida, o
[OTSessionDelegate sessionDidBeginReconnecting:] a mensagem é enviada, antes
da [OTSessionDelegate sessionDidReconnect:] mensagem.
Se o cliente não conseguir se reconectar à sessão, o
[OTSessionDelegate sessionDidDisconnect:] A mensagem é enviada.
- (void)sessionDidReconnect:(nonnull OTSession *)session
Parâmetros
session |
O OTSession instância que enviou esta mensagem. |
Discussão
Quaisquer editores e assinantes existentes são automaticamente reconectados quando o cliente se reconecta e essa mensagem é enviada.
Por padrão, quaisquer sinais iniciados pelo cliente local usando o
[OTSession signalWithType:string:connection:error:] Os sinais do método são enviados quando
o cliente se reconecta. Para impedir que quaisquer sinais iniciados enquanto o cliente estava desconectado
sejam enviados, use o
[OTSession signalWithType:string:connection:retryAfterReconnect:error:]
método para enviar o sinal e definir o retryAfterReconnect
parâmetro para NO. (Todos os sinais enviados por outros clientes enquanto o seu
cliente estava desconectado são recebidos assim que ele se reconecta.)
Veja [OTSessionDelegate sessionDidBeginReconnecting:].
Declarado em
OTSession.h
Monitoramento de alterações no estado de silêncio
– session:muteForced:
Enviado quando um moderador silencia as transmissões na sessão ou desativa o estado de silenciamento na sessão.
- (void)session:(nonnull OTSession *)session muteForced:(nonnull OTMuteForcedInfo *)muteForcedInfo
Parâmetros
session |
A sessão. |
muteForcedInfo |
Verifique o active propriedade deste objeto. Quando é definida como YES, o moderador silenciou as transmissões da sessão. Quando está configurado para NO, um moderador desativou o modo de silenciamento na sessão. |
Discussão
Veja [OTSession forceMuteAll:error:], [Recursos do OTSession], [OTPublisherKitDelegate muteForced:], e Silenciar o áudio das transmissões em uma sessão.
Declarado em
OTSession.h