RygelMediaItem

## RygelMediaItem RygelMediaItem — Represents a media item (Music, Video or Image). |

## Synopsis

    #define             RYGEL_TYPE_MEDIA_ITEM
    RygelDataSource *   rygel_media_item_create_stream_source
                                                            (RygelMediaItem *self,
                                                             const gchar *host_ip);
    gboolean            rygel_media_item_is_live_stream     (RygelMediaItem *self);
    gboolean            rygel_media_item_streamable         (RygelMediaItem *self);
    void                rygel_media_item_add_uri            (RygelMediaItem *self,
                                                             const gchar *uri);
    GUPnPProtocolInfo * rygel_media_item_get_protocol_info  (RygelMediaItem *self,
                                                             const gchar *uri,
                                                             const gchar *protocol);
    void                rygel_media_item_add_resources      (RygelMediaItem *self,
                                                             GUPnPDIDLLiteItem *didl_item,
                                                             gboolean allow_internal,
                                                             GError **error);
    gint64              rygel_media_item_get_size           (RygelMediaItem *self);
    void                rygel_media_item_set_size           (RygelMediaItem *self,
                                                             gint64 value);
    gboolean            rygel_media_item_get_place_holder   (RygelMediaItem *self);
    void                rygel_media_item_set_place_holder   (RygelMediaItem *self,
                                                             gboolean value);
    const gchar *       rygel_media_item_get_description    (RygelMediaItem *self);
    void                rygel_media_item_set_description    (RygelMediaItem *self,
                                                             const gchar *value);
    struct              RygelMediaItem;

## Object Hierarchy

      GObject
       +----RygelMediaObject
             +----RygelMediaItem
                   +----RygelAudioItem
                   +----RygelImageItem

## Known Derived Interfaces

RygelMediaItem is required by RygelVisualItem.

## Properties

      "description"              gchar*                : Read / Write
      "ocm-flags"                GUPnPOCMFlags         : Read
      "place-holder"             gboolean              : Read / Write
      "size"                     gint64                : Read / Write

## Description

These objects correspond to items in the UPnP ContentDirectory's DIDL-Lite XML.

## Details

### RYGEL_TYPE_MEDIA_ITEM

    #define RYGEL_TYPE_MEDIA_ITEM (rygel_media_item_get_type ())

The type for RygelMediaItem.

### rygel_media_item_create_stream_source ()

    RygelDataSource *   rygel_media_item_create_stream_source
                                                            (RygelMediaItem *self,
                                                             const gchar *host_ip);

`self` : | the RygelMediaItem instance

### rygel_media_item_is_live_stream ()

    gboolean            rygel_media_item_is_live_stream     (RygelMediaItem *self);

`self` : | the RygelMediaItem instance

### rygel_media_item_streamable ()

    gboolean            rygel_media_item_streamable         (RygelMediaItem *self);

`self` : | the RygelMediaItem instance

### rygel_media_item_add_uri ()

    void                rygel_media_item_add_uri            (RygelMediaItem *self,
                                                             const gchar *uri);

`self` : | the RygelMediaItem instance

### rygel_media_item_get_protocol_info ()

    GUPnPProtocolInfo * rygel_media_item_get_protocol_info  (RygelMediaItem *self,
                                                             const gchar *uri,
                                                             const gchar *protocol);

`self` : | the RygelMediaItem instance

### rygel_media_item_add_resources ()

    void                rygel_media_item_add_resources      (RygelMediaItem *self,
                                                             GUPnPDIDLLiteItem *didl_item,
                                                             gboolean allow_internal,
                                                             GError **error);

`self` : | the RygelMediaItem instance
`error` : | location to store the error occuring, or `NULL` to ignore

### rygel_media_item_get_size ()

    gint64              rygel_media_item_get_size           (RygelMediaItem *self);

`self` : | the RygelMediaItem instance to query
Returns : | the value of the "size" property

### rygel_media_item_set_size ()

    void                rygel_media_item_set_size           (RygelMediaItem *self,
                                                             gint64 value);

`self` : | the RygelMediaItem instance to modify
`value` : | the new value of the "size" property

### rygel_media_item_get_place_holder ()

    gboolean            rygel_media_item_get_place_holder   (RygelMediaItem *self);

`self` : | the RygelMediaItem instance to query
Returns : | the value of the "place-holder" property

### rygel_media_item_set_place_holder ()

    void                rygel_media_item_set_place_holder   (RygelMediaItem *self,
                                                             gboolean value);

`self` : | the RygelMediaItem instance to modify
`value` : | the new value of the "place-holder" property

### rygel_media_item_get_description ()

    const gchar *       rygel_media_item_get_description    (RygelMediaItem *self);

`self` : | the RygelMediaItem instance to query
Returns : | the value of the "description" property

### rygel_media_item_set_description ()

    void                rygel_media_item_set_description    (RygelMediaItem *self,
                                                             const gchar *value);

`self` : | the RygelMediaItem instance to modify
`value` : | the new value of the "description" property

### struct RygelMediaItem

    struct RygelMediaItem;

Represents a media item (Music, Video or Image).

These objects correspond to items in the UPnP ContentDirectory's DIDL-Lite XML.

## Property Details

### The `"description"` property

      "description"              gchar*                : Read / Write

description.

Default value: NULL

### The `"ocm-flags"` property

      "ocm-flags"                GUPnPOCMFlags         : Read

ocm-flags.

### The `"place-holder"` property

      "place-holder"             gboolean              : Read / Write

place-holder.

Default value: FALSE

### The `"size"` property

      "size"                     gint64                : Read / Write

size.

Default value: 0