GUPnPDIDLLiteContainer

## GUPnPDIDLLiteContainer GUPnPDIDLLiteContainer — DIDL-Lite Container |

## Synopsis

                        GUPnPDIDLLiteContainer;
    gboolean            gupnp_didl_lite_container_get_searchable
                                                            (GUPnPDIDLLiteContainer *container);
    gint                gupnp_didl_lite_container_get_child_count
                                                            (GUPnPDIDLLiteContainer *container);
    GList *             gupnp_didl_lite_container_get_create_classes
                                                            (GUPnPDIDLLiteContainer *container);
    GList *             gupnp_didl_lite_container_get_search_classes
                                                            (GUPnPDIDLLiteContainer *container);
    gint64              gupnp_didl_lite_container_get_storage_used
                                                            (GUPnPDIDLLiteContainer *container);
    void                gupnp_didl_lite_container_set_searchable
                                                            (GUPnPDIDLLiteContainer *container,
                                                             gboolean searchable);
    void                gupnp_didl_lite_container_set_child_count
                                                            (GUPnPDIDLLiteContainer *container,
                                                             gint child_count);
    void                gupnp_didl_lite_container_set_storage_used
                                                            (GUPnPDIDLLiteContainer *container,
                                                             gint64 storage_used);
    void                gupnp_didl_lite_container_add_create_class
                                                            (GUPnPDIDLLiteContainer *container,
                                                             const char *create_class);
    void                gupnp_didl_lite_container_add_create_class_full
                                                            (GUPnPDIDLLiteContainer *container,
                                                             const char *create_class,
                                                             gboolean include_derived);
    void                gupnp_didl_lite_container_add_search_class
                                                            (GUPnPDIDLLiteContainer *container,
                                                             const char *search_class);
    void                gupnp_didl_lite_container_add_search_class_full
                                                            (GUPnPDIDLLiteContainer *container,
                                                             const char *search_class,
                                                             gboolean include_derived);
    gboolean            gupnp_didl_lite_container_container_update_id_is_set
                                                            (GUPnPDIDLLiteContainer *container);
    guint               gupnp_didl_lite_container_get_container_update_id
                                                            (GUPnPDIDLLiteContainer *container);
    GList *             gupnp_didl_lite_container_get_create_classes_full
                                                            (GUPnPDIDLLiteContainer *container);
    guint               gupnp_didl_lite_container_get_total_deleted_child_count
                                                            (GUPnPDIDLLiteContainer *container);
    void                gupnp_didl_lite_container_set_container_update_id
                                                            (GUPnPDIDLLiteContainer *container,
                                                             guint update_id);
    void                gupnp_didl_lite_container_set_total_deleted_child_count
                                                            (GUPnPDIDLLiteContainer *container,
                                                             guint count);
    gboolean            gupnp_didl_lite_container_total_deleted_child_count_is_set
                                                            (GUPnPDIDLLiteContainer *container);
    void                gupnp_didl_lite_container_unset_container_update_id
                                                            (GUPnPDIDLLiteContainer *container);
    void                gupnp_didl_lite_container_unset_total_deleted_child_count
                                                            (GUPnPDIDLLiteContainer *container);

## Object Hierarchy

      GObject
       +----GUPnPDIDLLiteObject
             +----GUPnPDIDLLiteContainer

## Properties

      "child-count"              gint                  : Read / Write
      "container-update-id"      guint                 : Read / Write
      "searchable"               gboolean              : Read / Write
      "storage-used"             gint64                : Read / Write
      "total-deleted-child-count" guint                 : Read / Write

## Description

GUPnPDIDLLiteContainer respresents a DIDL-Lite container element.

## Details

### GUPnPDIDLLiteContainer

    typedef struct _GUPnPDIDLLiteContainer GUPnPDIDLLiteContainer;

### gupnp_didl_lite_container_get_searchable ()

    gboolean            gupnp_didl_lite_container_get_searchable
                                                            (GUPnPDIDLLiteContainer *container);

Checks whether `container` is searchable.

`container` : | GUPnPDIDLLiteContainer
Returns : | TRUE if `container` is searchable.

### gupnp_didl_lite_container_get_child_count ()

    gint                gupnp_didl_lite_container_get_child_count
                                                            (GUPnPDIDLLiteContainer *container);

Get the child count of the `container`. If the child count is unknown, -1 is returned.

`container` : | GUPnPDIDLLiteContainer
Returns : | The child count of the `container`, or -1 if it is unknown.

### gupnp_didl_lite_container_get_create_classes ()

    GList *             gupnp_didl_lite_container_get_create_classes
                                                            (GUPnPDIDLLiteContainer *container);

Gets the list of create classes of the `container`.

`container` : | GUPnPDIDLLiteContainer
Returns : | The list of create classes belonging to `container`, or `NULL`. g_list_free the returned list after usage and g_free each string in it. [element-type utf8][transfer full]

### gupnp_didl_lite_container_get_search_classes ()

    GList *             gupnp_didl_lite_container_get_search_classes
                                                            (GUPnPDIDLLiteContainer *container);

Gets the list of search classes of the `container`.

`container` : | GUPnPDIDLLiteContainer
Returns : | The list of search classes belonging to `container`, or `NULL`. g_list_free the returned list after usage and g_free each string in it. [element-type utf8][transfer full]

### gupnp_didl_lite_container_get_storage_used ()

    gint64              gupnp_didl_lite_container_get_storage_used
                                                            (GUPnPDIDLLiteContainer *container);

Get the number of bytes used by all child items of the `container`. If storage used is unknown, -1 is returned.

`container` : | GUPnPDIDLLiteContainer
Returns : | The number of bytes used by all children of the `container`, or -1 if it is unknown.

### gupnp_didl_lite_container_set_searchable ()

    void                gupnp_didl_lite_container_set_searchable
                                                            (GUPnPDIDLLiteContainer *container,
                                                             gboolean searchable);

(Un)set the searchibility of `container`.

`container` : | GUPnPDIDLLiteContainer
`searchable` : | The searchibility

### gupnp_didl_lite_container_set_child_count ()

    void                gupnp_didl_lite_container_set_child_count
                                                            (GUPnPDIDLLiteContainer *container,
                                                             gint child_count);

Set the child count of the `container`.

`container` : | GUPnPDIDLLiteContainer
`child_count` : | The child count

### gupnp_didl_lite_container_set_storage_used ()

    void                gupnp_didl_lite_container_set_storage_used
                                                            (GUPnPDIDLLiteContainer *container,
                                                             gint64 storage_used);

Set the number of bytes used by all child items of the `container`.

`container` : | GUPnPDIDLLiteContainer
`storage_used` : | The number of bytes used by all child items of the `container` or -1 if unknown.

### gupnp_didl_lite_container_add_create_class ()

    void                gupnp_didl_lite_container_add_create_class
                                                            (GUPnPDIDLLiteContainer *container,
                                                             const char *create_class);

Add a new create class to the `container`. includeDerived defaults to "0".

`container` : | GUPnPDIDLLiteContainer
`create_class` : | The createClass to add.
Returns : | None.

### gupnp_didl_lite_container_add_create_class_full ()

    void                gupnp_didl_lite_container_add_create_class_full
                                                            (GUPnPDIDLLiteContainer *container,
                                                             const char *create_class,
                                                             gboolean include_derived);

Add a new create class to the `container`.

`container` : | GUPnPDIDLLiteContainer
`create_class` : | The createClass to add.
`include_derived` : | Whether object with dervied classes may be created in this container or not.
Returns : | None.

### gupnp_didl_lite_container_add_search_class ()

    void                gupnp_didl_lite_container_add_search_class
                                                            (GUPnPDIDLLiteContainer *container,
                                                             const char *search_class);

Add a new search class to the `container`.

`container` : | GUPnPDIDLLiteContainer
`search_class` : | The searchClass to add.
Returns : | None.

### gupnp_didl_lite_container_add_search_class_full ()

    void                gupnp_didl_lite_container_add_search_class_full
                                                            (GUPnPDIDLLiteContainer *container,
                                                             const char *search_class,
                                                             gboolean include_derived);

