#include <audio_device.h>
詳細な説明
この構造体には、オーディオデバイスで使用するコールバック関数への関数ポインタのセットが含まれています。SDKは、オーディオデバイスに関連するイベントが発生した際に、これらの関数を呼び出します。
すべてのコールバックは、アプリケーションやメインスレッド上ではなく、内部スレッド上で行われる。アプリケーションは、内部スレッドのブロックを避けるために、できるだけ早くコールバックを返すべきである。
コールバックに加え、この構造体には user_data ポインタが含まれており、このポインタはオーディオデバイスに関連するデータを設定できる場所を指しています。
現場記録
破壊する
| otc_bool(* 破棄) (const otc_audio_device *audio_device, void *ユーザーデータ) |
SDKがオーディオデバイスの破棄を要求した際に呼び出されます。
パラメータ : | | | | --- | --- | | audio_device | オーディオデバイスインスタンスへのポインタ。 | | user_data | オーディオデバイスに対して設定した user_data へのポインタ。 |
戻り値 : エラーか成功かを示すブール値。
関連項目 ： otc_bool
destroy_capturer
| otc_bool(* destroy_capturer) (const otc_audio_device *audio_device, void *ユーザーデータ) |
SDKによるオーディオのキャプチャが完了し、オーディオデバイスのオーディオキャプチャ機能を破棄するタイミングになったときに呼び出されます。
パラメータ : | | | | --- | --- | | audio_device | オーディオデバイスインスタンスへのポインタ。 | | user_data | オーディオデバイスに対して設定した user_data へのポインタ。 |
戻り値 : エラーか成功かを示すブール値。
関連項目 ： otc_bool
destroy_renderer
| otc_bool(* destroy_renderer) (const otc_audio_device *audio_device, void *ユーザーデータ) |
SDKによるオーディオのレンダリングが完了し、オーディオデバイス用のオーディオレンダラーを破棄するタイミングになったときに呼び出されます。
パラメータ : | | | | --- | --- | | audio_device | オーディオデバイスインスタンスへのポインタ。 | | user_data | オーディオデバイスに対して設定した user_data へのポインタ。 |
戻り値 : エラーか成功かを示すブール値。
関連項目 ： otc_bool
get_capture_settings
| otc_bool(* get_capture_settings) (const otc_audio_device *audio_device, void *ユーザーデータ, struct otc_audio_device_settings *設定) |
SDKがオーディオデバイスで使用されるオーディオキャプチャ設定を要求した際に呼び出されます。
パラメータ : | | | | --- | --- | | audio_device | オーディオデバイスインスタンスへのポインタ。 | | user_data | オーディオデバイスに対して設定した user_data へのポインタ。 | | settings | 設定を保持する構造体へのポインタ。 |
戻り値 : エラーか成功かを示すブール値。
関連項目 ： otc_bool
get_estimated_capture_delay
| int(* get_estimated_capture_delay) (const otc_audio_device *audio_device, void *ユーザーデータ) |
SDKがオーディオデバイスの推定キャプチャ遅延（単位：ms）を要求した際に呼び出されます。
パラメータ : | | | | --- | --- | | audio_device | オーディオデバイスインスタンスへのポインタ。 | | user_data | オーディオデバイスに対して設定した user_data へのポインタ。 |
戻り値 : 推定キャプチャ遅延（ミリ秒単位）。
get_estimated_render_delay
| int(* get_estimated_render_delay) (const otc_audio_device *audio_device, void *ユーザーデータ) |
SDKがオーディオデバイスの推定レンダリング遅延（単位：ミリ秒）を要求した際に呼び出されます。
パラメータ : | | | | --- | --- | | audio_device | オーディオデバイスインスタンスへのポインタ。 | | user_data | オーディオデバイスに対して設定した user_data へのポインタ。 |
戻り値 : レンダリングにかかる推定遅延（ミリ秒単位）。
get_render_settings
| otc_bool(* get_render_settings) (const otc_audio_device *audio_device, void *ユーザーデータ, struct otc_audio_device_settings *設定) |
SDKがデバイスで使用されるオーディオレンダリング設定を要求した際に呼び出されます。
パラメータ : | | | | --- | --- | | audio_device | オーディオデバイスインスタンスへのポインタ。 | | user_data | オーディオデバイスに対して設定した user_data へのポインタ。 | | settings | 設定を保持する構造体へのポインタ。 |
戻り値 : エラーか成功かを示すブール値。
関連項目 ： otc_bool
init
| otc_bool(* init) (const otc_audio_device *audio_device, void *ユーザーデータ) |
SDKがオーディオデバイスに対して初期化を要求した際に呼び出されます。
パラメータ : | | | | --- | --- | | audio_device | オーディオデバイスインスタンスへのポインタ。 | | user_data | オーディオデバイスに対して設定した user_data へのポインタ。 |
戻り値 : エラーか成功かを示すブール値。
関連項目 ： otc_bool
init_capturer
| otc_bool(* init_capturer) (const otc_audio_device *audio_device, void *ユーザーデータ) |
SDKがオーディオキャプチャ機能に対し、オーディオデバイスの初期化を要求した際に呼び出されます。
パラメータ : | | | | --- | --- | | audio_device | オーディオデバイスインスタンスへのポインタ。 | | user_data | オーディオデバイスに対して設定した user_data へのポインタ。 |
戻り値 : エラーか成功かを示すブール値。
関連項目 ： otc_bool
init_renderer
| otc_bool(* init_renderer) (const otc_audio_device *audio_device, void *ユーザーデータ) |
SDKがオーディオレンダリングのためにオーディオデバイスに初期化を要求した際に呼び出されます。
パラメータ : | | | | --- | --- | | audio_device | オーディオデバイスインスタンスへのポインタ。 | | user_data | オーディオデバイスに対して設定した user_data へのポインタ。 |
戻り値 : エラーか成功かを示すブール値。
関連項目 ： otc_bool
is_capturer_initialized
| otc_bool(* is_capturer_initialized) (const otc_audio_device *audio_device, void *ユーザーデータ) |
そのデバイスがオーディオサンプリング用に初期化されているかどうか。
パラメータ : | | | | --- | --- | | audio_device | オーディオデバイスインスタンスへのポインタ。 | | user_data | オーディオデバイスに対して設定した user_data へのポインタ。 |
戻り値 : デバイスが初期化されているかどうかを示すブール値。
関連項目 ： otc_bool
is_capturer_started
| otc_bool(* is_capturer_started) (const otc_audio_device *audio_device, void *ユーザーデータ) |
デバイスがオーディオサンプリングを開始したかどうか。
パラメータ : | | | | --- | --- | | audio_device | オーディオデバイスインスタンスへのポインタ。 | | user_data | オーディオデバイスに対して設定した user_data へのポインタ。 |
戻り値 : 処理が開始されたかどうかを示すブール値。
関連項目 ： otc_bool
is_renderer_initialized
| otc_bool(* is_renderer_initialized) (const otc_audio_device *audio_device, void *ユーザーデータ) |
そのデバイスがオーディオ再生用に初期化されているかどうか。
パラメータ : | | | | --- | --- | | audio_device | オーディオデバイスインスタンスへのポインタ。 | | user_data | オーディオデバイスに対して設定した user_data へのポインタ。 |
戻り値 : 初期化されているかどうかを示すブール値。
関連項目 ： otc_bool
is_renderer_started
| otc_bool(* is_renderer_started) (const otc_audio_device *audio_device, void *ユーザーデータ) |
デバイスがオーディオの再生を開始したかどうか。
パラメータ : | | | | --- | --- | | audio_device | オーディオデバイスインスタンスへのポインタ。 | | user_data | オーディオデバイスに対して設定した user_data へのポインタ。 |
戻り値 : 処理が開始されたかどうかを示すブール値。
関連項目 ： otc_bool
予約済み
| void* reserved |
内部実装に使用される、予約済みリソースが格納されているメモリ領域へのvoidポインタ。
start_capturer
| otc_bool(* start_capturer) (const otc_audio_device *audio_device, void *ユーザーデータ) |
SDKがオーディオデバイスに対してオーディオサンプルの取得を開始するよう要求した際に呼び出されます。
パラメータ : | | | | --- | --- | | audio_device | オーディオデバイスインスタンスへのポインタ。 | | user_data | オーディオデバイスに対して設定した user_data へのポインタ。 |
戻り値 : エラーか成功かを示すブール値。
関連項目 ： otc_bool
start_renderer
| otc_bool(* start_renderer) (const otc_audio_device *audio_device, void *ユーザーデータ) |
SDKがオーディオデバイスに対してオーディオのレンダリングを開始するよう要求した際に呼び出されます。
パラメータ : | | | | --- | --- | | audio_device | オーディオデバイスインスタンスへのポインタ。 | | user_data | オーディオデバイスに対して設定した user_data へのポインタ。 |
戻り値 : エラーか成功かを示すブール値。
関連項目 ： otc_bool
stop_capturer
| otc_bool(* stop_capturer) (const otc_audio_device *audio_device, void *ユーザーデータ) |
SDKがオーディオデバイスに対して、オーディオのサンプリングを停止するようオーディオキャプチャ機能に要求した際に呼び出されます。
パラメータ : | | | | --- | --- | | audio_device | オーディオデバイスインスタンスへのポインタ。 | | user_data | オーディオデバイスに対して設定した user_data へのポインタ。 |
戻り値 : エラーか成功かを示すブール値。
関連項目 ： otc_bool
stop_renderer
| otc_bool(* stop_renderer) (const otc_audio_device *audio_device, void *ユーザーデータ) |
SDKがオーディオデバイスに対してオーディオの再生を停止するよう要求した際に呼び出されます。
パラメータ : | | | | --- | --- | | audio_device | オーディオデバイスインスタンスへのポインタ。 | | user_data | オーディオデバイスに対して設定した user_data へのポインタ。 |
戻り値 : エラーか成功かを示すブール値。
関連項目 ： otc_bool
ユーザーデータ
| void* user_data |
オーディオデバイスに関連して設定したデータへのポインタ。