ホーム › System.RemoteDesktop › IAudioInputEndpointRT

IAudioInputEndpointRT

COM

IID8026ab61-92b2-43c1-a1df-5c37ebd08d82継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

各処理パスの入力バッファーを取得します。

解説(Remarks)

IAudioInputEndpointRT のメソッドはリアルタイム処理スレッドから呼び出すことができます。このインターフェイスのメソッドの実装は、ブロックしたり、ページメモリにアクセスしたり、ブロックする可能性のあるシステムルーチンを呼び出したりしてはなりません。

リモートデスクトップサービス AudioEndpoint API はリモートデスクトップのシナリオで使用するためのものであり、クライアントアプリケーション向けではありません。

メソッド 3

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 void GetInputDataPointer(APO_CONNECTION_PROPERTY* pConnectionProperty, AE_CURRENT_POSITION* pAeTimeStamp)

オーディオエンジンがデータを読み取るバッファーへのポインターを取得します。

pConnectionProperty

APO_CONNECTION_PROPERTY*

inout

APO_CONNECTION_PROPERTY 構造体へのポインター。

呼び出し元は次のようにメンバー値を設定します。

pBuffer は NULL に設定します。
u32ValidFrameCount には、取得するデータポインターに必要なフレーム数を格納します。エンドポイントオブジェクトはこの情報をキャッシュしてはなりません。オーディオエンジンは処理のニーズに応じてこの数を変更することがあります。
u32BufferFlags は BUFFER_INVALID に設定します。

この呼び出しが正常に完了した場合、エンドポイントは次のようにメンバー値を設定しなければなりません。

pBuffer は、データが読み取られた有効なメモリを指します。u32BufferFlags メンバーに設定されたフラグによっては、無音が含まれる場合があります。
u32ValidFrameCount は変更しません。
u32BufferFlags は、データポインターに有効なデータが含まれている場合は BUFFER_VALID に、データポインターに無音データのみが含まれている場合は BUFFER_SILENT に設定します。バッファー内のデータは実際に無音である必要はありませんが、pBuffer で指定されるバッファーは、必要なフレーム数に一致するよう、u32ValidFrameCount に含まれるすべての無音フレームを保持できる必要があります。

pAeTimeStamp

AE_CURRENT_POSITION*

inout

バッファーにキャプチャされたデータのタイムスタンプを含む AE_CURRENT_POSITION 構造体へのポインター。このパラメーターは省略可能です。

解説(Remarks)

このメソッドは、エンジンへの入力として渡す必要のあるデータを含むバッファー pConnectionProperty->pBuffer へのポインターをエンドポイントから返します。データおよびバッファーポインターは、IAudioInputEndpointRT::ReleaseInputDataPointer メソッドが呼び出されるまで有効な状態を維持しなければなりません。エンドポイントオブジェクトは、要求された量の情報を設定し、有効なデータが存在しない場合は無音を挿入しなければなりません。エンドポイントオブジェクトが返すバッファーポインター pConnectionProperty->pBuffer は、フレームアラインされている必要があります。エンドポイントは、pConnectionProperty パラメーターで渡される接続プロパティに関連付けられた APO_CONNECTION_PROPERTY で利用可能となる場合がある追加の領域をサポートしません。

u32ValidFrameCount メンバーにゼロを渡すことは有効な要求です。この場合、入力ポインターは有効でなければなりませんが、エンドポイントはそこから読み取りを行いません。pConnectionProperty->u32ValidFrameCount の値は、エンドポイントがサポートする最大フレーム数以下でなければなりません。サポートされるフレーム数を取得するには、IAudioEndpoint::GetFramesPerPacket メソッドを呼び出します。

このメソッドはリアルタイム処理スレッドから呼び出すことができます。このメソッドの実装は、ブロックしたり、ページメモリにアクセスしたり、ブロックする可能性のあるシステムルーチンを呼び出したりしてはなりません。

vtbl 4 void ReleaseInputDataPointer(DWORD u32FrameCount, UINT_PTR pDataPointer)

取得したデータポインターを解放します。

u32FrameCount	DWORD	in	オーディオエンジンによって消費されたフレーム数。この数は、IAudioInputEndpointRT::GetInputDataPointer メソッドが pConnectionProperty->u32ValidFrameCount メンバーで返した値と同じでない場合があります。
pDataPointer	UINT_PTR	in	GetInputDataPointer メソッドによって取得され、pConnectionProperty->pBuffer メンバーで受け取ったバッファーへのポインター。

解説(Remarks)

ReleaseInputDataPointer は、オーディオエンジンが入力データポインターを必要としなくなったことをエンドポイントに通知するとともに、セッション中に使用されたフレーム数を示します。たとえば、ループバッファーを表すエンドポイントがオーディオエンジンの入力に接続されている場合、実際のフレーム数を使用して読み取りポインターを進めることができます。u32FrameCount がゼロの場合、これはクライアントが指定された入力バッファーのデータをまったく使用しなかったことを示します。u32FrameCount は、エンドポイントがサポートする最大フレーム数以下でなければなりません。サポートされるフレーム数を取得するには、オーディオエンジンが IAudioEndpoint::GetFramesPerPacket メソッドを呼び出します。

vtbl 5 void PulseEndpoint()

予約されています。(IAudioInputEndpointRT.PulseEndpoint)

解説(Remarks)

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IAudioInputEndpointRT "{8026AB61-92B2-43C1-A1DF-5C37EBD08D82}"
#usecom global IAudioInputEndpointRT IID_IAudioInputEndpointRT "{}"
#comfunc global IAudioInputEndpointRT_GetInputDataPointer      3 var,var
#comfunc global IAudioInputEndpointRT_ReleaseInputDataPointer  4 int,sptr
#comfunc global IAudioInputEndpointRT_PulseEndpoint            5
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IAudioInputEndpointRT "{8026AB61-92B2-43C1-A1DF-5C37EBD08D82}"
#usecom global IAudioInputEndpointRT IID_IAudioInputEndpointRT "{}"
#comfunc global IAudioInputEndpointRT_GetInputDataPointer      3 sptr,sptr
#comfunc global IAudioInputEndpointRT_ReleaseInputDataPointer  4 int,sptr
#comfunc global IAudioInputEndpointRT_PulseEndpoint            5
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。