GUPnPDIDLLiteObject: GUPnP A/V Reference Manual

## GUPnPDIDLLiteObject GUPnPDIDLLiteObject — DIDL-Lite Object |

## Functions

xmlNode * | gupnp_didl_lite_object_get_xml_node ()
xmlNsPtr | gupnp_didl_lite_object_get_upnp_namespace ()
xmlNsPtr | gupnp_didl_lite_object_get_dc_namespace ()
xmlNsPtr | gupnp_didl_lite_object_get_dlna_namespace ()
xmlNsPtr | gupnp_didl_lite_object_get_pv_namespace ()
GList * | gupnp_didl_lite_object_get_properties ()
const char * | gupnp_didl_lite_object_get_id ()
const char * | gupnp_didl_lite_object_get_parent_id ()
gboolean | gupnp_didl_lite_object_get_restricted ()
const char * | gupnp_didl_lite_object_get_title ()
const char * | gupnp_didl_lite_object_get_creator ()
const char * | gupnp_didl_lite_object_get_artist ()
const char * | gupnp_didl_lite_object_get_author ()
GList * | gupnp_didl_lite_object_get_creators ()
GList * | gupnp_didl_lite_object_get_artists ()
GList * | gupnp_didl_lite_object_get_authors ()
GList * | gupnp_didl_lite_object_get_descriptors ()
const char * | gupnp_didl_lite_object_get_write_status ()
const char * | gupnp_didl_lite_object_get_genre ()
const char * | gupnp_didl_lite_object_get_upnp_class ()
const char * | gupnp_didl_lite_object_get_album ()
const char * | gupnp_didl_lite_object_get_album_art ()
const char * | gupnp_didl_lite_object_get_description ()
const char * | gupnp_didl_lite_object_get_date ()
int | gupnp_didl_lite_object_get_track_number ()
GUPnPOCMFlags | gupnp_didl_lite_object_get_dlna_managed ()
GList * | gupnp_didl_lite_object_get_resources ()
GUPnPDIDLLiteResource * | gupnp_didl_lite_object_get_compat_resource ()
GUPnPDIDLLiteResource * | gupnp_didl_lite_object_add_resource ()
GUPnPDIDLLiteDescriptor * | gupnp_didl_lite_object_add_descriptor ()
void | gupnp_didl_lite_object_set_upnp_class ()
void | gupnp_didl_lite_object_set_id ()
void | gupnp_didl_lite_object_set_parent_id ()
void | gupnp_didl_lite_object_set_restricted ()
void | gupnp_didl_lite_object_set_title ()
void | gupnp_didl_lite_object_set_creator ()
void | gupnp_didl_lite_object_set_artist ()
void | gupnp_didl_lite_object_set_author ()
GUPnPDIDLLiteContributor * | gupnp_didl_lite_object_add_creator ()
GUPnPDIDLLiteContributor * | gupnp_didl_lite_object_add_artist ()
GUPnPDIDLLiteContributor * | gupnp_didl_lite_object_add_author ()
void | gupnp_didl_lite_object_set_genre ()
void | gupnp_didl_lite_object_set_write_status ()
void | gupnp_didl_lite_object_set_album ()
void | gupnp_didl_lite_object_set_album_art ()
void | gupnp_didl_lite_object_set_description ()
void | gupnp_didl_lite_object_set_date ()
void | gupnp_didl_lite_object_set_track_number ()
void | gupnp_didl_lite_object_set_dlna_managed ()
GUPnPDIDLLiteFragmentResult | gupnp_didl_lite_object_apply_fragments ()
char * | gupnp_didl_lite_object_get_album_xml_string ()
char * | gupnp_didl_lite_object_get_artists_xml_string ()
char * | gupnp_didl_lite_object_get_date_xml_string ()
char * | gupnp_didl_lite_object_get_title_xml_string ()
char * | gupnp_didl_lite_object_get_track_number_xml_string ()
guint | gupnp_didl_lite_object_get_update_id ()
char * | gupnp_didl_lite_object_get_upnp_class_xml_string ()
char * | gupnp_didl_lite_object_get_xml_string ()
void | gupnp_didl_lite_object_set_update_id ()
void | gupnp_didl_lite_object_unset_artists ()
void | gupnp_didl_lite_object_unset_update_id ()
gboolean | gupnp_didl_lite_object_update_id_is_set ()
gboolean | gupnp_didl_lite_object_is_restricted_set ()

