GDataMediaThumbnail

GDataMediaThumbnail — Media RSS thumbnail element

Stability Level

Unstable, unless otherwise indicated

Synopsis

#include <gdata/media/gdata-media-thumbnail.h>

                    GDataMediaThumbnail;
                    GDataMediaThumbnailClass;
const gchar *       gdata_media_thumbnail_get_uri       (GDataMediaThumbnail *self);
guint               gdata_media_thumbnail_get_height    (GDataMediaThumbnail *self);
guint               gdata_media_thumbnail_get_width     (GDataMediaThumbnail *self);
gint64              gdata_media_thumbnail_get_time      (GDataMediaThumbnail *self);
GFile *             gdata_media_thumbnail_download      (GDataMediaThumbnail *self,
                                                         GDataService *service,
                                                         const gchar *default_filename,
                                                         GFile *target_dest_file,
                                                         gboolean replace_file_if_exists,
                                                         GCancellable *cancellable,
                                                         GError **error);

Object Hierarchy

  GObject
   +----GDataParsable
         +----GDataMediaThumbnail

Properties

  "height"                   guint                 : Read
  "time"                     gint64                : Read
  "uri"                      gchar*                : Read
  "width"                    guint                 : Read

Description

GDataMediaThumbnail represents a "thumbnail" element from the Media RSS specification.

The class only implements parsing, not XML output, at the moment.

Details

GDataMediaThumbnail

typedef struct _GDataMediaThumbnail GDataMediaThumbnail;

All the fields in the GDataMediaThumbnail structure are private and should never be accessed directly.


GDataMediaThumbnailClass

typedef struct {
} GDataMediaThumbnailClass;

All the fields in the GDataMediaThumbnailClass structure are private and should never be accessed directly.

Since 0.4.0


gdata_media_thumbnail_get_uri ()

const gchar *       gdata_media_thumbnail_get_uri       (GDataMediaThumbnail *self);

Gets the "uri" property.

self :

a GDataMediaThumbnail

Returns :

the thumbnail's URI

Since 0.4.0


gdata_media_thumbnail_get_height ()

guint               gdata_media_thumbnail_get_height    (GDataMediaThumbnail *self);

Gets the "height" property.

self :

a GDataMediaThumbnail

Returns :

the thumbnail's height in pixels, or 0

Since 0.4.0


gdata_media_thumbnail_get_width ()

guint               gdata_media_thumbnail_get_width     (GDataMediaThumbnail *self);

Gets the "width" property.

self :

a GDataMediaThumbnail

Returns :

the thumbnail's width in pixels, or 0

Since 0.4.0


gdata_media_thumbnail_get_time ()

gint64              gdata_media_thumbnail_get_time      (GDataMediaThumbnail *self);

Gets the "time" property.

self :

a GDataMediaThumbnail

Returns :

the thumbnail's time offset in the media, or -1

Since 0.4.0


gdata_media_thumbnail_download ()

GFile *             gdata_media_thumbnail_download      (GDataMediaThumbnail *self,
                                                         GDataService *service,
                                                         const gchar *default_filename,
                                                         GFile *target_dest_file,
                                                         gboolean replace_file_if_exists,
                                                         GCancellable *cancellable,
                                                         GError **error);

Downloads and returns the thumbnail represented by self.

If target_dest_file is a directory, then the file will be downloaded into this directory with the default filename specified in default_filename.

self :

a GDataMediaThumbnail

service :

the GDataService

default_filename :

an optional default filename used if the user selects a directory as the destination

target_dest_file :

the destination file or directory to download to

replace_file_if_exists :

whether to replace already existing files at the download location

cancellable :

optional GCancellable object, or NULL

error :

a GError, or NULL

Returns :

the thumbnail's data, or NULL; unref with g_object_unref()

Since 0.6.0

Property Details

The "height" property

  "height"                   guint                 : Read

The height of the thumbnail, in pixels.

For more information, see the Media RSS specification.

Default value: 0

Since 0.4.0


The "time" property

  "time"                     gint64                : Read

The time offset of the thumbnail in relation to the media object, in milliseconds.

For more information, see the Media RSS specification.

Allowed values: >= -1

Default value: -1

Since 0.4.0


The "uri" property

  "uri"                      gchar*                : Read

The URI of the thumbnail.

For more information, see the Media RSS specification.

Default value: NULL

Since 0.4.0


The "width" property

  "width"                    guint                 : Read

The width of the thumbnail, in pixels.

For more information, see the Media RSS specification.

Default value: 0

Since 0.4.0