class UpnpAVLevel1SA

Maintain Sessions opened with 'http://resmyurcorg/upnp/av/play-1uis' Socket.

Public Methods

[more] UpnpAVLevel1SA(TargetDescription* target, ITAListener* taListener)
Basic constructor
[more]list<Connection*> * getConnectionList()
Get List of ConnectionList
[more]void sessionOpened(string targetId, string sessionId, string socketName, map<string, string>* clientProps, map<string, void*>* targetProps)
Create a new Session for this request.
[more]map<string, list<string>*> * setValuesRequest(string sessionId, bool isValidated, list<string>* paths, list<string>* operations, list<string>* reqValues)
Set the value/state of IUISocketElement specified by 'paths'.
[more]void eventNotification(string sid, string changes)
It is called from UpnpAvTAFacade when any eventNotification is received.
[more]map<string, string> * getValues(string sessionId, list<string>* paths, list<bool>* includeSets)
Get the value/state of the IUISocketElements of specified by 'paths'.
[more]void updateValues(list<string>* sessionIds, list<string>* paths, list<string>* operations, list<string>* values, list<bool>* hasDynRes)
Updates the client
[more]list<string> * getDynSocketElementIds(string socketName)
Get Dynamic socket elements for given socket
[more]void sessionClosed(string sessionId)
Cleanup the related information about the session specified by 'sessionId'.
[more]list<string> * getSessionIds()
Get List of SessionIds which are opened with specified Socket.
[more]string getSocketName(string sessionId)
Get a String value of socketName
[more]void AddSessionsAndUpdate(string renderer, string timePositionValue, string transportStateValue, string TotalTrackDuration)
Add the session who has connection with given renderer
[more]void registerTarget(map<string, void*>* targetProps)
Register Target Adapter with specified target properties.
[more]void unregisterTarget(string targetId)
Called when target has been disappeared from the network.
[more]string setSelectedMediaServer( Session* session, string elementPath, string reqValue )
Set the value of '/mediaServers[serverUDN]/isMediaServerSelected' by requested value.
[more]string setSelectedMediaRenderer( Session* session, string elementPath, string reqValue )
Set the value of '/mediaRenderers[rendererUDN]/isMediaServerSelected' by requested value.
[more]list<list<string>*> * getIndices(string sessionId, list<string>*eltIds, list<string>*indexNos)
Get IndexNames available on specific level of dimension of dimensional Element.
[more]bool isUnImplemented(string elementPath)
Returns true if socket element is implement in TA else returns false
[more]map<string, string> * getRendererUDNSessionIdMap()
Get the rendererUDN Vs sessionId Map
[more]list<Session*> * getSessionList()
Get the session list for UPnP AV LEVEL1 Adapter
[more]void updateConnectionElements(map<string, string>*rendererUpdates)
Updates every connections for UPnP AV LEVEL1 Adapter.
[more]void updateRendererElements(map<string, string>*rendererUpdates)
Updates every connections for UPnP AV LEVEL1 Adapter.
[more]void addAllMediaDevices(Session*session)
This function will all available UPnP device to session List

Documentation

Maintain Sessions opened with 'http:resmyurcorg/upnp/av/play-1uis' Socket. Also communicate with Upnp Device(MediaServer and MediaRenderer) and maintain state of those devices.

o UpnpAVLevel1SA(TargetDescription* target, ITAListener* taListener)
Basic constructor
Parameters:
- target as TargetDescription Object
- taListener as ITAListener Object

olist<Connection*> * getConnectionList()
Get List of ConnectionList
Returns:
a List<Connection>

ovoid sessionOpened(string targetId, string sessionId, string socketName, map<string, string>* clientProps, map<string, void*>* targetProps)
Create a new Session for this request. Create a dimensions for /mediaRenderer[UDN] and /mediaServer[UDN].

Parameters:
targetId - a String value of targetId
sessionId - a String value of sessionId
socketName - a String value of socketName
clientProps - a Map<String, String> value of Client Properties
targetProps - a Map<String, Object> value of Target Properties @throws TAFatalException

omap<string, list<string>*> * setValuesRequest(string sessionId, bool isValidated, list<string>* paths, list<string>* operations, list<string>* reqValues)
Set the value/state of IUISocketElement specified by 'paths'. Also change the state of UPnP Device according to the IUISocketElements specified by 'paths'.

Parameters:
sessionId - a String value of sessionId
paths - a List<String> of paths
operations - a List<String> of operations
reqValues - a List<String> of requested values
Returns:
a Map<String, List<String>> of values @throws TAFatalException

ovoid eventNotification(string sid, string changes)
It is called from UpnpAvTAFacade when any eventNotification is received.

Parameters:
sid - a String value of the subscriptionId
changes - XML string

omap<string, string> * getValues(string sessionId, list<string>* paths, list<bool>* includeSets)
Get the value/state of the IUISocketElements of specified by 'paths'.

Parameters:
sessionId - a String value of sessionId
paths - a List<String> of paths
Returns:
a Map<String, String> of values @throws TAFatalException

ovoid updateValues(list<string>* sessionIds, list<string>* paths, list<string>* operations, list<string>* values, list<bool>* hasDynRes)
Updates the client
Parameters:
sessionIds - List<String> of updated session ids
paths - a List<String> of updated paths
values - List<String> of updated values
operations - List<String> of operations
hasDynRes - List<String> of dynamic resource

olist<string> * getDynSocketElementIds(string socketName)
Get Dynamic socket elements for given socket
Parameters:
socketName - String Value of socket name
Returns:
List<string> of socket elements

ovoid sessionClosed(string sessionId)
Cleanup the related information about the session specified by 'sessionId'.

Parameters:
sessionId - a String value of sessionId @throws TAFatalException

olist<string> * getSessionIds()
Get List of SessionIds which are opened with specified Socket.

Returns:
a List<String> of sessionId

ostring getSocketName(string sessionId)
Get a String value of socketName
Parameters:
sessionId - String Value of sessionId
Returns:
a String value of socketName

ovoid AddSessionsAndUpdate(string renderer, string timePositionValue, string transportStateValue, string TotalTrackDuration)
Add the session who has connection with given renderer
Parameters:
renderer - String Value of renderer UDN
timePositionValue - String Value of current time position
transportStateValue - String Value of current transport state
TotalTrackDuration - String Value of total track duration of current track

ovoid registerTarget(map<string, void*>* targetProps)
Register Target Adapter with specified target properties.
Parameters:
targetProps - as Map<String, Object> object containing properties like device UDN(unique identification), friendly name, device type, etc @throws TAException @throws TAFatalException

ovoid unregisterTarget(string targetId)
Called when target has been disappeared from the network.

Parameters:
targetId - a String value of targetId @throws TAFatalException

ostring setSelectedMediaServer( Session* session, string elementPath, string reqValue )
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
Returns:
null if the value is not set successfully else return set value

ostring setSelectedMediaRenderer( Session* session, string elementPath, string reqValue )
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
Returns:
null if the value is not set successfully else return set value

olist<list<string>*> * getIndices(string sessionId, list<string>*eltIds, list<string>*indexNos)
Get IndexNames available on specific level of dimension of dimensional Element.

Parameters:
sessionId - a String value of sessionId
eltIds - a List<String> of elementIds
indexNos - a List<String> of indexNos
Returns:
a List<Set<String>> value

obool isUnImplemented(string elementPath)
Returns true if socket element is implement in TA else returns false
Parameters:
elementPath - as String Value of elementPath
Returns:
'true' if element path is unImplemented else 'false'

omap<string, string> * getRendererUDNSessionIdMap()
Get the rendererUDN Vs sessionId Map
Returns:
map<string,string>

olist<Session*> * getSessionList()
Get the session list for UPnP AV LEVEL1 Adapter
Returns:
List<session> containing list of Sessions

ovoid updateConnectionElements(map<string, string>*rendererUpdates)
Updates every connections for UPnP AV LEVEL1 Adapter. This method is called by UpnpAVFacade. UpnpAVFacade will fetch the necessary updates from Media renderer and will call this function.
Parameters:
rendererUpdates - a Map<string,string> containing following parameter from the media renderer rendererUDN transportState trackDuration relativeTimePosition title currentURIMetaData currentTrackURI isPlayAvailable isStopAvailable isPauseAvailable

ovoid updateRendererElements(map<string, string>*rendererUpdates)
Updates every connections for UPnP AV LEVEL1 Adapter. This method is called by UpnpAVFacade. UpnpAVFacade will fetch the volume and mute status from Media renderer and will call this function.
Parameters:
rendererUpdates - a Map<string,string> containing following parameter from the media renderer rendererUDN volume mute

ovoid addAllMediaDevices(Session*session)
This function will all available UPnP device to session List
Parameters:
session - a Session Object

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


This page was generated with the help of DOC++.