mx.effects.SoundEffect (Flex™ 2 リファレンスガイド)

パブリックプロパティ

	プロパティ		定義
		autoLoad : Boolean `true` の場合、`source` が指定されたら MP3 ファイルをロードします。	SoundEffect
		bufferTime : Number = 1000 SoundEffect クラスは、内部の Sound オブジェクトを使用して、MP3 ファイルを制御します。	SoundEffect
		className : String `"Fade"` など、エフェクトクラスの名前です。	Effect
		constructor : Object 特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。	Object
		customFilter : EffectTargetFilter エフェクトを再生するターゲットを特定するために、エフェクトによって使用されるタイプ EffectTargetFilter のカスタムフィルタオブジェクトを指定します。	Effect
		duration : Number エフェクトの継続時間を表します (ミリ秒単位)。	Effect
		filter : String エフェクトのターゲットをフィルタリングするアルゴリズムを指定します。	Effect
		instanceClass : Class このエフェクトクラスのエフェクトインスタンスクラスを指定する Class 型のオブジェクトを表します。	Effect
		isLoading : Boolean [read-only] このプロパティは、MP3 がロードされている場合は、`true` です。	SoundEffect
		isPlaying : Boolean エフェクトのインスタンスのいずれかが現在再生中の場合に true、そうでない場合に false となる読み取り専用フラグです。	Effect
		loops : int = 0 ループ内でサウンドを再生する回数を表します。値が 0 の場合、エフェクトは 1 回再生し、値が 1 の場合、エフェクトは 2 回再生されます。	SoundEffect
		panEasingFunction : Function パンエフェクトのイージング関数を表します。	SoundEffect
		panFrom : Number Sound オブジェクトの初期パンを表します。	SoundEffect
		panTo : Number Sound オブジェクトの最終パンを表します。	SoundEffect
		prototype : Object [static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。	Object
		relevantProperties : Array フィルタリング実行時に使用するプロパティ名の配列を表します。	Effect
		relevantStyles : Array フィルタリング実行時に使用するスタイル名の配列を表します。	Effect
		repeatCount : int = 1 エフェクトを繰り返す回数を表します。	Effect
		repeatDelay : int = 0 エフェクトを繰り返す前の待機時間を表します (ミリ秒単位)。	Effect
		sound : Sound [read-only] MP3 ファイルがロードされた Sound オブジェクトを表します。	SoundEffect
		source : Object 再生する MP3 ファイルの URL またはクラスを表します。	SoundEffect
		startDelay : int = 0 エフェクトを開始する前の待機時間を表します (ミリ秒単位)。	Effect
		startTime : Number = 0 再生を開始する MP3 ファイルの初期位置を表します (ミリ秒単位)。	SoundEffect
		suspendBackgroundProcessing : Boolean = false `true` の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。	Effect
		target : Object このエフェクトが適用される UIComponent オブジェクトを表します。	Effect
		targets : Array エフェクトのターゲットである UIComponent オブジェクトの配列を表します。	Effect
		useDuration : Boolean = true `true` の場合、`duration` プロパティで指定された時間の経過後にエフェクトを停止します。	SoundEffect
		volumeEasingFunction : Function ボリュームエフェクトのイージング関数を表します。	SoundEffect
		volumeFrom : Number Sound オブジェクトの初期ボリュームを表します。	SoundEffect
		volumeTo : Number Sound オブジェクトの最終ボリュームを表します。	SoundEffect

	メソッド	定義
		SoundEffect(target:Object = null) コンストラクタ。	SoundEffect
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		captureStartValues():void エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャします。	Effect
		createInstance(target:Object = null):EffectInstance 1 つのエフェクトインスタンスを作成し、それを初期化します。	Effect
		createInstances(targets:Array = null):Array ターゲットオブジェクトの配列を取得し、各ターゲットで `createInstance()` メソッドを呼び出します。	Effect
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		end(effectInstance:EffectInstance = null):void 現在再生中のエフェクトをすべて中断し、直ちにエフェクトの終わりにジャンプします。	Effect
		getAffectedProperties():Array ストリングの配列を返します。各ストリングは、このエフェクトによって変更されるプロパティの名前です。	Effect
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		load():void `source` プロパティに URL が指定されている場合は、MP3 をロードします。	SoundEffect
		pause():void `resume()` メソッドを呼び出すまで、エフェクトを一時停止します。	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array エフェクトの再生を開始します。	Effect
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙可能かどうかを示します。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		resume():void `pause()` メソッドを呼び出し、エフェクトを一時停止した後、再開させます。	Effect
		reverse():void エフェクトが現在再生中の場合に、エフェクトの現在位置から開始して、逆順でエフェクトを再生します。	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブ値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

	メソッド	定義
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void エフェクトインフラストラクチャによって内部的に使用されます。	Effect
		effectEndHandler(event:EffectEvent):void エフェクトインスタンスの再生終了時に呼び出されます。	Effect
		effectStartHandler(event:EffectEvent):void このメソッドは、エフェクトインスタンスの再生開始時に呼び出されます。	Effect
		filterInstance(propChanges:Array, targ:Object):Boolean エフェクトインスタンスのフィルタリングに必要なロジックを決定します。	Effect
		getValueFromTarget(target:Object, property:String):* ターゲットからプロパティの値を取得するために `captureStartValues()` によって呼び出されます。	Effect
		initInstance(instance:EffectInstance):void エフェクトインスタンスにエフェクトのプロパティをコピーします。	Effect

一覧	定義
complete	サウンドファイルのロードが完了すると送出されます。	SoundEffect
effectEnd	エフェクトの再生停止時 (エフェクトの再生完了時、またはエフェクトが `end()` メソッドの呼び出しにより中断されたとき) に送出されます。	Effect
effectStart	エフェクトの再生開始時に送出されます。	Effect
id3	ID3 データが MP3 サウンドファイルで使用できるようになると送出されます。	SoundEffect
ioError	サウンドファイルのロード中にエラーが発生すると送出されます。	SoundEffect
progress	サウンドファイルのロード時に定期的に送出されます。	SoundEffect

プロパティの詳細

autoLoad

プロパティ

autoLoad:Boolean [read-write]

true の場合、source が指定されたら MP3 ファイルをロードします。

デフォルト値true.

実装
public function get autoLoad():Boolean
public function set autoLoad(value:Boolean):void

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

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

panFrom

プロパティ

public var panFrom:Number

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

デフォルト値0.0.

panTo

プロパティ

public var panTo:Number

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

デフォルト値0.0.

sound

プロパティ

sound:Sound [read-only]

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

実装
public function get sound():Sound

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

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

volumeFrom

プロパティ

public var volumeFrom:Number

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

デフォルト値1.

volumeTo

プロパティ

public var volumeTo:Number

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

デフォルト値1.

コンストラクタの詳細

SoundEffect

()

コンストラクタ

public 関数 SoundEffect(target:Object = null)

コンストラクタ。

パラメータ

target:Object (default = null) — このエフェクトでアニメーション化するオブジェクトを表します。

メソッドの詳細

load

()

メソッド

public function load():void

source プロパティに URL が指定されている場合は、MP3 をロードします。

イベントの詳細

complete

event

イベントオブジェクトの型: flash.events.Event
Event.type property = flash.events.Event.COMPLETE

サウンドファイルのロードが完了すると送出されます。

complete イベントオブジェクトの type プロパティの値を定義します。

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	`false`
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	ロードが完了したネットワークオブジェクトです。`target` は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、`currentTarget` プロパティを使用します。

id3

event

イベントオブジェクトの型: flash.events.Event
Event.type property = flash.events.Event.ID3

ID3 データが MP3 サウンドファイルで使用できるようになると送出されます。

id3 イベントオブジェクトの type プロパティの値を定義します。

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	`false`
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	ID3 データが現在使用可能な MP3 をロードしている Sound オブジェクトです。`target` は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、`currentTarget` プロパティを使用します。

ioError

event

イベントオブジェクトの型: flash.events.IOErrorEvent
IOErrorEvent.type property = flash.events.IOErrorEvent.IO_ERROR

サウンドファイルのロード中にエラーが発生すると送出されます。

ioError イベントオブジェクトの type プロパティの値を定義します。

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	`false`
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	入出力エラーが発生したネットワークオブジェクトです。
`text`	エラーメッセージとして表示されるテキストです。

progress

event

イベントオブジェクトの型: flash.events.ProgressEvent
ProgressEvent.type property = flash.events.ProgressEvent.PROGRESS

サウンドファイルのロード時に定期的に送出されます。

イベントオブジェクトでは、現在ロードされているバイト数とロード対象の合計バイト数にアクセスできます。このイベントは常に送出されるとは限りません。progress イベントが送出されていなくても complete イベントが送出される場合もあります。

progress イベントオブジェクトの type プロパティの値を定義します。

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	`false`
`bytesLoaded`	リスナーがイベントを処理しているときにロードされたアイテム数またはバイト数です。
`bytesTotal`	ロードプロセスが成功した場合に最終的にロードされるアイテムまたはバイトの総数です。
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	進行状況をレポートするネットワークオブジェクトです。

例

SoundEffectExample

<?xml version="1.0"?>
<!-- Simple example to demonstrate the SoundEffect effect. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">

    <mx:SoundEffect id="mySounds" source="@Embed(source='assets/jazz.mp3')"/>

    <mx:Panel title="Sound Effect Example" width="75%" height="75%" 
        paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">

        <mx:Label width="100%" color="blue" 
            text="Click on the phone to hear the sound effect."/>

        <mx:Image id="flex" source="@Embed(source='assets/Nokia_6630.png')" 
            mouseDownEffect="{mySounds}"/>

    </mx:Panel>
</mx:Application>

Adobe^® Flex™ 2 リファレンスガイド		すべてのパッケージ \| すべてのクラス \| 言語エレメント \| 索引 \| 付録 \| 規則 \| フレーム内に表示フレームなしバージョン
Class SoundEffect	プロパティ \| メソッド \| イベント \| 例

パッケージ	mx.effects
	public class SoundEffect
継承	SoundEffect Effect EventDispatcher Object