OpenTok パブリッシャー。 続きを読む...

#include "config.h" #include "stream.h" #include "video_frame.h" #include "audio_data.h" #include "camera_capture_resolution.h" #include "media_transformer.h" #include "video_capturer.h"

詳細な説明

OpenTok パブリッシャー。

このファイルには、OpenTokパブリッシャーの型定義と、いくつかの関数の宣言が含まれています。

Typedef のドキュメント

otc_publisher

OpenTokのパブリッシャータイプの定義。

OpenTokセッションへのオーディオ・ビデオストリームの配信元を表す型。

otc_publisher_settings

OpenTok パブリッシャー設定のタイプ定義。

列挙型のドキュメント

otc_publisher_error_code

OpenTokパブリッシャー向けのエラーコード一覧。

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

otc_publisher_video_type

パブリッシャーの動画タイプの列挙。

この列挙は、サポートされているさまざまな動画形式を表しています。

otc_video_bitrate_preset

パブリッシャーのストリームにおける動画ビットレートを制御するためのプリセット戦略。

これらのプリセットを使用することで、開発者は手動でビットレートを指定することなく、帯域幅戦略を適用することができます。プリセットは、手動によるビットレート設定とは互いに排他的です。

詳しくは パブリッシャー最大ビットレート.

関数のドキュメント

otc_publisher_delete()

パブリッシャーインスタンスを解放します。これには、そのインスタンスにバインドされているすべてのハードウェアリソースも含まれます。

パラメータ : | | | | --- | --- | | publisher | 削除対象のパブリッシャーインスタンス。 |

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

otc_publisher_get_audio_fallback_enabled()

パブリッシャーのオーディオフォールバック機能が有効かどうかを返します。詳しくは、 otc_publisher_set_audio_fallback_enabled 関数である。

この関数は非推奨です。

パラメータ : | | | | --- | --- | | publisher | パブリッシャーインスタンス。 |

戻り値 : パブリッシャーのオーディオフォールバック機能が有効か無効かを示します。

otc_publisher_get_max_video_bitrate()

このパブリッシャーの動画ストリームに設定されている最大動画ビットレートを取得します。

現在設定されている動画の最大ビットレートを、ビット毎秒（bps）単位で返します。もし otc_publisher_set_max_video_bitrate()、またはプリセット（デフォルトを含む）が有効な場合、この関数は 0 を返します。

注： 戻り値が 0 の場合は、明示的なビットレート制限が適用されておらず、代わりにプリセットに基づく動作が使用されていることを示します。

パラメータ : | | | | | --- | --- | --- | | [in] | publisher | パブリッシャーインスタンス。 |

戻り値 : 現在の最大ビデオビットレート（ビット/秒）。手動で設定されていない場合は 0 を返します。

otc_publisher_get_name()

指定されたパブリッシャーの名前を取得します。

パラメータ : | | | | --- | --- | | publisher | パブリッシャーインスタンス。 |

戻り値 : 名前。

otc_publisher_get_publish_audio()

パブリッシャーがオーディオを配信しているかどうかを返します。

パラメータ : | | | | --- | --- | | publisher | パブリッシャーインスタンス。 |

Returns : パブリッシャーがオーディオを配信しているかどうか。

otc_publisher_get_publish_captions()

パブリッシャーでキャプションが有効になっているかどうかを返します。

パラメータ : | | | | --- | --- | | publisher | パブリッシャーインスタンス。 |

返り値 : パブリッシャーでキャプションが有効になっているかどうか。

otc_publisher_get_publish_video()

パブリッシャーが動画を配信しているかどうかを返します。

パラメータ : | | | | --- | --- | | publisher | パブリッシャーインスタンス。 |

Returns : パブリッシャーが動画を配信しているかどうか。

otc_publisher_get_publisher_id()

パブリッシャーの固有識別子を取得します。

パラメータ : | | | | --- | --- | | publisher | パブリッシャーインスタンス。 |

戻り値 : パブリッシャーの固有識別子。エラーが発生した場合は、null になります。

otc_publisher_get_rtc_stats_report()

パブリッシャーのRTC統計レポートを取得します。これは非同期操作です。 otc_publisher_rtc_stats_report_cb 構造体に渡す。 otc_publisher_set_rtc_stats_report_cb この関数を呼び出す前に、function を実行してください。統計情報が利用可能になると、 otc_publisher_set_rtc_stats_report_cb コールバック関数が呼び出される。

こちらも参照 otc_publisher_callbacks.on_audio_stats, otc_publisher_callbacks.on_video_statsそして otc_subscriber_get_rtc_stats_report.

