import org.openhab.binding.upnpcontrol.internal.handler.UpnpRendererHandler;
/**
- * Interface class to be implemented in {@link UpnpControlHandlerFactory}, allows a {UpnpRendererHandler} to register
- * itself as an audio sink when it supports audio. If it supports audio is only known after the communication with the
- * renderer is established.
+ * Interface class to be implemented in {@link org.openhab.binding.upnpcontrol.internal.UpnpControlHandlerFactory
+ * UpnpControlHandlerFactory}, allows a {@link UpnpRendererHandler} to register itself as an audio sink when it supports
+ * audio. If it supports audio is only known after the communication with the renderer is established.
*
* @author Mark Herwege - Initial contribution
*/
/**
* Method called when a the remote device represented by the thing for this handler is added to the jupnp
- * {@link RegistryListener} or is updated. Configuration info can be retrieved from the {@link RemoteDevice}.
+ * {@link org.jupnp.registry.RegistryListener RegistryListener} or is updated. Configuration info can be retrieved
+ * from the {@link RemoteDevice}.
*
* @param device
*/
/**
* Invoke PrepareForConnection on the UPnP Connection Manager.
- * Result is received in {@link onValueReceived}.
+ * Result is received in {@link #onValueReceived}.
*
* @param remoteProtocolInfo
* @param peerConnectionManager
/**
* Invoke GetCurrentConnectionIDs on the UPnP Connection Manager.
- * Result is received in {@link onValueReceived}.
+ * Result is received in {@link #onValueReceived}.
*/
protected void getCurrentConnectionIDs() {
Map<String, String> inputs = Collections.emptyMap();
/**
* Invoke GetCurrentConnectionInfo on the UPnP Connection Manager.
- * Result is received in {@link onValueReceived}.
+ * Result is received in {@link #onValueReceived}.
*/
protected void getCurrentConnectionInfo() {
CompletableFuture<Boolean> settingAVTransport = isAvTransportIdSet;
/**
* Invoke GetFeatureList on the UPnP Connection Manager.
- * Result is received in {@link onValueReceived}.
+ * Result is received in {@link #onValueReceived}.
*/
protected void getFeatureList() {
Map<String, String> inputs = Collections.emptyMap();
/**
* Invoke GetProtocolInfo on UPnP Connection Manager.
- * Result is received in {@link onValueReceived}.
+ * Result is received in {@link #onValueReceived}.
*/
protected void getProtocolInfo() {
Map<String, String> inputs = Collections.emptyMap();
}
/**
- * This method wraps {@link org.openhab.core.io.transport.upnp.UpnpIOService.invokeAction}. It schedules and
- * submits the call and calls {@link onValueReceived} upon completion. All state updates or other actions depending
- * on the results should be triggered from {@link onValueReceived} because the class fields with results will be
- * filled asynchronously.
+ * This method wraps {@link org.openhab.core.io.transport.upnp.UpnpIOService#invokeAction invokeAction}. It
+ * schedules and submits the call and calls {@link #onValueReceived} upon completion. All state updates or other
+ * actions depending on the results should be triggered from {@link #onValueReceived} because the class fields with
+ * results will be filled asynchronously.
*
* @param serviceId
* @param actionId
/**
* Invoke GetTransportState on UPnP AV Transport.
- * Result is received in {@link onValueReceived}.
+ * Result is received in {@link #onValueReceived}.
*/
protected void getTransportState() {
Map<String, String> inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId));
/**
* Invoke getPositionInfo on UPnP AV Transport.
- * Result is received in {@link onValueReceived}.
+ * Result is received in {@link #onValueReceived}.
*/
protected void getPositionInfo() {
Map<String, String> inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId));
/**
* Invoke GetMediaInfo on UPnP AV Transport.
- * Result is received in {@link onValueReceived}.
+ * Result is received in {@link #onValueReceived}.
*/
protected void getMediaInfo() {
Map<String, String> inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId));
/**
* Retrieves the current volume known to the control point, gets updated by GENA events or after UPnP Rendering
- * Control GetVolume call. This method is used to retrieve volume by {@link UpnpAudioSink.getVolume}.
+ * Control GetVolume call. This method is used to retrieve volume with the
+ * {@link org.openhab.binding.upnpcontrol.internal.audiosink.UpnpAudioSink#getVolume UpnpAudioSink.getVolume}
+ * method.
*
* @return current volume
*/
/**
* Invoke GetVolume on UPnP Rendering Control.
- * Result is received in {@link onValueReceived}.
+ * Result is received in {@link #onValueReceived}.
*
* @param channel
*/
/**
* Invoke getMute on UPnP Rendering Control.
- * Result is received in {@link onValueReceived}.
+ * Result is received in {@link #onValueReceived}.
*
* @param channel
*/
/**
* Invoke getMute on UPnP Rendering Control.
- * Result is received in {@link onValueReceived}.
+ * Result is received in {@link #onValueReceived}.
*
* @param channel
*/
}
/**
- * Method that does a UPnP browse on a content directory. Results will be retrieved in the {@link onValueReceived}
+ * Method that does a UPnP browse on a content directory. Results will be retrieved in the {@link #onValueReceived}
* method.
*
* @param objectID content directory object
}
/**
- * Method that does a UPnP search on a content directory. Results will be retrieved in the {@link onValueReceived}
+ * Method that does a UPnP search on a content directory. Results will be retrieved in the {@link #onValueReceived}
* method.
*
* @param containerID content directory container
/**
* Add a renderer to the renderer channel state option list.
- * This method is called from the {@link UpnpControlHandlerFactory} class when creating a renderer handler.
+ * This method is called from the {@link org.openhab.binding.upnpcontrol.internal.UpnpControlHandlerFactory
+ * UpnpControlHandlerFactory} class when creating a renderer handler.
*
* @param key
*/
/**
* Remove a renderer from the renderer channel state option list.
- * This method is called from the {@link UpnpControlHandlerFactory} class when removing a renderer handler.
+ * This method is called from the {@link org.openhab.binding.upnpcontrol.internal.UpnpControlHandlerFactory
+ * UpnpControlHandlerFactory} class when removing a renderer handler.
*
* @param key
*/
* of a current index in the queue. It has convenience methods to play previous/next entries, whereby the queue can be
* organized to play from first to last (with no repetition), to restart at the start when the end is reached (in a
* continuous loop), or to random shuffle the entries. Repeat and shuffle are off by default, but can be set using the
- * {@link setRepeat} and {@link setShuffle} methods.
+ * {@link #setRepeat} and {@link #setShuffle} methods.
*
* @author Mark Herwege - Initial contribution
*
}
/**
- * @return the index of the next element in the queue that will be served if {@link next} is called, or -1 if
+ * @return the index of the next element in the queue that will be served if {@link #next} is called, or -1 if
* nothing to serve for next.
*/
public synchronized int nextIndex() {
}
/**
- * @return the index of the previous element in the queue that will be served if {@link previous} is called, or -1
+ * @return the index of the previous element in the queue that will be served if {@link #previous} is called, or -1
* if nothing to serve for next.
*/
public synchronized int previousIndex() {
}
/**
- * @return true if there is an element to server when calling {@link next}.
+ * @return true if there is an element to server when calling {@link #next}.
*/
public synchronized boolean hasNext() {
int size = currentQueue.size();
}
/**
- * @return true if there is an element to server when calling {@link previous}.
+ * @return true if there is an element to server when calling {@link #previous}.
*/
public synchronized boolean hasPrevious() {
int size = currentQueue.size();
projects / openhab-addons.git / commitdiff