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

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

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

MXML のシンタックスexpandedMXML シンタックスを隠す

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"
  />

例を表示

関連項目

mx.effects.effectClasses.SoundEffectInstance
flash.media.Sound

パブリックプロパティ
 プロパティ定義元
  autoLoad : Boolean
true の場合、source が指定されたら MP3 ファイルをロードします。
SoundEffect
  bufferTime : Number = 1000
SoundEffect クラスは、内部の Sound オブジェクトを使用して、MP3 ファイルを制御します。
SoundEffect
 InheritedclassName : String
[読み取り専用] このエフェクトクラスの名前です。たとえば、"Fade" などがあります。
Effect
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
 InheritedcustomFilter : EffectTargetFilter
エフェクトを再生するターゲットを特定するために、エフェクトによって使用されるタイプ EffectTargetFilter のカスタムフィルタオブジェクトを指定します。
Effect
 Inheritedduration : Number
エフェクトの継続時間を表します（ミリ秒単位）。
Effect
 InheritedeffectTargetHost : IEffectTargetHost
データエフェクトのターゲットリストコントロールにアクセスできるプロパティです。
Effect
 Inheritedfilter : String
エフェクトのターゲットをフィルタリングするアルゴリズムを指定します。
Effect
 InheritedhideFocusRing : Boolean
エフェクトの開始時にエフェクトがフォーカスリングを非表示にするかどうかを指定します。
Effect
 InheritedinstanceClass : Class
このエフェクトクラスのエフェクトインスタンスクラスを指定する Class 型のオブジェクトを表します。
Effect
  isLoading : Boolean
[読み取り専用] このプロパティは、MP3 がロードされている場合は、true です。
SoundEffect
 InheritedisPlaying : Boolean
[読み取り専用] エフェクトのインスタンスのいずれかが現在再生中の場合に true、そうでない場合に false となる読み取り専用フラグです。
Effect
  loops : int = 0
ループ内でサウンドを再生する回数を表します。値が 0 の場合、エフェクトは 1 回再生され、値が 1 の場合、エフェクトは 2 回再生されます。以降も同様です。
SoundEffect
  panEasingFunction : Function
パンエフェクトのイージング関数を表します。
SoundEffect
  panFrom : Number
Sound オブジェクトの初期パンを表します。
SoundEffect
  panTo : Number
Sound オブジェクトの最終パンを表します。
SoundEffect
 InheritedperElementOffset : Number
エフェクトの最初のターゲットの後に発生する、エフェクトターゲットの追加遅延（ミリ秒）です。
Effect
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
 InheritedrelevantProperties : Array
フィルタリング実行時に使用するプロパティ名の配列を表します。
Effect
 InheritedrelevantStyles : Array
フィルタリング実行時に使用するスタイル名の配列を表します。
Effect
 InheritedrepeatCount : int = 1
エフェクトを繰り返す回数を表します。
Effect
 InheritedrepeatDelay : int = 0
エフェクトを繰り返す前の待機時間を表します（ミリ秒単位）。
Effect
  sound : Sound
[読み取り専用] MP3 ファイルがロードされた Sound オブジェクトを表します。
SoundEffect
  source : Object
再生する MP3 ファイルの URL またはクラスを表します。
SoundEffect
 InheritedstartDelay : int = 0
エフェクトを開始する前の待機時間を表します（ミリ秒単位）。
Effect
  startTime : Number = 0
再生を開始する MP3 ファイルの初期位置を表します（ミリ秒単位）。
SoundEffect
 InheritedsuspendBackgroundProcessing : Boolean = false
true の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。
Effect
 Inheritedtarget : Object
このエフェクトが適用される UIComponent オブジェクトを表します。
Effect
 Inheritedtargets : Array
エフェクトのターゲットである UIComponent オブジェクトの配列を表します。
Effect
 InheritedtriggerEvent : Event
エフェクトがトリガされたときに EffectManager によってこの Effect に渡される Event オブジェクトです。EffectManager によってエフェクトが再生されていない場合は null です。
Effect
  useDuration : Boolean = true
true の場合、duration プロパティで指定された時間の経過後にエフェクトを停止します。
SoundEffect
  volumeEasingFunction : Function
ボリュームエフェクトのイージング関数を表します。
SoundEffect
  volumeFrom : Number
Sound オブジェクトの初期ボリュームを表します。
SoundEffect
  volumeTo : Number
Sound オブジェクトの最終ボリュームを表します。
SoundEffect
プロテクトプロパティ
 プロパティ定義元
 InheritedendValuesCaptured : Boolean = false
エフェクトの終了値が既に決定されている場合は true を含むフラグ、エフェクトの実行時にエフェクトターゲットの現在のプロパティから終了値を取得する必要がある場合は false を含むフラグです。
Effect
パブリックメソッド
 メソッド定義元
  
SoundEffect(target:Object = null)
コンストラクタです。
SoundEffect
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
 Inherited
captureEndValues():void
エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャし、終了値として保存します。
Effect
 Inherited
