org.jmythapi.protocol.response
Interface IPixmap

All Superinterfaces:

Cloneable, IPropertyAware<IPixmap.Props>, IVersionable

All Known Implementing Classes:

Pixmap

public interface IPixmap
extends IVersionable, IPropertyAware<IPixmap.Props>

An interface to read the preview image of a recording.

This interface represents the response to a IBackend.queryPixmapIfModified(IProgramInfo, Date, Long) request.
This interface is property-aware. See the properties-list for all properties of this interface.

Response example:

<0>LAST_MODIFIED: Mon Jan 09 11:33:48 CET 2012 | <1>DATA_SIZE: 92867 | <2>DATA_CHECKSUM: 2660 | <3>DATA_BASE64: iVBORw0KGgoAAAANSUhEUgAAAUAA...

Since:

49

See Also:

QUERY_PIXMAP_GET_IF_MODIFIED, IBackend.queryPixmapIfModified(IProgramInfo, Date, Long), IBackend.queryPixmap(IProgramInfo)

Nested Class Summary

static class

IPixmap.Props The properties of an IPixmap response.

Method Summary

byte[]	getData() Gets the pixmap as byte array.
String	getDataBase64() Gets the pixmap as base64 encoded string.
String	getDataCheckSum() Gets the pixmap checksum.
Long	getDataSize() Gets the data size in bytes.
InputStream	getDataStream() Gets the pixmap as stream.
BufferedImage	getImage() Gets the pixmap as image.
Date	getLastModified()

Methods inherited from interface org.jmythapi.IVersionable

getVersionNr

Methods inherited from interface org.jmythapi.IPropertyAware

getProperties, getProperty, getPropertyClass, getPropertyCount, getPropertyIndex, getPropertyMap, getPropertyValue, getPropertyValue, getPropertyValueObject, getPropertyValues, setPropertyValue, setPropertyValue, setPropertyValueObject

Method Detail

getLastModified

Date getLastModified()

getDataSize

Long getDataSize()

Gets the data size in bytes.

Returns:

the amount of returned bytes

getDataCheckSum

String getDataCheckSum()

Gets the pixmap checksum.

Returns:

a checksum.

getDataBase64

String getDataBase64()

Gets the pixmap as base64 encoded string.

Returns:

the encoded pixmap

getData

byte[] getData()

Gets the pixmap as byte array.

Returns:

the pixmap as byte array.

getDataStream

InputStream getDataStream()

Gets the pixmap as stream.

Returns:

a pixmap stream.

getImage

BufferedImage getImage()
                       throws IOException

Gets the pixmap as image.

Returns:

the pixmap as image.

Throws:

IOException - on io errors