Package brisa :: Package upnp :: Package services :: Package cds :: Module content_directory :: Class ContentDirectory
[hide private]
[frames] | no frames]

Class ContentDirectory

source code

device.Service --+
                 |
                ContentDirectory

Content Directory service implementation (version 1.0).

Instance Methods [hide private]
 
__init__(self, plugins_folder, plugins_module_str) source code
 
start(self)
Starts the ContentDirectory by loading the plugins.
source code
 
stop(self)
Stops the ContentDirectory servie by unloading the plugins.
source code
 
publish(self, webserver) source code
dict
soap_GetSearchCapabilities(self, *args, **kwargs)
Returns the search capabilities supported by the device.
source code
dict
soap_GetSortCapabilities(self, *args, **kwargs)
Returns the CSV list of meta-data tags that can be used in sortCriteria.
source code
dict
soap_GetSystemUpdateID(self, *args, **kwargs)
Returns the current value of state variable SystemUpdateID.
source code
dict
soap_Browse(self, *args, **kwargs)
Implements the Browse action for the ContentDirectory.
source code
dict
_soap_Browse(self, *args)
Real implementation of the soap browse.
source code
 
soap_Search(self, *args, **kwargs)
Search for objects that match some search criteria.
source code
Method Details [hide private]

soap_GetSearchCapabilities(self, *args, **kwargs)

source code 

Returns the search capabilities supported by the device.

Parameters:
  • args (list) - list of arguments for the GetSearchCapabilities UPnP function
  • kwargs (dict) - dict of arguments for the GetSearchCapabilities UPnP function
Returns: dict
the search capabilities supported by the device

soap_GetSortCapabilities(self, *args, **kwargs)

source code 

Returns the CSV list of meta-data tags that can be used in sortCriteria.

Parameters:
  • args (list) - list of arguments for the GetSortCapabilities UPnP function
  • kwargs (dict) - dict of arguments for the GetSortCapabilities UPnP function
Returns: dict
CSV list of meta-data

soap_GetSystemUpdateID(self, *args, **kwargs)

source code 

Returns the current value of state variable SystemUpdateID.

Parameters:
  • args (list) - list of arguments for the GetSystemUpdateID UPnP function
  • kwargs (dict) - dict of arguments for the GetSystemUPdateID UPnP function
Returns: dict
current value of SystemUpdateID

soap_Browse(self, *args, **kwargs)

source code 

Implements the Browse action for the ContentDirectory.

Parameters:
  • args (list) - list of arguments for the Browse UPnP function
  • kwargs (dict) - dict of arguments for the Browse UPnP function
Returns: dict
the results of the browsing

_soap_Browse(self, *args)

source code 

Real implementation of the soap browse.

Parameters:
  • args (list) - list of arguments
Returns: dict
the results of browsing

soap_Search(self, *args, **kwargs)

source code 

Search for objects that match some search criteria.

Parameters:
  • args (list) - list of arguments for the Search UPnP function
  • kwargs (dict

    TODO: forward the search to the respective plugin. TODO: implement the search.

    ) - dict of arguments for the Search UPnP function