class UpnpAVLevel1SASupport

It provides Supports to UpnpAVLevel1TA for handling complexity.

Public Fields

added for searching(added after beta1.0 release)

Public Methods

UpnpAVLevel1SASupport(UpnpAVLevel1SA* upnpLevel1SA)

Constructor Assign the reference of UpnpAVLevel1SA and UpnpAvFacade to local variable.

list<Connection*> * getConnectionList()

Get the Connection List

map<string, string> * getRendererUDNSessionIdMap()

Get the rendererUDN Vs sessionId Map

UpnpAVLevel1SA* getUpnpLevel1SA()

Returns the UpnpAVLevel1SA Object

bool invokeCommandConnect(AbstractUISocketElement* socketElement, Session*session, Connection* connection, string indexForConnection, list<Connection*>*connectionList, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList)

Create a new dimension in set '/connection' and send updates of created dimension.

bool setVolume(Session*session, string elementPath, string value)

Set the value of volume on the mediaRendererDevice.

string getVolume(Session*session, string RendererUDN)

Get the value of Volume from the media renderer.

string setSelectedMediaServer( Session* session, string elementPath, string reqValue, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList )

Set the value of '/mediaServers[serverUDN]/isMediaServerSelected' by requested value.

string setSelectedMediaRenderer( Session* session, string elementPath, string reqValue, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList )

Set the value of '/mediaRenderers[rendererUDN]/isMediaServerSelected' by requested value.

bool setSellectedNodeId(Session* session, string elementPath, string reqValue, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList)

Set the value of '/mediaServers[serverUDN]/selectedNodeId' with the argument 'value'.

bool invokeCommandNextNode( Session*session, string serverUDN, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList, string conIndex)

Jump to the next Node.

bool invokeCommandPrevNode( Session*session, string serverUDN, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList, string conIndex)

Jump to the Previous Node.

bool invokeCommandParentNode( Session*session, string elementPath, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList)

Set the value of parentNode to the selectedNodeId.

bool invokeCommandFirstChildNode(Session* session, string elementPath, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList)

Set the value of firstChildNode to the selectedNodeId.

bool invokeCommandPlay( Session* session, Connection* connection, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList, bool flag)

Play the id Get from the Command Parameter Value of '/connections[conIndex]/transport/play/nodeToPlay'.

bool invokeCommandPause( Connection* connection, Session* session, string conIndex, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList)

Pause the playing item.

bool invokeCommandStop(Connection* connection, Session* session, string conIndex, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList)

Stop the playing item.

bool invokeCommandNext( Session* session, Connection*connection, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList)

Jump to the next item and if transportState is PLAYING then play that item.

bool invokeCommandPrevious( Session* session, Connection*connection, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList)

Jump to the previous item and if transportState is PLAYING then play that item.

string getRendererDevice(Session* session, string index)

Returns the connected media renderer for the given session and connection index

string getServerDevice(Session* session, string index)

Returns the connected media server for the given session and connection index

IXML_Document* getRelativeTimePosition(string device)

Get the value of 'RelativeTimePosition' from Media Renderer Device.

IXML_Document* getTransportInfo(string device)

Get the value of 'TransportState' from MediaRendererDevice.

IXML_Document* getMediaInfo(string rendererUDN)

Get the value of 'CurrentURIMetaData' and 'CurrentURI' of specified Media Renderer by calling its 'GetMediaInfo' action.

bool subscribe(string udn)

Subscribe to service "urn:schemas-upnp-org:service:AVTransport:1"

void updateValues(string renderer, string timePositionValue, string transportStateValue, string TotalTrackDuration)

updates the values to client

IXML_Document* doAction(string service, map<string, string>*paramMap, string UDN, bool makeAction, string action)

Performs the UPnP Action

string getBrowseFilter(Session*session, string serverUDN)

Get Browse Filter for given session and mediaServer

string getBrowseSortCriteria(Session*session, string serverUDN)

Get BrowseSortCriteria for given session and mediaServer

bool setMute(string elementPath, bool muteState)

Set the mute for given connection

