|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OperationGroup
Specifies a container with an ordered set of segments and an operation that is performed on these segments.
In an operation group that is itself in a transition, the input segments are provided by the transition and so the optional input segments property shall be omitted.
makeOperationGroup()
,
OperationDefinition
,
CompositionMob
Method Summary | |
---|---|
void |
addParameter(Parameter parameter)
Adds a new parameter to the collection of parameters of this operation group, which specify control values for the operation. |
void |
appendInputSegment(Segment segment)
Appends an input segment to the list of input segments of this operation group. |
int |
countParameters()
Returns the number of parameters in the collection of parameters of this operation group, which specify control values for the operation. |
int |
countSourceSegments()
Returns the number of media sources for this operation group, which is the size of the list of input segments for this operation. |
int |
getBypassOverride()
Returns the optional bypass override index of this operation group, which specifies the array index (1-based) of the input segment which is the primary input. |
Segment |
getInputSegmentAt(int index)
Given an index, returns the corresponding input segment from this list of input segments of this operation group. |
OperationDefinition |
getOperationDefinition()
Returns the operation definition for this operation group, which identifies the kind of operation. |
List<? extends Parameter> |
getParameters()
Returns the list of parameters of this operation group, which specify control values for the operation. |
SourceReferenceSegment |
getRendering()
Returns the segment that represents the optional rendering of this operation group, which specifies a rendered or precomputed version of the operation. |
void |
insertInputSegmentAt(int index,
Segment segment)
Inserts an input segment into the list of input segments of this operation group at the given index. |
boolean |
isTimeWarp()
Returns true if an operation group represents a
time warping effect. |
boolean |
isValidTransitionOperation()
Returns true if this operation group can be used in a
transition; otherwise returns false . |
Parameter |
lookupParameter(AUID argumentId)
Given an argument id, returns the corresponding parameter slot from the collection of parameters of this operation group. |
void |
prependInputSegment(Segment segment)
Prepends an input segment to the list of input segments of this operation group. |
void |
removeInputSegmentAt(int index)
Removes the segment at the given index from the list of input segments of the operation group. |
void |
setBypassOverride(Integer bypassOverride)
Sets the optional bypass override property on the given operation group object, which specifies the array index (1-based) of the input segment which is the primary input. |
void |
setOperationDefinition(OperationDefinition operationDefinition)
Sets the operation definition for the operation group, which identifies the kind of operation. |
void |
setRendering(SourceReferenceSegment sourceReference)
Returns the segment that represents the optional rendering of this operation group, which specifies a rendered or precomputed version of the operation. |
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 |
Method Detail |
---|
OperationDefinition getOperationDefinition()
Returns the operation definition for this operation group, which identifies the kind of operation.
void setOperationDefinition(OperationDefinition operationDefinition) throws NullPointerException
Sets the operation definition for the operation group, which identifies the kind of operation.
operationDefinition
- Operation definition for the operation group.
NullPointerException
- The given operation definition is null
.SourceReferenceSegment getRendering() throws PropertyNotPresentException
Returns the segment that represents the optional rendering of this operation group, which specifies a rendered or precomputed version of the operation. Working and final renderings are handled by using an essence group as the segment.
PropertyNotPresentException
- The optional rendering property is not present for
this operation group.SourceClip
void setRendering(SourceReferenceSegment sourceReference)
Returns the segment that represents the optional rendering of this operation group, which specifies a rendered or precomputed version of the operation. Multiple renderings may exist if the source clip refers to a master mob that contains an essence group.
sourceReference
- Segment containing a representation of the rendering.SourceClip
@UInt32 int getBypassOverride() throws PropertyNotPresentException
Returns the optional bypass override index of this operation group, which specifies the array index (1-based) of the input segment which is the primary input. This overrides any bypass specified by the operation definition. This is an optional property.
PropertyNotPresentException
- The optional bypass override property
is not set for the operation group.OperationDefinition.getBypass()
,
getOperationDefinition()
void setBypassOverride(@UInt32 Integer bypassOverride) throws IllegalArgumentException
Sets the optional bypass override property on the
given operation group object, which specifies the array index (1-based) of the
input segment which is the primary input. This overrides any bypass specified
by the operation definition. Set this optional
property to null
to omit it.
bypassOverride
- Bypass override property of this operation group.
IllegalArgumentException
- The bypass override property must be a 1-based
index value.@UInt32 int countParameters()
Returns the number of parameters in the collection of parameters of this operation group, which specify control values for the operation. This is an optional property and this method returns 0 when the property is not present.
void addParameter(Parameter parameter) throws DuplicateParameterException, NullPointerException
Adds a new parameter to the collection of parameters of this operation group, which specify control values for the operation. This is an optional property that becomes present when this method is called.
parameter
- Parameter to add to the collection of parameters of this operation group.
DuplicateParameterException
- The given parameter has the same identifier as one
that is already present in this operation group.
NullPointerException
- The given parameter is null
.List<? extends Parameter> getParameters()
Returns the list of parameters of this operation group, which specify control values for the operation. This is an optional property that returns an empty list when not present.
Parameter lookupParameter(@ArgIDType AUID argumentId) throws ParameterNotFoundException, NullPointerException
Given an argument id, returns the corresponding parameter slot from the collection of parameters of this operation group.
argumentId
- Argument id to look up in the collection of parameters of
this operation group.
ParameterNotFoundException
- The given argument identifier does not match that
of a parameter in the set of parameters for this operation group.
NullPointerException
- The given argument identifier is null
.@UInt32 int countSourceSegments()
Returns the number of media sources for this operation group, which is the size of the list of input segments for this operation. The input segments list is an optional property and 0 will be returned if the property is omitted.
void appendInputSegment(Segment segment) throws NullPointerException
Appends an input segment to the list of input segments of this operation group. The list is an optional property that will become present if a segment is appended.
segment
- Segment to append to the list of input segments of this
operation group.
NullPointerException
- The given segment to append is null
.void prependInputSegment(Segment segment) throws NullPointerException
Prepends an input segment to the list of input segments of this operation group. The list is an optional property that will become present if a segment is prepended.
segment
- Input segment to add to the beginning of the list of
input segments.
NullPointerException
- The given segment to prepend is null
.void insertInputSegmentAt(@UInt32 int index, Segment segment) throws IndexOutOfBoundsException, NullPointerException
Inserts an input segment into the list of input segments of this operation group at the given index. The existing segments at the given and higher indices are moved up by one to make room. This is an optional property that will become present if a segment is inserted at index 0.
index
- 0-based index where input segment is to be inserted.segment
- Input segment to insert at the given index.
IndexOutOfBoundsException
- The index value is outside the acceptable
range for the list of input segments.
NullPointerException
- The given segment to insert is null
.Segment getInputSegmentAt(@UInt32 int index) throws IndexOutOfBoundsException
Given an index, returns the corresponding input segment from this
list of input segments of this operation group. This is an optional property and this
method will always throw an IndexOutOfBoundsException
if the property is omitted.
index
- 0-based index into the list of input segments of
this operation group.
IndexOutOfBoundsException
- The index is outside the acceptable
range for the list of input segments.void removeInputSegmentAt(@UInt32 int index) throws IndexOutOfBoundsException
Removes the segment at the given index from the list of
input segments of the operation group. Existing segments at
higher indices are moved down by one to accommodate. This is an
optional property and this method will always throw an IndexOutOfBoundsException
if the property is omitted. Removing the last input segment from
the list will omit this property.
index
- 0-based index into the list of input segments of
this operation group.
IndexOutOfBoundsException
- The index is outside the
acceptable range for the list of input segments.@Bool boolean isValidTransitionOperation()
Returns true
if this operation group can be used in a
transition; otherwise returns false
. An operation group
can be used in a transition if its operation has exactly 2 inputs and
the operation has a level parameter.
Transition.setOperationGroup(OperationGroup)
@Bool boolean isTimeWarp()
Returns true
if an operation group represents a
time warping effect.
getOperationDefinition()
,
OperationDefinition.isTimeWarp()
|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |