Dmap.Connection¶
- Subclasses:
Dmap.AvConnection
,Dmap.ControlConnection
,Dmap.ImageConnection
Methods¶
- Inherited:
- Structs:
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
|
|
|
|
|
|
Properties¶
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r/w |
base URI |
||
r/w |
database ID |
||
r/w/co |
|
||
r/w |
DMAP version |
||
r/w/co |
record factory |
||
r/w/co |
host |
||
r/w/co |
connection name |
||
w |
connection password |
||
r/w/co |
port |
||
r/w |
revision number |
||
r/w |
session ID |
||
r/w/co |
connection username |
Signals¶
- Inherited:
Name |
Short Description |
---|---|
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
parent |
r |
Class Details¶
- class Dmap.Connection(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
- authenticate_message(session, message, auth, password)¶
- Parameters:
session (
Soup.Session
) – ASoup.Session
message (
Soup.Message
) – ASoup.Message
password (
str
) – A password
Attach an authentication credential to a request. This method should be called by a function that is connected to the
Dmap.Connection
::authenticate
signal. The signal will provide the connection, session, message and auth to that function. That function should obtain a password and provide it to this method.
- get_playlists()¶
- Returns:
pointer to a list of playlists.
- Return type:
Get the playlists associated with a
Dmap.Connection
instance.
- start(callback, *user_data)¶
- Parameters:
callback (
Dmap.ConnectionFunc
) – The function to call once the connection is complete.user_data (
object
orNone
) – The data to pass to the callback.
Connect to the remote DMAP share.
- stop(callback, *user_data)¶
- Parameters:
callback (
Dmap.ConnectionFunc
) – The function to call once the connection is complete.user_data (
object
orNone
) – The data to pass to the callback.
Disconnect from the remote DMAP share.
- do_connected() virtual¶
- do_connecting(state, progress) virtual¶
- Parameters:
state (
Dmap.ConnectionState
) –progress (
float
) –
- do_disconnected() virtual¶
- do_get_protocol_version_cc() virtual¶
- Return type:
- do_operation_done() virtual¶
Signal Details¶
- Dmap.Connection.signals.authenticate(connection, object, p0, p1, p2, p3)¶
- Signal Name:
authenticate
- Flags:
- Parameters:
connection (
Dmap.Connection
) – The object which received the signalobject (
str
) –p0 (
Soup.Session
) –p1 (
Soup.Message
) –p2 (
Soup.Auth
) –p3 (
bool
) –
- Dmap.Connection.signals.connected(connection)¶
- Signal Name:
connected
- Flags:
- Parameters:
connection (
Dmap.Connection
) – The object which received the signal
- Dmap.Connection.signals.connecting(connection, object, p0)¶
- Signal Name:
connecting
- Flags:
- Parameters:
connection (
Dmap.Connection
) – The object which received the signalobject (
int
) –p0 (
float
) –
- Dmap.Connection.signals.disconnected(connection)¶
- Signal Name:
disconnected
- Flags:
- Parameters:
connection (
Dmap.Connection
) – The object which received the signal
- Dmap.Connection.signals.error(connection, object)¶
- Signal Name:
error
- Flags:
- Parameters:
connection (
Dmap.Connection
) – The object which received the signal
- Dmap.Connection.signals.operation_done(connection)¶
- Signal Name:
operation-done
- Flags:
- Parameters:
connection (
Dmap.Connection
) – The object which received the signal
Property Details¶
- Dmap.Connection.props.base_uri¶
-
base URI
- Dmap.Connection.props.database_id¶
-
database ID
- Dmap.Connection.props.dmap_version¶
-
DMAP version
- Dmap.Connection.props.factory¶
- Name:
factory
- Type:
- Default Value:
- Flags:
record factory
- Dmap.Connection.props.host¶
- Name:
host
- Type:
- Default Value:
- Flags:
host
- Dmap.Connection.props.name¶
- Name:
name
- Type:
- Default Value:
- Flags:
connection name
- Dmap.Connection.props.password¶
-
connection password
- Dmap.Connection.props.port¶
- Name:
port
- Type:
- Default Value:
0
- Flags:
port
- Dmap.Connection.props.revision_number¶
-
revision number
- Dmap.Connection.props.session_id¶
-
session ID
- Dmap.Connection.props.username¶
- Name:
username
- Type:
- Default Value:
'libdmapsharing'
- Flags:
connection username