java.lang.Object

io.opentimeline.OTIOFactory

public class OTIOFactory
extends java.lang.Object

A singleton factory class that helps in creating all OTIO objects. It is expected that the developers use this Factory to create objects and not the Classes' constructors. After creation of each object the Factory adds a PhantomReference of the object to a ReferenceQueue. Whenever the object is Garbage Collected it will be available for polling in the reference queue and the native memory allocated for the object can be freed.

The factory does some minor cleanup everytime you interact with it, but the developers are expected to setup a mechanism to call the cleanUp() method at regular intervals.

Method Summary

Modifier and Type	Method	Description
`void`	`cleanUp()`
`<T> Any`	`createAny(T value)`
`AnyDictionary`	`createAnyDictionary()`
`AnyVector`	`createAnyVector()`
`Clip`	`createClip(Clip.ClipBuilder builder)`
`Clip`	`createClip(java.lang.String name, MediaReference mediaReference, TimeRange sourceRange, AnyDictionary metadata)`
`Composable`	`createComposable(AnyDictionary metadata)`
`Composable`	`createComposable(Composable.ComposableBuilder builder)`
`Composable`	`createComposable(java.lang.String name)`
`Composable`	`createComposable(java.lang.String name, AnyDictionary metadata)`
`Composition`	`createComposition(Composition.CompositionBuilder builder)`
`Composition`	`createComposition(java.lang.String name, TimeRange sourceRange, AnyDictionary metadata, java.util.List<Effect> effects, java.util.List<Marker> markers)`
`Effect`	`createEffect(Effect.EffectBuilder builder)`
`Effect`	`createEffect(java.lang.String name, java.lang.String effectName, AnyDictionary metadata)`
`ExternalReference`	`createExternalReference(ExternalReference.ExternalReferenceBuilder builder)`
`ExternalReference`	`createExternalReference(java.lang.String targetURL, TimeRange availableRange, AnyDictionary metadata)`
`FreezeFrame`	`createFreezeFrame(FreezeFrame.FreezeFrameBuilder builder)`
`FreezeFrame`	`createFreezeFrame(java.lang.String name, AnyDictionary metadata)`
`Gap`	`createGap(RationalTime duration, java.lang.String name, java.util.List<Effect> effects, java.util.List<Marker> markers, AnyDictionary metadata)`
`Gap`	`createGap(TimeRange sourceRange, java.lang.String name, java.util.List<Effect> effects, java.util.List<Marker> markers, AnyDictionary metadata)`
`Gap`	`createGap(Gap.GapBuilder builder)`
`GeneratorReference`	`createGeneratorReference(GeneratorReference.GeneratorReferenceBuilder builder)`
`GeneratorReference`	`createGeneratorReference(java.lang.String name, java.lang.String generatorKind, TimeRange availableRange, AnyDictionary parameters, AnyDictionary metadata)`
`ImageSequenceReference`	`createImageSequenceReference(ImageSequenceReference.ImageSequenceReferenceBuilder builder)`
`ImageSequenceReference`	`createImageSequenceReference(java.lang.String targetURLBase, java.lang.String namePrefix, java.lang.String nameSuffix, int startFrame, int frameStep, double rate, int frameZeroPadding, ImageSequenceReference.MissingFramePolicy missingFramePolicy, TimeRange availableRange, AnyDictionary metadata)`
`Item`	`createItem(Item.ItemBuilder builder)`
`Item`	`createItem(java.lang.String name, TimeRange sourceRange, AnyDictionary metadata, java.util.List<Effect> effects, java.util.List<Marker> markers)`
`LinearTimeWarp`	`createLinearTimeWarp(LinearTimeWarp.LinearTimeWarpBuilder builder)`
`LinearTimeWarp`	`createLinearTimeWarp(java.lang.String name, java.lang.String effectName, double timeScalar, AnyDictionary metadata)`
`Marker`	`createMarker(Marker.MarkerBuilder builder)`
`Marker`	`createMarker(java.lang.String name, TimeRange markedRange, java.lang.String color, AnyDictionary metadata)`
`MediaReference`	`createMediaReference(MediaReference.MediaReferenceBuilder builder)`
`MissingReference`	`createMediaReference(MissingReference.MissingReferenceBuilder builder)`
`MediaReference`	`createMediaReference(java.lang.String name, TimeRange availableRange, AnyDictionary metadata)`
`MissingReference`	`createMissingReference(java.lang.String name, TimeRange availableRange, AnyDictionary metadata)`
`ErrorStatus`	`createOpentimeIOErrorStatus()`
`ErrorStatus`	`createOpenTimelineIOErrorStatus()`
`SerializableCollection`	`createSerializableCollection(SerializableCollection.SerializableCollectionBuilder builder)`
`SerializableCollection`	`createSerializableCollection(java.lang.String name, java.util.List<SerializableObject> children, AnyDictionary metadata)`
`SerializableObject`	`createSerializableObject()`
`SerializableObjectWithMetadata`	`createSerializableObjectWithMetadata(AnyDictionary metadata)`
`SerializableObjectWithMetadata`	`createSerializableObjectWithMetadata(SerializableObjectWithMetadata.SerializableObjectWithMetadataBuilder builder)`
`SerializableObjectWithMetadata`	`createSerializableObjectWithMetadata(java.lang.String name)`
`SerializableObjectWithMetadata`	`createSerializableObjectWithMetadata(java.lang.String name, AnyDictionary metadata)`
`Stack`	`createStack(Stack.StackBuilder builder)`
`Stack`	`createStack(java.lang.String name, TimeRange sourceRange, AnyDictionary metadata, java.util.List<Effect> effects, java.util.List<Marker> markers)`
`TimeEffect`	`createTimeEffect(TimeEffect.TimeEffectBuilder builder)`
`TimeEffect`	`createTimeEffect(java.lang.String name, java.lang.String effectName, AnyDictionary metadata)`
`Timeline`	`createTimeline(Timeline.TimelineBuilder builder)`
`Timeline`	`createTimeline(java.lang.String name, RationalTime globalStartTime, AnyDictionary metadata)`
`Track`	`createTrack(Track.TrackBuilder builder)`
`Track`	`createTrack(java.lang.String name, TimeRange sourceRange, java.lang.String kind, AnyDictionary metadata)`
`Transition`	`createTransition(Transition.TransitionBuilder builder)`
`Transition`	`createTransition(java.lang.String name, java.lang.String transitionType, RationalTime inOffset, RationalTime outOffset, AnyDictionary metadata)`
`UnknownSchema`	`createUnknownSchema(UnknownSchema.UnknownSchemaBuilder builder)`
`UnknownSchema`	`createUnknownSchema(java.lang.String originalSchemaName, int originalSchemaVersion)`
`AnyDictionary.Iterator`	`getAnyDictionaryIterator(AnyDictionary anyDictionary)`
`AnyVector.Iterator`	`getAnyVectorIterator(AnyVector anyVector)`
`static OTIOFactory`	`getInstance()`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- getInstance
  
  public static OTIOFactory getInstance()
