SoundEffect

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

SoundEffect クラスは MP3 オーディオファイルを再生します。たとえば、ユーザーが Button コントロールをクリックしたときに、サウンドを再生することができます。このエフェクトでは、サウンドの繰り返し再生、ソースファイルの選択、およびボリュームとパンの制御が可能です。

MP3 ファイルを指定するには、source プロパティを使用します。 MP3 ファイルを既に埋め込んでいる場合は、Embed キーワードを使用して、MP3 ファイルの Class オブジェクトを source プロパティに渡すことができます。それ以外の場合は、MP3 ファイルへの完全な URL を指定します。

MXML シンタックス expanded

MXML シンタックスを隠す

The <mx:SoundEffect> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <mx:SoundEffect
    Properties
    id="ID"
    autoLoad="true|false"
    bufferTime="1000"
    loops="0"
    panEasingFunction=""
    panFrom="0"
    source=""
    startTime="0"
    useDuration="true|false"
    volumeEasingFunction="true|false"
    volumeTo="1"
     
    Events
    complete="No default"
    id3="No default"
    ioError="No default"
    progress="No default"
  />

例を表示

パブリックプロパティ

継承されるパブリックプロパティを隠す

継承されるパブリックプロパティを表示

	プロパティ		定義元
		autoLoad : Boolean true の場合、source が指定されたら MP3 ファイルをロードします。	SoundEffect
		bufferTime : Number = 1000 SoundEffect クラスは、内部 Sound オブジェクトを使用して MP3 ファイルを制御します。	SoundEffect
		className : String [読み取り専用] このエフェクトクラスの名前です。たとえば、"Fade" などがあります。	Effect
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		customFilter : mx.effects:EffectTargetFilter エフェクトを再生するターゲットを特定するために、エフェクトによって使用されるタイプ EffectTargetFilter のカスタムフィルターオブジェクトを指定します。	Effect
		duration : Number エフェクトの継続時間を表します（ミリ秒単位）。	Effect
		effectTargetHost : mx.effects:IEffectTargetHost データエフェクトのターゲットリストコントロールにアクセスできるプロパティです。	Effect
		filter : String エフェクトのターゲットをフィルタリングするアルゴリズムを指定します。	Effect
		hideFocusRing : Boolean エフェクトの開始時にエフェクトがフォーカス枠を非表示にするかどうかを指定します。	Effect
		instanceClass : Class このエフェクトクラスのエフェクトインスタンスクラスを指定する Class 型のオブジェクトを表します。	Effect
		isLoading : Boolean [読み取り専用] このプロパティは、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
		perElementOffset : Number エフェクトの最初のターゲットの後に発生する、エフェクトターゲットの追加遅延（ミリ秒）です。	Effect
		playheadTime : Number エフェクトの現在の時間位置です。	Effect
		relevantProperties : Array フィルタリング実行時に使用するプロパティ名の配列を表します。	Effect
		relevantStyles : Array フィルタリング実行時に使用するスタイル名の配列を表します。	Effect
		repeatCount : int = 1 エフェクトを繰り返す回数を表します。	Effect
		repeatDelay : int = 0 エフェクトを繰り返す前の待機時間を表します（ミリ秒単位）。	Effect
		sound : Sound [読み取り専用] MP3 ファイルがロードされた Sound オブジェクトを表します。	SoundEffect
		source : Object 再生する MP3 ファイルの URL またはクラスを表します。	SoundEffect
		startDelay : int = 0 エフェクトを開始する前の待機時間を表します（ミリ秒単位）。	Effect
		startTime : Number = 0 再生を開始する MP3 ファイルの初期位置を表します（ミリ秒単位）。	SoundEffect
		suspendBackgroundProcessing : Boolean = false true の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。	Effect
		target : Object このエフェクトが適用されるオブジェクトを表します。	Effect
		targets : Array エフェクトのターゲットであるオブジェクトの配列を表します。	Effect
		triggerEvent : Event エフェクトがトリガーされたときに EffectManager によってこの Effect に渡される Event オブジェクトです。EffectManager によってエフェクトが再生されていない場合は null です。	Effect
		useDuration : Boolean = true true の場合、duration プロパティで指定された時間の経過後にエフェクトを停止します。	SoundEffect
		volumeEasingFunction : Function ボリュームエフェクトのイージング関数を表します。	SoundEffect
		volumeFrom : Number Sound オブジェクトの初期ボリュームを表します。	SoundEffect
		volumeTo : Number Sound オブジェクトの最終ボリュームを表します。	SoundEffect

プロテクトプロパティ

継承されるプロテクトプロパティを隠す

