GUPnPMediaCollection

## GUPnPMediaCollection GUPnPMediaCollection — Media collection writer |

## Synopsis

    struct              GUPnPMediaCollection;
    GUPnPMediaCollection * gupnp_media_collection_new       (void);
    GUPnPMediaCollection * gupnp_media_collection_new_from_string
                                                            (const char *data);
    void                gupnp_media_collection_set_title    (GUPnPMediaCollection *collection,
                                                             const char *title);
    const char *        gupnp_media_collection_get_title    (GUPnPMediaCollection *collection);
    void                gupnp_media_collection_set_author   (GUPnPMediaCollection *collection,
                                                             const char *author);
    const char *        gupnp_media_collection_get_author   (GUPnPMediaCollection *collection);
    GUPnPDIDLLiteItem * gupnp_media_collection_add_item     (GUPnPMediaCollection *collection);
    char *              gupnp_media_collection_get_string   (GUPnPMediaCollection *collection);
    GList *             gupnp_media_collection_get_items    (GUPnPMediaCollection *collection);
    gboolean            gupnp_media_collection_get_mutable  (GUPnPMediaCollection *collection);

## Object Hierarchy

      GObject
       +----GUPnPMediaCollection

## Properties

      "author"                   gchar*                : Read / Write / Construct
      "data"                     gchar*                : Write / Construct Only
      "mutable"                  gboolean              : Read
      "title"                    gchar*                : Read / Write / Construct

## Description

GUPnPMediaCollection is a helper class for writing media collection files.

## Details

### struct GUPnPMediaCollection

    struct GUPnPMediaCollection;

### gupnp_media_collection_new ()

    GUPnPMediaCollection * gupnp_media_collection_new       (void);

Create a new writable media collection.

Returns : | A new GUPnPMediaCollection. [transfer full]

### gupnp_media_collection_new_from_string ()

    GUPnPMediaCollection * gupnp_media_collection_new_from_string
                                                            (const char *data);

Parse a new GUPnPMediaCollection from a block of XML data.

`data` : | XML string.
Returns : | A new GUPnPMediaCollection. [transfer full]

### gupnp_media_collection_set_title ()

    void                gupnp_media_collection_set_title    (GUPnPMediaCollection *collection,
                                                             const char *title);

Set the title of a GUPnPMediaCollection.

`collection` : | GUPnPMediaCollection
`title` : | New Title of this collection;

### gupnp_media_collection_get_title ()

    const char *        gupnp_media_collection_get_title    (GUPnPMediaCollection *collection);

`collection` : | GUPnPMediaCollection
Returns : | The title of this media collection or `NULL` if not set.

### gupnp_media_collection_set_author ()

    void                gupnp_media_collection_set_author   (GUPnPMediaCollection *collection,
                                                             const char *author);

Set the author of the media collection

`collection` : | GUPnPMediaCollection
`author` : | New author of this media collection.

### gupnp_media_collection_get_author ()

    const char *        gupnp_media_collection_get_author   (GUPnPMediaCollection *collection);

`collection` : | GUPnPMediaCollection
Returns : | The author of this media collection or `NULL` if not set.

### gupnp_media_collection_add_item ()

    GUPnPDIDLLiteItem * gupnp_media_collection_add_item     (GUPnPMediaCollection *collection);

`collection` : | GUPnPMediaCollection
Returns : | A new GUPnPDIDLLiteItem object. Unref after use. [transfer full]

### gupnp_media_collection_get_string ()

    char *              gupnp_media_collection_get_string   (GUPnPMediaCollection *collection);

`collection` : | GUPnPMediaCollection
Returns : | XML string representing this media collection. `g_free()` after use. If the colleciton is not mutable, returns a copy of the original string. [transfer full]

### gupnp_media_collection_get_items ()

    GList *             gupnp_media_collection_get_items    (GUPnPMediaCollection *collection);

`collection` : | GUPnPMediaCollection
Returns : | A GList containing the elemens of this collection, in proper order. Unref all items and free the list after use. [transfer full][element-type GUPnPDIDLLiteItem]

### gupnp_media_collection_get_mutable ()

    gboolean            gupnp_media_collection_get_mutable  (GUPnPMediaCollection *collection);

`collection` : | GUPnPMediaCollection
Returns : | TRUE if the collections is modifiable, FALSE otherwise.

## Property Details

### The `"author"` property

      "author"                   gchar*                : Read / Write / Construct

The author of this media collection.

Default value: NULL

### The `"data"` property

      "data"                     gchar*                : Write / Construct Only

Block of data to parse a collection from. If data is set upon construction it will override the other properties and create a unmutable collection parsed from data.

Default value: NULL

### The `"mutable"` property

      "mutable"                  gboolean              : Read

Whether this media collation is modifyable or not.

Default value: FALSE

### The `"title"` property

      "title"                    gchar*                : Read / Write / Construct

The title of this media collection.

Default value: NULL