## Properties

gchar * | album | Read / Write
gchar * | album-art | Read / Write
gchar * | artist | Read / Write
gchar * | author | Read / Write
gchar * | creator | Read / Write
gchar * | date | Read / Write
gpointer | dc-namespace | Read / Write / Construct Only
gchar * | description | Read / Write
GUPnPOCMFlags | dlna-managed | Read / Write
gpointer | dlna-namespace | Read / Write / Construct Only
gchar * | genre | Read / Write
gchar * | id | Read / Write
gchar * | parent-id | Read / Write
gpointer | pv-namespace | Read / Write / Construct Only
gboolean | restricted | Read / Write
gchar * | title | Read / Write
gint | track-number | Read / Write
guint | update-id | Read / Write
gchar * | upnp-class | Read / Write
gpointer | upnp-namespace | Read / Write / Construct Only
gchar * | write-status | Read / Write
GUPnPAVXMLDoc * | xml-doc | Write / Construct Only
gpointer | xml-node | Read / Write / Construct Only

## Types and Values

| GUPnPDIDLLiteObject
enum | GUPnPOCMFlags
enum | GUPnPDIDLLiteFragmentResult

## Object Hierarchy

        GObject
        ╰── GUPnPDIDLLiteObject
            ├── GUPnPDIDLLiteContainer
            ╰── GUPnPDIDLLiteItem

## Description

GUPnPDIDLLiteObject respresent a DIDL-Lite object element.

## Functions

### gupnp_didl_lite_object_get_xml_node ()

    xmlNode *
    gupnp_didl_lite_object_get_xml_node (GUPnPDIDLLiteObject *object);

Get the pointer to object node in XML document.

#### Parameters

object | The GUPnPDIDLLiteObject |

#### Returns

The pointer to object node in XML document.

[transfer none]

### gupnp_didl_lite_object_get_upnp_namespace ()

    xmlNsPtr
    gupnp_didl_lite_object_get_upnp_namespace
                                   (GUPnPDIDLLiteObject *object);

Get the pointer to the UPnP namespace registered with the XML document.

#### Parameters

object | The GUPnPDIDLLiteObject |

#### Returns

The pointer to UPnP namespace in XML document.

[transfer none]

### gupnp_didl_lite_object_get_dc_namespace ()

    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.

#### Parameters

object | The GUPnPDIDLLiteObject |

#### Returns

The pointer to DublinCore namespace in XML document.

[transfer none]

### gupnp_didl_lite_object_get_dlna_namespace ()

    xmlNsPtr
    gupnp_didl_lite_object_get_dlna_namespace
                                   (GUPnPDIDLLiteObject *object);

Get the pointer to the DLNA metadata namespace registered with the XML document containing this object.

#### Parameters

object | The GUPnPDIDLLiteObject |

#### Returns

The pointer to DLNA namespace in XML document.

[transfer none]

### gupnp_didl_lite_object_get_pv_namespace ()

    xmlNsPtr
    gupnp_didl_lite_object_get_pv_namespace
                                   (GUPnPDIDLLiteObject *object);

Get the pointer to the PV metadata namespace registered with the XML document containing this object.

#### Parameters

object | The GUPnPDIDLLiteObject |

#### Returns

The pointer to PV namespace in XML document.

[transfer none]

### gupnp_didl_lite_object_get_properties ()

    GList *
    gupnp_didl_lite_object_get_properties (GUPnPDIDLLiteObject *object,
                                           const char *name);

