Packagejp.progression.commands.media
Classpublic class DoSound
InheritanceDoSound Inheritance Command Inheritance flash.events.EventDispatcher

DoSound クラスは、Sound の再生を制御するコマンドクラスです。


Example 
  // DoSound インスタンスを作成する
  var com:DoSound = new DoSound();
  
  // コマンドを実行する
  com.execute();


Public Properties
 PropertyDefined by
 InheritedcatchError : Function
コマンドの実行中に例外が発生した際に実行するエラー処理関数を取得または設定します。
Command
 InheritedclassName : String
インスタンスのクラス名を取得します。 Indicates the instance className of the Command.
Command
 InheriteddefaultInterruptType : int
[static] interruptType プロパティの初期値を取得または設定します。 すでに生成済みのコマンドに対しては適用されません。
Command
 InheriteddefaultTimeout : Number
[static] timeout プロパティの初期値を取得または設定します。 すでに生成済みのコマンドに対しては適用されません。
Command
 Inheriteddelay : Number
コマンドが実際に実行されるまでの遅延時間を取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。
Command
 Inheriteddepth : int
コマンドツリー構造上での自身の深度を取得します。
Command
 Inheritedextra : Object
コマンドの実行処理、または中断処理の開始時に指定されているリレーオブジェクトを取得または設定します。 このコマンドが親の CommandList インスタンスによって実行されている場合には、親のリレーオブジェクトを順々に引き継ぎます。
Command
 Inheritedgroup : String
インスタンスのグループ名を取得または設定します。 Indicates the instance group of the Command.
Command
 Inheritedid : String
インスタンスを表すユニークな識別子を取得または設定します。
Command
 InheritedinterruptType : int
中断処理時の処理方法を取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。
Command
 InheritedlatestData : *
自身から見て最後に関連付けられた読み込みデータを取得または設定します。 このコマンドが CommandList インスタンス上に存在する場合には、自身より前、または自身の親のデータを取得します。
Command
  loops : int
サウンドチャンネルの再生が停止するまで startTime 値に戻ってサウンドの再生を繰り返す回数を取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。
DoSound
 Inheritedname : String
インスタンスの名前を取得または設定します。 Indicates the instance name of the Command.
Command
 Inheritednext : Command
このコマンドが関連付けられている親の CommandList インスタンス内で、次に位置する Command インスタンスを取得します。
Command
 InheritedonComplete : Function
コマンドオブジェクトが ExecuteEvent.EXECUTE_COMPLETE イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
Command
 InheritedonError : Function
コマンドオブジェクトが ExecuteErrorEvent.EXECUTE_ERROR イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
Command
 InheritedonInterrupt : Function
コマンドオブジェクトが ExecuteEvent.EXECUTE_INTERRUPT イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
Command
 InheritedonStart : Function
コマンドオブジェクトが ExecuteEvent.EXECUTE_START イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
Command
 Inheritedparent : CommandList
この Command オブジェクトを含む CommandList オブジェクトを示します。 Indicates the CommandList object that contains this Command object.
Command
 Inheritedprevious : Command
このコマンドが関連付けられている親の CommandList インスタンス内で、一つ前に位置する Command インスタンスを取得します。
Command
 Inheritedroot : Command
コマンドツリー構造の一番上に位置する Command インスタンスを取得します。
Command
 Inheritedscope : Object
コマンドの実行処理、または中断処理に指定されている関数内でのスコープ対象を取得または設定します。
Command
  sound : Sound
再生する Sound オブジェクトを取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。
DoSound
  soundChannel : SoundChannel
[read-only] 再生中の SoundChannel インスタンスを取得します。 コマンド実行中に値を変更しても、処理に対して反映されません。
DoSound
  soundTransform : SoundTransform
サウンドチャンネルに割り当てられる初期 SoundTransform オブジェクトを取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。
DoSound
  startTime : Number
再生を開始する初期位置（ミリ秒単位）を取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。
DoSound
 Inheritedstate : int
コマンドの実行状態を取得します。
Command
 InheritedthresholdLength : int
[static] 同一プロセス上で実行可能な最大コマンド数を取得または設定します。 設定された閾値を超えて実行された場合には、強制的に 1 ミリ秒の遅延を発生させます。 この値が大きすぎる場合、スタックオーバーフローが発生する可能性があります。
Command
 Inheritedtimeout : Number
コマンドの実行中のタイムアウト時間を取得または設定します。 指定された時間中に executeComplete() メソッド、または interrupt() メソッドが実行されなかった場合にはエラーが送出されます。 この値が 0 に設定されている場合、タイムアウト処理は発生しません。
Command
  waitForComplete : Boolean
