GUPnPDIDLLiteResource

GUPnPDIDLLiteResource — DIDL-Lite Resource

Synopsis

                    GUPnPDIDLLiteResource;
void                gupnp_didl_lite_resource_set_uri    (GUPnPDIDLLiteResource *resource,
                                                         const char *uri);
void                gupnp_didl_lite_resource_set_import_uri
                                                        (GUPnPDIDLLiteResource *resource,
                                                         const char *import_uri);
void                gupnp_didl_lite_resource_set_protocol_info
                                                        (GUPnPDIDLLiteResource *resource,
                                                         GUPnPProtocolInfo *info);
void                gupnp_didl_lite_resource_set_size   (GUPnPDIDLLiteResource *resource,
                                                         glong size);
void                gupnp_didl_lite_resource_set_size64 (GUPnPDIDLLiteResource *resource,
                                                         gint64 size);
void                gupnp_didl_lite_resource_set_duration
                                                        (GUPnPDIDLLiteResource *resource,
                                                         glong duration);
void                gupnp_didl_lite_resource_set_bitrate
                                                        (GUPnPDIDLLiteResource *resource,
                                                         int bitrate);
void                gupnp_didl_lite_resource_set_sample_freq
                                                        (GUPnPDIDLLiteResource *resource,
                                                         int sample_freq);
void                gupnp_didl_lite_resource_set_bits_per_sample
                                                        (GUPnPDIDLLiteResource *resource,
                                                         int sample_size);
void                gupnp_didl_lite_resource_set_protection
                                                        (GUPnPDIDLLiteResource *resource,
                                                         const char *protection);
void                gupnp_didl_lite_resource_set_audio_channels
                                                        (GUPnPDIDLLiteResource *resource,
                                                         int n_channels);
void                gupnp_didl_lite_resource_set_width  (GUPnPDIDLLiteResource *resource,
                                                         int width);
void                gupnp_didl_lite_resource_set_height (GUPnPDIDLLiteResource *resource,
                                                         int height);
void                gupnp_didl_lite_resource_set_color_depth
                                                        (GUPnPDIDLLiteResource *resource,
                                                         int color_depth);
const char *        gupnp_didl_lite_resource_get_uri    (GUPnPDIDLLiteResource *resource);
const char *        gupnp_didl_lite_resource_get_import_uri
                                                        (GUPnPDIDLLiteResource *resource);
GUPnPProtocolInfo * gupnp_didl_lite_resource_get_protocol_info
                                                        (GUPnPDIDLLiteResource *resource);
long                gupnp_didl_lite_resource_get_size   (GUPnPDIDLLiteResource *resource);
gint64              gupnp_didl_lite_resource_get_size64 (GUPnPDIDLLiteResource *resource);
long                gupnp_didl_lite_resource_get_duration
                                                        (GUPnPDIDLLiteResource *resource);
int                 gupnp_didl_lite_resource_get_bitrate
                                                        (GUPnPDIDLLiteResource *resource);
int                 gupnp_didl_lite_resource_get_sample_freq
                                                        (GUPnPDIDLLiteResource *resource);
int                 gupnp_didl_lite_resource_get_bits_per_sample
                                                        (GUPnPDIDLLiteResource *resource);
const char *        gupnp_didl_lite_resource_get_protection
                                                        (GUPnPDIDLLiteResource *resource);
int                 gupnp_didl_lite_resource_get_audio_channels
                                                        (GUPnPDIDLLiteResource *resource);
int                 gupnp_didl_lite_resource_get_width  (GUPnPDIDLLiteResource *resource);
int                 gupnp_didl_lite_resource_get_height (GUPnPDIDLLiteResource *resource);
int                 gupnp_didl_lite_resource_get_color_depth
                                                        (GUPnPDIDLLiteResource *resource);
xmlNode *           gupnp_didl_lite_resource_get_xml_node
                                                        (GUPnPDIDLLiteResource *resource);
guint               gupnp_didl_lite_resource_get_update_count
                                                        (GUPnPDIDLLiteResource *resource);
void                gupnp_didl_lite_resource_set_update_count
                                                        (GUPnPDIDLLiteResource *resource,
                                                         guint update_count);
void                gupnp_didl_lite_resource_unset_update_count
                                                        (GUPnPDIDLLiteResource *resource);
gboolean            gupnp_didl_lite_resource_update_count_is_set
                                                        (GUPnPDIDLLiteResource *resource);

Object Hierarchy

  GObject
   +----GUPnPDIDLLiteResource

