| Top |
Functions
Object Hierarchy
GObject
╰── GrlData
╰── GrlMedia
├── GrlMediaBox
├── GrlMediaAudio
├── GrlMediaVideo
╰── GrlMediaImage
Description
This high level class represents a multimedia item. It has methods to set and get properties like author, title, description, and so on.
Functions
grl_media_add_author ()
void grl_media_add_author (GrlMedia *media,const gchar *author);
Adds a new author to media
.
Since: 0.1.10
grl_media_add_external_player ()
void grl_media_add_external_player (GrlMedia *media,const gchar *player);
Adds a new external player to media
.
Since: 0.1.10
grl_media_add_external_url ()
void grl_media_add_external_url (GrlMedia *media,const gchar *url);
Adds a new external url to media
.
Since: 0.1.10
grl_media_add_keyword ()
void grl_media_add_keyword (GrlMedia *media,const gchar *keyword);
Adds the keyword describing the media
.
Since: 0.2.3
grl_media_add_region_data ()
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
.
Parameters
media |
a GrlMedia |
|
region |
the region's ISO-3166-1 code |
|
publication_date |
the publication date |
|
certificate |
the age certification |
Since: 0.2.3
grl_media_add_thumbnail ()
void grl_media_add_thumbnail (GrlMedia *media,const gchar *thumbnail);
Adds a new thumbnail to media
.
Since: 0.1.10
grl_media_add_thumbnail_binary ()
void grl_media_add_thumbnail_binary (GrlMedia *media,const guint8 *thumbnail,gsize size);
Adds a new thumbnail to media
.
Parameters
media |
a GrlMedia |
|
thumbnail |
a buffer containing the thumbnail for |
|
size |
size of buffer |
Since: 0.1.10
grl_media_add_url_data ()
void grl_media_add_url_data (GrlMedia *media,const gchar *url,const gchar *mime);
Adds a new media's URL with its mime-type.
Since: 0.1.10
grl_media_get_author_nth ()
const gchar * grl_media_get_author_nth (GrlMedia *media,guint index);
Since: 0.1.10
grl_media_get_certificate ()
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.
Since: 0.1.6
grl_media_get_creation_date ()
GDateTime *
grl_media_get_creation_date (GrlMedia *media);
Since: 0.2.0
grl_media_get_description ()
const gchar *
grl_media_get_description (GrlMedia *media);
Since: 0.1.4
grl_media_get_external_url ()
const gchar *
grl_media_get_external_url (GrlMedia *media);
Since: 0.1.6
grl_media_get_external_url_nth ()
const gchar * grl_media_get_external_url_nth (GrlMedia *media,guint index);
Since: 0.1.10
grl_media_get_keyword_nth ()
const gchar * grl_media_get_keyword_nth (GrlMedia *media,guint index);
Since: 0.2.3
grl_media_get_last_played ()
const gchar *
grl_media_get_last_played (GrlMedia *media);
Since: 0.1.4
grl_media_get_modification_date ()
GDateTime *
grl_media_get_modification_date (GrlMedia *media);
Since: 0.2.0
grl_media_get_player_nth ()
const gchar * grl_media_get_player_nth (GrlMedia *media,guint index);
Since: 0.1.10
grl_media_get_publication_date ()
GDateTime *
grl_media_get_publication_date (GrlMedia *media);
Since: 0.2.0
grl_media_get_region ()
const gchar *
grl_media_get_region (GrlMedia *media);
Returns
the ISO-3166-1 of the region where the media was
published (owned by media
).
[transfer none]
Since: 0.2.3
grl_media_get_region_data ()
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.
Parameters
media |
the media object |
|
publication_date |
the publication date, or |
[out][transfer none] |
certificate |
the age certification, or |
[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
grl_media_get_region_data_nth ()
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); ... } |
Parameters
media |
the media object |
|
index |
element to retrieve |
|
publication_date |
the publication date, or |
[out][transfer none] |
certificate |
the age certification, or |
[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
grl_media_get_thumbnail_binary ()
const guint8 * grl_media_get_thumbnail_binary (GrlMedia *media,gsize *size);
Since: 0.1.9
grl_media_get_thumbnail_binary_nth ()
const guint8 * grl_media_get_thumbnail_binary_nth (GrlMedia *media,gsize *size,guint index);
Parameters
media |
the media object |
|
size |
pointer to store the thumbnail buffer size |
|
index |
element to retrieve |
Since: 0.1.10
grl_media_get_thumbnail_nth ()
const gchar * grl_media_get_thumbnail_nth (GrlMedia *media,guint index);
Since: 0.1.10
grl_media_get_url_data ()
const gchar * grl_media_get_url_data (GrlMedia *media,gchar **mime);
Since: 0.1.10
grl_media_get_url_data_nth ()
const gchar * grl_media_get_url_data_nth (GrlMedia *media,guint index,gchar **mime);
Parameters
media |
the media object |
|
index |
element to retrieve |
|
mime |
the mime-type, or |
[out][transfer none] |
Since: 0.1.10
grl_media_serialize ()
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.
Since: 0.1.6
grl_media_serialize_extended ()
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).
Since: 0.1.6
grl_media_set_author ()
void grl_media_set_author (GrlMedia *media,const gchar *author);
Set the media's author
Since: 0.1.4
grl_media_set_certificate ()
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.
Since: 0.1.6
grl_media_set_creation_date ()
void grl_media_set_creation_date (GrlMedia *media,const GDateTime *creation_date);
Set the creation_date of the media
Since: 0.2.0
grl_media_set_description ()
void grl_media_set_description (GrlMedia *media,const gchar *description);
Set the media's description
Since: 0.1.4
grl_media_set_duration ()
void grl_media_set_duration (GrlMedia *media,gint duration);
Set the media's duration
Since: 0.1.4
grl_media_set_external_player ()
void grl_media_set_external_player (GrlMedia *media,const gchar *player);
Set the location of a player for the media (usually a flash player)
Since: 0.1.6
grl_media_set_external_url ()
void grl_media_set_external_url (GrlMedia *media,const gchar *url);
Set an external location where users can play the media
Since: 0.1.6
grl_media_set_favourite ()
void grl_media_set_favourite (GrlMedia *media,gboolean favourite);
Set if the media is favourite or not
Since: 0.2.3
grl_media_set_id ()
void grl_media_set_id (GrlMedia *media,const gchar *id);
Set the media identifier
Since: 0.1.4
grl_media_set_keyword ()
void grl_media_set_keyword (GrlMedia *media,const gchar *keyword);
Sets the keyword describing the media
.
Since: 0.2.3
grl_media_set_last_played ()
void grl_media_set_last_played (GrlMedia *media,const gchar *last_played);
Set the media last played date
Since: 0.1.4
grl_media_set_last_position ()
void grl_media_set_last_position (GrlMedia *media,gint last_position);
Set the media last played position
Since: 0.1.4
grl_media_set_license ()
void grl_media_set_license (GrlMedia *media,const gchar *license);
Set the media license
Since: 0.1.6
grl_media_set_mime ()
void grl_media_set_mime (GrlMedia *media,const gchar *mime);
Set the media's mime-type
Since: 0.1.4
grl_media_set_modification_date ()
void grl_media_set_modification_date (GrlMedia *media,const GDateTime *modification_date);
Set the modification date of the media
Since: 0.2.0
grl_media_set_play_count ()
void grl_media_set_play_count (GrlMedia *media,gint play_count);
Set the media play count
Since: 0.1.4
grl_media_set_publication_date ()
void grl_media_set_publication_date (GrlMedia *media,const GDateTime *date);
Set the publication date of media
.
Since: 0.2.0
grl_media_set_rating ()
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.
Since: 0.1.5
grl_media_set_region ()
void grl_media_set_region (GrlMedia *media,const gchar *region);
Sets the region
where media
was published.
Since: 0.2.3
grl_media_set_region_data ()
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
.
Parameters
media |
a GrlMedia |
|
region |
the region's ISO-3166-1 code |
|
publication_date |
the publication date |
|
certificate |
the age certification |
Since: 0.2.3
grl_media_set_site ()
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.
Since: 0.1.4
grl_media_set_source ()
void grl_media_set_source (GrlMedia *media,const gchar *source);
Set the media's source
Since: 0.1.4
grl_media_set_studio ()
void grl_media_set_studio (GrlMedia *media,const gchar *studio);
Set the media studio
Since: 0.1.6
grl_media_set_thumbnail ()
void grl_media_set_thumbnail (GrlMedia *media,const gchar *thumbnail);
Set the media's thumbnail URL
Since: 0.1.4
grl_media_set_thumbnail_binary ()
void grl_media_set_thumbnail_binary (GrlMedia *media,const guint8 *thumbnail,gsize size);
Set the media's binary thumbnail
Since: 0.1.9
grl_media_set_title ()
void grl_media_set_title (GrlMedia *media,const gchar *title);
Set the media's title
Since: 0.1.4
grl_media_set_url ()
void grl_media_set_url (GrlMedia *media,const gchar *url);
Set the media's URL
Since: 0.1.4
grl_media_set_url_data ()
void grl_media_set_url_data (GrlMedia *media,const gchar *url,const gchar *mime);
Set the media's URL and its mime-type.
Since: 0.1.10
grl_media_set_size ()
void grl_media_set_size (GrlMedia *media,gint64 size);
Set the size of the media
Since: 0.2.10
grl_media_unserialize ()
GrlMedia *
grl_media_unserialize (const gchar *serial);
Unserializes a GrlMedia.
Since: 0.1.6