bool selectPreset(string elementPath, string presetName)

Select the preset

string getMute(string elementPath)

get the mute for given connection

string getSelectedMediaServer(Session* session)

Get the Selected Media Server for given Session

string getSelectedMediaRenderer(Session* session)

Get the Selected Media Renderer for given Session

bool getCurrentConnectionInfo(string rendererUDN, string conIndex, Session*session, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList)

Get CurrentConnectionInfo of given Renderer device.

Documentation

It provides Supports to UpnpAVLevel1TA for handling complexity. It handles most of the communication with UPnP Device.

UpnpAVLevel1SASupport(UpnpAVLevel1SA* upnpLevel1SA)

Constructor Assign the reference of UpnpAVLevel1SA and UpnpAvFacade to local variable.

Parameters:

- upnpLevel1SA an object of UpnpAVLevel1SA

list<Connection*> * getConnectionList()

Get the Connection List

Returns:

list<Connection>

map<string, string> * getRendererUDNSessionIdMap()

Get the rendererUDN Vs sessionId Map

Returns:

map<string,string>

UpnpAVLevel1SA* getUpnpLevel1SA()

Returns the UpnpAVLevel1SA Object

Returns:

UpnpAVLevel1SA Object

bool invokeCommandConnect(AbstractUISocketElement* socketElement, Session*session, Connection* connection, string indexForConnection, list<Connection*>*connectionList, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList)

Create a new dimension in set '/connection' and send updates of created dimension. Also add relative updates in returnPathList, returnValueList and returnOperationList.

Parameters:

socketElement - an object of IUISocketElement
session - an object of Session
- connection an object of Connection
String - Value of Connection Index
- connectionList a List<Connection> value
returnPathList - a List<String> of returned path
returnValueList - a List<String> of returned value
returnOperationList - a List<String> of returned operation

Returns:

whether new dimension in set 'connection' is created or not

bool setVolume(Session*session, string elementPath, string value)

Set the value of volume on the mediaRendererDevice.

Parameters:

session - an object of Session
value - a String value of 'value'
elementPath - a String value of elementPath

Returns:

whether setVolume is set successfully or not

string getVolume(Session*session, string RendererUDN)

Get the value of Volume from the media renderer.

Parameters:

session - an object of Session
String - value of Renderer UDN

Returns:

a String value of volume

string setSelectedMediaServer( Session* session, string elementPath, string reqValue, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList )

Set the value of '/mediaServers[serverUDN]/isMediaServerSelected' by requested value. Return null if the value is not set successfully else return set value.

Parameters:

session - an Object of Session
elementPath - a String value of elementPath
reqValue - a String value of requested value
returnPathList - a List<String> of returned path
returnValueList - a List<String> of returned value
returnOperationList - a List<String> of returned operation

Returns:

null if the value is not set successfully else return set value

string setSelectedMediaRenderer( Session* session, string elementPath, string reqValue, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList )

Set the value of '/mediaRenderers[rendererUDN]/isMediaServerSelected' by requested value. Return null if the value is not set successfully else return set value.

Parameters:

session - an Object of Session
elementPath - a String value of elementPath
reqValue - a String value of requested value
returnPathList - a List<String> of returned path
returnValueList - a List<String> of returned value
returnOperationList - a List<String> of returned operation

Returns:

null if the value is not set successfully else return set value

bool setSellectedNodeId(Session* session, string elementPath, string reqValue, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList)

Set the value of '/mediaServers[serverUDN]/selectedNodeId' with the argument 'value'.

Parameters:

session - an Object of Session
elementPath - a String value of elementPath
value - a String value of 'value'
returnPathList - a List<String> of returned path
returnValueList - a List<String> of returned value
returnOperationList - a List<String> of returned operation

Returns:

false if the value is not set successfully else true

bool invokeCommandNextNode( Session*session, string serverUDN, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList, string conIndex)

Jump to the next Node. Also add relative updates in returnPathList, returnValueList and returnOperationList.

Parameters:

