Package io.opentimeline.opentimelineio
Class Transition
java.lang.Object
io.opentimeline.OTIOObject
io.opentimeline.opentimelineio.SerializableObject
io.opentimeline.opentimelineio.SerializableObjectWithMetadata
io.opentimeline.opentimelineio.Composable
io.opentimeline.opentimelineio.Transition
- All Implemented Interfaces:
java.lang.AutoCloseable
public class Transition extends Composable
Represents a transition between two items.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Transition.TransitionBuilder
static class
Transition.Type
Encoding types of transitions.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
-
Constructor Summary
Constructors Modifier Constructor Description protected
Transition()
Transition(Transition.TransitionBuilder builder)
Transition(java.lang.String name, java.lang.String transitionType, RationalTime inOffset, RationalTime outOffset, AnyDictionary metadata)
-
Method Summary
Modifier and Type Method Description RationalTime
getDuration(ErrorStatus errorStatus)
RationalTime
getInOffset()
Get amount of the previous clip this transition overlaps, exclusive.RationalTime
getOutOffset()
Get amount of the next clip this transition overlaps, exclusive.TimeRange
getRangeInParent(ErrorStatus errorStatus)
Find and return the range of this item in the parent.java.lang.String
getTransitionType()
TimeRange
getTrimmedRangeInParent(ErrorStatus errorStatus)
Find and return the trimmed range of this item in the parent.boolean
isOverlapping()
void
setInOffset(RationalTime inOffset)
Set amount of the previous clip this transition overlaps, exclusive.void
setOutOffset(RationalTime outOffset)
Set amount of the next clip this transition overlaps, exclusive.void
setTransitionType(java.lang.String transitionType)
java.lang.String
toString()
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
-
Constructor Details
-
Transition
protected Transition() -
Transition
public Transition(java.lang.String name, java.lang.String transitionType, RationalTime inOffset, RationalTime outOffset, AnyDictionary metadata) -
Transition
-
-
Method Details
-
isOverlapping
public boolean isOverlapping()- Overrides:
isOverlapping
in classComposable
- Returns:
- Return whether an Item is overlapping. By default false.
-
getTransitionType
public java.lang.String getTransitionType() -
setTransitionType
public void setTransitionType(java.lang.String transitionType) -
getInOffset
Get amount of the previous clip this transition overlaps, exclusive.- Returns:
- amount of the previous clip this transition overlaps, exclusive.
-
setInOffset
Set amount of the previous clip this transition overlaps, exclusive.- Parameters:
inOffset
- amount of the previous clip this transition overlaps, exclusive.
-
getOutOffset
Get amount of the next clip this transition overlaps, exclusive.- Returns:
- amount of the next clip this transition overlaps, exclusive.
-
setOutOffset
Set amount of the next clip this transition overlaps, exclusive.- Parameters:
outOffset
- amount of the next clip this transition overlaps, exclusive.
-
getDuration
- Overrides:
getDuration
in classComposable
- Parameters:
errorStatus
- errorStatus to report in case this is not implemented in a sub-class.- Returns:
- the duration of the Composable object.
-
getRangeInParent
Find and return the range of this item in the parent.- Parameters:
errorStatus
- errorStatus to report error while fetching range- Returns:
- the range of this item in the parent
-
getTrimmedRangeInParent
Find and return the trimmed range of this item in the parent.- Parameters:
errorStatus
- errorStatus to report error while fetching trimmed range- Returns:
- the trimmed range of this item in the parent.
-
toString
public java.lang.String toString()- Overrides:
toString
in classComposable
-