sbITranscodeEncoderProfile Interface Reference

import"sbITranscodeProfile.idl";

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

Public Member Functions

unsigned long getEncoderProfilePriority (in double aQuality)
 
COMMENT double getAudioBitrate (in double aQuality)
 
double getVideoBitsPerPixel (in double aQuality)
 

Public Attributes

attribute AString containerFormat
 The container format to put the transcoded media in (if any). More...
 
attribute AString audioCodec
 The audio codec to use (if any). More...
 
attribute AString videoCodec
 The video codec to use (if any). More...
 
- Public Attributes inherited from sbITranscodeProfile
const unsigned long TRANSCODE_TYPE_UNKNOWN = 0
 
const unsigned long TRANSCODE_TYPE_AUDIO = 1
 
const unsigned long TRANSCODE_TYPE_IMAGE = 2
 
const unsigned long TRANSCODE_TYPE_AUDIO_VIDEO = 3
 
const unsigned long TRANSCODE_PRIORITY_LOWEST = 0
 
const unsigned long TRANSCODE_PRIORITY_LOW = 1000
 
const unsigned long TRANSCODE_PRIORITY_MEDIUM = 2000
 
const unsigned long TRANSCODE_PRIORITY_HIGH = 3000
 
const unsigned long TRANSCODE_PRIORITY_HIGHEST = 4000
 
attribute AString id
 
attribute unsigned long priority
 
attribute AString description
 
attribute unsigned long type
 
attribute ACString fileExtension
 The file extension to use for this profile May be empty to indicate no extension is to be used. More...
 
attribute AString containerFormat
 
attribute AString audioCodec
 
attribute AString videoCodec
 
attribute nsIArray audioProperties
 
attribute nsIArray videoProperties
 
attribute nsIArray containerProperties
 
attribute nsIArray containerAttributes
 
attribute nsIArray videoAttributes
 
attribute nsIArray audioAttributes
 

Detailed Description

Transcoding profile data for the configurator algorithm v1

Definition at line 152 of file sbITranscodeProfile.idl.

Member Function Documentation

COMMENT double sbITranscodeEncoderProfile::getAudioBitrate ( in double  aQuality)

Get the desired audio bitrate for a given quality setting

Parameters
aQualitythe desired quality, in the range 0 to 1 (inclusive)
Returns
the desired bitrate, in bits per second
unsigned long sbITranscodeEncoderProfile::getEncoderProfilePriority ( in double  aQuality)

Get the priority of this encoder profile, when used at a given priority (some profiles may not be suitable for high quality encoding, for example)

Priorities of zero will not be considered. It is recommended to return a (small) positive value even for unsuitable quality settings, as being able to transcode is better than not.

Parameters
aQualitythe desired output quality, in the range 0 to 1 (inclusive)
Returns
The priority for this encoder; zero indicates that the given profile must not be used at this quality.
double sbITranscodeEncoderProfile::getVideoBitsPerPixel ( in double  aQuality)

Get the desired video bits per pixel for a given quality setting

Parameters
aQualitythe desired quality, in the range 0 to 1 (inclusive)
Returns
the desired bits per pixel; this value may be less than 1

Member Data Documentation

attribute AString sbITranscodeEncoderProfile::audioCodec

The audio codec to use (if any).

Examples: "audio/x-vorbis", "audio/mpeg", "audio/x-raw-int"

May be an empty string to indicate that no audio should be stored.

Definition at line 191 of file sbITranscodeProfile.idl.

attribute AString sbITranscodeEncoderProfile::containerFormat

The container format to put the transcoded media in (if any).

Examples: "application/ogg", "audio/mpeg", "video/mp4"

May be an empty string to indicate that no container is desired.

Note that 'tag' formats such as id3 are considered as container formats here for simplicity.

Definition at line 181 of file sbITranscodeProfile.idl.

attribute AString sbITranscodeEncoderProfile::videoCodec

The video codec to use (if any).

Examples: "video/mpeg", "video/x-theora", "video/x-yuv"

May be an empty string to indicate that no video should be stored.

Definition at line 201 of file sbITranscodeProfile.idl.


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