Pure-R 'OpenTimelineIO' Document Model

Documentation for package ‘rotio’ version 0.1.0

Help Pages

-- A --

active_media_reference_key	Active media reference key of a clip
active_media_reference_key<-	Active media reference key of a clip
add_child	Append a child, functionally (clone + append)
add_effect	Append an effect (functional: returns a new object)
add_track	Append a track to a timeline, functionally
almost_equal	Are two RationalTimes almost equal?
append_child	Append a child to a composition (in place)
audio_tracks	Video / audio tracks of a timeline
available_range	Available range of a media reference or clip
available_range<-	Available range of a media reference or clip

-- C --

children	Children of a composition or collection
clamped	Clamp a time or range into a bounding TimeRange
clear_children	Remove all children (in place)
Clip	Construct a Clip
clone	Deep-clone an OTIO object
color	Get or set an item's display color
color<-	Get or set an item's display color
comment	Comment of a Marker
comment<-	Comment of a Marker
contains	Does a TimeRange contain a time or range?

-- D --

default_media_key	The default media reference key ('"DEFAULT_MEDIA"')
duration	TimeRange start_time and duration

-- E --

Effect	Construct an OTIO effect
effects	Effects of an item or composition
effect_name	Effect kind label
effect_name<-	Effect kind label
enabled	Whether an item, composition, or effect is enabled
enabled<-	Whether an item, composition, or effect is enabled
end_frame	Last frame number of an ImageSequenceReference
end_time_exclusive	Exclusive / inclusive end of a TimeRange
end_time_inclusive	Exclusive / inclusive end of a TimeRange
extended_by	Smallest TimeRange covering two ranges
ExternalReference	Construct a media reference

-- F --

fill	Fill a gap with an item (3/4-point edit)
find_clips	All clips within an object (recursive)
flatten_stack	Flatten a stack of tracks into a single track
frame_for_time	Frame for a time in an ImageSequenceReference
frame_step	ImageSequenceReference fields
frame_zero_padding	ImageSequenceReference fields
FreezeFrame	Construct an OTIO effect
from_frames	Construct a RationalTime from a frame number at a rate
from_json_file	Read an OTIO JSON file into the object model
from_json_string	Parse an OTIO JSON string into the object model
from_seconds	Construct a RationalTime from seconds at a rate
from_timecode	RationalTime from a SMPTE timecode
from_time_string	RationalTime from a time string ("HH:MM:SS.sss") at a rate

-- G --

Gap	Construct a Gap
GeneratorReference	Construct a GeneratorReference
generator_kind	Generator kind of a GeneratorReference
generator_kind<-	Generator kind of a GeneratorReference
global_start_time	Global start time of a timeline
global_start_time<-	Global start time of a timeline

-- H --

has_child	Does a composition directly contain a child?
has_clips	Does an object contain any clips (recursive)?

-- I --

ImageSequenceReference	Construct an ImageSequenceReference
index_of_child	1-based position of a child, or NA
insert	Insert an item at a time, splitting the item it lands in
insert_child	Insert a child at a 1-based position (in place)
intersects	Do two TimeRanges intersect?
in_offset	Transition type / offsets
in_offset<-	Transition type / offsets
is_composition	Type predicates for OTIO objects
is_effect	Is x an Effect?
is_equivalent_to	Are two OTIO objects equivalent?
is_media_reference	Type predicates for OTIO objects
is_missing_reference	Is x a MissingReference?
is_otio	Type predicates for OTIO objects
is_parent_of	Is x an ancestor of other?
is_rational_time	Is x a RationalTime / TimeRange?
is_timeline	Type predicates for OTIO objects
is_time_range	Is x a RationalTime / TimeRange?
is_unknown_schema	Is an object's schema unknown?
Item	Construct a base Item

-- K --

kind	Get or set a track's kind
kind<-	Get or set a track's kind

-- L --

Construct an OTIO effect

-- M --

