Share via

IXACT3Cue::GetState

  • [アーティクル]

キューの現在の動作状態を取得します。

[Content-driven]

HRESULT 
GetState(
  DWORD *pdwState
);

パラメータ

  • pdwState
    キューのステータスを示すフラグです。次のフラグがあります。

    値説明
    XACT_CUESTATE_CREATED作成済みですが、何も実行しません
    XACT_CUESTATE_PREPARING再生の準備中です
    XACT_CUESTATE_PREPARED準備済みですが、再生しません
    XACT_CUESTATE_PLAYING再生中ですが、一時停止可能です
    XACT_CUESTATE_STOPPING停止中です
    XACT_CUESTATE_STOPPED停止済みです
    XACT_CUESTATE_PAUSED一時停止されています

    注    これらのフラグによって示されるステータスは、必ずしも相互に排他的である必要はありません。したがって、== (equal) 演算ではなく、& (and) 演算を使って、ステートをテストしてください。

戻り値

正常に実行された場合は S_OK を返し、失敗した場合はエラー コードを返します。

解説　

この関数は、呼び出しが行われた時点でキューが実行している処理を呼び出し元に通知します。GetState から返された状態は、現在の状態のみを示します。

XACT_CUESTATE_PAUSED だけは、他の状態フラグと組み合わせて使用されます。言い換えると、GetState は XACT_CUESTATE_PREPARING セットまたは XACT_CUESTATE_PLAYING セットでステート値を返すことがありますが、この両方の条件が同時に true となる可能性はないため、両方で返すことはありません。ただし、プレイ中にキューが一時停止されたことを示す場合、GetState は、XACT_CUESTATE_PLAYING と XACT_CUESTATE_PAUSED の両方のフラグ セットでステート値を返すことがあります。

要件

ヘッダー: Xact3.h 宣言

ライブラリ: Xact3.lib 内容

関連項目

IXACT3Cue