Use this function to retreive property nodes by name.

#### Parameters

object | GUPnPDIDLLiteObject |
name | name of the properties |

#### Returns

The list of property nodes by the name `property_name` belonging to `object` , or `NULL`. g_list_free the returned list after usage but do not modify the contents.

[element-type xmlNode*][transfer container]

### gupnp_didl_lite_object_get_id ()

    const char *
    gupnp_didl_lite_object_get_id (GUPnPDIDLLiteObject *object);

Get the ID of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The ID of the `object` , or `NULL`.

### gupnp_didl_lite_object_get_parent_id ()

    const char *
    gupnp_didl_lite_object_get_parent_id (GUPnPDIDLLiteObject *object);

Get the ID of the parent of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The ID of parent of the `object` , or `NULL`.

### gupnp_didl_lite_object_get_restricted ()

    gboolean
    gupnp_didl_lite_object_get_restricted (GUPnPDIDLLiteObject *object);

Whether the `object` is restricted or not.

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

TRUE if `object` is restricted.

### gupnp_didl_lite_object_get_title ()

    const char *
    gupnp_didl_lite_object_get_title (GUPnPDIDLLiteObject *object);

Get the title of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The title of the `object` , or `NULL`.

### gupnp_didl_lite_object_get_creator ()

    const char *
    gupnp_didl_lite_object_get_creator (GUPnPDIDLLiteObject *object);

Get the creator of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The creator of the `object` , or `NULL`.

### gupnp_didl_lite_object_get_artist ()

    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.

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The artist of the `object` , or `NULL`.

