upnpDevice (Variable type)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Communication / DLNA/UPnP functions

Properties specific to upnpDevice variables
WLanguage functions that use variables of type upnpDevice

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

upnpDevice (Variable type)

In french: upnpPériphérique

The upnpDevice type is used to define the advanced characteristics of a UPnP device. You can define and change the characteristics of the uPnP device using different WLanguage properties.

Note: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.

Example

MyDevice is upnpDevice
MyDevice = UPNPSearchDevice(CST_UPNP_UUID_SONY_BRAVIA, 51300)
IF ErrorOccurred THEN
ErrorInfo(errFullDetails)
ELSE
Add(m_arrDevice, MyDevice)
END

Properties

Properties specific to upnpDevice variables

The following properties can be used to handle a UPnP device:

Property name	Type used	Effect

Icon	Array of upnpImage	List of different available icons.
ModelDescription	Character string	Description of device features.
ModelName	Character string	Name of the model.
ModelNumber	Character string	Number of the model.
ModelURL	Character string	URL of a Web page containing the information specific to the model.
Name	Character string	Name of the device.
PresentationURL	Character string	URL of the Web page that can be used to control the device.
ProducerName	Character string	Name of the manufacturer.
ProducerURL	Character string	Link to the manufacturer site.
ProductCode	Character string	Product code (UPC).
SerialNumber	Character string	Serial number of the device.
Service	Array of upnpService	List of different available UPnP services.
Type	Character string	URI containing the type of device.
UniqueName	Character string	Unique name of device (UDN).
URL	Character string	URL containing the XML for device description.

Remarks

WLanguage functions that use variables of type upnpDevice

Standard functions:


UPNPFindDevice	Finds a device based on its unique name (UDN).
UPNPGetBrightness	Retrieves the brightness of a UPnP device.
UPNPGetContrast	Retrieves the contrast of a UPnP device.
UPNPGetMute	Retrieves the 'Mute' status of a UPnP device.
UPNPGetSharpness	Retrieves the sharpness of a UPnP device.
UPNPGetVolume	Retrieves the volume of a UPnP device.
UPNPMediaOpen	Opens a media on the UPnP device.
UPNPMediaPause	Pauses the reading of the current media on the UPnP device.
UPNPMediaPlay	Starts reading the current media on the UPnP device.
UPNPMediaStop	Stops reading the current media on the UPNP device.
UPNPModifyBrightness	Modifies the brightness of a UPnP device.
UPNPModifyContrast	Modifies the contrast of a UPnP device.
UPNPModifyMute	Modifies the 'Mute' status of a UPnP device.
UPNPModifySharpness	Changes the sharpness of a UPnP device.
UPNPModifyVolume	Change the volume of a UPnP device.

Functions with prefix syntax:


<upnpDevice variable>.GetBrightness	Retrieves the brightness of a UPnP device.
<upnpDevice variable>.GetContrast	Retrieves the contrast of a UPnP device.
<upnpDevice variable>.GetMute	Retrieves the 'Mute' status of a UPnP device.
<upnpDevice variable>.GetSharpness	Retrieves the sharpness of a UPnP device.
<upnpDevice variable>.GetVolume	Retrieves the volume of a UPnP device.
<upnpDevice variable>.MediaOpen	Opens a media on the UPnP device.
<upnpDevice variable>.MediaPause	Pauses the reading of the current media on the UPnP device.
<upnpDevice Variable>.MediaPlay	Starts reading the current media on the UPnP device.
<upnpDevice variable>.MediaStop	Stops reading the current media on the UPNP device.
<upnpDevice variable>.ModifyBrightness	Modifies the brightness of a UPnP device.
<upnpDevice variable>.ModifyContrast	Modifies the contrast of a UPnP device.
<upnpDevice variable>.ModifyMute	Modifies the 'Mute' status of a UPnP device.
<upnpDevice variable>.ModifySharpness	Changes the sharpness of a UPnP device.
<upnpDevice variable>.ModifyVolume	Change the volume of a UPnP device.