継承されるプロテクトプロパティを表示

	プロパティ		定義元
		applyTransitionEndProperties : Boolean このフラグは、エフェクトがトランジションで実行された場合に、エフェクト自体が設定した値をそのまま使用するのではなく、その終了状態に応じてプロパティ値を自動的に適用するかどうかを制御します。	Effect
		endValuesCaptured : Boolean = false エフェクトの終了値が既に決定されている場合は true を含むフラグ、エフェクトの実行時にエフェクトターゲットの現在のプロパティから終了値を取得する必要がある場合は false を含むフラグです。	Effect

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		SoundEffect(target:Object = null) コンストラクターです。	SoundEffect
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		captureEndValues():void エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャし、終了値として保存します。	Effect
		captureMoreStartValues(targets:Array):void ターゲットの追加セットの関連するプロパティの現在値をキャプチャします。この機能は、データ変更エフェクトを実行したときに Flex によって使用されます。	Effect
		captureStartValues():void エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャします。	Effect
		createInstance(target:Object = null):IEffectInstance 1 つのエフェクトインスタンスを作成し、それを初期化します。	Effect
		createInstances(targets:Array = null):Array ターゲットオブジェクトの配列を取得し、各ターゲットで createInstance() メソッドを呼び出します。	Effect
		deleteInstance(instance:IEffectInstance):void インスタンスからイベントリスナーを削除し、インスタンスのリストからインスタンスを削除します。	Effect
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		end(effectInstance:IEffectInstance = 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
		stop():void エフェクトターゲットを現在の状態にしたまま、エフェクトを停止します。	Effect
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	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
		effectStopHandler(event:EffectEvent):void エフェクトインスタンスが stop() メソッドの呼び出しによって停止されると呼び出されます。	Effect
		filterInstance(propChanges:Array, target:Object):Boolean エフェクトインスタンスをフィルタリングするために必要なロジックを決定します。	Effect
		getValueFromTarget(target:Object, property:String):* ターゲットからプロパティの値を取得するために captureStartValues() メソッドによって呼び出されます。	Effect
		initInstance(instance:IEffectInstance):void エフェクトインスタンスにエフェクトのプロパティをコピーします。	Effect

イベント

イベントの詳細についてはここをクリックしてください

継承されるイベントを隠す

継承されるイベントを表示

	概要	定義元
activate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
complete	サウンドファイルのロードが完了すると送出されます。	SoundEffect
deactivate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher
effectEnd	エフェクトのインスタンスの 1 つが再生を停止したとき（インスタンスの再生完了時、またはエフェクトが end() メソッドの呼び出しにより中断されたとき）に送出されます。	Effect
effectStart	エフェクトの再生開始時に送出されます。	Effect
effectStop	エフェクトが停止されると送出されます。これが発生するのは、stop() メソッドの呼び出しによってエフェクトが中断された場合のみです。	Effect
id3	ID3 データが MP3 サウンドファイルで使用できるようになると送出されます。	SoundEffect
ioError	サウンドファイルのロード中にエラーが発生すると送出されます。	SoundEffect
progress	サウンドファイルのロード時に定期的に送出されます。	SoundEffect

プロパティの詳細

autoLoad

プロパティ

autoLoad:Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

デフォルト値： true。

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

bufferTime

プロパティ

public var bufferTime:Number = 1000

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

デフォルト値： 1000。

isLoading

プロパティ

isLoading:Boolean [読み取り専用]

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

実装
public function get isLoading():Boolean

loops

プロパティ

public var loops:int = 0

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

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

デフォルト値： 0。

プロパティ

public var volumeEasingFunction:Function

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

volumeFrom

プロパティ

public var volumeFrom:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

デフォルト値： 1。

volumeTo

プロパティ

public var volumeTo:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

デフォルト値： 1。

コンストラクターの詳細

()

コンストラクター

public function SoundEffect(target:Object = null)

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

コンストラクターです。

パラメーター

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

メソッドの詳細

load

()

メソッド

public function load():void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

イベントの詳細

complete

イベント

イベントオブジェクトの型: flash.events.Event
プロパティ Event.type = flash.events.Event.COMPLETE

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

Event.COMPLETE 定数は、type プロパティ（complete イベントオブジェクト）の値を定義します。

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

プロパティ	値
`bubbles`	`false`
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	読み込みが完了したネットワークオブジェクトです。

id3

イベント

イベントオブジェクトの型: flash.events.Event
プロパティ Event.type = flash.events.Event.ID3

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

Event.ID3 定数は、type プロパティ（id3 イベントオブジェクト）の値を定義します。

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

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

ioError

イベント

イベントオブジェクトの型: flash.events.IOErrorEvent
プロパティ IOErrorEvent.type = flash.events.IOErrorEvent.IO_ERROR

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

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

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

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

progress

イベント

イベントオブジェクトの型: flash.events.ProgressEvent
プロパティ ProgressEvent.type = flash.events.ProgressEvent.PROGRESS

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

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

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

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

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

例この例の使用方法

SoundEffectExample.mxml

<?xml version="1.0"?>
<!-- Simple example to demonstrate the SoundEffect effect. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:s="library://ns.adobe.com/flex/spark"
        xmlns:mx="library://ns.adobe.com/flex/mx">

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

    <s:Panel title="Sound Effect Example" width="75%" height="75%" >
        <s:VGroup left="20" right="20" top="20" bottom="20">

        <s: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}"/>

        </s:VGroup>
    </s:Panel>
</s:Application>

法律上の注意 | プライバシーポリシー

SoundEffect - AS3 Flex

パッケージx

言語エレメント

付録

パッケージ mx.effects

autoLoad

bufferTime

isLoading

loops

panEasingFunction

panFrom

panTo

sound

source

startTime

useDuration

volumeEasingFunction

volumeFrom

volumeTo

SoundEffect

load

complete

id3

ioError

progress