パラメータ : | | | | --- | --- | | 発行元 | 発行元。 |

otc_publisher_get_session()

次の値を返します。 otc_session このパブリッシャーインスタンスに関連付けられました。

パラメータ : | | | | --- | --- | | publisher | パブリッシャーインスタンス。 |

返品 : ザ otc_session このインスタンスに関連付けられています。エラーがある場合は、null になります。

otc_publisher_get_stream()

パブリッシャーに関連付けられたストリームを返します。

パラメータ : | | | | --- | --- | | publisher | ストリームを取得するパブリッシャーインスタンス。 |

戻り値 : パブリッシャーに関連付けられたストリーム。エラーが発生した場合は、null になります。

otc_publisher_get_user_data()

指定されたパブリッシャーのユーザーデータを取得します。

パラメータ : | | | | --- | --- | | publisher | パブリッシャーインスタンス。 |

戻り値 : メモリ内のユーザーデータへのポインタ。

otc_publisher_get_video_bitrate_preset()

このパブリッシャーのストリームについて、現在有効になっている動画ビットレートのプリセットを取得します。

以前に、以下のコマンドを使用してカスタムビットレートを設定していた場合 otc_publisher_set_max_video_bitrate(), このメソッドは OTC_VIDEO_BITRATE_PRESET_CUSTOM を返します。

パラメータ : | | | | | --- | --- | --- | | [in] | publisher | パブリッシャーインスタンス。 |

戻り値 : アクティブなビットレートのプリセット。

otc_publisher_get_video_type()

パブリッシャーの動画タイプを取得します。詳しくは、 otc_publisher_set_video_type 関数である。

パラメータ : | | | | --- | --- | | publisher | パブリッシャーインスタンス。 |

戻り値 : パブリッシャーの動画タイプ。

otc_publisher_new()

新しい otc_publisher インスタンスを作成します。

パラメータ : | | | | --- | --- | | name | パブリッシャーの名前。他のクライアントは、セッション内のストリームの名前を取得できます。 | | capturer | カスタムビデオキャプチャ機能を提供する場合にこのパラメータを使用します。null に設定された場合、パブリッシャーはシステムのカメラを使用するデフォルトのビデオキャプチャ機能を使用します。 | | callbacks | パブリッシャーのコールバック関数ポインタを含む構造体へのポインタ。 |

戻り値 : 新しい otc_publisher インスタンス。エラーが発生した場合は null になります。

otc_publisher_new_with_settings()

新しい otc_publisher インスタンスを作成します。

パラメータ : | | | | --- | --- | | callbacks | パブリッシャーのコールバック関数ポインタを含む構造体へのポインタ。 | | settings | パブリッシャーに適用する設定を含む設定構造体。 |

戻り値 : 新しい otc_publisher インスタンス。エラーが発生した場合は null になります。

otc_publisher_set_audio_fallback_enabled()

加入者向けオーディオ・フォールバック機能を有効または無効にします。

オーディオ・フォールバック機能は、OpenTok Media Router を使用するセッションで利用可能です。オーディオ・フォールバック機能が有効になっている場合（デフォルト設定）、OpenTok Media Router が、特定のストリーム加入者に対してストリームの品質が著しく低下したと判断すると、音声品質を維持するために、その加入者のビデオを無効にします。

オーディオ・フォールバック機能を無効にするには、 otc_publisher_set_audio_fallback_enabled 関数を呼び出す前に（OTC_FALSE を引数として渡して）、 otc_session_publish 関数である。

この関数は非推奨です。詳しくは otc_publisher_settings_set_subscriber_audio_fallback_enabled.

パラメータ : | | | | --- | --- | | publisher | 影響を受けるパブリッシャー。 | | enabled | オーディオフォールバック機能を有効にするかどうか。 |

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

otc_publisher_set_audio_transformers()

このパブリッシャーのオーディオストリームに、オーディオトランスフォーマーの配列を設定します。null を指定すると、トランスフォーマーがリセットされます。

この配列は、ml-library が提供する vonage オーディオトランスフォーマーや、カスタムトランスフォーマーで構成することができます。トランスフォーマーには、各オーディオフレームごとに呼び出されるコールバックへのポインタが含まれています。

注： この機能は、Vonage Video API macOS SDKにのみ適用されます。Vonage Video API Linux SDKでは動作しません。

