|  |  |  | GUPnP A/V Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | ||||
GUPnPDIDLLiteObject; enum GUPnPOCMFlags; xmlNode * gupnp_didl_lite_object_get_xml_node (GUPnPDIDLLiteObject *object); xmlNsPtr gupnp_didl_lite_object_get_upnp_namespace (GUPnPDIDLLiteObject *object); xmlNsPtr gupnp_didl_lite_object_get_dc_namespace (GUPnPDIDLLiteObject *object); GList * gupnp_didl_lite_object_get_properties (GUPnPDIDLLiteObject *object,const char *name); const char * gupnp_didl_lite_object_get_id (GUPnPDIDLLiteObject *object); const char * gupnp_didl_lite_object_get_parent_id (GUPnPDIDLLiteObject *object); gboolean gupnp_didl_lite_object_get_restricted (GUPnPDIDLLiteObject *object); const char * gupnp_didl_lite_object_get_title (GUPnPDIDLLiteObject *object); const char * gupnp_didl_lite_object_get_creator (GUPnPDIDLLiteObject *object); const char * gupnp_didl_lite_object_get_artist (GUPnPDIDLLiteObject *object); const char * gupnp_didl_lite_object_get_author (GUPnPDIDLLiteObject *object); GList * gupnp_didl_lite_object_get_creators (GUPnPDIDLLiteObject *object); GList * gupnp_didl_lite_object_get_artists (GUPnPDIDLLiteObject *object); GList * gupnp_didl_lite_object_get_authors (GUPnPDIDLLiteObject *object); GList * gupnp_didl_lite_object_get_descriptors (GUPnPDIDLLiteObject *object); const char * gupnp_didl_lite_object_get_write_status (GUPnPDIDLLiteObject *object); const char * gupnp_didl_lite_object_get_genre (GUPnPDIDLLiteObject *object); const char * gupnp_didl_lite_object_get_upnp_class (GUPnPDIDLLiteObject *object); const char * gupnp_didl_lite_object_get_album (GUPnPDIDLLiteObject *object); const char * gupnp_didl_lite_object_get_album_art (GUPnPDIDLLiteObject *object); const char * gupnp_didl_lite_object_get_description (GUPnPDIDLLiteObject *object); const char * gupnp_didl_lite_object_get_date (GUPnPDIDLLiteObject *object); int gupnp_didl_lite_object_get_track_number (GUPnPDIDLLiteObject *object); GUPnPOCMFlags gupnp_didl_lite_object_get_dlna_managed (GUPnPDIDLLiteObject *object); GList * gupnp_didl_lite_object_get_resources (GUPnPDIDLLiteObject *object); GUPnPDIDLLiteResource * gupnp_didl_lite_object_get_compat_resource (GUPnPDIDLLiteObject *object,const char *sink_protocol_info,gboolean lenient); GUPnPDIDLLiteResource * gupnp_didl_lite_object_add_resource (GUPnPDIDLLiteObject *object); GUPnPDIDLLiteDescriptor * gupnp_didl_lite_object_add_descriptor (GUPnPDIDLLiteObject *object); void gupnp_didl_lite_object_set_upnp_class (GUPnPDIDLLiteObject *object,const char *upnp_class); void gupnp_didl_lite_object_set_id (GUPnPDIDLLiteObject *object,const char *id); void gupnp_didl_lite_object_set_parent_id (GUPnPDIDLLiteObject *object,const char *parent_id); void gupnp_didl_lite_object_set_restricted (GUPnPDIDLLiteObject *object,gboolean restricted); void gupnp_didl_lite_object_set_title (GUPnPDIDLLiteObject *object,const char *title); void gupnp_didl_lite_object_set_creator (GUPnPDIDLLiteObject *object,const char *creator); void gupnp_didl_lite_object_set_artist (GUPnPDIDLLiteObject *object,const char *artist); void gupnp_didl_lite_object_set_author (GUPnPDIDLLiteObject *object,const char *author); GUPnPDIDLLiteContributor * gupnp_didl_lite_object_add_creator (GUPnPDIDLLiteObject *object); GUPnPDIDLLiteContributor * gupnp_didl_lite_object_add_artist (GUPnPDIDLLiteObject *object); GUPnPDIDLLiteContributor * gupnp_didl_lite_object_add_author (GUPnPDIDLLiteObject *object); void gupnp_didl_lite_object_set_genre (GUPnPDIDLLiteObject *object,const char *genre); void gupnp_didl_lite_object_set_write_status (GUPnPDIDLLiteObject *object,const char *write_status); void gupnp_didl_lite_object_set_album (GUPnPDIDLLiteObject *object,const char *album); void gupnp_didl_lite_object_set_album_art (GUPnPDIDLLiteObject *object,const char *album_art); void gupnp_didl_lite_object_set_description (GUPnPDIDLLiteObject *object,const char *description); void gupnp_didl_lite_object_set_date (GUPnPDIDLLiteObject *object,const char *date); void gupnp_didl_lite_object_set_track_number (GUPnPDIDLLiteObject *object,int track_number); void gupnp_didl_lite_object_set_dlna_managed (GUPnPDIDLLiteObject *object,GUPnPOCMFlags dlna_managed);
GObject +----GUPnPDIDLLiteObject +----GUPnPDIDLLiteContainer +----GUPnPDIDLLiteItem
"album" gchar* : Read / Write "album-art" gchar* : Read / Write "artist" gchar* : Read / Write "author" gchar* : Read / Write "creator" gchar* : Read / Write "date" gchar* : Read / Write "dc-namespace" gpointer : Read / Write / Construct Only "description" gchar* : Read / Write "dlna-managed" GUPnPOCMFlags : Read / Write "dlna-namespace" gpointer : Read / Write / Construct Only "genre" gchar* : Read / Write "id" gchar* : Read / Write "parent-id" gchar* : Read / Write "restricted" gboolean : Read / Write "title" gchar* : Read / Write "track-number" gint : Read / Write "upnp-class" gchar* : Read / Write "upnp-namespace" gpointer : Read / Write / Construct Only "write-status" gchar* : Read / Write "xml-doc" GUPnPXMLDoc* : Write / Construct Only "xml-node" gpointer : Read / Write / Construct Only
typedef enum {
        GUPNP_OCM_FLAGS_NONE               = 0x0,
        GUPNP_OCM_FLAGS_UPLOAD             = 0x01,
        GUPNP_OCM_FLAGS_CREATE_CONTAINER   = 0x02,
        GUPNP_OCM_FLAGS_DESTROYABLE        = 0x04,
        GUPNP_OCM_FLAGS_UPLOAD_DESTROYABLE = 0x08,
        GUPNP_OCM_FLAGS_CHANGE_METADATA    = 0x10
} GUPnPOCMFlags;
The DLNA OCM flags supported by a DIDL-Lite Object. For details on these flags please refer to section 7.3.118.4 of DLNA Networked Device Interoperability Guidelines Volume 1, October 2006.
| No flags | |
| Indicates support for content upload. | |
| Indicates support for creation of child container. | |
| This object is destroyable. | |
| Indicates support for upload of destroyable content. | |
| Indicates support for changing metadata. | 
xmlNode *           gupnp_didl_lite_object_get_xml_node (GUPnPDIDLLiteObject *object);
Get the pointer to object node in XML document.
| 
 | The GUPnPDIDLLiteObject | 
