|
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.argument.FindSourceInformation
public class FindSourceInformation
Implementation of a class that contains the result returned by the
SearchSource.searchSource(int, long, tv.amwa.maj.enumeration.MobKind, tv.amwa.maj.enumeration.CriteriaType, tv.amwa.maj.enumeration.OperationChoice)
method, containing source information about particular mob slots.
The information available in this object will depend on the kind
of search carried out. All methods in this interface that return a non-primitive
type value could return a null
pointer to indicate that a value
is not present.
Constructor Summary | |
---|---|
FindSourceInformation(Mob mob,
Integer slotId,
Long position,
Rational editRate,
Long length,
Component component)
|
Method Summary | |
---|---|
Rational |
getEditRate()
Returns the edit rate for the search result. |
long |
getLength()
Returns the length of this component. |
Mob |
getMob()
Returns the mob search result. |
SourceReferenceValue |
getSourceReference()
Returns the source reference search result. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FindSourceInformation(Mob mob, Integer slotId, Long position, Rational editRate, Long length, Component component)
Method Detail |
---|
public Rational getEditRate()
FindSourceInformation
Returns the edit rate for the search result.
getEditRate
in interface FindSourceInformation
null
if this value is not available.public long getLength() throws BadPropertyException
FindSourceInformation
Returns the length of this component. The duration is specified in edit units of the result.
This method deals with an optional property, which will only be present for time-varying media and some events.
getLength
in interface FindSourceInformation
BadPropertyException
- The optional length property is not
present for this object.public Mob getMob()
FindSourceInformation
Returns the mob search result.
getMob
in interface FindSourceInformation
null
if no valid mob is referenced.public SourceReferenceValue getSourceReference()
FindSourceInformation
Returns the source reference search result.
getSourceReference
in interface FindSourceInformation
null
if the value is not
available.
|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |