Clutter.Timeline
Description: Reference for Clutter.Timeline

### Class

# ClutterTimeline

#### Description [src]

    class Clutter.Timeline : GObject.Object {
      /* No available fields */
    }

The `ClutterTimeline` structure contains only private data and should be accessed using the provided API.

Available since: | 0.2

#### Ancestors

- GObject

#### Descendants

- ClutterTransition

#### Implements

- ClutterScriptable

#### Constructors

###### clutter_timeline_new

Creates a new `ClutterTimeline` with a duration of `duration_ms` milli seconds.

Available since: 0.6

###### clutter_timeline_new_for_actor

Creates a new `ClutterTimeline` with a duration of `duration` milli seconds.

###### clutter_timeline_new_for_frame_clock

Creates a new `ClutterTimeline` with a duration of `duration_ms` milli seconds.

#### Instance methods

###### clutter_timeline_add_marker

Adds a named marker that will be hit when the timeline has reached the specified `progress`.

Available since: 1.14

###### clutter_timeline_add_marker_at_time

Adds a named marker that will be hit when the timeline has been running for `msecs` milliseconds.

Available since: 0.8

###### clutter_timeline_advance

Advance timeline to the requested point. The point is given as a time in milliseconds since the timeline started.

###### clutter_timeline_advance_to_marker

Advances `timeline` to the time of the given `marker_name`.

Available since: 0.8

###### clutter_timeline_get_actor

Get the actor the timeline is associated with.

###### clutter_timeline_get_auto_reverse

Retrieves the value set by clutter_timeline_set_auto_reverse().

Available since: 1.6

###### clutter_timeline_get_cubic_bezier_progress

Retrieves the control points for the cubic bezier progress mode.

Available since: 1.12

###### clutter_timeline_get_current_repeat

Retrieves the current repeat for a timeline.

Available since: 1.10

###### clutter_timeline_get_delay

Retrieves the delay set using clutter_timeline_set_delay().

Available since: 0.4

###### clutter_timeline_get_delta

Retrieves the amount of time elapsed since the last ClutterTimeline::new-frame signal.

Available since: 0.6

###### clutter_timeline_get_direction

Retrieves the direction of the timeline set with clutter_timeline_set_direction().

Available since: 0.6

###### clutter_timeline_get_duration

Retrieves the duration of a `ClutterTimeline` in milliseconds. See clutter_timeline_set_duration().

Available since: 0.6

###### clutter_timeline_get_duration_hint

Retrieves the full duration of the `timeline`, taking into account the current value of the `ClutterTimeline:repeat-count` property.

Available since: 1.10

###### clutter_timeline_get_elapsed_time

Request the current time position of the timeline.

###### clutter_timeline_get_frame_clock

No description available.

###### clutter_timeline_get_progress

The position of the timeline in a normalized [-1, 2] interval.

Available since: 0.6

###### clutter_timeline_get_progress_mode

Retrieves the progress mode set using `clutter_timeline_set_progress_mode()` or clutter_timeline_set_progress_func().

Available since: 1.10

###### clutter_timeline_get_repeat_count

Retrieves the number set using clutter_timeline_set_repeat_count().

Available since: 1.10

###### clutter_timeline_get_step_progress

Retrieves the parameters of the step progress mode used by `timeline`.

Available since: 1.12

###### clutter_timeline_has_marker

Checks whether `timeline` has a marker set with the given name.

Available since: 0.8

###### clutter_timeline_is_playing

Queries state of a `ClutterTimeline`.

###### clutter_timeline_list_markers

Retrieves the list of markers at time `msecs`. If `msecs` is a negative integer, all the markers attached to `timeline` will be returned.

Available since: 0.8

###### clutter_timeline_pause

Pauses the `ClutterTimeline` on current frame.

###### clutter_timeline_remove_marker

Removes `marker_name`, if found, from `timeline`.

Available since: 0.8

###### clutter_timeline_rewind

Rewinds `ClutterTimeline` to the first frame if its direction is `CLUTTER_TIMELINE_FORWARD` and the last frame if it is `CLUTTER_TIMELINE_BACKWARD`.

###### clutter_timeline_set_actor

Set the actor the timeline is associated with.

###### clutter_timeline_set_auto_reverse

Sets whether `timeline` should reverse the direction after the emission of the `ClutterTimeline::completed` signal.

Available since: 1.6

###### clutter_timeline_set_cubic_bezier_progress

Sets the `ClutterTimeline:progress-mode` of `timeline` to `CLUTTER_CUBIC_BEZIER`, and sets the two control points for the cubic bezier.

Available since: 1.12

###### clutter_timeline_set_delay

Sets the delay, in milliseconds, before `timeline` should start.

Available since: 0.4

###### clutter_timeline_set_direction

Sets the direction of `timeline`, either `CLUTTER_TIMELINE_FORWARD` or `CLUTTER_TIMELINE_BACKWARD`.

Available since: 0.6

###### clutter_timeline_set_duration

Sets the duration of the timeline, in milliseconds. The speed of the timeline depends on the ClutterTimeline:fps setting.

Available since: 0.6

###### clutter_timeline_set_frame_clock

No description available.

###### clutter_timeline_set_progress_func

Sets a custom progress function for `timeline`. The progress function will be called by `clutter_timeline_get_progress()` and will be used to compute the progress value based on the elapsed time and the total duration of the timeline.

Available since: 1.10

###### clutter_timeline_set_progress_mode

Sets the progress function using a value from the `ClutterAnimationMode` enumeration. The `mode` cannot be `CLUTTER_CUSTOM_MODE` or bigger than `CLUTTER_ANIMATION_LAST`.

Available since: 1.10

###### clutter_timeline_set_repeat_count