captureMoreStartValues(targets:Array):void
ターゲットの追加セットの関連するプロパティの現在値をキャプチャします。この機能は、データ変更エフェクトを実行したときに Flex によって使用されます。
Effect
 Inherited
captureStartValues():void
エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャします。
Effect
 Inherited
createInstance(target:Object = null):IEffectInstance
1 つのエフェクトインスタンスを作成し、それを初期化します。
Effect
 Inherited
createInstances(targets:Array = null):Array
ターゲットオブジェクトの配列を取得し、各ターゲットで createInstance() メソッドを呼び出します。
Effect
 Inherited
deleteInstance(instance:IEffectInstance):void
インスタンスからイベントリスナーを削除し、インスタンスのリストからインスタンスを削除します。
Effect
 Inherited
dispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
EventDispatcher
 Inherited
end(effectInstance:IEffectInstance = null):void
現在再生中のエフェクトをすべて中断し、直ちにエフェクトの終わりにジャンプします。
Effect
 Inherited
getAffectedProperties():Array
ストリングの配列を返します。各ストリングは、このエフェクトによって変更されるプロパティの名前です。
Effect
 Inherited
hasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
  
load():void
source プロパティに URL が指定されている場合は、MP3 をロードします。
SoundEffect
 Inherited
pause():void
resume() メソッドを呼び出すまで、エフェクトを一時停止します。
Effect
 Inherited
play(targets:Array = null, playReversedFromEnd:Boolean = false):Array
エフェクトの再生を開始します。
Effect
 Inherited
propertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
 Inherited
resume():void
pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。
Effect
 Inherited
reverse():void
エフェクトが現在再生中の場合に、エフェクトの現在位置から開始して、逆順でエフェクトを再生します。
Effect
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
stop():void
エフェクトターゲットを現在の状態にしたまま、エフェクトを停止します。
Effect
 Inherited
toString():String
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
valueOf():Object
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
willTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
プロテクトメソッド
 メソッド定義元
 Inherited
applyValueToTarget(target:Object, property:String, value:*, props:Object):void
エフェクトインフラストラクチャによって内部的に使用されます。
Effect
 Inherited
effectEndHandler(event:EffectEvent):void
エフェクトインスタンスの再生終了時に呼び出されます。
Effect
 Inherited
effectStartHandler(event:EffectEvent):void
このメソッドは、エフェクトインスタンスの再生開始時に呼び出されます。
Effect
 Inherited
filterInstance(propChanges:Array, target:Object):Boolean
エフェクトインスタンスをフィルタリングするために必要なロジックを決定します。
Effect
 Inherited
getValueFromTarget(target:Object, property:String):*
ターゲットからプロパティの値を取得するために captureStartValues() メソッドによって呼び出されます。
Effect
 Inherited
initInstance(instance:IEffectInstance):void
エフェクトインスタンスにエフェクトのプロパティをコピーします。
Effect
イベント
 イベント 概要 定義元
 Inherited
activate
[ブロードキャスト イベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。EventDispatcher
  
complete
サウンドファイルのロードが完了すると送出されます。SoundEffect
 Inherited
deactivate
[ブロードキャスト イベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。EventDispatcher
 Inherited
effectEnd
エフェクトの再生停止時（エフェクトの再生完了時、またはエフェクトが end() メソッドの呼び出しにより中断されたとき）に送出されます。Effect
 Inherited
effectStart
エフェクトの再生開始時に送出されます。Effect
  
id3
ID3 データが MP3 サウンドファイルで使用できるようになると送出されます。SoundEffect
  
ioError
サウンドファイルのロード中にエラーが発生すると送出されます。SoundEffect
  
progress
サウンドファイルのロード時に定期的に送出されます。SoundEffect
プロパティの詳細
autoLoadプロパティ
autoLoad:Boolean

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  [読み取り専用]

このプロパティは、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  [読み取り専用]

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



実装
    public function get sound():Sound
sourceプロパティ 
source:Object

再生する 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 function SoundEffect(target:Object = null)

コンストラクタです。

パラメータ
target:Object (default = null) — このエフェクトでアニメーション化するオブジェクトを表します。
メソッドの詳細
load()メソッド
public function load():void

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

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

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

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

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

プロパティ値
bubblesfalse
cancelablefalse は、キャンセルするデフォルトの動作がないことを示します。
currentTargetイベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
targetロードが完了したネットワークオブジェクトです。
id3 イベント  
イベントオブジェクトの型: flash.events.Event
プロパティ Event.type = flash.events.Event.ID3

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

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

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

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

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

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

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

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

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

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

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

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

プロパティ値
bubblesfalse
bytesLoadedリスナーがイベントを処理しているときにロードされたアイテム数またはバイト数です。
bytesTotalロードプロセスが成功した場合に最終的にロードされるアイテムまたはバイトの総数です。
cancelablefalse は、キャンセルするデフォルトの動作がないことを示します。
currentTargetイベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
target進行状況をレポートする オブジェクトです。
例 例の使用法
SoundEffectExample.mxml
<?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>



© 2009 Adobe Systems Incorporated. All rights reserved.
Thu Mar 19 2009, 08:51 PM -07:00
 

 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/effects/SoundEffect.html