|
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.DigitalImageDescriptor
@AAFClass(uuid1=218169601, uuid2=257, uuid3=9984, uuid4={6,14,43,52,2,6,1,1}, definedName="DigitalImageDescriptor", description="The DigitalImageDescriptor class specifies that a File SourceMob is associated with video essence that is formatted either using RGBA or luminance/chrominance formatting.") public abstract class DigitalImageDescriptor
Implements the description of video content data formatted either using RGBA or luminance/chrominance formatting.
THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.
Nested Class Summary | |
---|---|
static class |
DigitalImageDescriptor.DigitalImageDescriptorXMLHandler
|
static class |
DigitalImageDescriptor.VideoLineMapXMLHandler
|
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 |
DIGITALIMAGEDESCRIPTOR_ITEM
|
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.DigitalImageDescriptor |
---|
ALPHATRANSPARENCY_DEFAULT, DISPLAYF2OFFSET_DEFAULT, FIELDENDOFFSET_DEFAULT, FIELDSTARTOFFSET_DEFAULT, IMAGEALIGNMENTFACTOR_DEFAULT, STOREDF2OFFSET_DEFAULT, Uncompressed |
Constructor Summary | |
---|---|
DigitalImageDescriptor()
|
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. |
boolean |
areDisplayValuesPresent()
Returns whether this digital image descriptor contains a display view. |
boolean |
areSampledValuesPresent()
Returns whether this digital image descriptor contains a sample area values dimensions and offsets. |
boolean |
equals(Object o)
Tests to see if the given object is equal to this interchange object. |
byte |
getActiveFormatDescriptor()
Returns the active format descriptor property for the digital image descriptor, which specifies the desired framing of the content within the displayed image (4:3 in 16:9 etc.). |
AlphaTransparencyType |
getAlphaTransparency()
Returns the alpha transparency property of this digital image descriptor, which specifies whether the minimum alpha value or the maximum alpha value indicates transparency. |
AUID |
getCodingEquations()
Returns the coding equations property of this digital image descriptor, which specifies the coding equations to convert RGB image components to component color difference image components. |
AUID |
getColorPrimaries()
Returns the color primaries property for the digital image descriptor. |
AUID |
getCompression()
Returns the kind of compression and format of compression information of the video essence data described by this digital image descriptor. |
int |
getDisplayF2Offset()
Returns the display field 2 offset property of this digital image descriptor. |
int |
getDisplayHeight()
|
int[] |
getDisplayView()
Returns the dimensions of the display view of this digital image descriptor. |
int |
getDisplayWidth()
|
int |
getDisplayXOffset()
|
int |
getDisplayYOffset()
|
FieldNumber |
getFieldDominance()
Returns the field dominance property of this digital image descriptor, which specifies whether field 1 or field 2 is dominant in images composed of two interlaced fields. |
int |
getFieldEndOffset()
Returns the field end offset property of this digital image descriptor, which specifies the number of unused bytes at the end of each video field. |
int |
getFieldStartOffset()
Returns the field start offset property of this digital image descriptor, which specifies the number of unused bytes at the start of each video field. |
LayoutType |
getFrameLayout()
Returns the frame layout for this digital image descriptor, which describes whether all data for a complete sample is in one frame or is split into more than one field. |
int |
getImageAlignmentFactor()
Sets the image alignment factor property of this digital image descriptor, which specifies the alignment when storing the digital essence. |
Rational |
getImageAspectRatio()
Gets the image aspect ratio property of this digital image descriptor, which describes the ratio between the horizontal size and the vertical size in the intended final image. |
int |
getSampledHeight()
|
int[] |
getSampledView()
Returns the dimensions of the sampled view of this digital image descriptor. |
int |
getSampledWidth()
|
int |
getSampledXOffset()
|
int |
getSampledYOffset()
|
SignalStandardType |
getSignalStandard()
Returns the signal standard property of this digital image descriptor. |
int |
getStoredF2Offset()
Returns the stored field 2 offset property of this digital image descriptor, which specifies a topness adjustment for the stored picture. |
int |
getStoredHeight()
|
int[] |
getStoredView()
Returns the dimension of the stored view of this digital image descriptor. |
int |
getStoredWidth()
|
AUID |
getTransferCharacteristic()
Returns the opto-electronic transfer characteristic of this digital image descriptor. |
int[] |
getVideoLineMap()
Returns the video line map property of this digital image descriptor, which specifies the scan line in the analog source that corresponds to the beginning of each digitized field. |
int |
getVideoLineMapSize()
Returns the number of elements in the video line map property array of this digital image descriptor. |
int |
hashCode()
Returns a hash code value for this interchange object. |
void |
setActiveFormatDescriptor(Byte activeFormatDescriptor)
Sets the active format descriptor property for the digital image descriptor, which specifies the desired framing of the content within the displayed image (4:3 in 16:9 etc.). |
void |
setAlphaTransparency(AlphaTransparencyType alphaTransparency)
Sets the alpha transparency property of this digital image descriptor, which specifies whether the minimum alpha value or the maximum alpha value indicates transparency. |
void |
setCodingEquations(AUID codingEquations)
Sets the coding equations property of this digital image descriptor, which specifies the coding equations to convert RGB image components to component color difference image components. |
void |
setColorPrimaries(AUID colorPrimaries)
Sets the color primaries property for this digital image descriptor. |
void |
setCompression(AUID compression)
Sets the kind of compression and format of the compression information of the video essence data described by this digital image descriptor. |
void |
setDisplayF2Offset(Integer displayF2Offset)
Sets the display field 2 offset property of this digital image descriptor. |
void |
setDisplayView(int displayHeight,
int displayWidth,
int displayXOffset,
int displayYOffset)
Sets the dimension of display view of this digital image descriptor. |
void |
setFieldDominance(FieldNumber fieldDominance)
Sets the field dominance property of this digital image descriptor, which specifies whether field 1 or field 2 is dominant in images composed of two interlaced fields. |
void |
setFieldEndOffset(Integer fieldEndOffset)
Sets the field end offset property of this digital image descriptor, which specifies the number of unused bytes at the end of each video field. |
void |
setFieldStartOffset(Integer fieldStartOffset)
Sets the field start offset property of this digital image descriptor, which specifies the number of unused bytes at the start of each video field. |
void |
setFrameLayout(LayoutType frameLayout)
Sets the frame layout for this digital image descriptor, which describes whether all data for a complete sample is in one frame or is split into more than one field. |
void |
setImageAlignmentFactor(Integer imageAlignmentFactor)
Sets the image alignment factor property of this digital image descriptor which specifies the alignment when storing the digital essence. |
void |
setImageAspectRatio(Rational imageAspectRatio)
Sets the image aspect ratio property of this digital image descriptor, which describes the ratio between the horizontal size and the vertical size in the intended final image. |
void |
setPropertiesFromInterface(DigitalImageDescriptor castFrom)
|
void |
setSampledView(int sampledHeight,
int sampledWidth,
int sampledXOffset,
int sampledYOffset)
Sets the dimensions of the sampled view of this digital image descriptor. |
void |
setSignalStandard(SignalStandardType signalStandard)
Sets the signal standard property of this digital image descriptor, which specifies the underlying signal standard used to define the raster. |
void |
setStoredF2Offset(Integer storedF2Offset)
Sets the stored field 2 offset property of this digital image descriptor, which specifies a topness adjustment for the stored picture. |
void |
setStoredHeight(int storedHeight)
|
void |
setStoredView(int storedHeight,
int storedWidth)
Sets the dimension of the stored view of this digital image descriptor. |
void |
setStoredWidth(int storedWidth)
|
void |
setTransferCharacteristic(AUID transferCharacteristic)
Sets the opto-electronic transfer characteristic of this digital image descriptor. |
void |
setVideoLineMap(int[] videoLineMap)
Sets the video line map property of this digital image descriptor, which specifies the scan line in the analog source that corresponds to the beginning of each digitized field. |
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, clone, 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 |
---|
clone, toString |
Field Detail |
---|
public static final String DIGITALIMAGEDESCRIPTOR_ITEM
Constructor Detail |
---|
public DigitalImageDescriptor()
Method Detail |
---|
public final void setPropertiesFromInterface(DigitalImageDescriptor castFrom)
InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)
@AAFProperty(uuid1=67175170, uuid2=2304, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="ActiveFormatDescriptor", typeName="UInt8", optional=true, uniqueIdentifier=false, pid=12824) public byte getActiveFormatDescriptor() throws PropertyNotPresentException
DigitalImageDescriptor
Returns the active format descriptor property for the digital image descriptor, which specifies the desired framing of the content within the displayed image (4:3 in 16:9 etc.). The value exactly matches the active_format element defined by ETSI TS 102 154.
This optional property is set to the default value of "unspecified" by omitting its value.
getActiveFormatDescriptor
in interface DigitalImageDescriptor
PropertyNotPresentException
- The optional active format descriptor property
is not present in this digital image descriptor.public void setActiveFormatDescriptor(Byte activeFormatDescriptor) throws IllegalArgumentException
DigitalImageDescriptor
Sets the active format descriptor property for the digital image descriptor, which specifies the desired framing of the content within the displayed image (4:3 in 16:9 etc.). The value exactly matches the "active_format" element defined by ETSI TS 102 154.
To omit this optional property, call this method with null
.
When the property is not present, it is considered to be the same as its default
value of "unspecified".
setActiveFormatDescriptor
in interface DigitalImageDescriptor
activeFormatDescriptor
- Active format descriptor property for this
digital image descriptor.
IllegalArgumentException
- The active format descriptor is a 4-bit value
and cannot lie outside the range 0 to 15.@AAFProperty(uuid1=85983490, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="AlphaTransparency", typeName="AlphaTransparencyType", optional=true, uniqueIdentifier=false, pid=12815) public AlphaTransparencyType getAlphaTransparency()
DigitalImageDescriptor
Returns the alpha transparency property of this digital image descriptor, which specifies whether the minimum alpha value or the maximum alpha value indicates transparency. This is an optional property and if the value is omitted, the default value of AlphaTransparencyType.MinValueTransparent is returned.
getAlphaTransparency
in interface DigitalImageDescriptor
DigitalImageDescriptor.ALPHATRANSPARENCY_DEFAULT
public void setAlphaTransparency(AlphaTransparencyType alphaTransparency)
DigitalImageDescriptor
Sets the alpha transparency property of this digital image descriptor, which
specifies whether the minimum alpha value or the maximum
alpha value indicates transparency. To omit this optional property, call this
method with null
.
setAlphaTransparency
in interface DigitalImageDescriptor
alphaTransparency
- Alpha transparency orientation for this digital image
descriptor.DigitalImageDescriptor.ALPHATRANSPARENCY_DEFAULT
@AAFProperty(uuid1=67174913, uuid2=259, uuid3=256, uuid4={6,14,43,52,1,1,1,2}, definedName="CodingEquations", typeName="CodingEquationsType", optional=true, uniqueIdentifier=false, pid=12826) public AUID getCodingEquations() throws PropertyNotPresentException
DigitalImageDescriptor
Returns the coding equations property of this digital image descriptor, which specifies the coding equations to convert RGB image components to component color difference image components.
The default value for this optional property is unspecified which is represented by this property being omitted.
getCodingEquations
in interface DigitalImageDescriptor
PropertyNotPresentException
- The optional coding equations property
is not present for this digital image descriptor, indicating that it is
unspecified.CodingEquationsType
,
TypeDefinitionExtendibleEnumeration.ColorPrimariesType
public void setCodingEquations(AUID codingEquations)
DigitalImageDescriptor
Sets the coding equations property of this digital image descriptor, which specifies the coding equations to convert RGB image components to component color difference image components.
The default value for this optional property is unspecified,
which is represented by omitting this property. Setting the optional
coding equations property to null
will result in the property
being omitted.
setCodingEquations
in interface DigitalImageDescriptor
codingEquations
- Coding equations property of this digital image
descriptor.CodingEquationsType
,
TypeDefinitionExtendibleEnumeration.ColorPrimariesType
@AAFProperty(uuid1=67174913, uuid2=262, uuid3=256, uuid4={6,14,43,52,1,1,1,9}, definedName="ColorPrimaries", typeName="ColorPrimariesType", optional=true, uniqueIdentifier=false, pid=12825) public AUID getColorPrimaries() throws PropertyNotPresentException
DigitalImageDescriptor
Returns the color primaries property for the digital image descriptor.
This is an optional property and if the property is omitted it is assumed to be unspecified.
getColorPrimaries
in interface DigitalImageDescriptor
PropertyNotPresentException
- The optional color primaries property is not
present for this digital image descriptor, indicating that it is unspecified.ColorPrimariesType
,
TypeDefinitionExtendibleEnumeration.ColorPrimariesType
public void setColorPrimaries(AUID colorPrimaries)
DigitalImageDescriptor
Sets the color primaries property for this digital image descriptor.
The default value for this property is unspecified, which is
represented by omitting this property. Set this optional property to
null
to omit it.
setColorPrimaries
in interface DigitalImageDescriptor
colorPrimaries
- Color primaries for the digiral image descriptor.ColorPrimariesType
,
TypeDefinitionExtendibleEnumeration.ColorPrimariesType
@AAFProperty(uuid1=67175937, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="Compression", typeName="AUID", optional=true, uniqueIdentifier=false, pid=12801) public AUID getCompression() throws PropertyNotPresentException
DigitalImageDescriptor
Returns the kind of compression and format of compression
information of the video essence data described by this digital image descriptor. If
the image data is uncompressed, a PropertyNotPresentException
will be thrown.
getCompression
in interface DigitalImageDescriptor
PropertyNotPresentException
- The optional compression property is not
present in this digital image descriptor, indicating that the described image
essence data is uncompressed.public void setCompression(AUID compression)
DigitalImageDescriptor
Sets the kind of compression and format of the compression
information of the video essence data described by this digital image descriptor. If there
is no compression, set this optional property to DigitalImageDescriptor.Uncompressed
or null
.
setCompression
in interface DigitalImageDescriptor
compression
- Kind of compression and format of the compression
information of the video essence data, or DigitalImageDescriptor.Uncompressed
if the
image is uncompressed.DigitalImageDescriptor.Uncompressed
@AAFProperty(uuid1=67175170, uuid2=1792, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="DisplayF2Offset", typeName="Int32", optional=true, uniqueIdentifier=false, pid=12823) public int getDisplayF2Offset()
DigitalImageDescriptor
Returns the display field 2 offset property of this digital image descriptor. This value specifies a topness adjustment for the displayed picture. Valid values are 0 or 1.
If this property value is omitted, its default value of 0 will be returned.
getDisplayF2Offset
in interface DigitalImageDescriptor
DigitalImageDescriptor.DISPLAYF2OFFSET_DEFAULT
public void setDisplayF2Offset(Integer displayF2Offset) throws IllegalArgumentException
DigitalImageDescriptor
Sets the display field 2 offset property of this digital image descriptor. This value specifies a topness adjustment for the displayed picture. Valid values are 0 or 1.
Set this optional property to null
to omit its value. The
default value of this property is 0.
setDisplayF2Offset
in interface DigitalImageDescriptor
displayF2Offset
- Display field 2 offset property of this
digital image descriptor.
IllegalArgumentException
- The given display field 2 offset is not one
of the valid values of 0 or 1.DigitalImageDescriptor.DISPLAYF2OFFSET_DEFAULT
public int[] getDisplayView()
DigitalImageDescriptor
Returns the dimensions of the display view of this digital image descriptor. Typically, this includes the active picture area, but excludes leading blank video lines and any VITC lines. The offset is specified relative to the rectangle specified by the stored view.
The value returned is an array of four integer values. The index of the values correspond to:
0
- display height - Number of pixels in vertical
dimension of display view.1
- display width - Number of pixels in horizontal
dimension of display view.2
- display X offset - Number of pixels from top
left corner of stored view.3
- display Y offset - Number of pixels from top
left corner of stored view.The display view properties are either all present or all omitted. If the
properties are omitted, the default value is returned which is an area
equivalent to the stored view. To find out whether the display view
properties are present, call DigitalImageDescriptor.areDisplayValuesPresent()
.
getDisplayView
in interface DigitalImageDescriptor
public void setDisplayView(int displayHeight, int displayWidth, int displayXOffset, int displayYOffset) throws IllegalPropertyValueException
DigitalImageDescriptor
Sets the dimension of display view of this digital image descriptor. Typically, this includes the active picture area, but excludes leading blank video lines and any VITC lines. The offset is specified relative to the rectangle specified by the stored view.
All properties are optional and are set as follows:
displayHeight
- The default value is the stored height, so use
getStoredView()[0]
to set the default value.displayWidth
- The default value is the stored width, so use
getStoredView()[1]
to set the default value.displayXOffset
- The default value is 0, so use 0
to select the default.displayYOffset
- The default value is 0, so use 0
to select the default.The display view values are either all present or all omitted. Calling this
method successfully will mean display view values are present. To find out whether the display
view properties are present, call DigitalImageDescriptor.areDisplayValuesPresent()
.
setDisplayView
in interface DigitalImageDescriptor
displayHeight
- Number of pixels in vertical dimension of display view.displayWidth
- Number of pixels in vertical dimension of display view.displayXOffset
- Number of pixels from the top-left corner of the stored view.displayYOffset
- Number pixels from the top-left corner of the stored view.
IllegalPropertyValueException
- The area specified by display width
and display X offset properties is outside the stored view, or the area specified
by display height and display Y offset properties is outside the stored view.@AAFProperty(uuid1=67175681, uuid2=2816, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="DisplayHeight", typeName="UInt32", optional=true, uniqueIdentifier=false, pid=12808) public int getDisplayHeight()
@AAFProperty(uuid1=67175681, uuid2=3072, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="DisplayWidth", typeName="UInt32", optional=true, uniqueIdentifier=false, pid=12809) public int getDisplayWidth()
@AAFProperty(uuid1=67175681, uuid2=3328, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="DisplayXOffset", typeName="Int32", optional=true, uniqueIdentifier=false, pid=12810) public int getDisplayXOffset()
@AAFProperty(uuid1=67175681, uuid2=3584, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="DisplayYOffset", typeName="Int32", optional=true, uniqueIdentifier=false, pid=12811) public int getDisplayYOffset()
public boolean areDisplayValuesPresent()
DigitalImageDescriptor
Returns whether this digital image descriptor contains a display view. A value
of true
indicates that display height, width, x-offset and y-offset values are present.
areDisplayValuesPresent
in interface DigitalImageDescriptor
DigitalImageDescriptor.getDisplayView()
,
DigitalImageDescriptor.setDisplayView(int, int, int, int)
@AAFProperty(uuid1=67175169, uuid2=1536, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="FieldDominance", typeName="FieldNumber", optional=true, uniqueIdentifier=false, pid=12818) public FieldNumber getFieldDominance() throws PropertyNotPresentException
DigitalImageDescriptor
Returns the field dominance property of this digital image descriptor, which specifies whether field 1 or field 2 is dominant in images composed of two interlaced fields. This is an optional property with no default value.
getFieldDominance
in interface DigitalImageDescriptor
PropertyNotPresentException
- The optional field dominance property is
not present for this digital image descriptor.public void setFieldDominance(FieldNumber fieldDominance)
DigitalImageDescriptor
Sets the field dominance property of this digital image descriptor, which specifies whether field 1 or field 2 is dominant in images composed of two interlaced fields.
This is an optional property with no default value. Call this method with
null
to omit this property.
setFieldDominance
in interface DigitalImageDescriptor
fieldDominance
- Field dominance of this digital image descriptor.@AAFProperty(uuid1=68681987, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="FieldEndOffset", typeName="UInt32", optional=true, uniqueIdentifier=false, pid=12820) public int getFieldEndOffset()
DigitalImageDescriptor
Returns the field end offset property of this digital image descriptor, which specifies the number of unused bytes at the end of each video field.
If this property value is omitted, its default value of DigitalImageDescriptor.FIELDENDOFFSET_DEFAULT
will be returned.
getFieldEndOffset
in interface DigitalImageDescriptor
DigitalImageDescriptor.FIELDENDOFFSET_DEFAULT
public void setFieldEndOffset(Integer fieldEndOffset) throws IllegalArgumentException
DigitalImageDescriptor
Sets the field end offset property of this digital image descriptor, which specifies the number of unused bytes at the end of each video field.
Set this optional property to null
to omit its value. The default value
of this property is 0.
setFieldEndOffset
in interface DigitalImageDescriptor
fieldEndOffset
- Field end offset property of this digital image
descriptor.
IllegalArgumentException
- Cannot set the field end offset to a negative
value for this digital image descriptor.DigitalImageDescriptor.FIELDENDOFFSET_DEFAULT
@AAFProperty(uuid1=68681986, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="FieldStartOffset", typeName="UInt32", optional=true, uniqueIdentifier=false, pid=12819) public int getFieldStartOffset()
DigitalImageDescriptor
Returns the field start offset property of this digital image descriptor, which specifies the number of unused bytes at the start of each video field.
If this property value is omitted, its default value of 0 will be returned.
getFieldStartOffset
in interface DigitalImageDescriptor
DigitalImageDescriptor.FIELDSTARTOFFSET_DEFAULT
public void setFieldStartOffset(Integer fieldStartOffset) throws IllegalArgumentException
DigitalImageDescriptor
Sets the field start offset property of this digital image descriptor, which specifies the number of unused bytes at the start of each video field.
Set this optional property to null
to omit its value. The default
value of this property is 0.
setFieldStartOffset
in interface DigitalImageDescriptor
fieldStartOffset
- Field start offset of this digital image descriptor.
IllegalArgumentException
- The given field start offset is negative.DigitalImageDescriptor.FIELDSTARTOFFSET_DEFAULT
@AAFProperty(uuid1=67175169, uuid2=1024, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="FrameLayout", typeName="LayoutType", optional=false, uniqueIdentifier=false, pid=12812) public LayoutType getFrameLayout()
DigitalImageDescriptor
Returns the frame layout for this digital image descriptor, which describes whether all data for a complete sample is in one frame or is split into more than one field.
getFrameLayout
in interface DigitalImageDescriptor
public void setFrameLayout(LayoutType frameLayout) throws NullPointerException
DigitalImageDescriptor
Sets the frame layout for this digital image descriptor, which describes whether all data for a complete sample is in one frame or is split into more than one field.
setFrameLayout
in interface DigitalImageDescriptor
frameLayout
- Frame layout for the digital image descriptor.
NullPointerException
- The given frame layout is null
.@AAFProperty(uuid1=68681985, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="ImageAlignmentFactor", typeName="UInt32", optional=true, uniqueIdentifier=false, pid=12817) public int getImageAlignmentFactor()
DigitalImageDescriptor
Sets the image alignment factor property of this digital image descriptor, which specifies the alignment when storing the digital essence.
For example, a value of 16 means that the image is stored on 16-byte boundaries. The starting point for a field will always be a multiple of 16 bytes. If the field does not end on a 16-byte boundary, it is padded out to the next 16-byte boundary.
This property is optional and the default value of 1 will be returned if it is currently omitted.
getImageAlignmentFactor
in interface DigitalImageDescriptor
public void setImageAlignmentFactor(Integer imageAlignmentFactor) throws IllegalArgumentException
DigitalImageDescriptor
Sets the image alignment factor property of this digital image descriptor which specifies the alignment when storing the digital essence.
For example, a value of 16 means that the image is stored on 16-byte boundaries. The starting point for a field will always be a multiple of 16 bytes. If the field does not end on a 16-byte boundary, it is padded out to the next 16-byte boundary.
Set this optional property to null
to omit the property. The
default value of this property is 1.
setImageAlignmentFactor
in interface DigitalImageDescriptor
imageAlignmentFactor
- Image alignment factor of this digital image
descriptor.
IllegalArgumentException
- Cannot set the image alignment factor to
a negative value for this digital image descriptor.@AAFProperty(uuid1=67174657, uuid2=256, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="ImageAspectRatio", typeName="Rational", optional=false, uniqueIdentifier=false, pid=12814) public Rational getImageAspectRatio()
DigitalImageDescriptor
Gets the image aspect ratio property of this digital image descriptor, which describes the ratio between the horizontal size and the vertical size in the intended final image.
getImageAspectRatio
in interface DigitalImageDescriptor
public void setImageAspectRatio(Rational imageAspectRatio) throws NullPointerException
DigitalImageDescriptor
Sets the image aspect ratio property of this digital image descriptor, which describes the ratio between the horizontal size and the vertical size in the intended final image.
setImageAspectRatio
in interface DigitalImageDescriptor
imageAspectRatio
- Ratio between horizontal and vertical size of the
intended final image.
NullPointerException
- The given image aspect ratio is null
.public int[] getSampledView()
DigitalImageDescriptor
Returns the dimensions of the sampled view of this digital image descriptor. Typically, this includes any VITC lines as well as the active picture area, but excludes leading blank video lines. The offset is specified relative to the rectangle specified by the stored view.
The value returned is an array of four integer values. The index of the values correspond to:
0
- sampled height - Number of pixels in vertical
dimension of sampled view.1
- sampled width - Number of pixels in horizontal
dimension of sampled view.2
- sampled X offset - Number of pixels from top
left corner of stored view.3
- sampled Y offset - Number of pixels from top
left corner of stored view.The sampled view properties are either all present or all omitted. If the
properties are omitted, the default value is returned which is an area
equivalent to the stored view. To find out whether the sampled view
properties are present, call DigitalImageDescriptor.areSampledValuesPresent()
.
getSampledView
in interface DigitalImageDescriptor
public void setSampledView(int sampledHeight, int sampledWidth, int sampledXOffset, int sampledYOffset) throws IllegalPropertyValueException
DigitalImageDescriptor
Sets the dimensions of the sampled view of this digital image descriptor. Typically, this includes any VITC lines as well as the active picture area, but excludes leading blank video lines. The offset is specified relative to the rectangle specified by the stored view.
All properties are optional and are set as follows:
sampledHeight
- The default value is the stored height, so use
getStoredView()[0]
to set the default value.sampledWidth
- The default value is the stored width, so use
getStoredView()[1]
to set the default value.displayXOffset
- The default value is 0, so use 0
to select the default.displayYOffset
- The default value is 0, so use 0
to select the default.The sampled view values are either all present or all omitted. Calling this
method will mean sampled view values are present. To find out whether the sampled
view properties are present, call DigitalImageDescriptor.areSampledValuesPresent()
.
setSampledView
in interface DigitalImageDescriptor
sampledHeight
- Number of pixels in vertical dimension of sampled view.sampledWidth
- Number of pixels in horizontal dimension of sampled view.sampledXOffset
- Number of pixels from top left corner of the stored view.sampledYOffset
- Number of pixels from top left corner of the stored view.
IllegalPropertyValueException
- The area specified by the sampled width
and sampled X offset is outside the stored view, or the area
specified by the sampled height and sampled Y offset is
outside the stored view.@AAFProperty(uuid1=67175681, uuid2=1792, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="SampledHeight", typeName="UInt32", optional=true, uniqueIdentifier=false, pid=12804) public int getSampledHeight()
@AAFProperty(uuid1=67175681, uuid2=2048, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="SampledWidth", typeName="UInt32", optional=true, uniqueIdentifier=false, pid=12805) public int getSampledWidth()
@AAFProperty(uuid1=67175681, uuid2=2304, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="SampledXOffset", typeName="Int32", optional=true, uniqueIdentifier=false, pid=12806) public int getSampledXOffset()
@AAFProperty(uuid1=67175681, uuid2=2560, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="SampledYOffset", typeName="Int32", optional=true, uniqueIdentifier=false, pid=12807) public int getSampledYOffset()
public boolean areSampledValuesPresent()
DigitalImageDescriptor
Returns whether this digital image descriptor contains a sample area values dimensions and
offsets. A value of true
indicates that sampled height, width, x-offset and y-offset
values are present.
areSampledValuesPresent
in interface DigitalImageDescriptor
DigitalImageDescriptor.getSampledView()
,
DigitalImageDescriptor.setSampledView(int, int, int, int)
@AAFProperty(uuid1=67436819, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="SignalStandard", typeName="SignalStandardType", optional=true, uniqueIdentifier=false, pid=12821) public SignalStandardType getSignalStandard() throws PropertyNotPresentException
DigitalImageDescriptor
Returns the signal standard property of this digital image descriptor. This property specifies the underlying signal standard used to define the raster.
The default value for this property is unspecified, which is represented by omitting this property.
getSignalStandard
in interface DigitalImageDescriptor
PropertyNotPresentException
- The optional signal standard property is
not present for this digital image descriptor, indicating that it is
unspecified.SignalStandardType
public void setSignalStandard(SignalStandardType signalStandard)
DigitalImageDescriptor
Sets the signal standard property of this digital image descriptor, which specifies the underlying signal standard used to define the raster.
The default value for signal standard property is unspecified, which
is represented by omitting this property. Set this optional property to null
to omit it.
setSignalStandard
in interface DigitalImageDescriptor
signalStandard
- Signal standard property of this digital image
descriptor.@AAFProperty(uuid1=67175170, uuid2=2048, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="StoredF2Offset", typeName="Int32", optional=true, uniqueIdentifier=false, pid=12822) public int getStoredF2Offset()
DigitalImageDescriptor
Returns the stored field 2 offset property of this digital image descriptor, which specifies a topness adjustment for the stored picture. Valid values are 0 or -1.
This is an optional property and if it is omitted, the default value of 0 will be returned.
getStoredF2Offset
in interface DigitalImageDescriptor
DigitalImageDescriptor.STOREDF2OFFSET_DEFAULT
public void setStoredF2Offset(Integer storedF2Offset) throws IllegalArgumentException
DigitalImageDescriptor
Sets the stored field 2 offset property of this digital image descriptor, which specifies a topness adjustment for the stored picture. Valid values are 0 or -1.
Set this optional property to null
to omit its value. The
default value of this property is 0.
setStoredF2Offset
in interface DigitalImageDescriptor
storedF2Offset
- Stored field 2 offset property of this digital
image descriptor.
IllegalArgumentException
- The given stored field 2 offset is not one
of the valid values of 0 or -1.DigitalImageDescriptor.STOREDF2OFFSET_DEFAULT
public int[] getStoredView()
DigitalImageDescriptor
Returns the dimension of the stored view of this digital image descriptor. Typically, this includes leading blank video lines, any VITC lines, as well as the active picture area.
The value returned is an array of two integer values. The first element of the array (index 0) contains the stored height and the second element of the array (index 1) contains the stored width.
getStoredView
in interface DigitalImageDescriptor
public void setStoredView(int storedHeight, int storedWidth) throws IllegalArgumentException
DigitalImageDescriptor
Sets the dimension of the stored view of this digital image descriptor. Typically, this includes leading blank video lines, any VITC lines, as well as the active picture area.
setStoredView
in interface DigitalImageDescriptor
storedHeight
- Number of pixels in vertical dimension of stored view.storedWidth
- Number of pixels in horizontal dimension of stored view.
IllegalArgumentException
- One or both of the given stored width and height
properties is/are negative, which is not permitted.@AAFProperty(uuid1=67175682, uuid2=256, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="StoredHeight", typeName="UInt32", optional=false, uniqueIdentifier=false, pid=12802) public int getStoredHeight()
public void setStoredHeight(int storedHeight) throws IllegalArgumentException
IllegalArgumentException
@AAFProperty(uuid1=67175682, uuid2=512, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="StoredWidth", typeName="UInt32", optional=false, uniqueIdentifier=false, pid=12803) public int getStoredWidth()
public void setStoredWidth(int storedWidth) throws IllegalArgumentException
IllegalArgumentException
@AAFProperty(uuid1=67174913, uuid2=257, uuid3=512, uuid4={6,14,43,52,1,1,1,2}, definedName="TransferCharacteristic", typeName="TransferCharacteristicType", optional=true, uniqueIdentifier=false, pid=12816) public AUID getTransferCharacteristic() throws PropertyNotPresentException
DigitalImageDescriptor
Returns the opto-electronic transfer characteristic of this digital image descriptor. If this optional property is omitted, the opto-electronic characteristic is unspecified.
getTransferCharacteristic
in interface DigitalImageDescriptor
PropertyNotPresentException
- The optional opto-electronic characteristic
of this digital image descriptor is not present and so is unspecified.TransferCharacteristicType
,
TypeDefinitionExtendibleEnumeration.TransferCharacteristicType
public void setTransferCharacteristic(AUID transferCharacteristic)
DigitalImageDescriptor
Sets the opto-electronic transfer characteristic of this digital image descriptor.
The default value for the transfer characteristic property is
unspecified, which is represented by this property being omitted.
If this method is called with a null
value, the
this optional property is omitted.
setTransferCharacteristic
in interface DigitalImageDescriptor
transferCharacteristic
- Opto-electronic transfer characteristic of
the digital image descriptor.TransferCharacteristicType
,
TypeDefinitionExtendibleEnumeration.TransferCharacteristicType
@AAFProperty(uuid1=67175170, uuid2=1280, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="VideoLineMap", typeName="Int32Array", optional=false, uniqueIdentifier=false, pid=12813) public int[] getVideoLineMap()
DigitalImageDescriptor
Returns the video line map property of this digital image descriptor, which specifies the scan line in the analog source that corresponds to the beginning of each digitized field. For single-field video, there is 1 value in the array. For interleaved video, there are 2 values in the array.
getVideoLineMap
in interface DigitalImageDescriptor
public void setVideoLineMap(int[] videoLineMap) throws NullPointerException, IllegalArgumentException
DigitalImageDescriptor
Sets the video line map property of this digital image descriptor, which specifies the scan line in the analog source that corresponds to the beginning of each digitized field. For single-field video, there is 1 value in the array. For interleaved video, there are 2 values in the array.
setVideoLineMap
in interface DigitalImageDescriptor
videoLineMap
- Video line map for the digital image descriptor.
NullPointerException
- The given video line map is null
.
IllegalArgumentException
- The size of the video line map must be 1
or 2 for this digital image descriptor.public int getVideoLineMapSize()
DigitalImageDescriptor
Returns the number of elements in the video line map property array of this digital image descriptor.
getVideoLineMapSize
in interface DigitalImageDescriptor
DigitalImageDescriptor.getVideoLineMap()
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 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 |