Definition of the sbIMediacoreEvent interface. More...

import"sbIMediacoreEvent.idl";

Inheritance diagram for sbIMediacoreEvent:

Collaboration diagram for sbIMediacoreEvent:

Public Attributes
const unsigned long	UNINTIALIZED = 0x00000000

const unsigned long	METADATA_CHANGE = 0x00001000
	Metadata describing current item has changed. More...

const unsigned long	URI_CHANGE = 0x00001001
	URI used for operation has changed. More...

const unsigned long	DURATION_CHANGE = 0x00001002
	Current duration has changed. More...

const unsigned long	VOLUME_CHANGE = 0x00001003
	Volume has changed. More...

const unsigned long	MUTE_CHANGE = 0x00001004
	Mute status has changed. More...

const unsigned long	BEFORE_TRACK_CHANGE = 0x00001500
	Before the track playing is changed. More...

const unsigned long	TRACK_CHANGE = 0x00001501
	Track playing has changed. More...

const unsigned long	TRACK_INDEX_CHANGE = 0x00001502
	Index in view of item currently playing has changed. More...

const unsigned long	BEFORE_VIEW_CHANGE = 0x00001503
	Sequencer view is about to change. More...

const unsigned long	VIEW_CHANGE = 0x00001504
	Sequencer view changed. More...

const unsigned long	SEQUENCE_CHANGE = 0x00001505
	Sequence recalculated. More...

const unsigned long	SEQUENCE_END = 0x00001507
	Sequence end. More...

const unsigned long	EXPLICIT_TRACK_CHANGE = 0x00001508
	Explicit call to next or previous. More...

const unsigned long	STREAM_FOUND = 0x00002000
	Stream found. More...

const unsigned long	STREAM_HAS_VIDEO = 0x00002001
	Stream has video. More...

const unsigned long	BUFFERING = 0x00003000
	Buffering. More...

const unsigned long	BUFFER_UNDERRUN = 0x00003001
	Buffer underrun, operation is likely to halt. More...

const unsigned long	STREAM_BEFORE_START = 0x00004000
	Stream is about to start. More...

const unsigned long	STREAM_START = 0x00004001
	Stream has started. More...

const unsigned long	STREAM_BEFORE_PAUSE = 0x00004002
	Stream is about to pause. More...

const unsigned long	STREAM_PAUSE = 0x00004003
	Stream is now paused. More...

const unsigned long	STREAM_END = 0x00004004
	End of stream. More...

const unsigned long	STREAM_BEFORE_STOP = 0x00004005
	Stream is about to stop. More...

const unsigned long	STREAM_STOP = 0x00004006
	Stream was stopped. More...

const unsigned long	EXPLICIT_STOP = 0x00004007
	Explicit call to stop the playback. More...

const unsigned long	SEEKED = 0x00001005
	Playback has progressed in an unusual way. More...

const unsigned long	VIDEO_SIZE_CHANGED = 0x00005000
	Video size has changed. More...

const unsigned long	PLUGIN_MISSING = 0x00008000
	Plugin missing for requested format. More...

const unsigned long	CUSTOM_EVENT_BASE = 0x40000000
	Custom event base value. More...

const unsigned long	ERROR_EVENT = 0x80000000
	Indicates the event is an error and will have its error member set. More...

readonly attribute unsigned long	type
	The event type. More...

readonly attribute sbIMediacoreError	error
	Error member is only set when type of event is set to ERROR. More...

readonly attribute nsIVariant	data
	The event data. Payload varies per event type. More...

readonly attribute sbIMediacore	origin
	Mediacore that generated the event. More...

readonly attribute sbIMediacoreEventTarget	target
	Event Target that dispatched the event. More...

Detailed Description

Definition of the sbIMediacoreEvent interface.

Definition at line 38 of file sbIMediacoreEvent.idl.

Member Data Documentation

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 75 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 92 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 154 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 148 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::CUSTOM_EVENT_BASE = 0x40000000

Custom event base value.

Definition at line 248 of file sbIMediacoreEvent.idl.

readonly attribute nsIVariant sbIMediacoreEvent::data

The event data. Payload varies per event type.

Definition at line 267 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 56 of file sbIMediacoreEvent.idl.

readonly attribute sbIMediacoreError sbIMediacoreEvent::error

Error member is only set when type of event is set to ERROR.

Definition at line 262 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::ERROR_EVENT = 0x80000000

Indicates the event is an error and will have its error member set.

