Platform SDK: DirectX

DirectInputEffect.Start

DirectInputEffect.Start メソッドは、エフェクトの再生を開始する。エフェクトが既に再生中ならば、最初から開始される。エフェクトがダウンロードされていないか、または前回のダウンロード以来、変更されている場合は、開始前にエフェクトがダウンロードされる。この処理はデフォルトで行われる。これを抑制するには、DIES_NODOWNLOAD フラグを渡せばよい。

object.Start(iterations As Long, flags As Long)

パラメータ

object
DirectInputEffect オブジェクトを表すオブジェクト式。
iterations
連続してエフェクトを再生する回数。エンベロープは、反復ごとに再調整される。

エフェクトを一度だけ再生するには、1 を渡す。エフェクトを明示的に停止するまで繰り返し再生するには、-1 を渡す。エフェクトを明示的に停止するまでエンベロープを再調整せずに再生するには、DirectInputEffect.SetParameters メソッドでエフェクト パラメータを変更し、DIEFFECTlDuration メンバを -1 に変更する。

flags
デバイスがエフェクトをどのように再生するかを表す、CONST_DIESFLAGS 列挙のフラグ。値はゼロまたは次のフラグのいずれかを指定する。
DIES_SOLO
指定されたエフェクトが再生される前に、デバイス上のほかのすべてのエフェクトを停止する。このフラグを省略すると、エフェクトは、デバイス上で既に再生が始まっている既存のエフェクトと混合されることになる。
DIES_NODOWNLOAD
エフェクトの自動ダウンロードを行わない。

エラー コード

失敗すればエラーが発生し、Err.Number に次のいずれかのエラー コードが設定される。

DIERR_INVALIDPARAM
DIERR_INCOMPLETEEFFECT
DIERR_NOTEXCLUSIVEACQUIRED
DIERR_NOTINITIALIZED
DIERR_UNSUPPORTED

注意

このメソッドを成功させるには、デバイスを排他協調レベルで取得しなければならない。

複数回の繰り返しをサポートしないデバイスもある。