### gupnp_didl_lite_object_get_author ()

    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` .

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The author of the `object` , or `NULL`.

### gupnp_didl_lite_object_get_creators ()

    GList *
    gupnp_didl_lite_object_get_creators (GUPnPDIDLLiteObject *object);

`gupnp_didl_lite_object_get_creators` is deprecated and should not be used in newly-written code.

Get the creators of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The list of creators belonging to `object` , or `NULL`. g_list_free the returned list after usage and unref each object in it.

[element-type GUPnPDIDLLiteContributor*][transfer full]

### gupnp_didl_lite_object_get_artists ()

    GList *
    gupnp_didl_lite_object_get_artists (GUPnPDIDLLiteObject *object);

Get the artists of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The list of artists belonging to `object` , or `NULL`. g_list_free the returned list after usage and unref each object in it.

[element-type GUPnPDIDLLiteContributor*][transfer full]

### gupnp_didl_lite_object_get_authors ()

    GList *
    gupnp_didl_lite_object_get_authors (GUPnPDIDLLiteObject *object);

Get the authors of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The list of authors belonging to `object` , or `NULL`. g_list_free the returned list after usage and unref each object in it.

[element-type GUPnPDIDLLiteContributor*][transfer full]

### gupnp_didl_lite_object_get_descriptors ()

    GList *
    gupnp_didl_lite_object_get_descriptors
                                   (GUPnPDIDLLiteObject *object);

Get the descriptors of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The list of descriptors belonging to `object` , or `NULL`. g_list_free the returned list after usage and unref each object in it.

[element-type GUPnPDIDLLiteDescriptor*][transfer full]

### gupnp_didl_lite_object_get_write_status ()

    const char *
    gupnp_didl_lite_object_get_write_status
                                   (GUPnPDIDLLiteObject *object);

Get the write status of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The write status of the `object` , or `NULL`.

### gupnp_didl_lite_object_get_genre ()

    const char *
    gupnp_didl_lite_object_get_genre (GUPnPDIDLLiteObject *object);

Get the genre of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The genre of the `object` , or `NULL`.

### gupnp_didl_lite_object_get_upnp_class ()

    const char *
    gupnp_didl_lite_object_get_upnp_class (GUPnPDIDLLiteObject *object);

Get the UPnP class of the `object` .

#### Parameters

object | The GUPnPDIDLLiteObject |

#### Returns

The class of `object` , or `NULL`.

### gupnp_didl_lite_object_get_album ()

    const char *
    gupnp_didl_lite_object_get_album (GUPnPDIDLLiteObject *object);

Get the album of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The album of the `object` , or `NULL`.

### gupnp_didl_lite_object_get_album_art ()

    const char *
    gupnp_didl_lite_object_get_album_art (GUPnPDIDLLiteObject *object);

Get the URI to album art of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The URI to album art of the `object` , or `NULL`.

### gupnp_didl_lite_object_get_description ()

    const char *
    gupnp_didl_lite_object_get_description
                                   (GUPnPDIDLLiteObject *object);

Get the description of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The description of the `object` , or `NULL`.

### gupnp_didl_lite_object_get_date ()

    const char *
    gupnp_didl_lite_object_get_date (GUPnPDIDLLiteObject *object);

Get the date of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The date of the `object` , or `NULL`.

### gupnp_didl_lite_object_get_track_number ()

    int
    gupnp_didl_lite_object_get_track_number
                                   (GUPnPDIDLLiteObject *object);

Get the original track number of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The original track number of the `object` , or -1.

### gupnp_didl_lite_object_get_dlna_managed ()

    GUPnPOCMFlags
    gupnp_didl_lite_object_get_dlna_managed
                                   (GUPnPDIDLLiteObject *object);

Get the 'dlna:dlnaManaged' attribute of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The 'dlna:dlnaManaged' attribute of the `object` .

### gupnp_didl_lite_object_get_resources ()

    GList *
    gupnp_didl_lite_object_get_resources (GUPnPDIDLLiteObject *object);

Use this function to retreive resources from the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The list of resources belonging to `object` , or `NULL`. g_list_free the returned list after usage and unref each resource in it.

[element-type GUPnPDIDLLiteResource*][transfer full]

### gupnp_didl_lite_object_get_compat_resource ()

    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.

#### Parameters

object | GUPnPDIDLLiteObject |
sink_protocol_info | The SinkProtocolInfo string from MediaRenderer |
lenient | Enable lenient mode |

#### Returns

The resource belonging to `object` that is comaptible with any of the protocols specified in `sink_protocol_info` , or `NULL`. Unref after usage.

[transfer full]

### gupnp_didl_lite_object_add_resource ()

    GUPnPDIDLLiteResource *
    gupnp_didl_lite_object_add_resource (GUPnPDIDLLiteObject *object);

Creates a new resource, attaches it to `object` and returns it.

#### Parameters

object | A GUPnPDIDLLiteObject |

#### Returns

A new GUPnPDIDLLiteResource object. Unref after usage.

[transfer full]

### gupnp_didl_lite_object_add_descriptor ()

    GUPnPDIDLLiteDescriptor *
    gupnp_didl_lite_object_add_descriptor (GUPnPDIDLLiteObject *object);

Creates a new descriptor, attaches it to `object` and returns it.

#### Parameters

object | A GUPnPDIDLLiteObject |

#### Returns

A new GUPnPDIDLLiteDescriptor object. Unref after usage.

[transfer full]

### gupnp_didl_lite_object_set_upnp_class ()

    void
    gupnp_didl_lite_object_set_upnp_class (GUPnPDIDLLiteObject *object,
                                           const char *upnp_class);

Set the UPnP class of the `object` to `upnp_class` .

#### Parameters

object | The GUPnPDIDLLiteObject |
upnp_class | The UPnP class as string. |

### gupnp_didl_lite_object_set_id ()

    void
    gupnp_didl_lite_object_set_id (GUPnPDIDLLiteObject *object,
                                   const char *id);

Set the ID of the `object` to `id` .

#### Parameters

object | GUPnPDIDLLiteObject |
id | The ID |

### gupnp_didl_lite_object_set_parent_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` .

#### Parameters

object | GUPnPDIDLLiteObject |
parent_id | The parent ID |

