com.xuggle.mediatool
Interface IMediaCoder

Package class diagram package IMediaCoder
All Superinterfaces:
IMediaGenerator
All Known Subinterfaces:
IMediaReader, IMediaWriter

public interface IMediaCoder
extends IMediaGenerator

An IMediaGenerator that manages reading or writing to an IContainer.


Method Summary
 void close()
          Close this IMediaCoder.
 IContainer getContainer()
          Get the underlying media IContainer that the IMediaCoder is reading from or writing to.
 String getUrl()
          The URL from which the IContainer is being read or written to.
 boolean isOpen()
          Test if this IMediaCoder is open.
 void open()
          Open this IMediaCoder.
 
Methods inherited from interface com.xuggle.mediatool.IMediaGenerator
addListener, getListeners, removeListener
 

Method Detail

getContainer

IContainer getContainer()
Get the underlying media IContainer that the IMediaCoder is reading from or writing to. The returned IContainer can be further interrogated for media stream details.

Returns:
the media container.

getUrl

String getUrl()
The URL from which the IContainer is being read or written to.

Returns:
the source or destination URL.

open

void open()
Open this IMediaCoder. This will open the internal IContainer. Typically the tool will open itself at the right time, but there may exist rare cases where the calling context may need to open the tool.


isOpen

boolean isOpen()
Test if this IMediaCoder is open.

Returns:
true if the media tool is open.

close

void close()
Close this IMediaCoder. This will close all IStreamCoders explicitly opened by tool, then close the internal IContainer, again only if it was explicitly opened by tool.

Typically the tool will close itself at the right time, but there are instances where the calling context may need to close the tool.



Copyright © 2008, 2010 Xuggle