navigation: add more constructors for navigation events

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1610>
This commit is contained in:
Vivienne Watermeier 2022-01-31 13:01:10 +01:00 committed by GStreamer Marge Bot
parent 248baef400
commit c38afa2070
3 changed files with 166 additions and 1 deletions

View file

@ -745,6 +745,146 @@ gst_navigation_event_get_type (GstEvent * event)
return GST_NAVIGATION_EVENT_INVALID;
}
/**
* gst_navigation_event_new_key_press:
* @key: A string identifying the key press.
*
* Create a new navigation event for the given key press.
*
* Returns: (transfer full): a new #GstEvent
*
* Since: 1.22
*/
GstEvent *
gst_navigation_event_new_key_press (const gchar * key)
{
return gst_event_new_navigation (gst_structure_new (GST_NAVIGATION_EVENT_NAME,
"event", G_TYPE_STRING, "key-press", "key", G_TYPE_STRING, key,
NULL));
}
/**
* gst_navigation_event_new_key_release:
* @key: A string identifying the released key.
*
* Create a new navigation event for the given key release.
*
* Returns: (transfer full): a new #GstEvent
*
* Since: 1.22
*/
GstEvent *
gst_navigation_event_new_key_release (const gchar * key)
{
return gst_event_new_navigation (gst_structure_new (GST_NAVIGATION_EVENT_NAME,
"event", G_TYPE_STRING, "key-release", "key", G_TYPE_STRING, key,
NULL));
}
/**
* gst_navigation_event_new_mouse_button_press:
* @button: The number of the pressed mouse button.
* @x: The x coordinate of the mouse cursor.
* @y: The y coordinate of the mouse cursor.
*
* Create a new navigation event for the given key mouse button press.
*
* Returns: (transfer full): a new #GstEvent
*
* Since: 1.22
*/
GstEvent *
gst_navigation_event_new_mouse_button_press (gint button, gdouble x, gdouble y)
{
return gst_event_new_navigation (gst_structure_new (GST_NAVIGATION_EVENT_NAME,
"event", G_TYPE_STRING, "mouse-button-press",
"button", G_TYPE_INT, button, "pointer_x", G_TYPE_DOUBLE, x,
"pointer_y", G_TYPE_DOUBLE, y, NULL));
}
/**
* gst_navigation_event_new_mouse_button_release:
* @button: The number of the released mouse button.
* @x: The x coordinate of the mouse cursor.
* @y: The y coordinate of the mouse cursor.
*
* Create a new navigation event for the given key mouse button release.
*
* Returns: (transfer full): a new #GstEvent
*
* Since: 1.22
*/
GstEvent *
gst_navigation_event_new_mouse_button_release (gint button, gdouble x,
gdouble y)
{
return gst_event_new_navigation (gst_structure_new (GST_NAVIGATION_EVENT_NAME,
"event", G_TYPE_STRING, "mouse-button-release",
"button", G_TYPE_INT, button, "pointer_x", G_TYPE_DOUBLE, x,
"pointer_y", G_TYPE_DOUBLE, y, NULL));
}
/**
* gst_navigation_event_new_mouse_move:
* @x: The x coordinate of the mouse cursor.
* @y: The y coordinate of the mouse cursor.
*
* Create a new navigation event for the new mouse location.
*
* Returns: (transfer full): a new #GstEvent
*
* Since: 1.22
*/
GstEvent *
gst_navigation_event_new_mouse_move (gdouble x, gdouble y)
{
return gst_event_new_navigation (gst_structure_new (GST_NAVIGATION_EVENT_NAME,
"event", G_TYPE_STRING, "mouse-move",
"pointer_x", G_TYPE_DOUBLE, x, "pointer_y", G_TYPE_DOUBLE, y, NULL));
}
/**
* gst_navigation_event_new_mouse_scroll:
* @x: The x coordinate of the mouse cursor.
* @y: The y coordinate of the mouse cursor.
* @delta_x: The x component of the scroll movement.
* @delta_y: The y component of the scroll movement.
*
* Create a new navigation event for the mouse scroll.
*
* Returns: (transfer full): a new #GstEvent
*
* Since: 1.22
*/
GstEvent *
gst_navigation_event_new_mouse_scroll (gdouble x, gdouble y, gdouble delta_x,
gdouble delta_y)
{
return gst_event_new_navigation (gst_structure_new (GST_NAVIGATION_EVENT_NAME,
"event", G_TYPE_STRING, "mouse-scroll",
"pointer_x", G_TYPE_DOUBLE, x, "pointer_y", G_TYPE_DOUBLE, y,
"delta_pointer_x", G_TYPE_DOUBLE, delta_x,
"delta_pointer_y", G_TYPE_DOUBLE, delta_y, NULL));
}
/**
* gst_navigation_event_new_command:
* @command: The navigation command to use.
*
* Create a new navigation event given navigation command..
*
* Returns: (transfer full): a new #GstEvent
*
* Since: 1.22
*/
GstEvent *
gst_navigation_event_new_command (GstNavigationCommand command)
{
return gst_event_new_navigation (gst_structure_new (GST_NAVIGATION_EVENT_NAME,
"event", G_TYPE_STRING, "command",
"command-code", G_TYPE_UINT, (guint) command, NULL));
}
/**
* gst_navigation_event_parse_key_event:
* @event: A #GstEvent to inspect.

View file

@ -290,6 +290,30 @@ typedef enum {
GST_VIDEO_API
GstNavigationEventType gst_navigation_event_get_type (GstEvent *event);
GST_VIDEO_API
GstEvent* gst_navigation_event_new_key_press (const gchar * key) G_GNUC_MALLOC;
GST_VIDEO_API
GstEvent* gst_navigation_event_new_key_release (const gchar * key) G_GNUC_MALLOC;
GST_VIDEO_API
GstEvent* gst_navigation_event_new_mouse_button_press (gint button, gdouble x,
gdouble y) G_GNUC_MALLOC;
GST_VIDEO_API
GstEvent* gst_navigation_event_new_mouse_button_release (gint button, gdouble x,
gdouble y) G_GNUC_MALLOC;
GST_VIDEO_API
GstEvent* gst_navigation_event_new_mouse_move (gdouble x, gdouble y) G_GNUC_MALLOC;
GST_VIDEO_API
GstEvent* gst_navigation_event_new_mouse_scroll (gdouble x, gdouble y,
gdouble delta_x, gdouble delta_y) G_GNUC_MALLOC;
GST_VIDEO_API
GstEvent* gst_navigation_event_new_command (GstNavigationCommand command) G_GNUC_MALLOC;
GST_VIDEO_API
gboolean gst_navigation_event_parse_key_event (GstEvent *event,
const gchar **key);

View file

@ -1492,7 +1492,8 @@ gst_event_parse_seek_trickmode_interval (GstEvent * event,
/**
* gst_event_new_navigation:
* @structure: (transfer full): description of the event. The event will take
* ownership of the structure.
* ownership of the structure. See #GstNavigation for more specific
* constructors.
*
* Create a new navigation event from the given description.
*