The SoundLoaderContext to use with the sequencer. This object is passed to the constructor of the internal SoundEx object when an audio file is loaded.

The frequency, in milliseconds, that the sequencer will use to check the child elements of the current storyboard.

The default value is 100.

Returns or sets the position in the audio file.

When this property value is set, and the status property value is SequencerStatusTypes.PLAYING, playback stops and the status is changed to SequencerStatusTypes.PAUSED. If the status property value is SequencerStatusTypes.STOPPED, SequencerStatusTypes.EOF, or SequencerStatusTypes.LOAD_COMPLETE, the status is changed to SequencerStatusTypes.PAUSED. If the status is not one of the values listed above, an error is thrown.

The AssetResolver to use to request audio files. When this value is set to a non-null value, the sequencer registers itself with the resolver as an owner, and all content requested is requested using itself as the owner.

If the sequencer is currently loading content, all load actions in progress will be cancelled when this property is set. When removing the references to an existing resolver, the sequencer will unregister itself as an owner. If the new property value is not null, the sequencer will register itself as an owner.

The SoundTransform object to use when playing an audio file. This object is passed to the internal SoundEx object.

The current status of the sequencer. This value will be one of the SequencerStatusTypes constant values.

See also

Specifies the storyboard for the player.

If null is passed, the current storyboard is unloaded, the StoryboardEvent.UNLOAD event is dispatched, and no further action occurs.

If a non- null storyboard object is passed, the following actions occur, in order:

1. If the previously loaded storyboard is not null, the StoryboardEvent.UNLOAD event is dispatched. If the event is not cancelled, the current storyboard is unloaded. If the event is cancelled, further processing stops.
2. The StoryboardEvent.LOAD_START event is dispatched. If the event is not cancelled, the new storyboard is associated with the player. If the event is cancelled, further processing stops and the value of this property is set to null.
3. If the value of the new storyboard's Initialized persisted property is false, the storyboard is initialized and the StoryboardEvent.INITIALIZE event is dispatched.
4. If an audio file is specified, content load begins, and the contentLoadBegin event is dispatched.
5. If the audio file finishes loading, the contentLoadEnd event is dispatched, followed by the loadComplete event.
6. If the loadComplete event was dispatched, the checkForComplete() method is invoked. If all completion criteria have been met, the complete event is dispatched.

Note that the AudioSequencer may raise one or move SequencerStatusEvent.STATUS_CHANGED events during storyboard load. If the resolver property is null, the audio file will not be rendered, and no error will occur.

See also

Indicates whether or not the last position should be used to begin audio playback of a previously loaded storyboard.

The default value is false.

Creates a new instance of the AudioSequencer.

Parameters

Loads the storyboard.

This method is invoked by the storyboard property set method. Unlike other player classes, this method is invoked even if a null storyboard object is loaded. This method is invoked after initialization (if needed) occurs.

When loading a storyboard, the AudioSequencer performs the following actions:

• If the alwaysCheckComplete property value is true, each child element's Complete persisted property value is set to false.
• If the storyboard property value is null, the status property value is set to SequencerStatusTypes.NO_STORYBOARD, the SequencerStatusEvent.STATUS_CHANGED event is dispatched, and further processing stops.
• The child elements of the children collection of the storyboard are sorted by the value of each element's position persisted property, in ascending order.
• If the resolver property value is null, the status property value is set to SequencerStatusTypes.NO_RESOLVER, the SequencerStatusEvent.STATUS_CHANGED event is dispatched, the StoryboardEvent.LOAD_COMPLETE event is dispatched, the checkForComplete() method is invoked, and further processing stops.
• If no audio file is specified, the status property value is set to SequencerStatusTypes.EMPTY, the SequencerStatusEvent.STATUS_CHANGED event is dispatched, the StoryboardEvent.LOAD_COMPLETE event is dispatched, the checkForComplete() method is invoked, and further processing stops.
• Audio file loading begins.
• The superclass method is invoked.

See also

Pauses or resumes playback of the audio file.

If the status property value is SequencerStatusTypes.PAUSED, this method resumes playback of the audio file from the value of position. If the status property value is one of the following, this method pauses playback of the audio file at the current position:

• SequencerStatusTypes.PLAYING
• SequencerStatusTypes.LOAD_COMPLETE

For all other status property values, invoking this method has no effect.

If this method pauses playback, the player will dispatch the SequencerStatusEvent.STATUS_CHANGE event.

See also

Begins or resumes playback of the audio file.

If the status property value is SequencerStatusTypes.PAUSED, this method resumes playback of the audio file from the value of position. If the status property value is one of the following, this method begins playback of the audio file from the beginning:

• SequencerStatusTypes.STOPPED
• SequencerStatusTypes.EOF
• SequencerStatusTypes.LOAD_COMPLETE

For all other status property values, invoking this method has no effect.

If this method begins playback, the player will dispatch the SequencerStatusEvent.STATUS_CHANGE event.

See also

Removes known completion criteria from the CompleteRemaining storyboard persisted property.

This method is invoked by the checkForComplete() method if the value of the storyboard property is not null, and the complete event has not been dispatched since the storyboard was loaded.

In addition to the substrings processed by the BasePlayer, the AudioSequencer will remove the following substrings from the completeRemaining persisted property:

See also

Removes all properties set by the player.

Note that this method also removes interim completion properties used by the player, but not necessarily set by the player.

Parameters

Parameters

Stops playback of the audio file and sets the position property value to 0.

If the status property value is not SequencerStatusTypes.PAUSED, SequencerStatusTypes.PLAYING, SequencerStatusTypes.EOF, or SequencerStatusTypes.LOAD_COMPLETE, invoking this method has no effect.

If this method stops playback, the player will dispatch the SequencerStatusEvent.STATUS_CHANGE event.

See also

Performs cleanup actions when a storyboard is unloaded.

This method is invoked by the storyboard property set method when the current value of the property is not null and the unload event has not been cancelled.

When unloading a storyboard, the AudioSequencer performs the following actions:

• Audio file playback stops, and the internal sound objects are deleted.
• The resolver's cancelOwnerTransaction() method is invoked.
• Any content currently loading is closed by invoking the resolver's closeAllOf() method.
• The current value of the position property is saved to the storyboard's LastPosition persisted property.
• The superclass method is invoked.

See also

Dispatched when the sequencer begins to load external assets.

This event is dispatched when the storyboard property is set to a non-null value.

This event will occur if any external assets are defined, even if they cannot be loaded. This event is dispatched when the resolverInfo object whose owner property value is the player dispatches its beginTransaction event.

Dispatched when all external assets have finished loading.

This event will occur if any external assets are defined, even if they cannot be loaded. This event is dispatched when the resolverInfo object whose owner property value is the player dispatches its endTransaction event.

Dispatched when a sequencer element should be processed.

This event is dispatched when the sequencer's status property is SequencerStatusTypes.PLAYING and a child element object's Position persisted property value is <= the value of the sequencer's position property value and the element's Complete persisted property value is false. A CueEvent.CUE event is dispatched for each child element that meets this criteria.

Note that the child elements in the storyboard's children collection are sorted by the value of their Position persisted property value each time the storyboard is loaded; this ensures that the cue events occur "in order".

Dispatched when the status of the sequencer changes.

Dispatched when the audio has finished playing.

Dispatched when the internal timer fires. This event is dispatched when the sequencer's status property is SequencerStatusTypes.PLAYING, before any CueEvent.CUE events are dispatched.