@MediaClass(uuid1=218169601, uuid2=257, uuid3=6400, uuid4={6,14,43,52,2,6,1,1}, definedName="ControlPoint", description="The ControlPoint class specifies a value and a time point and is used to specify an effect control value.", symbol="ControlPoint") public class ControlPointImpl extends InterchangeObjectImpl implements ControlPoint, Serializable, XMLSerializable, Cloneable
Implements a value and a time point (position) that is used to specify an effect control value. Control points must be added to a varying value that is then added to the operation group describing the effect.
ObjectClassPropertyID| Constructor and Description |
|---|
ControlPointImpl() |
ControlPointImpl(TypeDefinition varyingValueType,
Rational controlPointTime,
PropertyValue controlPointValue) |
ControlPointImpl(VaryingValue varyingValue,
Rational controlPointTime,
PropertyValue controlPointValue)
Creates and initializes a new control point object, which specifies a value and a
time point and is used to specify an effect control value.
|
| Modifier and Type | Method and Description |
|---|---|
ControlPoint |
clone()
Create a cloned copy of this interchange object.
|
String |
getComment()
Include a comment when serializing a value to XML.
|
String |
getControlPointTimeString() |
PropertyValue |
getControlPointValue()
Returns the control point value at the control point's position (time), which
contains the type and value as a property value.
|
byte[] |
getControlPointValuePersist() |
EditHintType |
getEditHint()
Returns the edit hint of the control point, which describes how to alter the
position (time) of the operation group is made longer
or shorter.
|
Rational |
getTime()
Returns the time property of this control point, which specifies the time within the
varying value segment for which the value is defined.
|
TypeDefinition |
getTypeDefinition()
Returns the type definition of the value of this control point.
|
static Rational |
initializeControlPointTime() |
static PropertyValue |
initializeControlPointValue() |
void |
setControlPointTime(Rational controlPointTime)
Sets the position of the control point within an operation group, which specifies the time within the
varying value segment for which the value is defined.
|
void |
setControlPointTimeString(String controlPointTime) |
void |
setControlPointValue(PropertyValue controlPointValue)
Set the data value describing this control point at the control point's position (time).
|
void |
setControlPointValuePersist(byte[] indirectBytes) |
void |
setEditHint(EditHintType editHint)
Sets the control point edit hint value, which describes how to alter the
position (time) if the operation group is made longer or shorter.
|
addApplicationPlugin, appendXMLChildren, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getLinkedGenerationIDString, getObjectClass, getPersistentID, getPersistentIndex, hashCode, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setLinkedGenerationIDString, setObjectClass, setPersistentID, setPersistentIndex, toStringaddApplicationPlugin, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getObjectClass, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setObjectClass, toStringgetPersistentID, setPersistentIndexappendXMLChildrenpublic ControlPointImpl()
public ControlPointImpl(VaryingValue varyingValue, Rational controlPointTime, PropertyValue controlPointValue) throws NullPointerException, RationalRangeException
Creates and initializes a new control point object, which specifies a value and a time point and is used to specify an effect control value.
varyingValue - A varying value. This determines the type of this control point through the
parameter definition.controlPointTime - Specifies the time within the VaryingValue segment for which the value is defined,
with a value between 0 and 1.controlPointValue - Control point type and value.NullPointerException - One or more of the arguments is null and all values
are required.RationalRangeException - Rational time value is outside the inclusive range 0.0 to 1.0.ClassCastException - Cannot cast the given Java value to the given AAF type definition.public ControlPointImpl(TypeDefinition varyingValueType, Rational controlPointTime, PropertyValue controlPointValue)
@MediaProperty(uuid1=87033096, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="EditHint", typeName="EditHintType", optional=true, uniqueIdentifier=false, pid=6660, symbol="EditHint") public EditHintType getEditHint() throws PropertyNotPresentException
ControlPointReturns the edit hint of the control point, which describes how to alter the position (time) of the operation group is made longer or shorter. This is an optional property.
getEditHint in interface ControlPointPropertyNotPresentException - The optional edit hint property is not present
for this control point.@MediaPropertySetter(value="EditHint") public void setEditHint(EditHintType editHint)
ControlPointSets the control point edit hint value, which describes how to alter the
position (time) if the operation group is made longer or shorter.
Set this optional property to null to omit it.
setEditHint in interface ControlPointeditHint - Specifies a hint to be used if the effect starting time or
length is changed during editing.@MediaProperty(uuid1=117571843, uuid2=4098, uuid3=256, uuid4={6,14,43,52,1,1,1,2}, definedName="ControlPointTime", aliases="Time", typeName="Rational", optional=false, uniqueIdentifier=false, pid=6659, symbol="ControlPointTime") public Rational getTime()
ControlPointReturns the time property of this control point, which specifies the time within the varying value segment for which the value is defined. The value of the time property should be between&nbps;0 and 1 inclusive.
getTime in interface ControlPoint@MediaPropertySetter(value="ControlPointTime") public void setControlPointTime(Rational controlPointTime) throws RationalRangeException, NullPointerException
ControlPointSets the position of the control point within an operation group, which specifies the time within the varying value segment for which the value is defined. The value is expressed as a rational value between from 0 to 1.
setControlPointTime in interface ControlPointcontrolPointTime - Control point time.RationalRangeException - The rational value is outside the range 0 to 1.NullPointerException - The given time value is null.public static final Rational initializeControlPointTime()
public TypeDefinition getTypeDefinition()
ControlPointReturns the type definition of the value of this control point.
getTypeDefinition in interface ControlPointTypeDefinitionIndirect@MediaProperty(uuid1=87033101, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="ControlPointValue", aliases="Value", typeName="Indirect", optional=false, uniqueIdentifier=false, pid=6658, symbol="ControlPointValue") public PropertyValue getControlPointValue()
ControlPointReturns the control point value at the control point's position (time), which contains the type and value as a property value.
getControlPointValue in interface ControlPointTypeDefinitionIndirect,
ControlPoint.getTypeDefinition(),
PropertyValue.getType(),
PropertyValue.getValue()@MediaPropertySetter(value="ControlPointValue") public void setControlPointValue(PropertyValue controlPointValue) throws NullPointerException, ClassCastException
ControlPointSet the data value describing this control point at the control point's position (time). The value must be a property value containing the type and current value for the control point.
To create a control value of a specific type, use the
createValue() method of a
type definition. To access a type definition, use
the ControlPoint.getTypeDefinition() method as follows:
controlPoint.setControlPointValue(
controlPoint.getTypeDefinition().createValue(42));
Alternatively, you can retrieve the value of any other property using its property definition. To retrieve the property value of a property called foo from an instance called bar:
ClassDefinition barClassDef =
ClassDefinitionWarehouse.forClass(bar.getClass());
PropertyDefinition fooDefinition =
barClassDef.lookupPropertyDefinition("foo");
PropertyValue fooValue =
fooDefinition.getPropertyValue(bar);
setControlPointValue in interface ControlPointcontrolPointValue - The value of this control point at its position (time).NullPointerException - The given control point value is null.ClassCastException - Cannot cast the given value to the defined type
for this control point.TypeDefinition.createValue(Object),
PropertyValue.getValue(),
ConstantValue.setValue(PropertyValue)public static final PropertyValue initializeControlPointValue()
public ControlPoint clone()
InterchangeObjectCreate a cloned copy of this interchange object.
clone in interface MediaEntityclone in interface ControlPointclone in interface InterchangeObjectclone in class InterchangeObjectImplpublic String getComment()
XMLSerializableInclude a comment when serializing a value to XML. The comment will be inserted as the first child node of the element representing the class.
getComment in interface XMLSerializablegetComment in class InterchangeObjectImplpublic String getControlPointTimeString()
public void setControlPointTimeString(String controlPointTime)
public byte[] getControlPointValuePersist()
throws NotSerializableException,
NullPointerException,
IllegalPropertyValueException,
InsufficientSpaceException
public void setControlPointValuePersist(byte[] indirectBytes)
(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.