CScreensaver.MediaPlayer¶

Implementations:: CScreensaver.MediaPlayerProxy, CScreensaver.MediaPlayerSkeleton

Methods¶

class	`interface_info` ()
class	`override_properties` (klass, property_id_begin)
	`call_next` (cancellable, callback, *user_data)
	`call_next_finish` (res)
	`call_next_sync` (cancellable)
	`call_open_uri` (arg_Uri, cancellable, callback, *user_data)
	`call_open_uri_finish` (res)
	`call_open_uri_sync` (arg_Uri, cancellable)
	`call_pause` (cancellable, callback, *user_data)
	`call_pause_finish` (res)
	`call_pause_sync` (cancellable)
	`call_play` (cancellable, callback, *user_data)
	`call_play_finish` (res)
	`call_play_pause` (cancellable, callback, *user_data)
	`call_play_pause_finish` (res)
	`call_play_pause_sync` (cancellable)
	`call_play_sync` (cancellable)
	`call_previous` (cancellable, callback, *user_data)
	`call_previous_finish` (res)
	`call_previous_sync` (cancellable)
	`call_seek` (arg_Offset, cancellable, callback, *user_data)
	`call_seek_finish` (res)
	`call_seek_sync` (arg_Offset, cancellable)
	`call_set_position` (arg_TrackId, arg_Position, cancellable, callback, *user_data)
	`call_set_position_finish` (res)
	`call_set_position_sync` (arg_TrackId, arg_Position, cancellable)
	`call_stop` (cancellable, callback, *user_data)
	`call_stop_finish` (res)
	`call_stop_sync` (cancellable)
	`complete_next` (invocation)
	`complete_open_uri` (invocation)
	`complete_pause` (invocation)
	`complete_play` (invocation)
	`complete_play_pause` (invocation)
	`complete_previous` (invocation)
	`complete_seek` (invocation)
	`complete_set_position` (invocation)
	`complete_stop` (invocation)
	`emit_seeked` (arg_Position)

Virtual Methods¶

	`do_handle_next` (invocation)
	`do_handle_open_uri` (invocation, arg_Uri)
	`do_handle_pause` (invocation)
	`do_handle_play` (invocation)
	`do_handle_play_pause` (invocation)
	`do_handle_previous` (invocation)
	`do_handle_seek` (invocation, arg_Offset)
	`do_handle_set_position` (invocation, arg_TrackId, arg_Position)
	`do_handle_stop` (invocation)
	`do_seeked` (arg_Position)

Properties¶

Name	Type	Flags	Short Description
`can-control`	`bool`	r/w	CanControl
`can-go-next`	`bool`	r/w	CanGoNext
`can-go-previous`	`bool`	r/w	CanGoPrevious
`can-pause`	`bool`	r/w	CanPause
`can-play`	`bool`	r/w	CanPlay
`can-seek`	`bool`	r/w	CanSeek
`loop-status`	`str`	r/w	LoopStatus
`maximum-rate`	`float`	r/w	MaximumRate
`metadata`	`GLib.Variant`	r/w	Metadata
`minimum-rate`	`float`	r/w	MinimumRate
`playback-status`	`str`	r/w	PlaybackStatus
`position`	`int`	r/w	Position
`rate`	`float`	r/w	Rate
`shuffle`	`bool`	r/w	Shuffle
`volume`	`float`	r/w	Volume

Signals¶

Name	Short Description
`handle-next`	Signal emitted when a remote caller is invoking the ‘Next() [gdbus-method-org-mpris-MediaPlayer2-Player.Next]’ D-Bus method.
`handle-open-uri`	Signal emitted when a remote caller is invoking the ‘OpenUri() [gdbus-method-org-mpris-MediaPlayer2-Player.OpenUri]’ D-Bus method.
`handle-pause`	Signal emitted when a remote caller is invoking the ‘Pause() [gdbus-method-org-mpris-MediaPlayer2-Player.Pause]’ D-Bus method.
`handle-play`	Signal emitted when a remote caller is invoking the ‘Play() [gdbus-method-org-mpris-MediaPlayer2-Player.Play]’ D-Bus method.
`handle-play-pause`	Signal emitted when a remote caller is invoking the ‘PlayPause() [gdbus-method-org-mpris-MediaPlayer2-Player.PlayPause]’ D-Bus method.
`handle-previous`	Signal emitted when a remote caller is invoking the ‘Previous() [gdbus-method-org-mpris-MediaPlayer2-Player.Previous]’ D-Bus method.
`handle-seek`	Signal emitted when a remote caller is invoking the ‘Seek() [gdbus-method-org-mpris-MediaPlayer2-Player.Seek]’ D-Bus method.
`handle-set-position`	Signal emitted when a remote caller is invoking the ‘SetPosition() [gdbus-method-org-mpris-MediaPlayer2-Player.SetPosition]’ D-Bus method.
`handle-stop`	Signal emitted when a remote caller is invoking the ‘Stop() [gdbus-method-org-mpris-MediaPlayer2-Player.Stop]’ D-Bus method.
`seeked`	On the client-side, this signal is emitted whenever the D-Bus signal ‘“Seeked” [gdbus-signal-org-mpris-MediaPlayer2-Player.Seeked]’ is received.

Fields¶

None

Class Details¶

class CScreensaver.MediaPlayer¶

Bases:: GObject.GInterface
Structure:: CScreensaver.MediaPlayerIface

Abstract interface type for the D-Bus interface ‘org.mpris.MediaPlayer2.Player [gdbus-interface-org-mpris-MediaPlayer2-Player.top_of_page]’.

classmethod interface_info()¶

Returns:: A Gio.DBusInterfaceInfo. Do not free.
Return type:: Gio.DBusInterfaceInfo

Gets a machine-readable description of the ‘org.mpris.MediaPlayer2.Player [gdbus-interface-org-mpris-MediaPlayer2-Player.top_of_page]’ D-Bus interface.

classmethod override_properties(klass, property_id_begin)¶

Parameters:

klass (GObject.ObjectClass) – The class structure for a GObject.Object derived class.
property_id_begin (int) – The property id to assign to the first overridden property.

Returns:

The last property id.

Return type:

int

Overrides all GObject.Object properties in the CScreensaver.MediaPlayer interface for a concrete class. The properties are overridden in the order they are defined.

call_next(cancellable, callback, *user_data)¶

Parameters:

cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘Next() [gdbus-method-org-mpris-MediaPlayer2-Player.Next]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call CScreensaver.MediaPlayer.call_next_finish() to get the result of the operation.

See CScreensaver.MediaPlayer.call_next_sync() for the synchronous, blocking version of this method.

call_next_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to CScreensaver.MediaPlayer.call_next().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with CScreensaver.MediaPlayer.call_next().

call_next_sync(cancellable)¶

Parameters:: cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Synchronously invokes the ‘Next() [gdbus-method-org-mpris-MediaPlayer2-Player.Next]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See CScreensaver.MediaPlayer.call_next() for the asynchronous version of this method.

call_open_uri(arg_Uri, cancellable, callback, *user_data)¶

Parameters:

arg_Uri (str) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘OpenUri() [gdbus-method-org-mpris-MediaPlayer2-Player.OpenUri]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call CScreensaver.MediaPlayer.call_open_uri_finish() to get the result of the operation.

See CScreensaver.MediaPlayer.call_open_uri_sync() for the synchronous, blocking version of this method.

call_open_uri_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to CScreensaver.MediaPlayer.call_open_uri().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with CScreensaver.MediaPlayer.call_open_uri().

call_open_uri_sync(arg_Uri, cancellable)¶

Parameters:

