Class: Clutter::Score

Inherits:
Object
  • Object
show all
Defined in:
(unknown)

Overview

The Clutter::ScoreClass structure contains only private data

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Clutter::Score

Creates a new Clutter::Score. A #ClutterScore is an object that can hold multiple Clutter::Timelines in a sequential order.

Instance Method Details

#append(parent, timeline) ⇒ Clutter::gulong

Appends a timeline to another one existing in the score; the newly appended timeline will be started when parent is complete.

If parent is nil, the new Clutter::Timeline will be started when clutter_score_start() is called.

Clutter::Score will take a reference on timeline.

Parameters:

Returns:

  • (Clutter::gulong) —

    the id of the Clutter::Timeline inside the score, or 0 on failure. The returned id can be used with clutter_score_remove() or clutter_score_get_timeline().

#append_at_marker(parent, marker_name, timeline) ⇒ Clutter::gulong

Appends timeline at the given marker_name on the parent Clutter::Timeline.

If you want to append timeline at the end of parent, use clutter_score_append().

The Clutter::Score will take a reference on timeline.

Parameters:

  • parent (Clutter::Timeline) —

    the parent Clutter::Timeline

  • marker_name (String) —

    the name of the marker to use

  • timeline (Clutter::Timeline) —

    the Clutter::Timeline to append

Returns:

  • (Clutter::gulong) —

    the id of the Clutter::Timeline inside the score, or 0 on failure. The returned id can be used with clutter_score_remove() or clutter_score_get_timeline().

#get_timeline(id_) ⇒ Clutter::Timeline

Retrieves the Clutter::Timeline for id_ inside score.

Parameters:

  • id_ (Clutter::gulong) —

    the id of the timeline

Returns:

  • (Clutter::Timeline) —

    the requested timeline, or nil. This function does not increase the reference count on the returned Clutter::Timeline

#is_playing ⇒ Boolean

Query state of a Clutter::Score instance.

Returns:

  • (Boolean) —

    true if score is currently playing

#list_timelines ⇒ GLib::SList<Clutter::Timeline>

Retrieves a list of all the Clutter::Timelines managed by score.

Returns:

  • (GLib::SList<Clutter::Timeline>) —

    a #GSList containing all the timelines in the score. This function does not increase the reference count of the returned timelines. Use g_slist_free() on the returned list to deallocate its resources.

#loop ⇒ Boolean

Gets whether score is looping

Returns:

  • (Boolean) —

    true if the score is looping

#loop=(loop) ⇒ Boolean

Whether the Clutter::Score should restart once finished.

Parameters:

  • loop (Boolean)

Returns:

  • (Boolean) —

    loop

  • (Boolean) —

    loop

#loop? ⇒ Boolean

Whether the Clutter::Score should restart once finished.

Returns:

  • (Boolean) —

    loop

#pause ⇒ nil

Pauses a playing score score.

Returns:

  • (nil)

#remove(id_) ⇒ nil

Removes the Clutter::Timeline with the given id inside score. If the timeline has other timelines attached to it, those are removed as well.

Parameters:

  • id_ (Clutter::gulong) —

    the id of the timeline to remove

Returns:

  • (nil)

#remove_all ⇒ nil

Removes all the timelines inside score.

Returns:

  • (nil)

#rewind ⇒ nil

Rewinds a Clutter::Score to its initial state.

Returns:

  • (nil)

#start ⇒ nil

Starts the score.

Returns:

  • (nil)

#stop ⇒ nil

Stops and rewinds a playing Clutter::Score instance.

Returns:

  • (nil)