org.apache.batik.transcoder

Interface Transcoder

public interface Transcoder

This class defines an API for transcoding.
Method Summary
voidaddTranscodingHint(TranscodingHints.Key key, Object value)
Sets the value of a single preference for the transcoding process.
ErrorHandlergetErrorHandler()
Returns the error handler this transcoder uses to report warnings and errors, or null if any.
TranscodingHintsgetTranscodingHints()
Returns the transcoding hints of this transcoder.
voidremoveTranscodingHint(TranscodingHints.Key key)
Removes the value of a single preference for the transcoding process.
voidsetErrorHandler(ErrorHandler handler)
Sets the error handler this transcoder may use to report warnings and errors.
voidsetTranscodingHints(Map hints)
Replaces the values of all preferences for the transcoding algorithms with the specified hints.
voidsetTranscodingHints(TranscodingHints hints)
Sets the values of all preferences for the transcoding algorithms with the specified hints.
voidtranscode(TranscoderInput input, TranscoderOutput output)
Transcodes the specified input in the specified output.

Method Detail

addTranscodingHint

public void addTranscodingHint(TranscodingHints.Key key, Object value)
Sets the value of a single preference for the transcoding process.

Parameters: key the key of the hint to be set value the value indicating preferences for the specified hint category.

getErrorHandler

public ErrorHandler getErrorHandler()
Returns the error handler this transcoder uses to report warnings and errors, or null if any.

getTranscodingHints

public TranscodingHints getTranscodingHints()
Returns the transcoding hints of this transcoder.

removeTranscodingHint

public void removeTranscodingHint(TranscodingHints.Key key)
Removes the value of a single preference for the transcoding process.

Parameters: key the key of the hint to remove

setErrorHandler

public void setErrorHandler(ErrorHandler handler)
Sets the error handler this transcoder may use to report warnings and errors.

Parameters: handler to ErrorHandler to use

setTranscodingHints

public void setTranscodingHints(Map hints)
Replaces the values of all preferences for the transcoding algorithms with the specified hints.

Parameters: hints the rendering hints to be set

setTranscodingHints

public void setTranscodingHints(TranscodingHints hints)
Sets the values of all preferences for the transcoding algorithms with the specified hints.

Parameters: hints the rendering hints to be set

transcode

public void transcode(TranscoderInput input, TranscoderOutput output)
Transcodes the specified input in the specified output.

Parameters: input the input to transcode output the ouput where to transcode

Throws: TranscoderException if an error occured while transcoding

Copyright B) 2007 Apache Software Foundation. All Rights Reserved.