OpenTok セッション。 続きを読む...

#include "capabilities.h" #include "config.h" #include "publisher.h" #include "subscriber.h" #include "stream.h"
マクロ
#define 暗号化秘密鍵の最小長さ   8
#define 暗号化秘密鍵の最大長   256
型定義
typedef struct otc_session otc_session
typedef struct otc_session_settings otc_session_settings
列挙型
enum otc_session_error_code {   OTC_SESSION_AUTHORIZATION_FAILURE , OTC_SESSION_BLOCKED_COUNTRY , OTC_SESSION_CONNECTION_DROPPED , OTC_SESSION_CONNECTION_FAILED ,   OTC_SESSION_CONNECTION_LIMIT_EXCEEDED , OTC_SESSION_CONNECTION_REFUSED , OTC_SESSION_CONNECTION_TIMED_OUT , OTC_SESSION_FORCE_UNPUBLISH_OR_INVALID_STREAM = 1535 ,   OTC_SESSION_ILLEGAL_STATE , OTC_SESSION_INTERNAL_ERROR , OTC_SESSION_INVALID_SESSION , OTC_SESSION_INVALID_SIGNAL_TYPE ,   OTC_SESSION_NOT_CONNECTED , OTC_SESSION_NO_MESSAGING_SERVER , OTC_SESSION_NULL_OR_INVALID_PARAMETER , OTC_SESSION_PUBLISHER_NOT_FOUND ,   OTC_SESSION_SIGNAL_DATA_TOO_LONG , OTC_SESSION_SIGNAL_TYPE_TOO_LONG , OTC_SESSION_UNABLE_TO_SEND_SIGNAL , OTC_SESSION_STATE_FAILED = 1020 ,   OTC_SESSION_SUBSCRIBER_NOT_FOUND , OTC_SESSION_UNEXPECTED_GET_SESSION_INFO_REPONSE , OTC_SESSION_ENCRYPTION_SECRET_MISSING , OTC_SESSION_INVALID_ENCRYPTION_SECRET }
機能
otc_session * otc_session_new (const char *apikey, const char *session_id, const struct otc_session_callbacks *コールバック)
otc_session_settings * otc_session_settings_new (void)
otc_status otc_session_settings_set_connection_events_suppressed (otc_session_settings *設定、 otc_bool （抑制）
otc_status otc_session_settings_set_custom_ice_config (otc_session_settings *設定、定数構造体 otc_custom_ice_config *custom_ice_config)
otc_status otc_session_settings_set_proxy_url (otc_session_settings *settings, const char *proxy_url)
otc_status otc_session_settings_set_ip_whitelist (otc_session_settings *設定、 otc_bool (ip_whitelist)
otc_status otc_session_settings_set_single_peer_connection (otc_session_settings *設定、 otc_bool 有効にする)
セッションのシングル・ピア・接続（SPC）を有効または無効にします。 続きを読む...
otc_status otc_session_settings_set_session_migration (otc_session_settings *設定、 otc_bool 有効にする)
セッションのセッション移行を有効または無効にします。 続きを読む...
otc_status otc_session_settings_delete (otc_session_settings *設定)
otc_session * otc_session_new_with_settings (const char *apikey, const char *session_id, const struct otc_session_callbacks *コールバック、 otc_session_settings *設定)
otc_status otc_session_delete (otc_session *セッション)
otc_status otc_session_connect (otc_session *session, const char *token)
otc_status otc_session_disconnect (otc_session *セッション)
otc_status otc_session_publish (otc_session *セッション、 otc_publisher *出版社)
otc_status otc_session_unpublish (otc_session *セッション、 otc_publisher *出版社)
otc_status otc_session_subscribe (otc_session *セッション、 otc_加入者 *購読者)
otc_status otc_session_unsubscribe (otc_session *セッション、 otc_加入者 *購読者)
otc_status otc_session_send_signal (otc_session *session, const char *type, const char *signal)
otc_status otc_session_force_mute_all (otc_session *session, const char **excluded_streams_ids, const int excluded_streams_len)
otc_status otc_session_disable_force_mute (otc_session *セッション)
otc_status otc_session_force_mute_stream (const otc_session *session, const char *stream_id_to_mute)
otc_status otc_session_force_disconnect (const otc_session *セッション, const otc_connection *接続)
otc_status otc_session_send_signal_to_connection (otc_session *session, const char *type, const char *signal, const otc_connection *接続)
otc_status otc_session_send_signal_with_options (otc_session *session, const char *type, const char *signal, struct otc_signal_options signal_options)
otc_status otc_session_send_signal_to_connection_with_options (otc_session *session, const char *type, const char *signal, const otc_connection *接続、構造体 otc_signal_options signal_options)
otc_status otc_session_report_issue (struct otc_session *session, const char *issue_description, char **issue_id)
char * otc_session_get_id (const otc_session *セッション)
otc_connection * otc_session_get_connection (const otc_session *セッション)
struct otc_session_capabilities otc_session_get_capabilities (const otc_session *セッション)
void * otc_session_get_user_data (const otc_session *セッション)
otc_status otc_session_set_encryption_secret (otc_session *session, const char *secret)
セッション内のすべてのパブリッシャーおよびサブスクライバーが使用するエンドツーエンド暗号化の秘密鍵を設定します。 続きを読む...

詳細な説明

OpenTok セッション。

このファイルには、OpenTok セッションの型定義に加え、セッションを扱う際に役立ついくつかの関数の宣言が含まれています。

Typedef のドキュメント

otc_session
typedef struct otc_session otc_session

OpenTokのセッションタイプの定義。

otc_session_settings

OpenTok セッション設定の型定義。

列挙型のドキュメント

otc_session_error_code

OpenTok セッションのエラーコード一覧。

この列挙型は、セッションに関連するいくつかのエラーコードを表しています。

調査員
OTC_SESSION_AUTHORIZATION_FAILURE 無効なAPIキーまたはトークンが指定されました。
OTC_SESSION_BLOCKED_COUNTRY セッションに接続できません。利用規約違反：輸出コンプライアンス。
OTC_SESSION_CONNECTION_DROPPED OpenTokメッセージングサーバーとの接続が切断されました。
OTC_SESSION_CONNECTION_FAILED セッションへの接続に失敗しました。
OTC_SESSION_CONNECTION_LIMIT_EXCEEDED クライアントは、同時接続数の制限を超えているセッションに接続しようとしました。
OTC_SESSION_CONNECTION_REFUSED メッセージングサーバーへのソケットを開くことができませんでした。送信ポート 443 および 8080 にアクセスできることを確認してください。
OTC_SESSION_CONNECTION_TIMED_OUT セッションへの接続を試みた際、接続タイムアウトが発生しました
OTC_SESSION_FORCE_UNPUBLISH_OR_INVALID_STREAM 無効なストリームです。
OTC_SESSION_ILLEGAL_STATE このセッションに対して、不正または不適切なタイミングでメソッドが呼び出されました。たとえば、すでに接続済みのセッションに接続しようとすると、このエラーが発生します。
OTC_SESSION_INTERNAL_ERROR スレッドのディスパッチ失敗、メモリ不足、構文エラーなど。
OTC_SESSION_INVALID_SESSION 無効なセッションIDが指定されました。
OTC_SESSION_INVALID_SIGNAL_TYPE 無効な型のシグナルを送信しようとしました。
OTC_SESSION_NOT_CONNECTED セッションが接続されていません。また、要求された操作を実行するには、アクティブなセッション接続が必要です。
OTC_SESSION_NO_MESSAGING_SERVER このセッションでは、メッセージングサーバーが利用できません。
OTC_SESSION_NULL_OR_INVALID_PARAMETER 渡されたパラメータがnullまたは無効です。
OTC_SESSION_PUBLISHER_NOT_FOUND このセッションでは、パブリッシャーが不明です。これは通常、そのセッションに関連付けられていないパブリッシャーの公開を取り消そうとした結果として発生します。
OTC_SESSION_SIGNAL_DATA_TOO_LONG 最大長（8KB）を超えるデータ文字列を含む信号を送信しようとしました。
OTC_SESSION_SIGNAL_TYPE_TOO_LONG 最大長を超えるタイプの文字列を使用して信号を送信しようとしました。
OTC_SESSION_UNABLE_TO_SEND_SIGNAL シグナルの送信に失敗しました。おそらく、必要な権限が不足しているためです（例：パブリッシャー専用トークンなど）。
OTC_SESSION_STATE_FAILED セッションの状態を取得しようとした際に、接続がタイムアウトしました。
OTC_SESSION_SUBSCRIBER_NOT_FOUND このセッションでは、このサブスクライバーが認識されていません。これは通常、そのセッションに関連付けられていないサブスクライバーの登録解除を試みたことが原因です。
OTC_SESSION_UNEXPECTED_GET_SESSION_INFO_REPONSE 予期せぬ反応。
OTC_SESSION_ENCRYPTION_SECRET_MISSING 暗号化シークレットなしで、エンドツーエンド暗号化セッションに参加しようとしました。
OTC_SESSION_INVALID_ENCRYPTION_SECRET 暗号化シークレットなしで、エンドツーエンド暗号化セッションに参加しようとしました。

関数のドキュメント

otc_session_connect()
otc_status otc_session_connect ( otc_session * セッション,
const char * トークン
)

クライアントを OpenTok セッションに接続します。

パラメータ : | | | | --- | --- | | session | The otc_session 接続先の OpenTok セッションを表す構造体。 | | token | セッションに接続するためのクライアントトークン。詳細については トークン作成の概要. |

戻り値 : エラーか成功かを示す戻り値。

otc_session_delete()
otc_status otc_session_delete ( otc_session * セッション )

セッションに関連付けられたリソースを解放します。

パラメータ : | | | | --- | --- | | session | The otc_session 例。 |

otc_session_disable_force_mute()
otc_status otc_session_disable_force_mute ( otc_session * セッション )

セッションのアクティブなミュート状態を解除します。このメソッドを呼び出すと、そのセッションに配信される新しいストリームの音声はミュートされなくなります。

を呼び出した後 otc_session_force_mute_all() 関数（または別のクライアントのモデレーターがすべてのストリームをミュートする呼び出しを行った場合）、モデレーションの呼び出し後に配信されるストリームは、音声がミュートされた状態で配信されます。以下の関数を呼び出してください。 otc_session_disable_force_mute セッションのミュート状態を解除する関数（これにより、新たに公開されるストリームが自動的にミュートされるのを防ぐ）。

この関数を呼び出すと、 otc_session_callback.on_mute_forced() セッションに接続した各クライアントで呼び出されるコールバック関数。 active プロパティの otc_on_mute_forced_info 関数に渡された構造体を次のように設定する OTC_FALSE.

に電話する。 otc_session_get_capabilities クライアントがこの関数を正常に呼び出せるかどうかを確認するための関数です。これは、モデレーターの役割が割り当てられたトークンで接続したクライアント専用です（ トークン作成の概要.

パラメータ : | | | | --- | --- | | session | The otc_session OpenTokセッションを表す構造体。 |

戻り値 : エラーか成功かを示す戻り値。

otc_session_disconnect()
otc_status otc_session_disconnect ( otc_session * セッション )

このセッションからクライアントを切断します。クライアントのすべてのサブスクライバーおよびパブリッシャーも、セッションから切断されます。ベストプラクティスとして、この関数を呼び出す前に、 otc_session_unpublish すべてのパブリッシャー向けの関数を実行し、 otc_publisher_callbacks#on_stream_destroyed コールバック。これにより、パブリッシャーが確実に完全に削除されます。特に、ネットワーク接続の問題により、再接続機能のせいで削除が行えない場合（再接続の可能性に備えてパブリッシャーのストリームが維持される場合など）に有効です。

パラメータ : | | | | --- | --- | | session | The otc_session 切断対象の OpenTok セッションを表す構造体。 |

戻り値 : エラーか成功かを示す戻り値。

otc_session_force_disconnect()
otc_status otc_session_force_disconnect ( const otc_session * セッション,
const otc_connection * 接続
)

クライアントを強制的にセッションから切断します。

この関数を使って自身の接続を終了させることはできますが、 otc_session_disconnect の方が簡単です。クライアントのロールに、他のユーザーを強制的に切断するために必要な権限が含まれていない場合、エラーが返されます。クライアントのロールは、ユーザートークンを作成する際に定義します。この関数を使用して接続を切断すると、 otc_session_callbacks#on_connection_dropped そして otc_publisher_callbacks#on_stream_destroyed コールバックは、接続が otc_session_disconnect.

パラメータ : | | | | --- | --- | | session | 接続が属する otc_session | | connection | 切断する接続 |

戻り値 : エラーが発生した場合はエラーを返す。それ以外の場合はOTC_SUCCESSを返す。

otc_session_force_mute_all()
otc_status otc_session_force_mute_all ( otc_session * セッション,
const char ** 除外されたストリームのID,
const int 除外されたストリームの長さ
)

そのセッションに参加しているすべての配信者（除外されたストリームを配信している配信者を除く）に対して、音声をミュートするように強制します。

また、以下の呼び出しの後に発行されるストリームは、すべて otc_session_force_mute_all 関数はオーディオをミュートした状態でパブリッシュされます。セッションのミュート状態を解除するには otc_session_disable_force_mute 関数。この関数を呼び出した後、 otc_session_disable_force_mute 関数を使用すると、セッションに公開された新しいストリームは、音声がミュートされなくなります。

この関数を呼び出すと、 otc_session_callback.on_mute_forced() セッションに接続した各クライアントで呼び出されるコールバック関数。 active プロパティの otc_on_mute_forced_info 関数に渡された構造体を次のように設定する OTC_TRUE. また、 otc_publisher_callbacks.on_publisher_mute_forced() ミュートされたストリームを配信する各クライアントにおいて、コールバック関数が呼び出されます。

に電話する。 otc_session_get_capabilities クライアントがこの関数を正常に呼び出せるかどうかを確認するための関数です。これは、モデレーターの役割が割り当てられたトークンで接続したクライアント専用です（詳細は（詳細は トークン作成の概要.

パラメータ : | | | | --- | --- | | session | The otc_session OpenTokセッションを表す構造体。 | | excluded_streams_ids | ミュート対象のストリームのID文字列の配列へのポインタ。セッション内のすべてのストリーム（ローカルクライアントが公開しているストリームを含む）をミュートするには、これをnullptrに設定します。 | | excluded_streams_len | 除外されるストリーム配列の長さ。 |

戻り値 : エラーか成功かを示す戻り値。

otc_session_force_mute_stream()
otc_status otc_session_force_mute_stream ( const otc_session * セッション,
const char * stream_id_to_mute
)

指定されたストリームの配信者に、音声をミュートするよう強制します。

この関数を呼び出すと、 otc_publisher_callbacks.on_publisher_mute_forced() ミュートされたストリームを配信しているクライアント側で呼び出されるコールバック関数。

に電話する。 otc_session_get_capabilities クライアントがこの関数を正常に呼び出せるかどうかを確認するための関数です。これは、モデレーターの役割が割り当てられたトークンで接続したクライアント専用です（詳細は（詳細は トークン作成の概要.

パラメータ : | | | | --- | --- | | session | The otc_session OpenTokセッションを表す構造体。 | | stream_id_to_mute | ミュートするストリームのストリームID文字列。 |

戻り値 : エラーか成功かを示す戻り値。

otc_session_get_capabilities()
struct otc_session_capabilities otc_session_get_capabilities ( const otc_session * セッション )

セッションに接続しているクライアントの機能情報を取得します。すべて otc_session_capabilities メンバーは、以下になるまでは未定義です。 otc_session_callbacks.on_connected が呼び出されました。

パラメータ : | | | | --- | --- | | session | The otc_session OpenTokセッションを表す構造体。 |

返品 : ザ otc_session_capabilities インスタンスだ。

otc_session_get_connection()
otc_connection * otc_session_get_connection ( const otc_session * セッション )

このセッションに関連付けられた接続オブジェクトを取得します。

パラメータ : | | | | --- | --- | | session | The otc_session OpenTokセッションを表す構造体。 |

返品 : ザ otc_connection インスタンスだ。

otc_session_get_id()
char * otc_session_get_id ( const otc_session * セッション )

このセッションの一意のセッションIDを取得します。

otc_session_get_user_data()
void * otc_session_get_user_data ( const otc_session * セッション )

そのセッションに関連付けられたユーザーデータを取得します。詳しくは otc_session_callbacks.user_data.

パラメータ : | | | | --- | --- | | session | The otc_session OpenTokセッションを表す構造体。 |

戻り値 : ユーザーデータへのポインタ。

otc_session_new()
otc_session * otc_session_new ( const char * APIキー,
const char * session_id,
const struct otc_session_callbacks * コールバック
)

新しいものを生成します otc_session 構造体のインスタンス。これを otc_session_connect OpenTokセッションに接続するための関数。

こちらも参照 otc_session_new_with_settings otc_session 構造体を詳細オプションを使用して初期化するため。

パラメータ : | | | | --- | --- | | apikey | OpenTok プロジェクトの API キー。詳細については Vonage Video APIのAccountページをご覧ください. |

重要だ： （OpenTokプロジェクトではなく）VonageアプリケーションでVideo APIを使用する場合は、このパラメータにアプリケーションID（OpenTok APIキーではありません）を指定してください。

パラメータ : | | | | --- | --- | | session_id | セッション ID。 | | callbacks | otc_session_callbacks セッションに関連するイベントのコールバック関数を含む構造体。 |

戻り値 : OpenTok セッションを表す `otc_session` 構造体。

otc_session_new_with_settings()
otc_session * otc_session_new_with_settings ( const char * APIキー,
const char * session_id,
const struct otc_session_callbacks * コールバック,
otc_session_settings * 設定
)

高度な設定を適用して、新しい OpenTok セッションを作成します。これには、接続イベントの抑制、カスタム TURN サーバー、IP プロキシ機能、および IP ホワイトリスト機能に関する設定が含まれます。

パラメータ : | | | | --- | --- | | apikey | OpenTok プロジェクトの API キー。詳細については Vonage Video APIのAccountページをご覧ください. | | session_id | セッション ID。 | | callbacks | otc_session_callbacks セッションに関連するイベントのコールバック関数を含む構造体。 | | 設定 | 以下の otc_session_settings struct セッションの詳細設定。 |

返品 : ザ struct、OpenTokセッションを表すものです。

関連項目 ： otc_session_new.

otc_session_publish()
otc_status otc_session_publish ( otc_session * セッション,
otc_publisher * 出版社
)

セッションへのパブリッシャーのストリーミングを開始します。

パラメータ : | | | | --- | --- | | session | The otc_session パブリッシュ先の OpenTok セッションを表す構造体。 | | publisher | The otc_publisher パブリッシャーを表す構造体。 |

戻り値 : エラーか成功かを示す戻り値。

otc_session_report_issue()
otc_status otc_session_report_issue ( struct otc_session * セッション,
const char * 問題の説明,
char ** issue_id
)

アプリで問題が発生したことを報告してください。問題IDは、 インスペクター ツールを使用する際や、Vonage Video API サポートチームと問題について話し合う際。

パラメータ : | | | | --- | --- | | session | The otc_session OpenTokセッションを表す構造体。 | | issue_description | 説明文字列。 | | issue_id | 報告された問題の一意の識別子として設定される文字列へのポインタ。 |

戻り値 : エラーか成功かを示す戻り値。

otc_session_send_signal()
otc_status otc_session_send_signal ( otc_session * セッション,
const char * タイプ,
const char * 信号
)

そのセッションに接続しているすべてのクライアントに信号を送信します。詳しくは otc_session_send_signal_with_options, otc_session_send_signal_to_connectionそして otc_session_send_signal_to_connection_with_options. 以下の項目も参照してください。 シグナリングの概要.

パラメータ : | | | | --- | --- | | session | The otc_session OpenTokセッションを表す構造体。 | | type | シグナルのオプションの型文字列値。 | | signal | シグナルのオプションのデータ文字列値。 |

戻り値 : エラーか成功かを示す戻り値。

otc_session_send_signal_to_connection()
otc_status otc_session_send_signal_to_connection ( otc_session * セッション,
const char * タイプ,
const char * 信号,
const otc_connection * 接続
)

そのセッションに接続している特定のクライアントにシグナルを送信します。詳しくは otc_session_send_signal_to_connection_with_options, otc_session_send_signalそして otc_session_send_signal_with_options. 以下の項目も参照してください。 シグナリングの概要.

パラメータ : | | | | --- | --- | | session | The otc_session OpenTokセッションを表す構造体。 | | type | シグナルのオプションの型文字列値。 | | signal | シグナルのオプションのデータ文字列値。 | | connection | otc_connection シグナルを受信するクライアントに対応する構造体。 |

戻り値 : エラーか成功かを示す戻り値。

otc_session_send_signal_to_connection_with_options()
otc_status otc_session_send_signal_to_connection_with_options ( otc_session * セッション,
const char * タイプ,
const char * 信号,
const otc_connection * 接続,
struct otc_signal_options signal_options
)

指定したオプションを指定して、特定のクライアントにシグナルを送信します。詳しくは otc_session_send_signal, otc_session_send_signal_to_connectionそして otc_session_send_signal_with_options. 以下の項目も参照してください。 シグナリングの概要.

パラメータ : | | | | --- | --- | | session | The otc_session OpenTokセッションを表す構造体。 | | type | シグナルのオプションの型文字列値。 | | signal | シグナルのオプションのデータ文字列値。 | | connection | otc_connection シグナルを受信するクライアントに対応する構造体。 | | signal_options | 以下の otc_signal_options シグナルに関するオプションを含む構造体。 |

戻り値 : エラーか成功かを示す戻り値。

otc_session_send_signal_with_options()
otc_status otc_session_send_signal_with_options ( otc_session * セッション,
const char * タイプ,
const char * 信号,
struct otc_signal_options signal_options
)

指定されたオプションとともに、そのセッションに接続しているすべてのクライアントにシグナルを送信します。詳しくは otc_session_send_signal, otc_session_send_signal_to_connectionそして otc_session_send_signal_to_connection_with_options. 以下の項目も参照してください。 シグナリングの概要.

パラメータ : | | | | --- | --- | | session | The otc_session OpenTokセッションを表す構造体。 | | type | シグナルのオプションの型文字列値。 | | signal | シグナルのオプションのデータ文字列値。 | | signal_options | otc_signal_options シグナルに関するオプションを含む構造体。 |

戻り値 : エラーか成功かを示す戻り値。

otc_session_set_encryption_secret()
otc_status otc_session_set_encryption_secret ( otc_session * セッション,
const char * シークレット
)

セッション内のすべてのパブリッシャーおよびサブスクライバーが使用するエンドツーエンド暗号化の秘密鍵を設定します。

参照 エンドツーエンド暗号化の開発者向けガイド.

パラメータ : | | | | | --- | --- | --- | | | session | The otc_session OpenTokセッションを表す構造体。 | | [in] | secret | 暗号化シークレットの値。 |

戻り値 : エラーか成功かを示す戻り値。

otc_session_settings_delete()
otc_status otc_session_settings_delete ( otc_session_settings * 設定 )

を削除します otc_session_settings インスタンスだ。

otc_session_settings_new()
otc_session_settings * otc_session_settings_new ( void )

新しいものを生成します otc_session_settings インスタンス。高度なセッション設定を行うために使用されます。以下の関数を呼び出してこれらの設定を構成してから、 otc_session_new_with_settings これらの設定でセッションを作成する関数：

  • otc_session_settings_set_connection_events_suppressed — 接続イベントを抑制する。
  • otc_session_settings_set_custom_ice_config &mdash カスタム TURN サーバーを使用する。
  • otc_session_settings_set_proxy_url — IPプロキシ機能を設定します。
  • otc_session_settings_set_ip_whitelist — IPホワイトリスト機能を有効にします。
  • otc_session_settings_set_single_peer_connection — 「シングルピア接続」機能を有効にします。
  • otc_session_settings_set_session_migration — 「セッション移行」機能を有効にします。

otc_session_settings_set_connection_events_suppressed()
otc_status otc_session_settings_set_connection_events_suppressed ( otc_session_settings * 設定,
otc_bool 抑制する
)

大規模なインタラクティブ動画セッションに対応するため、接続イベントを無効にします。これにより、以下の現象を防ぎます。 otc_session_callbacks.on_connection_created そして otc_session_callbacks.on_connection_dropped 他のクライアントがセッションに接続したり、セッションから切断したりした際に、コールバック関数が呼び出されないようにします。（また、OpenTokサーバーはこれらのイベントをクライアントに送信しません。）詳細については、以下を参照してください。 接続イベントの抑制 OpenTokの開発者向けガイド内。

otc_session_settings_set_custom_ice_config()
otc_status otc_session_settings_set_custom_ice_config ( otc_session_settings * 設定,
const struct otc_custom_ice_config * custom_ice_config
)

ICEサーバーのカスタム設定を有効にします。これは、 設定可能なTURN機能.

otc_session_settings_set_ip_whitelist()
otc_status otc_session_settings_set_ip_whitelist ( otc_session_settings * 設定,
otc_bool ip_whitelist
)

クライアントにIPアドレスのホワイトリストを使用させるには、OTC_TRUEを渡してください。 この機能 アドオン機能として利用可能です。

otc_session_settings_set_proxy_url()
otc_status otc_session_settings_set_proxy_url ( otc_session_settings * 設定,
const char * proxy_url
)

IPプロキシのURLを設定します。詳しくは、 IPプロキシ開発者ガイド.

otc_session_settings_set_session_migration()
otc_status otc_session_settings_set_session_migration ( otc_session_settings * 設定,
otc_bool 有効にする
)

セッションのセッション移行を有効または無効にします。

セッション移行機能を有効にし、サーバーのローテーション中もクライアントが接続を維持できるようにします。デフォルト値は false （セッションの移行は有効になっていません）。詳細については、以下を参照してください。 サーバーのローテーションとセッションの移行.

パラメータ : | | | | --- | --- | | settings | セッション設定オブジェクトへのポインタ。 | | enable | セッション移行を有効（OTC_TRUE）または無効（OTC_FALSE）にするためのブール値フラグ。 |

戻り値 : otc_status 操作のステータスを返します。

otc_session_settings_set_single_peer_connection()
otc_status otc_session_settings_set_single_peer_connection ( otc_session_settings * 設定,
otc_bool 有効にする
)

セッションのシングル・ピア・接続（SPC）を有効または無効にします。

シングル・ピア・コネクション（SPC）は、すべての加入者接続を単一のピア接続にカプセル化する機能です。SPCを有効にするメリットとしては、OSリソースの消費削減、レート制御の改善、およびモバイルネイティブデバイスにおける大規模なセッションへの対応などが挙げられます。

SPCはデフォルトで無効になっています。無効にしている場合、セッションではMPC（Multiple Peer Connection）が使用され、各エンドポイント間で個別のピア接続が確立されます。

パラメータ : | | | | --- | --- | | settings | セッション設定オブジェクトへのポインタ。 | | enable | SPCを有効（OTC_TRUE）または無効（OTC_FALSE）にするためのブール値フラグ。 |

戻り値 : otc_status 操作のステータスを返します。

otc_session_subscribe()
otc_status otc_session_subscribe ( otc_session * セッション,
otc_加入者 * 契約者
)

このセッションにおいて、サブスクライバーのオーディオ・ビデオストリームの購読（ストリームの受信）を開始します。

パラメータ : | | | | --- | --- | | session | The otc_session 加入者のストリームを含む OpenTok セッションを表す構造体。 | | subscriber | The otc_subscriber 加入者を表す構造体。 |

戻り値 : エラーか成功かを示す戻り値。

otc_session_unpublish()
otc_status otc_session_unpublish ( otc_session * セッション,
otc_publisher * 出版社
)

セッションからパブリッシャーを削除します（これにより、そのストリームが停止します）。

パラメータ : | | | | --- | --- | | session | The otc_session 公開を解除するOpenTokセッションを表す構造体。 | | publisher | The otc_publisher パブリッシャーを表す構造体。 |

戻り値 : エラーか成功かを示す戻り値。

otc_session_unsubscribe()
otc_status otc_session_unsubscribe ( otc_session * セッション,
otc_加入者 * 契約者
)

セッション内の指定されたサブスクライバーへのサブスクリプション（ストリームの受信）を停止します。

パラメータ : | | | | --- | --- | | session | The otc_session 加入者のストリームを含む OpenTok セッションを表す構造体。 | | subscriber | The otc_subscriber 加入者を表す構造体。 |

戻り値 : エラーか成功かを示す戻り値。