Timeline

class Timeline
property id

The id of the timeline.

Type

str, read-only

property name

The name of the timeline.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

property range_start

The beginning of the animation (in seconds).

Type

float

Raises

ReadOnlyError -- If Database is in read only mode.

property range_end

The end of the animation (in seconds).

Type

float

Raises

ReadOnlyError -- If Database is in read only mode.

product_animation_track()

Get the product animation track.

Returns

The product animation track.

Return type

TimelineTrack

camera_animation_track()

Get the camera animation track.

Returns

The camera animation track.

Return type

TimelineTrack

configuration_animation_track()

Get the configuration animation track.

Returns

The configuration animation track.

Return type

TimelineTrack

channels_animation_tracks()

Get the list of channels animation tracks.

Returns

The list of channels animation tracks.

Return type

list(TimelineTrack)

texture_animation_tracks()

Get the list of texture animation tracks.

Returns

The list of texture animation tracks.

Return type

list(TimelineTrack)

empty_channels_track()

Get the empty Channels track.

Returns

The empty Channels track.

Return type

TimelineTrack

empty_texture_track()

Get the empty Texture track.

Returns

The empty Texture track.

Return type

TimelineTrack

duplicate()

Duplicate this timeline.

Returns

The duplicated timeline.

Return type

Timeline

Raises

ReadOnlyError -- If Database is in read only mode.

remove()

Delete a timeline

Note

If there is only one timeline left, it cannot be deleted.

Raises

TimelineLoopType

class TimelineLoopType
NONE = 0

No loop.

REPEAT = 1

Repeat loop.

INCREMENT = 2

Configuration keys.

TimelineTrack

class TimelineTrack
property id

The id of the timeline track.

Type

str, read-only

property name

The name of the timeline track.

Type

str, read-only

property type

The type of the timeline track.

Type

TimelineTrackType, read-only

property empty

Whether the timeline track is empty or not.

Type

bool, read-only

insert_animation(start_time_ms, animation)

Insert the animation at start_time in the timeline track.

Parameters
  • start_time_ms (int) -- Start time for the animation in the timeline track (in milliseconds).

  • animation (Animation) -- Animation to be inserted.

Returns

The id of the clip inserted in the given timeline track.

Return type

int

Raises

ReadOnlyError -- If Database is in read only mode.

move_animation(clip_id, track, new_start_time_ms)

Move the animation at start_time_ms in the track to track at new_track_index at new_start_time_ms

Note

The moved animation has a new clip id and the old id becomes invalid.

Parameters
  • clip_id (int) -- Id of the clip to be moved.

  • track (TimelineTrack) -- Timeline track in which the animation will be inserted.

  • new_start_time_ms (int) -- New start time for the moved animation (in milliseconds).

Returns

The new id of the clip moved to the given timeline track.

Return type

int

Raises

ReadOnlyError -- If Database is in read only mode.

remove_animation(clip_id)

Remove the animation at start_time_ms from the timeline track

Note

By default, if the timeline track becomes empty after the removal and is either a Channel Track or Texture Track, a new track of the same type will be added to the timeline.

Parameters

clip_id (int) -- Id of the clip to be removed.

Raises

ReadOnlyError -- If Database is in read only mode.

list_animations()

Get the animation list used in the timeline track.

Returns

The list of animation used in the timeline track.

Return type

list(Animation)

has_animation(animation)

Check if the timeline track has this animation.

Parameters

animation (Animation) -- Animation to be found.

Returns

Whether the timeline track has the animation or not.

Return type

bool

clear()

Remove all the animations inserted in the timeline track.

Raises

ReadOnlyError -- If Database is in read only mode.

has_clip(clip_id)

Check if the timeline track has the clip with the id id_clip.

Parameters

clip_id (int) -- Id of the clip to be checked.

Returns

Whether the timeline track has the clip or not.

Return type

bool

clip_start_time(clip_id)

Get the start time for the clip with the id id_clip.

Parameters

clip_id (int) -- Id of the clip to be checked.

Returns

Start time in ms.

Return type

int

clip_animation(clip_id)

Returns the animation for the clip animation with the id id_clip.

Parameters

clip_id (int) -- Id of the clip to be checked.

Returns

The animation corresponding to the clip.

Return type

Animation

Raises

ValueError -- If the timeline does not have a clip with the given id id_clip.

list_clip_id()

Get the clip id list in the timeline track.

Returns

The list of clip id in the timeline track.

Return type

list(int)

list_clip_id_for_animation(animation)

Get the clip id list in the timeline track corresponding to the given animation.

Parameters

animation (Animation) -- Animation for which the clip id list is to be found.

Returns

The list of clip id corresponding to the animation in the timeline track, empty if no clip exists for this animation.

Return type

list(int)

is_clip_playback_reversed(clip_id)

Whether the clip's playback is reversed.

Parameters

clip_id (int) -- Id of the clip.

Returns

Whether the clip's playback is reversed.

Return type

bool

set_clip_playback_reversed(clip_id, reversed)

Set the clip's playback reversed or not.

Parameters
  • clip_id (int) -- Id of the clip.

  • reversed (bool) -- New value for clip playback reversed.

Raises

ReadOnlyError -- If Database is in read only mode.

clip_loop_type(clip_id)

Whether the clip's playback is reversed.

Parameters

clip_id (int) -- Id of the clip.

Returns

Whether the clip's playback is reversed.

Return type

TimelineLoopType

set_clip_loop_type(clip_id, loop_type)

Set the clip's loop type.

Parameters
  • clip_id (int) -- Id of the clip.

  • loop_type (TimelineLoopType) -- New value for clip loop type.

Raises

ReadOnlyError -- If Database is in read only mode.

TimelineTrackType

class TimelineTrackType
PRODUCT_KEYS = 0

Product keys.

CAMERA_ANIMATIONS = 1

Camera animations.

CONFIGURATION_KEYS = 2

Configuration keys.

CHANNELS_ANIMATIONS = 3

Channel animations.

DYNAMIC_TEXTURES = 4

Video textures.