Add a new search class to the `container`.

`container` : | GUPnPDIDLLiteContainer
`search_class` : | The searchClass to add.
`include_derived` : | includeDerived attribute of the DIDL
Returns : | None.

### gupnp_didl_lite_container_container_update_id_is_set ()

    gboolean            gupnp_didl_lite_container_container_update_id_is_set
                                                            (GUPnPDIDLLiteContainer *container);

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

`container` : | GUPnPDIDLLiteContainer
Returns : | `TRUE` if update ID is set, otherwise `FALSE`

### gupnp_didl_lite_container_get_container_update_id ()

    guint               gupnp_didl_lite_container_get_container_update_id
                                                            (GUPnPDIDLLiteContainer *container);

Get the container update ID of the `container`.

`container` : | GUPnPDIDLLiteContainer
Returns : | The container update ID of the `container`.

### gupnp_didl_lite_container_get_create_classes_full ()

    GList *             gupnp_didl_lite_container_get_create_classes_full
                                                            (GUPnPDIDLLiteContainer *container);

Gets the list of create classes of the `container`.

`container` : | GUPnPDIDLLiteContainer
Returns : | The list of create classes belonging to `container`, or `NULL`. g_list_free the returned list after usage and unref each object in it. [element-type GUPnPDIDLLiteCreateClass*][transfer full]

### gupnp_didl_lite_container_get_total_deleted_child_count ()

    guint               gupnp_didl_lite_container_get_total_deleted_child_count
                                                            (GUPnPDIDLLiteContainer *container);

Get the total deleted child count of the `container`.

`container` : | GUPnPDIDLLiteContainer
Returns : | The total deleted child count of the `container`.

### gupnp_didl_lite_container_set_container_update_id ()

    void                gupnp_didl_lite_container_set_container_update_id
                                                            (GUPnPDIDLLiteContainer *container,
                                                             guint update_id);

Set the container update ID of the `container`.

`container` : | GUPnPDIDLLiteContainer
`update_id` : | The container update ID

### gupnp_didl_lite_container_set_total_deleted_child_count ()

    void                gupnp_didl_lite_container_set_total_deleted_child_count
                                                            (GUPnPDIDLLiteContainer *container,
                                                             guint count);

Set the container update ID of the `container`.

`container` : | GUPnPDIDLLiteContainer
`count` : | The container update ID

### gupnp_didl_lite_container_total_deleted_child_count_is_set ()

    gboolean            gupnp_didl_lite_container_total_deleted_child_count_is_set
                                                            (GUPnPDIDLLiteContainer *container);

Get whether the total deleted child conut of the `container` is set.

`container` : | GUPnPDIDLLiteContainer
Returns : | `TRUE` if property is set, otherwise `FALSE`

### gupnp_didl_lite_container_unset_container_update_id ()

    void                gupnp_didl_lite_container_unset_container_update_id
                                                            (GUPnPDIDLLiteContainer *container);

Unset the container update ID property of the `container`.

`container` : | GUPnPDIDLLiteContainer

### gupnp_didl_lite_container_unset_total_deleted_child_count ()

    void                gupnp_didl_lite_container_unset_total_deleted_child_count
                                                            (GUPnPDIDLLiteContainer *container);

Unset the total deleted child count property of the `container`.

`container` : | GUPnPDIDLLiteContainer

## Property Details

### The `"child-count"` property

      "child-count"              gint                  : Read / Write

The child count of this container.

Allowed values: >= 0

Default value: 0

### The `"container-update-id"` property

      "container-update-id"      guint                 : Read / Write

Update ID of this container.

Default value: 0

### The `"searchable"` property

      "searchable"               gboolean              : Read / Write

Whether this container is searchable.

Default value: FALSE

### The `"storage-used"` property

      "storage-used"             gint64                : Read / Write

The number of bytes used by all child items of this container.

Allowed values: >= -1

Default value: -1

### The `"total-deleted-child-count"` property

      "total-deleted-child-count" guint                 : Read / Write

Total deleted child count of this container.

Default value: 0