sbIMediaTranscoder Interface Reference

An object that performs a transcode operation. More...

List of all members.

Public Member Functions

PRInt32 transcode (in AString aInputURL, in sbIMediaType aInputMIMEType, in AString aOutputURL, in sbIMediaType aOutputMIMEType, in sbIMediaTranscoderCallback aCallback)
 Start a transcode operation.
void getSupportedMajorInputTypes (out PRUint32 nMajorCount,[array, size_is(nMajorCount), retval] out wstring aMajorInputs)
 Get the list of input major types.
void getSupportedInputMediaTypes (out PRUint32 nInputCount,[array, size_is(nInputCount), retval] out sbIMediaType aInputTypes)
 Get the list of input types.
void getSupportedMajorOutputTypes (out PRUint32 nMajorCount,[array, size_is(nMajorCount), retval] out wstring aMajorOutputs)
 Get the list of output major types.
void getSupportedOutputMediaTypes (out PRUint32 nOutputCount,[array, size_is(nOutputCount), retval] out sbIMediaType aOutputTypes)
 Get the list of output types.

Public Attributes

attribute AString name
 The name of the transcoder.
attribute AString description
 The long description of the transcoder.
attribute PRBool completed
 TRUE, if the transcode has completed.


Detailed Description

An object that performs a transcode operation.

This object is supposed to be a high-level wrapper for a full featured transcoder underneath the covers that does complex transcoding already.

It handles chaining the decode of the input type to the encode of the output type, internally.

Todo:
Stub interface. Currently unimplemented. Lots of work.
See also:
sbIMediaTranscoderManager, sbIMediaTranscoderCallback, sbIMediaType

Definition at line 151 of file sbIMediaTranscoder.idl.


Member Function Documentation

void sbIMediaTranscoder::getSupportedInputMediaTypes ( out PRUint32  nInputCount,
[array, size_is(nInputCount), retval] out sbIMediaType  aInputTypes 
)

Get the list of input types.

This method returns an array of sbIMediaType objects that it supports.

Parameters:
nInputCount The number of items in the array
aInputTypes The array of types

void sbIMediaTranscoder::getSupportedMajorInputTypes ( out PRUint32  nMajorCount,
[array, size_is(nMajorCount), retval] out wstring  aMajorInputs 
)

Get the list of input major types.

This method returns an array of all the major mimetype strings that it supports (the string to the left of the "/" in the mimetype string).

Parameters:
nMajorCount The number of items in the array
aMajorInputs The array of major type strings

void sbIMediaTranscoder::getSupportedMajorOutputTypes ( out PRUint32  nMajorCount,
[array, size_is(nMajorCount), retval] out wstring  aMajorOutputs 
)

Get the list of output major types.

This method returns an array of all the major mimetype strings that it supports (the string to the left of the "/" in the mimetype string).

Parameters:
nMajorCount The number of items in the array
aMajorOutputs The array of major type strings

void sbIMediaTranscoder::getSupportedOutputMediaTypes ( out PRUint32  nOutputCount,
[array, size_is(nOutputCount), retval] out sbIMediaType  aOutputTypes 
)

Get the list of output types.

This method returns an array of sbIMediaType objects that it supports.

Parameters:
nOutputCount The number of items in the array
aOutputTypes The array of types

PRInt32 sbIMediaTranscoder::transcode ( in AString  aInputURL,
in sbIMediaType  aInputMIMEType,
in AString  aOutputURL,
in sbIMediaType  aOutputMIMEType,
in sbIMediaTranscoderCallback  aCallback 
)

Start a transcode operation.

This method is called by the sbIMediaTranscoderManager after the proper sbIMediaTranscoder instance is found to handle the desired input and output files.

Parameters:
aInputURL The url to the input file
aInputType The type of the input file
aOutputURL The url to the output file
aOutputType The type for the output file
aCallback The optional callback object to observe the transcoding
Returns:
Error conditions of some form or another


The documentation for this interface was generated from the following file:
Generated on Mon Aug 21 21:01:55 2006 for Songbird by  doxygen 1.4.7