パラメータ : | | | | | --- | --- | --- | | [in] | publisher | パブリッシャーのインスタンス。 | | [in] | transformers | ストリームに適用される順序で並んだ、otc_audio_transformer への不透明ポインタの配列。 | | [in] | size | 配列のサイズ。 |

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

otc_publisher_set_max_audio_bitrate()

パブリッシャーのオーディオ最大ビットレートを設定します。

パラメータ : | | | | --- | --- | | publisher | 影響を受けるパブリッシャー。 | | bitrate | 希望するビットレート（kbps）。 |

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

otc_publisher_set_max_video_bitrate()

このパブリッシャーの動画ストリームに設定されている最大動画ビットレートを取得します。

現在の最大ビデオビットレートをビット毎秒（bps）単位で返します。もし otc_publisher_set_max_video_bitrate()、またはビットレートのプリセット（デフォルトのプリセットを含む）が有効な場合、この関数は 0 を返します。

注： 戻り値が 0 の場合は、手動によるビットレートの上限設定が適用されておらず、ストリームが事前設定された構成で動作していることを示します。

パラメータ : | | | | | --- | --- | --- | | [in] | publisher | パブリッシャーインスタンス。 |

戻り値 : 現在の最大ビデオビットレート（ビット/秒）。設定されていない場合やプリセットが使用されている場合は 0 を返します。

otc_publisher_set_publish_audio()

音声を配信するかどうか。デフォルトでは、ストリームは音声と動画の両方を配信します。

パラメータ : | | | | --- | --- | | publisher | 影響を受けるパブリッシャー。 | | publish_audio | オーディオを公開するかどうか。 |

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

otc_publisher_set_publish_captions()

キャプションを有効にするかどうか。デフォルトでは無効になっています。

パラメータ : | | | | --- | --- | | publisher | 影響を受けるパブリッシャー。 | | publish_captions | キャプションを有効にするかどうか。 |

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

otc_publisher_set_publish_video()

動画を配信するかどうか。デフォルトでは、ストリームは音声と動画の両方を配信します。

パラメータ : | | | | --- | --- | | publisher | 影響を受けるパブリッシャー。 | | publish_video | 動画を公開するかどうか。 |

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

otc_publisher_set_rtc_stats_report_cb()

パブリッシャーに対して、RTC 統計レポートのコールバックを設定します。

パラメータ : | | | | --- | --- | | publisher | パブリッシャーインスタンス。 | | cb | otc_publisher_rtc_stats_report_cb RTC統計レポート用のコールバック関数を含む構造体。 |

関連項目 ： otc_publisher_get_rtc_stats_report.

otc_publisher_set_video_bitrate_preset()

このパブリッシャーの動画ストリームに対して、動画ビットレートのプリセットを設定します。

あらかじめ定義された動画ビットレート戦略を適用し、エンコーダの動作を制御します。これらのプリセットは、Applicationsのニーズに応じて、動画の画質と帯域幅の使用量のバランスをとることを目的としています。

注： プリセット「OTC_VIDEO_BITRATE_PRESET_CUSTOM」は直接設定できません。以下の関数を呼び出すと、 otc_publisher_set_max_video_bitrate() これによりプリセットが上書きされ、プリセットのゲッターが OTC_VIDEO_BITRATE_PRESET_CUSTOM を返すようになります。

パラメータ : | | | | | --- | --- | --- | | [in] | publisher | パブリッシャーインスタンス。 | | [in] | preset | 以下の値のいずれか otc_video_bitrate_preset 応募するには。 |

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

otc_publisher_set_video_transformers()

このパブリッシャーのビデオストリームに、ビデオトランスフォーマーの配列を設定します。null を指定すると、トランスフォーマーがリセットされます。

この配列は、ml-library が提供する vonage ビデオトランスフォーマーや、カスタムトランスフォーマーで構成することができます。トランスフォーマーには、各ビデオフレームごとに呼び出されるコールバックへのポインタが含まれています。

注： この機能は、Vonage Video API macOS SDKにのみ適用されます。Vonage Video API Linux SDKでは動作しません。

パラメータ : | | | | | --- | --- | --- | | [in] | publisher | パブリッシャーインスタンス。 | | [in] | transformers | ストリームに適用される順序で並んだ、otc_video_transformer への不透明ポインタの配列。 | | [in] | size | 配列のサイズ。 |

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

otc_publisher_set_video_type()

パブリッシャーの動画タイプを設定します。デフォルトでは、動画のタイプは OTC_PUBLISHER_VIDEO_TYPE_CAMERA に設定されています（動画のソースがカメラであることを示します）。動画のソースが画面共有であることを示すには、これを OTC_PUBLISHER_VIDEO_TYPE_SCREEN に設定してください。 他のクライアントは、セッション内のストリームの動画タイプを検知できます（動画ソースの種類を判別するため）。

