diff options
author | Thibault Saunier <tsaunier@igalia.com> | 2021-02-24 23:49:06 -0300 |
---|---|---|
committer | GStreamer Marge Bot <gitlab-merge-bot@gstreamer-foundation.org> | 2021-05-05 10:02:44 +0000 |
commit | 4b0e54b1fbdafc22cb9a46fde041a5937dc3461c (patch) | |
tree | de5aaf6a8871def620f6201caf748dd63fa6f197 | |
parent | 906654de879d1006bea94f6430727a1506e6daef (diff) |
track-element: Fix and cleanup annotations
Making the class subclass able by bindings
Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-editing-services/-/merge_requests/231>
-rw-r--r-- | ges/ges-track-element.h | 61 |
1 files changed, 41 insertions, 20 deletions
diff --git a/ges/ges-track-element.h b/ges/ges-track-element.h index 6d984c91..507fe87e 100644 --- a/ges/ges-track-element.h +++ b/ges/ges-track-element.h @@ -64,31 +64,26 @@ struct _GESTrackElement { /** * GESTrackElementClass: - * @nleobject_factorytype: The name of the #GstElementFactory to use to - * create the underlying nleobject of a track element - * @create_gnl_object: Method to create the underlying nleobject of the - * track element. The default implementation will use the factory given by - * @nleobject_factorytype to created the nleobject and will give it - * the #GstElement returned by @create_element. - * @active_changed: Method to be called when the #GESTrackElement:active - * property changes. - * @list_children_properties: Deprecated: Listing children properties is - * handled by ges_timeline_element_list_children_properties() instead. - * @lookup_child: Deprecated: Use #GESTimelineElement.lookup_child() - * instead. - * @default_has_internal_source: What the default - * #GESTrackElement:has-internal-source value should be for new elements - * from this class. - * @default_track_type: What the default #GESTrackElement:track-type value - * should be for new elements from this class. */ struct _GESTrackElementClass { /*< private >*/ GESTimelineElementClass parent_class; /*< public >*/ - /* virtual methods for subclasses */ + /** + * GESTrackElementClass::nleobject_factorytype: + * + * The name of the #GstElementFactory to use to create the underlying + * nleobject of a track element + */ const gchar *nleobject_factorytype; + + /** + * GESTrackElementClass::create_gnl_object: + * @object: The #GESTrackElement + * + * Returns: (transfer floating): the #NLEObject to use in the #nlecomposition + */ GstElement* (*create_gnl_object) (GESTrackElement * object); /** @@ -100,16 +95,42 @@ struct _GESTrackElementClass { */ GstElement* (*create_element) (GESTrackElement * object); + /** + * GESTrackElementClass::active_changed: + * @object: A #GESTrackElement + * @active: Whether the element is active or not inside the #nlecomposition + * + * Notify when the #GESTrackElement:active property changes + */ void (*active_changed) (GESTrackElement *object, gboolean active); /*< private >*/ /* signals (currently unused) */ + /** + * GESTrackElementClass::changed: + * + * Deprecated: + */ void (*changed) (GESTrackElement * object); - /*< public >*/ - /* virtual methods for subclasses */ + /** + * GESTrackElementClass::list_children_properties: + * + * Listing children properties is handled by + * ges_timeline_element_list_children_properties() instead. + * + * Deprecated: 1.14: Use #GESTimelineElementClass::list_children_properties + * instead + */ GParamSpec** (*list_children_properties) (GESTrackElement * object, guint *n_properties); + + /** + * GESTrackElementClass::lookup_child: + * + * Deprecated: 1.14: Use #GESTimelineElementClass::lookup_child + * instead + */ gboolean (*lookup_child) (GESTrackElement *object, const gchar *prop_name, GstElement **element, |