Clutter.Score¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`append` (parent, timeline)
	`append_at_marker` (parent, marker_name, timeline)
	`get_loop` ()
	`get_timeline` (id_)
	`is_playing` ()
	`list_timelines` ()
	`pause` ()
	`remove` (id_)
	`remove_all` ()
	`rewind` ()
	`set_loop` (loop)
	`start` ()
	`stop` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_completed` ()
	`do_paused` ()
	`do_started` ()
	`do_timeline_completed` (timeline)
	`do_timeline_started` (timeline)

Properties¶

Name	Type	Flags	Short Description
`loop`	`bool`	r/w	Whether the score should restart once finished `deprecated`

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`completed`	The `::completed` signal is emitted each time a `Clutter.Score` terminates. `deprecated`
`paused`	The `::paused` signal is emitted each time a `Clutter.Score` is paused. `deprecated`
`started`	The `::started` signal is emitted each time a `Clutter.Score` starts playing. `deprecated`
`timeline-completed`	The `::timeline-completed` signal is emitted each time a timeline inside a `Clutter.Score` terminates. `deprecated`
`timeline-started`	The `::timeline-started` signal is emitted each time a new timeline inside a `Clutter.Score` starts playing. `deprecated`

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class Clutter.Score(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Clutter.ScoreClass

The Clutter.Score structure contains only private data and should be accessed using the provided API

New in version 0.6.

classmethod new()¶

Returns:: the newly created Clutter.Score. Use GObject.Object.unref() when done.
Return type:: Clutter.Score

Creates a new Clutter.Score. A Clutter.Score is an object that can hold multiple Clutter.Timeline s in a sequential order.

New in version 0.6.

Deprecated since version 1.8.

append(parent, timeline)¶

Parameters:

parent (Clutter.Timeline or None) – a Clutter.Timeline in the score, or None
timeline (Clutter.Timeline) – a Clutter.Timeline

Returns:

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().

Return type:

int

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

If parent is None, the new Clutter.Timeline will be started when Clutter.Score.start() is called.

Clutter.Score will take a reference on timeline.

New in version 0.6.

Deprecated since version 1.8.

append_at_marker(parent, marker_name, timeline)¶

Parameters:

parent (Clutter.Timeline) – the parent Clutter.Timeline
marker_name (str) – the name of the marker to use
timeline (Clutter.Timeline) – the Clutter.Timeline to append

Returns:

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().

Return type:

int

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.

New in version 0.8.

Deprecated since version 1.8.

get_loop()¶

Returns:: True if the score is looping
Return type:: bool

Gets whether self is looping

New in version 0.6.

Deprecated since version 1.8.

get_timeline(id_)¶

Parameters:: id (int) – the id of the timeline
Returns:: the requested timeline, or None. This function does not increase the reference count on the returned Clutter.Timeline
Return type:: Clutter.Timeline

Retrieves the Clutter.Timeline for id_ inside self.

New in version 0.6.

Deprecated since version 1.8.

is_playing()¶

Returns:: True if score is currently playing
Return type:: bool

Query state of a Clutter.Score instance.

New in version 0.6.

Deprecated since version 1.8.

list_timelines()¶

Returns:: a GLib.SList 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.
Return type:: [Clutter.Timeline]

Retrieves a list of all the Clutter.Timelines managed by self.

New in version 0.6.

Deprecated since version 1.8.

pause()¶: Pauses a playing score self.

New in version 0.6.

Deprecated since version 1.8.

remove(id_)¶

Parameters:: id (int) – the id of the timeline to remove

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

New in version 0.6.

Deprecated since version 1.8.

remove_all()¶: Removes all the timelines inside self.

New in version 0.6.

Deprecated since version 1.8.

rewind()¶: Rewinds a Clutter.Score to its initial state.

New in version 0.6.

Deprecated since version 1.8.

set_loop(loop)¶

Parameters:: loop (bool) – True for enable looping

Sets whether self should loop. A looping Clutter.Score will start from its initial state after the ::complete signal has been fired.

New in version 0.6.

Deprecated since version 1.8.

start()¶: Starts the score.

New in version 0.6.

Deprecated since version 1.8.

stop()¶: Stops and rewinds a playing Clutter.Score instance.

New in version 0.6.

Deprecated since version 1.8.

do_completed() virtual¶: handler for the Clutter.Score ::completed signal

do_paused() virtual¶: handler for the Clutter.Score ::paused signal

do_started() virtual¶: handler for the Clutter.Score ::started signal

do_timeline_completed(timeline) virtual¶

Parameters:: timeline (Clutter.Timeline) –

handler for the Clutter.Score ::timeline-completed signal

do_timeline_started(timeline) virtual¶

Parameters:: timeline (Clutter.Timeline) –

handler for the Clutter.Score ::timeline-started signal

Signal Details¶

Clutter.Score.signals.completed(score)¶

Signal Name:: completed
Flags:: RUN_LAST
Parameters:: score (Clutter.Score) – The object which received the signal

The ::completed signal is emitted each time a Clutter.Score terminates.

New in version 0.6.

Deprecated since version 1.8.

Clutter.Score.signals.paused(score)¶

Signal Name:: paused
Flags:: RUN_LAST
Parameters:: score (Clutter.Score) – The object which received the signal

The ::paused signal is emitted each time a Clutter.Score is paused.

New in version 0.6.

Deprecated since version 1.8.

Clutter.Score.signals.started(score)¶

Signal Name:: started
Flags:: RUN_LAST
Parameters:: score (Clutter.Score) – The object which received the signal

The ::started signal is emitted each time a Clutter.Score starts playing.

New in version 0.6.

Deprecated since version 1.8.

Clutter.Score.signals.timeline_completed(score, timeline)¶

Signal Name:

timeline-completed

Flags:

RUN_LAST

Parameters:

score (Clutter.Score) – The object which received the signal
timeline (Clutter.Timeline) – the completed timeline

The ::timeline-completed signal is emitted each time a timeline inside a Clutter.Score terminates.

New in version 0.6.

Deprecated since version 1.8.

Clutter.Score.signals.timeline_started(score, timeline)¶

Signal Name:

timeline-started

Flags:

RUN_LAST

Parameters:

score (Clutter.Score) – The object which received the signal
timeline (Clutter.Timeline) – the current timeline

The ::timeline-started signal is emitted each time a new timeline inside a Clutter.Score starts playing.

New in version 0.6.

Deprecated since version 1.8.

Property Details¶

Clutter.Score.props.loop¶

Name:: loop
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Whether the Clutter.Score should restart once finished.

New in version 0.6.

Deprecated since version 1.8.