Properties

  "audio-channels"           gint                  : Read / Write
  "bitrate"                  gint                  : Read / Write
  "bits-per-sample"          gint                  : Read / Write
  "color-depth"              gint                  : Read / Write
  "duration"                 glong                 : Read / Write
  "height"                   gint                  : Read / Write
  "import-uri"               gchar*                : Read / Write
  "protection"               gchar*                : Read / Write
  "protocol-info"            GUPnPProtocolInfo*    : Read / Write
  "sample-freq"              gint                  : Read / Write
  "size"                     glong                 : Read / Write
  "size64"                   gint64                : Read / Write
  "update-count"             guint                 : Read / Write
  "uri"                      gchar*                : Read / Write
  "width"                    gint                  : Read / Write
  "xml-doc"                  GUPnPXMLDoc*          : Write / Construct Only
  "xml-node"                 gpointer              : Read / Write / Construct Only

Description

GUPnPDIDLLiteResource respresent a DIDL-Lite resource (res) element.

Details

GUPnPDIDLLiteResource

typedef struct _GUPnPDIDLLiteResource GUPnPDIDLLiteResource;

gupnp_didl_lite_resource_set_uri ()

void                gupnp_didl_lite_resource_set_uri    (GUPnPDIDLLiteResource *resource,
                                                         const char *uri);

Set the URI associated with the resource.

resource :

A GUPnPDIDLLiteResource

uri :

The URI as string

Returns :

None.

gupnp_didl_lite_resource_set_import_uri ()

void                gupnp_didl_lite_resource_set_import_uri
                                                        (GUPnPDIDLLiteResource *resource,
                                                         const char *import_uri);

Set the import URI associated with the resource.

resource :

A GUPnPDIDLLiteResource

import_uri :

The URI as string

Returns :

None.

gupnp_didl_lite_resource_set_protocol_info ()

void                gupnp_didl_lite_resource_set_protocol_info
                                                        (GUPnPDIDLLiteResource *resource,
                                                         GUPnPProtocolInfo *info);

Set the protocol info associated with the resource.

resource :

A GUPnPDIDLLiteResource

info :

The protocol string

Returns :

None.

gupnp_didl_lite_resource_set_size ()

void                gupnp_didl_lite_resource_set_size   (GUPnPDIDLLiteResource *resource,
                                                         glong size);

Set the size (in bytes) of the resource. Passing a negative number will unset this property.

resource :

A GUPnPDIDLLiteResource

size :

The size (in bytes)

Returns :

None.

gupnp_didl_lite_resource_set_size64 ()

void                gupnp_didl_lite_resource_set_size64 (GUPnPDIDLLiteResource *resource,
                                                         gint64 size);

Set the size (in bytes) of the resource. Passing a negative number will unset this property.

resource :

A GUPnPDIDLLiteResource

size :

The size (in bytes)

Returns :

None.

gupnp_didl_lite_resource_set_duration ()

void                gupnp_didl_lite_resource_set_duration
                                                        (GUPnPDIDLLiteResource *resource,
                                                         glong duration);

Set the duration (in seconds) of the resource. Passing a negative number will unset this property.

resource :

A GUPnPDIDLLiteResource

duration :

The duration (in seconds)

Returns :

None.

gupnp_didl_lite_resource_set_bitrate ()

void                gupnp_didl_lite_resource_set_bitrate
                                                        (GUPnPDIDLLiteResource *resource,
                                                         int bitrate);

Set the bitrate (in bytes per second) of the resource. Passing a negative number will unset this property.

resource :

A GUPnPDIDLLiteResource

bitrate :

The bitrate

Returns :

None.

gupnp_didl_lite_resource_set_sample_freq ()

void                gupnp_didl_lite_resource_set_sample_freq
                                                        (GUPnPDIDLLiteResource *resource,
                                                         int sample_freq);

Set the sample frequency of the resource. Passing a negative number will unset this property.

resource :

A GUPnPDIDLLiteResource

sample_freq :

The sample frequency

Returns :

None.

gupnp_didl_lite_resource_set_bits_per_sample ()

void                gupnp_didl_lite_resource_set_bits_per_sample
                                                        (GUPnPDIDLLiteResource *resource,
                                                         int sample_size);

Set the sample size of the resource. Passing a negative number will unset this property.

resource :

A GUPnPDIDLLiteResource

sample_size :

The number of bits per sample

Returns :

None.

gupnp_didl_lite_resource_set_protection ()

void                gupnp_didl_lite_resource_set_protection
                                                        (GUPnPDIDLLiteResource *resource,
                                                         const char *protection);

Set the protection system used by the resource. Passing a negative number will unset this property.

resource :

A GUPnPDIDLLiteResource

protection :

The protection system identifier as string

Returns :

None.

gupnp_didl_lite_resource_set_audio_channels ()

void                gupnp_didl_lite_resource_set_audio_channels
                                                        (GUPnPDIDLLiteResource *resource,
                                                         int n_channels);

