GUPnPDIDLLiteObject

GUPnPDIDLLiteObject — DIDL-Lite Object

Synopsis

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_write_status
                                                        (GUPnPDIDLLiteObject *object);
const char*         gupnp_didl_lite_object_get_upnp_class
                                                        (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);

Description

GUPnPDIDLLiteObject respresent a DIDL-Lite object element.

Details

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.

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.

gupnp_didl_lite_object_get_id ()

const char*         gupnp_didl_lite_object_get_id       (GUPnPDIDLLiteObject *object);

Get the ID of the object.

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.

object : GUPnPDIDLLiteObject
Returns : The ID of parent of the object, or NULL. g_free after usage.

gupnp_didl_lite_object_get_restricted ()

gboolean            gupnp_didl_lite_object_get_restricted
                                                        (GUPnPDIDLLiteObject *object);

Whether the object is restricted or not.

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.

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.

object : GUPnPDIDLLiteObject
Returns : The creator of the object, or NULL.

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.

object : GUPnPDIDLLiteObject
Returns : The write status 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.

object : The GUPnPDIDLLiteObject
Returns : The class of object, or NULL.

gupnp_didl_lite_object_get_resources ()

GList*              gupnp_didl_lite_object_get_resources
                                                        (GUPnPDIDLLiteObject *object);

Use this function to retreive resources from the object.

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.

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.

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.
Generated by GTK-Doc V1.10