SoundEffect

Paket	mx.effects
Sınıf	public class SoundEffect
Miras Alma	SoundEffect Effect EventDispatcher Object

Dil Sürümü:

ActionScript 3.0

Ürün Sürümü:

Flex 3

Çalışma Zamanı Sürümleri:

Flash Player 9, AIR 1.1

The SoundEffect class plays an MP3 audio file. For example, you could play a sound when a user clicks a Button control. This effect lets you repeat the sound, select the source file, and control the volume and pan.

You specify the MP3 file using the source property. If you have already embedded the MP3 file, using the Embed keyword, you can pass the Class object of the MP3 file to the source property. Otherwise, specify the full URL to the MP3 file.

MXML Sözdizimi expanded

MXML Sözdizimini Gizle

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

Örnekleri görüntüle

İlgili API Öğeleri

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

Genel Özellikler

Miras Alınan Genel Özellikleri Gizle

Miras Alınan Genel Özellikleri Göster

	Özellik		Tanımlayan:
		autoLoad : Boolean If true, load the MP3 file when the source has been specified.	SoundEffect
		bufferTime : Number = 1000 The SoundEffect class uses an internal Sound object to control the MP3 file.	SoundEffect
		className : String [salt okunur] The name of the effect class, such as "Fade".	Effect
		constructor : Object Belirli bir nesne örneği için sınıf nesnesine veya yapıcı işlevine bir başvuru.	Object
		customFilter : mx.effects:EffectTargetFilter Specifies a custom filter object, of type EffectTargetFilter, used by the effect to determine the targets on which to play the effect.	Effect
		duration : Number Duration of the effect in milliseconds.	Effect
		effectTargetHost : mx.effects:IEffectTargetHost A property that lets you access the target list-based control of a data effect.	Effect
		filter : String Specifies an algorithm for filtering targets for an effect.	Effect
		hideFocusRing : Boolean Determines whether the effect should hide the focus ring when starting the effect.	Effect
		instanceClass : Class An object of type Class that specifies the effect instance class class for this effect class.	Effect
		isLoading : Boolean [salt okunur] This property is true if the MP3 has been loaded.	SoundEffect
		isPlaying : Boolean [salt okunur] A read-only flag which is true if any instances of the effect are currently playing, and false if none are.	Effect
		loops : int = 0 The number of times to play the sound in a loop, where a value of 0 means play the effect once, a value of 1 means play the effect twice, and so on.	SoundEffect
		panEasingFunction : Function The easing function for the pan effect.	SoundEffect
		panFrom : Number Initial pan of the Sound object.	SoundEffect
		panTo : Number Final pan of the Sound object.	SoundEffect
		perElementOffset : Number Additional delay, in milliseconds, for effect targets after the first target of the effect.	Effect
		playheadTime : Number Current time position of the effect.	Effect
		relevantProperties : Array An Array of property names to use when performing filtering.	Effect
		relevantStyles : Array An Array of style names to use when performing filtering.	Effect
		repeatCount : int = 1 Number of times to repeat the effect.	Effect
		repeatDelay : int = 0 Amount of time, in milliseconds, to wait before repeating the effect.	Effect
		sound : Sound [salt okunur] The Sound object that the MP3 file has been loaded into.	SoundEffect
		source : Object The URL or class of the MP3 file to play.	SoundEffect
		startDelay : int = 0 Amount of time, in milliseconds, to wait before starting the effect.	Effect
		startTime : Number = 0 The initial position in the MP3 file, in milliseconds, at which playback should start.	SoundEffect
		suspendBackgroundProcessing : Boolean = false If true, blocks all background processing while the effect is playing.	Effect
		target : Object The object to which this effect is applied.	Effect
		targets : Array An Array of objects that are targets for the effect.	Effect
		triggerEvent : Event The Event object passed to this Effect by the EffectManager when an effect is triggered, or null if the effect is not being played by the EffectManager.	Effect
		useDuration : Boolean = true If true, stop the effect after the time specified by the duration property has elapsed.	SoundEffect
		volumeEasingFunction : Function The easing function for the volume effect.	SoundEffect
		volumeFrom : Number Initial volume of the Sound object.	SoundEffect
		volumeTo : Number Final volume of the Sound object.	SoundEffect

Korunan Özellikler

Miras Alınan Korunan Özellikleri Gizle

Miras Alınan Korunan Özellikleri Göster

	Özellik		Tanımlayan:
		applyTransitionEndProperties : Boolean This flag controls whether the effect, when run in a transition, automatically applies the property values according to the end state, as opposed to leaving values as set by the effect itself.	Effect
		endValuesCaptured : Boolean = false A flag containing true if the end values of an effect have already been determined, or false if they should be acquired from the current properties of the effect targets when the effect runs.	Effect

Genel Yöntemler

Miras Alınan Genel Yöntemleri Gizle

Miras Alınan Genel Yöntemleri Göster

	Yöntem		Tanımlayan:
		SoundEffect(target:Object = null) Constructor.	SoundEffect
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void EventDispatcher nesnesi olan bir olay dinleyici nesnesini, dinleyicinin bir olayın bildirimini alması için kaydeder.	EventDispatcher
		captureEndValues():void Captures the current values of the relevant properties on the effect's targets and saves them as end values.	Effect
		captureMoreStartValues(targets:Array):void Captures the current values of the relevant properties of an additional set of targets Flex uses this function when a data change effect is run.	Effect
		captureStartValues():void Captures the current values of the relevant properties on the effect's targets.	Effect
		createInstance(target:Object = null):IEffectInstance Creates a single effect instance and initializes it.	Effect
		createInstances(targets:Array = null):Array Takes an Array of target objects and invokes the createInstance() method on each target.	Effect
		deleteInstance(instance:IEffectInstance):void Removes event listeners from an instance and removes it from the list of instances.	Effect
		dispatchEvent(event:Event):Boolean Olay akışına bir olay gönderir.	EventDispatcher
		end(effectInstance:IEffectInstance = null):void Interrupts an effect that is currently playing, and jumps immediately to the end of the effect.	Effect
		getAffectedProperties():Array Returns an Array of Strings, where each String is the name of a property changed by this effect.	Effect
		hasEventListener(type:String):Boolean EventDispatcher nesnesinin belirli bir olay türü için kayıtlı dinleyicisi olup olmadığını kontrol eder.	EventDispatcher
		hasOwnProperty(name:String):Boolean Bir nesnenin belirli bir özelliğinin tanımlı olup olmadığını gösterir.	Object
		isPrototypeOf(theClass:Object):Boolean Object sınıfının bir örneğinin parametre olarak belirtilen nesnenin prototip zincirinde olup olmadığını gösterir.	Object
		load():void Loads the MP3 if the source property points to a URL.	SoundEffect
		pause():void Pauses the effect until you call the resume() method.	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array Begins playing the effect.	Effect
		propertyIsEnumerable(name:String):Boolean Belirtilen özelliğin bulunup bulunmadığını ve numaralandırılabilir olup olmadığını gösterir.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher nesnesinden bir dinleyiciyi kaldırır.	EventDispatcher
		resume():void Resumes the effect after it has been paused by a call to the pause() method.	Effect
		reverse():void Plays the effect in reverse, if the effect is currently playing, starting from the current position of the effect.	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Dinamik bir özelliğin döngü işlemlerinde kullanılabilirliğini ayarlar.	Object
		stop():void Stops the effect, leaving the effect targets in their current state.	Effect
		toLocaleString():String Bu nesnenin, yerel ayara özel kurallara göre biçimlendirilmiş dize temsilini döndürür.	Object
		toString():String Belirtilen nesnenin dize olarak temsil edilen halini döndürür.	Object
		valueOf():Object Belirtilen nesnenin temel değerini döndürür.	Object
		willTrigger(type:String):Boolean Bir olay dinleyicisinin bu EventDispatcher nesnesiyle mi, yoksa onun belirtilen olay türüne yönelik üst öğelerinden biriyle mi kayıtlı olduğunu kontrol eder.	EventDispatcher

Korunan Yöntemler

Miras Alınan Korunan Yöntemleri Gizle

Miras Alınan Korunan Yöntemleri Göster

	Yöntem		Tanımlayan:
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void Used internally by the Effect infrastructure.	Effect
		effectEndHandler(event:EffectEvent):void Called when an effect instance has finished playing.	Effect
		effectStartHandler(event:EffectEvent):void This method is called when the effect instance starts playing.	Effect
		effectStopHandler(event:EffectEvent):void Called when an effect instance has stopped by a call to the stop() method.	Effect
		filterInstance(propChanges:Array, target:Object):Boolean Determines the logic for filtering out an effect instance.	Effect
		getValueFromTarget(target:Object, property:String):* Called by the captureStartValues() method to get the value of a property from the target.	Effect
		initInstance(instance:IEffectInstance):void Copies properties of the effect to the effect instance.	Effect

Olaylar

Olaylarla ilgili daha fazla bilgi için tıklatın

Miras Alınan Olayları Gizle

Miras Alınan Olayları Göster

	Özet	Tanımlayan:
activate	[broadcast olayı] Flash Player veya AIR uygulaması işletim sistemi odağına gelip etkin olduğunda gönderilir.	EventDispatcher
complete	Dispatched when the sound file finishes loading.	SoundEffect
deactivate	[broadcast olayı] Çalışan Flash Player veya AIR uygulaması sistem odağını kaybettiğinde ve etkin olmayan duruma geldiğinde gönderilir.	EventDispatcher
effectEnd	Dispatched when one of the effect's instances finishes playing, either when the instance finishes playing or when the effect is interrupted by a call to the end() method.	Effect
effectStart	Dispatched when the effect starts playing.	Effect
effectStop	Dispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method.	Effect
id3	Dispatched when ID3 data is available for an MP3 sound file.	SoundEffect
ioError	Dispatched when an error occurs during the loading of the sound file.	SoundEffect
progress	Dispatched periodically as the sound file loads.	SoundEffect

Özellik Ayrıntısı

autoLoad

özellik

autoLoad:Boolean

Dil Sürümü:

ActionScript 3.0

Ürün Sürümü:

Flex 3

Çalışma Zamanı Sürümleri:

Flash Player 9, AIR 1.1

If true, load the MP3 file when the source has been specified.

Varsayılan değer şudur true.

Uygulama
public function get autoLoad():Boolean
public function set autoLoad(value:Boolean):void

bufferTime

özellik

public var bufferTime:Number = 1000

Dil Sürümü:

ActionScript 3.0

Ürün Sürümü:

Flex 3

Çalışma Zamanı Sürümleri:

Flash Player 9, AIR 1.1

The SoundEffect class uses an internal Sound object to control the MP3 file. This property specifies the minimum number of milliseconds worth of sound data to hold in the Sound object's buffer. The Sound object waits until it has at least this much data before beginning playback, and before resuming playback after a network stall.

Varsayılan değer şudur 1000.

isLoading

özellik

isLoading:Boolean [salt okunur]

Dil Sürümü:

ActionScript 3.0

Ürün Sürümü:

Flex 3

Çalışma Zamanı Sürümleri:

Flash Player 9, AIR 1.1

This property is true if the MP3 has been loaded.

Uygulama
public function get isLoading():Boolean

loops

özellik

public var loops:int = 0

Dil Sürümü:

ActionScript 3.0

Ürün Sürümü:

Flex 3

Çalışma Zamanı Sürümleri:

Flash Player 9, AIR 1.1

The number of times to play the sound in a loop, where a value of 0 means play the effect once, a value of 1 means play the effect twice, and so on. If you repeat the MP3 file, it still uses the setting of the useDuration property to determine the playback time.

The duration property takes precedence over this property. If the effect duration is not long enough to play the sound at least once, the sound does not loop.

Varsayılan değer şudur 0.

özellik

public var volumeEasingFunction:Function

Dil Sürümü:

ActionScript 3.0

Ürün Sürümü:

Flex 3

Çalışma Zamanı Sürümleri:

Flash Player 9, AIR 1.1

The easing function for the volume effect. This function is used to interpolate between the values of volumeFrom and volumeTo.

volumeFrom

özellik

public var volumeFrom:Number

Dil Sürümü:

ActionScript 3.0

Ürün Sürümü:

Flex 3

Çalışma Zamanı Sürümleri:

Flash Player 9, AIR 1.1

Initial volume of the Sound object. Value can range from 0.0 to 1.0.

Varsayılan değer şudur 1.

volumeTo

özellik

public var volumeTo:Number

Dil Sürümü:

ActionScript 3.0

Ürün Sürümü:

Flex 3

Çalışma Zamanı Sürümleri:

Flash Player 9, AIR 1.1

Final volume of the Sound object. Value can range from 0.0 to 1.0.

Varsayılan değer şudur 1.

Yapıcı Ayrıntı

()

Yapıcı

public function SoundEffect(target:Object = null)

Dil Sürümü:

ActionScript 3.0

Ürün Sürümü:

Flex 3

Çalışma Zamanı Sürümleri:

Flash Player 9, AIR 1.1

Constructor.

Parametreler

target:Object (default = null) — The Object to animate with this effect.

Yöntem Ayrıntısı

load

()

yöntem

public function load():void

Dil Sürümü:

ActionScript 3.0

Ürün Sürümü:

Flex 3

Çalışma Zamanı Sürümleri:

Flash Player 9, AIR 1.1

Loads the MP3 if the source property points to a URL.

Olay Ayrıntısı

complete

Olay