### gupnp_didl_lite_object_set_restricted ()

    void
    gupnp_didl_lite_object_set_restricted (GUPnPDIDLLiteObject *object,
                                           gboolean restricted);

Set the restricted status of `object` to `restricted` .

#### Parameters

object | GUPnPDIDLLiteObject |
restricted | The restricted status |

### gupnp_didl_lite_object_set_title ()

    void
    gupnp_didl_lite_object_set_title (GUPnPDIDLLiteObject *object,
                                      const char *title);

Set the title of the `object` to `title` .

#### Parameters

object | GUPnPDIDLLiteObject |
title | The title |

### gupnp_didl_lite_object_set_creator ()

    void
    gupnp_didl_lite_object_set_creator (GUPnPDIDLLiteObject *object,
                                        const char *creator);

Set the creator of the `object` to `creator` .

#### Parameters

object | GUPnPDIDLLiteObject |
creator | The creator |

### gupnp_didl_lite_object_set_artist ()

    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` .

#### Parameters

object | The GUPnPDIDLLiteObject |
artist | The Artist |

### gupnp_didl_lite_object_set_author ()

    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` .

#### Parameters

object | The GUPnPDIDLLiteObject |
author | The Author |

### gupnp_didl_lite_object_add_creator ()

    GUPnPDIDLLiteContributor *
    gupnp_didl_lite_object_add_creator (GUPnPDIDLLiteObject *object);

`gupnp_didl_lite_object_add_creator` is deprecated and should not be used in newly-written code.

Add a new creator node to the `object` and return the associated GUPnPDIDLLiteContributor object.

#### Parameters

object | The GUPnPDIDLLiteObject |

#### Returns

A new GUPnPDIDLLiteContributor object. Unref after usage.

[transfer full]

### gupnp_didl_lite_object_add_artist ()

    GUPnPDIDLLiteContributor *
    gupnp_didl_lite_object_add_artist (GUPnPDIDLLiteObject *object);

Add a new Artist node to the `object` and return the associated GUPnPDIDLLiteContributor object.

#### Parameters

object | The GUPnPDIDLLiteObject |

#### Returns

A new GUPnPDIDLLiteContributor object. Unref after usage.

[transfer full]

### gupnp_didl_lite_object_add_author ()

    GUPnPDIDLLiteContributor *
    gupnp_didl_lite_object_add_author (GUPnPDIDLLiteObject *object);

Add a new author node to the `object` and return the associated GUPnPDIDLLiteContributor object.

#### Parameters

object | The GUPnPDIDLLiteObject |

#### Returns

A new GUPnPDIDLLiteContributor object. Unref after usage.

[transfer full]

### gupnp_didl_lite_object_set_genre ()

    void
    gupnp_didl_lite_object_set_genre (GUPnPDIDLLiteObject *object,
                                      const char *genre);

Set the genre of the `object` to `genre` .

#### Parameters

object | The GUPnPDIDLLiteObject |
genre | The Genre |

### gupnp_didl_lite_object_set_write_status ()

    void
    gupnp_didl_lite_object_set_write_status
                                   (GUPnPDIDLLiteObject *object,
                                    const char *write_status);

Set the write status of the `object` to `write_status` .

#### Parameters

object | GUPnPDIDLLiteObject |
write_status | The write status string |

### gupnp_didl_lite_object_set_album ()

    void
    gupnp_didl_lite_object_set_album (GUPnPDIDLLiteObject *object,
                                      const char *album);

Set the album of the `object` to `album` .

#### Parameters

object | GUPnPDIDLLiteObject |
album | The album string |

