Package io.opentimeline.opentimelineio

Class Stack

java.lang.Object

io.opentimeline.OTIOObject

io.opentimeline.opentimelineio.SerializableObject

io.opentimeline.opentimelineio.SerializableObjectWithMetadata

io.opentimeline.opentimelineio.Composable

io.opentimeline.opentimelineio.Item

io.opentimeline.opentimelineio.Composition

io.opentimeline.opentimelineio.Stack

All Implemented Interfaces:

java.lang.AutoCloseable

public class Stack
extends Composition

A stack represents a series of composables. Composables that are arranged such that their start times are at the same point. Most commonly, this would be a series of Track objects that then contain clips. The 0 time of those tracks would coincide with the 0-time of the stack. Stacks are in compositing order, with later children obscuring earlier children. In other words, from bottom to top. If a stack has three children, [A, B, C], C is above B which is above A. A stack is the length of its longest child. If a child ends before the other children, then an earlier index child would be visible before it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Stack.StackBuilder

Nested classes/interfaces inherited from class io.opentimeline.opentimelineio.Composition

Composition.CompositionBuilder

Nested classes/interfaces inherited from class io.opentimeline.opentimelineio.Item

Item.ItemBuilder

Nested classes/interfaces inherited from class io.opentimeline.opentimelineio.Composable

Composable.ComposableBuilder

Nested classes/interfaces inherited from class io.opentimeline.opentimelineio.SerializableObjectWithMetadata

SerializableObjectWithMetadata.SerializableObjectWithMetadataBuilder

Field Summary

Fields inherited from class io.opentimeline.OTIOObject

nativeManager

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Stack()
	Stack(Stack.StackBuilder builder)
	Stack(java.lang.String name, TimeRange sourceRange, AnyDictionary metadata, java.util.List<Effect> effects, java.util.List<Marker> markers)

Method Summary

Modifier and Type	Method	Description
java.util.stream.Stream<Clip>	eachClip(TimeRange searchRange, ErrorStatus errorStatus)
java.util.stream.Stream<Clip>	eachClip(ErrorStatus errorStatus)
TimeRange	getAvailableRange(ErrorStatus errorStatus)	Implemented by child classes, available range of media.
java.util.HashMap<Composable,TimeRange>	getRangeOfAllChildren(ErrorStatus errorStatus)	Return a HashMap mapping children to their range in this object.
TimeRange	rangeOfChildAtIndex(int index, ErrorStatus errorStatus)
TimeRange	trimmedRangeOfChildAtIndex(int index, ErrorStatus errorStatus)

Methods inherited from class io.opentimeline.opentimelineio.Composition

appendChild, clearChildren, eachChild, eachChild, eachChild, getChildAtTime, getChildAtTime, getChildren, getCompositionKind, getHandlesOfChild, getRangeOfChild, getRangeOfChildAtIndex, getTrimmedRangeOfChild, getTrimmedRangeOfChildAtIndex, hasChild, insertChild, isParentOf, removeChild, setChild, setChildren, toString, trimChildRange

Methods inherited from class io.opentimeline.opentimelineio.Item

getDuration, getEffects, getMarkers, getRangeInParent, getSourceRange, getTransformedTime, getTransformedTimeRange, getTrimmedRange, getTrimmedRangeInParent, getVisibleRange, isOverlapping, isVisible, setSourceRange

Methods inherited from class io.opentimeline.opentimelineio.Composable

parent

Methods inherited from class io.opentimeline.opentimelineio.SerializableObjectWithMetadata

getMetadata, getName, setMetadata, setName

Methods inherited from class io.opentimeline.opentimelineio.SerializableObject

clone, currentRefCount, dynamicFields, equals, fromJSONFile, fromJSONString, isEquivalentTo, isUnknownSchema, schemaName, schemaVersion, toJSONFile, toJSONFile, toJSONString, toJSONString

Methods inherited from class io.opentimeline.OTIOObject

close, getNativeManager, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Stack

protected Stack()

Stack

public Stack(java.lang.String name, TimeRange sourceRange, AnyDictionary metadata, java.util.List<Effect> effects, java.util.List<Marker> markers)

Stack

public Stack(Stack.StackBuilder builder)

Method Details

rangeOfChildAtIndex

public TimeRange rangeOfChildAtIndex(int index, ErrorStatus errorStatus)

trimmedRangeOfChildAtIndex

public TimeRange trimmedRangeOfChildAtIndex(int index, ErrorStatus errorStatus)

getAvailableRange

public TimeRange getAvailableRange(ErrorStatus errorStatus)

Description copied from class: Item

Implemented by child classes, available range of media.

Overrides:

getAvailableRange in class Item

Parameters:

errorStatus - errorStatus to report in case this is not implemented in a sub-class.

Returns:

available range of media

getRangeOfAllChildren

public java.util.HashMap<Composable,TimeRange> getRangeOfAllChildren(ErrorStatus errorStatus)

Description copied from class: Composition

Return a HashMap mapping children to their range in this object.

Overrides:

getRangeOfAllChildren in class Composition

Parameters:

errorStatus - errorStatus to report any error while fetching ranges

Returns:

a HashMap mapping children to their range in this object

eachClip

public java.util.stream.Stream<Clip> eachClip(TimeRange searchRange, ErrorStatus errorStatus)

eachClip

public java.util.stream.Stream<Clip> eachClip(ErrorStatus errorStatus)