Set the number of audio channels in the resource. Passing a negative number will unset this property.

resource :

A GUPnPDIDLLiteResource

n_channels :

The number of channels

Returns :

The number of audio channels in the resource or -1.

gupnp_didl_lite_resource_set_width ()

void                gupnp_didl_lite_resource_set_width  (GUPnPDIDLLiteResource *resource,
                                                         int width);

Set the width of this image/video resource. Setting both width and height to a negative number will unset the resolution property.

resource :

A GUPnPDIDLLiteResource

width :

The width

Returns :

None.

gupnp_didl_lite_resource_set_height ()

void                gupnp_didl_lite_resource_set_height (GUPnPDIDLLiteResource *resource,
                                                         int height);

Set the height of this image/video resource. Setting both width and height to a negative number will unset the resolution property.

resource :

A GUPnPDIDLLiteResource

height :

The height

Returns :

None.

gupnp_didl_lite_resource_set_color_depth ()

void                gupnp_didl_lite_resource_set_color_depth
                                                        (GUPnPDIDLLiteResource *resource,
                                                         int color_depth);

Set the color-depth of this image/video resource. Passing a negative number will unset this property.

resource :

A GUPnPDIDLLiteResource

color_depth :

The color-depth

Returns :

None.

gupnp_didl_lite_resource_get_uri ()

const char *        gupnp_didl_lite_resource_get_uri    (GUPnPDIDLLiteResource *resource);

Get the URI associated with the resource.

resource :

A GUPnPDIDLLiteResource

Returns :

The of URI the resource or NULL.

gupnp_didl_lite_resource_get_import_uri ()

const char *        gupnp_didl_lite_resource_get_import_uri
                                                        (GUPnPDIDLLiteResource *resource);

Get the import URI associated with the resource.

resource :

A GUPnPDIDLLiteResource

Returns :

The import URI or NULL.

gupnp_didl_lite_resource_get_protocol_info ()

GUPnPProtocolInfo * gupnp_didl_lite_resource_get_protocol_info
                                                        (GUPnPDIDLLiteResource *resource);

Get the protocol info associated with the resource.

resource :

A GUPnPDIDLLiteResource

Returns :

The protocol info associated with the resource or NULL. The returned object must not be unrefed. [transfer none]

gupnp_didl_lite_resource_get_size ()

long                gupnp_didl_lite_resource_get_size   (GUPnPDIDLLiteResource *resource);

Get the size (in bytes) of the resource.

resource :

A GUPnPDIDLLiteResource

Returns :

The size (in bytes) of the resource or -1.

gupnp_didl_lite_resource_get_size64 ()

gint64              gupnp_didl_lite_resource_get_size64 (GUPnPDIDLLiteResource *resource);

Get the size (in bytes) of the resource.

resource :

A GUPnPDIDLLiteResource

Returns :

The size (in bytes) of the resource or -1.

gupnp_didl_lite_resource_get_duration ()

long                gupnp_didl_lite_resource_get_duration
                                                        (GUPnPDIDLLiteResource *resource);

Get the duration (in seconds) of the resource.

resource :

A GUPnPDIDLLiteResource

Returns :

The duration (in seconds) of the resource or -1.

gupnp_didl_lite_resource_get_bitrate ()

int                 gupnp_didl_lite_resource_get_bitrate
                                                        (GUPnPDIDLLiteResource *resource);

Get the bitrate (in bytes per second) of the resource.

resource :

A GUPnPDIDLLiteResource

Returns :

The bitrate (in bytes per second) of the resource or -1.

gupnp_didl_lite_resource_get_sample_freq ()

int                 gupnp_didl_lite_resource_get_sample_freq
                                                        (GUPnPDIDLLiteResource *resource);

Get the sample frequency of the resource.

resource :

A GUPnPDIDLLiteResource

Returns :

The sample frequency of the resource or -1.

gupnp_didl_lite_resource_get_bits_per_sample ()

int                 gupnp_didl_lite_resource_get_bits_per_sample
                                                        (GUPnPDIDLLiteResource *resource);

Get the sample size of the resource.

resource :

A GUPnPDIDLLiteResource

Returns :

The number of bits per sample of the resource or -1.

gupnp_didl_lite_resource_get_protection ()

const char *        gupnp_didl_lite_resource_get_protection
                                                        (GUPnPDIDLLiteResource *resource);

Get the protection system used by the resource.

resource :

A GUPnPDIDLLiteResource

Returns :

The protection system in use by the resource or NULL.

gupnp_didl_lite_resource_get_audio_channels ()

int                 gupnp_didl_lite_resource_get_audio_channels
                                                        (GUPnPDIDLLiteResource *resource);

Get the number of audio channels in the resource.

