DVDBuilder for .NET  3.4
DVD Authoring Software Development Kit
SubpictureEncoder Class Reference

DVD subpicture stream encoder. More...

Inheritance diagram for SubpictureEncoder:

Public Member Functions

 SubpictureEncoder ()
 Creates a SubpictureEncoder object. More...
 
void Dispose ()
 Disposes the SubpictureEncoder and reclaims the resources used by the object. More...
 
bool Encode (string inputFile, string outputFile)
 Encodes the input file into a DVD-Video subpicture stream. More...
 
System.Drawing.Color GetImageMaskColor (SubpictureEncoderImageMaskColor index)
 Gets the image mask color with the specified index. More...
 
void SetImageMaskColor (SubpictureEncoderImageMaskColor index, System.Drawing.Color color)
 Sets the image mask color with the specified index. More...
 

Properties

ErrorInfo Error [get]
 The error information for the last operation. 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

Constructor & Destructor Documentation

Creates a SubpictureEncoder object.

Member Function Documentation

void Dispose ( )

Disposes the SubpictureEncoder and reclaims the resources used by the object.

bool Encode ( string  inputFile,
string  outputFile 
)

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

Parameters
inputFilePath 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.
outputFilePath to the output file. The format of the output file is always MPEG-2 PS (Program Stream).
Returns
true if the input file is encoded sucessfully; otherwise false.
System.Drawing.Color GetImageMaskColor ( SubpictureEncoderImageMaskColor  index)

Gets the image mask color with the specified index.

void SetImageMaskColor ( SubpictureEncoderImageMaskColor  index,
System.Drawing.Color  color 
)

Sets the image mask color with the specified index.

Property Documentation

ErrorInfo Error
get

The error information for the last operation.

See also
ErrorInfo