session - an Object of Session
serverUDN - a String value of server UDN
returnPathList - a List<String> of returned path
returnValueList - a List<String> of returned value
returnOperationList - a List<String> of returned operation
conIndex - a String value of connection index

Returns:

whether jump to nextNode command performed successfully or not

bool invokeCommandPrevNode( Session*session, string serverUDN, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList, string conIndex)

Jump to the Previous Node. Also add relative updates in returnPathList, returnValueList and returnOperationList.

Parameters:

session - an Object of Session
serverUDN - a String value of serverUDN
returnPathList - a List<String> of returned path
returnValueList - a List<String> of returned value
returnOperationList - a List<String> of returned operation
conIndex - a String value of connection index

Returns:

whether jump to nextNode command performed successfully or not

bool invokeCommandParentNode( Session*session, string elementPath, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList)

Set the value of parentNode to the selectedNodeId. Also add relative updates in returnPathList, returnValueList and returnOperationList.

Parameters:

session - an Object of Session
serverUDN - a String value of serverUDN
returnPathList - a List<String> of returned path
returnValueList - a List<String> of returned value
returnOperationList - a List<String> of returned operation

Returns:

whether ParentNode command performed successfully or not

bool invokeCommandFirstChildNode(Session* session, string elementPath, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList)

Set the value of firstChildNode to the selectedNodeId. Also add relative updates in returnPathList, returnValueList and returnOperationList.

Parameters:

session - an Object of Session
elementPath - a String value of elementPath
returnPathList - a List<String> of returned path
returnValueList - a List<String> of returned value
returnOperationList - a List<String> of returned operation

Returns:

whether FirstChildNode command performed successfully or not

bool invokeCommandPlay( Session* session, Connection* connection, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList, bool flag)

Play the id Get from the Command Parameter Value of '/connections[conIndex]/transport/play/nodeToPlay'. Also add relative updates in returnPathList, returnValueList and returnOperationList.

Parameters:

session - an object of Session
- connection an object of Connection
returnPathList - a List<String> of returned path
returnValueList - a List<String> of returned value
returnOperationList - a List<String> of returned operation
flag - a boolean value

Returns:

whether play command is invoked successfully or not

bool invokeCommandPause( Connection* connection, Session* session, string conIndex, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList)

Pause the playing item. Also add relative updates in returnPathList, returnValueList and returnOperationList.

Parameters:

session - an object of Session
- connection an object of Connection
returnPathList - a List<String> of returned path
returnValueList - a List<String> of returned value
returnOperationList - a List<String> of returned operation

Returns:

whether Pause command performed successfully or not

bool invokeCommandStop(Connection* connection, Session* session, string conIndex, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList)

Stop the playing item. Also add relative updates in returnPathList, returnValueList and returnOperationList.

Parameters:

session - an object of Session
- connection an object of Connection
conIndex - String value of connection index
returnPathList - a List<String> of returned path
returnValueList - a List<String> of returned value
returnOperationList - a List<String> of returned operation

Returns:

whether Stop command performed successfully or not

bool invokeCommandNext( Session* session, Connection*connection, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList)

Jump to the next item and if transportState is PLAYING then play that item. Also add relative updates in returnPathList, returnValueList and returnOperationList.

Parameters:

session - an object of Session
- connection an object of Connection
returnPathList - a List<String> of returned path
returnValueList - a List<String> of returned value
returnOperationList - a List<String> of returned operation

Returns:

whether next command is invoked successfully or not

bool invokeCommandPrevious( Session* session, Connection*connection, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList)

Jump to the previous item and if transportState is PLAYING then play that item. Also add relative updates in returnPathList, returnValueList and returnOperationList.

Parameters:

session - an object of Session
- connection an object of Connection
returnPathList - a List<String> of returned path
returnValueList - a List<String> of returned value
returnOperationList - a List<String> of returned operation

Returns:

whether next command is invoked successfully or not

string getRendererDevice(Session* session, string index)

Returns the connected media renderer for the given session and connection index

Parameters:

Session -
string - as connection index

Returns:

renderer udn

string getServerDevice(Session* session, string index)

Returns the connected media server for the given session and connection index

