Base interface for all Transcoding Configurators. This interface should be implemented by any Configurator system and implement the configurate function. More...
import"sbITranscodingConfigurator.idl";
Public Member Functions | |
| void | determineOutputType () |
| Determine the trancode destination format to use, based on the target device and desired output quality settings. The device must be set before calling this function. This will only determine the file format settings, not the details such as dimensions or bitrates. The muxer and encoder attributes below may be read after calling this method, but not the format details or properties. More... | |
| void | configurate () |
| Determine the transcode settings to use based on the input given. Both the device and the input format must be set before calling this function. Once this is called, the functions below may be called (they will throw an error if called before this function is called). More... | |
Public Attributes | |
| readonly attribute nsIArray | availableProfiles |
| attribute nsIURI | inputUri |
| attribute sbIMediaFormat | inputFormat |
| The input format to use when configuring the transcode profile. More... | |
| readonly attribute sbITranscodeError | lastError |
| readonly attribute AString | muxer |
| The muxer to use. The name is specific to the transcoder (for example, this may be a gstreamer element name for a gstreamer-based transcoder). More... | |
| readonly attribute boolean | useMuxer |
| Whether a muxer is in use. e.g. for a bare FLAC audio file it won't be. More... | |
| readonly attribute ACString | fileExtension |
| The file extension to use for transcoded files. This may depend on the muxer or the used codecs. It may also depend on nothing at all; it's all up to the configurator. More... | |
| readonly attribute AString | videoEncoder |
| The video encoder to use. The name is specific to the transcoder (for example, this may be a gstreamer element name for a gstreamer-based transcoder). More... | |
| readonly attribute boolean | useVideoEncoder |
| Whether a video encoder is in use. If this is true, the videoEncoder attribute must be non-empty. More... | |
| readonly attribute AString | audioEncoder |
| The audio encoder to use. The name is specific to the transcoder (for example, this may be a gstreamer element name for a gstreamer-based transcoder). This may be a void string if raw audio is desired. More... | |
| readonly attribute boolean | useAudioEncoder |
| Whether a audio encoder is in use. If this is true, the audioEncoder attribute may be empty; indicating that raw audio is desired. More... | |
| readonly attribute sbIMediaFormatVideo | videoFormat |
| The basic video format for data that is not specific to a particular codec. More... | |
| readonly attribute sbIMediaFormatAudio | audioFormat |
| The basic audio format for data that is not specific to a particular codec. More... | |
| readonly attribute nsIPropertyBag | videoEncoderProperties |
| With the input given, return the properties to set on the encoder to encode this format. This is used to e.g. select a bitrate for the video encoder. More... | |
| readonly attribute nsIPropertyBag | audioEncoderProperties |
| With the input given, return the properties to set on the encoder to encode this format. This is used to e.g. select a bitrate for the audio encoder. More... | |
Base interface for all Transcoding Configurators. This interface should be implemented by any Configurator system and implement the configurate function.
Definition at line 50 of file sbITranscodingConfigurator.idl.
| void sbITranscodingConfigurator::configurate | ( | ) |
Determine the transcode settings to use based on the input given. Both the device and the input format must be set before calling this function. Once this is called, the functions below may be called (they will throw an error if called before this function is called).
This function may fail if: The device or file info have not been set, or No encoder(s) are available for the formats supported by the device.
| void sbITranscodingConfigurator::determineOutputType | ( | ) |
Determine the trancode destination format to use, based on the target device and desired output quality settings. The device must be set before calling this function. This will only determine the file format settings, not the details such as dimensions or bitrates. The muxer and encoder attributes below may be read after calling this method, but not the format details or properties.
This function may fail if: The device or file info have not been set, or No encoder(s) are available for the formats supported by the device.
| readonly attribute AString sbITranscodingConfigurator::audioEncoder |
The audio encoder to use. The name is specific to the transcoder (for example, this may be a gstreamer element name for a gstreamer-based transcoder). This may be a void string if raw audio is desired.
| NS_ERROR_NOT_INITIALIZED | on read if determineOutputType() has not been called. |
Definition at line 144 of file sbITranscodingConfigurator.idl.
| readonly attribute nsIPropertyBag sbITranscodingConfigurator::audioEncoderProperties |
With the input given, return the properties to set on the encoder to encode this format. This is used to e.g. select a bitrate for the audio encoder.
| NS_ERROR_NOT_INITIALIZED | on read if configurate() has not been called. |
Definition at line 211 of file sbITranscodingConfigurator.idl.
| readonly attribute sbIMediaFormatAudio sbITranscodingConfigurator::audioFormat |
The basic audio format for data that is not specific to a particular codec.
| NS_ERROR_NOT_INITIALIZED | on read if configurate() has not been called. |
Definition at line 187 of file sbITranscodingConfigurator.idl.
| readonly attribute nsIArray sbITranscodingConfigurator::availableProfiles |
The list of profiles this configurator can use
Definition at line 55 of file sbITranscodingConfigurator.idl.
| readonly attribute ACString sbITranscodingConfigurator::fileExtension |
The file extension to use for transcoded files. This may depend on the muxer or the used codecs. It may also depend on nothing at all; it's all up to the configurator.
| NS_ERROR_NOT_INITIALIZED | on read if determineOutputType() has not been called. |
Definition at line 115 of file sbITranscodingConfigurator.idl.
| attribute sbIMediaFormat sbITranscodingConfigurator::inputFormat |
The input format to use when configuring the transcode profile.
| NS_ERROR_ALREADY_INITIALIZED | if configurate has been called. |
Definition at line 66 of file sbITranscodingConfigurator.idl.
| attribute nsIURI sbITranscodingConfigurator::inputUri |
The URI to use for the transcoding input. Mostly informational.
Definition at line 60 of file sbITranscodingConfigurator.idl.
| readonly attribute sbITranscodeError sbITranscodingConfigurator::lastError |
The last error this configurator has seen. May be null if no error has been encountered.
Definition at line 72 of file sbITranscodingConfigurator.idl.
| readonly attribute AString sbITranscodingConfigurator::muxer |
The muxer to use. The name is specific to the transcoder (for example, this may be a gstreamer element name for a gstreamer-based transcoder).
| NS_ERROR_NOT_INITIALIZED | on read if determineOutputType() has not been called. |
Definition at line 96 of file sbITranscodingConfigurator.idl.
| readonly attribute boolean sbITranscodingConfigurator::useAudioEncoder |
Whether a audio encoder is in use. If this is true, the audioEncoder attribute may be empty; indicating that raw audio is desired.
| NS_ERROR_NOT_INITIALIZED | on read if determineOutputType() has not been called. |
Definition at line 153 of file sbITranscodingConfigurator.idl.
| readonly attribute boolean sbITranscodingConfigurator::useMuxer |
Whether a muxer is in use. e.g. for a bare FLAC audio file it won't be.
| NS_ERROR_NOT_INITIALIZED | on read if determineOutputType() has not been called. |
Definition at line 105 of file sbITranscodingConfigurator.idl.
| readonly attribute boolean sbITranscodingConfigurator::useVideoEncoder |
Whether a video encoder is in use. If this is true, the videoEncoder attribute must be non-empty.
| NS_ERROR_NOT_INITIALIZED | on read if determineOutputType() has not been called. |
Definition at line 134 of file sbITranscodingConfigurator.idl.
| readonly attribute AString sbITranscodingConfigurator::videoEncoder |
The video encoder to use. The name is specific to the transcoder (for example, this may be a gstreamer element name for a gstreamer-based transcoder).
| NS_ERROR_NOT_INITIALIZED | on read if determineOutputType() has not been called. |
Definition at line 125 of file sbITranscodingConfigurator.idl.
| readonly attribute nsIPropertyBag sbITranscodingConfigurator::videoEncoderProperties |
With the input given, return the properties to set on the encoder to encode this format. This is used to e.g. select a bitrate for the video encoder.
| NS_ERROR_NOT_INITIALIZED | on read if configurate() has not been called. |
Definition at line 199 of file sbITranscodingConfigurator.idl.
| readonly attribute sbIMediaFormatVideo sbITranscodingConfigurator::videoFormat |
The basic video format for data that is not specific to a particular codec.
| NS_ERROR_NOT_INITIALIZED | on read if configurate() has not been called. |
Definition at line 176 of file sbITranscodingConfigurator.idl.
