Class (GI Class)

Grl-0.3GrlMedia

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

_init add_artist add_author add_director add_external_player add_external_url add_genre add_keyword add_lyrics add_mb_artist_id add_performer add_producer add_region_data add_thumbnail add_thumbnail_binary add_url_data connect connect_after emit get_album get_album_artist get_album_disc_number get_artist get_artist_nth get_author get_author_nth get_bitrate get_camera_model get_certificate get_childcount get_composer get_composer_nth get_creation_date get_description get_director get_director_nth get_duration get_episode get_episode_title get_exposure_time get_external_url get_external_url_nth get_favourite get_flash_used get_framerate get_genre get_genre_nth get_height get_id get_iso_speed get_keyword get_keyword_nth get_last_played get_last_position get_license get_lyrics get_lyrics_nth get_mb_album_id get_mb_artist_id get_mb_artist_id_nth get_mb_recording_id get_mb_release_group_id get_mb_release_id get_mb_track_id get_media_type get_mime get_modification_date get_orientation get_original_title get_performer get_performer_nth get_play_count get_player get_player_nth get_producer get_producer_nth get_publication_date get_rating get_region get_region_data get_region_data_nth get_season get_show get_site get_size get_source get_start_time get_studio get_thumbnail get_thumbnail_binary get_thumbnail_binary_nth get_thumbnail_nth get_title get_track_number get_url get_url_data get_url_data_nth get_width is_audio is_container is_image is_video serialize set_album set_album_artist set_album_disc_number set_artist set_author set_bitrate set_camera_model set_certificate set_childcount set_composer set_creation_date set_description set_director set_duration set_episode set_episode_title set_exposure_time set_external_player set_external_url set_favourite set_flash_used set_framerate set_genre set_height set_id set_iso_speed set_keyword set_last_played set_last_position set_license set_lyrics set_mb_album_id set_mb_artist_id set_mb_recording_id set_mb_release_group_id set_mb_release_id set_mb_track_id set_mime set_modification_date set_orientation set_original_title set_performer set_play_count set_producer set_publication_date set_rating set_region set_region_data set_season set_show set_site set_size set_source set_studio set_thumbnail set_thumbnail_binary set_title set_track_number set_url set_url_data set_width audio_new container_new image_new new unserialize video_new

Methods - Inherited from Grl.Data

Constructors

Properties

Compile-time signal type information.

This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.

$gtype: GType<Grl.Media>

Accessors

Methods

  • Adds a new artist to media.

    Parameters

    • artist: string

      an audio's artist

    Returns void

  • Adds a new author to media.

    Parameters

    • author: string

      an author for media

    Returns void

  • Adds the director of the media

    Parameters

    • director: string

      director of the movie

    Returns void

  • Adds a new external player to media.

    Parameters

    • player: string

      an external player for media

    Returns void

  • Adds a new external url to media.

    Parameters

    • url: string

      an external url for media

    Returns void

  • Adds a new genre to media.

    Parameters

    • genre: string

      an audio's genre

    Returns void

  • Adds the keyword describing the media.

    Parameters

    • keyword: string

      a keyword describing the media

    Returns void

  • Adds a new lyrics to media.

    Parameters

    • lyrics: string

      an audio's lyrics

    Returns void

  • Adds a new MusicBrainz artist id to media.

    Parameters

    • mb_artist_id: string

      a MusicBrainz artist identifier

    Returns void

  • Adds the actor performing in the movie.

    Parameters

    • performer: string

      an actor performing in the movie

    Returns void

  • Adds the producer of the media.

    Parameters

    • producer: string

      producer of the movie

    Returns void

  • Adds regional publication and certification information for region.

    Parameters

    • region: string

      the region's ISO-3166-1 code

    • publication_date: GLib.DateTime

      the publication date

    • certificate: string

      the age certification

    Returns void

  • Adds a new thumbnail to media.

    Parameters

    • thumbnail: string

      a thumbnail for media

    Returns void

  • Adds a new thumbnail to media.

    Parameters

    • thumbnail: number

      a buffer containing the thumbnail for media

    • size: number

      size of buffer

    Returns void

  • 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).

    Parameters

    • url: string

      a media's URL

    • mime: string

      th url mime type

    • bitrate: number

      the url bitrate, or -1 to ignore

    • framerate: number

      media framerate, or -1 to ignore

    • width: number

      media width, or -1 to ignore

    • height: number

      media height, or -1 to ignore

    Returns void

  • Returns number

    the disc number of the media for multi-disc album sets.

  • Parameters

    • index: number

      element to retrieve, starting at 0

    Returns string

    the n-th artist of the media

  • Parameters

    • index: number

      element to retrieve

    Returns string

    the n-th media's author.

  • 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.

    Returns string

    the media's age certification

  • Number of children of this container.

    Returns number

    number of children, or #GRL_METADATA_KEY_CHILDCOUNT_UNKNOWN if unknown.

  • Parameters

    • index: number

      element to retrieve, starting at 0

    Returns string

    the n-th composer of the media

  • Parameters

    • index: number

      element to retrieve

    Returns string

    the director of the movie (owned by media).

  • Returns string

    URL of an external location where the user play the media.

  • Parameters

    • index: number

      element to retrieve

    Returns string

    the n-th media's external location where the user can play it.

  • Parameters

    • index: number

      element to retrieve, starting at 0

    Returns string

    the n-th genre of the media

  • Parameters

    • index: number

      element to retrieve

    Returns string

    the keyword describing the media (owned by media).

  • Parameters

    • index: number

      element to retrieve, starting at 0

    Returns string

    the n-th lyrics of the media

  • Parameters

    • index: number

      element to retrieve, starting at 0

    Returns string

    the n-th MusicBrainz artist identifier of the media

  • Returns string

    the MusicBrainz release group identifier of the media

  • Returns string

    the MusicBrainz release identifier of the media

  • Returns string

    the original, untranslated title of the movie (owned by media).

  • Returns string

    the actor performing in the movie (owned by media).

  • Parameters

    • index: number

      element to retrieve

    Returns string

    the actor performing in the movie (owned by medi).

  • Parameters

    • index: number

      element to retrieve

    Returns string

    the n-th media's external player object.

  • Parameters

    • index: number

      element to retrieve

    Returns string

    the producer of the movie (owned by media).

  • Returns string

    the ISO-3166-1 of the region where the media was published (owned by media).

  • 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.

    Returns [string, GLib.DateTime, string]

    the ISO-3166-1 of the region where the media was published (owned by media).

  • 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:

    Parameters

    • index: number

      element to retrieve

    Returns [string, GLib.DateTime, string]

    the ISO-3166-1 of the region where the media was published (owned by media).

  • Returns number

    the start time of the logical media resource inside the file containing it, in seconds.

  • Parameters

    • size: number

      pointer to storing the thumbnail buffer size

    Returns number

    the media's thumbnail data and set size to the thumbnail buffer size

  • Parameters

    • size: number

      pointer to store the thumbnail buffer size

    • index: number

      element to retrieve

    Returns number

    the n-th media's thumbnail binary and sets size to the thumbnail buffer size.

  • Parameters

    • index: number

      element to retrieve

    Returns string

    the n-th media's thumbnail.

  • Parameters

    • framerate: number

      the url framerate, or null to ignore

    • width: number

      the url width, or null to ignore

    • height: number

      the url height, or null to ignore

    Returns [string, string, number]

    the media's URL and its related properties.

  • Parameters

    • index: number

      element to retrieve

    • framerate: number

      the url framerate, or null to ignore

    • width: number

      the url width, or null to ignore

    • height: number

      the url height, or null to ignore

    Returns [string, string, number]

    the n-th media's URL and its related properties.

  • Check if media is a container

    Returns boolean

    true if media is a container

  • Serializes a GrlMedia into a string. It does a basic serialization.

    See grl_media_serialize_extended() to get more serialization approaches.

    Returns string

    serialized media

  • Set the album of the media

    Parameters

    • album: string

      the audio's album

    Returns void

  • Set the main artist of the album of the media

    Parameters

    • album_artist: string

      the audio's album main artist

    Returns void

  • Set the disc number of the media for multi-disc album sets.

    Parameters

    • disc_number: number

      the disc number within an album

    Returns void

  • Set the artist of the media

    Parameters

    • artist: string

      the audio's artist

    Returns void

  • Set the media's author

    Parameters

    • author: string

      the media's author

    Returns void

  • Set the bitrate of the media

    Parameters

    • bitrate: number

      the audio's bitrate

    Returns void

  • Set the camera_model of the media

    Parameters

    • camera_model: string

      model of camera used to take picture

    Returns void

  • 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.

    Parameters

    • certificate: string

      The age certificate of the media

    Returns void

  • Sets the number of children of this container. Use #GRL_METADATA_KEY_CHILDCOUNT_UNKNOWN if it is unknown.

    Parameters

    • childcount: number

      number of children

    Returns void

  • Set the composer of the media

    Parameters

    • composer: string

      the audio's composer

    Returns void

  • Set the media's description

    Parameters

    • description: string

      the description

    Returns void

  • Sets the director of the media.

    Parameters

    • director: string

      director of the movie

    Returns void

  • Set the media's duration

    Parameters

    • duration: number

      the duration in seconds

    Returns void

  • Sets the episode number of the media

    Parameters

    • episode: number

      the video's episode

    Returns void

  • Sets the title of an media

    Parameters

    • episode_title: string

      the title of the episode

    Returns void

  • Set the exposure_time of the media

    Parameters

    • exposure_time: number

      picture's exposure time

    Returns void

  • Set the location of a player for the media (usually a flash player)

    Parameters

    • player: string

      location of an external player for this media

    Returns void

  • Set an external location where users can play the media

    Parameters

    • url: string

      external location where this media can be played.

    Returns void

  • Set if the media is favourite or not

    Parameters

    • favourite: boolean

      whether the item is favourite or not

    Returns void

  • Set the framerate of the media

    Parameters

    • framerate: number

      the video's framerate

    Returns void

  • Set the genre of the media

    Parameters

    • genre: string

      the audio's genre

    Returns void

  • Set the height of the media

    Parameters

    • height: number

      the video's height

    Returns void

  • Set the media identifier

    Parameters

    • id: string

      the identifier of the media

    Returns void

  • Set the iso_speed of the media

    Parameters

    • iso_speed: number

      picture's iso speed

    Returns void

  • Sets the keyword describing the media.

    Parameters

    • keyword: string

      a keyword describing the media

    Returns void

  • Set the media last played position

    Parameters

    • last_position: number

      second at which the media playback was interrupted

    Returns void

  • Set the media license

    Parameters

    • license: string

      The license of the media

    Returns void

  • Set the lyrics of the media

    Parameters

    • lyrics: string

      the audio's lyrics

    Returns void

  • Set the MusicBrainz album identifier of the media

    Parameters

    • mb_album_id: string

      the MusicBrainz album identifier

    Returns void

  • Set the MusicBrainz artist identifier of the media

    Parameters

    • mb_artist_id: string

      the MusicBrainz artist identifier

    Returns void

  • Set the MusicBrainz recording identifier of the media

    Parameters

    • mb_recording_id: string

      the MusicBrainz recording identifier

    Returns void

  • Set the MusicBrainz Release Group identifier of the media

    Parameters

    • mb_release_group_id: string

      Album group release identifier in MusicBrainz

    Returns void

  • Set the MusicBrainz release identifier of the media

    Parameters

    • mb_release_id: string

      Album release identifier in MusicBrainz

    Returns void

  • Set the MusicBrainz track identifier of the media

    Parameters

    • mb_track_id: string

      the MusicBrainz track identifier

    Returns void

  • Set the media's mime-type

    Parameters

    • mime: string

      the mime type

    Returns void

  • Set the orientation of the media

    Parameters

    • orientation: number

      degrees clockwise orientation of the picture

    Returns void

  • Sets the original, untranslated title of the media.

    Parameters

    • original_title: string

      original, untranslated title of the movie

    Returns void

  • Sets the actor performing in the movie.

    Parameters

    • performer: string

      an actor performing in the movie

    Returns void

  • Set the media play count

    Parameters

    • play_count: number

      the play count

    Returns void

  • Sets the producer of the media.

    Parameters

    • producer: string

      producer of the movie

    Returns void

  • This method receives a rating and its scale and normalizes it on a scale from 0...5 to match the usual five-star rating.

    Parameters

    • rating: number

      a rating value

    • max: number

      maximum rating value

    Returns void

  • Sets the region where media was published.

    Parameters

    • region: string

      the region's ISO-3166-1 code

    Returns void

  • Sets regional publication and certification information for region.

    Parameters

    • region: string

      the region's ISO-3166-1 code

    • publication_date: GLib.DateTime

      the publication date

    • certificate: string

      the age certification

    Returns void

  • Sets the season number of the media

    Parameters

    • season: number

      the video's season

    Returns void

  • Sets the show title of the media

    Parameters

    • show: string

      the video's show name

    Returns void

  • Set the media's site. A site is a website about the media such as a studio's promotional website for a movie.

    Parameters

    • site: string

      the site

    Returns void

  • Set the size of the media

    Parameters

    • size: number

      the size in bytes

    Returns void

  • Set the media's source

    Parameters

    • source: string

      the source

    Returns void

  • Set the media studio

    Parameters

    • studio: string

      The studio the media is from

    Returns void

  • Set the media's thumbnail URL

    Parameters

    • thumbnail: string

      the thumbnail URL

    Returns void

  • Set the media's binary thumbnail

    Parameters

    • thumbnail: number

      thumbnail buffer

    • size: number

      thumbnail buffer size

    Returns void

  • Set the media's title

    Parameters

    • title: string

      the title

    Returns void

  • Set the track number of the media

    Parameters

    • track_number: number

      the audio's track number

    Returns void

  • Set the media's URL

    Parameters

    • url: string

      the media's URL

    Returns void

  • Sets all the keys related with the URL of a media resource in one go.

    Parameters

    • url: string

      the media's URL

    • mime: string

      the url mime type

    • bitrate: number

      the url bitrate, or -1 to ignore

    • framerate: number

      media framerate, or -1 to ignore

    • width: number

      media width, or -1 to ignore

    • height: number

      media height, or -1 to ignore

    Returns void

  • Set the width of the media

    Parameters

    • width: number

      the video's width

    Returns void

Methods - Inherited from Grl.Data

  • Appends a new binary value for key in data.

    Parameters

    • key: number

      key to append

    • buf: number

      the buffer containing the new value

    • size: number

      size of buffer

    Returns void

  • Appends a new boxed value for key in data.

    Parameters

    • key: number

      key to append

    • Optionalboxed: any

      the new value

    Returns void

  • Appends a new float value for key in data.

    Parameters

    • key: number

      key to append

    • floatvalue: number

      the new value

    Returns void

  • Appends the value associated with key_name to data. This key_name is used to create a new GObject.ParamSpec instance, which is further used to create and register a key using grl_registry_register_metadata_key().

    A property key_name consists of segments consisting of ASCII letters and digits, separated by either the '-' or '_' character. The first character of a property key_name must be a letter. Key_names which violate these rules lead to undefined behaviour.

    Parameters

    • key_name: string

      name of the key to change or add

    • value: any

      the new value

    Returns boolean

    TRUE if value was added to key_name, FALSE otherwise.

  • Appends a new int value for key in data.

    Parameters

    • key: number

      key to append

    • intvalue: number

      the new value

    Returns void

  • Appends a new int64 value for key in data.

    Parameters

    • key: number

      key to append

    • intvalue: number

      the new value

    Returns void

  • Appends a new string value for key in data.

    Parameters

    • key: number

      key to append

    • strvalue: string

      the new value

    Returns void

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned GObject.Binding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A GObject.Object can have multiple bindings.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Complete version of g_object_bind_property().

    Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well. The transform_from function is only used in case of bidirectional bindings, otherwise it will be ignored

    The binding will automatically be removed when either the source or the target instances are finalized. This will release the reference that is being held on the GObject.Binding instance; if you want to hold on to the GObject.Binding instance, you will need to hold a reference to it.

    To remove the binding, call g_binding_unbind().

    A GObject.Object can have multiple bindings.

    The same user_data parameter will be used for both transform_to and transform_from transformation functions; the notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target GObject.Object

    • target_property: string

      the property on target to bind

    • flags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • Optionaltransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • Optionaltransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • Optionalnotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using GClosures instead of function pointers.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.

    Parameters

    • id: number

      Handler ID of the handler to be disconnected

    Returns void

  • This function is intended for GObject.Object implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one GObject.Object::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • Get the first value from data associated with key.

    Parameters

    • key: number

      key to look up.

    Returns unknown

    a GObject.Value. This value should not be modified nor freed by user.

  • Returns the first binary value associated with key from data. If key has no first value, or value is not a gfloat, or key is not in data, then null is returned.

    Parameters

    • key: number

      key to use

    Returns [number, number]

    buffer location associated with the key, or null in other case. If successful size will be set the to the buffer size.

  • Parameters

    • key: number

      key to use

    Returns boolean

    the first boolean value associated with key from data. If key has no first value, or value is not a gboolean, or key is not in the data, then FALSE is returned

  • Returns the first boxed value associated with key from data. If key has no first value, that value is not of a boxed type, or key is not in data, then null is returned.

    Parameters

    • key: number

      key to use

    Returns any

    the boxed instance associated with key if possible, or null in other cases. The caller should not change nor free the value.

  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • key: string

      name of the key for that association

    Returns any

    the data if found, or null if no such data exists.

  • Returns the first float value associated with key from data. If key has no first value, or value is not a gfloat, or key is not in data, then 0 is returned.

    Parameters

    • key: number

      key to use

    Returns number

    float value associated with key, or 0 in other case.

  • Returns the first int value associated with key from data. If key has no first value, or value is not a gint, or key is not in data, then 0 is returned.

    Parameters

    • key: number

      key to use

    Returns number

    int value associated with key, or 0 in other case.

  • Returns the first int64 value associated with key from data. If key has no first value, or value is not a gint, or key is not in data, then 0 is returned.

    Parameters

    • key: number

      key to use

    Returns number

    int value associated with key, or 0 in other case.

  • Returns a list with keys contained in data.

    Returns number[]

    an array with the keys. The content of the list should not be modified or freed. Use g_list_free() when done using the list.

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.

    Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.

    Parameters

    • property_name: string

      The name of the property to get

    • value: any

      Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type

    Returns any

  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • Returns a set containing the values for key and related keys at position index from data.

    If user changes any of the values in the related keys, the changes will become permanent.

    Parameters

    • key: number

      a metadata key

    • index: number

      element to retrieve, starting at 0

    Returns Grl.RelatedKeys

    a Grl.RelatedKeys. Do not free it.

  • Returns all non-null values for key from data. This ignores related keys.

    Parameters

    • key: number

      a metadata key

    Returns unknown[]

    a GLib.List with values. Do not change or free the values. Free the list with g_list_free.

  • Returns all non-null values for key from data. key must have been registered as a string-type key. This ignores related keys.

    Parameters

    • key: number

      a metadata key

    Returns string[]

    a GLib.List with values. Do not change or free the strings. Free the list with g_list_free.

  • Returns the first string value associated with key from data. If key has no first value, or value is not string, or key is not in data, then null is returned.

    Parameters

    • key: number

      key to use

    Returns string

    string associated with key, or null in other case. Caller should not change nor free the value.

  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • Checks if key is in data.

    Parameters

    • key: number

      key to search

    Returns boolean

    true if key is in data, false in other case.

  • Returns how many values key or related keys have in data: if key has no value, but a related key has, then it is counted as positive.

    As example, let's think in three related keys, K1, K2 and K3, and then thinks we have added several values for those keys, as:

    (V10, V20, V30), (V11, NULL, V31), (V12, NULL, V32)

    Therefore, when invoking grl_data_length (data, K2) it will return 3: considering K2 and the related keys (K1 and K3), there are 3 values.

    Parameters

    • key: number

      a metadata key

    Returns number

    number of values

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      typedef enum
    {
    PROP_FOO = 1,
    PROP_LAST
    } MyObjectProperty;

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
    0, 100,
    50,
    G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    Returns void

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

    the same object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

    object

  • Removes the first value for key from data. If there are other keys related to key their values will also be removed from data.

    Parameters

    • key: number

      key to remove

    Returns void

  • Removes the value at position index for key from data. If there are other keys related to key, their values at position index will also be removed from data.

    Parameters

    • key: number

      a metadata key

    • index: number

      index of key to be removed, starting at 0

    Returns void

  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • Sets the first value associated with key in data. If key already has a value old value is freed and the new one is set.

    Also, checks that value is compliant with key specification, modifying it accordingly. For instance, if key requires a number between 0 and 10, but value is outside this range, it will be adapted accordingly.

    Parameters

    • key: number

      key to change or add

    • value: any

      the new value

    Returns void

  • Parameters

    • ...args: never[]

    Returns any

  • Sets the first binary value associated with key in data. If key already has a first value old value is replaced by the new one.

    Parameters

    • key: number

      key to change or add

    • buf: number

      buffer holding the data

    • size: number

      size of the buffer

    Returns void

  • Sets the first boolean value associated with key in data. If key already has a first value, old value is replaced by the new one.

    Parameters

    • key: number

      key to change or add

    • boolvalue: boolean

      the new value

    Returns void

  • Sets the first boxed value associated with key in data. If key already has a value, the old value is freed and the new one is set.

    Parameters

    • key: number

      key to change or add

    • Optionalboxed: any

      the new value

    Returns void

  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a GLib.Quark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the GLib.Quark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optionaldata: any

      data to associate with that key

    Returns void

  • Sets the first float value associated with key in data. If key already has a first value old value is replaced by the new one.

    Parameters

    • key: number

      key to change or add

    • floatvalue: number

      the new value

    Returns void

  • Sets the first value associated with key_name in data. This key_name is used to create a new GObject.ParamSpec instance, which is further used to create and register a key using grl_registry_register_metadata_key(). If key_name already has a first value, old value is replaced by the new one.

    A property key_name consists of segments consisting of ASCII letters and digits, separated by either the '-' or '_' character. The first character of a property key_name must be a letter. Key_names which violate these rules lead to undefined behaviour.

    Parameters

    • key_name: string

      name of the key to change or add

    • value: any

      the new value

    Returns boolean

    TRUE if value was set to key_name, FALSE otherwise.

  • Sets the first int value associated with key in data. If key already has a first value old value is replaced by the new one.

    Parameters

    • key: number

      key to change or add

    • intvalue: number

      the new value

    Returns void

  • Sets the first int64 value associated with key in data. If key already has a first value old value is replaced by the new one.

    Parameters

    • key: number

      key to change or add

    • intvalue: number

      the new value

    Returns void

  • Sets a property on an object.

    Parameters

    • property_name: string

      The name of the property to set

    • value: any

      The value to set the property to

    Returns void

  • Updates the values at position index in data with values in relkeys.

    data will take ownership of relkeys, so do not free it after invoking this function.

    Parameters

    • relkeys: Grl.RelatedKeys

      a set of related keys

    • index: number

      position to be updated, starting at 0

    Returns void

  • Sets the first string value associated with key in data. If key already has a value old value is freed and the new one is set.

    Parameters

    • key: number

      key to change or add

    • strvalue: string

      the new value

    Returns void

  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • key: string

      name of the key

    Returns any

    the data if found, or null if no such data exists.

  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.

    Parameters

    • detailedName: string

      Name of the signal to stop emission of

    Returns void

  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the GObject.Object may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to null rather than retain a dangling pointer to a potentially invalid GObject.Object instance. Use g_clear_object() for this.

    Returns void

  • the constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. constructed implementors should chain up to the constructed call of their parent class to allow it to complete its initialisation.

    Returns void

  • the dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, dispose should chain up to the dispose method of the parent class.

    Returns void

  • instance finalization function, should finish the finalization of the instance begun in dispose and chain up to the finalize method of the parent class.

    Returns void

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    Returns void

  • the generic setter for all properties of this type. Should be overridden for every type with properties. If implementations of set_property don't emit property change notification explicitly, this will be done implicitly by the type system. However, if the notify signal is emitted explicitly, the type system will not emit it a second time.

    Parameters

    Returns void

  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    Returns void

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created GObject.ParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of GObject.TypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    Returns void

  • Parameters

    • property_id: number

      the new property ID

    • name: string

      the name of a property registered in a parent class or in an interface of this class.

    Returns void

Interfaces

ConstructorProps
SignalSignatures