GUPnPDIDLLiteObject

typedef struct _GUPnPDIDLLiteObject GUPnPDIDLLiteObject;

enum GUPnPOCMFlags

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.

enum GUPnPDIDLLiteFragmentResult

typedef enum {
      GUPNP_DIDL_LITE_FRAGMENT_RESULT_OK,
      GUPNP_DIDL_LITE_FRAGMENT_RESULT_CURRENT_BAD_XML,
      GUPNP_DIDL_LITE_FRAGMENT_RESULT_NEW_BAD_XML,
      GUPNP_DIDL_LITE_FRAGMENT_RESULT_CURRENT_INVALID,
      GUPNP_DIDL_LITE_FRAGMENT_RESULT_NEW_INVALID,
      GUPNP_DIDL_LITE_FRAGMENT_RESULT_REQUIRED_TAG,
      GUPNP_DIDL_LITE_FRAGMENT_RESULT_READONLY_TAG,
      GUPNP_DIDL_LITE_FRAGMENT_RESULT_MISMATCH,
      GUPNP_DIDL_LITE_FRAGMENT_RESULT_UNKNOWN_ERROR
} GUPnPDIDLLiteFragmentResult;

Possible return values of the gupnp_didl_lite_object_apply_fragments() call.

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.

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.

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.

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.

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.

gupnp_didl_lite_object_get_id ()

const char *        gupnp_didl_lite_object_get_id       (GUPnPDIDLLiteObject *object);

Get the ID of the object.

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.

gupnp_didl_lite_object_get_restricted ()

gboolean            gupnp_didl_lite_object_get_restricted
                                                        (GUPnPDIDLLiteObject *object);

Whether the object is restricted or not.

gupnp_didl_lite_object_get_title ()

const char *        gupnp_didl_lite_object_get_title    (GUPnPDIDLLiteObject *object);

Get the title of the object.

gupnp_didl_lite_object_get_creator ()

const char *        gupnp_didl_lite_object_get_creator  (GUPnPDIDLLiteObject *object);

Get the creator of the object.

gupnp_didl_lite_object_get_artist ()

const char *        gupnp_didl_lite_object_get_artist   (GUPnPDIDLLiteObject *object);

Get the artist of the object. If role is not NULL, it is set to the role of the artist if available.

gupnp_didl_lite_object_get_author ()

const char *        gupnp_didl_lite_object_get_author   (GUPnPDIDLLiteObject *object);

Get the author of the object.

gupnp_didl_lite_object_get_creators ()

GList *             gupnp_didl_lite_object_get_creators (GUPnPDIDLLiteObject *object);

Get the creators of the object.

gupnp_didl_lite_object_get_artists ()

GList *             gupnp_didl_lite_object_get_artists  (GUPnPDIDLLiteObject *object);

Get the artists of the object.

gupnp_didl_lite_object_get_authors ()

GList *             gupnp_didl_lite_object_get_authors  (GUPnPDIDLLiteObject *object);

Get the authors of the object.

gupnp_didl_lite_object_get_descriptors ()

GList *             gupnp_didl_lite_object_get_descriptors
                                                        (GUPnPDIDLLiteObject *object);

Get the descriptors of the object.

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.

gupnp_didl_lite_object_get_genre ()

const char *        gupnp_didl_lite_object_get_genre    (GUPnPDIDLLiteObject *object);

Get the genre of the object.

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.

gupnp_didl_lite_object_get_album ()

const char *        gupnp_didl_lite_object_get_album    (GUPnPDIDLLiteObject *object);

Get the album of the object.

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.

gupnp_didl_lite_object_get_description ()

const char *        gupnp_didl_lite_object_get_description
                                                        (GUPnPDIDLLiteObject *object);

Get the description of the object.

gupnp_didl_lite_object_get_date ()

const char *        gupnp_didl_lite_object_get_date     (GUPnPDIDLLiteObject *object);

Get the date of the object.

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.

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.

gupnp_didl_lite_object_get_resources ()

GList *             gupnp_didl_lite_object_get_resources
                                                        (GUPnPDIDLLiteObject *object);

Use this function to retreive resources from the object.

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.

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.

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.

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.

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.

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.

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.

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.

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.

gupnp_didl_lite_object_set_artist ()

void                gupnp_didl_lite_object_set_artist   (GUPnPDIDLLiteObject *object,
                                                         const char *artist);

Set the Artist of the object to artist.

gupnp_didl_lite_object_set_author ()

void                gupnp_didl_lite_object_set_author   (GUPnPDIDLLiteObject *object,
                                                         const char *author);

Set the Author of the object to author.

gupnp_didl_lite_object_add_creator ()

GUPnPDIDLLiteContributor * gupnp_didl_lite_object_add_creator
                                                        (GUPnPDIDLLiteObject *object);

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

gupnp_didl_lite_object_get_update_id ()

guint               gupnp_didl_lite_object_get_update_id
                                                        (GUPnPDIDLLiteObject *object);

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

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.

gupnp_didl_lite_object_unset_artists ()

void                gupnp_didl_lite_object_unset_artists
                                                        (GUPnPDIDLLiteObject *object);

Unset the artists properties of the object.

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.

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.

The "album" property

  "album"                    gchar*                : Read / Write

The album of this object.

Default value: NULL

The "album-art" property

  "album-art"                gchar*                : Read / Write

The URI to album art of this object.

Default value: NULL

The "artist" property

  "artist"                   gchar*                : Read / Write

The artist of this object.

Default value: NULL

The "author" property

  "author"                   gchar*                : Read / Write

The author of this object.

Default value: NULL

The "creator" property

  "creator"                  gchar*                : Read / Write

The creator of this object.

Default value: NULL

The "date" property

  "date"                     gchar*                : Read / Write

The date of this object.

Default value: NULL

The "dc-namespace" property

  "dc-namespace"             gpointer              : Read / Write / Construct Only

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

The "description" property

  "description"              gchar*                : Read / Write

The description of this object.

Default value: NULL

The "dlna-managed" property

  "dlna-managed"             GUPnPOCMFlags         : Read / Write

The 'dlna:dlnaManaged' attribute.

The "dlna-namespace" property

  "dlna-namespace"           gpointer              : Read / Write / Construct Only

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

The "genre" property

  "genre"                    gchar*                : Read / Write

The genre of this object.

Default value: NULL

The "id" property

  "id"                       gchar*                : Read / Write

The ID of this object.

Default value: NULL

The "parent-id" property

  "parent-id"                gchar*                : Read / Write

The ID of the parent container of this object.

Default value: NULL

The "restricted" property

  "restricted"               gboolean              : Read / Write

Whether this object is restricted.

Default value: FALSE

The "title" property

  "title"                    gchar*                : Read / Write

The title of this object.

Default value: NULL

The "track-number" property

  "track-number"             gint                  : Read / Write

The original track number of this object.

Allowed values: >= G_MAXULONG

Default value: -1

The "update-id" property

  "update-id"                guint                 : Read / Write

Update ID of this object.

Default value: 0

The "upnp-class" property

  "upnp-class"               gchar*                : Read / Write

The UPnP class of this object.

Default value: NULL

The "upnp-namespace" property

  "upnp-namespace"           gpointer              : Read / Write / Construct Only

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

The "write-status" property

  "write-status"             gchar*                : Read / Write

The write status of this object.

Default value: NULL

The "xml-doc" property

  "xml-doc"                  GUPnPXMLDoc*          : Write / Construct Only

The reference to XML document containing this object.

Internal property.

Stability Level: Private

The "xml-node" property

  "xml-node"                 gpointer              : Read / Write / Construct Only

The pointer to object node in XML document.