サウンドの再生完了を待って、コマンド処理の完了とするかどうかを取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。
DoSound
Public Methods
 MethodDefined by
  
DoSound(sound:Sound, startTime:Number = 0, loops:int = 0, waitForComplete:Boolean = false, initObject:Object = null)
新しい DoSound インスタンスを作成します。 Creates a new DoSound object.
DoSound
  
clone():Command
DoSound インスタンスのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。 Duplicates an instance of an DoSound subclass.
DoSound
  
dispose():void
保持しているデータを解放します。
DoSound
 Inherited
execute(extra:Object = null):void
コマンド処理を実行します。
Command
 Inherited
executeComplete():void
実行中のコマンド処理が完了したことを通知します。 このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。
Command
 Inherited
interrupt(enforced:Boolean = false):void
コマンド処理を中断します。 このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。
Command
 Inherited
setProperties(parameters:Object):Command
インスタンスに対して、複数のプロパティを一括設定します。
Command
  
toString():String
指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.
DoSound
Protected Methods
 MethodDefined by
 Inherited
throwError(target:Command, error:Error):void
コマンド処理中に例外が発生したことを通知します。 エラー処理が発生すると、コマンド処理が停止します。 問題を解決し、通常フローに戻す場合には executeComplete() メソッドを、問題が解決されず中断処理を行いたい場合には interrupt() メソッドを実行してください。 関数内で問題が解決、または中断処理に移行しなかった場合には ExecuteErrorEvent.EXECUTE_ERROR イベントが送出されます。
Command
Events
 EventSummaryDefined by
 Inherited
executeComplete
処理が完了した場合に送出されます。 Command
 Inherited
executeError
処理の途中でエラーが発生した場合に送出されます。 Command
 Inherited
executeInterrupt
処理が中断された場合に送出されます。 Command
 Inherited
executeStart
処理が開始された場合に送出されます。 Command
Property detail
loopsproperty
loops:int  [read-write]

サウンドチャンネルの再生が停止するまで startTime 値に戻ってサウンドの再生を繰り返す回数を取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。

Implementation
    public function get loops():int
    public function set loops(value:int):void
soundproperty 
sound:Sound  [read-write]

再生する Sound オブジェクトを取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。

Implementation
    public function get sound():Sound
    public function set sound(value:Sound):void
soundChannelproperty 
soundChannel:SoundChannel  [read-only]

再生中の SoundChannel インスタンスを取得します。 コマンド実行中に値を変更しても、処理に対して反映されません。

Implementation
    public function get soundChannel():SoundChannel
soundTransformproperty 
soundTransform:SoundTransform  [read-write]

サウンドチャンネルに割り当てられる初期 SoundTransform オブジェクトを取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。

Implementation
    public function get soundTransform():SoundTransform
    public function set soundTransform(value:SoundTransform):void
startTimeproperty 
startTime:Number  [read-write]

再生を開始する初期位置（ミリ秒単位）を取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。

Implementation
    public function get startTime():Number
    public function set startTime(value:Number):void
waitForCompleteproperty 
waitForComplete:Boolean  [read-write]

サウンドの再生完了を待って、コマンド処理の完了とするかどうかを取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。

Implementation
    public function get waitForComplete():Boolean
    public function set waitForComplete(value:Boolean):void
Constructor detail
DoSound()constructor
public function DoSound(sound:Sound, startTime:Number = 0, loops:int = 0, waitForComplete:Boolean = false, initObject:Object = null)

新しい DoSound インスタンスを作成します。 Creates a new DoSound object.

Parameters
sound:Sound — 再生する Sound オブジェクトです。
 
startTime:Number (default = 0) — 再生を開始する初期位置（ミリ秒単位）です。 The initial position in milliseconds at which playback should start.
 
loops:int (default = 0) — サウンドチャンネルの再生が停止するまで startTime 値に戻ってサウンドの再生を繰り返す回数を定義します。 Defines the number of times a sound loops back to the startTime value before the sound channel stops playback.
 
waitForComplete:Boolean (default = false) — サウンドの再生完了を待って、コマンド処理の完了とするかどうかです。
 
initObject:Object (default = null) — 設定したいプロパティを含んだオブジェクトです。
Method detail
clone()method
public override function clone():Command

DoSound インスタンスのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。 Duplicates an instance of an DoSound subclass.

Returns
Command — 元のオブジェクトと同じプロパティ値を含む新しい DoSound インスタンスです。 A new DoSound object that is identical to the original.
dispose()method 
public override function dispose():void

保持しているデータを解放します。

toString()method 
public override function toString():String

指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.

Returns
String — オブジェクトのストリング表現です。 A string representation of the object.



Copyright (C) 2007-2010 taka:nium.jp. All Rights Reserved.