Parameters:

Session -
string - as connection index

Returns:

server UDN (unique identificaiton number)

IXML_Document* getRelativeTimePosition(string device)

Get the value of 'RelativeTimePosition' from Media Renderer Device.

Parameters:

- rendererUDN a String value of rendererUDN

Returns:

a IXML_Document Object response for Relative Time Position

IXML_Document* getTransportInfo(string device)

Get the value of 'TransportState' from MediaRendererDevice.

Parameters:

- rendererUDN a String value of rendererUDN

Returns:

a IXML_Document Object response for transport state

IXML_Document* getMediaInfo(string rendererUDN)

Get the value of 'CurrentURIMetaData' and 'CurrentURI' of specified Media Renderer by calling its 'GetMediaInfo' action.

Parameters:

- rendererUDN a String value of rendererUDN

Returns:

response string for GetMediaInfo

bool subscribe(string udn)

Subscribe to service "urn:schemas-upnp-org:service:AVTransport:1"

Parameters:

string - udn of mediaRenderer.

Returns:

boolean true on success or boolean false on failure

void updateValues(string renderer, string timePositionValue, string transportStateValue, string TotalTrackDuration)

updates the values to client

Parameters:

renderer - a String Value of renderer UDN(unique identification number)
timePositionValue - a String Value of relative time position
transportStateValue - a String Value of transport state
TotalTrackDuration - a String Value of total track duration

IXML_Document* doAction(string service, map<string, string>*paramMap, string UDN, bool makeAction, string action)

Performs the UPnP Action

Parameters:

service - as String Value of sevice
paramMap - as map<string,string> which includes the UPnP specified action name and it's corresponding value
udn - String Value of media renderer UDN
makeAction - as bool specifies whether whether to make action or add action
action - as String specifying the action name

Returns:

response 'true' if action is performed successfully on device else 'false'

string getBrowseFilter(Session*session, string serverUDN)

Get Browse Filter for given session and mediaServer

Parameters:

sessin - an Session Object
serverUDN - String Value of UDN of connected media server

Returns:

String Value of browse filter

string getBrowseSortCriteria(Session*session, string serverUDN)

Get BrowseSortCriteria for given session and mediaServer

Parameters:

sessin - an Session Object
serverUDN - String UDN of connected media server

Returns:

String Value of BrowseSortCriteria

bool setMute(string elementPath, bool muteState)

Set the mute for given connection

Parameters:

elementPath - a String Value of elementPath
muteState - Boolean mute state i.e true or false

Returns:

if mute is set successfully true is returned else false is returned

bool selectPreset(string elementPath, string presetName)

Select the preset

Parameters:

elementPath - String Value of elementPath
presetName - String Value of presetName

Returns:

if selectpreset is set successfully true is returned else false is returned

string getMute(string elementPath)

get the mute for given connection

Parameters:

elementPath - a String Value of elementPath

Returns:

if mute is on true is returned else false is returned

string getSelectedMediaServer(Session* session)

Get the Selected Media Server for given Session

Parameters:

sessin - an Session Object

Returns:

String Value of UDN of Media Server

string getSelectedMediaRenderer(Session* session)

Get the Selected Media Renderer for given Session

Parameters:

sessin - an Session Object

Returns:

String Value of UDN of Media Renderer

bool getCurrentConnectionInfo(string rendererUDN, string conIndex, Session*session, list<string>* returnPathList, list<string>* returnValueList, list<string>* returnOperationList)

Get CurrentConnectionInfo of given Renderer device.

Parameters:

- rendererUDN a String Value of Renderer UDN
conIndex - a String Value of connection Index
session - an Session Object
returnPathList - a list<string> of returnPathList
returnValueList - a list<string> of returnValueList
returnOperationList - a list<string> of returnOperationList

Returns:

'true' if call is succeeded else 'false'

added for searching(added after beta1.0 release)

This class has no child classes.

Author:

Parikshit Thakur & Team, Trace R&D Center

Version:

Revision: 1.0

Alphabetic index HTML hierarchy of classes or Java