soco.config module

This module contains configuration variables.

They may be set by your code as follows:

from soco import config
...
config.VARIABLE = value

soco.config.SOCO_CLASS

The class object to use when SoCo instances are created.

Specify the actual callable class object here, not a string. If None, the default SoCo class will be used. Must be set before any instances are created, or it will have unpredictable effects.

soco.config.CACHE_ENABLED = True

Is the cache enabled?

If True (the default), some caching of network requests will take place.

See also

The soco.cache module.

soco.config.EVENT_ADVERTISE_IP = None

The IP on which to advertise to Sonos.

The default of None means that the relevant IP address will be detected automatically.

See also

The soco.events_base module.

soco.config.EVENT_LISTENER_IP = None

The IP on which the event listener listens.

The default of None means that the relevant IP address will be detected automatically.

See also

The soco.events_base module.

soco.config.EVENT_LISTENER_PORT = 1400

The port on which the event listener listens.

The default is 1400. You must set this before subscribing to any events.

See also

The soco.events_base module.

soco.config.EVENTS_MODULE = <module 'soco.events' from '/home/user/Desktop/shared/documentation/docs/sonos-controller/repository/soco/events.py'>

The events module to be used by the soco.services module.

The default of None means the soco.events module will be used.

See also

The soco.events and soco.events_twisted modules.