OpenTokの加入者。 続きを読む...
#include "config.h"
#include "stream.h"
#include "error.h"
#include "video_frame.h"
#include "audio_data.h"
| データ構造 | |
| struct | otc_加入者_音声_統計 |
| struct | otc_加入者動画統計 |
| struct | otc_subscriber_rtc_stats_report_cb |
| struct | otc_subscriber_callbacks |
詳細な説明
OpenTokの加入者。
このファイルには、OpenTokのサブスクライバーの型定義と、いくつかの関数の宣言が含まれています。
Typedef のドキュメント
otc_加入者
OpenTokの加入者タイプの定義。
OpenTok セッション内のストリームからオーディオおよびビデオを消費する側を表す型。
列挙型のドキュメント
otc_加入者_エラーコード
| enum otc_加入者_エラーコード |
OpenTokの加入者向けエラーコード一覧。
この列挙は、加入者に関連するいくつかのエラーコードを表しています。
| 調査員 | |
|---|---|
| OTC_SUBSCRIBER_INTERNAL_ERROR | 購読中に内部エラーが発生しました。 |
| OTC_SUBSCRIBER_SESSION_DISCONNECTED | 接続が切断されたセッションで、ストリームの購読を試行しています。 |
| OTC_SUBSCRIBER_SERVER_CANNOT_FIND_STREAM | ストリームが存在しないため、サブスクライバーの作成に失敗しました。これは、ストリームがセッションから削除されたのと同時にサブスクライバーが作成された場合に発生することがあります。 |
| OTC_SUBSCRIBER_STREAM_LIMIT_EXCEEDED | クライアントは、同時ストリーム数の上限を超えているセッション内で、ストリームの購読を試みました。 |
| OTC_SUBSCRIBER_TIMED_OUT | 購読を試みた際にタイムアウトが発生しました。 |
| OTC_SUBSCRIBER_WEBRTC_ERROR | 加入者のWebRTC接続に失敗しました。 |
| OTC_SUBSCRIBER_PEER_CONNECTION_NOT_CONNECTED | ピア接続はまだ作成されていません、または接続されていません。 |
| OTC_SUBSCRIBER_DECRYPTION_INTERNAL_ERROR | パケットの復号中に内部エラーが発生しました |
| OTC_SUBSCRIBER_ENCRYPTION_SECRET_MISMATCH | パケットの復号中に発生した秘密鍵の不一致 |
| OTC_SUBSCRIBER_DECRYPTION_UNSUPPORTED_CODEC | 復号に使用するメディアコーデックがサポートされていません |
関数のドキュメント
otc_subscriber_delete()
| otc_status otc_subscriber_delete | ( | otc_加入者 * | 契約者 | ) |
サブスクライバーインスタンスを解放します。これには、そのインスタンスにバインドされているすべてのハードウェアおよびUIリソースが含まれます。
パラメータ : | | | | --- | --- | | subscriber | 削除対象の加入者。 |
戻り値 : エラーか成功かを示す戻り値。
otc_subscriber_get_audio_volume()
| otc_status otc_subscriber_get_audio_volume | ( | const otc_加入者 * | 契約者, |
| double * | ボリューム | ||
| ) |
加入者の音声音量（0～100）を返します。
デフォルト値は 100 です。
パラメータ : | | | | --- | --- | | subscriber | サブスクライバーのインスタンス。 | | volume | サブスクライバーのボリューム。 |
戻り値 : エラーか成功かを示す戻り値。
関連項目 ： otc_エラーコード
otc_subscriber_get_preferred_framerate()
| otc_status otc_subscriber_get_preferred_framerate | ( | const otc_加入者 * | 契約者, |
| float * | 優先フレームレート | ||
| ) |
サブスクライバーのストリームに推奨されるフレームレートを返します。
パラメータ : | | | | --- | --- | | subscriber | サブスクライバーインスタンス。 | | preferred_framerate | サブスクライバーに関連付けられた優先フレームレート。 |
戻り値 : エラーか成功かを示す戻り値。
関連項目 ： otc_エラーコード
otc_subscriber_get_preferred_resolution()
| otc_status otc_subscriber_get_preferred_resolution | ( | const otc_加入者 * | 契約者, |
| uint32_t * | 推奨幅, | ||
| uint32_t * | 推奨高さ | ||
| ) |
サブスクライバーのストリームに対して推奨される解像度を返します。
パラメータ : | | | | --- | --- | | subscriber | サブスクライバーのインスタンス。 | | preferred_width | サブスクライバーの推奨幅。 | | preferred_height | サブスクライバーの推奨高さ。 |
戻り値 : エラーか成功かを示す戻り値。
関連項目 ： otc_エラーコード
otc_subscriber_get_rtc_stats_report()
| otc_status otc_subscriber_get_rtc_stats_report | ( | const otc_加入者 * | 契約者 | ) |
サブスクライバーの RTC 統計レポートを取得します。これは非同期操作です。次の操作を作成します。 otc_subscriber_rtc_stats_report_cb 構造体に渡す。 otc_subscriber_set_rtc_stats_report_cb この関数を呼び出す前に、function を実行してください。統計情報が利用可能になると、 otc_subscriber_set_rtc_stats_report_cb コールバック関数が呼び出される。
こちらも参照 otc_subscriber_callbacks.on_audio_stats, otc_subscriber_callbacks.on_video_statsそして otc_publisher_get_rtc_stats_report.
パラメータ : | | | | --- | --- | | subscriber | 加入者。 |
otc_subscriber_get_session()
| otc_session * otc_subscriber_get_session | ( | const otc_加入者 * | 契約者 | ) |
次の値を返します。 otc_session このインスタンスに関連付けました。
パラメータ : | | | | --- | --- | | subscriber | サブスクライバーインスタンス。 |
返品
: ザ otc_session このインスタンスに関連付けられています。エラーが発生した場合は、null になることがあります。
otc_subscriber_get_stream()
| otc_stream * otc_subscriber_get_stream | ( | const otc_加入者 * | 契約者 | ) |
そのサブスクライバーに関連付けられたストリームを返します。
パラメータ : | | | | --- | --- | | subscriber | ストリームを取得するサブスクライバーインスタンス。 |
戻り値 : サブスクライバーに関連付けられたストリーム。エラーが発生した場合はnullになることがあります。
otc_subscriber_get_subscribe_to_audio()
サブスクライバーがストリームのオーディオを購読しているかどうかを返します。
パラメータ : | | | | --- | --- | | subscriber | サブスクライバーインスタンス。 |
戻り値 : サブスクライバーが当該ストリームのオーディオを購読しているかどうか。
otc_subscriber_get_subscribe_to_captions()
サブスクライバーがストリームのキャプションを購読しているかどうかを返します。
パラメータ : | | | | --- | --- | | subscriber | サブスクライバーインスタンス。 |
戻り値
: サブスクライバーが、そのストリームのキャプションを購読しているかどうか。デフォルト値は、そのストリームのパブリッシャーのキャプション値です。 otc_publisher_get_publish_captions
otc_subscriber_get_subscribe_to_video()
サブスクライバーがストリームの動画を購読しているかどうかを返します。
パラメータ : | | | | --- | --- | | subscriber | サブスクライバーインスタンス。 |
戻り値 : サブスクライバーが当該ストリームの動画を購読しているかどうか。
otc_subscriber_get_subscriber_id()
| const char * otc_subscriber_get_subscriber_id | ( | const otc_加入者 * | 契約者 | ) |
指定された加入者の一意の識別子を取得します。
パラメータ : | | | | --- | --- | | subscriber | サブスクライバーインスタンス。 |
戻り値 : サブスクライバーを一意に識別する識別子。エラーが発生した場合はnullになることがあります。
otc_subscriber_get_user_data()
| void * otc_subscriber_get_user_data | ( | const otc_加入者 * | 契約者 | ) |
指定された加入者のユーザーデータを取得します。
パラメータ : | | | | --- | --- | | subscriber | サブスクライバーインスタンス。 |
戻り値 : メモリ内のユーザーデータへのポインタ。
otc_subscriber_new()
| otc_加入者 * otc_subscriber_new | ( | const otc_stream * | ストリーム, |
| const struct otc_subscriber_callbacks * | コールバック | ||
| ) |
指定されたストリームに対して、新しいサブスクライバーを作成します。
パラメータ : | | | | --- | --- | | stream | 購読するストリームに対応する Stream オブジェクト。 | | callbacks | サブスクライバーのコールバック関数の関数ポインタを含む構造体。 |
戻り値 : 新しい Subscriber インスタンス。エラーが発生した場合は null になることがあります。
otc_subscriber_set_audio_volume()
| otc_status otc_subscriber_set_audio_volume | ( | otc_加入者 * | 契約者, |
| ダブル | ボリューム | ||
| ) |
加入者の音声音量を0から100の間で設定します。値がこの範囲外の場合は、この範囲内に制限されます。
パラメータ : | | | | --- | --- | | subscriber | サブスクライバーのインスタンス。 | | volume | サブスクライバーのボリューム。 |
戻り値 : エラーか成功かを示す戻り値。
関連項目 ： otc_エラーコード
otc_subscriber_set_preferred_framerate()
| otc_status otc_subscriber_set_preferred_framerate | ( | otc_加入者 * | 契約者, |
| float | 優先フレームレート | ||
| ) |
サブスクライバーのストリームに対して、推奨フレームレートを設定します。
デフォルト値は 100 です。
パラメータ : | | | | --- | --- | | subscriber | 影響を受けるサブスクライバーインスタンス。 | | preferred_framerate | サブスクライバーの優先フレームレート。 |
戻り値 : エラーか成功かを示す戻り値。
関連項目 ： otc_エラーコード
otc_subscriber_set_preferred_resolution()
| otc_status otc_subscriber_set_preferred_resolution | ( | otc_加入者 * | 契約者, |
| uint32_t | 推奨幅, | ||
| uint32_t | 推奨高さ | ||
| ) |
サブスクライバーのストリームに使用する優先解像度を設定します。
パラメータ : | | | | --- | --- | | subscriber | 影響を受けるサブスクライバーのインスタンス。 | | preferred_width | サブスクライバーの希望幅。 | | preferred_height | サブスクライバーの希望高さ。 |
戻り値 : エラーか成功かを示す戻り値。
関連項目 ： otc_エラーコード
otc_subscriber_set_rtc_stats_report_cb()
| otc_status otc_subscriber_set_rtc_stats_report_cb | ( | otc_加入者 * | 契約者, |
| struct otc_subscriber_rtc_stats_report_cb | cb | ||
| ) |
RTC 統計レポートのコールバックをサブスクライバーに設定します。otc_subscriber_get_rtc_stats_report を参照してください。
パラメータ : | | | | --- | --- | | subscriber | サブスクライバーインスタンス。 | | cb | otc_subscriber_rtc_stats_report_cb RTC統計レポート用のコールバック関数を含む構造体。 |
otc_subscriber_set_subscribe_to_audio()
| otc_status otc_subscriber_set_subscribe_to_audio | ( | otc_加入者 * | 契約者, |
| otc_bool | subscribe_to_audio | ||
| ) |
ストリームのオーディオを購読します。
パラメータ : | | | | --- | --- | | subscriber | 影響を受けるサブスクライバーインスタンス。 | | subscribe_to_audio | オーディオを購読するかどうか。 |
戻り値 : エラーか成功かを示す戻り値。
otc_subscriber_set_subscribe_to_captions()
| otc_status otc_subscriber_set_subscribe_to_captions | ( | otc_加入者 * | 契約者, |
| otc_bool | 字幕を購読する | ||
| ) |
そのストリームの字幕を購読します。
パラメータ : | | | | --- | --- | | subscriber | 影響を受けるサブスクライバーインスタンス。 | | subscribe_to_captions | キャプションを購読するかどうか。 |
戻り値 : エラーか成功かを示す戻り値。
otc_subscriber_set_subscribe_to_video()
| otc_status otc_subscriber_set_subscribe_to_video | ( | otc_加入者 * | 契約者, |
| otc_bool | subscribe_to_video | ||
| ) |
そのストリームの動画を購読します。
パラメータ : | | | | --- | --- | | subscriber | 影響を受けるサブスクライバーインスタンス。 | | subscribe_to_video | ビデオを購読するかどうか。 |
戻り値 : エラーか成功かを示す戻り値。