A client facade to the upnp lookup and access framework. More...

Inheritance diagram for de.yaacc.upnp.UpnpClient:

Collaboration diagram for de.yaacc.upnp.UpnpClient:

Classes
class	LocalDummyDevice

Public Member Functions
	UpnpClient (Context context)

boolean	initialize (Context context)
	Initialize the Object.

boolean	startService ()

void	onServiceConnected (ComponentName className, IBinder service)

YaaccUpnpServerService	getYaaccUpnpServerService ()

void	onServiceDisconnected (ComponentName componentName)

void	remoteDeviceDiscoveryStarted (Registry registry, RemoteDevice remotedevice)

void	remoteDeviceDiscoveryFailed (Registry registry, RemoteDevice remotedevice, Exception exception)

void	remoteDeviceAdded (Registry registry, RemoteDevice remotedevice)

void	remoteDeviceUpdated (Registry registry, RemoteDevice remotedevice)

void	remoteDeviceRemoved (Registry registry, RemoteDevice remotedevice)

void	localDeviceAdded (Registry registry, LocalDevice localdevice)

void	localDeviceRemoved (Registry registry, LocalDevice localdevice)

void	beforeShutdown (Registry registry)

void	afterShutdown ()

Service<?, ?>	getAVTransportService (Device<?, ?, ?> device)
	Returns a Service of type AVTransport.

Service<?, ?>	getRenderingControlService (Device<?, ?, ?> device)
	Returns a Service of type RenderingControl.

void	addUpnpClientListener (UpnpClientListener listener)
	Add an listener.

void	removeUpnpClientListener (UpnpClientListener listener)
	Removes a listener added with `addUpnpClientListener(UpnpClientListener)`, so a destroyed screen is no longer called.

Collection< Device<?, ?, ?> >	getDevices ()
	Returns all registered UpnpDevices.

Collection< Device<?, ?, ?> >	getDevicesProvidingContentDirectoryService ()
	Returns all registered UpnpDevices with a ContentDirectory Service.

Collection< Device<?, ?, ?> >	getDevicesProvidingAvTransportService ()
	Returns all registered UpnpDevices with an AVTransport Service, and those that offer an OpenHome playlist without one.

Device<?, ?, ?>	getDevice (String identifier)
	Returns a registered UpnpDevice.

boolean	isInitialized ()
	True if the client is initialized.

Registry	getRegistry ()
	Returns the upnp registry.

Context	getContext ()

ContentDirectoryBrowseResult	browseSync (Position pos)
	Browse ContenDirctory synchronous.

ContentDirectoryBrowseResult	browseSync (Position pos, Long firstResult, Long maxResult, SortCriterion... orderBy)

ContentDirectoryBrowseResult	browseSync (Device<?, ?, ?> device, String objectID, BrowseFlag flag, String filter, long firstResult, Long maxResults, SortCriterion... orderBy)
	Browse ContenDirctory synchronous.

HttpRequestSender	getHttpRequestSender ()

void	addNetworkRecoveryListener (NetworkRecoveryListener listener)
	Registers for "the network is back" (see `NetworkRecoveryListener`).

void	removeNetworkRecoveryListener (NetworkRecoveryListener listener)

NetworkRecoveryListener	getNetworkRecoveryRelay ()

void	searchDevices ()
	Search asynchronously for all devices.

void	refreshAfterResume ()
	A browser screen came back to the foreground, maybe after the device or the app was suspended (screen off, Doze, a long time in the background): checks the network listener and searches the devices again if the last search is not recent.

Player	attachOpenHomePlayer (Device<?, ?, ?> device)
	Returns all player instances initialized with the given didl object.

List< Player >	initializePlayers (DIDLObject didlObject)

List< Player >	initializePlayers (List< Item > items)
	Returns all player instances initialized with the given didl object.

List< Player >	initializePlayers (AvTransport transport)
	Returns all player instances initialized with the given transport object.