arg_Uri (str) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the ‘OpenUri() [gdbus-method-org-mpris-MediaPlayer2-Player.OpenUri]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See CScreensaver.MediaPlayer.call_open_uri() for the asynchronous version of this method.

call_pause(cancellable, callback, *user_data)¶

Parameters:

cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘Pause() [gdbus-method-org-mpris-MediaPlayer2-Player.Pause]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call CScreensaver.MediaPlayer.call_pause_finish() to get the result of the operation.

See CScreensaver.MediaPlayer.call_pause_sync() for the synchronous, blocking version of this method.

call_pause_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to CScreensaver.MediaPlayer.call_pause().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with CScreensaver.MediaPlayer.call_pause().

call_pause_sync(cancellable)¶

Parameters:: cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Synchronously invokes the ‘Pause() [gdbus-method-org-mpris-MediaPlayer2-Player.Pause]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See CScreensaver.MediaPlayer.call_pause() for the asynchronous version of this method.

call_play(cancellable, callback, *user_data)¶

Parameters:

cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘Play() [gdbus-method-org-mpris-MediaPlayer2-Player.Play]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call CScreensaver.MediaPlayer.call_play_finish() to get the result of the operation.

See CScreensaver.MediaPlayer.call_play_sync() for the synchronous, blocking version of this method.

call_play_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to CScreensaver.MediaPlayer.call_play().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with CScreensaver.MediaPlayer.call_play().

call_play_pause(cancellable, callback, *user_data)¶

Parameters:

cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘PlayPause() [gdbus-method-org-mpris-MediaPlayer2-Player.PlayPause]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call CScreensaver.MediaPlayer.call_play_pause_finish() to get the result of the operation.

See CScreensaver.MediaPlayer.call_play_pause_sync() for the synchronous, blocking version of this method.

call_play_pause_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to CScreensaver.MediaPlayer.call_play_pause().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with CScreensaver.MediaPlayer.call_play_pause().

call_play_pause_sync(cancellable)¶

Parameters:: cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Synchronously invokes the ‘PlayPause() [gdbus-method-org-mpris-MediaPlayer2-Player.PlayPause]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See CScreensaver.MediaPlayer.call_play_pause() for the asynchronous version of this method.

call_play_sync(cancellable)¶

Parameters:: cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Synchronously invokes the ‘Play() [gdbus-method-org-mpris-MediaPlayer2-Player.Play]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See CScreensaver.MediaPlayer.call_play() for the asynchronous version of this method.

call_previous(cancellable, callback, *user_data)¶

Parameters:

cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘Previous() [gdbus-method-org-mpris-MediaPlayer2-Player.Previous]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call CScreensaver.MediaPlayer.call_previous_finish() to get the result of the operation.

See CScreensaver.MediaPlayer.call_previous_sync() for the synchronous, blocking version of this method.

call_previous_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to CScreensaver.MediaPlayer.call_previous().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with CScreensaver.MediaPlayer.call_previous().

call_previous_sync(cancellable)¶

Parameters:: cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Synchronously invokes the ‘Previous() [gdbus-method-org-mpris-MediaPlayer2-Player.Previous]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See CScreensaver.MediaPlayer.call_previous() for the asynchronous version of this method.

call_seek(arg_Offset, cancellable, callback, *user_data)¶

Parameters:

arg_Offset (int) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘Seek() [gdbus-method-org-mpris-MediaPlayer2-Player.Seek]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call CScreensaver.MediaPlayer.call_seek_finish() to get the result of the operation.

See CScreensaver.MediaPlayer.call_seek_sync() for the synchronous, blocking version of this method.

call_seek_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to CScreensaver.MediaPlayer.call_seek().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with CScreensaver.MediaPlayer.call_seek().

call_seek_sync(arg_Offset, cancellable)¶

Parameters:

arg_Offset (int) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the ‘Seek() [gdbus-method-org-mpris-MediaPlayer2-Player.Seek]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See CScreensaver.MediaPlayer.call_seek() for the asynchronous version of this method.

call_set_position(arg_TrackId, arg_Position, cancellable, callback, *user_data)¶

Parameters:

arg_TrackId (str) – Argument to pass with the method invocation.
arg_Position (int) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘SetPosition() [gdbus-method-org-mpris-MediaPlayer2-Player.SetPosition]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call CScreensaver.MediaPlayer.call_set_position_finish() to get the result of the operation.

See CScreensaver.MediaPlayer.call_set_position_sync() for the synchronous, blocking version of this method.

call_set_position_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to CScreensaver.MediaPlayer.call_set_position().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with CScreensaver.MediaPlayer.call_set_position().

call_set_position_sync(arg_TrackId, arg_Position, cancellable)¶

Parameters:

arg_TrackId (str) – Argument to pass with the method invocation.
arg_Position (int) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the ‘SetPosition() [gdbus-method-org-mpris-MediaPlayer2-Player.SetPosition]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See CScreensaver.MediaPlayer.call_set_position() for the asynchronous version of this method.

call_stop(cancellable, callback, *user_data)¶

Parameters:

cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘Stop() [gdbus-method-org-mpris-MediaPlayer2-Player.Stop]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call CScreensaver.MediaPlayer.call_stop_finish() to get the result of the operation.

See CScreensaver.MediaPlayer.call_stop_sync() for the synchronous, blocking version of this method.

call_stop_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to CScreensaver.MediaPlayer.call_stop().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with CScreensaver.MediaPlayer.call_stop().

call_stop_sync(cancellable)¶

Parameters:: cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Synchronously invokes the ‘Stop() [gdbus-method-org-mpris-MediaPlayer2-Player.Stop]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See CScreensaver.MediaPlayer.call_stop() for the asynchronous version of this method.

