tv.amwa.maj.iface
Interface SearchSource

All Known Subinterfaces:

SourceMob

All Known Implementing Classes:

SourceMob

public interface SearchSource

Specifies a search for source information of a slot in a master mob or source mob.

Author:

Richard Cartwright

Method Summary

List<FindSourceInformation>

searchSource(int slotId, long offset, MobKind mobKind, CriteriaType mediaCriteria, OperationChoice operationChoice) Returns the source information for a slot in a master mob or source mob.

Method Detail

searchSource

List<FindSourceInformation> searchSource(@SlotID
                                         int slotId,
                                         @PositionType
                                         long offset,
                                         MobKind mobKind,
                                         CriteriaType mediaCriteria,
                                         OperationChoice operationChoice)
                                         throws NullPointerException,
                                                InvalidMobTypeException,
                                                TraversalNotPossibleException

Returns the source information for a slot in a master mob or source mob. The method follows the source clip references in the specified slot until it encounters the kind of mob specified in the mob kind parameter.

This function cannot be used on a composition mob and is not intended to be called iteratively.

Parameters:

slotId - Slot to find source information for.

offset - Offset into the slot.

mobKind - Kind of mob to search for.

mediaCriteria - Media criteria to match in the search.

operationChoice - Operation choice.

Returns:

List of source information matching the given search criteria.

Throws:

NullPointerException - One or more of the arguments is null.

InvalidMobTypeException - The given mob type is not valid.

TraversalNotPossibleException - A mob of the given kind cannot be found.