startSoundStream Element

The startSoundStream element plays a sound object from the objects collection as clip audio stream. Each clip represented by movie or sprite may contain only one audio stream.

Syntax

<startSoundStream objectId="objectId" [trimFrames="nFramesToTrim"] [trimToMovie="trimToMovie"] [stopOnFinish="stopWhenCompleted"]/>

Attributes

Name

Description

Value type

Optional

Default Value

objectId

Sound object ID from the objects collection.

id

no

-

trimFrames

If you need to use some fragment from source audio object you may specify stream duration in movie frames here. This attribute has higher priority than trimToMovie.

integer

yes

-

trimToMovie

Trims audio stream to movie length if true. Movie length is calculated as all animations sum. By default if audio stream is longer than movie, extra frames are added to movie according to audio stream playing time.

boolean

yes

false

stopOnFinish

If set to true, sound and movie timeline will be stopped when streaming sound completes playback.

boolean

yes

false

Parent Elements

frame element

See Also

XML Schema Reference