marked_range	Marked range of a Marker
marked_range<-	Marked range of a Marker
Marker	Construct a Marker
MediaReference	Construct a generic MediaReference
media_reference	Active media reference of a clip
media_reference<-	Active media reference of a clip
media_references	Media references of a clip
metadata	Get or set object metadata
metadata<-	Get or set object metadata
MissingReference	Construct a media reference

-- N --

name	Get or set the name of an OTIO object
name<-	Get or set the name of an OTIO object
name_prefix	ImageSequenceReference fields
name_suffix	ImageSequenceReference fields
number_of_images_in_sequence	Number of images in an ImageSequenceReference

-- O --

out_offset	Transition type / offsets
out_offset<-	Transition type / offsets
overlapping	Does an item overlap its neighbours?
overlaps	Do two TimeRanges overlap (cross without containment)?
overwrite	Overwrite a span of a composition with an item

-- P --

parameters	Parameters of a GeneratorReference
parameters<-	Parameters of a GeneratorReference
parent	Parent of an OTIO object
presentation_time_for_image_number	Presentation time of the nth image (1-based)

-- R --

range_from_start_end_time	Construct a TimeRange from start and exclusive end times
range_in_parent	Range of an item within its parent composition
rate	RationalTime value and rate
RationalTime	Construct a RationalTime
read_otiod	Read an OTIOD bundle
register_downgrade_function	Register a schema downgrade function
register_upgrade_function	Register a schema upgrade function
remove	Remove the item at a time, optionally leaving a gap
remove_child	Remove the child at a position (in place)
rescaled_to	Rescale a RationalTime to a new rate
ripple	Ripple an item's source range
roll	Roll an item, adjusting adjacent items to fit

-- S --

schema_name	Schema name of an OTIO object
schema_version	Schema version of an OTIO object
SerializableCollection	Construct a SerializableCollection
set_child	Replace the child at a position (in place)
set_children	Replace all children (in place)
set_children<-	Replace all children (in place)
set_media_references	Replace the media references of a clip (in place)
slice	Slice an item in two at a time
slide	Slide an item, adjusting the previous item's duration
slip	Slip an item's source range
source_range	Get or set an item's source range
source_range<-	Get or set an item's source range
Stack	Construct a Stack
start_frame	ImageSequenceReference fields
start_time	TimeRange start_time and duration

-- T --

target_url	Target URL of a clip or external reference
target_url<-	Target URL of a clip or external reference
target_url_base	ImageSequenceReference fields
target_url_base<-	ImageSequenceReference fields
target_url_for_image_number	Target URL of the nth image (1-based)
TimeEffect	Construct an OTIO effect
Timeline	Construct a Timeline
TimeRange	Construct a TimeRange
TimeTransform	Construct a TimeTransform
time_scalar	Time scalar of a LinearTimeWarp
time_scalar<-	Time scalar of a LinearTimeWarp
to_frames	Frame number of a RationalTime
to_json_file	Write an OTIO object to a JSON file
to_json_string	Serialize an OTIO object to a JSON string
to_seconds	Convert a RationalTime to seconds
to_timecode	SMPTE timecode for a RationalTime
to_time_string	Time string ("HH:MM:SS.sss") for a RationalTime
Track	Construct a Track
tracks	The track stack of a timeline
tracks<-	The track stack of a timeline
track_trimmed_to_range	Trim a track to a time range
Transition	Construct a Transition
transition_type	Transition type / offsets
transition_type<-	Transition type / offsets
trim	Trim an item, filling the freed time with gap
trimmed_range	Trimmed range of an item
trimmed_range_in_parent	Range of an item within its parent, trimmed by the parent's source range
type_version_map	Current OTIO schema versions

-- V --

validate_with_RcppOTIO	Validate an OTIO object against the real OpenTimelineIO library
value	RationalTime value and rate
video_tracks	Video / audio tracks of a timeline
visible	Is an item visible?
visible_range	Visible range of an item (including adjacent transitions)

-- W --

Write an OTIOD bundle