|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object tv.amwa.maj.entity.InterchangeObject tv.amwa.maj.entity.EssenceDescriptor tv.amwa.maj.entity.AAFFileDescriptor tv.amwa.maj.entity.TIFFDescriptor
@AAFClass(uuid1=218169601, uuid2=257, uuid3=11008, uuid4={6,14,43,52,2,6,1,1}, definedName="TIFFDescriptor", description="The TIFFDescriptor class specifies that a File SourceMob is associated with video essence formatted according to the TIFF specification.") public class TIFFDescriptor
Implements the description of a file of video essence formatted according to the Tagged Image File Format (TIFF) specification.
THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.
Nested Class Summary | |
---|---|
static class |
TIFFDescriptor.XMLHandler
|
Nested classes/interfaces inherited from class tv.amwa.maj.entity.AAFFileDescriptor |
---|
AAFFileDescriptor.FileDescriptorXMLHandler |
Nested classes/interfaces inherited from class tv.amwa.maj.entity.EssenceDescriptor |
---|
EssenceDescriptor.EssenceDescriptorXMLHandler, EssenceDescriptor.LocatorXMLHandler, EssenceDescriptor.SubDescriptorXMLHandler |
Nested classes/interfaces inherited from class tv.amwa.maj.entity.InterchangeObject |
---|
InterchangeObject.InterchangeObjectXMLHandler |
Field Summary | |
---|---|
static String |
TIFFDESCRIPTOR_TAG
|
Fields inherited from class tv.amwa.maj.entity.AAFFileDescriptor |
---|
FILEDESCRIPTOR_ITEM |
Fields inherited from class tv.amwa.maj.entity.EssenceDescriptor |
---|
ESSENCEDESCRIPTOR_ITEM |
Fields inherited from interface tv.amwa.maj.iface.TIFFDescriptor |
---|
LEADINGLINES_DEFAULT, TRAILINGLINES_DEFAULT |
Constructor Summary | |
---|---|
TIFFDescriptor(ContainerDefinition containerFormat,
boolean isUniform,
boolean isContiguous,
byte[] summary)
Creates and initializes a new TIFF descritpor, which specifies that a file source mob is associated with video essence formatted according
to the TIFF specification. |
Method Summary | |
---|---|
void |
appendXMLChildren(Node parent)
Append child elements to the given parent node to serialize the value of an object to an XML fragment. |
TIFFDescriptor |
clone()
Creates a cloned copy of this entity. |
boolean |
equals(Object o)
Tests to see if the given object is equal to this interchange object. |
boolean |
getIsContiguous()
Returns true if essence data is stored in contiguous
bytes for the TIFF data described by this TIFF descriptor; otherwise
false. |
boolean |
getIsUniform()
Returns true if the TIFF data described by this
TIFF descriptor has the same number of rows per strip throughout;
otherwise false . |
int |
getJPEGTableID()
Returns the JPEG table code property of this TIFF descriptor, which specifies the registered JPEG table code. |
int |
getLeadingLines()
Returns the number of leading lines of the TIFF descriptor, which specifies the number of leading lines to be thrown away when viewing the TIFF data. |
byte[] |
getSummary()
Returns the copy of the TIFF IFD file information of this TIFF descriptor, without the sample data. |
int |
getSummaryBufferSize()
Returns the size of the buffer required by the TIFFDescriptor.getSummary()
method. |
int |
getTrailingLines()
Returns the number of trailing lines of this TIFF descriptor, which specifies the number of trailing lines to be thrown away when viewing the TIFF data. |
int |
hashCode()
Returns a hash code value for this interchange object. |
void |
setIsContiguous(boolean isContiguous)
Sets whether essence data is stored in contiguous bytes for the TIFF data described by this TIFF descriptor. |
void |
setIsUniform(boolean isUniform)
Sets whether the TIFF data described by this TIFF descriptor has the same number of rows per strip throughout. |
void |
setJPEGTableID(Integer jpegTableID)
Sets the JPEG table code property of this TIFF descriptor, which specifies the registered JPEG table code. |
void |
setLeadingLines(Integer leadingLines)
Sets the number of leading lines of this TIFF descriptor, which specifies the number of leading lines to be thrown away when viewing the TIFF data. |
void |
setPropertiesFromInterface(TIFFDescriptor castFrom)
|
void |
setSummary(byte[] summary)
Sets the copy of the TIFF IFD file information of this TIFF descriptor, without the sample data. |
void |
setTrailingLines(Integer trailingLines)
Sets the number of trailing lines of this TIFF descriptor, which specifies the number of trailing lines to be thrown away when viewing the TIFF data. |
Methods inherited from class tv.amwa.maj.entity.AAFFileDescriptor |
---|
describesStaticEssence, getCodecDefinition, getContainerFormat, getLength, getLinkedSlotID, getSampleRate, setCodecDefinition, setContainerFormat, setDescribesStaticEssence, setDescribesTimeVaryingEssence, setLength, setLinkedSlotID, setPropertiesFromInterface, setSampleRate |
Methods inherited from class tv.amwa.maj.entity.EssenceDescriptor |
---|
appendLocator, appendSubDescriptor, countLocators, countSubDescriptors, getLocatorAt, getLocators, getSubDescriptorAt, getSubDescriptors, insertLocatorAt, insertSubDescriptorAt, prependLocator, prependSubDescriptor, removeLocatorAt, removeSubDescriptorAt, setPropertiesFromInterface |
Methods inherited from class tv.amwa.maj.entity.InterchangeObject |
---|
castFromInterface, countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, registerImplementation, setPropertiesFromInterface, setPropertyValue, toString |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface tv.amwa.maj.iface.AAFFileDescriptor |
---|
getCodecDefinition, getContainerFormat, getLength, getLinkedSlotID, getSampleRate, setCodecDefinition, setContainerFormat, setLength, setLinkedSlotID, setSampleRate |
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 |
Methods inherited from interface tv.amwa.maj.entity.MAJCommon |
---|
toString |
Field Detail |
---|
public static final String TIFFDESCRIPTOR_TAG
Constructor Detail |
---|
public TIFFDescriptor(ContainerDefinition containerFormat, @Bool boolean isUniform, @Bool boolean isContiguous, @DataValue byte[] summary) throws NullPointerException
Creates and initializes a new TIFF descritpor, which specifies that a
file source mob
is associated with video essence formatted according
to the TIFF specification.
containerFormat
- Container format of the TIFF data.isUniform
- Does the data have the same number of rows per strip throughout?isContiguous
- Is the data stored in contiguous bytes?summary
- A copy of the TIFF IFD, without the sample data.
NullPointerException
- The container format and/or summary arguments are null
and both are required.Method Detail |
---|
public final void setPropertiesFromInterface(TIFFDescriptor castFrom)
InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)
@AAFProperty(uuid1=101188097, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="IsContiguous", typeName="Boolean", optional=false, uniqueIdentifier=false, pid=14082) public boolean getIsContiguous()
TIFFDescriptor
Returns true
if essence data is stored in contiguous
bytes for the TIFF data described by this TIFF descriptor; otherwise
false.
getIsContiguous
in interface TIFFDescriptor
public void setIsContiguous(boolean isContiguous)
TIFFDescriptor
Sets whether essence data is stored in contiguous
bytes for the TIFF data described by this TIFF descriptor. Set to
true
if the data is contiguous; otherwise
false
.
setIsContiguous
in interface TIFFDescriptor
isContiguous
- Is the TIFF data represented by the TIFF descriptor
stored in contiguous bytes?@AAFProperty(uuid1=84017411, uuid2=257, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="IsUniform", typeName="Boolean", optional=false, uniqueIdentifier=false, pid=14081) public boolean getIsUniform()
TIFFDescriptor
Returns true
if the TIFF data described by this
TIFF descriptor has the same number of rows per strip throughout;
otherwise false
.
getIsUniform
in interface TIFFDescriptor
public void setIsUniform(boolean isUniform)
TIFFDescriptor
Sets whether the TIFF data described by this TIFF descriptor
has the same number of rows per strip throughout. Set to
true
if it does; otherwise false
.
setIsUniform
in interface TIFFDescriptor
isUniform
- Does the TIFF data described by this TIFF descriptor
have the same number of rows per strip throughout?@AAFProperty(uuid1=84017411, uuid2=258, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="JPEGTableID", typeName="JPEGTableIDType", optional=true, uniqueIdentifier=false, pid=14085) public int getJPEGTableID() throws PropertyNotPresentException
TIFFDescriptor
Returns the JPEG table code property of this TIFF descriptor, which specifies the registered JPEG table code. This is an optional property that, when omitted, indicate that the described image data uses a table that is not registered.
getJPEGTableID
in interface TIFFDescriptor
PropertyNotPresentException
- The optional JPEG table id property is
not present in this TIFF descriptor.public void setJPEGTableID(Integer jpegTableID)
TIFFDescriptor
Sets the JPEG table code property of this TIFF descriptor, which specifies
the registered JPEG table code. Set this optional property to null
to omit it and indicate that the described image data uses a table that is not registered.
setJPEGTableID
in interface TIFFDescriptor
jpegTableID
- JPEG table code property of tis TIFF descriptor.@AAFProperty(uuid1=67175170, uuid2=768, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="LeadingLines", typeName="Int32", optional=true, uniqueIdentifier=false, pid=14083) public int getLeadingLines()
TIFFDescriptor
Returns the number of leading lines of the TIFF descriptor, which specifies the number of leading lines to be thrown away when viewing the TIFF data.
If this optional property is omitted, its default value of 0 will be returned.
getLeadingLines
in interface TIFFDescriptor
TIFFDescriptor.LEADINGLINES_DEFAULT
,
TIFFDescriptor.getTrailingLines()
public void setLeadingLines(Integer leadingLines)
TIFFDescriptor
Sets the number of leading lines of this TIFF descriptor, which specifies the number of leading lines to be thrown away when viewing the TIFF data.
The optional property has a default value of 0.
Set this optional property to null
to omit it.
setLeadingLines
in interface TIFFDescriptor
leadingLines
- Number of leading lines of this TIFF descriptor.TIFFDescriptor.LEADINGLINES_DEFAULT
,
TIFFDescriptor.setTrailingLines(Integer)
@AAFProperty(uuid1=50529026, uuid2=768, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="Summary", typeName="DataValue", optional=false, uniqueIdentifier=false, pid=14086) public byte[] getSummary()
TIFFDescriptor
Returns the copy of the TIFF IFD file information of this TIFF descriptor, without the sample data.
getSummary
in interface TIFFDescriptor
public void setSummary(byte[] summary) throws NullPointerException
TIFFDescriptor
Sets the copy of the TIFF IFD file information of this TIFF descriptor, without the sample data.
setSummary
in interface TIFFDescriptor
summary
- Sets the TIFF IFD file information of this TIFF
descriptor.
NullPointerException
- The given TIFF IFD data is null
.public int getSummaryBufferSize()
TIFFDescriptor
Returns the size of the buffer required by the TIFFDescriptor.getSummary()
method.
getSummaryBufferSize
in interface TIFFDescriptor
TIFFDescriptor.getSummary()
method.@AAFProperty(uuid1=67175170, uuid2=1024, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="TrailingLines", typeName="Int32", optional=true, uniqueIdentifier=false, pid=14084) public int getTrailingLines()
TIFFDescriptor
Returns the number of trailing lines of this TIFF descriptor, which specifies the number of trailing lines to be thrown away when viewing the TIFF data.
If this optional property is omitted, its default value of 0 will be returned.
getTrailingLines
in interface TIFFDescriptor
TIFFDescriptor.TRAILINGLINES_DEFAULT
,
TIFFDescriptor.getTrailingLines()
public void setTrailingLines(Integer trailingLines)
TIFFDescriptor
Sets the number of trailing lines of this TIFF descriptor, which specifies the number of trailing lines to be thrown away when viewing the TIFF data.
This optional property has a default value of 0.
Set this optional property to null
to omit it.
setTrailingLines
in interface TIFFDescriptor
trailingLines
- Trailing lines of this TIFF descriptor.TIFFDescriptor.TRAILINGLINES_DEFAULT
,
TIFFDescriptor.setLeadingLines(Integer)
public boolean equals(Object o)
MAJCommon
Tests to see if the given object is equal to this interchange object. To be equal, the given value must be not null, share the same interface to its value and each of the properties of the value must each be equal.
equals
in interface MAJCommon
equals
in class AAFFileDescriptor
o
- Object to test for equality with.
Object.equals(Object)
public int hashCode()
MAJCommon
Returns a hash code value for this interchange object.
hashCode
in interface MAJCommon
hashCode
in class AAFFileDescriptor
Object.hashCode()
public TIFFDescriptor clone()
MAJCommon
Creates a cloned copy of this entity. The clone will be initialized to have the same value as this value but exists independently from then on. Changes to this value will not effect the clone and changes to the clone will not effect this. MAJ API clones are true deep clones with no shared references to areas of memory within the original.
This method does not throw a CloneNotSupportedException
as all
entity values must implement the Cloneable
interface. If a cloning
error does occur, a null
value will be returned but this is very unlikely
to happen.
clone
in interface MAJCommon
clone
in class EssenceDescriptor
Object.clone()
public void appendXMLChildren(Node parent)
XMLSerializable
Append child elements to the given parent node to serialize the value of an object
to an XML fragment. Methods of the XMLBuilder
class are provided to help with this
process.
appendXMLChildren
in interface XMLSerializable
appendXMLChildren
in class AAFFileDescriptor
parent
- XML parent element to append child nodes to.
|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |