Songbird / Development / Songbird Add-Ons API Documentation

sbIMediacoreEvent Interface Reference

Definition of the sbIMediacoreEvent interface. More...

import "sbIMediacoreEvent.idl";

List of all members.

Public Attributes

const unsigned long UNINTIALIZED = 0x00000000
const unsigned long METADATA_CHANGE = 0x00001000
 Metadata describing current item has changed.
const unsigned long URI_CHANGE = 0x00001001
 URI used for operation has changed.
const unsigned long DURATION_CHANGE = 0x00001002
 Current duration has changed.
const unsigned long VOLUME_CHANGE = 0x00001003
 Volume has changed.
const unsigned long MUTE_CHANGE = 0x00001004
 Mute status has changed.
const unsigned long BEFORE_TRACK_CHANGE = 0x00001500
 Before the track playing is changed.
const unsigned long TRACK_CHANGE = 0x00001501
 Track playing has changed.
const unsigned long TRACK_INDEX_CHANGE = 0x00001502
 Index in view of item currently playing has changed.
const unsigned long BEFORE_VIEW_CHANGE = 0x00001503
 Sequencer view is about to change.
const unsigned long VIEW_CHANGE = 0x00001504
 Sequencer view changed.
const unsigned long SEQUENCE_CHANGE = 0x00001505
 Sequence recalculated.
const unsigned long STREAM_FOUND = 0x00002000
 Stream found.
const unsigned long STREAM_HAS_VIDEO = 0x00002001
 Stream has video.
const unsigned long BUFFERING = 0x00003000
 Buffering.
const unsigned long BUFFER_UNDERRUN = 0x00003001
 Buffer underrun, operation is likely to halt.
const unsigned long STREAM_START = 0x00004000
 Stream has started.
const unsigned long STREAM_PAUSE = 0x00004001
 Stream is now paused.
const unsigned long STREAM_END = 0x00004002
 End of stream.
const unsigned long STREAM_STOP = 0x00004003
 Stream was stopped.
const unsigned long PLUGIN_MISSING = 0x00008000
 Plugin missing for requested format.
const unsigned long CUSTOM_EVENT_BASE = 0x40000000
 Custom event base value.
const unsigned long ERROR_EVENT = 0x80000000
 Indicates the event is an error and will have it's error member set.
readonly attribute unsigned
long 
type
 The event type.
readonly attribute sbIMediacoreError error
 Error member is only set when type of event is set to ERROR.
readonly attribute nsIVariant data
 The event data. Payload varies per event type.
readonly attribute sbIMediacore origin
 Mediacore that generated the event.
readonly attribute sbIMediacoreEventTarget target
 Event Target that dispatched the event.


Detailed Description

Definition of the sbIMediacoreEvent interface.

Definition at line 40 of file sbIMediacoreEvent.idl.


Member Data Documentation

const unsigned long sbIMediacoreEvent::METADATA_CHANGE = 0x00001000

Metadata describing current item has changed.

Note:
data is an sbIPropertyArray object.

Definition at line 48 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::URI_CHANGE = 0x00001001

URI used for operation has changed.

Note:
data is an nsIURI object.

Definition at line 53 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::DURATION_CHANGE = 0x00001002

Current duration has changed.

Note:
data is the new duration as an unsigned long long (in milliseconds).

Definition at line 58 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::VOLUME_CHANGE = 0x00001003

Volume has changed.

Note:
data is the new volume as a double (from 0 to 1).

Definition at line 63 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::MUTE_CHANGE = 0x00001004

Mute status has changed.

Note:
data is the new mute state (boolean, true = muted).

Definition at line 68 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::BEFORE_TRACK_CHANGE = 0x00001500

Before the track playing is changed.

Note:
This event should only be fired by the sequencer.

data is the new sbIMediaItem that will be played.

Definition at line 77 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::TRACK_CHANGE = 0x00001501

Track playing has changed.

Note:
This event should only be fired by the sequencer.

data is the new sbIMediaItem being played.

Definition at line 83 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::TRACK_INDEX_CHANGE = 0x00001502

Index in view of item currently playing has changed.

Note:
This event should only be fired by the sequencer.

data is the new index (unsigned long).

Definition at line 89 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::BEFORE_VIEW_CHANGE = 0x00001503

Sequencer view is about to change.

Note:
data is the new sbIMediaListView.

Definition at line 94 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::VIEW_CHANGE = 0x00001504

Sequencer view changed.

Note:
data is the new sbIMediaListView.

Definition at line 99 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::SEQUENCE_CHANGE = 0x00001505

Sequence recalculated.

Note:
This event should only be fired by the sequencer.

data is the new sequence.

Definition at line 105 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::STREAM_FOUND = 0x00002000

Stream found.

Note:
Reserved for later use.

Definition at line 113 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::STREAM_HAS_VIDEO = 0x00002001

Stream has video.

Note:
data is null.

Definition at line 119 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::BUFFERING = 0x00003000

Buffering.

Note:
data is the buffering progress as a double (from 0 to 1).

Definition at line 125 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::BUFFER_UNDERRUN = 0x00003001

Buffer underrun, operation is likely to halt.

Note:
This event is likely to be followed by BUFFERING events.

data is null.

Definition at line 131 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::STREAM_START = 0x00004000

Stream has started.

Note:
data is null.

Definition at line 137 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::STREAM_PAUSE = 0x00004001

Stream is now paused.

Note:
data is null.

Definition at line 142 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::STREAM_END = 0x00004002

End of stream.

Note:
data is null.

Definition at line 147 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::STREAM_STOP = 0x00004003

Stream was stopped.

Note:
data is null.

Definition at line 152 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::PLUGIN_MISSING = 0x00008000

Plugin missing for requested format.

Note:
Reserved for later use.

Definition at line 158 of file sbIMediacoreEvent.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