Definition at line 253 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::EXPLICIT_STOP = 0x00004007

Explicit call to stop the playback.

Triggered by user or code that is actively attempting to stop the playback. This event is not fired when the sequencer goes to the end and no next track for playback.

Note: data is null.; STREAM_BEFORE_STOP and STREAM_STOP are still fired.

Definition at line 219 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::EXPLICIT_TRACK_CHANGE = 0x00001508

Explicit call to next or previous.

Triggered by user or code that is actively attempting to change to the next track. This event is not fired when the sequencer goes to the next track because the previous track has finished playing in its entirety.

Note: data is null.; BEFORE_TRACK_CHANGE and TRACK_CHANGE are still fired. You may use those events to get the next item that will be playing.

Definition at line 128 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::METADATA_CHANGE = 0x00001000

Metadata describing current item has changed.

Note: data is an sbIPropertyArray object.

Definition at line 46 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 66 of file sbIMediacoreEvent.idl.

readonly attribute sbIMediacore sbIMediacoreEvent::origin

Mediacore that generated the event.

Definition at line 272 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::PLUGIN_MISSING = 0x00008000

Plugin missing for requested format.

Note: Reserved for later use.

Definition at line 243 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::SEEKED = 0x00001005

Playback has progressed in an unusual way.

Note: data is a property bag, containing PRUint64 "position" - the position of the stream after seeking.

Definition at line 226 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 103 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::SEQUENCE_END = 0x00001507

Sequence end.

This event will be fired by the sequencer when it runs out of items to play from its sequence. This event will not be fired when the sequence repeats because of repeat one or repeat all being turned on.

Note: This event should only be fired by the sequencer.; data is null for this event.

Definition at line 115 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::STREAM_BEFORE_PAUSE = 0x00004002

Stream is about to pause.

Note: This event is a notification only, and may be dispatched asynchronously. By the time the event is received playback may already have paused.; data is a property bag, containing PRUint64 "position" - the position of the stream when pause was requested. PRUint64 "duration" - the length of the stream nsIURI "uri" - the URI that was playing when the pause started

Definition at line 180 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::STREAM_BEFORE_START = 0x00004000

Stream is about to start.

Note: This event is a notification only, and may be dispatched asynchronously. By the time the event is received the playback may have already started.; data is an empty property bag

Definition at line 163 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::STREAM_BEFORE_STOP = 0x00004005

Stream is about to stop.

Note: This event is a notification only, and may be dispatched asynchronously. By the time the event is received playback may already have stopped (and therefore querying the playback controller may result in different values).; data is a property bag, containing PRUint64 "position" - the position of the stream when stopping of playback was requested. PRUint64 "duration" - the length of the stream nsIURI "uri" - the URI that was playing when the stop was requested.

Definition at line 203 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::STREAM_END = 0x00004004

End of stream.

Note: data is null.

Definition at line 190 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::STREAM_FOUND = 0x00002000

Stream found.

Note: Reserved for later use.

Definition at line 136 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::STREAM_HAS_VIDEO = 0x00002001

Stream has video.

Note: data is null.

Definition at line 142 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::STREAM_PAUSE = 0x00004003

Stream is now paused.

Note: data is null.

Definition at line 185 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::STREAM_START = 0x00004001

Stream has started.

Note: data is null.

Definition at line 168 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::STREAM_STOP = 0x00004006

Stream was stopped.

Note: data is null.

Definition at line 208 of file sbIMediacoreEvent.idl.

readonly attribute sbIMediacoreEventTarget sbIMediacoreEvent::target

Event Target that dispatched the event.

Definition at line 276 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 81 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 87 of file sbIMediacoreEvent.idl.

readonly attribute unsigned long sbIMediacoreEvent::type

The event type.

Definition at line 258 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::UNINTIALIZED = 0x00000000

Definition at line 40 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 51 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::VIDEO_SIZE_CHANGED = 0x00005000

Video size has changed.

Note: data is an sbIVideoSize object.

See Also: sbIVideoSize

Definition at line 235 of file sbIMediacoreEvent.idl.

const unsigned long sbIMediacoreEvent::VIEW_CHANGE = 0x00001504

Sequencer view changed.

Note: data is the new sbIMediaListView.

Definition at line 97 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 61 of file sbIMediacoreEvent.idl.

The documentation for this interface was generated from the following file:

/home/martin/dev/nightingale-hacking/components/mediacore/base/public/sbIMediacoreEvent.idl

Public Attributes

Detailed Description

Member Data Documentation