| Returns : | The pointer to object node in XML document. | 
xmlNsPtr            gupnp_didl_lite_object_get_upnp_namespace
                                                        (GUPnPDIDLLiteObject *object);
Get the pointer to the UPnP namespace registered with the XML document.
| 
 | The GUPnPDIDLLiteObject | 
| Returns : | The pointer to UPnP namespace in XML document. | 
xmlNsPtr            gupnp_didl_lite_object_get_dc_namespace
                                                        (GUPnPDIDLLiteObject *object);
Get the pointer to the DublinCore namespace registered with the XML document containing this object.
| 
 | The GUPnPDIDLLiteObject | 
| Returns : | The pointer to DublinCore namespace in XML document. | 
GList * gupnp_didl_lite_object_get_properties (GUPnPDIDLLiteObject *object,const char *name);
Use this function to retreive property nodes by name.
| 
 | GUPnPDIDLLiteObject | 
| 
 | name of the properties | 
| Returns : | The list of property nodes
by the name property_namebelonging toobject, orNULL. g_list_free the
returned list after usage but do not modify the contents. [element-type utf8][transfer none] | 
const char *        gupnp_didl_lite_object_get_id       (GUPnPDIDLLiteObject *object);
Get the ID of the object.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | The ID of the object, orNULL. | 
const char *        gupnp_didl_lite_object_get_parent_id
                                                        (GUPnPDIDLLiteObject *object);
Get the ID of the parent of the object.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | The ID of parent of the object, orNULL. g_free after
usage. | 
gboolean            gupnp_didl_lite_object_get_restricted
                                                        (GUPnPDIDLLiteObject *object);
