![]() |
![]() |
![]() |
GUPnP Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
GUPnPDeviceInfo; GUPnPResourceFactory * gupnp_device_info_get_resource_factory (GUPnPDeviceInfo *device_info
); GUPnPContext * gupnp_device_info_get_context (GUPnPDeviceInfo *info
); const char * gupnp_device_info_get_location (GUPnPDeviceInfo *info
); const SoupURI * gupnp_device_info_get_url_base (GUPnPDeviceInfo *info
); const char * gupnp_device_info_get_udn (GUPnPDeviceInfo *info
); const char * gupnp_device_info_get_device_type (GUPnPDeviceInfo *info
); char * gupnp_device_info_get_friendly_name (GUPnPDeviceInfo *info
); char * gupnp_device_info_get_manufacturer (GUPnPDeviceInfo *info
); char * gupnp_device_info_get_manufacturer_url (GUPnPDeviceInfo *info
); char * gupnp_device_info_get_model_description (GUPnPDeviceInfo *info
); char * gupnp_device_info_get_model_name (GUPnPDeviceInfo *info
); char * gupnp_device_info_get_model_number (GUPnPDeviceInfo *info
); char * gupnp_device_info_get_model_url (GUPnPDeviceInfo *info
); char * gupnp_device_info_get_serial_number (GUPnPDeviceInfo *info
); char * gupnp_device_info_get_presentation_url (GUPnPDeviceInfo *info
); char * gupnp_device_info_get_upc (GUPnPDeviceInfo *info
); char * gupnp_device_info_get_icon_url (GUPnPDeviceInfo *info
,const char *requested_mime_type
,int requested_depth
,int requested_width
,int requested_height
,gboolean prefer_bigger
,char **mime_type
,int *depth
,int *width
,int *height
); GList * gupnp_device_info_list_dlna_capabilities (GUPnPDeviceInfo *info
); char * gupnp_device_info_get_description_value (GUPnPDeviceInfo *info
,const char *element
); GList * gupnp_device_info_list_devices (GUPnPDeviceInfo *info
); GList * gupnp_device_info_list_device_types (GUPnPDeviceInfo *info
); GUPnPDeviceInfo * gupnp_device_info_get_device (GUPnPDeviceInfo *info
,const char *type
); GList * gupnp_device_info_list_services (GUPnPDeviceInfo *info
); GList * gupnp_device_info_list_service_types (GUPnPDeviceInfo *info
); GUPnPServiceInfo * gupnp_device_info_get_service (GUPnPDeviceInfo *info
,const char *type
);
"context" GUPnPContext* : Read / Write / Construct Only "device-type" gchar* : Read / Write / Construct Only "document" GUPnPXMLDoc* : Write / Construct Only "element" gpointer : Write / Construct Only "location" gchar* : Read / Write / Construct Only "resource-factory" GUPnPResourceFactory* : Read / Write / Construct Only "udn" gchar* : Read / Write / Construct Only "url-base" gpointer : Read / Write / Construct Only
The GUPnPDeviceInfo base abstract class provides methods for querying device information.
typedef struct _GUPnPDeviceInfo GUPnPDeviceInfo;
This struct contains private data only, and should be accessed using the functions below.
GUPnPResourceFactory * gupnp_device_info_get_resource_factory
(GUPnPDeviceInfo *device_info
);
Get the GUPnPResourceFactory used by the device_info
.
|
A GUPnPDeviceInfo |
Returns : |
A GUPnPResourceFactory. |
GUPnPContext * gupnp_device_info_get_context (GUPnPDeviceInfo *info
);
Get the associated GUPnPContext.
|
A GUPnPDeviceInfo |
Returns : |
A GUPnPContext. |
const char * gupnp_device_info_get_location (GUPnPDeviceInfo *info
);
Get the location of the device description file.
|
A GUPnPDeviceInfo |
Returns : |
A constant string. |
const SoupURI * gupnp_device_info_get_url_base (GUPnPDeviceInfo *info
);
Get the URL base of this device.
|
A GUPnPDeviceInfo |
Returns : |
A SoupURI. |
const char * gupnp_device_info_get_udn (GUPnPDeviceInfo *info
);
Get the Unique Device Name of the device.
|
A GUPnPDeviceInfo |
Returns : |
A constant string. |
const char * gupnp_device_info_get_device_type (GUPnPDeviceInfo *info
);
Get the UPnP device type.
|
A GUPnPDeviceInfo |
Returns : |
A constant string, or NULL .
|
char * gupnp_device_info_get_friendly_name (GUPnPDeviceInfo *info
);
Get the friendly name of the device.
|
A GUPnPDeviceInfo |
Returns : |
A string, or NULL . g_free() after use.
|
char * gupnp_device_info_get_manufacturer (GUPnPDeviceInfo *info
);
Get the manufacturer of the device.
|
A GUPnPDeviceInfo |
Returns : |
A string, or NULL . g_free() after use.
|
char * gupnp_device_info_get_manufacturer_url
(GUPnPDeviceInfo *info
);
Get a URL pointing to the manufacturer's website.
|
A GUPnPDeviceInfo |
Returns : |
A string, or NULL . g_free() after use.
|
char * gupnp_device_info_get_model_description
(GUPnPDeviceInfo *info
);
Get the description of the device model.
|
A GUPnPDeviceInfo |
Returns : |
A string, or NULL . g_free() after use.
|
char * gupnp_device_info_get_model_name (GUPnPDeviceInfo *info
);
Get the model name of the device.
|
A GUPnPDeviceInfo |
Returns : |
A string, or NULL . g_free() after use.
|
char * gupnp_device_info_get_model_number (GUPnPDeviceInfo *info
);
Get the model number of the device.
|
A GUPnPDeviceInfo |
Returns : |
A string, or NULL . g_free() after use.
|
char * gupnp_device_info_get_model_url (GUPnPDeviceInfo *info
);
Get a URL pointing to the device model's website.
|
A GUPnPDeviceInfo |
Returns : |
A string, or NULL . g_free() after use.
|
char * gupnp_device_info_get_serial_number (GUPnPDeviceInfo *info
);
Get the serial number of the device.
|
A GUPnPDeviceInfo |
Returns : |
A string, or NULL . g_free() after use.
|
char * gupnp_device_info_get_presentation_url
(GUPnPDeviceInfo *info
);
Get a URL pointing to the device's presentation page, for web-based administration.
|
A GUPnPDeviceInfo |
Returns : |
A string, or NULL . g_free() after use.
|
char * gupnp_device_info_get_upc (GUPnPDeviceInfo *info
);
Get the Universal Product Code of the device.
|
A GUPnPDeviceInfo |
Returns : |
A string, or NULL . g_free() after use.
|
char * gupnp_device_info_get_icon_url (GUPnPDeviceInfo *info
,const char *requested_mime_type
,int requested_depth
,int requested_width
,int requested_height
,gboolean prefer_bigger
,char **mime_type
,int *depth
,int *width
,int *height
);
Get a URL pointing to the icon most closely matching the
given criteria, or NULL
. If requested_mime_type
is set, only icons with
this mime type will be returned. If requested_depth
is set, only icons with
this or lower depth will be returned. If requested_width
and/or
requested_height
are set, only icons that are this size or smaller are
returned, unless prefer_bigger
is set, in which case the next biggest icon
will be returned. The returned strings should be freed.
|
A GUPnPDeviceInfo |
|
The requested file
format, or NULL for any. allow-none. transfer none. |
|
The requested color depth, or -1 for any |
|
The requested width, or -1 for any |
|
The requested height, or -1 for any |
|
TRUE if a bigger, rather than a smaller icon should be
returned if no exact match could be found
|
|
The location where to store the the format
of the returned icon, or NULL . The returned string should be freed after
use. out. allow-none. |
|
(out) (allow-none) : The location where to store the depth of the
returned icon, or NULL
|
|
(out) (allow-none) : The location where to store the width of the
returned icon, or NULL
|
|
(out) (allow-none) : The location where to store the height of the
returned icon, or NULL
|
Returns : |
a string, or NULL . g_free() after use.. transfer full. |
GList * gupnp_device_info_list_dlna_capabilities
(GUPnPDeviceInfo *info
);
Get a GList of strings that represent the device capabilities as announced in the device description file using the <dlna:X_DLNACAP> element.
|
A GUPnPDeviceInfo |
Returns : |
a GList of newly allocated strings or
NULL if the device description doesn't contain the <dlna:X_DLNACAP>
element.. element-type utf8. |
char * gupnp_device_info_get_description_value (GUPnPDeviceInfo *info
,const char *element
);
This function provides generic access to the contents of arbitrary elements in the device description file.
|
A GUPnPDeviceInfo |
|
Name of the description element to retrieve |
Returns : |
a newly allocated string or NULL if the device
description doesn't contain the given element
|
GList * gupnp_device_info_list_devices (GUPnPDeviceInfo *info
);
Get a GList of new objects implementing GUPnPDeviceInfo
representing the devices directly contained in info
. The returned list
should be g_list_free()
'd and the elements should be g_object_unref()
'd.
Note that devices are not cached internally, so that every time you call this function new objects are created. The application must cache any used devices if it wishes to keep them around and re-use them.
|
A GUPnPDeviceInfo |
Returns : |
a GList of new GUPnPDeviceInfo objects.. element-type GUPnP.DeviceInfo. transfer full GUPnP.DeviceInfo. |
GList * gupnp_device_info_list_device_types (GUPnPDeviceInfo *info
);
Get a GList of strings representing the types of the devices
directly contained in info
.
|
A GUPnPDeviceInfo |
Returns : |
A GList of strings. The
elements should be g_free() 'd and the list should be g_list_free() 'd.. element-type utf8. transfer full utf8. |
GUPnPDeviceInfo * gupnp_device_info_get_device (GUPnPDeviceInfo *info
,const char *type
);
Get the service with type type
directly contained in info
as
a new object implementing GUPnPDeviceInfo, or NULL
if no such device
was found. The returned object should be unreffed when done.
Note that devices are not cached internally, so that every time you call this function a new object is created. The application must cache any used devices if it wishes to keep them around and re-use them.
|
A GUPnPDeviceInfo |
|
The type of the device to be retrieved. |
Returns : |
A new GUPnPDeviceInfo. |
GList * gupnp_device_info_list_services (GUPnPDeviceInfo *info
);
Get a GList of new objects implementing GUPnPServiceInfo representing the
services directly contained in info
. The returned list should be
g_list_free()
'd and the elements should be g_object_unref()
'd.
Note that services are not cached internally, so that every time you call function new objects are created. The application must cache any used services if it wishes to keep them around and re-use them.
|
A GUPnPDeviceInfo |
Returns : |
(element-type GUPnP.ServiceInfo) (transfer full) : A GList of new GUPnPServiceInfo objects. |
GList * gupnp_device_info_list_service_types
(GUPnPDeviceInfo *info
);
Get a GList of strings representing the types of the services
directly contained in info
.
|
A GUPnPDeviceInfo |
Returns : |
A GList of strings. The
elements should be g_free() 'd and the list should be g_list_free() 'd.. element-type utf8. transfer full utf8. |
GUPnPServiceInfo * gupnp_device_info_get_service (GUPnPDeviceInfo *info
,const char *type
);
Get the service with type type
directly contained in info
as a new object
implementing GUPnPServiceInfo, or NULL
if no such device was found. The
returned object should be unreffed when done.
Note that services are not cached internally, so that every time you call this function a new object is created. The application must cache any used services if it wishes to keep them around and re-use them.
|
A GUPnPDeviceInfo |
|
The type of the service to be retrieved. |
Returns : |
A GUPnPServiceInfo. |
"context"
property"context" GUPnPContext* : Read / Write / Construct Only
The GUPnPContext to use.
"device-type"
property"device-type" gchar* : Read / Write / Construct Only
The device type.
Default value: NULL
"document"
property"document" GUPnPXMLDoc* : Write / Construct Only
Private property.
Stability Level: Private
"element"
property"element" gpointer : Write / Construct Only
Private property.
Stability Level: Private
"location"
property"location" gchar* : Read / Write / Construct Only
The location of the device description file.
Default value: NULL
"resource-factory"
property"resource-factory" GUPnPResourceFactory* : Read / Write / Construct Only
The resource factory to use. Set to NULL for default factory.
"udn"
property"udn" gchar* : Read / Write / Construct Only
The UDN of this device.
Default value: NULL