Songbird / Development / Songbird Add-Ons API Documentation

sbIMediacoreSequencer Interface Reference

List of all members.

Public Member Functions

void playView (in sbIMediaListView aView,[optional] in long long aItemIndex)
 Play a media list view as a sequence. Optionally provide the index of the item in the view that should play first in the sequence.
void playURL (in nsIURI aURI)
 Play a single URL as a sequence.
void play ()
 Play the sequence.
void stop ()
 Stop the sequence.
void next ()
 Go to the next item in the sequence.
void previous ()
 Go to the previous item in the sequence.
void requestHandleNextItem (in sbIMediacore aMediacore)
 Indicate that the current core will handle the next item in the sequence when the stream ends.
void abort ()
 Abort the current item playback attempt.

Public Attributes

const unsigned long MODE_FORWARD = 0
const unsigned long MODE_REVERSE = 1
const unsigned long MODE_SHUFFLE = 1 << 1
const unsigned long MODE_CUSTOM = 1 << 16
attribute unsigned long mode
const unsigned long MODE_REPEAT_NONE = 0
const unsigned long MODE_REPEAT_ONE = 1
const unsigned long MODE_REPEAT_ALL = 1 << 1
attribute unsigned long repeatMode
attribute sbIMediaListView view
 The view that was used to generate the current sequence.
readonly attribute unsigned
long 
viewPosition
 The current position in the view. This position is tied to the sequencePosition.
readonly attribute sbIMediaItem currentItem
 The current item in the view.
readonly attribute sbIMediaItem nextItem
 The next item in the sequence.
readonly attribute nsIArray currentSequence
 The current sequence.
attribute unsigned long sequencePosition
 The current position in the sequence. This position is tied to the viewPosition.
const long AUTO_PICK_INDEX = -1
 Allow the sequencer to pick the most appropriate start index for a sequence.
attribute sbIMediacoreSequenceGenerator customGenerator

Detailed Description

Definition at line 39 of file sbIMediacoreSequencer.idl.


Member Function Documentation

void sbIMediacoreSequencer::playView ( in sbIMediaListView  aView,
[optional] in long long  aItemIndex 
)

Play a media list view as a sequence. Optionally provide the index of the item in the view that should play first in the sequence.

Parameters:
aView The view you wish to play.
aItemIndex The index of the item inside the view to play first. You may pass sbIMediacoreSequencer::AUTO_PICK_INDEX if you wish to have the sequencer pick the most appropriate start index for the sequence.
See also:
AUTO_PICK_INDEX

void sbIMediacoreSequencer::abort (  ) 

Abort the current item playback attempt.

Note:
This method may only be called from BEFORE_TRACK_CHANGE. If you attempt to call it from another context, it will silently fail.


Member Data Documentation

readonly attribute unsigned long sbIMediacoreSequencer::viewPosition

The current position in the view. This position is tied to the sequencePosition.

Exceptions:
NS_ERROR_NOT_AVAILABLE when the sequence position is invalid.

Definition at line 65 of file sbIMediacoreSequencer.idl.

readonly attribute sbIMediaItem sbIMediacoreSequencer::currentItem

The current item in the view.

Note:
This is the equivalent of calling sbIMediaListView::getItemByIndex using viewPosition.

This may be null if there is no currentItem.

Definition at line 73 of file sbIMediacoreSequencer.idl.

readonly attribute sbIMediaItem sbIMediacoreSequencer::nextItem

The next item in the sequence.

Note:
This is equivalent to getting the current sequence and asking it for sequencePosition + 1.

This may be null if there is no next item.

Definition at line 81 of file sbIMediacoreSequencer.idl.

attribute unsigned long sbIMediacoreSequencer::sequencePosition

The current position in the sequence. This position is tied to the viewPosition.

Exceptions:
NS_ERROR_NOT_AVAILABLE when the sequence position is invalid.

Definition at line 93 of file sbIMediacoreSequencer.idl.

const long sbIMediacoreSequencer::AUTO_PICK_INDEX = -1

Allow the sequencer to pick the most appropriate start index for a sequence.

The sequencer will pick a random index for the start of the sequence if shuffle is enabled. If shuffle is disabled, the sequencer will pick the first available index: 0.

See also:
playView

Definition at line 118 of file sbIMediacoreSequencer.idl.


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:29:00 2009 for Songbird by  doxygen 1.5.2