import "sbICoreWrapper.idl";
Public Member Functions | |
boolean | getPaused () |
Get the pause state Return the pause state of the playback core. | |
boolean | getPlaying () |
Get the playing state Return the play state of the playback core. If the core is stopped, this will return FALSE, but if paused it will still return TRUE. | |
boolean | getMute () |
Get the mute state. | |
void | setMute (in boolean aMute) |
Set the mute state. | |
unsigned long | getVolume () |
Get the volume. | |
void | setVolume (in unsigned long aVolume) |
Set the volume. | |
unsigned long long | getLength () |
Get the length of the current media. | |
unsigned long long | getPosition () |
Get the position within the current media. | |
void | setPosition (in unsigned long long aPosition) |
Set the position of playback. | |
void | goFullscreen () |
Maximize the plugin window to be fullscreen. Have the plugin render to the full size of the screen. | |
AString | getId () |
Generic id string. | |
void | setId (in AString aId) |
Set the string identifier. | |
nsIDOMHTMLElement | getObject () |
Retrieve the HTML element that implements playback functionality This gets the object that actually implements the playback functionality. For some cores this will be an nsIHTMLDOMObjectElement and some it will be an nsIHTMLDOMEmbedElement. Either way, it is the additional javascript API that exists on the object that will be utilized in most cases. | |
void | setObject (in nsIDOMHTMLElement aObject) |
Set the HTML element that implements playback functionality This sets the object that actually implements the playback functionality. For some cores this will be an nsIHTMLDOMObjectElement and some it will be an nsIHTMLDOMEmbedElement. Either way, it is the additional javascript API that exists on the object that will be utilized in most cases. | |
boolean | playURL (in AString aURL) |
Specify the url to play and start playback. | |
boolean | play () |
Resume paused playback. Multiple calls do nothing. | |
boolean | stop () |
Stop playback. | |
boolean | pause () |
Pause playing playback. Multiple calls do nothing. | |
AString | getMetadata (in AString aKey) |
Get the requested metadata. | |
void | onSwapCore () |
Called when the core is swapping. Allows the core to do any cleaning up it needs to. Also stops the playback of any media. | |
boolean | isMediaURL (in AString aURL) |
Check to see if an url points to media content This checks for a number of known file extensions and prefixes to see if the URL contains them and is therefore media. | |
boolean | isVideoURL (in AString aURL) |
Check to see if an url points to video content This checks for a number of known file extensions to see if the URL contains them and is therefore video. |
Definition at line 44 of file sbICoreWrapper.idl.
AString sbICoreWrapper::getId | ( | ) |
Generic id string.
unsigned long long sbICoreWrapper::getLength | ( | ) |
Get the length of the current media.
AString sbICoreWrapper::getMetadata | ( | in AString | aKey | ) |
Get the requested metadata.
aKey | - The category of metadata to retrieve (name, artist, etc...) |
boolean sbICoreWrapper::getMute | ( | ) |
Get the mute state.
FALSE if not muted
nsIDOMHTMLElement sbICoreWrapper::getObject | ( | ) |
Retrieve the HTML element that implements playback functionality This gets the object that actually implements the playback functionality. For some cores this will be an nsIHTMLDOMObjectElement and some it will be an nsIHTMLDOMEmbedElement. Either way, it is the additional javascript API that exists on the object that will be utilized in most cases.
boolean sbICoreWrapper::getPaused | ( | ) |
Get the pause state Return the pause state of the playback core.
FALSE if not paused
boolean sbICoreWrapper::getPlaying | ( | ) |
Get the playing state Return the play state of the playback core. If the core is stopped, this will return FALSE, but if paused it will still return TRUE.
FALSE if not playing
unsigned long long sbICoreWrapper::getPosition | ( | ) |
Get the position within the current media.
unsigned long sbICoreWrapper::getVolume | ( | ) |
Get the volume.
void sbICoreWrapper::goFullscreen | ( | ) |
Maximize the plugin window to be fullscreen. Have the plugin render to the full size of the screen.
boolean sbICoreWrapper::isMediaURL | ( | in AString | aURL | ) |
Check to see if an url points to media content This checks for a number of known file extensions and prefixes to see if the URL contains them and is therefore media.
aURL | - the URL to check |
false if the URL does not point to media content
boolean sbICoreWrapper::isVideoURL | ( | in AString | aURL | ) |
Check to see if an url points to video content This checks for a number of known file extensions to see if the URL contains them and is therefore video.
aURL | - the URL to check |
false if the URL does not point to video content
void sbICoreWrapper::onSwapCore | ( | ) |
Called when the core is swapping. Allows the core to do any cleaning up it needs to. Also stops the playback of any media.
boolean sbICoreWrapper::pause | ( | ) |
Pause playing playback. Multiple calls do nothing.
boolean sbICoreWrapper::play | ( | ) |
Resume paused playback. Multiple calls do nothing.
boolean sbICoreWrapper::playURL | ( | in AString | aURL | ) |
Specify the url to play and start playback.
\return | true If playback was successful. |
NS_ERROR_INVALID_ARG | If the URL passed in is null/undefined. | |
NS_ERROR_NOT_INITIALIZED | If no object has been set. |
void sbICoreWrapper::setId | ( | in AString | aId | ) |
Set the string identifier.
aId | - the string identifier |
void sbICoreWrapper::setMute | ( | in boolean | aMute | ) |
Set the mute state.
aMute | - A boolean indicating the desired mute state |
void sbICoreWrapper::setObject | ( | in nsIDOMHTMLElement | aObject | ) |
Set the HTML element that implements playback functionality This sets the object that actually implements the playback functionality. For some cores this will be an nsIHTMLDOMObjectElement and some it will be an nsIHTMLDOMEmbedElement. Either way, it is the additional javascript API that exists on the object that will be utilized in most cases.
aObject | The HTML element |
void sbICoreWrapper::setPosition | ( | in unsigned long long | aPosition | ) |
Set the position of playback.
aPosition | - The position, in milliseconds, of where to move the playback to. |
void sbICoreWrapper::setVolume | ( | in unsigned long | aVolume | ) |
Set the volume.
aVolume | - an integer between 0 and 255 inclusive |
boolean sbICoreWrapper::stop | ( | ) |
Stop playback.