FileDocCategorySizeDatePackage
PlugIn.javaAPI DocJMF 2.1.1e2942Mon May 12 12:20:36 BST 2003javax.media

PlugIn

public interface PlugIn implements Controls
The base interface for JMF plug-ins. A PlugIn is a media processing unit that accepts data in a particular format and processes or presents the data. Plug-ins are registered through the PlugInManager.
since
JMF 2.0

Fields Summary
public static final int
BUFFER_PROCESSED_OK
The input Buffer was converted successfully to output.
public static final int
BUFFER_PROCESSED_FAILED
The input Buffer could not be handled.
public static final int
INPUT_BUFFER_NOT_CONSUMED
The input Buffer chunk was not fully consumed. The plug-in should update the offset + length fields of the Buffer. The plug-in will be called later with the same input Buffer.
public static final int
OUTPUT_BUFFER_NOT_FILLED
The output Buffer chunk was not filled. The plug-in should update the offset + length fields of the Buffer. The plug-in will be called later with the same output Buffer.
public static final int
PLUGIN_TERMINATED
The processing of the given buffer has caused the plugin to terminate. The plugin will not be able to continue further processing.
Constructors Summary
Methods Summary
public voidclose()
Closes the plug-in component and releases the resources it was using. No more data will be accepted by the plug-in after close is called. A closed plug-in can be reinstated by calling open again.

public java.lang.StringgetName()
Gets the name of this plug-in as a human-readable string.

return
A String that contains the descriptive name of the plug-in.

public voidopen()
Opens the plug-in software or hardware component and acquires the resources that the plug-in needs to operate. All required input and/or output formats have to be set on the plug-in before open is called. Buffers should not be passed into the plug-in without first calling this method.

exception
ResourceUnavailableException If all of the required resources cannot be acquired.

public voidreset()
Resets the state of the plug-in. The reset method is typically called if the end of media is reached or the media is repositioned.