GstNavigation
The Navigation interface is used for creating and injecting navigation related events such as mouse button presses, cursor motion and key presses. The associated library also provides methods for parsing received events, and for sending and receiving navigation related bus events. One main usecase is DVD menu navigation.
The main parts of the API are:
-
The GstNavigation interface, implemented by elements which provide an application with the ability to create and inject navigation events into the pipeline.
-
GstNavigation event handling API. GstNavigation events are created in response to calls on a GstNavigation interface implementation, and sent in the pipeline. Upstream elements can use the navigation event API functions to parse the contents of received messages.
-
GstNavigation message handling API. GstNavigation messages may be sent on the message bus to inform applications of navigation related changes in the pipeline, such as the mouse moving over a clickable region, or the set of available angles changing.
The GstNavigation message functions provide functions for creating and parsing custom bus messages for signaling GstNavigation changes.
GstNavigation
GstVideo.Navigation
GstVideo.Navigation
Methods
gst_navigation_send_command
gst_navigation_send_command (GstNavigation * navigation, GstNavigationCommand command)
Sends the indicated command to the navigation interface.
Parameters:
navigation
–
The navigation interface instance
command
–
The command to issue
GstVideo.Navigation.prototype.send_command
function GstVideo.Navigation.prototype.send_command(command: GstVideo.NavigationCommand): {
// javascript wrapper for 'gst_navigation_send_command'
}
Sends the indicated command to the navigation interface.
Parameters:
The navigation interface instance
The command to issue
GstVideo.Navigation.send_command
def GstVideo.Navigation.send_command (self, command):
#python wrapper for 'gst_navigation_send_command'
Sends the indicated command to the navigation interface.
Parameters:
The navigation interface instance
The command to issue
gst_navigation_send_event
gst_navigation_send_event (GstNavigation * navigation, GstStructure * structure)
Parameters:
navigation
–
structure
–
GstVideo.Navigation.prototype.send_event
function GstVideo.Navigation.prototype.send_event(structure: Gst.Structure): {
// javascript wrapper for 'gst_navigation_send_event'
}
Parameters:
GstVideo.Navigation.send_event
def GstVideo.Navigation.send_event (self, structure):
#python wrapper for 'gst_navigation_send_event'
Parameters:
gst_navigation_send_key_event
gst_navigation_send_key_event (GstNavigation * navigation, const char* event, const char* key)
Parameters:
navigation
–
The navigation interface instance
event
–
The type of the key event. Recognised values are "key-press" and "key-release"
key
–
Character representation of the key. This is typically as produced by XKeysymToString.
GstVideo.Navigation.prototype.send_key_event
function GstVideo.Navigation.prototype.send_key_event(event: String, key: String): {
// javascript wrapper for 'gst_navigation_send_key_event'
}
Parameters:
The navigation interface instance
The type of the key event. Recognised values are "key-press" and "key-release"
Character representation of the key. This is typically as produced by XKeysymToString.
GstVideo.Navigation.send_key_event
def GstVideo.Navigation.send_key_event (self, event, key):
#python wrapper for 'gst_navigation_send_key_event'
Parameters:
The navigation interface instance
The type of the key event. Recognised values are "key-press" and "key-release"
Character representation of the key. This is typically as produced by XKeysymToString.
gst_navigation_send_mouse_event
gst_navigation_send_mouse_event (GstNavigation * navigation, const char* event, int button, double x, double y)
Sends a mouse event to the navigation interface. Mouse event coordinates are sent relative to the display space of the related output area. This is usually the size in pixels of the window associated with the element implementing the GstNavigation interface.
Parameters:
navigation
–
The navigation interface instance
event
–
The type of mouse event, as a text string. Recognised values are "mouse-button-press", "mouse-button-release" and "mouse-move".
button
–
The button number of the button being pressed or released. Pass 0 for mouse-move events.
x
–
The x coordinate of the mouse event.
y
–
The y coordinate of the mouse event.
GstVideo.Navigation.prototype.send_mouse_event
function GstVideo.Navigation.prototype.send_mouse_event(event: String, button: Number, x: Number, y: Number): {
// javascript wrapper for 'gst_navigation_send_mouse_event'
}
Sends a mouse event to the navigation interface. Mouse event coordinates are sent relative to the display space of the related output area. This is usually the size in pixels of the window associated with the element implementing the GstVideo.Navigation interface.
Parameters:
The navigation interface instance
The type of mouse event, as a text string. Recognised values are "mouse-button-press", "mouse-button-release" and "mouse-move".
The button number of the button being pressed or released. Pass 0 for mouse-move events.
The x coordinate of the mouse event.
The y coordinate of the mouse event.
GstVideo.Navigation.send_mouse_event
def GstVideo.Navigation.send_mouse_event (self, event, button, x, y):
#python wrapper for 'gst_navigation_send_mouse_event'
Sends a mouse event to the navigation interface. Mouse event coordinates are sent relative to the display space of the related output area. This is usually the size in pixels of the window associated with the element implementing the GstVideo.Navigation interface.
Parameters:
The navigation interface instance
The type of mouse event, as a text string. Recognised values are "mouse-button-press", "mouse-button-release" and "mouse-move".
The button number of the button being pressed or released. Pass 0 for mouse-move events.
The x coordinate of the mouse event.
The y coordinate of the mouse event.
gst_navigation_send_mouse_scroll_event
gst_navigation_send_mouse_scroll_event (GstNavigation * navigation, double x, double y, double delta_x, double delta_y)
Sends a mouse scroll event to the navigation interface. Mouse event coordinates are sent relative to the display space of the related output area. This is usually the size in pixels of the window associated with the element implementing the GstNavigation interface.
Parameters:
navigation
–
The navigation interface instance
x
–
The x coordinate of the mouse event.
y
–
The y coordinate of the mouse event.
delta_x
–
The delta_x coordinate of the mouse event.
delta_y
–
The delta_y coordinate of the mouse event.
Since : 1.18
GstVideo.Navigation.prototype.send_mouse_scroll_event
function GstVideo.Navigation.prototype.send_mouse_scroll_event(x: Number, y: Number, delta_x: Number, delta_y: Number): {
// javascript wrapper for 'gst_navigation_send_mouse_scroll_event'
}
Sends a mouse scroll event to the navigation interface. Mouse event coordinates are sent relative to the display space of the related output area. This is usually the size in pixels of the window associated with the element implementing the GstVideo.Navigation interface.
Parameters:
The navigation interface instance
The x coordinate of the mouse event.
The y coordinate of the mouse event.
The delta_x coordinate of the mouse event.
The delta_y coordinate of the mouse event.
Since : 1.18
GstVideo.Navigation.send_mouse_scroll_event
def GstVideo.Navigation.send_mouse_scroll_event (self, x, y, delta_x, delta_y):
#python wrapper for 'gst_navigation_send_mouse_scroll_event'
Sends a mouse scroll event to the navigation interface. Mouse event coordinates are sent relative to the display space of the related output area. This is usually the size in pixels of the window associated with the element implementing the GstVideo.Navigation interface.
Parameters:
The navigation interface instance
The x coordinate of the mouse event.
The y coordinate of the mouse event.
The delta_x coordinate of the mouse event.
The delta_y coordinate of the mouse event.
Since : 1.18
Functions
gst_navigation_event_get_type
GstNavigationEventType gst_navigation_event_get_type (GstEvent * event)
Inspect a GstEvent and return the GstNavigationEventType of the event, or GST_NAVIGATION_EVENT_INVALID if the event is not a GstNavigation event.
Parameters:
event
–
A GstEvent to inspect.
GstVideo.prototype.navigation_event_get_type
function GstVideo.prototype.navigation_event_get_type(event: Gst.Event): {
// javascript wrapper for 'gst_navigation_event_get_type'
}
Inspect a Gst.Event and return the GstVideo.NavigationEventType of the event, or GstVideo.NavigationEventType.INVALID if the event is not a GstVideo.Navigation event.
GstVideo.navigation_event_get_type
def GstVideo.navigation_event_get_type (event):
#python wrapper for 'gst_navigation_event_get_type'
Inspect a Gst.Event and return the GstVideo.NavigationEventType of the event, or GstVideo.NavigationEventType.INVALID if the event is not a GstVideo.Navigation event.
gst_navigation_event_parse_command
gboolean gst_navigation_event_parse_command (GstEvent * event, GstNavigationCommand * command)
Inspect a GstNavigation command event and retrieve the enum value of the associated command.
Parameters:
event
–
A GstEvent to inspect.
command
(
[out][optional])
–
Pointer to GstNavigationCommand to receive the type of the navigation event.
TRUE if the navigation command could be extracted, otherwise FALSE.
GstVideo.prototype.navigation_event_parse_command
function GstVideo.prototype.navigation_event_parse_command(event: Gst.Event): {
// javascript wrapper for 'gst_navigation_event_parse_command'
}
Inspect a GstVideo.Navigation command event and retrieve the enum value of the associated command.
Returns a tuple made of:
TRUE if the navigation command could be extracted, otherwise FALSE.
TRUE if the navigation command could be extracted, otherwise FALSE.
GstVideo.navigation_event_parse_command
def GstVideo.navigation_event_parse_command (event):
#python wrapper for 'gst_navigation_event_parse_command'
Inspect a GstVideo.Navigation command event and retrieve the enum value of the associated command.
Returns a tuple made of:
TRUE if the navigation command could be extracted, otherwise FALSE.
TRUE if the navigation command could be extracted, otherwise FALSE.
gst_navigation_event_parse_key_event
gboolean gst_navigation_event_parse_key_event (GstEvent * event, const gchar ** key)
Parameters:
event
–
A GstEvent to inspect.
key
(
[out][optional][transfer: none])
–
A pointer to a location to receive the string identifying the key press. The returned string is owned by the event, and valid only until the event is unreffed.
GstVideo.prototype.navigation_event_parse_key_event
function GstVideo.prototype.navigation_event_parse_key_event(event: Gst.Event): {
// javascript wrapper for 'gst_navigation_event_parse_key_event'
}
Returns a tuple made of:
GstVideo.navigation_event_parse_key_event
def GstVideo.navigation_event_parse_key_event (event):
#python wrapper for 'gst_navigation_event_parse_key_event'
gst_navigation_event_parse_mouse_button_event
gboolean gst_navigation_event_parse_mouse_button_event (GstEvent * event, gint * button, gdouble * x, gdouble * y)
Retrieve the details of either a GstNavigation mouse button press event or a mouse button release event. Determine which type the event is using gst_navigation_event_get_type to retrieve the GstNavigationEventType.
Parameters:
event
–
A GstEvent to inspect.
button
(
[out][optional])
–
Pointer to a gint that will receive the button number associated with the event.
x
(
[out][optional])
–
Pointer to a gdouble to receive the x coordinate of the mouse button event.
y
(
[out][optional])
–
Pointer to a gdouble to receive the y coordinate of the mouse button event.
TRUE if the button number and both coordinates could be extracted, otherwise FALSE.
GstVideo.prototype.navigation_event_parse_mouse_button_event
function GstVideo.prototype.navigation_event_parse_mouse_button_event(event: Gst.Event): {
// javascript wrapper for 'gst_navigation_event_parse_mouse_button_event'
}
Retrieve the details of either a GstVideo.Navigation mouse button press event or a mouse button release event. Determine which type the event is using GstVideo.prototype.navigation_event_get_type to retrieve the GstVideo.NavigationEventType.
Returns a tuple made of:
TRUE if the button number and both coordinates could be extracted, otherwise FALSE.
TRUE if the button number and both coordinates could be extracted, otherwise FALSE.
TRUE if the button number and both coordinates could be extracted, otherwise FALSE.
TRUE if the button number and both coordinates could be extracted, otherwise FALSE.
GstVideo.navigation_event_parse_mouse_button_event
def GstVideo.navigation_event_parse_mouse_button_event (event):
#python wrapper for 'gst_navigation_event_parse_mouse_button_event'
Retrieve the details of either a GstVideo.Navigation mouse button press event or a mouse button release event. Determine which type the event is using GstVideo.navigation_event_get_type to retrieve the GstVideo.NavigationEventType.
Returns a tuple made of:
TRUE if the button number and both coordinates could be extracted, otherwise FALSE.
TRUE if the button number and both coordinates could be extracted, otherwise FALSE.
TRUE if the button number and both coordinates could be extracted, otherwise FALSE.
TRUE if the button number and both coordinates could be extracted, otherwise FALSE.
gst_navigation_event_parse_mouse_move_event
gboolean gst_navigation_event_parse_mouse_move_event (GstEvent * event, gdouble * x, gdouble * y)
Inspect a GstNavigation mouse movement event and extract the coordinates of the event.
Parameters:
event
–
A GstEvent to inspect.
x
(
[out][optional])
–
Pointer to a gdouble to receive the x coordinate of the mouse movement.
y
(
[out][optional])
–
Pointer to a gdouble to receive the y coordinate of the mouse movement.
TRUE if both coordinates could be extracted, otherwise FALSE.
GstVideo.prototype.navigation_event_parse_mouse_move_event
function GstVideo.prototype.navigation_event_parse_mouse_move_event(event: Gst.Event): {
// javascript wrapper for 'gst_navigation_event_parse_mouse_move_event'
}
Inspect a GstVideo.Navigation mouse movement event and extract the coordinates of the event.
Returns a tuple made of:
TRUE if both coordinates could be extracted, otherwise FALSE.
TRUE if both coordinates could be extracted, otherwise FALSE.
TRUE if both coordinates could be extracted, otherwise FALSE.
GstVideo.navigation_event_parse_mouse_move_event
def GstVideo.navigation_event_parse_mouse_move_event (event):
#python wrapper for 'gst_navigation_event_parse_mouse_move_event'
Inspect a GstVideo.Navigation mouse movement event and extract the coordinates of the event.
Returns a tuple made of:
TRUE if both coordinates could be extracted, otherwise FALSE.
TRUE if both coordinates could be extracted, otherwise FALSE.
TRUE if both coordinates could be extracted, otherwise FALSE.
gst_navigation_event_parse_mouse_scroll_event
gboolean gst_navigation_event_parse_mouse_scroll_event (GstEvent * event, gdouble * x, gdouble * y, gdouble * delta_x, gdouble * delta_y)
Inspect a GstNavigation mouse scroll event and extract the coordinates of the event.
Parameters:
event
–
A GstEvent to inspect.
x
(
[out][optional])
–
Pointer to a gdouble to receive the x coordinate of the mouse movement.
y
(
[out][optional])
–
Pointer to a gdouble to receive the y coordinate of the mouse movement.
delta_x
(
[out][optional])
–
Pointer to a gdouble to receive the delta_x coordinate of the mouse movement.
delta_y
(
[out][optional])
–
Pointer to a gdouble to receive the delta_y coordinate of the mouse movement.
TRUE if all coordinates could be extracted, otherwise FALSE.
Since : 1.18
GstVideo.prototype.navigation_event_parse_mouse_scroll_event
function GstVideo.prototype.navigation_event_parse_mouse_scroll_event(event: Gst.Event): {
// javascript wrapper for 'gst_navigation_event_parse_mouse_scroll_event'
}
Inspect a GstVideo.Navigation mouse scroll event and extract the coordinates of the event.
Returns a tuple made of:
TRUE if all coordinates could be extracted, otherwise FALSE.
TRUE if all coordinates could be extracted, otherwise FALSE.
TRUE if all coordinates could be extracted, otherwise FALSE.
TRUE if all coordinates could be extracted, otherwise FALSE.
TRUE if all coordinates could be extracted, otherwise FALSE.
Since : 1.18
GstVideo.navigation_event_parse_mouse_scroll_event
def GstVideo.navigation_event_parse_mouse_scroll_event (event):
#python wrapper for 'gst_navigation_event_parse_mouse_scroll_event'
Inspect a GstVideo.Navigation mouse scroll event and extract the coordinates of the event.
Returns a tuple made of:
TRUE if all coordinates could be extracted, otherwise FALSE.
TRUE if all coordinates could be extracted, otherwise FALSE.
TRUE if all coordinates could be extracted, otherwise FALSE.
TRUE if all coordinates could be extracted, otherwise FALSE.
TRUE if all coordinates could be extracted, otherwise FALSE.
Since : 1.18
gst_navigation_message_get_type
GstNavigationMessageType gst_navigation_message_get_type (GstMessage * message)
Check a bus message to see if it is a GstNavigation event, and return the GstNavigationMessageType identifying the type of the message if so.
Parameters:
message
–
A GstMessage to inspect.
The type of the GstMessage, or GST_NAVIGATION_MESSAGE_INVALID if the message is not a GstNavigation notification.
GstVideo.prototype.navigation_message_get_type
function GstVideo.prototype.navigation_message_get_type(message: Gst.Message): {
// javascript wrapper for 'gst_navigation_message_get_type'
}
Check a bus message to see if it is a GstVideo.Navigation event, and return the GstVideo.NavigationMessageType identifying the type of the message if so.
Parameters:
A Gst.Message to inspect.
The type of the Gst.Message, or GstVideo.NavigationMessageType.INVALID if the message is not a GstVideo.Navigation notification.
GstVideo.navigation_message_get_type
def GstVideo.navigation_message_get_type (message):
#python wrapper for 'gst_navigation_message_get_type'
Check a bus message to see if it is a GstVideo.Navigation event, and return the GstVideo.NavigationMessageType identifying the type of the message if so.
Parameters:
A Gst.Message to inspect.
The type of the Gst.Message, or GstVideo.NavigationMessageType.INVALID if the message is not a GstVideo.Navigation notification.
gst_navigation_message_new_angles_changed
GstMessage * gst_navigation_message_new_angles_changed (GstObject * src, guint cur_angle, guint n_angles)
Creates a new GstNavigation message with type GST_NAVIGATION_MESSAGE_ANGLES_CHANGED for notifying an application that the current angle, or current number of angles available in a multiangle video has changed.
Parameters:
src
–
A GstObject to set as source of the new message.
cur_angle
–
The currently selected angle.
n_angles
–
The number of viewing angles now available.
The new GstMessage.
GstVideo.prototype.navigation_message_new_angles_changed
function GstVideo.prototype.navigation_message_new_angles_changed(src: Gst.Object, cur_angle: Number, n_angles: Number): {
// javascript wrapper for 'gst_navigation_message_new_angles_changed'
}
Creates a new GstVideo.Navigation message with type GstVideo.NavigationMessageType.ANGLES_CHANGED for notifying an application that the current angle, or current number of angles available in a multiangle video has changed.
Parameters:
A Gst.Object to set as source of the new message.
The currently selected angle.
The number of viewing angles now available.
The new Gst.Message.
GstVideo.navigation_message_new_angles_changed
def GstVideo.navigation_message_new_angles_changed (src, cur_angle, n_angles):
#python wrapper for 'gst_navigation_message_new_angles_changed'
Creates a new GstVideo.Navigation message with type GstVideo.NavigationMessageType.ANGLES_CHANGED for notifying an application that the current angle, or current number of angles available in a multiangle video has changed.
Parameters:
A Gst.Object to set as source of the new message.
The currently selected angle.
The number of viewing angles now available.
The new Gst.Message.
gst_navigation_message_new_commands_changed
GstMessage * gst_navigation_message_new_commands_changed (GstObject * src)
Creates a new GstNavigation message with type GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED
Parameters:
src
–
A GstObject to set as source of the new message.
The new GstMessage.
GstVideo.prototype.navigation_message_new_commands_changed
function GstVideo.prototype.navigation_message_new_commands_changed(src: Gst.Object): {
// javascript wrapper for 'gst_navigation_message_new_commands_changed'
}
Creates a new GstVideo.Navigation message with type GstVideo.NavigationMessageType.COMMANDS_CHANGED
Parameters:
A Gst.Object to set as source of the new message.
The new Gst.Message.
GstVideo.navigation_message_new_commands_changed
def GstVideo.navigation_message_new_commands_changed (src):
#python wrapper for 'gst_navigation_message_new_commands_changed'
Creates a new GstVideo.Navigation message with type GstVideo.NavigationMessageType.COMMANDS_CHANGED
Parameters:
A Gst.Object to set as source of the new message.
The new Gst.Message.
gst_navigation_message_new_event
GstMessage * gst_navigation_message_new_event (GstObject * src, GstEvent * event)
Creates a new GstNavigation message with type GST_NAVIGATION_MESSAGE_EVENT.
Parameters:
src
–
A GstObject to set as source of the new message.
event
(
[transfer: none])
–
A navigation GstEvent
The new GstMessage.
Since : 1.6
GstVideo.prototype.navigation_message_new_event
function GstVideo.prototype.navigation_message_new_event(src: Gst.Object, event: Gst.Event): {
// javascript wrapper for 'gst_navigation_message_new_event'
}
Creates a new GstVideo.Navigation message with type GstVideo.NavigationMessageType.EVENT.
Parameters:
A Gst.Object to set as source of the new message.
The new Gst.Message.
Since : 1.6
GstVideo.navigation_message_new_event
def GstVideo.navigation_message_new_event (src, event):
#python wrapper for 'gst_navigation_message_new_event'
Creates a new GstVideo.Navigation message with type GstVideo.NavigationMessageType.EVENT.
Parameters:
A Gst.Object to set as source of the new message.
The new Gst.Message.
Since : 1.6
gst_navigation_message_new_mouse_over
GstMessage * gst_navigation_message_new_mouse_over (GstObject * src, gboolean active)
Creates a new GstNavigation message with type GST_NAVIGATION_MESSAGE_MOUSE_OVER.
Parameters:
src
–
A GstObject to set as source of the new message.
The new GstMessage.
GstVideo.prototype.navigation_message_new_mouse_over
function GstVideo.prototype.navigation_message_new_mouse_over(src: Gst.Object, active: Number): {
// javascript wrapper for 'gst_navigation_message_new_mouse_over'
}
Creates a new GstVideo.Navigation message with type GstVideo.NavigationMessageType.MOUSE_OVER.
Parameters:
A Gst.Object to set as source of the new message.
The new Gst.Message.
GstVideo.navigation_message_new_mouse_over
def GstVideo.navigation_message_new_mouse_over (src, active):
#python wrapper for 'gst_navigation_message_new_mouse_over'
Creates a new GstVideo.Navigation message with type GstVideo.NavigationMessageType.MOUSE_OVER.
Parameters:
A Gst.Object to set as source of the new message.
The new Gst.Message.
gst_navigation_message_parse_angles_changed
gboolean gst_navigation_message_parse_angles_changed (GstMessage * message, guint * cur_angle, guint * n_angles)
Parse a GstNavigation message of type GST_NAVIGATION_MESSAGE_ANGLES_CHANGED and extract the cur_angle and n_angles parameters.
Parameters:
message
–
A GstMessage to inspect.
cur_angle
(
[out][optional])
–
A pointer to a guint to receive the new current angle number, or NULL
n_angles
(
[out][optional])
–
A pointer to a guint to receive the new angle count, or NULL.
GstVideo.prototype.navigation_message_parse_angles_changed
function GstVideo.prototype.navigation_message_parse_angles_changed(message: Gst.Message): {
// javascript wrapper for 'gst_navigation_message_parse_angles_changed'
}
Parse a GstVideo.Navigation message of type GST_NAVIGATION_MESSAGE_ANGLES_CHANGED and extract the cur_angle and n_angles parameters.
Parameters:
A Gst.Message to inspect.
Returns a tuple made of:
GstVideo.navigation_message_parse_angles_changed
def GstVideo.navigation_message_parse_angles_changed (message):
#python wrapper for 'gst_navigation_message_parse_angles_changed'
Parse a GstVideo.Navigation message of type GST_NAVIGATION_MESSAGE_ANGLES_CHANGED and extract the cur_angle and n_angles parameters.
Parameters:
A Gst.Message to inspect.
Returns a tuple made of:
gst_navigation_message_parse_event
gboolean gst_navigation_message_parse_event (GstMessage * message, GstEvent ** event)
Parse a GstNavigation message of type GST_NAVIGATION_MESSAGE_EVENT and extract contained GstEvent. The caller must unref the event when done with it.
Parameters:
message
–
A GstMessage to inspect.
event
(
[out][optional][transfer: full])
–
a pointer to a GstEvent to receive the contained navigation event.
Since : 1.6
GstVideo.prototype.navigation_message_parse_event
function GstVideo.prototype.navigation_message_parse_event(message: Gst.Message): {
// javascript wrapper for 'gst_navigation_message_parse_event'
}
Parse a GstVideo.Navigation message of type GstVideo.NavigationMessageType.EVENT and extract contained Gst.Event. The caller must unref the event when done with it.
Parameters:
A Gst.Message to inspect.
Returns a tuple made of:
Since : 1.6
GstVideo.navigation_message_parse_event
def GstVideo.navigation_message_parse_event (message):
#python wrapper for 'gst_navigation_message_parse_event'
Parse a GstVideo.Navigation message of type GstVideo.NavigationMessageType.EVENT and extract contained Gst.Event. The caller must unref the event when done with it.
Parameters:
A Gst.Message to inspect.
Returns a tuple made of:
Since : 1.6
gst_navigation_message_parse_mouse_over
gboolean gst_navigation_message_parse_mouse_over (GstMessage * message, gboolean * active)
Parse a GstNavigation message of type GST_NAVIGATION_MESSAGE_MOUSE_OVER and extract the active/inactive flag. If the mouse over event is marked active, it indicates that the mouse is over a clickable area.
Parameters:
message
–
A GstMessage to inspect.
active
(
[out][optional])
–
A pointer to a gboolean to receive the active/inactive state, or NULL.
GstVideo.prototype.navigation_message_parse_mouse_over
function GstVideo.prototype.navigation_message_parse_mouse_over(message: Gst.Message): {
// javascript wrapper for 'gst_navigation_message_parse_mouse_over'
}
Parse a GstVideo.Navigation message of type GstVideo.NavigationMessageType.MOUSE_OVER and extract the active/inactive flag. If the mouse over event is marked active, it indicates that the mouse is over a clickable area.
Parameters:
A Gst.Message to inspect.
Returns a tuple made of:
GstVideo.navigation_message_parse_mouse_over
def GstVideo.navigation_message_parse_mouse_over (message):
#python wrapper for 'gst_navigation_message_parse_mouse_over'
Parse a GstVideo.Navigation message of type GstVideo.NavigationMessageType.MOUSE_OVER and extract the active/inactive flag. If the mouse over event is marked active, it indicates that the mouse is over a clickable area.
Parameters:
A Gst.Message to inspect.
Returns a tuple made of:
gst_navigation_query_get_type
GstNavigationQueryType gst_navigation_query_get_type (GstQuery * query)
Inspect a GstQuery and return the GstNavigationQueryType associated with it if it is a GstNavigation query.
Parameters:
query
–
The query to inspect
The GstNavigationQueryType of the query, or GST_NAVIGATION_QUERY_INVALID
GstVideo.prototype.navigation_query_get_type
function GstVideo.prototype.navigation_query_get_type(query: Gst.Query): {
// javascript wrapper for 'gst_navigation_query_get_type'
}
Inspect a Gst.Query and return the GstVideo.NavigationQueryType associated with it if it is a GstVideo.Navigation query.
Parameters:
The query to inspect
The GstVideo.NavigationQueryType of the query, or GstVideo.NavigationQueryType.INVALID
GstVideo.navigation_query_get_type
def GstVideo.navigation_query_get_type (query):
#python wrapper for 'gst_navigation_query_get_type'
Inspect a Gst.Query and return the GstVideo.NavigationQueryType associated with it if it is a GstVideo.Navigation query.
Parameters:
The query to inspect
The GstVideo.NavigationQueryType of the query, or GstVideo.NavigationQueryType.INVALID
gst_navigation_query_new_angles
GstQuery * gst_navigation_query_new_angles ()
Create a new GstNavigation angles query. When executed, it will query the pipeline for the set of currently available angles, which may be greater than one in a multiangle video.
The new query.
GstVideo.prototype.navigation_query_new_angles
function GstVideo.prototype.navigation_query_new_angles(): {
// javascript wrapper for 'gst_navigation_query_new_angles'
}
Create a new GstVideo.Navigation angles query. When executed, it will query the pipeline for the set of currently available angles, which may be greater than one in a multiangle video.
The new query.
GstVideo.navigation_query_new_angles
def GstVideo.navigation_query_new_angles ():
#python wrapper for 'gst_navigation_query_new_angles'
Create a new GstVideo.Navigation angles query. When executed, it will query the pipeline for the set of currently available angles, which may be greater than one in a multiangle video.
The new query.
gst_navigation_query_new_commands
GstQuery * gst_navigation_query_new_commands ()
Create a new GstNavigation commands query. When executed, it will query the pipeline for the set of currently available commands.
The new query.
GstVideo.prototype.navigation_query_new_commands
function GstVideo.prototype.navigation_query_new_commands(): {
// javascript wrapper for 'gst_navigation_query_new_commands'
}
Create a new GstVideo.Navigation commands query. When executed, it will query the pipeline for the set of currently available commands.
The new query.
GstVideo.navigation_query_new_commands
def GstVideo.navigation_query_new_commands ():
#python wrapper for 'gst_navigation_query_new_commands'
Create a new GstVideo.Navigation commands query. When executed, it will query the pipeline for the set of currently available commands.
The new query.
gst_navigation_query_parse_angles
gboolean gst_navigation_query_parse_angles (GstQuery * query, guint * cur_angle, guint * n_angles)
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 angles into the guint pointed to by the n_angles variable.
Parameters:
query
–
a GstQuery
cur_angle
(
[out][optional])
–
Pointer to a guint into which to store the currently selected angle value from the query, or NULL
n_angles
(
[out][optional])
–
Pointer to a guint into which to store the number of angles value from the query, or NULL
GstVideo.prototype.navigation_query_parse_angles
function GstVideo.prototype.navigation_query_parse_angles(query: Gst.Query): {
// javascript wrapper for 'gst_navigation_query_parse_angles'
}
Parse the current angle number in the GstVideo.Navigation angles query into the Number pointed to by the cur_angle variable, and the number of available angles into the Number pointed to by the n_angles variable.
Returns a tuple made of:
GstVideo.navigation_query_parse_angles
def GstVideo.navigation_query_parse_angles (query):
#python wrapper for 'gst_navigation_query_parse_angles'
Parse the current angle number in the GstVideo.Navigation angles query into the int pointed to by the cur_angle variable, and the number of available angles into the int pointed to by the n_angles variable.
Returns a tuple made of:
gst_navigation_query_parse_commands_length
gboolean gst_navigation_query_parse_commands_length (GstQuery * query, guint * n_cmds)
Parse the number of commands in the GstNavigation commands query.
GstVideo.prototype.navigation_query_parse_commands_length
function GstVideo.prototype.navigation_query_parse_commands_length(query: Gst.Query): {
// javascript wrapper for 'gst_navigation_query_parse_commands_length'
}
Parse the number of commands in the GstVideo.Navigation commands query.
Returns a tuple made of:
GstVideo.navigation_query_parse_commands_length
def GstVideo.navigation_query_parse_commands_length (query):
#python wrapper for 'gst_navigation_query_parse_commands_length'
Parse the number of commands in the GstVideo.Navigation commands query.
Returns a tuple made of:
gst_navigation_query_parse_commands_nth
gboolean gst_navigation_query_parse_commands_nth (GstQuery * query, guint nth, GstNavigationCommand * cmd)
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 set to GST_NAVIGATION_COMMAND_INVALID.
Parameters:
query
–
a GstQuery
nth
–
the nth command to retrieve.
cmd
(
[out][optional])
–
a pointer to store the nth command into.
GstVideo.prototype.navigation_query_parse_commands_nth
function GstVideo.prototype.navigation_query_parse_commands_nth(query: Gst.Query, nth: Number): {
// javascript wrapper for 'gst_navigation_query_parse_commands_nth'
}
Parse the GstVideo.Navigation command query and retrieve the nth command from it into cmd. If the list contains less elements than nth, cmd will be set to GstVideo.NavigationCommand.INVALID.
GstVideo.navigation_query_parse_commands_nth
def GstVideo.navigation_query_parse_commands_nth (query, nth):
#python wrapper for 'gst_navigation_query_parse_commands_nth'
Parse the GstVideo.Navigation command query and retrieve the nth command from it into cmd. If the list contains less elements than nth, cmd will be set to GstVideo.NavigationCommand.INVALID.
gst_navigation_query_set_angles
gst_navigation_query_set_angles (GstQuery * query, guint cur_angle, guint n_angles)
Set the GstNavigation angles query result field in query.
Parameters:
query
–
a GstQuery
cur_angle
–
the current viewing angle to set.
n_angles
–
the number of viewing angles to set.
GstVideo.prototype.navigation_query_set_angles
function GstVideo.prototype.navigation_query_set_angles(query: Gst.Query, cur_angle: Number, n_angles: Number): {
// javascript wrapper for 'gst_navigation_query_set_angles'
}
Set the GstVideo.Navigation angles query result field in query.
Parameters:
the current viewing angle to set.
the number of viewing angles to set.
GstVideo.navigation_query_set_angles
def GstVideo.navigation_query_set_angles (query, cur_angle, n_angles):
#python wrapper for 'gst_navigation_query_set_angles'
Set the GstVideo.Navigation angles query result field in query.
Parameters:
the current viewing angle to set.
the number of viewing angles to set.
gst_navigation_query_set_commands
gst_navigation_query_set_commands (GstQuery * query, gint n_cmds, ... ...)
Set the GstNavigation command query result fields in query. The number of commands passed must be equal to n_commands.
Parameters:
query
–
a GstQuery
n_cmds
–
the number of commands to set.
...
–
A list of GstNavigationCommand values, n_cmds entries long.
gst_navigation_query_set_commandsv
gst_navigation_query_set_commandsv (GstQuery * query, gint n_cmds, GstNavigationCommand * cmds)
Set the GstNavigation command query result fields in query. The number of commands passed must be equal to n_commands.
Parameters:
query
–
a GstQuery
n_cmds
–
the number of commands to set.
cmds
(
[arraylength=n_cmds])
–
An array containing n_cmds GstNavigationCommand values.
GstVideo.prototype.navigation_query_set_commandsv
function GstVideo.prototype.navigation_query_set_commandsv(query: Gst.Query, n_cmds: Number, cmds: [ GstVideo.NavigationCommand ]): {
// javascript wrapper for 'gst_navigation_query_set_commandsv'
}
Set the GstVideo.Navigation command query result fields in query. The number of commands passed must be equal to n_commands.
Parameters:
the number of commands to set.
An array containing n_cmds GstNavigationCommand values.
GstVideo.navigation_query_set_commandsv
def GstVideo.navigation_query_set_commandsv (query, n_cmds, cmds):
#python wrapper for 'gst_navigation_query_set_commandsv'
Set the GstVideo.Navigation command query result fields in query. The number of commands passed must be equal to n_commands.
Parameters:
the number of commands to set.
An array containing n_cmds GstNavigationCommand values.
Virtual Methods
send_event
send_event (GstNavigation * navigation, GstStructure * structure)
sending a navigation event
Parameters:
navigation
–
structure
–
vfunc_send_event
function vfunc_send_event(navigation: GstVideo.Navigation, structure: Gst.Structure): {
// javascript implementation of the 'send_event' virtual method
}
sending a navigation event
Parameters:
do_send_event
def do_send_event (navigation, structure):
#python implementation of the 'send_event' virtual method
sending a navigation event
Parameters:
Function Macros
GST_NAVIGATION_GET_INTERFACE
#define GST_NAVIGATION_GET_INTERFACE(obj) \ (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GST_TYPE_NAVIGATION, GstNavigationInterface))
Enumerations
GstNavigationCommand
A set of commands that may be issued to an element providing the GstNavigation interface. The available commands can be queried via the gst_navigation_query_new_commands query.
For convenience in handling DVD navigation, the MENU commands are aliased as: GST_NAVIGATION_COMMAND_DVD_MENU = GST_NAVIGATION_COMMAND_MENU1 GST_NAVIGATION_COMMAND_DVD_TITLE_MENU = GST_NAVIGATION_COMMAND_MENU2 GST_NAVIGATION_COMMAND_DVD_ROOT_MENU = GST_NAVIGATION_COMMAND_MENU3 GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU = GST_NAVIGATION_COMMAND_MENU4 GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU = GST_NAVIGATION_COMMAND_MENU5 GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU = GST_NAVIGATION_COMMAND_MENU6 GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU = GST_NAVIGATION_COMMAND_MENU7
Members
GST_NAVIGATION_COMMAND_INVALID
(0)
–
An invalid command entry
GST_NAVIGATION_COMMAND_MENU1
(1)
–
Execute navigation menu command 1. For DVD, this enters the DVD root menu, or exits back to the title from the menu.
GST_NAVIGATION_COMMAND_MENU2
(2)
–
Execute navigation menu command 2. For DVD, this jumps to the DVD title menu.
GST_NAVIGATION_COMMAND_MENU3
(3)
–
Execute navigation menu command 3. For DVD, this jumps into the DVD root menu.
GST_NAVIGATION_COMMAND_MENU4
(4)
–
Execute navigation menu command 4. For DVD, this jumps to the Subpicture menu.
GST_NAVIGATION_COMMAND_MENU5
(5)
–
Execute navigation menu command 5. For DVD, the jumps to the audio menu.
GST_NAVIGATION_COMMAND_MENU6
(6)
–
Execute navigation menu command 6. For DVD, this jumps to the angles menu.
GST_NAVIGATION_COMMAND_MENU7
(7)
–
Execute navigation menu command 7. For DVD, this jumps to the chapter menu.
GST_NAVIGATION_COMMAND_LEFT
(20)
–
Select the next button to the left in a menu, if such a button exists.
GST_NAVIGATION_COMMAND_RIGHT
(21)
–
Select the next button to the right in a menu, if such a button exists.
GST_NAVIGATION_COMMAND_UP
(22)
–
Select the button above the current one in a menu, if such a button exists.
GST_NAVIGATION_COMMAND_DOWN
(23)
–
Select the button below the current one in a menu, if such a button exists.
GST_NAVIGATION_COMMAND_ACTIVATE
(24)
–
Activate (click) the currently selected button in a menu, if such a button exists.
GST_NAVIGATION_COMMAND_PREV_ANGLE
(30)
–
Switch to the previous angle in a multiangle feature.
GST_NAVIGATION_COMMAND_NEXT_ANGLE
(31)
–
Switch to the next angle in a multiangle feature.
GstVideo.NavigationCommand
A set of commands that may be issued to an element providing the GstVideo.Navigation interface. The available commands can be queried via the GstVideo.prototype.navigation_query_new_commands query.
For convenience in handling DVD navigation, the MENU commands are aliased as: GST_NAVIGATION_COMMAND_DVD_MENU = GST_NAVIGATION_COMMAND_MENU1 GST_NAVIGATION_COMMAND_DVD_TITLE_MENU = GST_NAVIGATION_COMMAND_MENU2 GST_NAVIGATION_COMMAND_DVD_ROOT_MENU = GST_NAVIGATION_COMMAND_MENU3 GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU = GST_NAVIGATION_COMMAND_MENU4 GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU = GST_NAVIGATION_COMMAND_MENU5 GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU = GST_NAVIGATION_COMMAND_MENU6 GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU = GST_NAVIGATION_COMMAND_MENU7
Members
GstVideo.NavigationCommand.INVALID
(0)
–
An invalid command entry
GstVideo.NavigationCommand.MENU1
(1)
–
Execute navigation menu command 1. For DVD, this enters the DVD root menu, or exits back to the title from the menu.
GstVideo.NavigationCommand.MENU2
(2)
–
Execute navigation menu command 2. For DVD, this jumps to the DVD title menu.
GstVideo.NavigationCommand.MENU3
(3)
–
Execute navigation menu command 3. For DVD, this jumps into the DVD root menu.
GstVideo.NavigationCommand.MENU4
(4)
–
Execute navigation menu command 4. For DVD, this jumps to the Subpicture menu.
GstVideo.NavigationCommand.MENU5
(5)
–
Execute navigation menu command 5. For DVD, the jumps to the audio menu.
GstVideo.NavigationCommand.MENU6
(6)
–
Execute navigation menu command 6. For DVD, this jumps to the angles menu.
GstVideo.NavigationCommand.MENU7
(7)
–
Execute navigation menu command 7. For DVD, this jumps to the chapter menu.
GstVideo.NavigationCommand.LEFT
(20)
–
Select the next button to the left in a menu, if such a button exists.
GstVideo.NavigationCommand.RIGHT
(21)
–
Select the next button to the right in a menu, if such a button exists.
GstVideo.NavigationCommand.UP
(22)
–
Select the button above the current one in a menu, if such a button exists.
GstVideo.NavigationCommand.DOWN
(23)
–
Select the button below the current one in a menu, if such a button exists.
GstVideo.NavigationCommand.ACTIVATE
(24)
–
Activate (click) the currently selected button in a menu, if such a button exists.
GstVideo.NavigationCommand.PREV_ANGLE
(30)
–
Switch to the previous angle in a multiangle feature.
GstVideo.NavigationCommand.NEXT_ANGLE
(31)
–
Switch to the next angle in a multiangle feature.
GstVideo.NavigationCommand
A set of commands that may be issued to an element providing the GstVideo.Navigation interface. The available commands can be queried via the GstVideo.navigation_query_new_commands query.
For convenience in handling DVD navigation, the MENU commands are aliased as: GST_NAVIGATION_COMMAND_DVD_MENU = GST_NAVIGATION_COMMAND_MENU1 GST_NAVIGATION_COMMAND_DVD_TITLE_MENU = GST_NAVIGATION_COMMAND_MENU2 GST_NAVIGATION_COMMAND_DVD_ROOT_MENU = GST_NAVIGATION_COMMAND_MENU3 GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU = GST_NAVIGATION_COMMAND_MENU4 GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU = GST_NAVIGATION_COMMAND_MENU5 GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU = GST_NAVIGATION_COMMAND_MENU6 GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU = GST_NAVIGATION_COMMAND_MENU7
Members
GstVideo.NavigationCommand.INVALID
(0)
–
An invalid command entry
GstVideo.NavigationCommand.MENU1
(1)
–
Execute navigation menu command 1. For DVD, this enters the DVD root menu, or exits back to the title from the menu.
GstVideo.NavigationCommand.MENU2
(2)
–
Execute navigation menu command 2. For DVD, this jumps to the DVD title menu.
GstVideo.NavigationCommand.MENU3
(3)
–
Execute navigation menu command 3. For DVD, this jumps into the DVD root menu.
GstVideo.NavigationCommand.MENU4
(4)
–
Execute navigation menu command 4. For DVD, this jumps to the Subpicture menu.
GstVideo.NavigationCommand.MENU5
(5)
–
Execute navigation menu command 5. For DVD, the jumps to the audio menu.
GstVideo.NavigationCommand.MENU6
(6)
–
Execute navigation menu command 6. For DVD, this jumps to the angles menu.
GstVideo.NavigationCommand.MENU7
(7)
–
Execute navigation menu command 7. For DVD, this jumps to the chapter menu.
GstVideo.NavigationCommand.LEFT
(20)
–
Select the next button to the left in a menu, if such a button exists.
GstVideo.NavigationCommand.RIGHT
(21)
–
Select the next button to the right in a menu, if such a button exists.
GstVideo.NavigationCommand.UP
(22)
–
Select the button above the current one in a menu, if such a button exists.
GstVideo.NavigationCommand.DOWN
(23)
–
Select the button below the current one in a menu, if such a button exists.
GstVideo.NavigationCommand.ACTIVATE
(24)
–
Activate (click) the currently selected button in a menu, if such a button exists.
GstVideo.NavigationCommand.PREV_ANGLE
(30)
–
Switch to the previous angle in a multiangle feature.
GstVideo.NavigationCommand.NEXT_ANGLE
(31)
–
Switch to the next angle in a multiangle feature.
GstNavigationEventType
Enum values for the various events that an element implementing the GstNavigation interface might send up the pipeline.
Members
GST_NAVIGATION_EVENT_INVALID
(0)
–
Returned from gst_navigation_event_get_type when the passed event is not a navigation event.
GST_NAVIGATION_EVENT_KEY_PRESS
(1)
–
A key press event. Use gst_navigation_event_parse_key_event to extract the details from the event.
GST_NAVIGATION_EVENT_KEY_RELEASE
(2)
–
A key release event. Use gst_navigation_event_parse_key_event to extract the details from the event.
GST_NAVIGATION_EVENT_MOUSE_BUTTON_PRESS
(3)
–
A mouse button press event. Use gst_navigation_event_parse_mouse_button_event to extract the details from the event.
GST_NAVIGATION_EVENT_MOUSE_BUTTON_RELEASE
(4)
–
A mouse button release event. Use gst_navigation_event_parse_mouse_button_event to extract the details from the event.
GST_NAVIGATION_EVENT_MOUSE_MOVE
(5)
–
A mouse movement event. Use gst_navigation_event_parse_mouse_move_event to extract the details from the event.
GST_NAVIGATION_EVENT_COMMAND
(6)
–
A navigation command event. Use gst_navigation_event_parse_command to extract the details from the event.
GST_NAVIGATION_EVENT_MOUSE_SCROLL
(7)
–
A mouse scroll event. Use gst_navigation_event_parse_mouse_scroll_event to extract the details from the event. (Since: 1.18)
GstVideo.NavigationEventType
Enum values for the various events that an element implementing the GstNavigation interface might send up the pipeline.
Members
GstVideo.NavigationEventType.INVALID
(0)
–
Returned from GstVideo.prototype.navigation_event_get_type when the passed event is not a navigation event.
GstVideo.NavigationEventType.KEY_PRESS
(1)
–
A key press event. Use GstVideo.prototype.navigation_event_parse_key_event to extract the details from the event.
GstVideo.NavigationEventType.KEY_RELEASE
(2)
–
A key release event. Use GstVideo.prototype.navigation_event_parse_key_event to extract the details from the event.
GstVideo.NavigationEventType.MOUSE_BUTTON_PRESS
(3)
–
A mouse button press event. Use GstVideo.prototype.navigation_event_parse_mouse_button_event to extract the details from the event.
GstVideo.NavigationEventType.MOUSE_BUTTON_RELEASE
(4)
–
A mouse button release event. Use GstVideo.prototype.navigation_event_parse_mouse_button_event to extract the details from the event.
GstVideo.NavigationEventType.MOUSE_MOVE
(5)
–
A mouse movement event. Use GstVideo.prototype.navigation_event_parse_mouse_move_event to extract the details from the event.
GstVideo.NavigationEventType.COMMAND
(6)
–
A navigation command event. Use GstVideo.prototype.navigation_event_parse_command to extract the details from the event.
GstVideo.NavigationEventType.MOUSE_SCROLL
(7)
–
A mouse scroll event. Use GstVideo.prototype.navigation_event_parse_mouse_scroll_event to extract the details from the event. (Since: 1.18)
GstVideo.NavigationEventType
Enum values for the various events that an element implementing the GstNavigation interface might send up the pipeline.
Members
GstVideo.NavigationEventType.INVALID
(0)
–
Returned from GstVideo.navigation_event_get_type when the passed event is not a navigation event.
GstVideo.NavigationEventType.KEY_PRESS
(1)
–
A key press event. Use GstVideo.navigation_event_parse_key_event to extract the details from the event.
GstVideo.NavigationEventType.KEY_RELEASE
(2)
–
A key release event. Use GstVideo.navigation_event_parse_key_event to extract the details from the event.
GstVideo.NavigationEventType.MOUSE_BUTTON_PRESS
(3)
–
A mouse button press event. Use GstVideo.navigation_event_parse_mouse_button_event to extract the details from the event.
GstVideo.NavigationEventType.MOUSE_BUTTON_RELEASE
(4)
–
A mouse button release event. Use GstVideo.navigation_event_parse_mouse_button_event to extract the details from the event.
GstVideo.NavigationEventType.MOUSE_MOVE
(5)
–
A mouse movement event. Use GstVideo.navigation_event_parse_mouse_move_event to extract the details from the event.
GstVideo.NavigationEventType.COMMAND
(6)
–
A navigation command event. Use GstVideo.navigation_event_parse_command to extract the details from the event.
GstVideo.NavigationEventType.MOUSE_SCROLL
(7)
–
A mouse scroll event. Use GstVideo.navigation_event_parse_mouse_scroll_event to extract the details from the event. (Since: 1.18)
GstNavigationMessageType
A set of notifications that may be received on the bus when navigation related status changes.
Members
GST_NAVIGATION_MESSAGE_INVALID
(0)
–
Returned from gst_navigation_message_get_type when the passed message is not a navigation message.
GST_NAVIGATION_MESSAGE_MOUSE_OVER
(1)
–
Sent when the mouse moves over or leaves a clickable region of the output, such as a DVD menu button.
GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED
(2)
–
Sent when the set of available commands changes and should re-queried by interested applications.
GST_NAVIGATION_MESSAGE_ANGLES_CHANGED
(3)
–
Sent when display angles in a multi-angle feature (such as a multiangle DVD) change - either angles have appeared or disappeared.
GST_NAVIGATION_MESSAGE_EVENT
(4)
–
Sent when a navigation event was not handled by any element in the pipeline (Since: 1.6)
GstVideo.NavigationMessageType
A set of notifications that may be received on the bus when navigation related status changes.
Members
GstVideo.NavigationMessageType.INVALID
(0)
–
Returned from GstVideo.prototype.navigation_message_get_type when the passed message is not a navigation message.
GstVideo.NavigationMessageType.MOUSE_OVER
(1)
–
Sent when the mouse moves over or leaves a clickable region of the output, such as a DVD menu button.
GstVideo.NavigationMessageType.COMMANDS_CHANGED
(2)
–
Sent when the set of available commands changes and should re-queried by interested applications.
GstVideo.NavigationMessageType.ANGLES_CHANGED
(3)
–
Sent when display angles in a multi-angle feature (such as a multiangle DVD) change - either angles have appeared or disappeared.
GstVideo.NavigationMessageType.EVENT
(4)
–
Sent when a navigation event was not handled by any element in the pipeline (Since: 1.6)
GstVideo.NavigationMessageType
A set of notifications that may be received on the bus when navigation related status changes.
Members
GstVideo.NavigationMessageType.INVALID
(0)
–
Returned from GstVideo.navigation_message_get_type when the passed message is not a navigation message.
GstVideo.NavigationMessageType.MOUSE_OVER
(1)
–
Sent when the mouse moves over or leaves a clickable region of the output, such as a DVD menu button.
GstVideo.NavigationMessageType.COMMANDS_CHANGED
(2)
–
Sent when the set of available commands changes and should re-queried by interested applications.
GstVideo.NavigationMessageType.ANGLES_CHANGED
(3)
–
Sent when display angles in a multi-angle feature (such as a multiangle DVD) change - either angles have appeared or disappeared.
GstVideo.NavigationMessageType.EVENT
(4)
–
Sent when a navigation event was not handled by any element in the pipeline (Since: 1.6)
GstNavigationQueryType
Types of navigation interface queries.
Members
GST_NAVIGATION_QUERY_INVALID
(0)
–
invalid query
GST_NAVIGATION_QUERY_COMMANDS
(1)
–
command query
GST_NAVIGATION_QUERY_ANGLES
(2)
–
viewing angle query
GstVideo.NavigationQueryType
Types of navigation interface queries.
Members
GstVideo.NavigationQueryType.INVALID
(0)
–
invalid query
GstVideo.NavigationQueryType.COMMANDS
(1)
–
command query
GstVideo.NavigationQueryType.ANGLES
(2)
–
viewing angle query
GstVideo.NavigationQueryType
Types of navigation interface queries.
Members
GstVideo.NavigationQueryType.INVALID
(0)
–
invalid query
GstVideo.NavigationQueryType.COMMANDS
(1)
–
command query
GstVideo.NavigationQueryType.ANGLES
(2)
–
viewing angle query
Constants
GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU
#define GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU GST_NAVIGATION_COMMAND_MENU6
GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU
#define GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU GST_NAVIGATION_COMMAND_MENU5
GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU
#define GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU GST_NAVIGATION_COMMAND_MENU7
GST_NAVIGATION_COMMAND_DVD_MENU
#define GST_NAVIGATION_COMMAND_DVD_MENU GST_NAVIGATION_COMMAND_MENU1
GST_NAVIGATION_COMMAND_DVD_ROOT_MENU
#define GST_NAVIGATION_COMMAND_DVD_ROOT_MENU GST_NAVIGATION_COMMAND_MENU3
GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU
#define GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU GST_NAVIGATION_COMMAND_MENU4
GST_NAVIGATION_COMMAND_DVD_TITLE_MENU
#define GST_NAVIGATION_COMMAND_DVD_TITLE_MENU GST_NAVIGATION_COMMAND_MENU2
GST_TYPE_NAVIGATION
#define GST_TYPE_NAVIGATION \ (gst_navigation_get_type ())
The results of the search are