An object capable of transcoding a source URI to a destination file. More...
import"sbITranscodeVideoJob.idl";
Public Member Functions | |
| PRInt32 | vote (in sbIMediaItem aMediaItem) |
| Vote to be the handler returned for the given url. More... | |
| void | transcode () |
| Start the transcoding operation. More... | |
Public Attributes | |
| attribute sbIPropertyArray | metadata |
| An array of metadata properties. More... | |
| attribute nsIInputStream | metadataImage |
| An input stream for the encoded image. More... | |
| attribute sbITranscodingConfigurator | configurator |
| The configurator that will be used to configurate the transcoder for the specific input URI. More... | |
| attribute AString | sourceURI |
| The source URI to transcode from. More... | |
| attribute AString | destURI |
| The destination URI to transcode to. Used only if destStream is set to a non-null value. More... | |
| attribute nsIOutputStream | destStream |
| A stream to write the output to. Used in preference to destURI if this is set. More... | |
An object capable of transcoding a source URI to a destination file.
User code should request an instance using sbITranscodeManager::getTranscoder()
Implementations should also implement sbIJobProgress, and usually sbIJobCancelable.
Definition at line 52 of file sbITranscodeVideoJob.idl.
| void sbITranscodeVideoJob::transcode | ( | ) |
Start the transcoding operation.
Caller should monitor progress via sbIJobProgress
| PRInt32 sbITranscodeVideoJob::vote | ( | in sbIMediaItem | aMediaItem | ) |
Vote to be the handler returned for the given url.
The sbITranscodeManager will instantiate one of every sbITranscodeVideoJob subclass and ask it to vote on whether it can support transcoding a given media item with a given transcoding profile. The highest vote will be used as the handler for the media item.
Values less than zero cause that handler to be ignored.
At the moment, our handlers return -1, 0, or 1000 (for "no," "maybe," and "yes").
| aMediaItem | The media item on which to vote |
| attribute sbITranscodingConfigurator sbITranscodeVideoJob::configurator |
The configurator that will be used to configurate the transcoder for the specific input URI.
The transcoding job will use the configurator to decide on parameters for the raw media input to the encoder, and to decide on the specific encoder settings to use.
Definition at line 81 of file sbITranscodeVideoJob.idl.
| attribute nsIOutputStream sbITranscodeVideoJob::destStream |
A stream to write the output to. Used in preference to destURI if this is set.
Note that the output stream may not be seekable, in which case some formats may not work correctly. If the stream does implement nsISeekableStream, any format should be usable.
Definition at line 106 of file sbITranscodeVideoJob.idl.
| attribute AString sbITranscodeVideoJob::destURI |
The destination URI to transcode to. Used only if destStream is set to a non-null value.
Note that, in general, only file URIs will be supported for destination URI. For non-file URIs, an nsIOutputStream should be used instead (see below).
Definition at line 96 of file sbITranscodeVideoJob.idl.
| attribute sbIPropertyArray sbITranscodeVideoJob::metadata |
An array of metadata properties.
Metadata properties to be written into the destination file. Metadata items in this property array should be used to replace those in the source file (where present), and add them otherwise. Metadata items present in the source stream but not in this array should be preserved where possible.
Definition at line 63 of file sbITranscodeVideoJob.idl.
| attribute nsIInputStream sbITranscodeVideoJob::metadataImage |
An input stream for the encoded image.
If an image is desired in the encoded file (e.g. album art cover), set this to an input stream that the encoded image can be read from.
Definition at line 71 of file sbITranscodeVideoJob.idl.
| attribute AString sbITranscodeVideoJob::sourceURI |
The source URI to transcode from.
Definition at line 86 of file sbITranscodeVideoJob.idl.
