概要

OTSessionインスタンスへのメッセージ送信に使用されます。OTSessionクラスには 以下の delegate プロパティ。 [OTSession initWithApiKey:sessionId:delegate:] メッセージ、 OTSessionDelegate オブジェクトを指定します。

セッションへの接続

– sessionDidConnect: 必須メソッド

クライアントがセッションに接続した際に送信されます。

- (void)sessionDidConnect:(nonnull OTSession *)session

パラメータ

登録地

OTSession.h

– sessionDidDisconnect: 必須メソッド

クライアントがセッションから切断されたときに送信されます。

- (void)sessionDidDisconnect:(nonnull OTSession *)session

パラメータ

登録地

OTSession.h

– session:didFailWithError: 必須メソッド

セッションへの接続に失敗した場合、または接続に成功した後、エラーによりセッションへの接続が 切断された場合に送信されます。

- (void)session:(nonnull OTSession *)session didFailWithError:(nonnull OTError *)error

パラメータ

考察

このメッセージは、Applicationsが以下を呼び出した後に送信されます [OTSession connectWithToken:error:].

接続が正常に確立された後にセッションへの接続が切断されたためにこのメッセージが送信される場合、 そのメッセージは、 [OTSessionDelegate sessionDidDisconnect:] メッセージが送信される。

登録地

OTSession.h

セッション内のストリームの監視

– session:streamCreated: 必須メソッド

このセッションで新しいストリームが作成されたときに送信されます。

- (void)session:(nonnull OTSession *)session streamCreated:(nonnull OTStream *)stream

パラメータ

考察

なお、アプリケーションがこのセッションにストリームを公開する場合、独自のセッション デリゲートは、自身が公開したストリームに対して [OTSessionDelegate session:streamCreated:] メッセージを受け取りません。このイベントについては、デリゲート コールバック [OTPublisherKitDelegate publisher:streamCreated:] を参照してください。

登録地

OTSession.h

– session:streamDestroyed: 必須メソッド

ストリームがセッションへの配信を停止した際に送信されます。

- (void)session:(nonnull OTSession *)session streamDestroyed:(nonnull OTStream *)stream

パラメータ

登録地

OTSession.h

セッション内の接続の監視

– session:connectionCreated:

別のクライアントがセッションに接続したときに送信されます。この connection object クライアントの接続を表します。

- (void)session:(nonnull OTSession *)session connectionCreated:(nonnull OTConnection *)connection

パラメータ

考察

自身のクライアントがセッションに接続した場合は、このメッセージは送信されません。 その代わりに、 [OTSessionDelegate sessionDidConnect:] 自身のクライアントがセッションに接続すると、メッセージが送信されます。

登録地

OTSession.h

– session:connectionDestroyed:

別のクライアントがセッションから切断されたときに送信されます。この connection このオブジェクトは、クライアントがセッションに対して確立していた接続を表します。

- (void)session:(nonnull OTSession *)session connectionDestroyed:(nonnull OTConnection *)connection

パラメータ

考察

自身のクライアントがセッションから切断された場合、このメッセージは送信されません。 その代わりに、 [OTSessionDelegate sessionDidDisconnect:] 自身のクライアントがセッションに接続すると、メッセージが送信されます。

登録地

OTSession.h

– session:receivedSignalType:fromConnection:withString:

セッションでメッセージを受信した際に送信されます。

- (void)session:(nonnull OTSession *)session receivedSignalType:(NSString *_Nullable)type fromConnection:(OTConnection *_Nullable)connection withString:(NSString *_Nullable)string

パラメータ

登録地

OTSession.h

アーカイブイベントの監視

– session:archiveStartedWithId:name:

セッションのアーカイブ録画が開始されたときに送信されます。録画がすでに進行中の セッションに接続した場合、接続時にこのメッセージが送信されます。

- (void)session:(nonnull OTSession *)session archiveStartedWithId:(nonnull NSString *)archiveId name:(NSString *_Nullable)name

パラメータ

考察

このメッセージに応じて、セッションが記録中であることを示す ユーザーインターフェース上の通知（「パブリッシャー」ビュー内のアイコンなど）を 追加することを検討するとよいでしょう。

詳細については、OpenTokをご覧ください。 アーカイブの概要.

登録地

OTSession.h

– session:archiveStoppedWithId:

セッションのアーカイブ録画が終了した際に送信されます。

- (void)session:(nonnull OTSession *)session archiveStoppedWithId:(nonnull NSString *)archiveId

パラメータ

考察

このメッセージを受け取った際は、セッションが録画中であることを示す ユーザーインターフェース上の通知（「パブリッシャー」ビューのアイコンなど）を 変更または削除することをお勧めします。

詳細については、OpenTokをご覧ください。 アーカイブの概要.

登録地

OTSession.h

セッションへの再接続

– sessionDidBeginReconnecting:

ローカルクライアントが OpenTok セッションとの接続を失い、 再接続を試みている際に送信されます。これは、ネットワーク接続が切断されたことが原因です。 クライアントがセッションに再接続できた場合、 [OTSessionDelegate sessionDidReconnect:] メッセージが送信されます。それ以外の場合、 クライアントが再接続できない場合は、 [OTSessionDelegate sessionDidDisconnect:] メッセージが送信されます。

- (void)sessionDidBeginReconnecting:(nonnull OTSession *)session

パラメータ

考察

このメッセージが送信された際、アプリがセッションへの再接続を試みており、 音声・映像ストリームが一時的に切断されていることをユーザーに知らせるため、 ユーザーインターフェース上の通知を表示することを検討するとよいでしょう。

登録地

OTSession.h

– sessionDidReconnect:

ローカルクライアントが、一時的にネットワーク接続が切断された後、 OpenTokセッションに再接続した際に送信されます。接続が切断された場合、 [OTSessionDelegate sessionDidBeginReconnecting:] メッセージが送信される前に、 その [OTSessionDelegate sessionDidReconnect:] メッセージ。 クライアントがセッションに再接続できない場合、 [OTSessionDelegate sessionDidDisconnect:] メッセージが送信される。

- (void)sessionDidReconnect:(nonnull OTSession *)session

パラメータ

考察

クライアントが再接続し、このメッセージが送信されると、 既存のパブリッシャーおよびサブスクライバーは自動的に再接続されます。

デフォルトでは、ローカルクライアントが [OTSession signalWithType:string:connection:error:] メソッドは、 クライアントが再接続した際に送信されます。接続が切断されている間に発生したシグナルが 送信されないようにするには、 [OTSession signalWithType:string:connection:retryAfterReconnect:error:] 信号を送信する方法、および retryAfterReconnect パラメータを NO. （クライアントが切断されていた間に他のクライアントから送信されたすべての 信号は、再接続時に受信されます。）

参照 [OTSessionDelegate sessionDidBeginReconnecting:].

登録地

OTSession.h

ミュート状態の変化の監視

– session:muteForced:

モデレーターがセッション内の配信をミュートしたり、セッション内のミュート状態を解除したりした際に送信されます。

- (void)session:(nonnull OTSession *)session muteForced:(nonnull OTMuteForcedInfo *)muteForcedInfo

パラメータ

考察

参照 [OTSession forceMuteAll:error:], [OTSessionの機能], [OTPublisherKitDelegate muteForced:]そして セッション内の ストリームの音声をミュートする.

登録地

OTSession.h