
Media Authoring with Java API 

PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 
public interface VaryingValue
Specifies a changing data value for an effect control value.
makeVaryingValue()
,
OperationGroup.addParameter(Parameter)
Method Summary  

void 
addControlPoint(ControlPoint controlPoint)
Adds a control point to the sequence of control points of this varying value, each of which specifies a value and a time point at which the value is defined. 
int 
countControlPoints()
Returns the number of control points in the sequence of control points of this varying value, each of which specifies a value and a time point at which the value is defined. 
ControlPoint 
getControlPointAt(int index)
Retrieves the input control point at the given index in the sequence of control points of this varying value, each of which specifies a value and a time point at which the value is defined. 
List<? extends ControlPoint> 
getControlPoints()
Returns the sequence of control points of this varying value, each of which specifies a value and a time point at which the value is defined. 
Object 
getInterpolatedValue(Rational inputValue)
Returns the interpolated value of the varying value at a given time position, which should be a value between 0 and 1 inclusive. 
InterpolationDefinition 
getInterpolationDefinition()
Returns the interpolation property of this varying value, which specifies the kind of interpolation to be used to find the value between control points. 
void 
removeControlPointAt(int index)
This function removes the input control point at the given index in the sequence of control points of this varying value, each of which specifies a value and a time point at which the value is defined. 
Methods inherited from interface tv.amwa.maj.iface.Parameter 

getParameterDefinition, getTypeDefinition 
Methods inherited from interface tv.amwa.maj.iface.InterchangeObject 

countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue 
Method Detail 

void addControlPoint(ControlPoint controlPoint) throws NullPointerException
Adds a control point to the sequence of control points of this varying value, each of which specifies a value and a time point at which the value is defined. The point will be sorted by time order, not the order that the points were added in.
controlPoint
 Control point to add to the sequence of control
points.
NullPointerException
 The given control point is null
.List<? extends ControlPoint> getControlPoints()
Returns the sequence of control points of this varying value, each of which specifies a value and a time point at which the value is defined.
@UInt32 int countControlPoints()
Returns the number of control points in the sequence of control points of this varying value, each of which specifies a value and a time point at which the value is defined.
ControlPoint getControlPointAt(@UInt32 int index) throws IndexOutOfBoundsException
Retrieves the input control point at the given index in the sequence of control points of this varying value, each of which specifies a value and a time point at which the value is defined.
index
 0based index of the control point to retrieve.
IndexOutOfBoundsException
 The given index is outside the
acceptable range for the current sequence of control points of this
varying value.void removeControlPointAt(@UInt32 int index) throws IndexOutOfBoundsException
This function removes the input control point at the given index in the sequence of control points of this varying value, each of which specifies a value and a time point at which the value is defined. Control points already existing at indices higher than the given index will be moved to the next lower index to accommodate.
index
 Index of control point to remove from the sequence.
IndexOutOfBoundsException
 The index is outside acceptable
range for the current sequence of control points of this varying
value.InterpolationDefinition getInterpolationDefinition()
Returns the interpolation property of this varying value, which specifies the kind of interpolation to be used to find the value between control points.
getInterpolatedValue(Rational)
,
InterpolationConstant
Object getInterpolatedValue(Rational inputValue) throws NullPointerException
Returns the interpolated value of the varying value at a given time position, which should be a value between 0 and 1 inclusive. The data type of the value contained in the value returned will be the same as the data type of the parameter this varying value provides a value for, which is the same as the data type of all of the control points.
inputValue
 Time position along the operation group to find the
interpolated value for.
NullPointerException
 The given input value is null
.getInterpolationDefinition()
,
InterpolationConstant
,
Parameter.getTypeDefinition()
,
ControlPoint.getTypeDefinition()
,
TypeDefinition.createValue(Object)
,
PropertyValue.getValue()

Media Authoring with Java API 

PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 