- createAny
  
  public <T> Any createAny(T value)
- createAnyDictionary
  
  public AnyDictionary createAnyDictionary()
- getAnyDictionaryIterator
  
  public AnyDictionary.Iterator getAnyDictionaryIterator(AnyDictionary anyDictionary)
- createAnyVector
  
  public AnyVector createAnyVector()
- getAnyVectorIterator
  
  public AnyVector.Iterator getAnyVectorIterator(AnyVector anyVector)
- createClip
  
  public Clip createClip(java.lang.String name, MediaReference mediaReference, TimeRange sourceRange, AnyDictionary metadata)
- createClip
  
  public Clip createClip(Clip.ClipBuilder builder)
- createComposable
  
  public Composable createComposable(java.lang.String name, AnyDictionary metadata)
- createComposable
  
  public Composable createComposable(java.lang.String name)
- createComposable
  
  public Composable createComposable(AnyDictionary metadata)
- createComposable
  
  public Composable createComposable(Composable.ComposableBuilder builder)
- createComposition
  
  public Composition createComposition(java.lang.String name, TimeRange sourceRange, AnyDictionary metadata, java.util.List<Effect> effects, java.util.List<Marker> markers)
- createComposition
  
  public Composition createComposition(Composition.CompositionBuilder builder)
- createEffect
  
  public Effect createEffect(java.lang.String name, java.lang.String effectName, AnyDictionary metadata)
- createEffect
  
  public Effect createEffect(Effect.EffectBuilder builder)
- createOpenTimelineIOErrorStatus
  
  public ErrorStatus createOpenTimelineIOErrorStatus()
- createOpentimeIOErrorStatus
  
  public ErrorStatus createOpentimeIOErrorStatus()
- createExternalReference
  
  public ExternalReference createExternalReference(java.lang.String targetURL, TimeRange availableRange, AnyDictionary metadata)
- createExternalReference
  
  public ExternalReference createExternalReference(ExternalReference.ExternalReferenceBuilder builder)
- createFreezeFrame
  
  public FreezeFrame createFreezeFrame(java.lang.String name, AnyDictionary metadata)
- createFreezeFrame
  
  public FreezeFrame createFreezeFrame(FreezeFrame.FreezeFrameBuilder builder)
- createGap
  
  public Gap createGap(TimeRange sourceRange, java.lang.String name, java.util.List<Effect> effects, java.util.List<Marker> markers, AnyDictionary metadata)
- createGap
  
  public Gap createGap(RationalTime duration, java.lang.String name, java.util.List<Effect> effects, java.util.List<Marker> markers, AnyDictionary metadata)
- createGap
  
  public Gap createGap(Gap.GapBuilder builder)