パラメータ : | | | | --- | --- | | publisher | 影響を受けるパブリッシャー。 | | video_type | パブリッシャーの動画タイプ。 |

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

otc_publisher_settings_delete()

otc_publisher_settings インスタンスを削除します。

パラメータ : | | | | --- | --- | | settings | 削除対象の otc_publisher_settings インスタンス。 |

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

otc_publisher_settings_new()

新しい `otc_publisher_settings` インスタンスを作成します。

戻り値 : 新しい otc_publisher_settings インスタンス

otc_publisher_settings_set_allow_audio_capture_while_muted()

いつ otc_publisher_settings_set_allow_audio_capture_while_muted に設定されている。 false、すべてのパブリッシャーが音声をミュートすると、マイクは自動的にオフになります。少なくとも1人のパブリッシャーがミュートを解除すると、マイクは自動的に再びオンになります。設定が true, すべてのパブリッシャーがオーディオをミュートしている場合でも、マイクは常にオン状態のままになります。マイクがオフになっている場合、パブリッシャーに対して audio_level や audio_data などのコールバックは呼び出されなくなる点に注意してください。デフォルト値は true.参照 otc_session_new_with_settings.

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

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

otc_publisher_settings_set_audio_track()

パブリッシャーのオーディオトラックを以下を使用して構築できるようにします otc_publisher_new_with_settings.

パラメータ : | | | | --- | --- | | settings | 対象となる otc_publisher_settings インスタンス。 | | enabled | パブリッシャーの構築時にオーディオトラックを生成するかどうかを有効／無効にする。 otc_publisher_new_with_settings. |

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

otc_publisher_settings_set_auto_gain_control()

これにより、パブリッシャー向けのオーディオ自動ゲイン制御を以下のように構築できるようになります。 otc_publisher_new_with_settings.

Vonage Video APIのLinux SDKでは動作しません。

パラメータ : | | | | --- | --- | | settings | 対象となる otc_publisher_settings インスタンス。 | | enabled | 自動ゲイン制御を有効にするか（true、デフォルト）、無効にするか（false）。 |

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

otc_publisher_settings_set_default_camera_capture_resolution()

デフォルトの動画キャプチャ機能のカメラキャプチャ解像度を設定します。

カスタムビデオキャプチャ機能は、によって設定されたキャプチャ解像度を反映すべきではありません。 otc_publisher_settings_set_default_camera_capture_resolution、この機能はデフォルトの動画キャプチャ機能でのみ使用可能です。

パラメータ : | | | | --- | --- | | camera_capture_resolution | デフォルトのビデオキャプチャ機能におけるカメラのキャプチャ解像度。 | | settings | 影響を受ける otc_publisher_settings インスタンス。 |

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

otc_publisher_settings_set_disable_audio_processing()

いつ otc_publisher_settings_set_disable_audio_processing に設定されている。 true, 音響エコーキャンセル、自動ゲイン制御、およびノイズ抑制の個別の設定は無視され、音声は一切処理されません。デフォルト値は false.参照 otc_publisher_new_with_settings.

パラメータ : | | | | --- | --- | | settings | 対象となる otc_publisher_settings インスタンス。 | | enabled | オーディオ処理のサポートを有効にするか（true）、無効にするか（false、デフォルト）。 |

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

otc_publisher_settings_set_echo_cancellation()

以下の方法でパブリッシャーの音響エコーキャンセルを有効にします。 otc_publisher_new_with_settings.

注： この機能は、Vonage Video API macOS SDKにのみ適用されます。Vonage Video API Linux SDKでは動作しません。

パラメータ : | | | | --- | --- | | settings | 対象となる otc_publisher_settings インスタンス。 | | enabled | 音響エコーキャンセル機能を有効にするか（true、デフォルト）、無効にするか（false）。 |

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

otc_publisher_settings_set_name()

これを使用して作成されるパブリッシャーの希望する名前を設定します otc_publisher_new_with_settings.

パラメータ : | | | | --- | --- | | settings | 影響を受ける otc_publisher_settings インスタンス。 | | name | パブリッシャーの名前。他のクライアントは、セッション内のストリームの名前を取得できます。 |

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

otc_publisher_settings_set_noise_suppression()

以下の方法でパブリッシャのノイズ抑制を有効にします。 otc_publisher_new_with_settings.

