YAACC - UPNP Client and Server
Loading...
Searching...
No Matches
de.yaacc.upnp.callback.openhome.ClingOhControl Class Reference

Calls the actions of the OpenHome services of a device through Cling and waits for the answer. More...

Inheritance diagram for de.yaacc.upnp.callback.openhome.ClingOhControl:
Inheritance graph
Collaboration diagram for de.yaacc.upnp.callback.openhome.ClingOhControl:
Collaboration graph

Public Member Functions

 ClingOhControl (Device<?, ?, ?> device, HttpRequestSender sender)
 
Map< String, String > invoke (String serviceName, String actionName, Map< String, String > arguments) throws OhControlException
 
- Public Member Functions inherited from de.yaacc.openhome.OhControl

Static Public Member Functions

static Service<?, ?> findService (Device<?, ?, ?> device, String name)
 
static boolean offersPlaylist (Device<?, ?, ?> device)
 Whether the device offers what the controller needs: the playlist and the product (source and standby).
 

Static Public Attributes

static final String NAMESPACE = "av-openhome-org"
 

Detailed Description

Calls the actions of the OpenHome services of a device through Cling and waits for the answer.

Blocks the calling thread, so it is used from the player's own worker thread, never from the main thread.

Member Function Documentation

◆ findService()

static Service<?, ?> de.yaacc.upnp.callback.openhome.ClingOhControl.findService ( Device<?, ?, ?> device,
String name )
static
Returns
the service of that name (the highest version the device offers), null if it has none. A renderer inside another device (a phone that serves files and plays) offers the OpenHome services on its root device: they are looked for there too.

Referenced by de.yaacc.upnp.callback.openhome.ClingOhControl.invoke(), and de.yaacc.upnp.callback.openhome.ClingOhControl.offersPlaylist().

Here is the caller graph for this function:

◆ invoke()

Map< String, String > de.yaacc.upnp.callback.openhome.ClingOhControl.invoke ( String service,
String action,
Map< String, String > arguments ) throws OhControlException
Parameters
service"Product", "Playlist", "Info", "Time" or "Volume"
actionthe action name
argumentsthe input arguments by name, as text
Returns
the output arguments by name, as text (empty for none)
Exceptions
OhControlExceptionwhen the device refused the action, did not answer, or does not offer the service

Implements de.yaacc.openhome.OhControl.

Here is the call graph for this function:

The documentation for this class was generated from the following file: