ホーム › Media.Audio › IAudioSessionManager
IAudioSessionManager
COM公式ドキュメント
IAudioSessionManager インターフェイスは、クロスプロセスおよびプロセス固有のオーディオセッションの両方について、クライアントがセッションコントロールおよびボリュームコントロールにアクセスできるようにします。
メソッド 2
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
vtbl 3 HRESULT GetAudioSessionControl(GUID* AudioSessionGuid, DWORD StreamFlags, IAudioSessionControl** SessionControl)
GetAudioSessionControl メソッドは、オーディオセッションコントロールを取得します。
| AudioSessionGuid | GUID* | inoptional | セッション GUID へのポインター。この GUID が以前に開かれたセッションを識別しない場合、この呼び出しは新しい空のセッションを開きます。Sndvol プログラムは、セッションに 1 つ以上のアクティブなストリームが含まれていない限り、そのセッションのボリュームレベルコントロールを表示しません。このパラメーターが NULL であるか、値 GUID_NULL を指している場合、メソッドはストリームを既定のセッションに割り当てます。 |
| StreamFlags | DWORD | in | オーディオストリームのフラグの状態を指定します。 |
| SessionControl | IAudioSessionControl** | out | メソッドがオーディオセッションコントロールオブジェクトの IAudioSessionControl インターフェイスへのポインターを書き込むポインター変数へのポインター。呼び出し側は、このインターフェイスが不要になった際に、インターフェイスの Release メソッドを呼び出して解放する責任があります。呼び出しが失敗した場合、*SessionControl は NULL になります。 |
戻り値
メソッドが成功した場合は S_OK を返します。失敗した場合、考えられる戻り値には、次の表に示す値が含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| オーディオストリームが正常に初期化されていません。 | |
| オーディオエンドポイントデバイスが取り外されたか、オーディオハードウェアまたは関連するハードウェアリソースが再構成、無効化、削除、あるいはその他の理由で使用できなくなりました。 | |
| Windows オーディオサービスが実行されていません。 | |
| パラメーター SessionControl が NULL です。 | |
|
メモリ不足です。 |
解説(Remarks)
このメソッドを呼び出すコード例については、Audio Events for Legacy Audio Applications を参照してください。
vtbl 4 HRESULT GetSimpleAudioVolume(GUID* AudioSessionGuid, DWORD StreamFlags, ISimpleAudioVolume** AudioVolume)
GetSimpleAudioVolume メソッドは、シンプルオーディオボリュームコントロールを取得します。
| AudioSessionGuid | GUID* | inoptional | セッション GUID へのポインター。この GUID が以前に開かれたセッションを識別しない場合、この呼び出しは新しい空のセッションを開きます。Sndvol プログラムは、セッションに 1 つ以上のアクティブなストリームが含まれていない限り、そのセッションのボリュームレベルコントロールを表示しません。このパラメーターが NULL であるか、値 GUID_NULL を指している場合、メソッドはストリームを既定のセッションに割り当てます。 |
| StreamFlags | DWORD | in | 要求がクロスプロセスセッションに対するものかどうかを指定します。セッションがクロスプロセスの場合は TRUE に設定します。セッションがクロスプロセスでない場合は FALSE に設定します。 |
| AudioVolume | ISimpleAudioVolume** | out | メソッドがオーディオボリュームコントロールオブジェクトの ISimpleAudioVolume インターフェイスへのポインターを書き込むポインター変数へのポインター。このインターフェイスは、現在のプロセスのシンプルオーディオボリュームコントロールを表します。呼び出し側は、このインターフェイスが不要になった際に、インターフェイスの Release メソッドを呼び出して解放する責任があります。Activate の呼び出しが失敗した場合、*AudioVolume は NULL になります。 |
戻り値
メソッドが成功した場合は S_OK を返します。失敗した場合、考えられる戻り値には、次の表に示す値が含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| オーディオストリームが正常に初期化されていません。 | |
| オーディオエンドポイントデバイスが取り外されたか、オーディオハードウェアまたは関連するハードウェアリソースが再構成、無効化、削除、あるいはその他の理由で使用できなくなりました。 | |
| Windows オーディオサービスが実行されていません。 | |
| パラメーター AudioVolume が NULL です。 | |
|
メモリ不足です。 |
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
出力引数:
#define global IID_IAudioSessionManager "{BFA971F1-4D5E-40BB-935E-967039BFBEE4}" #usecom global IAudioSessionManager IID_IAudioSessionManager "{}" #comfunc global IAudioSessionManager_GetAudioSessionControl 3 var,int,sptr #comfunc global IAudioSessionManager_GetSimpleAudioVolume 4 var,int,sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IAudioSessionManager "{BFA971F1-4D5E-40BB-935E-967039BFBEE4}" #usecom global IAudioSessionManager IID_IAudioSessionManager "{}" #comfunc global IAudioSessionManager_GetAudioSessionControl 3 sptr,int,sptr #comfunc global IAudioSessionManager_GetSimpleAudioVolume 4 sptr,int,sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。