注： この機能は、Vonage Video API macOS SDKにのみ適用されます。Vonage Video API Linux SDKでは動作しません。

パラメータ : | | | | --- | --- | | settings | 対象となる otc_publisher_settings インスタンス。 | | enabled | ノイズ抑制を有効にするか（true、デフォルト）、無効にするか（false）。 |

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

otc_publisher_settings_set_opus_dtx()

有効にする Opus DTX 出版社を構築するには、 otc_publisher_new_with_settings. Opus DTX を有効にすると、長時間の無音部分があるストリームにおいて、帯域幅の使用量を削減できます。

パラメータ : | | | | --- | --- | | settings | 対象となる otc_publisher_settings インスタンス。 | | enabled | Opus DTX サポートを有効にするか（true）、無効にするか（false、デフォルト）。 |

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

otc_publisher_settings_set_publisher_audio_fallback_enabled()

パブリッシャーのオーディオフォールバック機能を有効または無効にします。

パブリッシャーのオーディオフォールバック機能が有効になっている場合、パブリッシャーがストリームの品質が著しく低下したと判断すると、オーディオ品質を維持するためにビデオストリームを無効にし、オーディオストリームの送信を継続します。このパブリッシャーに対応するキャプチャ機能は無効化されず、キャプチャされたフレームは引き続きパブリッシャー側で確認できます。

デフォルト設定は OTC_FALSE です（オーディオフォールバック機能は無効になっています）。OpenTok Media Server を使用するセッションでスクリーンビデオタイプを使用する場合、サブスクライバー側で映像が途切れないように、パブリッシャーのオーディオフォールバック設定はデフォルトで OTC_FALSE に設定されています。

パラメータ : | | | | --- | --- | | settings | 影響を受けるパブリッシャーの設定。 | | enabled | オーディオフォールバック機能を有効にするかどうか。 |

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

otc_publisher_settings_set_scalable_screenshare()

スケーラブルビデオの使用を許可する スケーラブルビデオ 次のような出版社にとっては、 otc_publisher_video_type に設定する。 OTC_PUBLISHER_VIDEO_TYPE_SCREEN と otc_publisher_new_with_settings.

パラメータ : | | | | --- | --- | | settings | 対象となる otc_publisher_settings インスタンス。 | | enabled | 画面共有ストリームでのスケーラブルビデオの使用を有効／無効にします。 |

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

otc_publisher_settings_set_stereo()

パブリッシャーでステレオオーディオを構築できるようにします。 otc_publisher_new_with_settings.

パラメータ : | | | | --- | --- | | settings | 対象となる otc_publisher_settings インスタンス。 | | enabled | 構築されるパブリッシャーのステレオオーディオサポートを有効／無効にする。 otc_publisher_new_with_settings. |

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

otc_publisher_settings_set_subscriber_audio_fallback_enabled()

サブスクライバーのオーディオフォールバック機能を有効または無効にします（公開されたストリームのサブスクライバー向け）

加入者向けオーディオフォールバック機能は、OpenTok Media Router を使用するセッションで利用可能です。 オーディオフォールバック機能が有効になっている場合（デフォルト設定）、OpenTok Media Router は、特定のサブスクライバーに対するストリームの品質が著しく低下したと判断すると、オーディオ品質を維持するために、そのサブスクライバーのビデオを無効にします。

デフォルト設定は OTC_TRUE です（オーディオフォールバック機能が有効になっています）。スクリーン動画タイプを使用する場合、加入者側のオーディオフォールバック設定はデフォルトで OTC_FALSE に設定されるため、加入者側で動画が途切れることはありません。

パラメータ : | | | | --- | --- | | settings | 影響を受けるパブリッシャーの設定。 | | enabled | オーディオフォールバック機能を有効にするかどうか。 |

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

otc_publisher_settings_set_video_capturer()

パブリッシャーのビデオキャプチャ機能を、以下を使用して構築するように設定します。 otc_publisher_new_with_settings.

パラメータ : | | | | --- | --- | | settings | 対象となる otc_publisher_settings インスタンス。 | | capturer | ビデオキャプチャ装置。 |

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

otc_publisher_settings_set_video_track()

パブリッシャーのビデオトラックを以下を使用して構築できるようにします。 otc_publisher_new_with_settings.

パラメータ : | | | | --- | --- | | settings | 対象となる otc_publisher_settings インスタンス。 | | enabled | パブリッシャー用に構築されるビデオトラックの有無を有効／無効にする otc_publisher_new_with_settings. |

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