UpnpAvTun (Trace URC SDK Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

edu.wisc.trace.urcsdk.client.upnpdcps
Class UpnpAvTun

java.lang.Object
  edu.wisc.trace.urcsdk.client.upnpdcps.UpnpAvTun

All Implemented Interfaces:: IClientTun, org.cybergarage.upnp.event.EventListener

public class UpnpAvTun
extends java.lang.Object
implements IClientTun, org.cybergarage.upnp.event.EventListener
extends java.lang.Object
implements IClientTun, org.cybergarage.upnp.event.EventListener

UpnpAvTun is a sample TUN for UPnP AV devices in Flat Mode for the SDK. Presently MediaRenderers and Media Servers can be operated using this TUN with the URC framework. This tun uses upnpdcpstun.properties file to configure various Map Parameter
e.g

resourceserveruri
positionpolldelay
genapresubscriptiontime

Also other map parameters should be read from this file (map parameters from the program code will overwrite parameters from the properties file).All default values should go in the properties file, and not in the Java code.

Author:: Parikshit Thakur & team

Nested Class Summary
`class`	`UpnpAvTun.DescriptionReader` For SAX Parsing of DIDL-Lite document received from Media Server
`class`	`UpnpAvTun.MediaServerRendererPair` Maintains MediaServer-MediaRenderer pair for a particular Client
`class`	`UpnpAvTun.RendererMonitorThread` Thread to periodically monitor a running renderer.
`class`	`UpnpAvTun.RendererSubscribeThread` Thread for periodically subscribing a MediaRenderer.
`class`	`UpnpAvTun.StopRunner`

Field Summary
`protected java.util.HashMap<IClient,UpnpAvTun.MediaServerRendererPair>`	`clientMediaServerRendererPairs`
`protected java.util.logging.Logger`	`logger`
`protected java.util.HashMap<java.lang.String,TargetMirror>`	`sessionIdTargetMirrorMap`
`protected java.util.ArrayList<TargetMirror>`	`targetMirrorList`

Constructor Summary
`UpnpAvTun()` Creates instance of `UpnpAvTun`

Method Summary
`void`	`abortSession(java.lang.String sessionId)` Not supported by Upnp Targets
`void`	`acknowledgeNotification(java.lang.String sessionId, IUISocketElement socketElement)` Not supported by Upnp Targets
`boolean`	`browse(java.lang.String mediaServerUdn)` `browse` called for initial browse when Media Server is detected.
`boolean`	`browse(java.lang.String mediaServerUdn, java.lang.String searchingId, int index, boolean isCalculateTotalCount)` `browse` is used for browsing of particular index.
`boolean`	`browse(java.lang.String mediaServerUdn, java.lang.String searchingId, int index, java.lang.String browseFlag, boolean isCalculateTotalCount)` `browse` is used for browsing a particular index.
`void`	`closeSession(java.lang.String sessionId)` Called to alert the Target that the Client wants to close the session.
`void`	`configureForClient(IClient client, java.util.Map<java.lang.String,java.lang.Object> parameterMap)` Nothing specific to configure for Clients binding to this TUN
`void`	`eventNotifyReceived(java.lang.String sid, long seq, java.lang.String name, java.lang.String value)` Called by the CLink SDK for UPnP, when an event is received from a Subscribed UPnP Service
`void`	`firstChildNode(java.lang.String mediaServerUdn, java.lang.String parentNode)` `firstChildNode` called to invoke firstChildNode command.
`java.lang.Object`	`getElementState(java.lang.String sessionId, java.lang.String elementId)` Retrieve the current state of the element from the Upnp Target.
`protected UpnpAvTun.MediaServerRendererPair`	`getMediaServerRendererPairByMediaRendererSid(java.lang.String mediaRendererSid)` Returns the `MediaServerRendererPair` for requested mediaRendererSid (Subscription Id)
`protected UpnpAvTun.MediaServerRendererPair`	`getMediaServerRendererPairByMediaRendererUdn(java.lang.String mediaRendererUdn)` Returns the `MediaServerRendererPair` for requested mediaRendererUdn
`protected UpnpAvTun.MediaServerRendererPair`	`getMediaServerRendererPairByMediaServerUdn(java.lang.String mediaServerUdn)` Returns the `MediaServerRendererPair` for requested mediaServerUdn
`boolean`	`getPositionInfo(UpnpAvTun.MediaServerRendererPair mediaServerRendererPair)` Get current connection info for specified connection ID.
`java.util.List<TargetMirror>`	`getRegisteredTargets()` Returns the List of Targets discovered by this TUN
`java.lang.String`	`invokeCommandRequest(IUISocketElement socketElement)` Should be implemented by the underlying network specific layer to indicate to the target that the user has invoked a commmand.
`void`	`invokeLocator(java.lang.String locatorId, java.lang.String targetName)` Not supported by Upnp Targets
`void`	`nextNode(java.lang.String mediaServerUdn, java.lang.String parentNode)` `nextNode` called to invoke nextNode command.
`ClientSession`	`openSessionRequest(IClient client, TargetMirror target, UISocketMirror socket)` Should be implemented by the underlying network specific layer to open a new Session with the Target
`void`	`parentNode(java.lang.String mediaServerUdn, java.lang.String parentNode)` `parentNode` called to invoke parentNode command.
`void`	`pause(java.lang.String mediaRendererUdn)` `pause` called to invoke pause command.
`void`	`play(java.lang.String mediaRendererUdn)` Invoke play command on the MediaRenderer
`void`	`prevNode(java.lang.String mediaServerUdn, java.lang.String parentNode)` `prevNode` called to invoke previousNode command.
`boolean`	`setElementStateRequest(IUISocketElement element)` To set a Upnp State Variable.
`void`	`setListener(IClientTunListener clientTunListener)` Sets the listener for this ClientTun
`void`	`startMonitorThread(UpnpAvTun.MediaServerRendererPair mediaServerRendererPair)` `startMonitorThread` is used to start monitor thread which retrieves the Relative Time Position of the Track which is playing
`void`	`stopMonitorThread()` `stopMonitorThread` is used to stop monitor thread
`void`	`targetDiscarded(java.lang.String targetId)` Called when a Target unregisters itself from the network.
`void`	`targetDiscovered(java.net.URI tduri, java.lang.String targetId)` Called when a new Target is discovered on the network.
`void`	`unbindClient(IClient client)` Not necessary for UPnP DCPs, as the standard UPnP devices have no knowledge about the URC Client
`void`	`updateElementCsvList(java.lang.String sessionId, java.lang.String elementIdCsvList, java.lang.String valueCsvList)` Called when the Target sends accumulated update using CSV list
`void`	`updateElementState(java.lang.String sessionId, java.lang.String elementId, java.lang.Object elementValue)` Called when the Target updates the value of a state element.
`void`	`ustop(java.lang.String mediaRendererUdn)` `ustop` called to invoke stop command.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

logger

protected java.util.logging.Logger logger

sessionIdTargetMirrorMap

protected java.util.HashMap<java.lang.String,TargetMirror> sessionIdTargetMirrorMap

clientMediaServerRendererPairs

protected java.util.HashMap<IClient,UpnpAvTun.MediaServerRendererPair> clientMediaServerRendererPairs

targetMirrorList

protected java.util.ArrayList<TargetMirror> targetMirrorList

Constructor Detail

UpnpAvTun

public UpnpAvTun()

Creates instance of UpnpAvTun

Method Detail