Commit a90f9dc2 authored by Guillaume Desmottes's avatar Guillaume Desmottes 🐐

add missing Since annotations on new API

Part-of: <!181>
parent d56f3fe9
Pipeline #155350 waiting for manual action with stages
in 17 seconds
......@@ -201,6 +201,7 @@ _child_property_removed (GESTimelineElement * element, GObject * child,
* #GESTrackElement:has-internal-source set to %TRUE.
*
* Returns: %TRUE if the child property was found and newly registered.
* Since: 1.18
*/
gboolean
ges_base_effect_register_time_property (GESBaseEffect * effect,
......@@ -288,6 +289,7 @@ ges_base_effect_register_time_property (GESBaseEffect * effect,
* #GESTrackElement:has-internal-source set to %TRUE.
*
* Returns: %TRUE if the translation functions were set.
* Since: 1.18
*/
gboolean
ges_base_effect_set_time_translation_funcs (GESBaseEffect * effect,
......@@ -331,6 +333,7 @@ ges_base_effect_set_time_translation_funcs (GESBaseEffect * effect,
* considered a time effect.
*
* Returns: %TRUE if @effect is considered a time effect.
* Since: 1.18
*/
gboolean
ges_base_effect_is_time_effect (GESBaseEffect * effect)
......
......@@ -72,6 +72,7 @@ struct _GESBaseEffectClass
* values given in @time_properties before using the currently set values.
*
* Returns: The translated time.
* Since: 1.18
*/
typedef GstClockTime (*GESBaseEffectTimeTranslationFunc) (GESBaseEffect * effect,
GstClockTime time,
......
......@@ -2808,6 +2808,7 @@ ges_clip_is_moving_from_layer (GESClip * clip)
* layer.
*
* Returns: %TRUE if @clip was successfully moved to @layer.
* Since: 1.18
*/
gboolean
ges_clip_move_to_layer_full (GESClip * clip, GESLayer * layer, GError ** error)
......@@ -2972,6 +2973,7 @@ ges_clip_get_layer (GESClip * clip)
* Gets the #GESClip:duration-limit of the clip.
*
* Returns: The duration-limit of @clip.
* Since: 1.18
*/
GstClockTime
ges_clip_get_duration_limit (GESClip * clip)
......@@ -3013,6 +3015,7 @@ _cmp_children_by_priority (gconstpointer a_p, gconstpointer b_p)
* would not be able to adapt itself once the effect is added.
*
* Returns: %TRUE if @effect was successfully added to @clip at @index.
* Since: 1.18
*/
gboolean
ges_clip_add_top_effect (GESClip * clip, GESBaseEffect * effect, gint index,
......@@ -3107,6 +3110,7 @@ _is_added_effect (GESClip * clip, GESBaseEffect * effect)
* would not be able to adapt itself once the effect is removed.
*
* Returns: %TRUE if @effect was successfully added to @clip at @index.
* Since: 1.18
*/
gboolean
ges_clip_remove_top_effect (GESClip * clip, GESBaseEffect * effect,
......@@ -3221,6 +3225,7 @@ ges_clip_set_top_effect_priority (GESClip * clip,
* ordering.
*
* Returns: %TRUE if @effect was successfully moved to @newindex.
* Since: 1.18
*/
gboolean
ges_clip_set_top_effect_index_full (GESClip * clip, GESBaseEffect * effect,
......@@ -3367,6 +3372,7 @@ ges_clip_set_top_effect_index (GESClip * clip, GESBaseEffect * effect,
*
* Returns: (transfer none) (nullable): The newly created clip resulting
* from the splitting @clip, or %NULL if @clip can't be split.
* Since: 1.18
*/
GESClip *
ges_clip_split_full (GESClip * clip, guint64 position, GError ** error)
......@@ -4142,6 +4148,7 @@ ges_clip_get_timeline_time_from_internal_time (GESClip * clip,
* Returns: The time in the internal coordinates of @child corresponding
* to @timeline_time, or #GST_CLOCK_TIME_NONE if the conversion could not
* be performed.
* Since: 1.18
*/
GstClockTime
ges_clip_get_internal_time_from_timeline_time (GESClip * clip,
......@@ -4346,6 +4353,7 @@ ges_clip_get_core_internal_time_from_timeline_time (GESClip * clip,
* Returns: The timestamp corresponding to @frame_number in the core
* children of @clip, in the timeline coordinates, or #GST_CLOCK_TIME_NONE
* if the conversion could not be performed.
* Since: 1.18
*/
GstClockTime
ges_clip_get_timeline_time_from_source_frame (GESClip * clip,
......
......@@ -522,6 +522,15 @@ typedef enum {
GES_EDIT_MODE_SLIDE
} GESEditMode;
/**
* ges_edit_mode_name:
* @mode: a #GESEditMode
*
* Return a string representation of @mode.
*
* Returns: (transfer none): a string representation of @mode.
* Since: 1.18
*/
GES_API
const gchar * ges_edit_mode_name (GESEditMode mode);
......
......@@ -40,15 +40,15 @@ G_BEGIN_DECLS
* @GES_ERROR_FORMATTER_MALFORMED_INPUT_FILE: The formatted files was malformed
* @GES_ERROR_INVALID_FRAME_NUMBER: The frame number is invalid
* @GES_ERROR_NEGATIVE_LAYER: The operation would lead to a negative
* #GES_TIMELINE_ELEMENT_LAYER_PRIORITY
* #GES_TIMELINE_ELEMENT_LAYER_PRIORITY. (Since: 1.18)
* @GES_ERROR_NEGATIVE_TIME: The operation would lead to a negative time.
* E.g. for the #GESTimelineElement:start #GESTimelineElement:duration or
* #GESTimelineElement:in-point.
* #GESTimelineElement:in-point. (Since: 1.18)
* @GES_ERROR_NOT_ENOUGH_INTERNAL_CONTENT: Some #GESTimelineElement does
* not have a large enough #GESTimelineElement:max-duration to cover the
* desired operation
* desired operation. (Since: 1.18)
* @GES_ERROR_INVALID_OVERLAP_IN_TRACK: The operation would break one of
* the overlap conditions for the #GESTimeline
* the overlap conditions for the #GESTimeline. (Since: 1.18)
*/
typedef enum
{
......
......@@ -665,6 +665,7 @@ ges_layer_is_empty (GESLayer * layer)
*
* Returns: %TRUE if @clip was properly added to @layer, or %FALSE
* if @layer refused to add @clip.
* Since: 1.18
*/
gboolean
ges_layer_add_clip_full (GESLayer * layer, GESClip * clip, GError ** error)
......@@ -851,6 +852,7 @@ ges_layer_add_clip (GESLayer * layer, GESClip * clip)
* the given properties.
*
* Returns: (transfer none): The newly created clip.
* Since: 1.18
*/
GESClip *
ges_layer_add_asset_full (GESLayer * layer,
......
......@@ -38,6 +38,7 @@
*
* Returns: (transfer floating) (nullable): The newly created #GESSourceClip,
* or %NULL if there was an error.
* Since: 1.18
*/
GESSourceClip *
ges_source_clip_new_time_overlay (void)
......
......@@ -1847,6 +1847,7 @@ ges_timeline_element_set_child_property_by_pspec (GESTimelineElement * self,
* property name (and type name) are left unchanged!
*
* Returns: %TRUE if the property was found and set.
* Since: 1.18
*/
gboolean
ges_timeline_element_set_child_property_full (GESTimelineElement * self,
......@@ -2384,6 +2385,7 @@ ges_timeline_element_get_layer_priority (GESTimelineElement * self)
* timeline.
*
* Returns: %TRUE if the edit of @self completed, %FALSE on failure.
* Since: 1.18
*/
gboolean
......
......@@ -221,7 +221,7 @@ struct _GESTimelineElement
* setting can fail, with the @error being optionally set. Default
* implementation will call @set_child_property and return %TRUE.
* @get_layer_priority: Get the #GESLayer:priority of the layer that this
* element is part of.
* element is part of. (Since: 1.18)
* @list_children_properties: List the children properties that have been
* registered for the element. The default implementation is able to fetch
* all of these, so should be sufficient. If you overwrite this, you
......
......@@ -1990,6 +1990,8 @@ ges_track_element_get_control_binding (GESTrackElement * object,
* a timed value for the control source lies before the in-point of the
* element, or after its out-point, then it will be removed. At the
* in-point and out-point times, a new interpolated value will be placed.
*
* Since: 1.18
*/
void
ges_track_element_clamp_control_source (GESTrackElement * object,
......@@ -2027,6 +2029,8 @@ ges_track_element_clamp_control_source (GESTrackElement * object,
*
* Sets #GESTrackElement:auto-clamp-control-sources. If set to %TRUE, this
* will immediately clamp all the control sources.
*
* Since: 1.18
*/
void
ges_track_element_set_auto_clamp_control_sources (GESTrackElement * object,
......@@ -2054,6 +2058,7 @@ ges_track_element_set_auto_clamp_control_sources (GESTrackElement * object,
*
* Returns: Whether the control sources for the child properties of
* @object are automatically clamped.
* Since: 1.18
*/
gboolean
ges_track_element_get_auto_clamp_control_sources (GESTrackElement * object)
......@@ -2093,6 +2098,7 @@ ges_track_element_freeze_control_sources (GESTrackElement * object,
* will be a core child of its parent clip.
*
* Returns: %TRUE if @element is a core track element.
* Since: 1.18
*/
gboolean
ges_track_element_is_core (GESTrackElement * object)
......
......@@ -1148,6 +1148,7 @@ remove_element_internal (GESTrack * track, GESTrackElement * object,
* Note that a #GESTrackElement can only be added to one track.
*
* Returns: %TRUE if @object was successfully added to @track.
* Since: 1.18
*/
gboolean
ges_track_add_element_full (GESTrack * track, GESTrackElement * object,
......@@ -1275,6 +1276,7 @@ ges_track_get_elements (GESTrack * track)
* ownership of the element.
*
* Returns: %TRUE if @object was successfully removed from @track.
* Since: 1.18
*/
gboolean
ges_track_remove_element_full (GESTrack * track, GESTrackElement * object,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment