![]() |
![]() |
![]() |
GData Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#include <gdata/services/picasaweb/gdata-picasaweb-file.h> GDataPicasaWebFile; GDataPicasaWebFileClass; GDataPicasaWebFile * gdata_picasaweb_file_new (const gchar *id
); const gchar * gdata_picasaweb_file_get_id (GDataPicasaWebFile *self
); void gdata_picasaweb_file_get_edited (GDataPicasaWebFile *self
,GTimeVal *edited
); const gchar * gdata_picasaweb_file_get_version (GDataPicasaWebFile *self
); gdouble gdata_picasaweb_file_get_position (GDataPicasaWebFile *self
); void gdata_picasaweb_file_set_position (GDataPicasaWebFile *self
,gdouble position
); const gchar * gdata_picasaweb_file_get_album_id (GDataPicasaWebFile *self
); void gdata_picasaweb_file_set_album_id (GDataPicasaWebFile *self
,const gchar *album_id
); guint gdata_picasaweb_file_get_width (GDataPicasaWebFile *self
); guint gdata_picasaweb_file_get_height (GDataPicasaWebFile *self
); gsize gdata_picasaweb_file_get_size (GDataPicasaWebFile *self
); const gchar * gdata_picasaweb_file_get_client (GDataPicasaWebFile *self
); void gdata_picasaweb_file_set_client (GDataPicasaWebFile *self
,const gchar *client
); const gchar * gdata_picasaweb_file_get_checksum (GDataPicasaWebFile *self
); void gdata_picasaweb_file_set_checksum (GDataPicasaWebFile *self
,const gchar *checksum
); void gdata_picasaweb_file_get_timestamp (GDataPicasaWebFile *self
,GTimeVal *timestamp
); void gdata_picasaweb_file_set_timestamp (GDataPicasaWebFile *self
,GTimeVal *timestamp
); gboolean gdata_picasaweb_file_is_commenting_enabled (GDataPicasaWebFile *self
); void gdata_picasaweb_file_set_is_commenting_enabled (GDataPicasaWebFile *self
,gboolean is_commenting_enabled
); guint gdata_picasaweb_file_get_comment_count (GDataPicasaWebFile *self
); guint gdata_picasaweb_file_get_rotation (GDataPicasaWebFile *self
); void gdata_picasaweb_file_set_rotation (GDataPicasaWebFile *self
,guint rotation
); const gchar * gdata_picasaweb_file_get_video_status (GDataPicasaWebFile *self
); const gchar * gdata_picasaweb_file_get_tags (GDataPicasaWebFile *self
); void gdata_picasaweb_file_set_tags (GDataPicasaWebFile *self
,const gchar *tags
); const gchar * gdata_picasaweb_file_get_credit (GDataPicasaWebFile *self
); const gchar * gdata_picasaweb_file_get_caption (GDataPicasaWebFile *self
); void gdata_picasaweb_file_set_caption (GDataPicasaWebFile *self
,const gchar *caption
); GList * gdata_picasaweb_file_get_contents (GDataPicasaWebFile *self
); GList * gdata_picasaweb_file_get_thumbnails (GDataPicasaWebFile *self
); gdouble gdata_picasaweb_file_get_distance (GDataPicasaWebFile *self
); gdouble gdata_picasaweb_file_get_exposure (GDataPicasaWebFile *self
); gboolean gdata_picasaweb_file_get_flash (GDataPicasaWebFile *self
); gdouble gdata_picasaweb_file_get_focal_length (GDataPicasaWebFile *self
); gdouble gdata_picasaweb_file_get_fstop (GDataPicasaWebFile *self
); const gchar * gdata_picasaweb_file_get_image_unique_id (GDataPicasaWebFile *self
); gint gdata_picasaweb_file_get_iso (GDataPicasaWebFile *self
); const gchar * gdata_picasaweb_file_get_make (GDataPicasaWebFile *self
); const gchar * gdata_picasaweb_file_get_model (GDataPicasaWebFile *self
); void gdata_picasaweb_file_get_coordinates (GDataPicasaWebFile *self
,gdouble *latitude
,gdouble *longitude
); void gdata_picasaweb_file_set_coordinates (GDataPicasaWebFile *self
,gdouble latitude
,gdouble longitude
);
"album-id" gchar* : Read / Write "caption" gchar* : Read / Write "checksum" gchar* : Read / Write "client" gchar* : Read / Write "comment-count" guint : Read "credit" gchar* : Read "distance" gdouble : Read "edited" GDataTimeVal* : Read "exposure" gdouble : Read "file-id" gchar* : Read / Write / Construct Only "flash" gboolean : Read "focal-length" gdouble : Read "fstop" gdouble : Read "height" guint : Read "image-unique-id" gchar* : Read "is-commenting-enabled" gboolean : Read / Write "iso" glong : Read "latitude" gdouble : Read / Write "longitude" gdouble : Read / Write "make" gchar* : Read "model" gchar* : Read "position" gdouble : Read / Write "rotation" guint : Read / Write "size" gulong : Read "tags" gchar* : Read / Write "timestamp" GDataTimeVal* : Read / Write "version" gchar* : Read / Write / Construct Only "video-status" gchar* : Read "width" guint : Read
GDataPicasaWebFile is a subclass of GDataEntry to represent a file in an album on Google PicasaWeb.
For more details of Google PicasaWeb's GData API, see the online documentation.
typedef struct _GDataPicasaWebFile GDataPicasaWebFile;
All the fields in the GDataPicasaWebFile structure are private and should never be accessed directly.
Since 0.4.0
typedef struct { } GDataPicasaWebFileClass;
All the fields in the GDataPicasaWebFileClass structure are private and should never be accessed directly.
Since 0.4.0
GDataPicasaWebFile * gdata_picasaweb_file_new (const gchar *id
);
Creates a new GDataPicasaWebFile with the given ID and default properties.
|
the file's ID, or NULL . [allow-none]
|
Returns : |
a new GDataPicasaWebFile; unref with g_object_unref()
|
Since 0.4.0
const gchar * gdata_picasaweb_file_get_id (GDataPicasaWebFile *self
);
Gets the "file-id" property.
|
a GDataPicasaWebFile |
Returns : |
the file's ID |
Since 0.6.4
void gdata_picasaweb_file_get_edited (GDataPicasaWebFile *self
,GTimeVal *edited
);
Gets the "edited" property and puts it in edited
. If the property is unset,
both fields in the GTimeVal will be set to 0
.
|
a GDataPicasaWebFile |
|
a GTimeVal. [out caller-allocates] |
Since 0.4.0
const gchar * gdata_picasaweb_file_get_version (GDataPicasaWebFile *self
);
Gets the "version" property.
|
a GDataPicasaWebFile |
Returns : |
the file's version number, or NULL
|
Since 0.4.0
gdouble gdata_picasaweb_file_get_position (GDataPicasaWebFile *self
);
Gets the "position" property.
|
a GDataPicasaWebFile |
Returns : |
the file's ordinal position in the album |
Since 0.4.0
void gdata_picasaweb_file_set_position (GDataPicasaWebFile *self
,gdouble position
);
Sets the "position" property.
|
a GDataPicasaWebFile |
|
the file's new position in the album |
Since 0.4.0
const gchar * gdata_picasaweb_file_get_album_id (GDataPicasaWebFile *self
);
Gets the "album-id" property. This is in the same form as returned by gdata_picasaweb_album_get_id()
.
|
a GDataPicasaWebFile |
Returns : |
the ID of the album containing the GDataPicasaWebFile |
Since 0.4.0
void gdata_picasaweb_file_set_album_id (GDataPicasaWebFile *self
,const gchar *album_id
);
Sets the "album-id" property, effectively moving the file to the album.
|
a GDataPicasaWebFile |
|
the ID of the new album for this file |
Since 0.4.0
guint gdata_picasaweb_file_get_width (GDataPicasaWebFile *self
);
Gets the "width" property.
|
a GDataPicasaWebFile |
Returns : |
the width of the image or video, in pixels |
Since 0.4.0
guint gdata_picasaweb_file_get_height (GDataPicasaWebFile *self
);
Gets the "height" property.
|
a GDataPicasaWebFile |
Returns : |
the height of the image or video, in pixels |
Since 0.4.0
gsize gdata_picasaweb_file_get_size (GDataPicasaWebFile *self
);
Gets the "size" property.
|
a GDataPicasaWebFile |
Returns : |
the size of the file, in bytes |
Since 0.4.0
const gchar * gdata_picasaweb_file_get_client (GDataPicasaWebFile *self
);
Gets the "client" property.
|
a GDataPicasaWebFile |
Returns : |
the name of the software which created the photo, or NULL
|
Since 0.4.0
void gdata_picasaweb_file_set_client (GDataPicasaWebFile *self
,const gchar *client
);
Sets the "client" property to client
.
Set client
to NULL
to unset the property.
|
a GDataPicasaWebFile |
|
the name of the software which created or modified the photo, or NULL . [allow-none]
|
Since 0.4.0
const gchar * gdata_picasaweb_file_get_checksum (GDataPicasaWebFile *self
);
Gets the "checksum" property.
|
a GDataPicasaWebFile |
Returns : |
the checksum assigned to this file, or NULL
|
Since 0.4.0
void gdata_picasaweb_file_set_checksum (GDataPicasaWebFile *self
,const gchar *checksum
);
Sets the "checksum" property to checksum
.
Set checksum
to NULL
to unset the property.
|
a GDataPicasaWebFile |
|
the new checksum for this file, or NULL . [allow-none]
|
Since 0.4.0
void gdata_picasaweb_file_get_timestamp (GDataPicasaWebFile *self
,GTimeVal *timestamp
);
Gets the "timestamp" property and puts it in timestamp
. If the property is unset,
both fields in the GTimeVal will be set to 0
.
|
a GDataPicasaWebFile |
|
a GTimeVal. [out caller-allocates] |
Since 0.4.0
void gdata_picasaweb_file_set_timestamp (GDataPicasaWebFile *self
,GTimeVal *timestamp
);
Sets the "timestamp" property from values supplied by timestamp
. If timestamp
is NULL
,
the property will be unset.
|
a GDataPicasaWebFile |
|
a GTimeVal, or NULL . [allow-none]
|
Since 0.4.0
gboolean gdata_picasaweb_file_is_commenting_enabled
(GDataPicasaWebFile *self
);
Gets the "is-commenting-enabled" property.
|
a GDataPicasaWebFile |
Returns : |
TRUE if commenting is enabled, FALSE otherwise
|
Since 0.4.0
void gdata_picasaweb_file_set_is_commenting_enabled (GDataPicasaWebFile *self
,gboolean is_commenting_enabled
);
Sets the "is-commenting-enabled" property to is_commenting_enabled
.
|
a GDataPicasaWebFile |
|
TRUE if commenting should be enabled for the file, FALSE otherwise
|
Since 0.4.0
guint gdata_picasaweb_file_get_comment_count
(GDataPicasaWebFile *self
);
Gets the "comment-count" property.
|
a GDataPicasaWebFile |
Returns : |
the number of comments on the file |
Since 0.4.0
guint gdata_picasaweb_file_get_rotation (GDataPicasaWebFile *self
);
Gets the "rotation" property.
|
a GDataPicasaWebFile |
Returns : |
the image's rotation, in degrees |
Since 0.4.0
void gdata_picasaweb_file_set_rotation (GDataPicasaWebFile *self
,guint rotation
);
Sets the "rotation" property to rotation
.
The rotation is absolute, rather than cumulative, through successive calls to gdata_picasaweb_file_set_rotation()
,
so calling it with 90° then 20° will result in a final rotation of 20°.
|
a GDataPicasaWebFile |
|
the new rotation for the image, in degrees |
Since 0.4.0
const gchar * gdata_picasaweb_file_get_video_status
(GDataPicasaWebFile *self
);
Gets the "video-status" property.
|
a GDataPicasaWebFile |
Returns : |
the status of this video ("pending", "ready", "final" or "failed"), or NULL
|
Since 0.4.0
const gchar * gdata_picasaweb_file_get_tags (GDataPicasaWebFile *self
);
Gets the "tags" property.
|
a GDataPicasaWebFile |
Returns : |
a comma-separated list of tags associated with the file, or NULL
|
Since 0.4.0
void gdata_picasaweb_file_set_tags (GDataPicasaWebFile *self
,const gchar *tags
);
Sets the "tags" property to tags
.
Set tags
to NULL
to unset the property.
|
a GDataPicasaWebFile |
|
a new comma-separated list of tags, or NULL . [allow-none]
|
Since 0.4.0
const gchar * gdata_picasaweb_file_get_credit (GDataPicasaWebFile *self
);
Gets the "credit" property.
|
a GDataPicasaWebFile |
Returns : |
the nickname of the user credited with this file |
Since 0.4.0
const gchar * gdata_picasaweb_file_get_caption (GDataPicasaWebFile *self
);
Gets the "caption" property.
|
a GDataPicasaWebFile |
Returns : |
the file's descriptive caption, or NULL
|
Since 0.4.0
void gdata_picasaweb_file_set_caption (GDataPicasaWebFile *self
,const gchar *caption
);
Sets the "caption" property to caption
.
Set caption
to NULL
to unset the file's caption.
|
a GDataPicasaWebFile |
|
the file's new caption, or NULL . [allow-none]
|
Since 0.4.0
GList * gdata_picasaweb_file_get_contents (GDataPicasaWebFile *self
);
Returns a list of media content, e.g. the actual photo or video.
|
a GDataPicasaWebFile |
Returns : |
a GList of GDataMediaContent items. [element-type GData.MediaContent][transfer none GData.MediaContent] |
Since 0.4.0
GList * gdata_picasaweb_file_get_thumbnails (GDataPicasaWebFile *self
);
Returns a list of thumbnails, often at different sizes, for this file. Currently, PicasaWeb usually returns three thumbnails, with widths in pixels of 72, 144, and 288. However, the thumbnail will not be larger than the actual image, so thumbnails may be smaller than the widths listed above.
|
a GDataPicasaWebFile |
Returns : |
a GList of GDataMediaThumbnails, or NULL . [element-type GData.MediaThumbnail][transfer none GData.MediaThumbnail]
|
Since 0.4.0
gdouble gdata_picasaweb_file_get_distance (GDataPicasaWebFile *self
);
Gets the "distance" property.
|
a GDataPicasaWebFile |
Returns : |
the distance recorded in the photo's EXIF, or -1 if unknown
|
Since 0.5.0
gdouble gdata_picasaweb_file_get_exposure (GDataPicasaWebFile *self
);
Gets the "exposure" property.
|
a GDataPicasaWebFile |
Returns : |
the exposure value, or 0 if unknown
|
Since 0.5.0
gboolean gdata_picasaweb_file_get_flash (GDataPicasaWebFile *self
);
Gets the "flash" property.
|
a GDataPicasaWebFile |
Returns : |
TRUE if flash was used, FALSE otherwise
|
Since 0.5.0
gdouble gdata_picasaweb_file_get_focal_length
(GDataPicasaWebFile *self
);
Gets the "focal-length" property.
|
a GDataPicasaWebFile |
Returns : |
the focal-length value, or -1 if unknown
|
Since 0.5.0
gdouble gdata_picasaweb_file_get_fstop (GDataPicasaWebFile *self
);
Gets the "fstop" property.
|
a GDataPicasaWebFile |
Returns : |
the F-stop value, or 0 if unknown
|
Since 0.5.0
const gchar * gdata_picasaweb_file_get_image_unique_id
(GDataPicasaWebFile *self
);
Gets the "image-unique-id" property.
|
a GDataPicasaWebFile |
Returns : |
the photo's unique EXIF identifier, or NULL
|
Since 0.5.0
gint gdata_picasaweb_file_get_iso (GDataPicasaWebFile *self
);
Gets the "iso" property.
|
a GDataPicasaWebFile |
Returns : |
the ISO speed, or -1 if unknown
|
Since 0.5.0
const gchar * gdata_picasaweb_file_get_make (GDataPicasaWebFile *self
);
Gets the "make" property.
|
a GDataPicasaWebFile |
Returns : |
the name of the manufacturer of the camera, or NULL if unknown
|
Since 0.5.0
const gchar * gdata_picasaweb_file_get_model (GDataPicasaWebFile *self
);
Gets the "model" property.
|
a GDataPicasaWebFile |
Returns : |
the model name of the camera, or NULL if unknown
|
Since 0.5.0
void gdata_picasaweb_file_get_coordinates (GDataPicasaWebFile *self
,gdouble *latitude
,gdouble *longitude
);
Gets the "latitude" and "longitude" properties, setting the out parameters to them.
If either latitude or longitude is NULL
, that parameter will not be set. If the coordinates are unset,
latitude
and longitude
will be set to G_MAXDOUBLE
.
|
a GDataPicasaWebFile |
|
return location for the latitude, or NULL . [out caller-allocates][allow-none caller-allocates]
|
|
return location for the longitude, or NULL . [out caller-allocates][allow-none caller-allocates]
|
Since 0.5.0
void gdata_picasaweb_file_set_coordinates (GDataPicasaWebFile *self
,gdouble latitude
,gdouble longitude
);
Sets the "latitude" and "longitude" properties to
latitude
and longitude
respectively.
|
a GDataPicasaWebFile |
|
the file's new latitude coordinate, or G_MAXDOUBLE
|
|
the file's new longitude coordinate, or G_MAXDOUBLE
|
Since 0.5.0
"album-id"
property "album-id" gchar* : Read / Write
The ID for the file's album. This is in the same form as returned by gdata_picasaweb_album_get_id()
.
For more information, see the gphoto specification.
Default value: NULL
Since 0.4.0
"caption"
property "caption" gchar* : Read / Write
The file's descriptive caption.
Default value: NULL
Since 0.4.0
"checksum"
property "checksum" gchar* : Read / Write
A checksum of the file, useful for duplicate detection.
For more information, see the gphoto specification.
Default value: NULL
Since 0.4.0
"client"
property "client" gchar* : Read / Write
The name of the software which created or last modified the file.
For more information, see the gphoto specification.
Default value: NULL
Since 0.4.0
"comment-count"
property "comment-count" guint : Read
The number of comments on the file.
For more information, see the gphoto specification.
Default value: 0
Since 0.4.0
"credit"
property "credit" gchar* : Read
The nickname of the user credited with this file.
For more information, see the Media RSS specification.
Default value: NULL
Since 0.4.0
"distance"
property "distance" gdouble : Read
The distance to the subject reported in the image's EXIF.
For more information, see the EXIF element reference.
Allowed values: >= -1
Default value: -1
Since 0.5.0
"edited"
property "edited" GDataTimeVal* : Read
The time this file was last edited. If the file has not been edited yet, the content indicates the time it was created.
For more information, see the Atom Publishing Protocol specification.
Since 0.4.0
"exposure"
property "exposure" gdouble : Read
The exposure time.
For more information, see the EXIF element reference.
Allowed values: >= 0
Default value: 0
Since 0.5.0
"file-id"
property "file-id" gchar* : Read / Write / Construct Only
The ID of the file. This is a substring of the ID returned by gdata_entry_get_id()
for GDataPicasaWebFiles; for example,
if gdata_entry_get_id()
returned
"http://picasaweb.google.com/data/entry/user/libgdata.picasaweb/albumid/5328889949261497249/photoid/5328890138794566386" for a
particular GDataPicasaWebFile, the "file-id" property would be "5328890138794566386".
For more information, see the gphoto specification.
Default value: NULL
Since 0.6.4
"flash"
property "flash" gboolean : Read
Indicates whether the flash was used.
For more information, see the EXIF element reference.
Default value: FALSE
Since 0.5.0
"focal-length"
property "focal-length" gdouble : Read
The focal length for the shot.
For more information, see the EXIF element reference.
Allowed values: >= -1
Default value: -1
Since 0.5.0
"fstop"
property "fstop" gdouble : Read
The F-stop value.
For more information, see the EXIF element reference.
Allowed values: >= 0
Default value: 0
Since 0.5.0
"height"
property "height" guint : Read
The height of the photo or video, in pixels.
For more information, see the gphoto specification.
Default value: 0
Since 0.4.0
"image-unique-id"
property "image-unique-id" gchar* : Read
An unique ID for the image found in the EXIF.
For more information, see the EXIF element reference.
Default value: NULL
Since 0.5.0
"is-commenting-enabled"
property "is-commenting-enabled" gboolean : Read / Write
Whether commenting is enabled for this file.
Default value: TRUE
Since 0.4.0
"iso"
property "iso" glong : Read
The ISO speed.
For more information, see the EXIF element reference and ISO 5800:1987.
Allowed values: >= -1
Default value: -1
Since 0.5.0
"latitude"
property "latitude" gdouble : Read / Write
The location as a latitude coordinate associated with this file. Valid latitudes range from -90.0
to 90.0
inclusive.
For more information, see the GeoRSS specification.
Allowed values: [-90,90]
Default value: 0
Since 0.5.0
"longitude"
property "longitude" gdouble : Read / Write
The location as a longitude coordinate associated with this file. Valid longitudes range from -180.0
to 180.0
inclusive.
For more information, see the GeoRSS specification.
Allowed values: [-180,180]
Default value: 0
Since 0.5.0
"make"
property "make" gchar* : Read
The name of the manufacturer of the camera.
For more information, see the EXIF element reference.
Default value: NULL
Since 0.5.0
"model"
property "model" gchar* : Read
The model of the camera.
For more information, see the EXIF element reference.
Default value: NULL
Since 0.5.0
"position"
property "position" gdouble : Read / Write
The ordinal position of the file within the album. Lower values mean the file will be closer to the start of the album.
For more information, see the gphoto specification.
Allowed values: [0,G_MAXFLOAT]
Default value: 0
Since 0.4.0
"rotation"
property "rotation" guint : Read / Write
The rotation of the photo, in degrees. This will only be non-zero for files which are pending rotation, and haven't yet been
permanently modified. For files which have already been rotated, this will be 0
.
For more information, see the gphoto specification.
Allowed values: <= 359
Default value: 0
Since 0.4.0
"size"
property "size" gulong : Read
The size of the file, in bytes.
For more information, see the gphoto specification.
Since 0.4.0
"tags"
property "tags" gchar* : Read / Write
A comma-separated list of tags associated with the file.
For more information, see the Media RSS specification.
Default value: NULL
Since 0.4.0
"timestamp"
property "timestamp" GDataTimeVal* : Read / Write
The time the file was purportedly taken.
For more information, see the gphoto specification.
Since 0.4.0
"version"
property "version" gchar* : Read / Write / Construct Only
The version number of the file. Version numbers are based on modification time, so they don't increment linearly.
For more information, see the gphoto specification.
Default value: NULL
Since 0.4.0
"video-status"
property "video-status" gchar* : Read
The status of the file, if it is a video.
Possible values include "pending", "ready", "final", and "failed".
For more information, see the gphoto specification.
Default value: NULL
Since 0.4.0
"width"
property "width" guint : Read
The width of the photo or video, in pixels.
For more information, see the gphoto specification.
Default value: 0
Since 0.4.0