resource :

A GUPnPDIDLLiteResource

Returns :

The number of audio channels in the resource or -1.

gupnp_didl_lite_resource_get_width ()

int                 gupnp_didl_lite_resource_get_width  (GUPnPDIDLLiteResource *resource);

Get the width of this image/video resource.

resource :

A GUPnPDIDLLiteResource

Returns :

The width of this image/video resource or -1.

gupnp_didl_lite_resource_get_height ()

int                 gupnp_didl_lite_resource_get_height (GUPnPDIDLLiteResource *resource);

Get the height of this image/video resource.

resource :

A GUPnPDIDLLiteResource

Returns :

The height of the resource or -1.

gupnp_didl_lite_resource_get_color_depth ()

int                 gupnp_didl_lite_resource_get_color_depth
                                                        (GUPnPDIDLLiteResource *resource);

Get the color-depth of this image/video resource.

resource :

A GUPnPDIDLLiteResource

Returns :

The color depth of the resource or -1.

gupnp_didl_lite_resource_get_xml_node ()

xmlNode *           gupnp_didl_lite_resource_get_xml_node
                                                        (GUPnPDIDLLiteResource *resource);

Get the pointer to res node in XML document.

resource :

The GUPnPDIDLLiteResource

Returns :

The pointer to res node in XML document. [transfer none]

gupnp_didl_lite_resource_get_update_count ()

guint               gupnp_didl_lite_resource_get_update_count
                                                        (GUPnPDIDLLiteResource *resource);

Get the update count of this resource.

resource :

A GUPnPDIDLLiteResource

Returns :

The update count of the resource.

gupnp_didl_lite_resource_set_update_count ()

void                gupnp_didl_lite_resource_set_update_count
                                                        (GUPnPDIDLLiteResource *resource,
                                                         guint update_count);

Set the update count of this resource.

resource :

A GUPnPDIDLLiteResource

update_count :

The update_count

Returns :

None.

gupnp_didl_lite_resource_unset_update_count ()

void                gupnp_didl_lite_resource_unset_update_count
                                                        (GUPnPDIDLLiteResource *resource);

Unset the update count of this resource.

resource :

A GUPnPDIDLLiteResource

Returns :

None.

gupnp_didl_lite_resource_update_count_is_set ()

gboolean            gupnp_didl_lite_resource_update_count_is_set
                                                        (GUPnPDIDLLiteResource *resource);

Check whether the update count property of this resource is set.

resource :

A GUPnPDIDLLiteResource

Returns :

TRUE if set, otherwise FALSE.

Property Details

The "audio-channels" property

  "audio-channels"           gint                  : Read / Write

The number of audio channels in this resource.

Allowed values: >= G_MAXULONG

Default value: -1


The "bitrate" property

  "bitrate"                  gint                  : Read / Write

The bitrate of this resource.

Allowed values: >= G_MAXULONG

Default value: -1


The "bits-per-sample" property

  "bits-per-sample"          gint                  : Read / Write

The sample size of this resource.

Allowed values: >= G_MAXULONG

Default value: -1


The "color-depth" property

  "color-depth"              gint                  : Read / Write

The color-depth of this image/video resource.

Allowed values: >= G_MAXULONG

Default value: -1


The "duration" property

  "duration"                 glong                 : Read / Write

The duration (in seconds) of this resource.

Allowed values: >= -1

Default value: -1


The "height" property

  "height"                   gint                  : Read / Write

The height of this image/video resource.

Allowed values: >= G_MAXULONG

Default value: -1


The "import-uri" property

  "import-uri"               gchar*                : Read / Write

The Import URI associated with this resource.

Default value: NULL


The "protection" property

  "protection"               gchar*                : Read / Write

The protection system used for this resource.

Default value: NULL


The "protocol-info" property

  "protocol-info"            GUPnPProtocolInfo*    : Read / Write

The protocol info associated with this resource.


The "sample-freq" property

  "sample-freq"              gint                  : Read / Write

The sample frequency of this resource.

Allowed values: >= G_MAXULONG

Default value: -1


The "size" property

  "size"                     glong                 : Read / Write

The size (in bytes) of this resource.

Allowed values: >= -1

Default value: -1


The "size64" property

  "size64"                   gint64                : Read / Write

The size (in bytes) of this resource.

Allowed values: >= -1

Default value: -1


The "update-count" property

  "update-count"             guint                 : Read / Write

The update count of this resource.

Default value: 0


The "uri" property

  "uri"                      gchar*                : Read / Write

The URI associated with this resource.

Default value: NULL


The "width" property

  "width"                    gint                  : Read / Write

The width of this image/video resource.

Allowed values: >= G_MAXULONG

Default value: -1


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 res node in XML document.