ホーム › System.RemoteDesktop › IAudioEndpoint

IAudioEndpoint

COM

📘 Microsoft Learn (日本語) · English

IID30a99515-1527-4451-af9f-00c5f0234daf継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

オーディオエンドポイントに関する情報をオーディオエンジンに提供します。このインターフェイスはオーディオエンドポイントによって実装されます。

解説(Remarks)

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

メソッド 5

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

vtbl 3 HRESULT GetFrameFormat(WAVEFORMATEX** ppFormat)

オーディオエンドポイントのフォーマットを取得します。

ppFormat

WAVEFORMATEX**

out

オーディオエンドポイントが表すデバイスのフォーマット情報を格納する WAVEFORMATEX 構造体へのポインターを受け取ります。実装は CoTaskMemAlloc を使用して構造体のメモリを割り当てる必要があります。呼び出し元は CoTaskMemFree を使用してバッファーを解放する必要があります。CoTaskMemAlloc および CoTaskMemFree の詳細については、Windows SDK のドキュメントを参照してください。

戻り値

メソッドが成功した場合は S_OK を返します。

解説(Remarks)

このメソッドをリアルタイム処理スレッドから呼び出してはなりません。

vtbl 4 HRESULT GetFramesPerPacket(DWORD* pFramesPerPacket)

エンドポイントの周期とサンプルレートに基づいて、オーディオエンドポイントがサポートできるパケットあたりの最大フレーム数を取得します。

pFramesPerPacket

DWORD*

out

エンドポイントがサポートできるパケットあたりの最大フレーム数を受け取ります。

戻り値

メソッドが成功した場合は S_OK を返します。

vtbl 5 HRESULT GetLatency(LONGLONG* pLatency)

オーディオエンドポイントのレイテンシを取得します。

pLatency

LONGLONG*

out

オーディオエンドポイントによってストリームに追加されるレイテンシを受け取る HNSTIME 変数へのポインター。

戻り値

メソッドが成功した場合は S_OK を返します。

解説(Remarks)

エンドポイントには、入出力 (I/O) 転送 (再生またはキャプチャ) 用に既にコミットされたデータよりバッファーが先行できるように、いくらかのレイテンシがあります。たとえば、オーディオエンドポイントが I/O 転送に先行するために 5 ミリ秒のバッファーを使用している場合、このメソッドが返すレイテンシは 5 ミリ秒です。

このメソッドをリアルタイム処理スレッドから呼び出してはなりません。

vtbl 6 HRESULT SetStreamFlags(DWORD streamFlags)

オーディオエンドポイントにストリーム構成フラグを設定します。

streamFlags

DWORD

1 つ以上の AUDCLNT_STREAMFLAGS_XXX 定数のビットごとの OR。

戻り値

メソッドが成功した場合は S_OK を返します。

解説(Remarks)

このメソッドをリアルタイム処理スレッドから呼び出してはなりません。

vtbl 7 HRESULT SetEventHandle(HANDLE eventHandle)

バッファーの処理が完了したことを通知するためにエンドポイントが使用するイベントのハンドルを設定します。

eventHandle

HANDLE

バッファー完了コールバックを呼び出すために使用されるイベントハンドル。

戻り値

メソッドが成功した場合は S_OK を返します。失敗した場合、返される可能性のあるコードには、以下のものが含まれますが、これらに限定されません。

解説(Remarks)

SetEventHandle メソッドは、エンドポイントにオーディオエンジンのイベントハンドルを設定します。この実装では、オーディオエンドポイントが初期化されていない場合、または SetBuffer メソッドによってバッファーが設定されていない場合、呼び出し元は AEERR_NOT_INITIALIZED というエラー応答を受け取ります。

イベント通知を受け取るには、オーディオエンジンがエンドポイントに AUDCLNT_STREAMFLAGS_EVENTCALLBACK フラグを設定しておく必要があります。このフラグを設定するには、オーディオエンジンは IAudioEndpoint::SetStreamFlags メソッドを呼び出します。

このメソッドをリアルタイム処理スレッドから呼び出してはなりません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IAudioEndpoint "{30A99515-1527-4451-AF9F-00C5F0234DAF}"
#usecom global IAudioEndpoint IID_IAudioEndpoint "{}"
#comfunc global IAudioEndpoint_GetFrameFormat      3 var
#comfunc global IAudioEndpoint_GetFramesPerPacket  4 var
#comfunc global IAudioEndpoint_GetLatency          5 var
#comfunc global IAudioEndpoint_SetStreamFlags      6 int
#comfunc global IAudioEndpoint_SetEventHandle      7 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IAudioEndpoint "{30A99515-1527-4451-AF9F-00C5F0234DAF}"
#usecom global IAudioEndpoint IID_IAudioEndpoint "{}"
#comfunc global IAudioEndpoint_GetFrameFormat      3 sptr
#comfunc global IAudioEndpoint_GetFramesPerPacket  4 sptr
#comfunc global IAudioEndpoint_GetLatency          5 sptr
#comfunc global IAudioEndpoint_SetStreamFlags      6 int
#comfunc global IAudioEndpoint_SetEventHandle      7 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。