sbIMediacoreManager Interface Reference

import"sbIMediacoreManager.idl";

Inheritance diagram for sbIMediacoreManager:
[legend]
Collaboration diagram for sbIMediacoreManager:
[legend]

Public Member Functions

sbIMediacoreVideoWindow getPrimaryVideoWindow (in boolean aCreate, [optional] in unsigned long aWidthHint, [optional] in unsigned long aHeightHint)
 
sbIMediacoreEvent createEvent (in unsigned long aType, in sbIMediacore aOrigin, [optional] in nsIVariant aData, [optional] in sbIMediacoreError aError)
 

Public Attributes

readonly attribute sbIMediacore primaryCore
 
readonly attribute
sbIMediacoreBalanceControl 
balanceControl
 
readonly attribute
sbIMediacoreVolumeControl 
volumeControl
 
readonly attribute
sbIMediacoreMultibandEqualizer 
equalizer
 
readonly attribute
sbIMediacorePlaybackControl 
playbackControl
 
readonly attribute
sbIMediacoreCapabilities 
capabilities
 
readonly attribute
sbIMediacoreStatus 
status
 
readonly attribute
sbIMediacoreVideoWindow 
video
 
attribute sbIMediacoreSequencer sequencer
 

Detailed Description

Definition at line 48 of file sbIMediacoreManager.idl.

Member Function Documentation

sbIMediacoreEvent sbIMediacoreManager::createEvent ( in unsigned long  aType,
in sbIMediacore  aOrigin,
[optional] in nsIVariant  aData,
[optional] in sbIMediacoreError  aError 
)

Create a new event

Parameters
aTypeThe type of the event; should be one of the COMMAND_* or EVENT_* constants on the sbIMediacoreEvent.
aData(Optional) The data to pass to any listeners that would receive this event.
aOrigin(Optional) Some indication of the source of the event.
aError(Optional) An error associated with the event
See Also
sbIMediacoreEvent
sbIMediacoreEventTarget
sbIMediacoreEventListener
sbIMediacoreVideoWindow sbIMediacoreManager::getPrimaryVideoWindow ( in boolean  aCreate,
[optional] in unsigned long  aWidthHint,
[optional] in unsigned long  aHeightHint 
)

Get (or create) the primary video window

Parameters
aCreateCreate the window if it does not exist.
aWidthHint(Optional) Width of the video that will be shown
aHeightHint(Optional) Height of the video that will be shown
Note
Both width and height hints have to be non-zero if you wish them to be used to size the video window upon creation. If you do not use the hints, the video window will rely on a VIDEO_SIZE_CHANGED event to size itself properly.
This method will return null if aCreate is false and there is no video window available.

Member Data Documentation

readonly attribute sbIMediacoreBalanceControl sbIMediacoreManager::balanceControl

Definition at line 58 of file sbIMediacoreManager.idl.

readonly attribute sbIMediacoreCapabilities sbIMediacoreManager::capabilities

Definition at line 64 of file sbIMediacoreManager.idl.

readonly attribute sbIMediacoreMultibandEqualizer sbIMediacoreManager::equalizer

Definition at line 61 of file sbIMediacoreManager.idl.

readonly attribute sbIMediacorePlaybackControl sbIMediacoreManager::playbackControl

Definition at line 62 of file sbIMediacoreManager.idl.

readonly attribute sbIMediacore sbIMediacoreManager::primaryCore

The primary core is always used to play user content.

If you need a mediacore for background tasks of any kind, it is preferable to create a new instance.

Definition at line 56 of file sbIMediacoreManager.idl.

attribute sbIMediacoreSequencer sbIMediacoreManager::sequencer

The current sequencer used to generate and manage playback sequences.

Setting the sequencer will have the following effect:

  1. Current sequences remain unaffected.
  2. When playback of current sequences is complete, the new sequencer is used to generate the next sequence.

Definition at line 78 of file sbIMediacoreManager.idl.

readonly attribute sbIMediacoreStatus sbIMediacoreManager::status

Definition at line 65 of file sbIMediacoreManager.idl.

readonly attribute sbIMediacoreVideoWindow sbIMediacoreManager::video

Definition at line 67 of file sbIMediacoreManager.idl.

readonly attribute sbIMediacoreVolumeControl sbIMediacoreManager::volumeControl

Definition at line 59 of file sbIMediacoreManager.idl.


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