Player	initializeLocalPlayer (List< PlayableItem > items)
	Creates a player on this device for the items (the OpenHome renderer's queue); not started.

Collection< Player >	getCurrentPlayers ()
	Returns all current player instances.

void	addPlayerListChangeListener (PlayerListChangeNotifier.Listener listener)
	Registers a listener for players being added to or removed from the player service; see `PlayerService#addPlayerListChangeListener`.

void	removePlayerListChangeListener (PlayerListChangeNotifier.Listener listener)

long	getPlayerCreationSequence (Player player)
	Creation sequence of an active player (higher = added later), or 0 if the player isn't active or the player service isn't bound.

List< Player >	getCurrentPlayers (AvTransport transport)
	Returns all current player instances for the given transport object.

List< Item >	toItemList (DIDLContent didlContent)
	returns a list of all items including items in containers for the given didlContent

List< Item >	toItemList (DIDLObject didlObject)
	Converts the content of a didlObject into a list of cling items.

Set< String >	getReceiverDeviceIds ()
	Gets the receiver IDs, if none is defined the local device will be returned.

void	setReceiverDeviceIds (Set< String > receiverDeviceIds)
	Set the list of receiver device ids.

Collection< Device<?, ?, ?> >	getReceiverDevices ()
	Returns the receiverIds stored in the preferences.

Collection< Device<?, ?, ?> >	awaitReceiverDevices ()
	Like `getReceiverDevices()`, but first gives a selected receiver that is not in the registry right now a few seconds to come back (`ReceiverAvailabilityPolicy`: three looks, 2.5 s apart, a search before each wait).

void	clearReceiverDevices ()
	Clears the receiver selection: the stored set becomes empty (and stays empty, it is not replaced by the local device) and a "receiver removed" event is fired for every receiver that was selected, so views that follow the selection refresh.

int	getReceiverDevicesReadyCount ()

void	setReceiverDevices (Collection< Device<?, ?, ?> > receiverDevices)
	set the receiverDevices to the devices in the given collection.

void	addReceiverDevice (Device<?, ?, ?> receiverDevice)
	add a receiver device

void	removeReceiverDevice (Device<?, ?, ?> receiverDevice)
	remove a receiver device

String	getProviderDeviceId ()

Device<?, ?, ?>	getProviderDevice ()

void	setProviderDevice (Device<?, ?, ?> provider)

void	shutdown ()
	Shutdown the upnp client and all players.

int	getDefaultDuration ()
	Return the configured default duration.

int	getSilenceDuration ()
	Return the configured silence duration.

boolean	isMute ()
	returns the mute state

void	setMute (boolean mute)
	set the mute state

int	getVolume ()
	returns the current volume level

void	setVolume (int desired)
	set the volume in the range of 0-100

void	downloadItem (DIDLObject selectedDIDLObject)

List< Player >	initializePlayersWithPlayableItems (List< PlayableItem > items)

List< Player >	initializeQueuePlayers (de.yaacc.share.PickedQueue.Result queue)
	Creates the players of a picked queue on the stored receiver selection (one player per receiver and media type, see `PlayerService#createQueuePlayers`); worker thread.

boolean	getMute (Device<?, ?, ?> device)

boolean	hasActionGetMute (Device<?, ?, ?> device)

void	setMute (Device<?, ?, ?> device, boolean mute)

int	getVolume (Device<?, ?, ?> device)

boolean	hasActionGetVolume (Device<?, ?, ?> device)

void	setVolume (Device<?, ?, ?> device, int volume)

boolean	hasActionSetVolume (Service<?, ?> service)

Optional< Player >	getPlayer (int id)

void	addToPlaylist (DIDLObject item)
	Adds the item to the chosen receivers: the playlist of a receiver that already has a player gets it, a receiver without a player gets a new one (see `PlaylistTargets`).

PlayableItem	createPlayableItem (Uri uri) throws IOException
	Makes the item for a shared http(s) link (shared text).

PlayableItem	createPlayableItem (Uri uri, Set< String > receiverIds) throws IOException
	Same as `createPlayableItem(Uri)`, with the receivers the share is made for given explicitly: the addresses a proxied link is served to are built from exactly these ids, never from the stored selection, which another action may have replaced or cleared during the network work.

void	discardShareOf (PlayableItem item)
	Gives up the share an item was made for (no player took it): removes its registry key, which closes the source of a file.

boolean	isHttpServerRunning ()
	Whether the local HTTP server accepts connections (it runs whenever the app process lives, whatever the "local server" setting says).

boolean	isPlayerServiceInitialized ()

Public Member Functions inherited from de.yaacc.upnp.registry.RegistryListener

Static Public Attributes
static String	LOCAL_UID = "LOCAL_UID"

Detailed Description

A client facade to the upnp lookup and access framework.

This class provides all services to manage devices.

Author: Tobias Schoene (TheOpenBit)

Member Function Documentation

◆ addNetworkRecoveryListener()

void de.yaacc.upnp.UpnpClient.addNetworkRecoveryListener ( NetworkRecoveryListener listener )

Registers for "the network is back" (see NetworkRecoveryListener).

Held weakly: the caller keeps the listener and calls removeNetworkRecoveryListener when it stops.

◆ addPlayerListChangeListener()

void de.yaacc.upnp.UpnpClient.addPlayerListChangeListener ( PlayerListChangeNotifier.Listener listener )

Registers a listener for players being added to or removed from the player service; see PlayerService#addPlayerListChangeListener.

Works before the service is bound: the listener is attached once it is. Callers must call removePlayerListChangeListener when done.

Referenced by de.yaacc.upnp.UpnpClient.initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addReceiverDevice()

void de.yaacc.upnp.UpnpClient.addReceiverDevice ( Device<?, ?, ?> receiverDevice )

add a receiver device

Parameters

receiverDevice receiverDevice

Here is the call graph for this function:

◆ addUpnpClientListener()

void de.yaacc.upnp.UpnpClient.addUpnpClientListener ( UpnpClientListener listener )

Add an listener.

Parameters

listener the listener to be added

◆ afterShutdown()

void de.yaacc.upnp.UpnpClient.afterShutdown ( )

Implements de.yaacc.upnp.registry.RegistryListener.

◆ attachOpenHomePlayer()

Player de.yaacc.upnp.UpnpClient.attachOpenHomePlayer ( Device<?, ?, ?> device )

Returns all player instances initialized with the given didl object.

Parameters

didlObject the object which describes the content to be played

Returns: the player The player of an OpenHome device that plays already, for its playlist screen: the device keeps its queue, the player only shows it. Starts the player service when it is not running (it is only started when something is played), and waits for it: not for the main thread.; the player, null if the player service did not come up

Here is the call graph for this function:

◆ awaitReceiverDevices()

Collection< Device<?, ?, ?> > de.yaacc.upnp.UpnpClient.awaitReceiverDevices ( )

Like getReceiverDevices(), but first gives a selected receiver that is not in the registry right now a few seconds to come back (ReceiverAvailabilityPolicy: three looks, 2.5 s apart, a search before each wait).

After a suspend the registry may have dropped the renderer; getReceiverDevices() would remove it from the stored selection for good. What is still missing after the last look is dropped as before.

Waits, so worker threads only; on the main thread it does not wait.

Referenced by de.yaacc.upnp.UpnpClient.addToPlaylist(), de.yaacc.player.PlayerService.createPlayer(), and de.yaacc.upnp.UpnpClient.initializeQueuePlayers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ beforeShutdown()

void de.yaacc.upnp.UpnpClient.beforeShutdown ( Registry registry )

Implements de.yaacc.upnp.registry.RegistryListener.

◆ browseSync() [1/2]

ContentDirectoryBrowseResult de.yaacc.upnp.UpnpClient.browseSync	(	Device<?, ?, ?>	device,
		String	objectID,
		BrowseFlag	flag,
		String	filter,
		long	firstResult,
		Long	maxResults,
		SortCriterion...	orderBy )

Browse ContenDirctory synchronous.

Parameters

device	the device to be browsed
objectID	the browsing root
flag	kind of browsing

See also: BrowseFlag

Parameters

filter	a filter
firstResult	first result
maxResults	max result count
orderBy	sorting criteria

See also: SortCriterion

Returns: the browsing result

Here is the call graph for this function:

◆ browseSync() [2/2]

ContentDirectoryBrowseResult de.yaacc.upnp.UpnpClient.browseSync ( Position pos )

Browse ContenDirctory synchronous.

Parameters

pos	Position the device and object to be browsed

Returns: the browsing result

◆ clearReceiverDevices()

void de.yaacc.upnp.UpnpClient.clearReceiverDevices ( )

Clears the receiver selection: the stored set becomes empty (and stays empty, it is not replaced by the local device) and a "receiver removed" event is fired for every receiver that was selected, so views that follow the selection refresh.

Does nothing to running players or to the allowed set of an existing share (that was fixed when the share was registered).

Here is the call graph for this function:

◆ createPlayableItem() [1/2]

PlayableItem de.yaacc.upnp.UpnpClient.createPlayableItem ( Uri uri ) throws IOException

Makes the item for a shared http(s) link (shared text).

Worker thread only: it reads the link's metadata over the network and, with the media proxy option on, registers the link with the share registry.

The media type comes from the metadata reader; if that fails it comes from a bounded HTTP HEAD (concrete audio, video or image type); only if that fails too the link is assumed to be an image, as before, and a payload-free line says so. With the proxy option on a target the phone must not fetch (loopback, link-local, this phone's own address, see LinkTargetPolicy) is refused. Nothing here logs the link or the exceptions' text.

Returns: the item, or null if the link is refused (the caller plays nothing)

Referenced by de.yaacc.upnp.UpnpClient.createPlayableItem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createPlayableItem() [2/2]

PlayableItem de.yaacc.upnp.UpnpClient.createPlayableItem	(	Uri	uri,
		Set< String >	receiverIds ) throws IOException

Same as createPlayableItem(Uri), with the receivers the share is made for given explicitly: the addresses a proxied link is served to are built from exactly these ids, never from the stored selection, which another action may have replaced or cleared during the network work.

Parameters

receiverIds the receivers chosen for this share, captured at confirm time

Here is the call graph for this function:

◆ discardShareOf()

void de.yaacc.upnp.UpnpClient.discardShareOf ( PlayableItem item )

Gives up the share an item was made for (no player took it): removes its registry key, which closes the source of a file.

Does nothing for an item without a proxy URL. Never throws.

Here is the call graph for this function:

◆ getAVTransportService()

Service<?, ?> de.yaacc.upnp.UpnpClient.getAVTransportService ( Device<?, ?, ?> device )

Returns a Service of type AVTransport.

Parameters

device the device which provides the service

Returns: the service of null

◆ getContext()

Context de.yaacc.upnp.UpnpClient.getContext ( )

Returns: the context

Here is the caller graph for this function:

◆ getCurrentPlayers() [1/2]

Collection< Player > de.yaacc.upnp.UpnpClient.getCurrentPlayers ( )

Returns all current player instances.

Returns: the player

Referenced by de.yaacc.upnp.UpnpClient.addToPlaylist(), de.yaacc.upnp.server.openhome.AndroidOpenHomeHost.isAlive(), and de.yaacc.upnp.server.avtransport.AvTransportMediaRendererPaused.seek().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentPlayers() [2/2]

List< Player > de.yaacc.upnp.UpnpClient.getCurrentPlayers ( AvTransport transport )

Returns all current player instances for the given transport object.

Parameters

transport the object which describes the content to be played

Returns: the player

Here is the call graph for this function:

◆ getDefaultDuration()

int de.yaacc.upnp.UpnpClient.getDefaultDuration ( )

Return the configured default duration.

Returns: the duration

Referenced by de.yaacc.upnp.UpnpClient.getCurrentPlayers(), and de.yaacc.upnp.server.openhome.AndroidOpenHomeHost.toPlayableItem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDevice()

Device<?, ?, ?> de.yaacc.upnp.UpnpClient.getDevice ( String identifier )

Returns a registered UpnpDevice.

Returns: the upnpDevice null if not found

Referenced by de.yaacc.player.PlayerService.createPlayerForLocalDevice(), de.yaacc.upnp.UpnpClient.getProviderDevice(), de.yaacc.upnp.UpnpClient.getReceiverDevices(), and de.yaacc.share.ShareAddressResolver.resolve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDevices()

Collection< Device<?, ?, ?> > de.yaacc.upnp.UpnpClient.getDevices ( )

Returns all registered UpnpDevices.

Returns: the upnpDevices

Referenced by de.yaacc.upnp.UpnpClient.getDevices(), de.yaacc.upnp.UpnpClient.getDevicesProvidingAvTransportService(), and de.yaacc.upnp.UpnpClient.getDevicesProvidingContentDirectoryService().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDevicesProvidingAvTransportService()

Collection< Device<?, ?, ?> > de.yaacc.upnp.UpnpClient.getDevicesProvidingAvTransportService ( )

Returns all registered UpnpDevices with an AVTransport Service, and those that offer an OpenHome playlist without one.

Returns: the upnpDevices

Here is the call graph for this function:

◆ getDevicesProvidingContentDirectoryService()

Collection< Device<?, ?, ?> > de.yaacc.upnp.UpnpClient.getDevicesProvidingContentDirectoryService ( )

Returns all registered UpnpDevices with a ContentDirectory Service.

Returns: the upnpDevices

Here is the call graph for this function:

◆ getHttpRequestSender()

HttpRequestSender de.yaacc.upnp.UpnpClient.getHttpRequestSender ( )

Returns: the sender of the server service's network listener, or null when there is none (yet): no service bound, the listener not created or no network came up since the start

Referenced by de.yaacc.upnp.UpnpClient.browseSync(), de.yaacc.player.OpenHomePlayer.createControl(), and de.yaacc.player.AVTransportPlayer.getHttpRequestSender().

Here is the caller graph for this function:

◆ getNetworkRecoveryRelay()

NetworkRecoveryListener de.yaacc.upnp.UpnpClient.getNetworkRecoveryRelay ( )

Returns: the listener the server service registers at its network listener, it passes the "network is back" on to the listeners added with addNetworkRecoveryListener

◆ getProviderDevice()

Device<?, ?, ?> de.yaacc.upnp.UpnpClient.getProviderDevice ( )

Returns: the provider device

Here is the call graph for this function:

◆ getProviderDeviceId()

String de.yaacc.upnp.UpnpClient.getProviderDeviceId ( )

Returns: the providerDeviceId

Referenced by de.yaacc.upnp.UpnpClient.getProviderDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getReceiverDeviceIds()

Set< String > de.yaacc.upnp.UpnpClient.getReceiverDeviceIds ( )

Gets the receiver IDs, if none is defined the local device will be returned.

Returns: the receiverDeviceIds, a copy the caller may modify (the set that SharedPreferences.getStringSet returns must never be changed); an empty stored set stays empty

Referenced by de.yaacc.upnp.UpnpClient.createPlayableItem(), de.yaacc.upnp.UpnpClient.getReceiverDevices(), and de.yaacc.share.ShareAddressResolver.resolve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getReceiverDevices()

Collection< Device<?, ?, ?> > de.yaacc.upnp.UpnpClient.getReceiverDevices ( )

Returns the receiverIds stored in the preferences.

If an receiver id is unknown it will be removed.

Returns: the receiverDevices

Referenced by de.yaacc.upnp.UpnpClient.addReceiverDevice(), de.yaacc.upnp.UpnpClient.awaitReceiverDevices(), de.yaacc.upnp.UpnpClient.clearReceiverDevices(), and de.yaacc.upnp.UpnpClient.removeReceiverDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRegistry()

Registry de.yaacc.upnp.UpnpClient.getRegistry ( )

Returns the upnp registry.

Returns: the registry

Referenced by de.yaacc.upnp.UpnpClient.getDevice(), de.yaacc.upnp.UpnpClient.getDevices(), de.yaacc.upnp.UpnpClient.getDevicesProvidingAvTransportService(), and de.yaacc.upnp.UpnpClient.getDevicesProvidingContentDirectoryService().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRenderingControlService()

Service<?, ?> de.yaacc.upnp.UpnpClient.getRenderingControlService ( Device<?, ?, ?> device )

Returns a Service of type RenderingControl.

Parameters

device the device which provides the service

Returns: the service of null

◆ getSilenceDuration()

int de.yaacc.upnp.UpnpClient.getSilenceDuration ( )

Return the configured silence duration.

Returns: the duration

Referenced by de.yaacc.player.AbstractPlayer.getSilenceDuration().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getVolume()

int de.yaacc.upnp.UpnpClient.getVolume ( )

returns the current volume level

Returns: the value in the range of 0-100

Here is the call graph for this function:

◆ initialize()

boolean de.yaacc.upnp.UpnpClient.initialize ( Context context )

Initialize the Object.

Parameters

context the context

Returns: true if initialization completes correctly

Here is the call graph for this function:

◆ initializeLocalPlayer()

Player de.yaacc.upnp.UpnpClient.initializeLocalPlayer ( List< PlayableItem > items )

Creates a player on this device for the items (the OpenHome renderer's queue); not started.

Returns: the player, null if the player service is not there

Referenced by de.yaacc.upnp.server.openhome.AndroidOpenHomeHost.createPlayer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initializePlayers() [1/2]

List< Player > de.yaacc.upnp.UpnpClient.initializePlayers ( AvTransport transport )

Returns all player instances initialized with the given transport object.

Parameters

transport the object which describes the content to be played

Returns: the player

Here is the call graph for this function:

◆ initializePlayers() [2/2]

List< Player > de.yaacc.upnp.UpnpClient.initializePlayers ( List< Item > items )

Returns all player instances initialized with the given didl object.

Parameters

items the items to be played

Returns: the player

Here is the call graph for this function:

◆ initializeQueuePlayers()

List< Player > de.yaacc.upnp.UpnpClient.initializeQueuePlayers ( de.yaacc.share.PickedQueue.Result queue )

Creates the players of a picked queue on the stored receiver selection (one player per receiver and media type, see PlayerService#createQueuePlayers); worker thread.

Not started.

Here is the call graph for this function:

◆ isHttpServerRunning()

boolean de.yaacc.upnp.UpnpClient.isHttpServerRunning ( )

Whether the local HTTP server accepts connections (it runs whenever the app process lives, whatever the "local server" setting says).

A short loopback connect: call it only off the main thread. See HttpServerProbe.

Here is the call graph for this function:

◆ isInitialized()

boolean de.yaacc.upnp.UpnpClient.isInitialized ( )

True if the client is initialized.

Returns: true or false

Referenced by de.yaacc.upnp.UpnpClient.getDevice(), de.yaacc.upnp.UpnpClient.getDevices(), de.yaacc.upnp.UpnpClient.getDevicesProvidingAvTransportService(), de.yaacc.upnp.UpnpClient.getDevicesProvidingContentDirectoryService(), de.yaacc.upnp.UpnpClient.getRegistry(), and de.yaacc.upnp.UpnpClient.searchDevices().

Here is the caller graph for this function:

◆ isMute()

boolean de.yaacc.upnp.UpnpClient.isMute ( )

returns the mute state

Returns: the state

Here is the call graph for this function:

◆ localDeviceAdded()

void de.yaacc.upnp.UpnpClient.localDeviceAdded	(	Registry	registry,
		LocalDevice	localdevice )

Implements de.yaacc.upnp.registry.RegistryListener.

◆ localDeviceRemoved()

void de.yaacc.upnp.UpnpClient.localDeviceRemoved	(	Registry	registry,
		LocalDevice	localdevice )

Implements de.yaacc.upnp.registry.RegistryListener.

◆ refreshAfterResume()

void de.yaacc.upnp.UpnpClient.refreshAfterResume ( )

A browser screen came back to the foreground, maybe after the device or the app was suspended (screen off, Doze, a long time in the background): checks the network listener and searches the devices again if the last search is not recent.

Does its work on the client's executor and returns at once.

◆ remoteDeviceAdded()

void de.yaacc.upnp.UpnpClient.remoteDeviceAdded	(	Registry	registry,
		RemoteDevice	remotedevice )

Implements de.yaacc.upnp.registry.RegistryListener.

◆ remoteDeviceDiscoveryFailed()

void de.yaacc.upnp.UpnpClient.remoteDeviceDiscoveryFailed	(	Registry	registry,
		RemoteDevice	remotedevice,
		Exception	exception )

Implements de.yaacc.upnp.registry.RegistryListener.

◆ remoteDeviceDiscoveryStarted()

void de.yaacc.upnp.UpnpClient.remoteDeviceDiscoveryStarted	(	Registry	registry,
		RemoteDevice	remotedevice )

Implements de.yaacc.upnp.registry.RegistryListener.

◆ remoteDeviceRemoved()

void de.yaacc.upnp.UpnpClient.remoteDeviceRemoved	(	Registry	registry,
		RemoteDevice	remotedevice )

Implements de.yaacc.upnp.registry.RegistryListener.

◆ remoteDeviceUpdated()

void de.yaacc.upnp.UpnpClient.remoteDeviceUpdated	(	Registry	registry,
		RemoteDevice	remotedevice )

Implements de.yaacc.upnp.registry.RegistryListener.

◆ removeReceiverDevice()

void de.yaacc.upnp.UpnpClient.removeReceiverDevice ( Device<?, ?, ?> receiverDevice )

remove a receiver device

Parameters

receiverDevice receiverDevice

Here is the call graph for this function:

◆ removeUpnpClientListener()

void de.yaacc.upnp.UpnpClient.removeUpnpClientListener ( UpnpClientListener listener )

Removes a listener added with addUpnpClientListener(UpnpClientListener), so a destroyed screen is no longer called.

Removes one registration; does nothing if the listener is not registered.

Parameters

listener the listener to be removed

◆ setMute()

void de.yaacc.upnp.UpnpClient.setMute ( boolean mute )

set the mute state

Parameters

mute the state

Here is the call graph for this function:

◆ setReceiverDeviceIds()

void de.yaacc.upnp.UpnpClient.setReceiverDeviceIds ( Set< String > receiverDeviceIds )

Set the list of receiver device ids.

Parameters

receiverDeviceIds the device ids.

Referenced by de.yaacc.upnp.UpnpClient.clearReceiverDevices(), de.yaacc.upnp.UpnpClient.getReceiverDevices(), de.yaacc.upnp.UpnpClient.setReceiverDevices(), and de.yaacc.browser.ContentListFragment.startPlayAction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setReceiverDevices()

void de.yaacc.upnp.UpnpClient.setReceiverDevices ( Collection< Device<?, ?, ?> > receiverDevices )

set the receiverDevices to the devices in the given collection.

Parameters

receiverDevices the devices

Referenced by de.yaacc.upnp.UpnpClient.addReceiverDevice(), and de.yaacc.upnp.UpnpClient.removeReceiverDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setVolume()

void de.yaacc.upnp.UpnpClient.setVolume ( int desired )

set the volume in the range of 0-100

Parameters

desired volume

Here is the call graph for this function:

◆ toItemList() [1/2]

List< Item > de.yaacc.upnp.UpnpClient.toItemList ( DIDLContent didlContent )

returns a list of all items including items in containers for the given didlContent

Parameters

didlContent the content

Returns: all items included in the content

Referenced by de.yaacc.upnp.UpnpClient.addToPlaylist(), de.yaacc.upnp.UpnpClient.toItemList(), and de.yaacc.upnp.UpnpClient.toItemList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toItemList() [2/2]

List< Item > de.yaacc.upnp.UpnpClient.toItemList ( DIDLObject didlObject )

Converts the content of a didlObject into a list of cling items.

Parameters

didlObject the content

Returns: the list of cling items

Here is the call graph for this function:

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

/github/workspace/yaacc/src/main/java/de/yaacc/upnp/UpnpClient.java

Classes

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ addNetworkRecoveryListener()

◆ addPlayerListChangeListener()

◆ addReceiverDevice()

◆ addUpnpClientListener()

◆ afterShutdown()

◆ attachOpenHomePlayer()

◆ awaitReceiverDevices()

◆ beforeShutdown()

◆ browseSync() [1/2]

◆ browseSync() [2/2]

◆ clearReceiverDevices()

◆ createPlayableItem() [1/2]

◆ createPlayableItem() [2/2]

◆ discardShareOf()

◆ getAVTransportService()

◆ getContext()

◆ getCurrentPlayers() [1/2]

◆ getCurrentPlayers() [2/2]

◆ getDefaultDuration()

◆ getDevice()

◆ getDevices()

◆ getDevicesProvidingAvTransportService()

◆ getDevicesProvidingContentDirectoryService()

◆ getHttpRequestSender()

◆ getNetworkRecoveryRelay()

◆ getProviderDevice()

◆ getProviderDeviceId()

◆ getReceiverDeviceIds()

◆ getReceiverDevices()

◆ getRegistry()

◆ getRenderingControlService()

◆ getSilenceDuration()

◆ getVolume()

◆ initialize()

◆ initializeLocalPlayer()

◆ initializePlayers() [1/2]

◆ initializePlayers() [2/2]

◆ initializeQueuePlayers()

◆ isHttpServerRunning()

◆ isInitialized()

◆ isMute()

◆ localDeviceAdded()

◆ localDeviceRemoved()

◆ refreshAfterResume()

◆ remoteDeviceAdded()

◆ remoteDeviceDiscoveryFailed()

◆ remoteDeviceDiscoveryStarted()

◆ remoteDeviceRemoved()

◆ remoteDeviceUpdated()

◆ removeReceiverDevice()

◆ removeUpnpClientListener()

◆ setMute()

◆ setReceiverDeviceIds()

◆ setReceiverDevices()

◆ setVolume()

◆ toItemList() [1/2]

◆ toItemList() [2/2]