Olay Nesne Türü: flash.events.Event
özellik Event.type = flash.events.Event.COMPLETE

Dil Sürümü:

ActionScript 3.0

Ürün Sürümü:

Flex 3

Çalışma Zamanı Sürümleri:

Flash Player 9, AIR 1.1

Dispatched when the sound file finishes loading.

Event.COMPLETE sabiti, complete olay nesnesinin type özelliği değerini tanımlar.

Bu olay şu özelliklere sahiptir:

Özellik	Değer
`bubbles`	`false`
`cancelable`	`false`; iptal edilecek varsayılan davranış yoktur.
`currentTarget`	Bu Event nesnesini olay dinleyicisiyle etkin olarak işleyen nesne.
`target`	Yüklemesi tamamlanan network nesnesi.

id3

Olay

Olay Nesne Türü: flash.events.Event
özellik Event.type = flash.events.Event.ID3

Dil Sürümü:

ActionScript 3.0

Ürün Sürümü:

Flex 3

Çalışma Zamanı Sürümleri:

Flash Player 9, AIR 1.1

Dispatched when ID3 data is available for an MP3 sound file.

Event.ID3 sabiti, id3 olay nesnesinin type özelliği değerini tanımlar.

Bu olay şu özelliklere sahiptir:

Özellik	Değer
`bubbles`	`false`
`cancelable`	`false`; iptal edilecek varsayılan davranış yoktur.
`currentTarget`	Bu Event nesnesini olay dinleyicisiyle etkin olarak işleyen nesne.
`target`	ID3 verilerinin şimdi kullanılabilir olduğu MP3'ü yükleyen Sound nesnesi. `target` her zaman olay dinleyicisini kaydeden görüntüleme listesindeki nesne değildir. Geçerli olarak olayı işleyen görüntüleme listesindeki nesneye erişmek için `currentTarget` özelliğini kullanın.

ioError

Olay

Olay Nesne Türü: flash.events.IOErrorEvent
özellik IOErrorEvent.type = flash.events.IOErrorEvent.IO_ERROR

Dil Sürümü:

ActionScript 3.0

Ürün Sürümü:

Flex 3

Çalışma Zamanı Sürümleri:

Flash Player 9, AIR 1.1

Dispatched when an error occurs during the loading of the sound file.

ioError olay nesnesinin type özelliği değerini tanımlar.

Bu olay şu özelliklere sahiptir:

Özellik	Değer
`bubbles`	`false`
`cancelable`	`false`; iptal edilecek varsayılan davranış yoktur.
`currentTarget`	Bu Event nesnesini olay dinleyicisiyle etkin olarak işleyen nesne.
`errorID`	Belirli bir hata mesajıyla ilişkili başvuru numarası (yalnızca AIR).
`target`	Girdi/çıktı hatası yaşayan network nesnesi.
`text`	Hata mesajı olarak gösterilecek metin.

progress

Olay

Olay Nesne Türü: flash.events.ProgressEvent
özellik ProgressEvent.type = flash.events.ProgressEvent.PROGRESS

Dil Sürümü:

ActionScript 3.0

Ürün Sürümü:

Flex 3

Çalışma Zamanı Sürümleri:

Flash Player 9, AIR 1.1

Dispatched periodically as the sound file loads.

Within the event object, you can access the number of bytes currently loaded and the total number of bytes to load. The event is not guaranteed to be dispatched, which means that the complete event might be dispatched without any progress events being dispatched.

Bir progress olay nesnesinin type özelliği değerini tanımlar.

Bu olay şu özelliklere sahiptir:

Özellik	Değer
`bubbles`	`false`
`bytesLoaded`	Dinleyici olayı işlerken yüklenen öğe veya bayt sayısı.
`bytesTotal`	Yükleme işlemi başarılı olursa yüklenecek toplam öğe veya bayt sayısı.
`cancelable`	`false`; iptal edilecek varsayılan davranış yoktur.
`currentTarget`	Bu Event nesnesini olay dinleyicisiyle etkin olarak işleyen nesne.
`target`	İlerlemeyi bildiren nesne.

Örnekler Bu örnek nasıl kullanılır?

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>

Yasal Uyarılar | Çevrimiçi Gizlilik İlkesi

SoundEffect - AS3 Flex

Paketlerx

Dil Öğeleri

Ekler

Paket mx.effects

autoLoad

bufferTime

isLoading

loops

panEasingFunction

panFrom

panTo

sound

source

startTime

useDuration

volumeEasingFunction

volumeFrom

volumeTo

SoundEffect

load

complete

id3

ioError

progress