### gupnp_didl_lite_object_set_album_art ()

    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` .

#### Parameters

object | GUPnPDIDLLiteObject |
album_art | The URI of album art |

### gupnp_didl_lite_object_set_description ()

    void
    gupnp_didl_lite_object_set_description
                                   (GUPnPDIDLLiteObject *object,
                                    const char *description);

Set the description of the `object` to `description` .

#### Parameters

object | GUPnPDIDLLiteObject |
description | The description string |

### gupnp_didl_lite_object_set_date ()

    void
    gupnp_didl_lite_object_set_date (GUPnPDIDLLiteObject *object,
                                     const char *date);

Set the date of the `object` to `date` .

#### Parameters

object | GUPnPDIDLLiteObject |
date | The date string |

### gupnp_didl_lite_object_set_track_number ()

    void
    gupnp_didl_lite_object_set_track_number
                                   (GUPnPDIDLLiteObject *object,
                                    int track_number);

Set the original track number of the `object` to `track_number` .

#### Parameters

object | GUPnPDIDLLiteObject |
track_number | The original track number |

### gupnp_didl_lite_object_set_dlna_managed ()

    void
    gupnp_didl_lite_object_set_dlna_managed
                                   (GUPnPDIDLLiteObject *object,
                                    GUPnPOCMFlags dlna_managed);

Set the 'dlna:dlnaManaged' attribute of the `object` to `dlna_managed` .

#### Parameters

object | GUPnPDIDLLiteObject |
dlna_managed | The GUPnPOCMFlags. |

### gupnp_didl_lite_object_apply_fragments ()

    GUPnPDIDLLiteFragmentResult
    gupnp_didl_lite_object_apply_fragments
                                   (GUPnPDIDLLiteObject *object,
                                    gchar **current_fragments,
                                    gint current_size,
                                    gchar **new_fragments,
                                    gint new_size);

Updates object by applying `new_fragments` in places of `current_fragments` . For `current_size` and `new_size` -1 can be passed when respectively `current_fragments` and `new_fragments` are NULL terminated.

#### Parameters

object | The GUPnPDIDLLiteObject |
current_fragments | XML fragments of `object` . | [array length=current_size][transfer none]
current_size | Size of `current_fragments` or -1. |
new_fragments | Substitutes for `current_fragments` . | [array length=new_size][transfer none]
new_size | Size of `new_fragments` or -1. |

#### Returns

Result of operation.

### gupnp_didl_lite_object_get_album_xml_string ()

    char *
    gupnp_didl_lite_object_get_album_xml_string
                                   (GUPnPDIDLLiteObject *object);

Creates a string representation of the DIDL-Lite XML fragment related to the object album.

#### Parameters

object | A GUPnPDIDLLiteObject |

#### Returns

A DIDL-Lite XML fragment string, or `NULL`. g_free after usage.

### gupnp_didl_lite_object_get_artists_xml_string ()

    char *
    gupnp_didl_lite_object_get_artists_xml_string
                                   (GUPnPDIDLLiteObject *object);

Creates a string representation of the DIDL-Lite XML fragments related to the object artists.

#### Parameters

object | A GUPnPDIDLLiteObject |

#### Returns

A DIDL-Lite XML fragment string, or `NULL`. g_free after usage.

### gupnp_didl_lite_object_get_date_xml_string ()

    char *
    gupnp_didl_lite_object_get_date_xml_string
                                   (GUPnPDIDLLiteObject *object);

Creates a string representation of the DIDL-Lite XML fragment related to the object date.

#### Parameters

object | A GUPnPDIDLLiteObject |

#### Returns

A DIDL-Lite XML fragment string, or `NULL`. g_free after usage.

### gupnp_didl_lite_object_get_title_xml_string ()

    char *
    gupnp_didl_lite_object_get_title_xml_string
                                   (GUPnPDIDLLiteObject *object);

Creates a string representation of the DIDL-Lite XML fragment related to the object title.

#### Parameters

object | A GUPnPDIDLLiteObject |

#### Returns

A DIDL-Lite XML fragment string, or `NULL`. g_free after usage.

### gupnp_didl_lite_object_get_track_number_xml_string ()

    char *
    gupnp_didl_lite_object_get_track_number_xml_string
                                   (GUPnPDIDLLiteObject *object);

Creates a string representation of the DIDL-Lite XML fragment related to the object track number.

#### Parameters

object | A GUPnPDIDLLiteObject |

#### Returns

A DIDL-Lite XML fragment string, or `NULL`. g_free after usage.

### gupnp_didl_lite_object_get_update_id ()

    guint
    gupnp_didl_lite_object_get_update_id (GUPnPDIDLLiteObject *object);

Get the update ID of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

The update ID of the `object` .

### gupnp_didl_lite_object_get_upnp_class_xml_string ()

    char *
    gupnp_didl_lite_object_get_upnp_class_xml_string
                                   (GUPnPDIDLLiteObject *object);

Creates a string representation of the DIDL-Lite XML fragment related to the object UPnP class.

#### Parameters

object | A GUPnPDIDLLiteObject |

#### Returns

A DIDL-Lite XML fragment string, or `NULL`. g_free after usage.

### gupnp_didl_lite_object_get_xml_string ()

    char *
    gupnp_didl_lite_object_get_xml_string (GUPnPDIDLLiteObject *object);

Get the representation of this object as an XML string.

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

XML representation of this object as string.

[transfer full]

### gupnp_didl_lite_object_set_update_id ()

    void
    gupnp_didl_lite_object_set_update_id (GUPnPDIDLLiteObject *object,
                                          guint update_id);

Set the update ID of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |
update_id | Update ID |

### gupnp_didl_lite_object_unset_artists ()

    void
    gupnp_didl_lite_object_unset_artists (GUPnPDIDLLiteObject *object);

Unset the artists properties of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

### gupnp_didl_lite_object_unset_update_id ()

    void
    gupnp_didl_lite_object_unset_update_id
                                   (GUPnPDIDLLiteObject *object);

Unset the update ID property of the `object` .

#### Parameters

object | GUPnPDIDLLiteObject |

### gupnp_didl_lite_object_update_id_is_set ()

    gboolean
    gupnp_didl_lite_object_update_id_is_set
                                   (GUPnPDIDLLiteObject *object);

Get whether the update ID of the `object` is set.

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

`TRUE` if update ID is set, otherwise `FALSE`

### gupnp_didl_lite_object_is_restricted_set ()

    gboolean
    gupnp_didl_lite_object_is_restricted_set
                                   (GUPnPDIDLLiteObject *object);

Whehter the restricted attribute exists on `object`

#### Parameters

object | GUPnPDIDLLiteObject |

#### Returns

TRUE if restricted exists, FALSE otherwise.

## Types and Values

### GUPnPDIDLLiteObject

    typedef struct _GUPnPDIDLLiteObject GUPnPDIDLLiteObject;

### enum 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.

#### Members

GUPNP_OCM_FLAGS_NONE | No flags |
GUPNP_OCM_FLAGS_UPLOAD | Indicates support for content upload. |
GUPNP_OCM_FLAGS_CREATE_CONTAINER | Indicates support for creation of child container. |
GUPNP_OCM_FLAGS_DESTROYABLE | This object is destroyable. |
GUPNP_OCM_FLAGS_UPLOAD_DESTROYABLE | Indicates support for upload of destroyable content. |
GUPNP_OCM_FLAGS_CHANGE_METADATA | Indicates support for changing metadata. |

### enum GUPnPDIDLLiteFragmentResult

Possible return values of the `gupnp_didl_lite_object_apply_fragments()` call.

#### Members

GUPNP_DIDL_LITE_FRAGMENT_RESULT_OK | Operation succeeded. |
GUPNP_DIDL_LITE_FRAGMENT_RESULT_CURRENT_BAD_XML | Current set of fragments is bad XML |
GUPNP_DIDL_LITE_FRAGMENT_RESULT_NEW_BAD_XML | New set of fragments is bad XML |
GUPNP_DIDL_LITE_FRAGMENT_RESULT_CURRENT_INVALID | Current set of fragments is invalid |
GUPNP_DIDL_LITE_FRAGMENT_RESULT_NEW_INVALID | New set of fragments is invalid |
GUPNP_DIDL_LITE_FRAGMENT_RESULT_REQUIRED_TAG | Trying to remove a required tag |
GUPNP_DIDL_LITE_FRAGMENT_RESULT_READONLY_TAG | Trying to modify or remove a read-only tag |
GUPNP_DIDL_LITE_FRAGMENT_RESULT_MISMATCH | Length of the two fragment sets does not match |
GUPNP_DIDL_LITE_FRAGMENT_RESULT_UNKNOWN_ERROR | General error sink if none of the others applies. |

## Property Details

### The `“album”` property

      “album”                    gchar *

The album of this object.

Flags: Read / Write

Default value: NULL

### The `“album-art”` property

      “album-art”                gchar *

The URI to album art of this object.

Flags: Read / Write

Default value: NULL

### The `“artist”` property

      “artist”                   gchar *

The artist of this object.

`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.