Whether the object is restricted or not.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | TRUE if objectis restricted. | 
const char *        gupnp_didl_lite_object_get_title    (GUPnPDIDLLiteObject *object);
Get the title of the object.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | The title of the object, orNULL. | 
const char *        gupnp_didl_lite_object_get_creator  (GUPnPDIDLLiteObject *object);
gupnp_didl_lite_object_get_creator has been deprecated since version 0.5.3 and should not be used in newly-written code. Use gupnp_didl_lite_object_get_creators instead.
Get the creator of the object.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | The creator of the object, orNULL. | 
const char *        gupnp_didl_lite_object_get_artist   (GUPnPDIDLLiteObject *object);
gupnp_didl_lite_object_get_artist has been deprecated since version 0.5.3 and should not be used in newly-written code. Use gupnp_didl_lite_object_get_artists instead.
Get the artist of the object. If role is not NULL, it is set to the role
of the artist if available.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | The artist of the object, orNULL. | 
const char *        gupnp_didl_lite_object_get_author   (GUPnPDIDLLiteObject *object);
gupnp_didl_lite_object_get_author has been deprecated since version 0.5.3 and should not be used in newly-written code. Use gupnp_didl_lite_object_get_authors instead.
Get the author of the object.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | The author of the object, orNULL. | 
GList *             gupnp_didl_lite_object_get_creators (GUPnPDIDLLiteObject *object);
Get the creators of the object.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | The list of creators belonging to object, orNULL.
g_list_free the returned list after usage and unref each object in it. | 
GList *             gupnp_didl_lite_object_get_artists  (GUPnPDIDLLiteObject *object);
Get the artists of the object.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | The list of artists belonging to object, orNULL.
g_list_free the returned list after usage and unref each object in it. | 
GList *             gupnp_didl_lite_object_get_authors  (GUPnPDIDLLiteObject *object);
Get the authors of the object.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | The list of authors belonging to object, orNULL.
g_list_free the returned list after usage and unref each object in it. | 
GList *             gupnp_didl_lite_object_get_descriptors
                                                        (GUPnPDIDLLiteObject *object);
Get the descriptors of the object.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | The list of descriptors belonging to object, orNULL.
g_list_free the returned list after usage and unref each object in it. | 
const char *        gupnp_didl_lite_object_get_write_status
                                                        (GUPnPDIDLLiteObject *object);
Get the write status of the object.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | The write status of the object, orNULL. | 
const char *        gupnp_didl_lite_object_get_genre    (GUPnPDIDLLiteObject *object);
Get the genre of the object.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | The genre of the object, orNULL. | 
const char *        gupnp_didl_lite_object_get_upnp_class
                                                        (GUPnPDIDLLiteObject *object);
Get the UPnP class of the object.
| 
 | The GUPnPDIDLLiteObject | 
| Returns : | The class of object, orNULL. | 
const char *        gupnp_didl_lite_object_get_album    (GUPnPDIDLLiteObject *object);
Get the album of the object.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | The album of the object, orNULL. | 
const char *        gupnp_didl_lite_object_get_album_art
                                                        (GUPnPDIDLLiteObject *object);
Get the URI to album art of the object.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | The URI to album art of the object, orNULL. | 
const char *        gupnp_didl_lite_object_get_description
                                                        (GUPnPDIDLLiteObject *object);
Get the description of the object.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | The description of the object, orNULL. | 
const char *        gupnp_didl_lite_object_get_date     (GUPnPDIDLLiteObject *object);
Get the date of the object.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | The date of the object, orNULL. | 
int                 gupnp_didl_lite_object_get_track_number
                                                        (GUPnPDIDLLiteObject *object);
Get the original track number of the object.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | The original track number of the object, or -1. | 
GUPnPOCMFlags       gupnp_didl_lite_object_get_dlna_managed
                                                        (GUPnPDIDLLiteObject *object);
Get the 'dlna:dlnaManaged' attribute of the object.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | The 'dlna:dlnaManaged' attribute of the object. | 
GList *             gupnp_didl_lite_object_get_resources
                                                        (GUPnPDIDLLiteObject *object);
Use this function to retreive resources from the object.
| 
 | GUPnPDIDLLiteObject | 
| Returns : | The list
of resources belonging to object, orNULL. g_list_free the
returned list after usage and unref each resource in it. [element-type GUPnPDIDLLiteResource][transfer full] | 
GUPnPDIDLLiteResource * gupnp_didl_lite_object_get_compat_resource (GUPnPDIDLLiteObject *object,const char *sink_protocol_info,gboolean lenient);
Use this function to get a resource from the object that is compatible with
any of the protocols specified in the sink_protocol_info. The value of
sink_protocol_info will typically be acquired from 'Sink' argument of
'GetProtocolInfo' action or 'SinkProtocolInfo' state-variable of a
ConnectionManager service.
If lenient is TRUE, the first resource in the list is returned instead of
NULL if none of resources and protocols are found to be compatible.
| 
 | GUPnPDIDLLiteObject | 
