Dmap.ControlShare

Subclasses:

None

Methods

Inherited:

Dmap.Share (3), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	new (library_name, player, db, container_db)
	pair (service_name, passcode)
	player_updated ()
	start_lookup ()
	stop_lookup ()

Virtual Methods

Inherited:

Dmap.Share (15), GObject.Object (7)

	do_add_guid (guid)
	do_lookup_guid (guid)
	do_remote_found (service_name, remote_name)
	do_remote_lost (service_name)
	do_remote_paired (service_name, connected)

Properties

Inherited:

Dmap.Share (9)

Name	Type	Flags	Short Description
library-name	str	r/w	Library name as will be shown in the Remote
player	GObject.Object	r/w/co	Player

Signals

Inherited:

Dmap.Share (1), GObject.Object (1)

Name	Short Description
add-guid
lookup-guid
remote-found
remote-lost
remote-paired

Fields

Inherited:

Dmap.Share (1), GObject.Object (1)

Name	Type	Access	Description
dmap_av_share_instance	Dmap.AvShare	r

Class Details

class Dmap.ControlShare(**kwargs)

Bases:

Dmap.Share

Abstract:

No

Structure:

Dmap.ControlShareClass

classmethod new(library_name, player, db, container_db)

Parameters:

• library_name (str) – The library name that will be shown in the remote.

• player (Dmap.ControlPlayer) – A Dmap.ControlPlayer instance, used to retrieve information from a player implementation.

• db (Dmap.Db) – a media database represented by a Dmap.Db instance.

• container_db (Dmap.ContainerDb) – a container (album) database represented by a Dmap.ContainerDb instance.

Returns:

a pointer to a Dmap.ControlShare.

Return type:

Dmap.ControlShare

Creates a new DACP share and publishes it using mDNS.

pair(service_name, passcode)

Parameters:

• service_name (str) – DACP client (remote) service identifier.

• passcode (str) – 4-Digit PIN code entered by the user.

Pairs a DACP client (Remote) with this server. If the passcode is correct (the same as shown on the remote), the remote will start connecting to this server.

player_updated()

start_lookup()

Raises:

GLib.Error

Returns:

True on success, else False with error set.

Return type:

bool

Start looking up for DACP remotes. Connect to Dmap.ControlShare ::remote-found signal to detect new remotes. Be aware that when a Dmap.ControlShare is created, only after calling this function is that it starts looking up for Remotes on the network.

stop_lookup()

Raises:

GLib.Error

Return type:

bool

Stop looking up for DACP remotes.

do_add_guid(guid) virtual

Parameters:

guid (str) –

do_lookup_guid(guid) virtual

Parameters:

guid (str) –

Return type:

bool

do_remote_found(service_name, remote_name) virtual

Parameters:

• service_name (str) –

• remote_name (str) –

do_remote_lost(service_name) virtual

Parameters:

service_name (str) –

do_remote_paired(service_name, connected) virtual

Parameters:

• service_name (str) –

• connected (bool) –

Signal Details

Dmap.ControlShare.signals.add_guid(control_share, object)

Signal Name:

add-guid

Flags:

RUN_LAST

Parameters:

• control_share (Dmap.ControlShare) – The object which received the signal

• object (str) –

Dmap.ControlShare.signals.lookup_guid(control_share, object)

Signal Name:

lookup-guid

Flags:

RUN_LAST

Parameters:

• control_share (Dmap.ControlShare) – The object which received the signal

• object (str) –

Return type:

bool

Dmap.ControlShare.signals.remote_found(control_share, object, p0)

Signal Name:

remote-found

Flags:

RUN_LAST

Parameters:

• control_share (Dmap.ControlShare) – The object which received the signal

• object (str) –

• p0 (str) –

Dmap.ControlShare.signals.remote_lost(control_share, object)

Signal Name:

remote-lost

Flags:

RUN_LAST

Parameters:

• control_share (Dmap.ControlShare) – The object which received the signal

• object (str) –

Dmap.ControlShare.signals.remote_paired(control_share, object, p0)

Signal Name:

remote-paired

Flags:

RUN_LAST

Parameters:

• control_share (Dmap.ControlShare) – The object which received the signal

• object (str) –

• p0 (bool) –

Property Details

Dmap.ControlShare.props.library_name

Name:

library-name

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

Library name as will be shown in the Remote

Dmap.ControlShare.props.player

Name:

player

Type:

GObject.Object

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

Player