IAudioClient::Stop メソッド (audioclient.h)
Stop メソッドは、オーディオ ストリームを停止します。
構文
HRESULT Stop();
戻り値
メソッドが成功してストリームを停止すると、S_OKが返されます。 メソッドが成功し、ストリームが既に停止されている場合、メソッドはS_FALSEを返します。 エラーが発生した場合、次の表に示す値が、可能なリターン コードに含まれますが、これらに限定されません。
| リターン コード | 説明 |
|---|---|
|
クライアントが正常に初期化されていません。 |
|
Windows オーディオ サービスが実行されていません。 |
注釈
このメソッドでは、 IAudioClient インターフェイスを事前に初期化する必要があります。 クライアントが IAudioClient::Initialize メソッドを正常に呼び出してオーディオ ストリームを初期化するまで、このメソッドの呼び出しはすべてエラー AUDCLNT_E_NOT_INITIALIZEDで失敗します。
Stop は、実行中のオーディオ ストリームを停止するコントロール メソッドです。 このメソッドは、オーディオ エンジンとのクライアントの接続を介してデータのストリーミングを停止します。 ストリームを停止すると、ストリームのオーディオ クロックが現在のストリーム位置でフリーズします。 後続の IAudioClient::Start の呼び出しにより、ストリームはその位置から実行を再開します。 必要に応じて、クライアントは IAudioClient::Reset メソッドを呼び出して、ストリームの停止中に位置をリセットできます。
Stop メソッドを呼び出すコード例については、次のトピックを参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ | UWP アプリ] |
| サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリ | UWP アプリ] |
| 対象プラットフォーム | Windows |
| ヘッダー | audioclient.h |