DVDBuilder for C++  3.4
DVD Authoring Software Development Kit
SubpictureEncoder Class Referenceabstract

DVD subpicture stream encoder. More...

Inheritance diagram for SubpictureEncoder:
Reference

Public Member Functions

virtual bool_t encode (const char_t *pInputFile, const char_t *pOutputFile)=0
 Encodes the input file into a DVD-Video subpicture stream. More...
 
virtual const ErrorInfoerror () const =0
 Returns the error information for the last operation. More...
 
virtual uint32_t imageMaskColor (uint32_t index)=0
 Gets the image mask color with the specified index. More...
 
virtual void setImageMaskColor (uint32_t index, uint32_t color)=0
 Sets the image mask color with the specified index. More...
 
- Public Member Functions inherited from Reference
virtual int32_t release () const =0
 Releases the instance. More...
 
virtual int32_t retain () const =0
 Retains the instance. More...
 
virtual int32_t retainCount () const =0
 Returns the current reference count. More...
 

Detailed Description

DVD subpicture stream encoder.

Currently the only supported input is Spruce Technologies STL file with subtitles defined as images. Subtitle generation from text and fonts is currently not supported. The output is always MPEG-2 PS (Program Stream).

For STL format description see: STL Subtitle File Format

Version
2.1.1

Member Function Documentation

virtual bool_t encode ( const char_t *  pInputFile,
const char_t *  pOutputFile 
)
pure virtual

Encodes the input file into a DVD-Video subpicture stream.

Parameters
pInputFilePath to the input file.

The input file should be in the STL format developed by Spruce Technologies. For STL format description see: STL Subtitle File Format

The subtitles must be defined as BMP or TIFF images. Subtitle generation from text and fonts is currently not supported.

Parameters
pOutputFilePath to the output file.

The format of the output file is always MPEG-2 PS (Program Stream).

virtual const ErrorInfo* error ( ) const
pure virtual

Returns the error information for the last operation.

Returns
A pointer to an ErrorInfo object.
virtual uint32_t imageMaskColor ( uint32_t  index)
pure virtual

Gets the image mask color with the specified index.

Parameters
indexthe color index.
See also
SubpictureEncoderImageMaskColor::Enum
virtual void setImageMaskColor ( uint32_t  index,
uint32_t  color 
)
pure virtual

Sets the image mask color with the specified index.

Parameters
indexthe color index.
colorthe new color value.
See also
SubpictureEncoderImageMaskColor::Enum