| 
 | The SinkProtocolInfo string from MediaRenderer | 
| 
 | Enable lenient mode | 
| Returns : | The resource belonging to objectthat is comaptible with
any of the protocols specified insink_protocol_info, orNULL. Unref after
usage. | 
GUPnPDIDLLiteResource * gupnp_didl_lite_object_add_resource
                                                        (GUPnPDIDLLiteObject *object);
Creates a new resource, attaches it to object and returns it.
| 
 | A GUPnPDIDLLiteObject | 
| Returns : | A new GUPnPDIDLLiteResource object. Unref after usage. | 
GUPnPDIDLLiteDescriptor * gupnp_didl_lite_object_add_descriptor
                                                        (GUPnPDIDLLiteObject *object);
Creates a new descriptor, attaches it to object and returns it.
| 
 | A GUPnPDIDLLiteObject | 
| Returns : | A new GUPnPDIDLLiteDescriptor object. Unref after usage. | 
void gupnp_didl_lite_object_set_upnp_class (GUPnPDIDLLiteObject *object,const char *upnp_class);
Set the UPnP class of the object to upnp_class.
| 
 | The GUPnPDIDLLiteObject | 
| 
 | The UPnP class as string. | 
void gupnp_didl_lite_object_set_id (GUPnPDIDLLiteObject *object,const char *id);
Set the ID of the object to id.
| 
 | GUPnPDIDLLiteObject | 
| 
 | The ID | 
void gupnp_didl_lite_object_set_parent_id (GUPnPDIDLLiteObject *object,const char *parent_id);
Set the ID of the parent of the object to parent_id.
| 
 | GUPnPDIDLLiteObject | 
| 
 | The parent ID | 
void gupnp_didl_lite_object_set_restricted (GUPnPDIDLLiteObject *object,gboolean restricted);
Set the restricted status of object to restricted.
| 
 | GUPnPDIDLLiteObject | 
| 
 | The restricted status | 
void gupnp_didl_lite_object_set_title (GUPnPDIDLLiteObject *object,const char *title);
Set the title of the object to title.
| 
 | GUPnPDIDLLiteObject | 
| 
 | The title | 
void gupnp_didl_lite_object_set_creator (GUPnPDIDLLiteObject *object,const char *creator);
gupnp_didl_lite_object_set_creator has been deprecated since version 0.5.3 and should not be used in newly-written code. Use gupnp_didl_lite_object_add_creator instead.
Set the creator of the object to creator.
| 
 | GUPnPDIDLLiteObject | 
| 
 | The creator | 
void gupnp_didl_lite_object_set_artist (GUPnPDIDLLiteObject *object,const char *artist);
gupnp_didl_lite_object_set_artist has been deprecated since version 0.5.3 and should not be used in newly-written code. Use gupnp_didl_lite_object_add_artist instead.
Set the Artist of the object to artist.
| 
 | The GUPnPDIDLLiteObject | 
| 
 | The Artist | 
void gupnp_didl_lite_object_set_author (GUPnPDIDLLiteObject *object,const char *author);
gupnp_didl_lite_object_set_author has been deprecated since version 0.5.3 and should not be used in newly-written code. Use gupnp_didl_lite_object_add_author instead.
Set the Author of the object to author.
| 
 | The GUPnPDIDLLiteObject | 
| 
 | The Author | 
GUPnPDIDLLiteContributor * gupnp_didl_lite_object_add_creator
                                                        (GUPnPDIDLLiteObject *object);
Add a new creator node to the object and return the associated
GUPnPDIDLLiteContributor object.
| 
 | The GUPnPDIDLLiteObject | 
| Returns : | A new GUPnPDIDLLiteContributor object. Unref after usage. | 
GUPnPDIDLLiteContributor * gupnp_didl_lite_object_add_artist
                                                        (GUPnPDIDLLiteObject *object);
Add a new Artist node to the object and return the associated
GUPnPDIDLLiteContributor object.
| 
 | The GUPnPDIDLLiteObject | 
| Returns : | A new GUPnPDIDLLiteContributor object. Unref after usage. | 
GUPnPDIDLLiteContributor * gupnp_didl_lite_object_add_author
                                                        (GUPnPDIDLLiteObject *object);
Add a new author node to the object and return the associated
GUPnPDIDLLiteContributor object.
| 
 | The GUPnPDIDLLiteObject | 