Sets the number of times the `timeline` should repeat.

Available since: 1.10

###### clutter_timeline_set_step_progress

Sets the `ClutterTimeline:progress-mode` of the `timeline` to `CLUTTER_STEPS` and provides the parameters of the step function.

Available since: 1.12

###### clutter_timeline_skip

Advance timeline by the requested time in milliseconds.

###### clutter_timeline_start

Starts the `ClutterTimeline` playing.

###### clutter_timeline_stop

Stops the `ClutterTimeline` and moves to frame 0

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from ClutterScriptable (4)

###### clutter_scriptable_get_id

Retrieves the id of `scriptable` set using clutter_scriptable_set_id().

Available since: 0.6

###### clutter_scriptable_parse_custom_node

Parses the passed JSON node. The implementation must set the type of the passed `GValue` pointer using g_value_init().

Available since: 0.6

###### clutter_scriptable_set_custom_property

Overrides the common properties setting. The underlying virtual function should be used when implementing custom properties.

Available since: 0.6

###### clutter_scriptable_set_id

Sets `id_` as the unique Clutter script it for this instance of `ClutterScriptableIface`.

Available since: 0.6

#### Properties

###### Clutter.Timeline:actor

No description available.

###### Clutter.Timeline:auto-reverse

If the direction of the timeline should be automatically reversed when reaching the end.

Available since: 1.6

###### Clutter.Timeline:delay

A delay, in milliseconds, that should be observed by the timeline before actually starting.

Available since: 0.4

###### Clutter.Timeline:direction

The direction of the timeline, either `CLUTTER_TIMELINE_FORWARD` or `CLUTTER_TIMELINE_BACKWARD`.

Available since: 0.6

###### Clutter.Timeline:duration

Duration of the timeline in milliseconds, depending on the ClutterTimeline:fps value.

Available since: 0.6

###### Clutter.Timeline:frame-clock

The frame clock driving the timeline.

###### Clutter.Timeline:progress-mode

Controls the way a `ClutterTimeline` computes the normalized progress.

Available since: 1.10

###### Clutter.Timeline:repeat-count

Defines how many times the timeline should repeat.

Available since: 1.10

#### Signals

###### Clutter.Timeline::completed

The `ClutterTimeline::completed` signal is emitted when the timeline’s elapsed time reaches the value of the `ClutterTimeline:duration` property.

###### Clutter.Timeline::marker-reached

The ::marker-reached signal is emitted each time a timeline reaches a marker set with clutter_timeline_add_marker_at_time(). This signal is detailed with the name of the marker as well, so it is possible to connect a callback to the ::marker-reached signal for a specific marker with:

Available since: 0.8

###### Clutter.Timeline::new-frame

The ::new-frame signal is emitted for each timeline running timeline before a new frame is drawn to give animations a chance to update the scene.

###### Clutter.Timeline::paused

The ::paused signal is emitted when `clutter_timeline_pause()` is invoked.

###### Clutter.Timeline::started

The ::started signal is emitted when the timeline starts its run. This might be as soon as `clutter_timeline_start()` is invoked or after the delay set in the ClutterTimeline:delay property has expired.

###### Clutter.Timeline::stopped

The `ClutterTimeline::stopped` signal is emitted when the timeline has been stopped, either because `clutter_timeline_stop()` has been called, or because it has been exhausted.

Available since: 1.12

##### Signals inherited from GObject (1)

###### GObject.Object::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct ClutterTimelineClass {
      void (* started) (
        ClutterTimeline* timeline
      );
      void (* completed) (
        ClutterTimeline* timeline
      );
      void (* paused) (
        ClutterTimeline* timeline
      );
      void (* new_frame) (
        ClutterTimeline* timeline,
        gint msecs
      );
      void (* marker_reached) (
        ClutterTimeline* timeline,
        const gchar* marker_name,
        gint msecs
      );
      void (* stopped) (
        ClutterTimeline* timeline,
        gboolean is_finished
      );
      void (* _clutter_timeline_1) (
    void
      );
      void (* _clutter_timeline_2) (
    void
      );
      void (* _clutter_timeline_3) (
    void
      );
      void (* _clutter_timeline_4) (
    void
      );

    }

###### Class members

`started` |
    void (* started) (
        ClutterTimeline* timeline
      )
| No description available.
`completed` |
    void (* completed) (
        ClutterTimeline* timeline
      )
| No description available.
`paused` |
    void (* paused) (
        ClutterTimeline* timeline
      )
| No description available.
`new_frame` |
    void (* new_frame) (
        ClutterTimeline* timeline,
        gint msecs
      )
| No description available.
`marker_reached` |
    void (* marker_reached) (
        ClutterTimeline* timeline,
        const gchar* marker_name,
        gint msecs
      )
| No description available.
`stopped` |
    void (* stopped) (
        ClutterTimeline* timeline,
        gboolean is_finished
      )
| No description available.
`_clutter_timeline_1` |
    void (* _clutter_timeline_1) (
    void
      )
| No description available.
`_clutter_timeline_2` |
    void (* _clutter_timeline_2) (
    void
      )
| No description available.
`_clutter_timeline_3` |
    void (* _clutter_timeline_3) (
    void
      )
| No description available.
`_clutter_timeline_4` |
    void (* _clutter_timeline_4) (
    void
      )
| No description available.

#### Virtual methods

###### Clutter.TimelineClass.completed

No description available.

###### Clutter.TimelineClass.marker_reached

No description available.

###### Clutter.TimelineClass.new_frame

No description available.

###### Clutter.TimelineClass.paused

No description available.

###### Clutter.TimelineClass.started

No description available.

###### Clutter.TimelineClass.stopped

No description available.