Flags: Read / Write

Default value: NULL

### The `“author”` property

      “author”                   gchar *

The author of this object.

`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.

Flags: Read / Write

Default value: NULL

### The `“creator”` property

      “creator”                  gchar *

The creator of this object.

Flags: Read / Write

Default value: NULL

### The `“date”` property

      “date”                     gchar *

The date of this object.

Flags: Read / Write

Default value: NULL

### The `“dc-namespace”` property

      “dc-namespace”             gpointer

Pointer to the DublinCore namespace registered with the XML document containing this object.

Flags: Read / Write / Construct Only

### The `“description”` property

      “description”              gchar *

The description of this object.

Flags: Read / Write

Default value: NULL

### The `“dlna-managed”` property

      “dlna-managed”             GUPnPOCMFlags

The 'dlna:dlnaManaged' attribute.

Flags: Read / Write

### The `“dlna-namespace”` property

      “dlna-namespace”           gpointer

Pointer to the DLNA metadata namespace registered with the XML document containing this object.

Flags: Read / Write / Construct Only

### The `“genre”` property

      “genre”                    gchar *

The genre of this object.

Flags: Read / Write

Default value: NULL

### The `“id”` property

      “id”                       gchar *

The ID of this object.

Flags: Read / Write

Default value: NULL

### The `“parent-id”` property

      “parent-id”                gchar *

The ID of the parent container of this object.

Flags: Read / Write

Default value: NULL

### The `“pv-namespace”` property

      “pv-namespace”             gpointer

Pointer to the PV metadata namespace registered with the XML document containing this object.

Flags: Read / Write / Construct Only

### The `“restricted”` property

      “restricted”               gboolean

Whether this object is restricted.

Flags: Read / Write

Default value: FALSE

### The `“title”` property

      “title”                    gchar *

The title of this object.

Flags: Read / Write

Default value: NULL

### The `“track-number”` property

      “track-number”             gint

The original track number of this object.

Flags: Read / Write

Allowed values: >= -1

Default value: -1

### The `“update-id”` property

      “update-id”                guint

Update ID of this object.

Flags: Read / Write

Default value: 0

### The `“upnp-class”` property

      “upnp-class”               gchar *

The UPnP class of this object.

Flags: Read / Write

Default value: NULL

### The `“upnp-namespace”` property

      “upnp-namespace”           gpointer

Pointer to the UPnP namespace registered with the XML document containing this object.

Flags: Read / Write / Construct Only

### The `“write-status”` property

      “write-status”             gchar *

The write status of this object.

Flags: Read / Write

Default value: NULL

### The `“xml-doc”` property

      “xml-doc”                  GUPnPAVXMLDoc *

The reference to XML document containing this object.

Internal property.

Flags: Write / Construct Only

Stability Level: Private

### The `“xml-node”` property

      “xml-node”                 gpointer

The pointer to object node in XML document.

Flags: Read / Write / Construct Only