- createGeneratorReference
  
  public GeneratorReference createGeneratorReference(java.lang.String name, java.lang.String generatorKind, TimeRange availableRange, AnyDictionary parameters, AnyDictionary metadata)
- createGeneratorReference
  
  public GeneratorReference createGeneratorReference(GeneratorReference.GeneratorReferenceBuilder builder)
- createImageSequenceReference
  
  public ImageSequenceReference createImageSequenceReference(java.lang.String targetURLBase, java.lang.String namePrefix, java.lang.String nameSuffix, int startFrame, int frameStep, double rate, int frameZeroPadding, ImageSequenceReference.MissingFramePolicy missingFramePolicy, TimeRange availableRange, AnyDictionary metadata)
- createImageSequenceReference
  
  public ImageSequenceReference createImageSequenceReference(ImageSequenceReference.ImageSequenceReferenceBuilder builder)
- createItem
  
  public Item createItem(java.lang.String name, TimeRange sourceRange, AnyDictionary metadata, java.util.List<Effect> effects, java.util.List<Marker> markers)
- createItem
  
  public Item createItem(Item.ItemBuilder builder)
- createLinearTimeWarp
  
  public LinearTimeWarp createLinearTimeWarp(java.lang.String name, java.lang.String effectName, double timeScalar, AnyDictionary metadata)
- createLinearTimeWarp
  
  public LinearTimeWarp createLinearTimeWarp(LinearTimeWarp.LinearTimeWarpBuilder builder)
- createMarker
  
  public Marker createMarker(java.lang.String name, TimeRange markedRange, java.lang.String color, AnyDictionary metadata)
- createMarker
  
  public Marker createMarker(Marker.MarkerBuilder builder)
- createMediaReference
  
  public MediaReference createMediaReference(java.lang.String name, TimeRange availableRange, AnyDictionary metadata)
- createMediaReference
  
  public MediaReference createMediaReference(MediaReference.MediaReferenceBuilder builder)
- createMissingReference
  
  public MissingReference createMissingReference(java.lang.String name, TimeRange availableRange, AnyDictionary metadata)
- createMediaReference
  
  public MissingReference createMediaReference(MissingReference.MissingReferenceBuilder builder)
- createSerializableCollection
  
  public SerializableCollection createSerializableCollection(java.lang.String name, java.util.List<SerializableObject> children, AnyDictionary metadata)
- createSerializableCollection
  
  public SerializableCollection createSerializableCollection(SerializableCollection.SerializableCollectionBuilder builder)
- createSerializableObject
  
  public SerializableObject createSerializableObject()
- createSerializableObjectWithMetadata
  
  public SerializableObjectWithMetadata createSerializableObjectWithMetadata(java.lang.String name, AnyDictionary metadata)
- createSerializableObjectWithMetadata
  
  public SerializableObjectWithMetadata createSerializableObjectWithMetadata(java.lang.String name)
- createSerializableObjectWithMetadata
  
  public SerializableObjectWithMetadata createSerializableObjectWithMetadata(AnyDictionary metadata)
- createSerializableObjectWithMetadata
  
  public SerializableObjectWithMetadata createSerializableObjectWithMetadata(SerializableObjectWithMetadata.SerializableObjectWithMetadataBuilder builder)
- createStack
  
  public Stack createStack(java.lang.String name, TimeRange sourceRange, AnyDictionary metadata, java.util.List<Effect> effects, java.util.List<Marker> markers)
- createStack
  
  public Stack createStack(Stack.StackBuilder builder)
- createTimeEffect
  
  public TimeEffect createTimeEffect(java.lang.String name, java.lang.String effectName, AnyDictionary metadata)
- createTimeEffect
  
  public TimeEffect createTimeEffect(TimeEffect.TimeEffectBuilder builder)
- createTimeline
  
  public Timeline createTimeline(java.lang.String name, RationalTime globalStartTime, AnyDictionary metadata)
- createTimeline
  
  public Timeline createTimeline(Timeline.TimelineBuilder builder)
- createTrack
  
  public Track createTrack(java.lang.String name, TimeRange sourceRange, java.lang.String kind, AnyDictionary metadata)
- createTrack
  
  public Track createTrack(Track.TrackBuilder builder)
- createTransition
  
  public Transition createTransition(java.lang.String name, java.lang.String transitionType, RationalTime inOffset, RationalTime outOffset, AnyDictionary metadata)
- createTransition
  
  public Transition createTransition(Transition.TransitionBuilder builder)
- createUnknownSchema
  
  public UnknownSchema createUnknownSchema(java.lang.String originalSchemaName, int originalSchemaVersion)
- createUnknownSchema
  
  public UnknownSchema createUnknownSchema(UnknownSchema.UnknownSchemaBuilder builder)
- cleanUp
  
  public void cleanUp()

Class OTIOFactory

Method Summary

Methods inherited from class java.lang.Object

Method Details