mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-07-03 13:16:04 +00:00
Code Issues 1 Projects Releases Wiki Activity

navigation: Add introspection annotations for some output parameters

Browse source 
The missing annotations prevented proper usage from introspected
bindings like python.

https://bugzilla.gnome.org/show_bug.cgi?id=783330
This commit is contained in:
Scott D Phillips 2017-06-01 13:01:03 -07:00 committed by Arun Raghavan
parent e774d1ca4b
commit 8d1b45ded6
1 changed files with 31 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
gst-libs/gst/video/navigation.c
View file

@ -277,7 +277,8 @@ gst_navigation_query_set_commands (GstQuery * query, gint n_cmds, ...)
* gst_navigation_query_set_commandsv: * gst_navigation_query_set_commandsv:
* @query: a #GstQuery * @query: a #GstQuery
* @n_cmds: the number of commands to set. * @n_cmds: the number of commands to set.
* @cmds: An array containing @n_cmds @GstNavigationCommand values. * @cmds: (array length=n_cmds): An array containing @n_cmds
* @GstNavigationCommand values.
* *
* Set the #GstNavigation command query result fields in @query. The number * Set the #GstNavigation command query result fields in @query. The number
* of commands passed must be equal to @n_commands. * of commands passed must be equal to @n_commands.
@ -303,7 +304,7 @@ gst_navigation_query_set_commandsv (GstQuery * query, gint n_cmds,
/** /**
* gst_navigation_query_parse_commands_length: * gst_navigation_query_parse_commands_length:
* @query: a #GstQuery * @query: a #GstQuery
* @n_cmds: (out): the number of commands in this query. * @n_cmds: (out) (optional): the number of commands in this query.
* *
* Parse the number of commands in the #GstNavigation commands @query. * Parse the number of commands in the #GstNavigation commands @query.
* *
@ -334,7 +335,7 @@ gst_navigation_query_parse_commands_length (GstQuery * query, guint * n_cmds)
* gst_navigation_query_parse_commands_nth: * gst_navigation_query_parse_commands_nth:
* @query: a #GstQuery * @query: a #GstQuery
* @nth: the nth command to retrieve. * @nth: the nth command to retrieve.
* @cmd: (out): a pointer to store the nth command into. * @cmd: (out) (optional): a pointer to store the nth command into.
* *
* Parse the #GstNavigation command query and retrieve the @nth command from * Parse the #GstNavigation command query and retrieve the @nth command from
* it into @cmd. If the list contains less elements than @nth, @cmd will be * it into @cmd. If the list contains less elements than @nth, @cmd will be
@ -415,10 +416,10 @@ gst_navigation_query_set_angles (GstQuery * query, guint cur_angle,
/** /**
* gst_navigation_query_parse_angles: * gst_navigation_query_parse_angles:
* @query: a #GstQuery * @query: a #GstQuery
* @cur_angle: Pointer to a #guint into which to store the currently selected * @cur_angle: (out) (optional): Pointer to a #guint into which to store the
* angle value from the query, or NULL * currently selected angle value from the query, or NULL
* @n_angles: Pointer to a #guint into which to store the number of angles * @n_angles: (out) (optional): Pointer to a #guint into which to store the
* value from the query, or NULL * number of angles value from the query, or NULL
* *
* Parse the current angle number in the #GstNavigation angles @query into the * Parse the current angle number in the #GstNavigation angles @query into the
* #guint pointed to by the @cur_angle variable, and the number of available * #guint pointed to by the @cur_angle variable, and the number of available
@ -522,8 +523,8 @@ gst_navigation_message_new_mouse_over (GstObject * src, gboolean active)
/** /**
* gst_navigation_message_parse_mouse_over: * gst_navigation_message_parse_mouse_over:
* @message: A #GstMessage to inspect. * @message: A #GstMessage to inspect.
* @active: A pointer to a gboolean to receive the active/inactive state, * @active: (out) (optional): A pointer to a gboolean to receive the
* or NULL. * active/inactive state, or NULL.
* *
* Parse a #GstNavigation message of type #GST_NAVIGATION_MESSAGE_MOUSE_OVER * Parse a #GstNavigation message of type #GST_NAVIGATION_MESSAGE_MOUSE_OVER
* and extract the active/inactive flag. If the mouse over event is marked * and extract the active/inactive flag. If the mouse over event is marked
@ -576,8 +577,8 @@ gst_navigation_message_new_event (GstObject * src, GstEvent * event)
/** /**
* gst_navigation_message_parse_event: * gst_navigation_message_parse_event:
* @message: A #GstMessage to inspect. * @message: A #GstMessage to inspect.
* @event: (out) (transfer full): a pointer to a #GstEvent to receive the * @event: (out) (optional) (transfer full): a pointer to a #GstEvent to receive
* contained navigation event. * the contained navigation event.
* *
* Parse a #GstNavigation message of type #GST_NAVIGATION_MESSAGE_EVENT * Parse a #GstNavigation message of type #GST_NAVIGATION_MESSAGE_EVENT
* and extract contained #GstEvent. The caller must unref the @event when done * and extract contained #GstEvent. The caller must unref the @event when done
@ -657,9 +658,10 @@ gst_navigation_message_new_angles_changed (GstObject * src, guint cur_angle,
/** /**
* gst_navigation_message_parse_angles_changed: * gst_navigation_message_parse_angles_changed:
* @message: A #GstMessage to inspect. * @message: A #GstMessage to inspect.
* @cur_angle: A pointer to a #guint to receive the new current angle number, * @cur_angle: (out) (optional): A pointer to a #guint to receive the new
* or NULL * current angle number, or NULL
* @n_angles: A pointer to a #guint to receive the new angle count, or NULL. * @n_angles: (out) (optional): A pointer to a #guint to receive the new angle
* count, or NULL.
* *
* Parse a #GstNavigation message of type GST_NAVIGATION_MESSAGE_ANGLES_CHANGED * Parse a #GstNavigation message of type GST_NAVIGATION_MESSAGE_ANGLES_CHANGED
* and extract the @cur_angle and @n_angles parameters. * and extract the @cur_angle and @n_angles parameters.
@ -734,9 +736,9 @@ gst_navigation_event_get_type (GstEvent * event)
/** /**
* gst_navigation_event_parse_key_event: * gst_navigation_event_parse_key_event:
* @event: A #GstEvent to inspect. * @event: A #GstEvent to inspect.
* @key: A pointer to a location to receive the string identifying the key * @key: (out) (optional) (transfer none): A pointer to a location to receive
* press. The returned string is owned by the event, and valid only until the * the string identifying the key press. The returned string is owned by the
* event is unreffed. * event, and valid only until the event is unreffed.
*/ */
gboolean gboolean
gst_navigation_event_parse_key_event (GstEvent * event, const gchar ** key) gst_navigation_event_parse_key_event (GstEvent * event, const gchar ** key)
@ -761,12 +763,12 @@ gst_navigation_event_parse_key_event (GstEvent * event, const gchar ** key)
/** /**
* gst_navigation_event_parse_mouse_button_event: * gst_navigation_event_parse_mouse_button_event:
* @event: A #GstEvent to inspect. * @event: A #GstEvent to inspect.
* @button: Pointer to a gint that will receive the button number associated * @button: (out) (optional): Pointer to a gint that will receive the button
* with the event. * number associated with the event.
* @x: Pointer to a gdouble to receive the x coordinate of the mouse button * @x: (out) (optional): Pointer to a gdouble to receive the x coordinate of the
* event. * mouse button event.
* @y: Pointer to a gdouble to receive the y coordinate of the mouse button * @y: (out) (optional): Pointer to a gdouble to receive the y coordinate of the
* event. * mouse button event.
* *
* Retrieve the details of either a #GstNavigation mouse button press event or * Retrieve the details of either a #GstNavigation mouse button press event or
* a mouse button release event. Determine which type the event is using * a mouse button release event. Determine which type the event is using
@ -803,8 +805,10 @@ gst_navigation_event_parse_mouse_button_event (GstEvent * event, gint * button,
/** /**
* gst_navigation_event_parse_mouse_move_event: * gst_navigation_event_parse_mouse_move_event:
* @event: A #GstEvent to inspect. * @event: A #GstEvent to inspect.
* @x: Pointer to a gdouble to receive the x coordinate of the mouse movement. * @x: (out) (optional): Pointer to a gdouble to receive the x coordinate of the
* @y: Pointer to a gdouble to receive the y coordinate of the mouse movement. * mouse movement.
* @y: (out) (optional): Pointer to a gdouble to receive the y coordinate of the
* mouse movement.
* *
* Inspect a #GstNavigation mouse movement event and extract the coordinates * Inspect a #GstNavigation mouse movement event and extract the coordinates
* of the event. * of the event.
@ -835,8 +839,8 @@ gst_navigation_event_parse_mouse_move_event (GstEvent * event, gdouble * x,
/** /**
* gst_navigation_event_parse_command: * gst_navigation_event_parse_command:
* @event: A #GstEvent to inspect. * @event: A #GstEvent to inspect.
* @command: Pointer to GstNavigationCommand to receive the type of the * @command: (out) (optional): Pointer to GstNavigationCommand to receive the
* navigation event. * type of the navigation event.
* *
* Inspect a #GstNavigation command event and retrieve the enum value of the * Inspect a #GstNavigation command event and retrieve the enum value of the
* associated command. * associated command.