Package nzilbb.media

Interface MediaConverter

All Known Subinterfaces:

IMediaConverter

All Known Implementing Classes:

FfmpegConverter, FragmentExtractor, Resampler

public interface MediaConverter

Converts media from one format to another.

Author:

Robert Fromont robert@fromont.net.nz

Method Summary

Modifier and Type	Method	Description
ParameterSet	configure(ParameterSet configuration)	Configure the converter.
boolean	conversionSupported(String sourceType, String destinationType)	Determines whether this converter supports conversion between the given types.
MediaThread	start(String sourceType, File source, String destinationType, File destination)	Starts conversion.

Method Detail

configure

ParameterSet configure(ParameterSet configuration)
                throws MediaException

Configure the converter. This might include executable paths, conversion parameters, etc.

This method can be invoked with an empty parameter set, to discover what (if any) parameters are required. If parameters are returned, and user interaction is possible, then the user may be presented with an interface for setting/confirming these parameters.

Parameters:

configuration - The configuration for the converter.

Returns:

A list of configuration parameters must be set before the converter can be used.

Throws:

MediaException - If an error occurs.

conversionSupported

boolean conversionSupported(String sourceType,
                            String destinationType)
                     throws MediaException

Determines whether this converter supports conversion between the given types.

Parameters:

sourceType - The MIME type of the source media.

destinationType - The MIME type of the destination format.

Returns:

true if the converter can convert from the sourceType to the destinationType, false otherwise.

Throws:

MediaException - If an error occurs.

start

MediaThread start(String sourceType,
                  File source,
                  String destinationType,
                  File destination)
           throws MediaException

Starts conversion.

Parameters:

sourceType - The MIME type of the source media.

source - The source file.

destinationType - The MIME type of the destination format.

destination - The destination file.

Returns:

A thread that is processing the media.

Throws:

MediaException - If an error occurs.