GUPnPDeviceInfo

GUPnPDeviceInfo — Base abstract class for querying device information.

Synopsis




                    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_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_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);


Description

The GUPnPDeviceInfo base abstract class provides methods for querying device information.

Details

GUPnPDeviceInfo

typedef struct {
        GObject parent;

        GUPnPDeviceInfoPrivate *priv;
} GUPnPDeviceInfo;


gupnp_device_info_get_resource_factory ()

GUPnPResourceFactory* gupnp_device_info_get_resource_factory
                                                        (GUPnPDeviceInfo *device_info);

device_info : A GUPnPDeviceInfo
Returns : The GUPnPResourceFactory used by the device_info.

gupnp_device_info_get_context ()

GUPnPContext*       gupnp_device_info_get_context       (GUPnPDeviceInfo *info);

info : A GUPnPDeviceInfo
Returns : The associated GUPnPContext.

gupnp_device_info_get_location ()

const char*         gupnp_device_info_get_location      (GUPnPDeviceInfo *info);

info : A GUPnPDeviceInfo
Returns : The location of the device description file.

gupnp_device_info_get_url_base ()

const SoupUri*      gupnp_device_info_get_url_base      (GUPnPDeviceInfo *info);

info : A GUPnPDeviceInfo
Returns : The URL base.

gupnp_device_info_get_udn ()

const char*         gupnp_device_info_get_udn           (GUPnPDeviceInfo *info);

info : A GUPnPDeviceInfo
Returns : The UDN.

gupnp_device_info_get_device_type ()

const char*         gupnp_device_info_get_device_type   (GUPnPDeviceInfo *info);

info : A GUPnPDeviceInfo
Returns : The UPnP device type, or NULL.

gupnp_device_info_get_friendly_name ()

char*               gupnp_device_info_get_friendly_name (GUPnPDeviceInfo *info);

info : A GUPnPDeviceInfo
Returns : The friendly name, or NULL. g_free() after use.

gupnp_device_info_get_manufacturer ()

char*               gupnp_device_info_get_manufacturer  (GUPnPDeviceInfo *info);

info : A GUPnPDeviceInfo
Returns : The manufacturer, or NULL. g_free() after use.

gupnp_device_info_get_manufacturer_url ()

char*               gupnp_device_info_get_manufacturer_url
                                                        (GUPnPDeviceInfo *info);

info : A GUPnPDeviceInfo
Returns : A URL pointing to the manufacturers website, or NULL. g_free() after use.

gupnp_device_info_get_model_description ()

char*               gupnp_device_info_get_model_description
                                                        (GUPnPDeviceInfo *info);

info : A GUPnPDeviceInfo
Returns : The description of the device model, or NULL. g_free() after use.

gupnp_device_info_get_model_name ()

char*               gupnp_device_info_get_model_name    (GUPnPDeviceInfo *info);

info : A GUPnPDeviceInfo
Returns : The name of the device model, or NULL. g_free() after use.

gupnp_device_info_get_model_number ()

char*               gupnp_device_info_get_model_number  (GUPnPDeviceInfo *info);

info : A GUPnPDeviceInfo
Returns : The model number, or NULL. g_free() after use.

gupnp_device_info_get_model_url ()

char*               gupnp_device_info_get_model_url     (GUPnPDeviceInfo *info);

info : A GUPnPDeviceInfo
Returns : A URL pointing to the device models website, or NULL. g_free() after use.

gupnp_device_info_get_serial_number ()

char*               gupnp_device_info_get_serial_number (GUPnPDeviceInfo *info);

info : A GUPnPDeviceInfo
Returns : The serial number, or NULL. g_free() after use.

gupnp_device_info_get_upc ()

char*               gupnp_device_info_get_upc           (GUPnPDeviceInfo *info);

info : A GUPnPDeviceInfo
Returns : The UPC, or NULL. g_free() after use.

gupnp_device_info_get_icon_url ()

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);

info : A GUPnPDeviceInfo
requested_mime_type : The requested file format, or NULL for any
requested_depth : The requested color depth, or -1 for any
requested_width : The requested width, or -1 for any
requested_height : The requested height, or -1 for any
prefer_bigger : TRUE if a bigger, rather than a smaller icon should be returned if no exact match could be found
mime_type : The location where to store the the format of the returned icon, or NULL. The returned string should be freed after use
depth : The location where to store the depth of the returned icon, or NULL
width : The location where to store the width of the returned icon, or NULL
height : The location where to store the height of the returned icon, or NULL
Returns : 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.

gupnp_device_info_list_devices ()

GList*              gupnp_device_info_list_devices      (GUPnPDeviceInfo *info);

info : A GUPnPDeviceInfo
Returns : 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.

gupnp_device_info_list_device_types ()

GList*              gupnp_device_info_list_device_types (GUPnPDeviceInfo *info);

info : A GUPnPDeviceInfo
Returns : A GList of strings representing the types of the devices directly contained in info. The returned list should be g_list_free()'d and the elements should be g_free()'d.

gupnp_device_info_get_device ()

GUPnPDeviceInfo*    gupnp_device_info_get_device        (GUPnPDeviceInfo *info,
                                                         const char *type);

info : A GUPnPDeviceInfo
type : The type of the device to be retrieved.
Returns : 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.

gupnp_device_info_list_services ()

GList*              gupnp_device_info_list_services     (GUPnPDeviceInfo *info);

info : A GUPnPDeviceInfo
Returns : 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 this function new objects are created. The application must cache any used services if it wishes to keep them around and re-use them.

gupnp_device_info_list_service_types ()

GList*              gupnp_device_info_list_service_types
                                                        (GUPnPDeviceInfo *info);

info : A GUPnPDeviceInfo
Returns : A GList of strings representing the types of the services directly contained in info. The returned list should be g_list_free()'d and the elements should be g_free()'d.

gupnp_device_info_get_service ()

GUPnPServiceInfo*   gupnp_device_info_get_service       (GUPnPDeviceInfo *info,
                                                         const char *type);

info : A GUPnPDeviceInfo
type : The type of the service to be retrieved.
Returns : 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.