tv.amwa.maj.iface
Interface AuxiliaryDescriptor

All Superinterfaces:

EssenceDescriptor, InterchangeObject, PhysicalDescriptor

All Known Implementing Classes:

AuxiliaryDescriptor

public interface AuxiliaryDescriptor
extends PhysicalDescriptor

Specifies the description of an auxiliary file essence source. The type of data in the essence is given by a mime type. See the IANA register of media types.

Author:

Richard Cartwright

See Also:

AAFFactory.makeAuxiliaryDescriptor(), SourceMob.getEssenceDescriptor()

Method Summary

String	getCharSet() Gets the registered character set used by the internal and external representation of the data as per RFC 2048.
String	getMimeType() Gets the registered mime type of the data in the auxiliary file as per RFC 2046 (MIME media types) and RFC 2048 (MIME registration prodcedures).
void	setCharSet(String charSet) Sets the registered character set used by the internal and external representation of the data as per RFC 2048.
void	setMimeType(String mimeType) Sets the registered mime type of the data in the auxiliary file as per RFC 2046 and RFC 2048.

Methods inherited from interface tv.amwa.maj.iface.EssenceDescriptor

appendLocator, appendSubDescriptor, countLocators, countSubDescriptors, getLocatorAt, getLocators, getSubDescriptorAt, getSubDescriptors, insertLocatorAt, insertSubDescriptorAt, prependLocator, prependSubDescriptor, removeLocatorAt, removeSubDescriptorAt

Methods inherited from interface tv.amwa.maj.iface.InterchangeObject

countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue

Method Detail

setMimeType

void setMimeType(@AAFString
                 String mimeType)
                 throws NullPointerException

Sets the registered mime type of the data in the auxiliary file as per RFC 2046 and RFC 2048.

Parameters:

mimeType - Specifies the registered mimetype of the data in the auxiliary file.

Throws:

NullPointerException - The given mime type is null.

getMimeType

@AAFString
String getMimeType()

Gets the registered mime type of the data in the auxiliary file as per RFC 2046 (MIME media types) and RFC 2048 (MIME registration prodcedures).

Returns:

The registered mimetype of the data in the auxiliary file.

setCharSet

void setCharSet(@AAFString
                String charSet)

Sets the registered character set used by the internal and external representation of the data as per RFC 2048. See the IANA register of character sets. Example: "ISO-8859-1". Set to null to omit this optional property.

Parameters:

charSet - Specifies the registered character set used by the internal and external representation of the data.

getCharSet

@AAFString
String getCharSet()
                  throws PropertyNotPresentException

Gets the registered character set used by the internal and external representation of the data as per RFC 2048. See the IANA register of character sets. Example: "ISO-8859-1". This is an optional property.

Returns:

The registered character set used by the internal and external representation of the data.

Throws:

PropertyNotPresentException - The optional character set is not present for this auxiliary descriptor.