|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecttv.amwa.maj.entity.InterchangeObject
tv.amwa.maj.entity.EssenceDescriptor
tv.amwa.maj.entity.PhysicalDescriptor
tv.amwa.maj.entity.ImportDescriptor
tv.amwa.maj.entity.BWFImportDescriptor
@AAFClass(uuid1=218169601, uuid2=257, uuid3=20480, uuid4={6,14,43,52,2,6,1,1}, definedName="BWFImportDescriptor", description="Specifies audio essence represented according to the Broadcast Wave specifications.") public class BWFImportDescriptor
Implements the description of audio essence that is formatted according the the Broadcast Wave Format specifications, which is a file essence source that is not directly manipulated by an AAF application.
THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.
Nested Class Summary | |
---|---|
static class |
BWFImportDescriptor.UnknownBWFChunksXMLHandler
|
static class |
BWFImportDescriptor.XMLHandler
|
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 |
BWFIMPORTDESCRIPTOR_TAG
|
Fields inherited from class tv.amwa.maj.entity.ImportDescriptor |
---|
IMPORTDESCRIPTOR_TAG |
Fields inherited from class tv.amwa.maj.entity.EssenceDescriptor |
---|
ESSENCEDESCRIPTOR_ITEM |
Constructor Summary | |
---|---|
BWFImportDescriptor()
Creates and initializes a new BWF import descriptor, which specifies audio data essence according to the Broadcast Wave specifications. |
Method Summary | |
---|---|
void |
appendUnknownBWFChunk(RIFFChunk chunk)
Append a RIFFChunk to end of the list of unknown BWF chunks of this BWF import descriptor. |
void |
appendXMLChildren(Node parent)
Append child elements to the given parent node to serialize the value of an object to an XML fragment. |
BWFImportDescriptor |
clone()
Creates a cloned copy of this entity. |
int |
countUnknownBWFChunks()
Returns the total number of unknown BWF chunks attached to this BWF import descriptor. |
boolean |
equals(Object o)
Tests to see if the given object is equal to this interchange object. |
String |
getBasicData()
Returns the basic data of this BWF import descriptor, which is taken from the basic data property of the associated <qlty> chunk. |
String |
getCodingHistory()
Returns the coding history property of this BWF import descriptor, which is taken from the coding history property of the associated <bext> chunk. |
String |
getCueSheet()
Returns the cue sheet property of this BWF import descriptor, which is taken from the cue sheet data property of the associated <qlty> chunk. |
String |
getEndOfModulation()
Returns the end of modulation property of this BWF import descriptor, which is taken from the end modulation data property of the associated <qlty> chunk. |
int |
getFileSecurityReport()
Returns the file security code of the quality report of this BWF import descriptor. |
int |
getFileSecurityWave()
Returns the file security code of the BWF wave data of this BWF import descriptor. |
String |
getOperatorComment()
Returns the operator comment property of this BWF import descriptor, which is taken from the comment of operator property of the associated <qlty> chunk. |
String |
getQualityEvent()
Returns the quality event data property of this BWF import descriptor, which is taken from the quality event data property of the associated <qlty> chunk. |
String |
getQualityParameter()
Returns the quality parameter property of this BWF import descriptor, which is taken from the quality parameter data property of the associated <qlty> chunk. |
String |
getStartOfModulation()
Returns the start of modulation data of this BWF import descriptor, which is taken from the start modulation data poperty of the associated <qlty> chunk. |
RIFFChunk |
getUnknownBWFChunkAt(int index)
Returns the RIFFChunk from the list of unknown BWF chunks of this BWF import descriptor at the given index. |
List<RIFFChunk> |
getUnknownBWFChunks()
Returns a copy of the list of unknown BWF chunks of this BWF import descriptor. |
int |
hashCode()
Returns a hash code value for this interchange object. |
void |
insertUnknownBWFChunkAt(int index,
RIFFChunk chunk)
Insert a RIFFChunk into the list of unknown BWF chunks of this BWF import descriptor at the given index. |
void |
prependUnknownBWFChunk(RIFFChunk chunk)
Prepend a RIFFChunk to the beginning of the list of unknown BWF chunks of this BWF descriptor. |
void |
removeUnknownBWFChunkAt(int index)
Removes the RIFFChunk at the given index through the list of unknown BWF chunks of this BWF descriptor. |
void |
setBasicData(String basicData)
Sets the basic data of this BWF import descriptor, which is taken from the basic data property of the associated <qlty> chunk. |
void |
setCodingHistory(String codingHistory)
Sets the coding history property of this BWF import descriptor, which is taken from the coding history property of the associated <bext> chunk. |
void |
setCueSheet(String cueSheet)
Sets the cue sheet property of this BWF import descriptor, which is taken from the cue sheet data property of the associated <qlty> chunk. |
void |
setEndOfModulation(String endOfModulation)
Sets the end of modulation property of this BWF import descriptor, which is taken from the end modulation data property of the associated <qlty> chunk. |
void |
setFileSecurityReport(Integer fileSecurityReport)
Set the file security code of the quality report of this BWF import descriptor. |
void |
setFileSecurityWave(Integer fileSecurityWave)
Sets the file security code of the BWF wave data of this BWF import descriptor. |
void |
setOperatorComment(String operatorComment)
Sets the operator comment property of this BWF import descriptor, which is taken from the comment of operator property of the associated <qlty> chunk. |
void |
setPropertiesFromInterface(BWFImportDescriptor castFrom)
|
void |
setQualityEvent(String qualityEvent)
Sets the quality event data property of this BWF import descriptor, which is taken from the quality event data property of the associated <qlty> chunk. |
void |
setQualityParameter(String qualityParameter)
Sets the quality parameter property of this BWF import descriptor, which is taken from the quality parameter data property of the associated <qlty> chunk. |
void |
setStartOfModulation(String startOfModulation)
Sets the start of modulation data of this BWF import descriptor, which is taken from the start modulation data property of the associated <qlty> chunk. |
Methods inherited from class tv.amwa.maj.entity.ImportDescriptor |
---|
setPropertiesFromInterface |
Methods inherited from class tv.amwa.maj.entity.PhysicalDescriptor |
---|
setPropertiesFromInterface |
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, wait, wait, wait |
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 BWFIMPORTDESCRIPTOR_TAG
Constructor Detail |
---|
public BWFImportDescriptor()
Creates and initializes a new BWF import descriptor, which specifies audio data essence according to the Broadcast Wave specifications.
Method Detail |
---|
public final void setPropertiesFromInterface(BWFImportDescriptor castFrom)
InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)
@AAFProperty(uuid1=67241218, uuid2=513, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="QltyBasicData", typeName="String", optional=true, uniqueIdentifier=false, pid=15650) public String getBasicData() throws PropertyNotPresentException
BWFImportDescriptor
Returns the basic data of this BWF import descriptor, which is taken from the basic data property of the associated <qlty> chunk. This property is optional.
getBasicData
in interface BWFImportDescriptor
PropertyNotPresentException
- The optional basic data property is not present
in this BWF import descriptor.public void setBasicData(String basicData)
BWFImportDescriptor
Sets the basic data of this BWF import descriptor, which is taken from the
basic data property of the associated <qlty> chunk. This property is optional
and setting it to null
will omit the property.
setBasicData
in interface BWFImportDescriptor
basicData
- Basic data of this BWF import descriptor.@AAFProperty(uuid1=67241218, uuid2=257, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="BextCodingHistory", typeName="String", optional=true, uniqueIdentifier=false, pid=15649) public String getCodingHistory() throws PropertyNotPresentException
BWFImportDescriptor
Returns the coding history property of this BWF import descriptor, which is taken from the coding history property of the associated <bext> chunk. This property is optional.
getCodingHistory
in interface BWFImportDescriptor
PropertyNotPresentException
- The optional coding history property is not
present in this BWF import descriptor.public void setCodingHistory(String codingHistory)
BWFImportDescriptor
Sets the coding history property of this BWF import descriptor, which is
taken from the coding history property of the associated <bext> chunk.
This property is optional and setting it to null
will omit the
property.
setCodingHistory
in interface BWFImportDescriptor
codingHistory
- Coding history property of this BWF import descriptor.@AAFProperty(uuid1=67241218, uuid2=2049, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="QltyCueSheet", typeName="String", optional=true, uniqueIdentifier=false, pid=15656) public String getCueSheet() throws PropertyNotPresentException
BWFImportDescriptor
Returns the cue sheet property of this BWF import descriptor, which is taken from the cue sheet data property of the associated <qlty> chunk. This property is optional
getCueSheet
in interface BWFImportDescriptor
PropertyNotPresentException
- The optional cue sheet property is not present
in this BWF import descriptor.public void setCueSheet(String cueSheet)
BWFImportDescriptor
Sets the cue sheet property of this BWF import descriptor, which is taken from
the cue sheet data property of the associated <qlty> chunk. This
property is optional and setting it to null
will omit the property.
setCueSheet
in interface BWFImportDescriptor
cueSheet
- Cue sheet property of this BWF import descriptor.@AAFProperty(uuid1=67241218, uuid2=1281, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="QltyEndOfModulation", typeName="String", optional=true, uniqueIdentifier=false, pid=15653) public String getEndOfModulation() throws PropertyNotPresentException
BWFImportDescriptor
Returns the end of modulation property of this BWF import descriptor, which is taken from the end modulation data property of the associated <qlty> chunk. This property is optional.
getEndOfModulation
in interface BWFImportDescriptor
PropertyNotPresentException
- The optional end of modulation property is not
present in this BWF import descriptor.public void setEndOfModulation(String endOfModulation)
BWFImportDescriptor
Sets the end of modulation property of this BWF import descriptor, which is taken from
the end modulation data property of the associated <qlty> chunk. This
property is optional and setting it to null
will omit the property.
setEndOfModulation
in interface BWFImportDescriptor
endOfModulation
- End of modulation property of this BWF import descriptor.@AAFProperty(uuid1=67240706, uuid2=1280, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="QltyFileSecurityReport", typeName="UInt32", optional=true, uniqueIdentifier=false, pid=15637) public int getFileSecurityReport() throws PropertyNotPresentException
BWFImportDescriptor
Returns the file security code of the quality report of this BWF import descriptor. This property is optional.
getFileSecurityReport
in interface BWFImportDescriptor
PropertyNotPresentException
- The optional file security code value is
not present in this BWF import descriptor.public void setFileSecurityReport(Integer fileSecurityReport)
BWFImportDescriptor
Set the file security code of the quality report of this BWF import descriptor.
This property is optional and can be omitted by setting its value to
null
.
setFileSecurityReport
in interface BWFImportDescriptor
fileSecurityReport
- File security code of the quality report of this BWF import
descriptor.@AAFProperty(uuid1=67240706, uuid2=1536, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="QltyFileSecurityWave", typeName="UInt32", optional=true, uniqueIdentifier=false, pid=15638) public int getFileSecurityWave() throws PropertyNotPresentException
BWFImportDescriptor
Returns the file security code of the BWF wave data of this BWF import descriptor. This property is optional.
getFileSecurityWave
in interface BWFImportDescriptor
PropertyNotPresentException
- The optional file security wave property
is not present in this BWF import descriptor.public void setFileSecurityWave(Integer fileSecurityWave)
BWFImportDescriptor
Sets the file security code of the BWF wave data of this BWF import
descriptor. This property is optional and can be omitted by setting its value to
null
.
setFileSecurityWave
in interface BWFImportDescriptor
fileSecurityWave
- File security code of the BWF wave data of this BWF import
descriptor.@AAFProperty(uuid1=67241218, uuid2=1793, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="QltyOperatorComment", typeName="String", optional=true, uniqueIdentifier=false, pid=15655) public String getOperatorComment() throws PropertyNotPresentException
BWFImportDescriptor
Returns the operator comment property of this BWF import descriptor, which is taken from the comment of operator property of the associated <qlty> chunk. This property is optional.
getOperatorComment
in interface BWFImportDescriptor
PropertyNotPresentException
- The optional operator comment property is not
present in this BWF import descriptor.public void setOperatorComment(String operatorComment)
BWFImportDescriptor
Sets the operator comment property of this BWF import descriptor, which is taken
from the comment of operator property of the associated <qlty> chunk. This
property is optional and setting it to null
will omit the property.
setOperatorComment
in interface BWFImportDescriptor
operatorComment
- Operator comment of this BWF import descriptor.@AAFProperty(uuid1=67241218, uuid2=1025, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="QltyQualityEvent", typeName="String", optional=true, uniqueIdentifier=false, pid=15652) public String getQualityEvent() throws PropertyNotPresentException
BWFImportDescriptor
Returns the quality event data property of this BWF import descriptor, which is taken from the quality event data property of the associated <qlty> chunk. This property is optional.
getQualityEvent
in interface BWFImportDescriptor
PropertyNotPresentException
- The optional quality event property is not present
in this BWF import descriptor.public void setQualityEvent(String qualityEvent)
BWFImportDescriptor
Sets the quality event data property of this BWF import descriptor, which is taken
from the quality event data property of the associated <qlty> chunk. This
property is optional and setting it to null
will omit the property.
setQualityEvent
in interface BWFImportDescriptor
qualityEvent
- Quality event data property of this BWF import descriptor.@AAFProperty(uuid1=67241218, uuid2=1537, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="QltyQualityParameter", typeName="String", optional=true, uniqueIdentifier=false, pid=15654) public String getQualityParameter() throws PropertyNotPresentException
BWFImportDescriptor
Returns the quality parameter property of this BWF import descriptor, which is taken from the quality parameter data property of the associated <qlty> chunk. This property is optional.
getQualityParameter
in interface BWFImportDescriptor
PropertyNotPresentException
- The optional quality parameter property is not present
in this BWF import descriptor.public void setQualityParameter(String qualityParameter)
BWFImportDescriptor
Sets the quality parameter property of this BWF import descriptor, which is taken
from the quality parameter data property of the associated <qlty> chunk. This
property is optional and setting it to null
will omit the property.
setQualityParameter
in interface BWFImportDescriptor
qualityParameter
- Quality parameter property of this BWF import descriptor.@AAFProperty(uuid1=67241218, uuid2=769, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="QltyStartOfModulation", typeName="String", optional=true, uniqueIdentifier=false, pid=15651) public String getStartOfModulation() throws PropertyNotPresentException
BWFImportDescriptor
Returns the start of modulation data of this BWF import descriptor, which is taken from the start modulation data poperty of the associated <qlty> chunk. This property is optional.
getStartOfModulation
in interface BWFImportDescriptor
PropertyNotPresentException
- The optional start of modulation property is not
present in this BWF import descriptor.public void setStartOfModulation(String startOfModulation)
BWFImportDescriptor
Sets the start of modulation data of this BWF import descriptor, which is taken
from the start modulation data property of the associated <qlty> chunk. This
property is optional and setting it to null
will omit the property.
setStartOfModulation
in interface BWFImportDescriptor
startOfModulation
- Start of modulation data of this BWF import descriptor.@AAFProperty(uuid1=100729092, uuid2=1551, uuid3=0, uuid4={6,14,43,52,1,1,1,8}, definedName="UnknownBWFChunks", typeName="StrongReferenceVector of RIFFChunk", optional=true, uniqueIdentifier=false, pid=15667) public List<RIFFChunk> getUnknownBWFChunks()
BWFImportDescriptor
Returns a copy of the list of unknown BWF chunks of this BWF import descriptor.
getUnknownBWFChunks
in interface BWFImportDescriptor
public void appendUnknownBWFChunk(RIFFChunk chunk) throws NullPointerException, ObjectAlreadyAttachedException
BWFImportDescriptor
Append a RIFFChunk to end of the list of unknown BWF chunks of this BWF import descriptor.
appendUnknownBWFChunk
in interface BWFImportDescriptor
chunk
- Chunk to append to the current list.
NullPointerException
- The chunk argument is null
.
ObjectAlreadyAttachedException
- The chunk is already contained within
the list of unknown BWF chunks of this BWF import descriptor.public int countUnknownBWFChunks()
BWFImportDescriptor
Returns the total number of unknown BWF chunks attached to this BWF import descriptor.
countUnknownBWFChunks
in interface BWFImportDescriptor
public RIFFChunk getUnknownBWFChunkAt(int index) throws IndexOutOfBoundsException
BWFImportDescriptor
Returns the RIFFChunk from the list of unknown BWF chunks of this BWF import descriptor at the given index.
getUnknownBWFChunkAt
in interface BWFImportDescriptor
index
- Index of the chunk to retrieve.
IndexOutOfBoundsException
- The given index is outside the acceptable
range for the current list of unknown BWF chunks of this BWF import descriptor.public void insertUnknownBWFChunkAt(int index, RIFFChunk chunk) throws NullPointerException, IndexOutOfBoundsException, ObjectAlreadyAttachedException
BWFImportDescriptor
Insert a RIFFChunk into the list of unknown BWF chunks of this BWF import descriptor at the given index. Chunks already existing at the given and higher indices will be moved to the next higher index to accommodate the new chunk.
insertUnknownBWFChunkAt
in interface BWFImportDescriptor
index
- Index through the list of unknown BWF chunks at which to insert
the additional chunk.chunk
- Chunk to insert at the given index.
NullPointerException
- The chunk argument is null
.
IndexOutOfBoundsException
- The given index is outside the acceptable
range for the current list of unknown BWF chunks of this BWF import descriptor.
ObjectAlreadyAttachedException
- The given chunk is already contained in
the list of unknown BWF chunks of this BWF import descriptor.public void prependUnknownBWFChunk(RIFFChunk chunk) throws NullPointerException, ObjectAlreadyAttachedException
BWFImportDescriptor
Prepend a RIFFChunk to the beginning of the list of unknown BWF chunks of this BWF descriptor.
prependUnknownBWFChunk
in interface BWFImportDescriptor
chunk
- Chunk to prepend to the current list.
NullPointerException
- The chunk argument is null
.
ObjectAlreadyAttachedException
- The The chunk is already contained within
the list of unknown BWF chunks of this BWF import descriptor.public void removeUnknownBWFChunkAt(int index) throws IndexOutOfBoundsException
BWFImportDescriptor
Removes the RIFFChunk at the given index through the list of unknown BWF chunks of this BWF descriptor. Chunks already existing at indices higher than the given index will be moved to the next lower index to fill the gap left by the removal.
removeUnknownBWFChunkAt
in interface BWFImportDescriptor
index
- Index of the chunk to remove.
IndexOutOfBoundsException
- The given index is outside the acceptable
range for the current list of unknown BWF chunks of this BWF import descriptor.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 ImportDescriptor
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 EssenceDescriptor
Object.hashCode()
public BWFImportDescriptor 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 ImportDescriptor
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 ImportDescriptor
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 |