soco.music_services.accounts module¶
This module contains classes relating to Third Party music services.
-
class
soco.music_services.accounts.
Account
[source]¶ An account for a Music Service.
Each service may have more than one account: see the Sonos release notes for version 5-2
-
service_type
= None¶ str – A unique identifier for the music service to which this account relates, eg
'2311'
for Spotify.
-
serial_number
= None¶ str – A unique identifier for this account
-
nickname
= None¶ str – The account’s nickname
-
username
= None¶ str – The username used for logging into the music service
-
metadata
= None¶ str – Metadata for the account
-
oa_device_id
= None¶ str – Used for OpenAuth id for some services
-
key
= None¶ str – Used for OpenAuthid for some services
-
classmethod
get_accounts
(soco=None)[source]¶ Get all accounts known to the Sonos system.
Parameters: soco ( SoCo
, optional) – aSoCo
instance to query. IfNone
, a random instance is used. Defaults toNone
.Returns: A dict containing account instances. Each key is the account’s serial number, and each value is the related Account instance. Accounts which have been marked as deleted are excluded. Return type: dict Note
Any existing Account instance will have its attributes updated to those currently stored on the Sonos system.
-