![]() |
![]() |
![]() |
Grilo Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#include <grilo.h> struct GrlMedia; struct GrlMediaClass; enum GrlMediaSerializeType; enum GrlMediaType; GrlMedia * grl_media_new (void
); GrlMedia * grl_media_audio_new (void
); GrlMedia * grl_media_image_new (void
); GrlMedia * grl_media_video_new (void
); GrlMedia * grl_media_container_new (void
); gboolean grl_media_is_audio (GrlMedia *media
); gboolean grl_media_is_image (GrlMedia *media
); gboolean grl_media_is_video (GrlMedia *media
); gboolean grl_media_is_container (GrlMedia *media
); void grl_media_add_artist (GrlMedia *media
,const gchar *artist
); void grl_media_add_author (GrlMedia *media
,const gchar *author
); void grl_media_add_director (GrlMedia *media
,const gchar *director
); void grl_media_add_external_player (GrlMedia *media
,const gchar *player
); void grl_media_add_external_url (GrlMedia *media
,const gchar *url
); void grl_media_add_genre (GrlMedia *media
,const gchar *genre
); void grl_media_add_keyword (GrlMedia *media
,const gchar *keyword
); void grl_media_add_lyrics (GrlMedia *media
,const gchar *lyrics
); void grl_media_add_mb_artist_id (GrlMedia *media
,const gchar *mb_artist_id
); void grl_media_add_performer (GrlMedia *media
,const gchar *performer
); void grl_media_add_producer (GrlMedia *media
,const gchar *producer
); void grl_media_add_region_data (GrlMedia *media
,const gchar *region
,const GDateTime *publication_date
,const gchar *certificate
); void grl_media_add_thumbnail (GrlMedia *media
,const gchar *thumbnail
); void grl_media_add_thumbnail_binary (GrlMedia *media
,const guint8 *thumbnail
,gsize size
); void grl_media_add_url_data (GrlMedia *media
,const gchar *url
,const gchar *mime
,gint bitrate
,gfloat framerate
,gint width
,gint height
); const gchar * grl_media_get_album (GrlMedia *media
); const gchar * grl_media_get_artist (GrlMedia *media
); const gchar * grl_media_get_artist_nth (GrlMedia *media
,guint index
); const gchar * grl_media_get_author (GrlMedia *media
); const gchar * grl_media_get_author_nth (GrlMedia *media
,guint index
); gint grl_media_get_bitrate (GrlMedia *media
); const gchar * grl_media_get_camera_model (GrlMedia *media
); const gchar * grl_media_get_certificate (GrlMedia *media
); gint grl_media_get_childcount (GrlMedia *media
); GDateTime * grl_media_get_creation_date (GrlMedia *media
); const gchar * grl_media_get_description (GrlMedia *media
); const gchar * grl_media_get_director (GrlMedia *media
); const gchar * grl_media_get_director_nth (GrlMedia *media
,guint index
); gint grl_media_get_duration (GrlMedia *media
); gint grl_media_get_episode (GrlMedia *media
); const gchar * grl_media_get_episode_title (GrlMedia *media
); gfloat grl_media_get_exposure_time (GrlMedia *media
); gboolean grl_media_get_favourite (GrlMedia *media
); const gchar * grl_media_get_flash_used (GrlMedia *media
); gfloat grl_media_get_framerate (GrlMedia *media
); const gchar * grl_media_get_genre (GrlMedia *media
); const gchar * grl_media_get_genre_nth (GrlMedia *media
,guint index
); gint grl_media_get_height (GrlMedia *media
); const gchar * grl_media_get_external_url (GrlMedia *media
); const gchar * grl_media_get_external_url_nth (GrlMedia *media
,guint index
); const gchar * grl_media_get_id (GrlMedia *media
); gfloat grl_media_get_iso_speed (GrlMedia *media
); const gchar * grl_media_get_keyword (GrlMedia *media
); const gchar * grl_media_get_keyword_nth (GrlMedia *media
,guint index
); GDateTime * grl_media_get_last_played (GrlMedia *media
); gint grl_media_get_last_position (GrlMedia *media
); const gchar * grl_media_get_license (GrlMedia *media
); const gchar * grl_media_get_mb_album_id (GrlMedia *media
); const gchar * grl_media_get_mb_artist_id (GrlMedia *media
); const gchar * grl_media_get_mb_artist_id_nth (GrlMedia *media
,guint index
); const gchar * grl_media_get_mb_recording_id (GrlMedia *media
); const gchar * grl_media_get_mb_track_id (GrlMedia *media
); const gchar * grl_media_get_mime (GrlMedia *media
); GDateTime * grl_media_get_modification_date (GrlMedia *media
); gint grl_media_get_orientation (GrlMedia *media
); const gchar * grl_media_get_original_title (GrlMedia *media
); const gchar * grl_media_get_performer (GrlMedia *media
); const gchar * grl_media_get_performer_nth (GrlMedia *media
,guint index
); const gchar * grl_media_get_producer (GrlMedia *media
); const gchar * grl_media_get_producer_nth (GrlMedia *media
,guint index
); gint grl_media_get_play_count (GrlMedia *media
); const gchar * grl_media_get_player (GrlMedia *media
); const gchar * grl_media_get_player_nth (GrlMedia *media
,guint index
); GDateTime * grl_media_get_publication_date (GrlMedia *media
); gfloat grl_media_get_rating (GrlMedia *media
); const gchar * grl_media_get_region (GrlMedia *media
); const gchar * grl_media_get_region_data (GrlMedia *media
,const GDateTime **publication_date
,const gchar **certificate
); const gchar * grl_media_get_region_data_nth (GrlMedia *media
,guint index
,const GDateTime **publication_date
,const gchar **certificate
); gint grl_media_get_season (GrlMedia *media
); const gchar * grl_media_get_show (GrlMedia *media
); const gchar * grl_media_get_site (GrlMedia *media
); const gchar * grl_media_get_source (GrlMedia *media
); gfloat grl_media_get_start_time (GrlMedia *media
); const gchar * grl_media_get_studio (GrlMedia *media
); const gchar * grl_media_get_thumbnail (GrlMedia *media
); const guint8 * grl_media_get_thumbnail_binary (GrlMedia *media
,gsize *size
); const guint8 * grl_media_get_thumbnail_binary_nth (GrlMedia *media
,gsize *size
,guint index
); const gchar * grl_media_get_thumbnail_nth (GrlMedia *media
,guint index
); gint grl_media_get_track_number (GrlMedia *media
); const gchar * grl_media_get_title (GrlMedia *media
); const gchar * grl_media_get_url (GrlMedia *media
); const gchar * grl_media_get_url_data (GrlMedia *media
,gchar **mime
,gint *bitrate
,gfloat *framerate
,gint *width
,gint *height
); const gchar * grl_media_get_url_data_nth (GrlMedia *media
,guint index
,gchar **mime
,gint *bitrate
,gfloat *framerate
,gint *width
,gint *height
); gint64 grl_media_get_size (GrlMedia *media
); gint grl_media_get_width (GrlMedia *media
); gchar * grl_media_serialize (GrlMedia *media
); gchar * grl_media_serialize_extended (GrlMedia *media
,GrlMediaSerializeType serial_type
,...
); void grl_media_set_album (GrlMedia *media
,const gchar *album
); void grl_media_set_artist (GrlMedia *media
,const gchar *artist
); void grl_media_set_author (GrlMedia *media
,const gchar *author
); void grl_media_set_bitrate (GrlMedia *media
,gint bitrate
); void grl_media_set_camera_model (GrlMedia *media
,const gchar *camera_model
); void grl_media_set_certificate (GrlMedia *media
,const gchar *certificate
); void grl_media_set_childcount (GrlMedia *media
,gint childcount
); void grl_media_set_creation_date (GrlMedia *media
,const GDateTime *creation_date
); void grl_media_set_description (GrlMedia *media
,const gchar *description
); void grl_media_set_director (GrlMedia *media
,const gchar *director
); void grl_media_set_duration (GrlMedia *media
,gint duration
); void grl_media_set_episode (GrlMedia *media
,gint episode
); void grl_media_set_episode_title (GrlMedia *media
,const gchar *episode_title
); void grl_media_set_exposure_time (GrlMedia *media
,gfloat exposure_time
); void grl_media_set_external_player (GrlMedia *media
,const gchar *player
); void grl_media_set_external_url (GrlMedia *media
,const gchar *url
); void grl_media_set_favourite (GrlMedia *media
,gboolean favourite
); void grl_media_set_flash_used (GrlMedia *media
,const gchar *flash_used
); void grl_media_set_framerate (GrlMedia *media
,gfloat framerate
); void grl_media_set_genre (GrlMedia *media
,const gchar *genre
); void grl_media_set_height (GrlMedia *media
,gint height
); void grl_media_set_id (GrlMedia *media
,const gchar *id
); void grl_media_set_iso_speed (GrlMedia *media
,gfloat iso_speed
); void grl_media_set_keyword (GrlMedia *media
,const gchar *keyword
); void grl_media_set_last_played (GrlMedia *media
,const GDateTime *last_played
); void grl_media_set_last_position (GrlMedia *media
,gint last_position
); void grl_media_set_license (GrlMedia *media
,const gchar *license
); void grl_media_set_lyrics (GrlMedia *media
,const gchar *lyrics
); void grl_media_set_mb_album_id (GrlMedia *media
,const gchar *mb_album_id
); void grl_media_set_mb_artist_id (GrlMedia *media
,const gchar *mb_artist_id
); void grl_media_set_mb_recording_id (GrlMedia *media
,const gchar *mb_recording_id
); void grl_media_set_mb_track_id (GrlMedia *media
,const gchar *mb_track_id
); void grl_media_set_mime (GrlMedia *media
,const gchar *mime
); void grl_media_set_modification_date (GrlMedia *media
,const GDateTime *modification_date
); void grl_media_set_original_title (GrlMedia *media
,const gchar *original_title
); void grl_media_set_orientation (GrlMedia *media
,gint orientation
); void grl_media_set_performer (GrlMedia *media
,const gchar *performer
); void grl_media_set_producer (GrlMedia *media
,const gchar *producer
); void grl_media_set_play_count (GrlMedia *media
,gint play_count
); void grl_media_set_publication_date (GrlMedia *media
,const GDateTime *date
); void grl_media_set_rating (GrlMedia *media
,gfloat rating
,gfloat max
); void grl_media_set_region (GrlMedia *media
,const gchar *region
); void grl_media_set_region_data (GrlMedia *media
,const gchar *region
,const GDateTime *publication_date
,const gchar *certificate
); void grl_media_set_season (GrlMedia *media
,gint season
); void grl_media_set_show (GrlMedia *media
,const gchar *show
); void grl_media_set_site (GrlMedia *media
,const gchar *site
); void grl_media_set_source (GrlMedia *media
,const gchar *source
); void grl_media_set_studio (GrlMedia *media
,const gchar *studio
); void grl_media_set_thumbnail (GrlMedia *media
,const gchar *thumbnail
); void grl_media_set_thumbnail_binary (GrlMedia *media
,const guint8 *thumbnail
,gsize size
); void grl_media_set_title (GrlMedia *media
,const gchar *title
); void grl_media_set_track_number (GrlMedia *media
,gint track_number
); void grl_media_set_url (GrlMedia *media
,const gchar *url
); void grl_media_set_url_data (GrlMedia *media
,const gchar *url
,const gchar *mime
,gint bitrate
,gfloat framerate
,gint width
,gint height
); void grl_media_set_size (GrlMedia *media
,gint64 size
); void grl_media_set_width (GrlMedia *media
,gint width
); GrlMedia * grl_media_unserialize (const gchar *serial
);
This high level class represents a multimedia item. It has methods to set and get properties like author, title, description, and so on.
struct GrlMediaClass { GrlDataClass parent_class; };
Grilo Media Class
GrlDataClass |
the parent class structure |
typedef enum { GRL_MEDIA_SERIALIZE_BASIC, GRL_MEDIA_SERIALIZE_PARTIAL, GRL_MEDIA_SERIALIZE_FULL } GrlMediaSerializeType;
GrlMedia serialize type
Basic mode | |
Partial mode | |
Full mode |
Since 0.2.3
typedef enum { GRL_MEDIA_TYPE_UNKNOWN, GRL_MEDIA_TYPE_AUDIO, GRL_MEDIA_TYPE_VIDEO, GRL_MEDIA_TYPE_IMAGE, GRL_MEDIA_TYPE_CONTAINER } GrlMediaType;
GrlMedia * grl_media_new (void
);
Creates a new data media object.
Returns : |
a newly-allocated data media. |
GrlMedia * grl_media_audio_new (void
);
Creates a new media audio object.
Returns : |
a newly-allocated media audio. |
Since 0.1.4
GrlMedia * grl_media_image_new (void
);
Creates a new media image object.
Returns : |
a newly-allocated media image. |
Since 0.1.4
GrlMedia * grl_media_video_new (void
);
Creates a new media video object.
Returns : |
a newly-allocated media video. |
Since 0.1.4
GrlMedia * grl_media_container_new (void
);
Creates a new media container object.
Returns : |
a newly-allocated media container. |
Since 0.3.0
gboolean grl_media_is_audio (GrlMedia *media
);
Check if media
is an audio
|
a media |
Returns : |
TRUE if media is an audio |
Since 0.3.0
gboolean grl_media_is_image (GrlMedia *media
);
Check if media
is an image
|
a media |
Returns : |
TRUE if media is an image |
Since 0.3.0
gboolean grl_media_is_video (GrlMedia *media
);
Check if media
is a video
|
a media |
Returns : |
TRUE if media is a video |
Since 0.3.0
gboolean grl_media_is_container (GrlMedia *media
);
Check if media
is a container
|
a media |
Returns : |
TRUE if media is a container |
Since 0.3.0
void grl_media_add_artist (GrlMedia *media
,const gchar *artist
);
Adds a new artist to media
.
|
the media instance |
|
an audio's artist |
Since 0.3.0
void grl_media_add_author (GrlMedia *media
,const gchar *author
);
Adds a new author to media
.
|
a GrlMedia |
|
an author for media
|
Since 0.1.10
void grl_media_add_director (GrlMedia *media
,const gchar *director
);
Adds the director of the media
|
a GrlMedia |
|
director of the movie |
Since 0.3.0
void grl_media_add_external_player (GrlMedia *media
,const gchar *player
);
Adds a new external player to media
.
|
a GrlMedia |
|
an external player for media
|
Since 0.1.10
void grl_media_add_external_url (GrlMedia *media
,const gchar *url
);
Adds a new external url to media
.
|
a GrlMedia |
|
an external url for media
|
Since 0.1.10
void grl_media_add_genre (GrlMedia *media
,const gchar *genre
);
Adds a new genre to media
.
|
the media instance |
|
an audio's genre |
Since 0.3.0
void grl_media_add_keyword (GrlMedia *media
,const gchar *keyword
);
Adds the keyword describing the media
.
|
a GrlMedia |
|
a keyword describing the media |
Since 0.2.3
void grl_media_add_lyrics (GrlMedia *media
,const gchar *lyrics
);
Adds a new lyrics to media
.
|
the media instance |
|
an audio's lyrics |
Since 0.3.0
void grl_media_add_mb_artist_id (GrlMedia *media
,const gchar *mb_artist_id
);
Adds a new MusicBrainz artist id to media
.
|
the media instance |
|
a MusicBrainz artist identifier |
Since 0.3.0
void grl_media_add_performer (GrlMedia *media
,const gchar *performer
);
Adds the actor performing in the movie.
|
a GrlMedia |
|
an actor performing in the movie |
Since 0.3.0
void grl_media_add_producer (GrlMedia *media
,const gchar *producer
);
Adds the producer of the media.
|
a GrlMedia |
|
producer of the movie |
Since 0.3.0
void grl_media_add_region_data (GrlMedia *media
,const gchar *region
,const GDateTime *publication_date
,const gchar *certificate
);
Adds regional publication and certification information for region
.
|
a GrlMedia |
|
the region's ISO-3166-1 code |
|
the publication date |
|
the age certification |
Since 0.2.3
void grl_media_add_thumbnail (GrlMedia *media
,const gchar *thumbnail
);
Adds a new thumbnail to media
.
|
a GrlMedia |
|
a thumbnail for media
|
Since 0.1.10
void grl_media_add_thumbnail_binary (GrlMedia *media
,const guint8 *thumbnail
,gsize size
);
Adds a new thumbnail to media
.
|
a GrlMedia |
|
a buffer containing the thumbnail for media
|
|
size of buffer |
Since 0.1.10
void grl_media_add_url_data (GrlMedia *media
,const gchar *url
,const gchar *mime
,gint bitrate
,gfloat framerate
,gint width
,gint height
);
Sets all the keys related with the URL of a media resource and adds it to
media
(useful for resources with more than one URL).
|
a GrlMedia |
|
a media's URL |
|
th url mime type |
|
the url bitrate, or -1 to ignore |
|
media framerate, or -1 to ignore |
|
media width, or -1 to ignore |
|
media height, or -1 to ignore |
Since 0.3.0
const gchar * grl_media_get_album (GrlMedia *media
);
|
the media instance |
Returns : |
the album of the media |
Since 0.3.0
const gchar * grl_media_get_artist (GrlMedia *media
);
|
the media instance |
Returns : |
the artist of the media |
Since 0.3.0
const gchar * grl_media_get_artist_nth (GrlMedia *media
,guint index
);
|
the media instance |
|
element to retrieve, starting at 0 |
Returns : |
the n-th artist of the media |
Since 0.3.0
const gchar * grl_media_get_author (GrlMedia *media
);
|
the media object |
Returns : |
the media's author |
Since 0.1.4
const gchar * grl_media_get_author_nth (GrlMedia *media
,guint index
);
|
the media object |
|
element to retrieve |
Returns : |
the n-th media's author. |
Since 0.1.10
gint grl_media_get_bitrate (GrlMedia *media
);
|
the media instance |
Returns : |
the bitrate of the media |
Since 0.3.0
const gchar * grl_media_get_camera_model (GrlMedia *media
);
|
the media instance |
Returns : |
model of camera used to take picture |
Since 0.3.0
const gchar * grl_media_get_certificate (GrlMedia *media
);
Returns the media's first age certificate.
This should usually be the media's most relevant
age certificate. Use grl_media_get_region_data_nth()
to
get other age certificates.
|
the media object |
Returns : |
the media's age certification |
Since 0.1.6
gint grl_media_get_childcount (GrlMedia *media
);
Number of children of this container.
|
the media container instance |
Returns : |
number of children, or GRL_METADATA_KEY_CHILDCOUNT_UNKNOWN if unknown. |
Since 0.3.0
GDateTime * grl_media_get_creation_date (GrlMedia *media
);
|
the media |
Returns : |
date when media was created (owned by media ). [transfer none]
|
Since 0.2.0
const gchar * grl_media_get_description (GrlMedia *media
);
|
the media object |
Returns : |
the media's description |
Since 0.1.4
const gchar * grl_media_get_director (GrlMedia *media
);
|
a GrlMedia |
Returns : |
the director of the movie (owned by media ). [transfer none]
|
Since 0.3.0
const gchar * grl_media_get_director_nth (GrlMedia *media
,guint index
);
|
a GrlMedia |
|
element to retrieve |
Returns : |
the director of the movie (owned by media ). [transfer none]
|
Since 0.3.0
gint grl_media_get_duration (GrlMedia *media
);
|
the media object |
Returns : |
the media's duration in seconds |
Since 0.1.4
gint grl_media_get_episode (GrlMedia *media
);
|
the media instance |
Returns : |
the episode number of the media |
Since 0.3.0
const gchar * grl_media_get_episode_title (GrlMedia *media
);
|
the media instance |
Returns : |
the title of the episode |
Since 0.3.0
gfloat grl_media_get_exposure_time (GrlMedia *media
);
|
the media instance |
Returns : |
picture's exposure time |
Since 0.3.0
gboolean grl_media_get_favourite (GrlMedia *media
);
|
the media object |
Returns : |
whether the media is favourite or not |
Since 0.2.3
const gchar * grl_media_get_flash_used (GrlMedia *media
);
|
the media instance |
Returns : |
whether the flash was used. See http://library.gnome.org/devel/ontology/unstable/nmm-classes.htmlnmm-Flash |
Since 0.3.0
gfloat grl_media_get_framerate (GrlMedia *media
);
|
the media instance |
Returns : |
the framerate of the media |
Since 0.3.0
const gchar * grl_media_get_genre (GrlMedia *media
);
|
the media instance |
Returns : |
the genre of the media |
Since 0.3.0
const gchar * grl_media_get_genre_nth (GrlMedia *media
,guint index
);
|
the media instance |
|
element to retrieve, starting at 0 |
Returns : |
the n-th genre of the media |
Since 0.3.0
gint grl_media_get_height (GrlMedia *media
);
|
the media instance |
Returns : |
the height of the media |
Since 0.3.0
const gchar * grl_media_get_external_url (GrlMedia *media
);
|
the media object |
Returns : |
URL of an external location where the user play the media. |
Since 0.1.6
const gchar * grl_media_get_external_url_nth (GrlMedia *media
,guint index
);
|
the media object |
|
element to retrieve |
Returns : |
the n-th media's external location where the user can play it. |
Since 0.1.10
const gchar * grl_media_get_id (GrlMedia *media
);
|
the media object |
Returns : |
the media's identifier |
Since 0.1.4
gfloat grl_media_get_iso_speed (GrlMedia *media
);
|
the media instance |
Returns : |
picture's iso speed |
Since 0.3.0
const gchar * grl_media_get_keyword (GrlMedia *media
);
|
a GrlMedia |
Returns : |
the keyword describing the media (owned by media ). [transfer none]
|
Since 0.2.3
const gchar * grl_media_get_keyword_nth (GrlMedia *media
,guint index
);
|
a GrlMedia |
|
element to retrieve |
Returns : |
the keyword describing the media (owned by media ). [transfer none]
|
Since 0.2.3
GDateTime * grl_media_get_last_played (GrlMedia *media
);
|
the media object |
Returns : |
the media's last played time |
Since 0.3.0
gint grl_media_get_last_position (GrlMedia *media
);
|
the media object |
Returns : |
the media's last_played position (in seconds) |
Since 0.1.4
const gchar * grl_media_get_license (GrlMedia *media
);
|
the media object |
Returns : |
the license the media is under |
Since 0.1.6
const gchar * grl_media_get_mb_album_id (GrlMedia *media
);
|
the media instance |
Returns : |
the MusicBrainz album identifier |
Since 0.3.0
const gchar * grl_media_get_mb_artist_id (GrlMedia *media
);
|
the media instance |
Returns : |
the MusicBrainz artist identifier |
Since 0.3.0
const gchar * grl_media_get_mb_artist_id_nth (GrlMedia *media
,guint index
);
|
the media instance |
|
element to retrieve, starting at 0 |
Returns : |
the n-th MusicBrainz artist identifier of the media |
Since 0.3.0
const gchar * grl_media_get_mb_recording_id (GrlMedia *media
);
|
the media instance |
Returns : |
the MusicBrainz recording identifier |
Since 0.3.0
const gchar * grl_media_get_mb_track_id (GrlMedia *media
);
|
the media instance |
Returns : |
the MusicBrainz track identifier |
Since 0.3.0
const gchar * grl_media_get_mime (GrlMedia *media
);
|
the media object |
Returns : |
the media's mime-type |
Since 0.1.4
GDateTime * grl_media_get_modification_date (GrlMedia *media
);
|
the media |
Returns : |
date when the media was last modified (owned by media ). [transfer none]
|
Since 0.2.0
gint grl_media_get_orientation (GrlMedia *media
);
|
the image instance |
Returns : |
degrees clockwise orientation of the picture |
Since 0.3.0
const gchar * grl_media_get_original_title (GrlMedia *media
);
|
a GrlMedia |
Returns : |
the original, untranslated title of the movie (owned by media ). [transfer none]
|
Since 0.3.0
const gchar * grl_media_get_performer (GrlMedia *media
);
|
a GrlMedia |
Returns : |
the actor performing in the movie (owned by media ). [transfer none]
|
Since 0.3.0
const gchar * grl_media_get_performer_nth (GrlMedia *media
,guint index
);
|
a GrlMedia |
|
element to retrieve |
Returns : |
the actor performing in the movie (owned by medi ). [transfer none]
|
Since 0.3.0
const gchar * grl_media_get_producer (GrlMedia *media
);
|
a GrlMedia |
Returns : |
the producer of the movie (owned by media ). [transfer none]
|
Since 0.3.0
const gchar * grl_media_get_producer_nth (GrlMedia *media
,guint index
);
|
a GrlMedia |
|
element to retrieve |
Returns : |
the producer of the movie (owned by media ). [transfer none]
|
Since 0.3.0
gint grl_media_get_play_count (GrlMedia *media
);
|
the media object |
Returns : |
the media's play count |
Since 0.1.4
const gchar * grl_media_get_player (GrlMedia *media
);
|
the media object |
Returns : |
URL of an external player object for this media |
Since 0.1.6
const gchar * grl_media_get_player_nth (GrlMedia *media
,guint index
);
|
the media object |
|
element to retrieve |
Returns : |
the n-th media's external player object. |
Since 0.1.10
GDateTime * grl_media_get_publication_date (GrlMedia *media
);
|
the media object |
Returns : |
the publication date of media (owned by media ). [transfer none]
|
Since 0.2.0
gfloat grl_media_get_rating (GrlMedia *media
);
|
the media object |
Returns : |
the media's rating |
Since 0.1.5
const gchar * grl_media_get_region (GrlMedia *media
);
|
the media object |
Returns : |
the ISO-3166-1 of the region where the media was
published (owned by media ). [transfer none]
|
Since 0.2.3
const gchar * grl_media_get_region_data (GrlMedia *media
,const GDateTime **publication_date
,const gchar **certificate
);
Returns the media's age certificate and publication date for the first region.
This should usually be the media's most relevant region.
Use grl_media_get_region_data_nth()
to get the age certificate and
publication date for other regions.
|
the media object |
|
the publication date, or NULL to ignore. [out][transfer none]
|
|
the age certification, or NULL to ignore. [out][transfer none]
|
Returns : |
the ISO-3166-1 of the region where the media was
published (owned by media ). [transfer none]
|
Since 0.2.3
const gchar * grl_media_get_region_data_nth (GrlMedia *media
,guint index
,const GDateTime **publication_date
,const gchar **certificate
);
Returns the media's age certificate and publication date for one region.
Use grl_data_length()
with GRL_METADATA_KEY_REGION to discover
how many regions are available. For instance:
1 2 3 4 5 6 7 8 9 10 |
guint count = grl_data_length (GRL_DATA (media), GRL_METADATA_KEY_REGION); guint i; for (i = 0; i < count; ++i) { const GDateTime* publication_date = NULL; const gchar* certificate = NULL; const gchar* region = grl_media_get_region_data_nth (media, i, &publication_date, &certificate); ... } |
|
the media object |
|
element to retrieve |
|
the publication date, or NULL to ignore. [out][transfer none]
|
|
the age certification, or NULL to ignore. [out][transfer none]
|
Returns : |
the ISO-3166-1 of the region where the media was
published (owned by media ). [transfer none]
|
Since 0.2.3
gint grl_media_get_season (GrlMedia *media
);
|
the media instance |
Returns : |
the season number of the media |
Since 0.3.0
const gchar * grl_media_get_show (GrlMedia *media
);
|
the media instance |
Returns : |
the show title of the media |
Since 0.3.0
const gchar * grl_media_get_site (GrlMedia *media
);
|
the media object |
Returns : |
the media's site |
Since 0.1.4
const gchar * grl_media_get_source (GrlMedia *media
);
|
the media object source |
Returns : |
the media's source |
Since 0.1.4
gfloat grl_media_get_start_time (GrlMedia *media
);
|
the media object |
Returns : |
the start time of the logical media resource inside the file containing it, in seconds. |
Since 0.1.19
const gchar * grl_media_get_studio (GrlMedia *media
);
|
the media object |
Returns : |
the studio the media is from |
Since 0.1.6
const gchar * grl_media_get_thumbnail (GrlMedia *media
);
|
the media object |
Returns : |
the media's thumbnail URL |
Since 0.1.4
const guint8 * grl_media_get_thumbnail_binary (GrlMedia *media
,gsize *size
);
|
the media object |
|
pointer to storing the thumbnail buffer size |
Returns : |
the media's thumbnail data and set size to the thumbnail buffer size |
Since 0.1.9
const guint8 * grl_media_get_thumbnail_binary_nth (GrlMedia *media
,gsize *size
,guint index
);
|
the media object |
|
pointer to store the thumbnail buffer size |
|
element to retrieve |
Returns : |
the n-th media's thumbnail binary and sets size to the thumbnail buffer size. |
Since 0.1.10
const gchar * grl_media_get_thumbnail_nth (GrlMedia *media
,guint index
);
|
the media object |
|
element to retrieve |
Returns : |
the n-th media's thumbnail. |
Since 0.1.10
gint grl_media_get_track_number (GrlMedia *media
);
|
the media instance |
Returns : |
the track number of the media |
Since 0.3.0
const gchar * grl_media_get_title (GrlMedia *media
);
|
the media object |
Returns : |
the media's title |
Since 0.1.4
const gchar * grl_media_get_url (GrlMedia *media
);
|
the media object |
Returns : |
the media's URL |
Since 0.1.4
const gchar * grl_media_get_url_data (GrlMedia *media
,gchar **mime
,gint *bitrate
,gfloat *framerate
,gint *width
,gint *height
);
|
the media object |
|
the mime-type, or NULL to ignore. [out][transfer none]
|
|
the url bitrate, or NULL to ignore. [out]
|
|
the url framerate, or NULL to ignore |
|
the url width, or NULL to ignore |
|
the url height, or NULL to ignore |
Returns : |
the media's URL and its related properties. |
Since 0.3.0
const gchar * grl_media_get_url_data_nth (GrlMedia *media
,guint index
,gchar **mime
,gint *bitrate
,gfloat *framerate
,gint *width
,gint *height
);
|
the media object |
|
element to retrieve |
|
the mime-type, or NULL to ignore. [out][transfer none]
|
|
the url bitrate, or NULL to ignore. [out]
|
|
the url framerate, or NULL to ignore |
|
the url width, or NULL to ignore |
|
the url height, or NULL to ignore |
Returns : |
the n-th media's URL and its related properties. |
Since 0.3.0
gint64 grl_media_get_size (GrlMedia *media
);
|
the media object |
Returns : |
the media's size, in bytes or -1 if unknown. |
Since 0.2.10
gint grl_media_get_width (GrlMedia *media
);
|
the media instance |
Returns : |
the width of the media |
Since 0.3.0
gchar * grl_media_serialize (GrlMedia *media
);
Serializes a GrlMedia into a string. It does a basic serialization.
See grl_media_serialize_extended()
to get more serialization approaches.
|
a GrlMedia |
Returns : |
serialized media |
Since 0.1.6
gchar * grl_media_serialize_extended (GrlMedia *media
,GrlMediaSerializeType serial_type
,...
);
Serializes a GrlMedia into a string.
See grl_media_unserialize()
to recover back the GrlMedia from the string.
If serialization type is GRL_MEDIA_SERIALIZE_PARTIAL
then it requires a
GList
with the properties to consider in serialization (id and source are
always considered).
|
a GrlMedia |
|
type of serialization |
|
media keys to serialize |
Returns : |
serialized media |
Since 0.1.6
void grl_media_set_album (GrlMedia *media
,const gchar *album
);
Set the album of the media
|
the media instance |
|
the audio's album |
Since 0.3.0
void grl_media_set_artist (GrlMedia *media
,const gchar *artist
);
Set the artist of the media
|
the media instance |
|
the audio's artist |
Since 0.3.0
void grl_media_set_author (GrlMedia *media
,const gchar *author
);
Set the media's author
|
the media |
|
the media's author |
Since 0.1.4
void grl_media_set_bitrate (GrlMedia *media
,gint bitrate
);
Set the bitrate of the media
|
the media instance |
|
the audio's bitrate |
Since 0.3.0
void grl_media_set_camera_model (GrlMedia *media
,const gchar *camera_model
);
Set the camera_model of the media
|
the media instance |
|
model of camera used to take picture |
Since 0.3.0
void grl_media_set_certificate (GrlMedia *media
,const gchar *certificate
);
Set the media's first age certification.
This should usually be the media's most relevant
age certificate. Use grl_media_set_region_data()
to
set other age certificates.
|
the media |
|
The age certificate of the media |
Since 0.1.6
void grl_media_set_childcount (GrlMedia *media
,gint childcount
);
Sets the number of children of this container. Use GRL_METADATA_KEY_CHILDCOUNT_UNKNOWN if it is unknown.
|
the media container instance |
|
number of children |
Since 0.3.0
void grl_media_set_creation_date (GrlMedia *media
,const GDateTime *creation_date
);
Set the creation_date of the media
|
the media |
|
date when media was created |
Since 0.2.0
void grl_media_set_description (GrlMedia *media
,const gchar *description
);
Set the media's description
|
the media |
|
the description |
Since 0.1.4
void grl_media_set_director (GrlMedia *media
,const gchar *director
);
Sets the director of the media.
|
a GrlMedia |
|
director of the movie |
Since 0.3.0
void grl_media_set_duration (GrlMedia *media
,gint duration
);
Set the media's duration
|
the media |
|
the duration in seconds |
Since 0.1.4
void grl_media_set_episode (GrlMedia *media
,gint episode
);
Sets the episode number of the media
|
the media instance |
|
the video's episode |
Since 0.3.0
void grl_media_set_episode_title (GrlMedia *media
,const gchar *episode_title
);
Sets the title of an media
|
the media instance |
|
the title of the episode |
Since 0.3.0
void grl_media_set_exposure_time (GrlMedia *media
,gfloat exposure_time
);
Set the exposure_time of the media
|
the media instance |
|
picture's exposure time |
Since 0.3.0
void grl_media_set_external_player (GrlMedia *media
,const gchar *player
);
Set the location of a player for the media (usually a flash player)
|
the media |
|
location of an external player for this media |
Since 0.1.6
void grl_media_set_external_url (GrlMedia *media
,const gchar *url
);
Set an external location where users can play the media
|
the media |
|
external location where this media can be played. |
Since 0.1.6
void grl_media_set_favourite (GrlMedia *media
,gboolean favourite
);
Set if the media is favourite or not
|
a media |
|
whether the item is favourite or not |
Since 0.2.3
void grl_media_set_flash_used (GrlMedia *media
,const gchar *flash_used
);
Set the flash_used of the media See http://library.gnome.org/devel/ontology/unstable/nmm-classes.htmlnmm-Flash
|
the media instance |
|
whether the flash was used |
Since 0.3.0
void grl_media_set_framerate (GrlMedia *media
,gfloat framerate
);
Set the framerate of the media
|
the media instance |
|
the video's framerate |
Since 0.3.0
void grl_media_set_genre (GrlMedia *media
,const gchar *genre
);
Set the genre of the media
|
the media instance |
|
the audio's genre |
Since 0.3.0
void grl_media_set_height (GrlMedia *media
,gint height
);
Set the height of the media
|
the media instance |
|
the video's height |
Since 0.3.0
void grl_media_set_id (GrlMedia *media
,const gchar *id
);
Set the media identifier
|
the media |
|
the identifier of the media |
Since 0.1.4
void grl_media_set_iso_speed (GrlMedia *media
,gfloat iso_speed
);
Set the iso_speed of the media
|
the media instance |
|
picture's iso speed |
Since 0.3.0
void grl_media_set_keyword (GrlMedia *media
,const gchar *keyword
);
Sets the keyword describing the media
.
|
a GrlMedia |
|
a keyword describing the media |
Since 0.2.3
void grl_media_set_last_played (GrlMedia *media
,const GDateTime *last_played
);
Set the media last played date
|
the media |
|
date when the media was last played |
Since 0.3.0
void grl_media_set_last_position (GrlMedia *media
,gint last_position
);
Set the media last played position
|
the media |
|
second at which the media playback was interrupted |
Since 0.1.4
void grl_media_set_license (GrlMedia *media
,const gchar *license
);
Set the media license
|
the media |
|
The license of the media |
Since 0.1.6
void grl_media_set_lyrics (GrlMedia *media
,const gchar *lyrics
);
Set the lyrics of the media
|
the media instance |
|
the audio's lyrics |
Since 0.3.0
void grl_media_set_mb_album_id (GrlMedia *media
,const gchar *mb_album_id
);
Set the MusicBrainz album identifier of the media
|
the media instance |
|
the MusicBrainz album identifier |
Since 0.3.0
void grl_media_set_mb_artist_id (GrlMedia *media
,const gchar *mb_artist_id
);
Set the MusicBrainz artist identifier of the media
|
the media instance |
|
the MusicBrainz artist identifier |
Since 0.3.0
void grl_media_set_mb_recording_id (GrlMedia *media
,const gchar *mb_recording_id
);
Set the MusicBrainz recording identifier of the media
|
the media instance |
|
the MusicBrainz recording identifier |
Since 0.3.0
void grl_media_set_mb_track_id (GrlMedia *media
,const gchar *mb_track_id
);
Set the MusicBrainz track identifier of the media
|
the media instance |
|
the MusicBrainz track identifier |
Since 0.3.0
void grl_media_set_mime (GrlMedia *media
,const gchar *mime
);
Set the media's mime-type
|
the media |
|
the mime type |
Since 0.1.4
void grl_media_set_modification_date (GrlMedia *media
,const GDateTime *modification_date
);
Set the modification date of the media
|
the media |
|
date when the media was last modified |
Since 0.2.0
void grl_media_set_original_title (GrlMedia *media
,const gchar *original_title
);
Sets the original, untranslated title of the media.
|
a GrlMedia |
|
original, untranslated title of the movie |
Since 0.3.0
void grl_media_set_orientation (GrlMedia *media
,gint orientation
);
Set the orientation of the media
|
the media instance |
|
degrees clockwise orientation of the picture |
Since 0.3.0
void grl_media_set_performer (GrlMedia *media
,const gchar *performer
);
Sets the actor performing in the movie.
|
a GrlMedia |
|
an actor performing in the movie |
Since 0.3.0
void grl_media_set_producer (GrlMedia *media
,const gchar *producer
);
Sets the producer of the media.
|
a GrlMedia |
|
producer of the movie |
Since 0.3.0
void grl_media_set_play_count (GrlMedia *media
,gint play_count
);
Set the media play count
|
the media |
|
the play count |
Since 0.1.4
void grl_media_set_publication_date (GrlMedia *media
,const GDateTime *date
);
Set the publication date of media
.
|
the media |
|
the date |
Since 0.2.0
void grl_media_set_rating (GrlMedia *media
,gfloat rating
,gfloat max
);
This method receives a rating and its scale and normalizes it on a scale from 0...5 to match the usual five-star rating.
|
a media |
|
a rating value |
|
maximum rating value |
Since 0.1.5
void grl_media_set_region (GrlMedia *media
,const gchar *region
);
Sets the region
where media
was published.
|
a GrlMedia |
|
the region's ISO-3166-1 code |
Since 0.2.3
void grl_media_set_region_data (GrlMedia *media
,const gchar *region
,const GDateTime *publication_date
,const gchar *certificate
);
Sets regional publication and certification information for region
.
|
a GrlMedia |
|
the region's ISO-3166-1 code |
|
the publication date |
|
the age certification |
Since 0.2.3
void grl_media_set_season (GrlMedia *media
,gint season
);
Sets the season number of the media
|
the media instance |
|
the video's season |
Since 0.3.0
void grl_media_set_show (GrlMedia *media
,const gchar *show
);
Sets the show title of the media
|
the media instance |
|
the video's show name |
Since 0.3.0
void grl_media_set_site (GrlMedia *media
,const gchar *site
);
Set the media's site. A site is a website about the media such as a studio's promotional website for a movie.
|
the media |
|
the site |
Since 0.1.4
void grl_media_set_source (GrlMedia *media
,const gchar *source
);
Set the media's source
|
the media |
|
the source |
Since 0.1.4
void grl_media_set_studio (GrlMedia *media
,const gchar *studio
);
Set the media studio
|
the media |
|
The studio the media is from |
Since 0.1.6
void grl_media_set_thumbnail (GrlMedia *media
,const gchar *thumbnail
);
Set the media's thumbnail URL
|
the media |
|
the thumbnail URL |
Since 0.1.4
void grl_media_set_thumbnail_binary (GrlMedia *media
,const guint8 *thumbnail
,gsize size
);
Set the media's binary thumbnail
|
the media |
|
thumbnail buffer |
|
thumbnail buffer size |
Since 0.1.9
void grl_media_set_title (GrlMedia *media
,const gchar *title
);
Set the media's title
|
the media |
|
the title |
Since 0.1.4
void grl_media_set_track_number (GrlMedia *media
,gint track_number
);
Set the track number of the media
|
the media instance |
|
the audio's track number |
Since 0.3.0
void grl_media_set_url (GrlMedia *media
,const gchar *url
);
Set the media's URL
|
the media |
|
the media's URL |
Since 0.1.4
void grl_media_set_url_data (GrlMedia *media
,const gchar *url
,const gchar *mime
,gint bitrate
,gfloat framerate
,gint width
,gint height
);
Sets all the keys related with the URL of a media resource in one go.
|
a GrlMedia |
|
the media's URL |
|
the url mime type |
|
the url bitrate, or -1 to ignore |
|
media framerate, or -1 to ignore |
|
media width, or -1 to ignore |
|
media height, or -1 to ignore |
Since 0.3.0
void grl_media_set_size (GrlMedia *media
,gint64 size
);
Set the size of the media
|
the media |
|
the size in bytes |
Since 0.2.10
void grl_media_set_width (GrlMedia *media
,gint width
);
Set the width of the media
|
the media instance |
|
the video's width |
Since 0.3.0
GrlMedia * grl_media_unserialize (const gchar *serial
);
Unserializes a GrlMedia.
|
a serialized media |
Returns : |
the GrlMedia from the serial. [transfer full] |
Since 0.1.6
"media-type"
property"media-type" GrlMediaType : Read / Write / Construct
Type of media.
Default value: GRL_MEDIA_TYPE_UNKNOWN