|
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.Component tv.amwa.maj.entity.Segment tv.amwa.maj.entity.Event tv.amwa.maj.entity.GPITrigger
@AAFClass(uuid1=218169601, uuid2=257, uuid3=1792, uuid4={6,14,43,52,2,6,1,1}, definedName="GPITrigger", description="The GPITrigger class specifies a trigger action that should be taken when the GPITrigger is reached.") public class GPITrigger
Implements a trigger action that should be taken when the GPI trigger is reached.
THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.
Nested Class Summary | |
---|---|
static class |
GPITrigger.XMLHandler
|
Nested classes/interfaces inherited from class tv.amwa.maj.entity.Event |
---|
Event.EventXMLHandler |
Nested classes/interfaces inherited from class tv.amwa.maj.entity.Segment |
---|
Segment.SegmentXMLHandler |
Nested classes/interfaces inherited from class tv.amwa.maj.entity.Component |
---|
Component.ComponentAttributesXMLHandler, Component.ComponentUserCommentsXMLHandler, Component.ComponentXMLHandler, Component.KLVDataXMLHandler |
Nested classes/interfaces inherited from class tv.amwa.maj.entity.InterchangeObject |
---|
InterchangeObject.InterchangeObjectXMLHandler |
Field Summary | |
---|---|
static String |
GPITRIGGER_TAG
|
Fields inherited from class tv.amwa.maj.entity.Event |
---|
EVENT_ITEM |
Fields inherited from class tv.amwa.maj.entity.Component |
---|
COMPONENT_ITEM |
Constructor Summary | |
---|---|
GPITrigger(DataDefinition dataDefinition,
boolean activeState)
Creates and initializes a new GPI trigger event, which specifies a trigger action that should be taken when the GPITrigger is reached. |
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. |
GPITrigger |
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 |
getActiveState()
Returns the active state of this GPI trigger, which is true if the event
is "on". |
int |
hashCode()
Returns a hash code value for this interchange object. |
void |
setActiveState(boolean activeState)
Set to true to turn the trigger "on" or
false to turn the trigger off. |
void |
setPropertiesFromInterface(GPITrigger castFrom)
|
Methods inherited from class tv.amwa.maj.entity.Event |
---|
getComment, getPosition, getPositionPresent, setComment, setPosition, setPositionPresent, setPropertiesFromInterface |
Methods inherited from class tv.amwa.maj.entity.Segment |
---|
segmentOffsetToTC, segmentTCToOffset, setPropertiesFromInterface |
Methods inherited from class tv.amwa.maj.entity.Component |
---|
appendAttribute, appendAttribute, appendComment, appendComment, appendKLVData, countAttributes, countComments, countKLVData, getAttributes, getComments, getDataDefinition, getKLVData, getLength, getLengthPresent, removeAttribute, removeComment, removeKLVData, setDataDefinition, setLength, setLengthPresent, 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.Event |
---|
getComment, getPosition, setComment, setPosition |
Methods inherited from interface tv.amwa.maj.iface.Segment |
---|
segmentOffsetToTC, segmentTCToOffset |
Methods inherited from interface tv.amwa.maj.iface.Component |
---|
appendAttribute, appendAttribute, appendComment, appendComment, appendKLVData, countAttributes, countComments, countKLVData, getAttributes, getComments, getDataDefinition, getKLVData, getLength, removeAttribute, removeComment, removeKLVData, setDataDefinition, setLength |
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 GPITRIGGER_TAG
Constructor Detail |
---|
public GPITrigger(DataDefinition dataDefinition, @Bool boolean activeState) throws NullPointerException
Creates and initializes a new GPI trigger event, which specifies a
trigger action that should be taken when the GPITrigger is reached. If this event
is located in an event mob slot
, its position must also be
set using Event.setPosition(long)
.
dataDefinition
- Kind of data represented by this component.activeState
- Is the event turned on?
NullPointerException
- Data definition argument is null
.Method Detail |
---|
public final void setPropertiesFromInterface(GPITrigger castFrom)
InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)
@AAFProperty(uuid1=87032833, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="ActiveState", typeName="Boolean", optional=false, uniqueIdentifier=false, pid=2049) public boolean getActiveState()
GPITrigger
Returns the active state of this GPI trigger, which is true
if the event
is "on".
getActiveState
in interface GPITrigger
public void setActiveState(boolean activeState)
GPITrigger
Set to true
to turn the trigger "on" or
false
to turn the trigger off.
setActiveState
in interface GPITrigger
activeState
- Active state to set for the trigger.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 Event
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 Event
Object.hashCode()
public GPITrigger 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 Segment
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 Event
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 |