パッケージmx.effects.effectClasses
public class SoundEffectInstance
継承SoundEffectInstance Inheritance EffectInstance Inheritance EventDispatcher Inheritance Object

SoundEffectInstance クラスでは SoundEffect エフェクトのインスタンスクラスを実装します。このクラスのインスタンスは SoundEffect エフェクトの再生時に Flex により作成されます。ユーザー自身が作成することはありません。

関連項目

mx.effects.Fade


パブリックプロパティ
 プロパティ定義
  bufferTime : Number = 1000
SoundEffect クラスは、内部の Sound オブジェクトを使用して、MP3 ファイルを制御します。
SoundEffectInstance
 InheritedclassName : String
このエフェクトクラスの名前です。たとえば、"FadeInstance" などがあります。
EffectInstance
 Inheritedconstructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
 Inheritedduration : Number
エフェクトの継続時間を表します (ミリ秒単位)。
EffectInstance
 Inheritedeffect : Effect
この EffectInstance オブジェクトを作成した Effect オブジェクトを表します。
EffectInstance
  isLoading : Boolean
[read-only] このプロパティは、MP3 がロードされている場合は、true です。
SoundEffectInstance
  loops : int = 0
ループ内でサウンドを再生する回数を表します。値が 0 の場合、エフェクトは 1 回再生し、値が 1 の場合、エフェクトは 2 回再生されます。
SoundEffectInstance
  panEasingFunction : Function
パンエフェクトのイージング関数を表します。
SoundEffectInstance
  panFrom : Number
Sound オブジェクトの初期パンを表します。
SoundEffectInstance
  panTo : Number
Sound オブジェクトの最終パンを表します。
SoundEffectInstance
 InheritedplayheadTime : Number
エフェクト再生中の現在位置を表します。
EffectInstance
 InheritedpropertyChanges : PropertyChanges
エフェクトのターゲットに関連するプロパティのセットに対して、開始値および終了値を含む PropertyChanges オブジェクトを指定します。
EffectInstance
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
 InheritedrepeatCount : int = 1
エフェクトを繰り返す回数を表します。
EffectInstance
 InheritedrepeatDelay : int = 0
エフェクトを繰り返す前の待機時間を表します (ミリ秒単位)。
EffectInstance
  sound : Sound
内部 Sound オブジェクトへの参照です。
SoundEffectInstance
  soundChannel : SoundChannel
[read-only] MP3 ファイルがロードされた SoundChannel オブジェクトを表します。
SoundEffectInstance
  source : Object
再生する MP3 ファイルの URL またはクラスを表します。
SoundEffectInstance
 InheritedstartDelay : int = 0
エフェクトを開始する前の待機時間を表します (ミリ秒単位)。
EffectInstance
  startTime : Number = 0
再生を開始する MP3 ファイルの初期位置を表します (ミリ秒単位)。
SoundEffectInstance
 InheritedsuspendBackgroundProcessing : Boolean = false
true の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。
EffectInstance
 Inheritedtarget : Object
このエフェクトが適用される UIComponent オブジェクトを表します。
EffectInstance
 InheritedtriggerEvent : Event
エフェクトの再生をトリガしたイベントを表します (存在する場合)。
EffectInstance
  useDuration : Boolean = true
true の場合、duration プロパティで指定された時間の経過後にエフェクトを停止します。
SoundEffectInstance
  volumeEasingFunction : Function
ボリュームエフェクトのイージング関数を表します。
SoundEffectInstance
  volumeFrom : Number
Sound オブジェクトの初期ボリュームを表します。
SoundEffectInstance
  volumeTo : Number
Sound オブジェクトの最終ボリュームを表します。
SoundEffectInstance
パブリックメソッド
 メソッド定義
  SoundEffectInstance(target:Object)
コンストラクタ。
SoundEffectInstance
 InheritedaddEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
 InheriteddispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
EventDispatcher
 Inheritedend():void
現在再生中のエフェクトインスタンスを中断し、直ちにエフェクトの終わりにジャンプします。
EffectInstance
 InheritedfinishEffect():void
エフェクトの再生が完了すると、end() メソッドによって呼び出されます。
EffectInstance
 InheritedfinishRepeat():void
繰り返されるエフェクトの各反復により再生が終了すると、呼び出されます。
EffectInstance
 InheritedhasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 InheritedhasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 InheritedinitEffect(event:Event):void
このメソッドは、エフェクトが EffectManager によってトリガされると、呼び出されます。
EffectInstance
 InheritedisPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inheritedpause():void
resume() メソッドを呼び出すまで、エフェクトを一時停止します。
EffectInstance
 Inheritedplay():void
ターゲットでエフェクトインスタンスを再生します。
EffectInstance
 InheritedpropertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
Object
 InheritedremoveEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
 Inheritedresume():void
pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。
EffectInstance
 Inheritedreverse():void
エフェクトの現在位置から開始して、逆順でエフェクトを再生します。
EffectInstance
 InheritedsetPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 InheritedstartEffect():void
startDelay 時間の経過後、ターゲットでエフェクトインスタンスを再生します。
EffectInstance
 InheritedtoString():String
指定されたオブジェクトのストリング表現を返します。
Object
 InheritedvalueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
Object
 InheritedwillTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
プロパティの詳細
bufferTimeプロパティ
public var bufferTime:Number = 1000

SoundEffect クラスは、内部の Sound オブジェクトを使用して、MP3 ファイルを制御します。このプロパティによって、Sound オブジェクトのバッファで保持するサウンドデータに応じた最小時間が指定されます (単位はミリ秒)。Sound オブジェクトは、再生の開始前、ならびにネットワーク停止後の再生の再開前に少なくともこの大量のデータを取得するまで待機します。

デフォルト値1000.

isLoadingプロパティ 
isLoading:Boolean  [read-only]

このプロパティは、MP3 がロードされている場合は、true です。

実装
    public function get isLoading():Boolean
loopsプロパティ 
public var loops:int = 0

ループ内でサウンドを再生する回数を表します。値が 0 の場合、エフェクトは 1 回再生し、値が 1 の場合、エフェクトは 2 回再生されます。MP3 ファイルを繰り返す場合、useDuration プロパティの設定により再生時間が決定します。

duration プロパティは、このプロパティよりも優先されます。エフェクトの持続時間がサウンドを最低 1 回再生するのに必要とされる時間に満たない場合、サウンドはループ処理されません。

デフォルト値0.

panEasingFunctionプロパティ 
public var panEasingFunction:Function

パンエフェクトのイージング関数を表します。この関数を使用して、panFrompanTo の範囲の値を補間します。

panFromプロパティ 
public var panFrom:Number

Sound オブジェクトの初期パンを表します。値の範囲は -1.0 ~ 1.0 です。ここで、-1.0 は左のチャンネルのみを使用し、1.0 は右のチャンネルのみを使用します。0.0 は 2 つのチャンネル間でサウンドが均一になるようにバランスをとります。

デフォルト値0.

panToプロパティ 
public var panTo:Number

Sound オブジェクトの最終パンを表します。値の範囲は -1.0 ~ 1.0 です。ここで、-1.0 は左のチャンネルのみを使用し、1.0 は右のチャンネルのみを使用します。0.0 は 2 つのチャンネル間でサウンドが均一になるようにバランスをとります。

デフォルト値0.

soundプロパティ 
public var sound:Sound

内部 Sound オブジェクトへの参照です。SoundEffect はこのインスタンスを使用して MP3 ファイルを再生します。

soundChannelプロパティ 
soundChannel:SoundChannel  [read-only]

MP3 ファイルがロードされた SoundChannel オブジェクトを表します。

実装
    public function get soundChannel():SoundChannel
sourceプロパティ 
source:Object  [read-write]

再生する MP3 ファイルの URL またはクラスを表します。既に埋め込み MP3 ファイルがある場合は、Embed キーワードを使用して MP3 ファイルの Class オブジェクトを source プロパティに渡します。それ以外の場合は、MP3 ファイルへの完全な URL を指定してください。

実装
    public function get source():Object
    public function set source(value:Object):void
startTimeプロパティ 
public var startTime:Number = 0

再生を開始する MP3 ファイルの初期位置を表します (ミリ秒単位)。

デフォルト値0.

useDurationプロパティ 
public var useDuration:Boolean = true

true の場合、duration プロパティで指定された時間の経過後にエフェクトを停止します。false の場合、MP3 の再生またはループの完了後にエフェクトを停止します。

デフォルト値true.

volumeEasingFunctionプロパティ 
public var volumeEasingFunction:Function

ボリュームエフェクトのイージング関数を表します。この関数を使用して、volumeFromvolumeTo の範囲の値を補間します。

volumeFromプロパティ 
public var volumeFrom:Number

Sound オブジェクトの初期ボリュームを表します。値の範囲は 0.0 から 1.0 です。

デフォルト値1.0.

volumeToプロパティ 
public var volumeTo:Number

Sound オブジェクトの最終ボリュームを表します。値の範囲は 0.0 から 1.0 です。

デフォルト値1.0.

コンストラクタの詳細
SoundEffectInstance()コンストラクタ
public 関数 SoundEffectInstance(target:Object)

コンストラクタ。

パラメータ
target:Object — このエフェクトでアニメーション化するオブジェクトを表します。