complete_next(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘Next() [gdbus-method-org-mpris-MediaPlayer2-Player.Next]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

complete_open_uri(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘OpenUri() [gdbus-method-org-mpris-MediaPlayer2-Player.OpenUri]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

complete_pause(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘Pause() [gdbus-method-org-mpris-MediaPlayer2-Player.Pause]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

complete_play(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘Play() [gdbus-method-org-mpris-MediaPlayer2-Player.Play]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

complete_play_pause(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘PlayPause() [gdbus-method-org-mpris-MediaPlayer2-Player.PlayPause]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

complete_previous(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘Previous() [gdbus-method-org-mpris-MediaPlayer2-Player.Previous]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

complete_seek(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘Seek() [gdbus-method-org-mpris-MediaPlayer2-Player.Seek]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

complete_set_position(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘SetPosition() [gdbus-method-org-mpris-MediaPlayer2-Player.SetPosition]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

complete_stop(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘Stop() [gdbus-method-org-mpris-MediaPlayer2-Player.Stop]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

emit_seeked(arg_Position)¶

Parameters:: arg_Position (int) – Argument to pass with the signal.

Emits the ‘“Seeked” [gdbus-signal-org-mpris-MediaPlayer2-Player.Seeked]’ D-Bus signal.

do_handle_next(invocation) virtual¶

Parameters:: invocation (Gio.DBusMethodInvocation) –
Return type:: bool

do_handle_open_uri(invocation, arg_Uri) virtual¶

Parameters:

invocation (Gio.DBusMethodInvocation) –
arg_Uri (str) –

Return type:

bool

do_handle_pause(invocation) virtual¶

Parameters:: invocation (Gio.DBusMethodInvocation) –
Return type:: bool

do_handle_play(invocation) virtual¶

Parameters:: invocation (Gio.DBusMethodInvocation) –
Return type:: bool

do_handle_play_pause(invocation) virtual¶

Parameters:: invocation (Gio.DBusMethodInvocation) –
Return type:: bool

do_handle_previous(invocation) virtual¶

Parameters:: invocation (Gio.DBusMethodInvocation) –
Return type:: bool

do_handle_seek(invocation, arg_Offset) virtual¶

Parameters:

invocation (Gio.DBusMethodInvocation) –
arg_Offset (int) –

Return type:

bool

do_handle_set_position(invocation, arg_TrackId, arg_Position) virtual¶

Parameters:

invocation (Gio.DBusMethodInvocation) –
arg_TrackId (str) –
arg_Position (int) –

Return type:

bool

do_handle_stop(invocation) virtual¶

Parameters:: invocation (Gio.DBusMethodInvocation) –
Return type:: bool

do_seeked(arg_Position) virtual¶

Parameters:: arg_Position (int) –

Signal Details¶

CScreensaver.MediaPlayer.signals.handle_next(media_player, invocation)¶

Signal Name:

handle-next

Flags:

RUN_LAST

Parameters:

media_player (CScreensaver.MediaPlayer) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘Next() [gdbus-method-org-mpris-MediaPlayer2-Player.Next]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call CScreensaver.MediaPlayer.complete_next() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

CScreensaver.MediaPlayer.signals.handle_open_uri(media_player, invocation, arg_Uri)¶

Signal Name:

handle-open-uri

Flags:

RUN_LAST

Parameters:

media_player (CScreensaver.MediaPlayer) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
arg_Uri (str) – Argument passed by remote caller.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘OpenUri() [gdbus-method-org-mpris-MediaPlayer2-Player.OpenUri]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call CScreensaver.MediaPlayer.complete_open_uri() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

CScreensaver.MediaPlayer.signals.handle_pause(media_player, invocation)¶

Signal Name:

handle-pause

Flags:

RUN_LAST

Parameters:

media_player (CScreensaver.MediaPlayer) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘Pause() [gdbus-method-org-mpris-MediaPlayer2-Player.Pause]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call CScreensaver.MediaPlayer.complete_pause() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

CScreensaver.MediaPlayer.signals.handle_play(media_player, invocation)¶

Signal Name:

handle-play

Flags:

RUN_LAST

Parameters:

media_player (CScreensaver.MediaPlayer) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘Play() [gdbus-method-org-mpris-MediaPlayer2-Player.Play]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call CScreensaver.MediaPlayer.complete_play() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

CScreensaver.MediaPlayer.signals.handle_play_pause(media_player, invocation)¶

Signal Name:

handle-play-pause

Flags:

RUN_LAST

Parameters:

media_player (CScreensaver.MediaPlayer) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘PlayPause() [gdbus-method-org-mpris-MediaPlayer2-Player.PlayPause]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call CScreensaver.MediaPlayer.complete_play_pause() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

CScreensaver.MediaPlayer.signals.handle_previous(media_player, invocation)¶

Signal Name:

handle-previous

Flags:

RUN_LAST

Parameters:

media_player (CScreensaver.MediaPlayer) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘Previous() [gdbus-method-org-mpris-MediaPlayer2-Player.Previous]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call CScreensaver.MediaPlayer.complete_previous() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

CScreensaver.MediaPlayer.signals.handle_seek(media_player, invocation, arg_Offset)¶

Signal Name:

handle-seek

Flags:

RUN_LAST

Parameters:

media_player (CScreensaver.MediaPlayer) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
arg_Offset (int) – Argument passed by remote caller.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘Seek() [gdbus-method-org-mpris-MediaPlayer2-Player.Seek]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call CScreensaver.MediaPlayer.complete_seek() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

CScreensaver.MediaPlayer.signals.handle_set_position(media_player, invocation, arg_TrackId, arg_Position)¶

Signal Name:

handle-set-position

Flags:

RUN_LAST

Parameters:

media_player (CScreensaver.MediaPlayer) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
arg_TrackId (str) – Argument passed by remote caller.
arg_Position (int) – Argument passed by remote caller.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘SetPosition() [gdbus-method-org-mpris-MediaPlayer2-Player.SetPosition]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call CScreensaver.MediaPlayer.complete_set_position() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

CScreensaver.MediaPlayer.signals.handle_stop(media_player, invocation)¶

Signal Name:

handle-stop

Flags:

RUN_LAST

Parameters:

media_player (CScreensaver.MediaPlayer) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘Stop() [gdbus-method-org-mpris-MediaPlayer2-Player.Stop]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call CScreensaver.MediaPlayer.complete_stop() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

CScreensaver.MediaPlayer.signals.seeked(media_player, arg_Position)¶

Signal Name:

seeked

Flags:

RUN_LAST

Parameters:

media_player (CScreensaver.MediaPlayer) – The object which received the signal
arg_Position (int) – Argument.

On the client-side, this signal is emitted whenever the D-Bus signal ‘“Seeked” [gdbus-signal-org-mpris-MediaPlayer2-Player.Seeked]’ is received.

On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal.

Property Details¶

CScreensaver.MediaPlayer.props.can_control¶

Name:: can-control
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“CanControl” [gdbus-property-org-mpris-MediaPlayer2-Player.CanControl]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

CScreensaver.MediaPlayer.props.can_go_next¶

Name:: can-go-next
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“CanGoNext” [gdbus-property-org-mpris-MediaPlayer2-Player.CanGoNext]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

CScreensaver.MediaPlayer.props.can_go_previous¶

Name:: can-go-previous
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“CanGoPrevious” [gdbus-property-org-mpris-MediaPlayer2-Player.CanGoPrevious]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

CScreensaver.MediaPlayer.props.can_pause¶

Name:: can-pause
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“CanPause” [gdbus-property-org-mpris-MediaPlayer2-Player.CanPause]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

CScreensaver.MediaPlayer.props.can_play¶

Name:: can-play
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“CanPlay” [gdbus-property-org-mpris-MediaPlayer2-Player.CanPlay]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

CScreensaver.MediaPlayer.props.can_seek¶

Name:: can-seek
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“CanSeek” [gdbus-property-org-mpris-MediaPlayer2-Player.CanSeek]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

CScreensaver.MediaPlayer.props.loop_status¶

Name:: loop-status
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“LoopStatus” [gdbus-property-org-mpris-MediaPlayer2-Player.LoopStatus]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.

CScreensaver.MediaPlayer.props.maximum_rate¶

Name:: maximum-rate
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“MaximumRate” [gdbus-property-org-mpris-MediaPlayer2-Player.MaximumRate]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

CScreensaver.MediaPlayer.props.metadata¶

Name:: metadata
Type:: GLib.Variant
Default Value:: None
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“Metadata” [gdbus-property-org-mpris-MediaPlayer2-Player.Metadata]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

CScreensaver.MediaPlayer.props.minimum_rate¶

Name:: minimum-rate
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“MinimumRate” [gdbus-property-org-mpris-MediaPlayer2-Player.MinimumRate]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

CScreensaver.MediaPlayer.props.playback_status¶

Name:: playback-status
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“PlaybackStatus” [gdbus-property-org-mpris-MediaPlayer2-Player.PlaybackStatus]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

CScreensaver.MediaPlayer.props.position¶

Name:: position
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“Position” [gdbus-property-org-mpris-MediaPlayer2-Player.Position]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

CScreensaver.MediaPlayer.props.rate¶

Name:: rate
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“Rate” [gdbus-property-org-mpris-MediaPlayer2-Player.Rate]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.

CScreensaver.MediaPlayer.props.shuffle¶

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

Represents the D-Bus property ‘“Shuffle” [gdbus-property-org-mpris-MediaPlayer2-Player.Shuffle]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.

CScreensaver.MediaPlayer.props.volume¶

Name:: volume
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“Volume” [gdbus-property-org-mpris-MediaPlayer2-Player.Volume]’.

Since the D-Bus property for this GObject.Object property is both readable and writable, it is meaningful to both read from it and write to it on both the service- and client-side.