| Package | jp.progression.commands |
| Class | public class DoSound |
| Inheritance | DoSound  Command EventIntegrator flash.events.EventDispatcher |
| Property | Defined By | ||
|---|---|---|---|
 | className : String [read-only]
インスタンスのクラス名を取得します。
Indicates the instance className of the Command.
| Command | |
| defaultTimeOut : int [static] | Command | |
| delay : int
コマンド実行までの遅延時間（ミリ秒）を取得または設定します。
| Command | |
| enabled : Boolean
コマンドが実行可能かどうかを取得または設定します。
この値を false に設定した状態で execute() メソッドを実行すると、何も処理を行わずに CommandEvent.COMMAND_COMPLETE イベントを送出します。
| Command | |
| enforcedInterrupting : Boolean [read-only]
コマンドが強制中断処理中かどうかを取得します。
| Command | |
| extra : Object [read-only]
execute() メソッド実行時に引数として指定されたオブジェクトを取得します。
このコマンドが親の CommandList インスタンスによって実行されている場合には、親の extra オブジェクトの内容をコマンド実行順にリレーする形で引き継ぎます。
| Command | |
| group : String
インスタンスのグループ名を取得または設定します。
Indicates the instance group of the Command.
| Command | |
| id : String
インスタンスの識別子を取得または設定します。
Indicates the instance id of the Command.
| Command | |
| interrupting : Boolean [read-only]
コマンドが中断処理中かどうかを取得します。
| Command | |
| latestData : *
CommandList 上で、自身より前に実行された外部データ読み込み系のコマンドが持っている外部データを取得します。
| Command | |
| length : int [read-only]
コマンドの深度を取得します。
| Command | |
| name : String
インスタンスの名前を取得または設定します。
Indicates the instance name of the Command.
| Command | |
| next : Command [read-only]
このコマンドが CommandList インスタンスに関連付けられている場合に、次に位置するコマンドを取得します。
| Command | |
| parent : CommandList [read-only]
このコマンドを子に含んでいる親の CommandList インスタンスを取得します。
| Command | |
| previous : Command [read-only]
このコマンドが CommandList インスタンスに関連付けられている場合に、前に位置するコマンドを取得します。
| Command | |
| root : Command [read-only]
コマンドツリー構造の一番上に位置するコマンドを取得します。
| Command | |
| running : Boolean [read-only]
コマンドが実行中かどうかを取得します。
| Command | |
| scope : Object
コマンド実行処理、および中断処理のタイムアウト時間（ミリ秒）を取得または設定します。
指定された時間中に executeComplete() メソッド、もしくは interruptComplete() が実行されなかった場合にエラーが送出されます。
この値が 0 に設定されている場合、タイムアウトは発生しません。
| Command | |
| sound : Sound
再生する Sound オブジェクトを取得または設定します。
| DoSound | ||
| thresholdLength : int [static] | Command | |
| timeOut : int
コマンド実行処理、および中断処理のタイムアウト時間（ミリ秒）を取得または設定します。
指定された時間中に executeComplete() メソッド、もしくは interruptComplete() が実行されなかった場合にエラーが送出されます。
この値が 0 に設定されている場合、タイムアウトは発生しません。
| Command | |
| waitForComplete : Boolean
サウンドの再生完了を待って、コマンド処理の完了とするかどうかを取得または設定します。
| DoSound | ||
| Method | Defined By | ||
|---|---|---|---|
DoSound(sound:Sound, waitForComplete:Boolean = false, initObject:Object = null)
新しい DoSound インスタンスを作成します。
Creates a new DoSound object.
| DoSound | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override]
イベントリスナーオブジェクトを EventIntegrator インスタンスに登録し、リスナーがイベントの通知を受け取るようにします。
このメソッドを使用して登録されたリスナーを removeEventListener() メソッドで削除した場合には、restoreRemovedListeners() メソッドで再登録させることができます。
Register the event listener object into the EventIntegrator instance to get the event notification. | EventIntegrator | |
| addExclusivelyEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventIntegrator インスタンスに登録し、リスナーがイベントの通知を受け取るようにします。
このメソッドを使用して登録されたリスナーは、IEventIntegrator インスタンスの管理外となるため、removeEventListener() メソッドで削除した場合にも、restoreRemovedListeners() メソッドで再登録させることができません。
Register the event listener object into the EventIntegrator instance to get the event notification. | EventIntegrator | |
|
コマンドの実行完了直後に処理させたい関数を設定します。
関数実行時の this 参照は実行しているコマンドインスタンスになります。
| Command | |
|
コマンドに対してすぐに関数を実行します。
関数実行時の this 参照は実行しているコマンドインスタンスになります。
| Command | |
|
コマンドの実行直前に処理させたい関数を設定します。
関数実行時の this 参照は実行しているコマンドインスタンスになります。
| Command | |
[override]
DoSound インスタンスのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。
Duplicates an instance of an DoSound subclass.
| DoSound | ||
| completelyRemoveEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventIntegrator インスタンスからリスナーを削除します。
このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができません。
Remove the listener from EventIntegrator instance. | EventIntegrator | |
| dispatchEvent(event:Event):Boolean [override]
イベントをイベントフローに送出します。
Dispatches an event into the event flow.
| EventIntegrator | |
|
コマンド実行中に例外エラーが発生した場合に呼び出される関数を設定します。
関数実行時の this 参照はエラーが発生したコマンドインスタンスになります。
| Command | |
| execute(extra:Object = null):void
コマンドを実行します。
| Command | |
| executeComplete():void
実行中のコマンド処理が完了したことを通知します。
このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。
| Command | |
| getCommandById(id:String):Command
指定された id と同じ値が設定されている Command インスタンスを返します。
| Command | |
| getCommandsByGroup(group:String, sort:Boolean = false):Array
指定された group と同じ値を持つ Command インスタンスを含む配列を返します。
| Command | |
| getCommandsByRegExp(fieldName:String, pattern:RegExp, sort:Boolean = false):Array
指定された fieldName が条件と一致する Command インスタンスを含む配列を返します。
| Command | |
| hasEventListener(type:String):Boolean [override]
EventIntegrator インスタンスに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
| EventIntegrator | |
| interrupt(enforced:Boolean = false, extra:Object = null):void
コマンド処理を中断します。
このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。
| Command | |
| interruptComplete():void
実行中のコマンド中断処理が完了したことを通知します。
このメソッドを実行するためには、事前に interrupt() メソッドが実行されている必要があります。
| Command | |
|
コマンド実行中にイベントが発生した場合に呼び出されるリスナー関数を設定します。
| Command | |
| removeAllListeners(completely:Boolean = false):void
addEventListener() メソッド経由で登録された全てのイベントリスナー登録を削除します。
完全に登録を削除しなかった場合には、削除されたイベントリスナーを restoreRemovedListeners() メソッドで復帰させることができます。
Remove the whole event listener registered via addEventListener() method. | EventIntegrator | |
| removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override]
EventIntegrator インスタンスからリスナーを削除します。
このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができます。
Remove the listener from EventIntegrator instance. | EventIntegrator | |
| restoreRemovedListeners():void
removeEventListener() メソッド、または removeAllListeners() メソッド経由で削除された全てイベントリスナーを再登録します。
Re-register the whole event listener removed via removeEventListener() or removeAllListeners() method.
| EventIntegrator | |
| setProperties(props:Object):Command
コマンドに対して、複数のプロパティを一括設定します。
| Command | |
| toString():String [override]
指定されたオブジェクトのストリング表現を返します。
Returns the string representation of the specified object.
| Command | |
| willTrigger(type:String):Boolean [override]
指定されたイベントタイプについて、この EventIntegrator インスタンスまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
| EventIntegrator | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| コマンドがコマンドリストに追加された場合に送出されます。 | Command | ||
| コマンドの処理が完了した場合に送出されます。 | Command | ||
| コマンド処理中にエラーが発生した場合に送出されます。 | Command | ||
| コマンドの処理を停止した場合に送出されます。 | Command | ||
| コマンドがコマンドリストから削除された場合に送出されます。 | Command | ||
| コマンドの処理が開始された場合に送出されます。 | Command | ||
| データが正常にロードされたときに送出されます。 | DoSound | |||
| MP3 サウンドで ID3 データを使用できる場合に、Sound オブジェクトによって送出されます。 | DoSound | |||
| 入出力エラーが発生してロード処理が失敗したときに送出されます。 | DoSound | |||
| ロード操作が開始したときに送出されます。 | DoSound | |||
| ダウンロード処理を実行中にデータを受信したときに送出されます。 | DoSound | |||
| サウンドの再生が終了したときに送出されます。 | DoSound | |||
| sound | property |
Hide Inherited Public Properties
Show Inherited Public Propertiessound:Sound再生する Sound オブジェクトを取得または設定します。
public function get sound():Sound public function set sound(value:Sound):void| waitForComplete | property |
waitForComplete:Booleanサウンドの再生完了を待って、コマンド処理の完了とするかどうかを取得または設定します。
public function get waitForComplete():Boolean public function set waitForComplete(value:Boolean):void| DoSound | () | Constructor |
public function DoSound(sound:Sound, waitForComplete:Boolean = false, initObject:Object = null)新しい DoSound インスタンスを作成します。 Creates a new DoSound object.
Parameterssound:Sound — 再生する Sound オブジェクトです。
| |
waitForComplete:Boolean (default = false) | |
initObject:Object (default = null) |
| clone | () | method |
override public function clone():CommandDoSound インスタンスのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。 Duplicates an instance of an DoSound subclass.
ReturnsCommand —
元のオブジェクトと同じプロパティ値を含む新しい DoSound インスタンスです。
A new DoSound object that is identical to the original.
|
| complete | Event |
flash.events.Eventflash.events.Event.COMPLETEデータが正常にロードされたときに送出されます。
| id3 | Event |
flash.events.Eventflash.events.Event.ID3MP3 サウンドで ID3 データを使用できる場合に、Sound オブジェクトによって送出されます。
| ioError | Event |
flash.events.IOErrorEventflash.events.IOErrorEvent.IO_ERROR入出力エラーが発生してロード処理が失敗したときに送出されます。
| open | Event |
flash.events.Eventflash.events.Event.OPENロード操作が開始したときに送出されます。
| progress | Event |
flash.events.ProgressEventflash.events.ProgressEvent.PROGRESSダウンロード処理を実行中にデータを受信したときに送出されます。
| soundComplete | Event |
flash.events.Eventflash.events.Event.SOUND_COMPLETEサウンドの再生が終了したときに送出されます。
// DoSound コマンドを作成します。
var com:DoSound = new DoSound( new Sound(), false );
// DoSound コマンドを実行します。
com.execute();