SoCo
v0.14
User Documentation
Getting started
Examples
Frequently Asked Questions
Plugins
Authors
In depth topics
Speaker Topologies
UPnP Services
Events
The Music Library Data Structures
API documentation
soco package
Release Notes
SoCo releases
Development Topics
Unit and integration tests
Release Procedures
SoCo
Docs
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
Z
_
_BaseCache (class in soco.cache)
_translation (soco.data_structures.DidlAlbum attribute)
(soco.data_structures.DidlAlbumList attribute)
(soco.data_structures.DidlAudioBroadcast attribute)
(soco.data_structures.DidlAudioBroadcastFavorite attribute)
(soco.data_structures.DidlAudioItem attribute)
(soco.data_structures.DidlComposer attribute)
(soco.data_structures.DidlContainer attribute)
(soco.data_structures.DidlFavorite attribute)
(soco.data_structures.DidlGenre attribute)
(soco.data_structures.DidlItem attribute)
(soco.data_structures.DidlMusicAlbum attribute)
(soco.data_structures.DidlMusicAlbumCompilation attribute)
(soco.data_structures.DidlMusicAlbumFavorite attribute)
(soco.data_structures.DidlMusicArtist attribute)
(soco.data_structures.DidlMusicGenre attribute)
(soco.data_structures.DidlMusicTrack attribute)
(soco.data_structures.DidlObject attribute)
(soco.data_structures.DidlPerson attribute)
(soco.data_structures.DidlPlaylistContainer attribute)
(soco.data_structures.DidlPlaylistContainerFavorite attribute)
(soco.data_structures.DidlRadioShow attribute)
(soco.data_structures.DidlSameArtist attribute)
A
Account (class in soco.music_services.accounts)
Action (class in soco.services)
add_item_to_sonos_playlist() (soco.core.SoCo method)
add_multiple_to_queue() (soco.core.SoCo method)
add_to_queue() (soco.core.SoCo method)
add_uri_to_queue() (soco.core.SoCo method)
address (soco.events.EventServerThread attribute)
Alarm (class in soco.alarms)
AlarmClock (class in soco.services)
album (soco.ms_data_structures.MSTrack attribute)
album_art_uri (soco.ms_data_structures.MusicServiceItem attribute)
album_artist_display_option (soco.core.SoCo attribute)
(soco.music_library.MusicLibrary attribute)
all_groups (soco.core.SoCo attribute)
all_zones (soco.core.SoCo attribute)
any_soco() (in module soco.discovery)
Argument (class in soco.services)
artist (soco.ms_data_structures.MSAlbum attribute)
(soco.ms_data_structures.MSTrack attribute)
available_search_categories (soco.music_services.music_service.MusicService attribute)
AVTransport (class in soco.services)
B
base_url (soco.services.Service attribute)
bass (soco.core.SoCo attribute)
browse() (soco.core.SoCo method)
(soco.music_library.MusicLibrary method)
(soco.plugins.wimp.Wimp method)
browse_by_idstring() (soco.core.SoCo method)
(soco.music_library.MusicLibrary method)
build_command() (soco.services.Service method)
by_name() (in module soco.discovery)
C
Cache (class in soco.cache)
cache (soco.services.Service attribute)
CACHE_ENABLED (in module soco.config)
call() (soco.music_services.music_service.MusicServiceSoapClient method)
(soco.soap.SoapMessage method)
camel_to_underscore() (in module soco.utils)
can_play (soco.ms_data_structures.MusicServiceItem attribute)
CannotCreateDIDLMetadata
clear() (soco.cache._BaseCache method)
(soco.cache.Cache method)
(soco.cache.NullCache method)
(soco.cache.TimedCache method)
clear_queue() (soco.core.SoCo method)
clear_sonos_playlist() (soco.core.SoCo method)
ContentDirectory (class in soco.services)
control_url (soco.services.Service attribute)
coordinator (soco.groups.ZoneGroup attribute)
create_sonos_playlist() (soco.core.SoCo method)
create_sonos_playlist_from_queue() (soco.core.SoCo method)
cross_fade (soco.core.SoCo attribute)
D
default_timeout (soco.cache.TimedCache attribute)
delete() (soco.cache._BaseCache method)
(soco.cache.Cache method)
(soco.cache.NullCache method)
(soco.cache.TimedCache method)
deleted (soco.music_services.accounts.Account attribute)
deprecated (class in soco.utils)
desc (soco.music_services.music_service.MusicService attribute)
desc_from_uri() (in module soco.music_services.music_service)
description (soco.plugins.wimp.Wimp attribute)
DeviceProperties (class in soco.services)
dialog_mode (soco.core.SoCo attribute)
didl_metadata (soco.ms_data_structures.MusicServiceItem attribute)
DidlAlbum (class in soco.data_structures)
DidlAlbumList (class in soco.data_structures)
DidlAudioBroadcast (class in soco.data_structures)
DidlAudioBroadcastFavorite (class in soco.data_structures)
DidlAudioItem (class in soco.data_structures)
DidlComposer (class in soco.data_structures)
DidlContainer (class in soco.data_structures)
DidlFavorite (class in soco.data_structures)
DidlGenre (class in soco.data_structures)
DidlItem (class in soco.data_structures)
DidlMetaClass (class in soco.data_structures)
DIDLMetadataError
DidlMusicAlbum (class in soco.data_structures)
DidlMusicAlbumCompilation (class in soco.data_structures)
DidlMusicAlbumFavorite (class in soco.data_structures)
DidlMusicArtist (class in soco.data_structures)
DidlMusicGenre (class in soco.data_structures)
DidlMusicTrack (class in soco.data_structures)
DidlObject (class in soco.data_structures)
DidlPerson (class in soco.data_structures)
DidlPlaylistContainer (class in soco.data_structures)
DidlPlaylistContainerFavorite (class in soco.data_structures)
DidlRadioShow (class in soco.data_structures)
DidlResource (class in soco.data_structures)
DidlSameArtist (class in soco.data_structures)
discover() (in module soco.discovery)
do_NOTIFY() (soco.events.EventNotifyHandler method)
duration (soco.alarms.Alarm attribute)
(soco.data_structures.DidlResource attribute)
(soco.ms_data_structures.MSTrack attribute)
E
enabled (soco.alarms.Alarm attribute)
(soco.cache._BaseCache attribute)
Event (class in soco.events)
EVENT_LISTENER_IP (in module soco.config)
EVENT_LISTENER_PORT (in module soco.config)
event_subscription_url (soco.services.Service attribute)
EventListener (class in soco.events)
EventNotifyHandler (class in soco.events)
events (soco.events.Subscription attribute)
EventServer (class in soco.events)
EventServerThread (class in soco.events)
ExamplePlugin (class in soco.plugins.example)
extended_id (soco.ms_data_structures.MusicServiceItem attribute)
F
form_uri() (soco.plugins.wimp.Wimp static method)
from_dict() (soco.data_structures.DidlObject class method)
(soco.data_structures.DidlResource class method)
(soco.ms_data_structures.MusicServiceItem class method)
from_element() (soco.data_structures.DidlObject class method)
(soco.data_structures.DidlResource class method)
from_name() (soco.plugins.SoCoPlugin class method)
from_xml() (soco.ms_data_structures.MusicServiceItem class method)
G
get() (soco.cache._BaseCache method)
(soco.cache.Cache method)
(soco.cache.NullCache method)
(soco.cache.TimedCache method)
get_accounts() (soco.music_services.accounts.Account class method)
get_accounts_for_service() (soco.music_services.accounts.Account class method)
get_alarms() (in module soco.alarms)
get_album_artists() (soco.core.SoCo method)
(soco.music_library.MusicLibrary method)
get_albums() (soco.core.SoCo method)
(soco.music_library.MusicLibrary method)
(soco.plugins.wimp.Wimp method)
get_albums_for_artist() (soco.core.SoCo method)
(soco.music_library.MusicLibrary method)
get_all_music_services_names() (soco.music_services.music_service.MusicService class method)
get_artists() (soco.core.SoCo method)
(soco.music_library.MusicLibrary method)
(soco.plugins.wimp.Wimp method)
get_composers() (soco.core.SoCo method)
(soco.music_library.MusicLibrary method)
get_current_track_info() (soco.core.SoCo method)
get_current_transport_info() (soco.core.SoCo method)
get_data_for_name() (soco.music_services.music_service.MusicService class method)
get_extended_metadata() (soco.music_services.music_service.MusicService method)
get_extended_metadata_text() (soco.music_services.music_service.MusicService method)
get_favorite_radio_shows() (soco.core.SoCo method)
(soco.music_library.MusicLibrary method)
get_favorite_radio_stations() (soco.core.SoCo method)
(soco.music_library.MusicLibrary method)
get_genres() (soco.core.SoCo method)
(soco.music_library.MusicLibrary method)
get_item_album_art_uri() (soco.core.SoCo method)
get_last_update() (soco.music_services.music_service.MusicService method)
get_media_metadata() (soco.music_services.music_service.MusicService method)
get_media_uri() (soco.music_services.music_service.MusicService method)
get_metadata() (soco.music_services.music_service.MusicService method)
get_ms_item() (in module soco.ms_data_structures)
get_music_library_information() (soco.core.SoCo method)
(soco.music_library.MusicLibrary method)
get_music_service_information() (soco.plugins.wimp.Wimp method)
get_playlists() (soco.core.SoCo method)
(soco.music_library.MusicLibrary method)
(soco.plugins.wimp.Wimp method)
get_queue() (soco.core.SoCo method)
get_sleep_timer() (soco.core.SoCo method)
get_soap_header() (soco.music_services.music_service.MusicServiceSoapClient method)
get_sonos_favorites() (soco.core.SoCo method)
(soco.music_library.MusicLibrary method)
get_sonos_playlist_by_attr() (soco.core.SoCo method)
get_sonos_playlists() (soco.core.SoCo method)
get_speaker_info() (soco.core.SoCo method)
get_subscribed_services_names() (soco.music_services.music_service.MusicService class method)
get_tracks() (soco.core.SoCo method)
(soco.music_library.MusicLibrary method)
(soco.plugins.wimp.Wimp method)
get_tracks_for_album() (soco.core.SoCo method)
(soco.music_library.MusicLibrary method)
get_uri() (soco.data_structures.DidlObject method)
GetZoneGroupState() (soco.services.ZoneGroupTopology method)
group (soco.core.SoCo attribute)
GroupManagement (class in soco.services)
GroupRenderingControl (class in soco.services)
H
handle_upnp_error() (soco.services.Service method)
household_id (soco.core.SoCo attribute)
I
id_to_extended_id() (soco.plugins.wimp.Wimp static method)
in_args (soco.services.Action attribute)
include_linked_zones (soco.alarms.Alarm attribute)
ip_address (soco.core.SoCo attribute)
is_bridge (soco.core.SoCo attribute)
is_coordinator (soco.core.SoCo attribute)
is_playing_line_in (soco.core.SoCo attribute)
is_playing_radio (soco.core.SoCo attribute)
is_playing_tv (soco.core.SoCo attribute)
is_running (soco.events.EventListener attribute)
is_subscribed (soco.events.Subscription attribute)
is_valid_recurrence() (in module soco.alarms)
is_visible (soco.core.SoCo attribute)
item_class (soco.data_structures.DidlAlbum attribute)
(soco.data_structures.DidlAlbumList attribute)
(soco.data_structures.DidlAudioBroadcast attribute)
(soco.data_structures.DidlAudioBroadcastFavorite attribute)
(soco.data_structures.DidlAudioItem attribute)
(soco.data_structures.DidlComposer attribute)
(soco.data_structures.DidlContainer attribute)
(soco.data_structures.DidlFavorite attribute)
(soco.data_structures.DidlGenre attribute)
(soco.data_structures.DidlItem attribute)
(soco.data_structures.DidlMusicAlbum attribute)
(soco.data_structures.DidlMusicAlbumCompilation attribute)
(soco.data_structures.DidlMusicAlbumFavorite attribute)
(soco.data_structures.DidlMusicArtist attribute)
(soco.data_structures.DidlMusicGenre attribute)
(soco.data_structures.DidlMusicTrack attribute)
(soco.data_structures.DidlObject attribute)
(soco.data_structures.DidlPerson attribute)
(soco.data_structures.DidlPlaylistContainer attribute)
,
[1]
(soco.data_structures.DidlPlaylistContainerFavorite attribute)
(soco.data_structures.DidlRadioShow attribute)
(soco.data_structures.DidlSameArtist attribute)
item_id (soco.ms_data_structures.MusicServiceItem attribute)
iter_actions() (soco.services.Service method)
iter_event_vars() (soco.services.Service method)
J
join() (soco.core.SoCo method)
K
key (soco.music_services.accounts.Account attribute)
L
label (soco.groups.ZoneGroup attribute)
library_updating (soco.core.SoCo attribute)
(soco.music_library.MusicLibrary attribute)
ListOfMusicInfoItems (class in soco.data_structures)
log_message() (soco.events.EventNotifyHandler method)
loudness (soco.core.SoCo attribute)
M
make_key() (soco.cache.TimedCache static method)
members (soco.groups.ZoneGroup attribute)
metadata (soco.music_services.accounts.Account attribute)
move_in_sonos_playlist() (soco.core.SoCo method)
MR_ConnectionManager (class in soco.services)
MS_ConnectionManager (class in soco.services)
MSAlbum (class in soco.ms_data_structures)
MSAlbumList (class in soco.ms_data_structures)
MSArtist (class in soco.ms_data_structures)
MSArtistTracklist (class in soco.ms_data_structures)
MSCollection (class in soco.ms_data_structures)
MSFavorites (class in soco.ms_data_structures)
MSPlaylist (class in soco.ms_data_structures)
MSTrack (class in soco.ms_data_structures)
music_plugin_play() (soco.plugins.example.ExamplePlugin method)
music_plugin_stop() (soco.plugins.example.ExamplePlugin method)
MusicLibrary (class in soco.music_library)
MusicService (class in soco.music_services.music_service)
MusicServiceException
MusicServiceItem (class in soco.ms_data_structures)
MusicServices (class in soco.services)
MusicServiceSoapClient (class in soco.music_services.music_service)
mute (soco.core.SoCo attribute)
N
name (soco.plugins.example.ExamplePlugin attribute)
(soco.plugins.SoCoPlugin attribute)
(soco.plugins.wimp.Wimp attribute)
(soco.services.Action attribute)
(soco.services.Argument attribute)
NAMESPACES (in module soco.xml)
next() (soco.core.SoCo method)
nickname (soco.music_services.accounts.Account attribute)
night_mode (soco.core.SoCo attribute)
NotSupportedException
ns_tag() (in module soco.xml)
NullCache (class in soco.cache)
number_returned (soco.data_structures.ListOfMusicInfoItems attribute)
O
oa_device_id (soco.music_services.accounts.Account attribute)
only_on_master() (in module soco.core)
out_args (soco.services.Action attribute)
P
parent_id (soco.ms_data_structures.MusicServiceItem attribute)
parse_event_xml() (in module soco.events)
partymode() (soco.core.SoCo method)
pause() (soco.core.SoCo method)
play() (soco.core.SoCo method)
play_from_queue() (soco.core.SoCo method)
play_mode (soco.alarms.Alarm attribute)
(soco.core.SoCo attribute)
play_uri() (soco.core.SoCo method)
player_name (soco.core.SoCo attribute)
prepare() (soco.soap.SoapMessage method)
prepare_headers() (soco.soap.SoapMessage method)
prepare_soap_body() (soco.soap.SoapMessage method)
prepare_soap_envelope() (soco.soap.SoapMessage method)
prepare_soap_header() (soco.soap.SoapMessage method)
prettify() (in module soco.utils)
previous() (soco.core.SoCo method)
program_metadata (soco.alarms.Alarm attribute)
program_uri (soco.alarms.Alarm attribute)
protocol_info (soco.data_structures.DidlResource attribute)
put() (soco.cache._BaseCache method)
(soco.cache.Cache method)
(soco.cache.NullCache method)
(soco.cache.TimedCache method)
Q
QPlay (class in soco.services)
Queue (class in soco.data_structures)
(class in soco.services)
queue_size (soco.core.SoCo attribute)
R
ramp_to_volume() (soco.core.SoCo method)
really_unicode() (in module soco.utils)
really_utf8() (in module soco.utils)
recurrence (soco.alarms.Alarm attribute)
reference (soco.data_structures.DidlFavorite attribute)
remove() (soco.alarms.Alarm method)
remove_from_queue() (soco.core.SoCo method)
remove_from_sonos_playlist() (soco.core.SoCo method)
remove_sonos_playlist() (soco.core.SoCo method)
RenderingControl (class in soco.services)
renew() (soco.events.Subscription method)
reorder_sonos_playlist() (soco.core.SoCo method)
requested_timeout (soco.events.Subscription attribute)
restore() (soco.snapshot.Snapshot method)
RFC
RFC 3986
run() (soco.events.EventServerThread method)
S
save() (soco.alarms.Alarm method)
scpd_url (soco.services.Service attribute)
search() (soco.music_services.music_service.MusicService method)
search_track() (soco.core.SoCo method)
(soco.music_library.MusicLibrary method)
search_type (soco.data_structures.SearchResult attribute)
SearchResult (class in soco.data_structures)
seek() (soco.core.SoCo method)
send_command() (soco.services.Service method)
serial_number (soco.music_services.accounts.Account attribute)
Service (class in soco.services)
service_id (soco.ms_data_structures.MusicServiceItem attribute)
(soco.plugins.wimp.Wimp attribute)
service_type (soco.music_services.accounts.Account attribute)
(soco.services.Service attribute)
set_sleep_timer() (soco.core.SoCo method)
set_uri() (soco.data_structures.DidlObject method)
short_label (soco.groups.ZoneGroup attribute)
show_xml() (in module soco.utils)
sid (soco.events.Subscription attribute)
Snapshot (class in soco.snapshot)
snapshot() (soco.snapshot.Snapshot method)
SoapFault
SoapMessage (class in soco.soap)
SoCo (class in soco.core)
soco (soco.services.Service attribute)
soco.alarms (module)
soco.cache (module)
soco.compat (module)
soco.config (module)
soco.core (module)
soco.data_structures (module)
soco.discovery (module)
soco.events (module)
soco.exceptions (module)
soco.groups (module)
soco.ms_data_structures (module)
soco.music_library (module)
soco.music_services.accounts (module)
soco.music_services.music_service (module)
soco.plugins (module)
soco.plugins.example (module)
soco.plugins.spotify (module)
soco.plugins.wimp (module)
soco.services (module)
soco.snapshot (module)
soco.soap (module)
soco.utils (module)
soco.xml (module)
SOCO_CLASS (in module soco.config)
SoCoException
SoCoPlugin (class in soco.plugins)
SoCoSlaveException
SoCoUPnPException
sonos_uri_from_id() (soco.music_services.music_service.MusicService method)
start() (soco.events.EventListener method)
start_library_update() (soco.core.SoCo method)
(soco.music_library.MusicLibrary method)
start_time (soco.alarms.Alarm attribute)
status_light (soco.core.SoCo attribute)
stop() (soco.core.SoCo method)
(soco.events.EventListener method)
stop_flag (soco.events.EventServerThread attribute)
subscribe() (soco.events.Subscription method)
(soco.services.Service method)
Subscription (class in soco.events)
switch_to_line_in() (soco.core.SoCo method)
switch_to_tv() (soco.core.SoCo method)
SystemProperties (class in soco.services)
T
tag (soco.data_structures.DidlAlbum attribute)
(soco.data_structures.DidlAlbumList attribute)
(soco.data_structures.DidlAudioBroadcast attribute)
(soco.data_structures.DidlAudioBroadcastFavorite attribute)
(soco.data_structures.DidlAudioItem attribute)
(soco.data_structures.DidlComposer attribute)
(soco.data_structures.DidlContainer attribute)
(soco.data_structures.DidlFavorite attribute)
(soco.data_structures.DidlGenre attribute)
(soco.data_structures.DidlItem attribute)
(soco.data_structures.DidlMusicAlbum attribute)
(soco.data_structures.DidlMusicAlbumCompilation attribute)
(soco.data_structures.DidlMusicAlbumFavorite attribute)
(soco.data_structures.DidlMusicArtist attribute)
(soco.data_structures.DidlMusicGenre attribute)
(soco.data_structures.DidlMusicTrack attribute)
(soco.data_structures.DidlObject attribute)
(soco.data_structures.DidlPerson attribute)
(soco.data_structures.DidlPlaylistContainer attribute)
(soco.data_structures.DidlPlaylistContainerFavorite attribute)
(soco.data_structures.DidlRadioShow attribute)
(soco.data_structures.DidlSameArtist attribute)
tags_with_text() (in module soco.ms_data_structures)
time_left (soco.events.Subscription attribute)
TimedCache (class in soco.cache)
timeout (soco.events.Subscription attribute)
title (soco.ms_data_structures.MusicServiceItem attribute)
to_dict (soco.ms_data_structures.MusicServiceItem attribute)
to_dict() (soco.data_structures.DidlObject method)
(soco.data_structures.DidlResource method)
to_didl_string() (in module soco.data_structures)
to_element() (soco.data_structures.DidlObject method)
(soco.data_structures.DidlResource method)
total_matches (soco.data_structures.ListOfMusicInfoItems attribute)
treble (soco.core.SoCo attribute)
U
uid (soco.core.SoCo attribute)
(soco.groups.ZoneGroup attribute)
unjoin() (soco.core.SoCo method)
UnknownSoCoException
UnknownXMLStructure
unsubscribe() (soco.events.Subscription method)
unwrap_arguments() (soco.services.Service static method)
update_id (soco.data_structures.ListOfMusicInfoItems attribute)
uri (soco.data_structures.DidlResource attribute)
(soco.ms_data_structures.MSAlbum attribute)
(soco.ms_data_structures.MSAlbumList attribute)
(soco.ms_data_structures.MSArtistTracklist attribute)
(soco.ms_data_structures.MSPlaylist attribute)
(soco.ms_data_structures.MSTrack attribute)
url_escape_path() (in module soco.utils)
username (soco.music_services.accounts.Account attribute)
(soco.plugins.wimp.Wimp attribute)
V
vartype (soco.services.Argument attribute)
version (soco.services.Service attribute)
visible_zones (soco.core.SoCo attribute)
volume (soco.alarms.Alarm attribute)
(soco.core.SoCo attribute)
W
Wimp (class in soco.plugins.wimp)
with_metaclass() (in module soco.compat)
wrap_arguments() (soco.services.Service static method)
Z
ZoneGroup (class in soco.groups)
ZoneGroupTopology (class in soco.services)
Read the Docs
v: v0.14
Versions
latest
stable
v0.14
v0.13
v0.12
v0.11.1
v0.11
v0.10
v0.9
v0.8
v0.7
v0.6
v0.5
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.