| Returns : | A new GUPnPDIDLLiteContributor object. Unref after usage. | 
void gupnp_didl_lite_object_set_genre (GUPnPDIDLLiteObject *object,const char *genre);
Set the genre of the object to genre.
| 
 | The GUPnPDIDLLiteObject | 
| 
 | The Genre | 
void gupnp_didl_lite_object_set_write_status (GUPnPDIDLLiteObject *object,const char *write_status);
Set the write status of the object to write_status.
| 
 | GUPnPDIDLLiteObject | 
| 
 | The write status string | 
void gupnp_didl_lite_object_set_album (GUPnPDIDLLiteObject *object,const char *album);
Set the album of the object to album.
| 
 | GUPnPDIDLLiteObject | 
| 
 | The album string | 
void gupnp_didl_lite_object_set_album_art (GUPnPDIDLLiteObject *object,const char *album_art);
Set the URI to album art of the object to album_art.
| 
 | GUPnPDIDLLiteObject | 
| 
 | The URI of album art | 
void gupnp_didl_lite_object_set_description (GUPnPDIDLLiteObject *object,const char *description);
Set the description of the object to description.
| 
 | GUPnPDIDLLiteObject | 
| 
 | The description string | 
void gupnp_didl_lite_object_set_date (GUPnPDIDLLiteObject *object,const char *date);
Set the date of the object to date.
| 
 | GUPnPDIDLLiteObject | 
| 
 | The date string | 
void gupnp_didl_lite_object_set_track_number (GUPnPDIDLLiteObject *object,int track_number);
Set the original track number of the object to track_number.
| 
 | GUPnPDIDLLiteObject | 
| 
 | The original track number | 
void gupnp_didl_lite_object_set_dlna_managed (GUPnPDIDLLiteObject *object,GUPnPOCMFlags dlna_managed);
Set the 'dlna:dlnaManaged' attribute of the object to dlna_managed.
| 
 | GUPnPDIDLLiteObject | 
| 
 | The GUPnPOCMFlags. | 
"album-art" property"album-art" gchar* : Read / Write
The URI to album art of this object.
Default value: NULL
"artist" property"artist" gchar* : Read / Write
GUPnPDIDLLiteObject:artist has been deprecated since version 0.5.3 and should not be used in newly-written code. Use gupnp_didl_lite_object_get_artists and
gupnp_didl_lite_object_add_artist instead since unlike this
property, they are capable of dealing with multiple artist nodes.
The artist of this object.
Default value: NULL
"author" property"author" gchar* : Read / Write
GUPnPDIDLLiteObject:author has been deprecated since version 0.5.3 and should not be used in newly-written code. Use gupnp_didl_lite_object_get_authors and
gupnp_didl_lite_object_add_author instead since unlike this
property, they are capable of dealing with multiple author nodes.
The author of this object.
Default value: NULL
"creator" property"creator" gchar* : Read / Write
GUPnPDIDLLiteObject:creator has been deprecated since version 0.5.3 and should not be used in newly-written code. Use gupnp_didl_lite_object_get_creators and
gupnp_didl_lite_object_add_creator instead since unlike this
property, they are capable of dealing with multiple creator nodes.
The creator of this object.
Default value: NULL
"dc-namespace" property"dc-namespace" gpointer : Read / Write / Construct Only
Pointer to the DublinCore namespace registered with the XML document containing this object.
"description" property"description" gchar* : Read / Write
The description of this object.
Default value: NULL
"dlna-managed" property"dlna-managed" GUPnPOCMFlags : Read / Write
The 'dlna:dlnaManaged' attribute.
"dlna-namespace" property"dlna-namespace" gpointer : Read / Write / Construct Only
Pointer to the DLNA metadata namespace registered with the XML document containing this object.
"parent-id" property"parent-id" gchar* : Read / Write
The ID of the parent container of this object.
Default value: NULL
"restricted" property"restricted" gboolean : Read / Write
Whether this object is restricted.
Default value: FALSE
"track-number" property"track-number" gint : Read / Write
The original track number of this object.
Allowed values: >= -1
Default value: -1
"upnp-class" property"upnp-class" gchar* : Read / Write
The UPnP class of this object.
Default value: NULL
"upnp-namespace" property"upnp-namespace" gpointer : Read / Write / Construct Only
Pointer to the UPnP namespace registered with the XML document containing this object.
"write-status" property"write-status" gchar* : Read / Write
The write status of this object.
Default value: NULL
"xml-doc" property"xml-doc" GUPnPXMLDoc* : Write / Construct Only
The reference to XML document containing this object.
Internal property.
Stability Level: Private
"xml-node" property"xml-node" gpointer : Read / Write / Construct Only
The pointer to object node in XML document.