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


GstNavigation


GstNavigation


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:

navigation ( GstVideo.Navigation ) –

The navigation interface instance

command ( GstVideo.NavigationCommand ) –

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:

navigation ( GstVideo.Navigation ) –

The navigation interface instance

command ( GstVideo.NavigationCommand ) –

The command to issue


gst_navigation_send_event

gst_navigation_send_event (GstNavigation * navigation,
                           GstStructure * structure)

Parameters:

navigation
No description available
structure
No description available

GstVideo.Navigation.prototype.send_event

function GstVideo.Navigation.prototype.send_event(structure: Gst.Structure): {
    // javascript wrapper for 'gst_navigation_send_event'
}

Parameters:

navigation ( GstVideo.Navigation ) –
No description available
structure ( Gst.Structure ) –
No description available

GstVideo.Navigation.send_event

def GstVideo.Navigation.send_event (self, structure):
    #python wrapper for 'gst_navigation_send_event'

Parameters:

navigation ( GstVideo.Navigation ) –
No description available
structure ( Gst.Structure ) –
No description available

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:

navigation ( GstVideo.Navigation ) –

The navigation interface instance

event ( String ) –

The type of the key event. Recognised values are "key-press" and "key-release"

key ( String ) –

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:

navigation ( GstVideo.Navigation ) –

The navigation interface instance

event ( str ) –

The type of the key event. Recognised values are "key-press" and "key-release"

key ( str ) –

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:

navigation ( GstVideo.Navigation ) –

The navigation interface instance

event ( String ) –

The type of mouse event, as a text string. Recognised values are "mouse-button-press", "mouse-button-release" and "mouse-move".

button ( Number ) –

The button number of the button being pressed or released. Pass 0 for mouse-move events.

x ( Number ) –

The x coordinate of the mouse event.

y ( Number ) –

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:

navigation ( GstVideo.Navigation ) –

The navigation interface instance

event ( str ) –

The type of mouse event, as a text string. Recognised values are "mouse-button-press", "mouse-button-release" and "mouse-move".

button ( int ) –

The button number of the button being pressed or released. Pass 0 for mouse-move events.

x ( float ) –

The x coordinate of the mouse event.

y ( float ) –

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:

navigation ( GstVideo.Navigation ) –

The navigation interface instance

x ( Number ) –

The x coordinate of the mouse event.

y ( Number ) –

The y coordinate of the mouse event.

delta_x ( Number ) –

The delta_x coordinate of the mouse event.

delta_y ( Number ) –

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:

navigation ( GstVideo.Navigation ) –

The navigation interface instance

x ( float ) –

The x coordinate of the mouse event.

y ( float ) –

The y coordinate of the mouse event.

delta_x ( float ) –

The delta_x coordinate of the mouse event.

delta_y ( float ) –

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.

Returns
No description available

GstVideo.Navigation.prototype.event_get_type

function GstVideo.Navigation.prototype.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.

Parameters:

event ( Gst.Event ) –

A Gst.Event to inspect.

No description available

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.

Parameters:

event ( Gst.Event ) –

A Gst.Event to inspect.

No description available

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.

Returns

TRUE if the navigation command could be extracted, otherwise FALSE.


GstVideo.Navigation.prototype.event_parse_command

function GstVideo.Navigation.prototype.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.

Parameters:

event ( Gst.Event ) –

A Gst.Event to inspect.

Returns a tuple made of:

( Number ) –

TRUE if the navigation command could be extracted, otherwise FALSE.

command ( GstVideo.NavigationCommand ) –

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.

Parameters:

event ( Gst.Event ) –

A Gst.Event to inspect.

Returns a tuple made of:

( bool ) –

TRUE if the navigation command could be extracted, otherwise FALSE.

command ( GstVideo.NavigationCommand ) –

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.

Returns
No description available

GstVideo.Navigation.prototype.event_parse_key_event

function GstVideo.Navigation.prototype.event_parse_key_event(event: Gst.Event): {
    // javascript wrapper for 'gst_navigation_event_parse_key_event'
}

Parameters:

event ( Gst.Event ) –

A Gst.Event to inspect.

Returns a tuple made of:

( Number ) –
No description available
key ( String ) –
No description available

GstVideo.Navigation.event_parse_key_event

def GstVideo.Navigation.event_parse_key_event (event):
    #python wrapper for 'gst_navigation_event_parse_key_event'

Parameters:

event ( Gst.Event ) –

A Gst.Event to inspect.

Returns a tuple made of:

( bool ) –
No description available
key ( str ) –
No description available

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.

Returns

TRUE if the button number and both coordinates could be extracted, otherwise FALSE.


GstVideo.Navigation.prototype.event_parse_mouse_button_event

function GstVideo.Navigation.prototype.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.Navigation.prototype.event_get_type to retrieve the GstVideo.NavigationEventType.

Parameters:

event ( Gst.Event ) –

A Gst.Event to inspect.

Returns a tuple made of:

( Number ) –

TRUE if the button number and both coordinates could be extracted, otherwise FALSE.

button ( Number ) –

TRUE if the button number and both coordinates could be extracted, otherwise FALSE.

x ( Number ) –

TRUE if the button number and both coordinates could be extracted, otherwise FALSE.

y ( Number ) –

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.

Parameters:

event ( Gst.Event ) –

A Gst.Event to inspect.

Returns a tuple made of:

( bool ) –

TRUE if the button number and both coordinates could be extracted, otherwise FALSE.

button ( int ) –

TRUE if the button number and both coordinates could be extracted, otherwise FALSE.

x ( float ) –

TRUE if the button number and both coordinates could be extracted, otherwise FALSE.

y ( float ) –

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.

Returns

TRUE if both coordinates could be extracted, otherwise FALSE.


GstVideo.Navigation.prototype.event_parse_mouse_move_event

function GstVideo.Navigation.prototype.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.

Parameters:

event ( Gst.Event ) –

A Gst.Event to inspect.

Returns a tuple made of:

( Number ) –

TRUE if both coordinates could be extracted, otherwise FALSE.

x ( Number ) –

TRUE if both coordinates could be extracted, otherwise FALSE.

y ( Number ) –

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.

Parameters:

event ( Gst.Event ) –

A Gst.Event to inspect.

Returns a tuple made of:

( bool ) –

TRUE if both coordinates could be extracted, otherwise FALSE.

x ( float ) –

TRUE if both coordinates could be extracted, otherwise FALSE.

y ( float ) –

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.

Returns

TRUE if all coordinates could be extracted, otherwise FALSE.

Since : 1.18


GstVideo.Navigation.prototype.event_parse_mouse_scroll_event

function GstVideo.Navigation.prototype.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.

Parameters:

event ( Gst.Event ) –

A Gst.Event to inspect.

Returns a tuple made of:

( Number ) –

TRUE if all coordinates could be extracted, otherwise FALSE.

x ( Number ) –

TRUE if all coordinates could be extracted, otherwise FALSE.

y ( Number ) –

TRUE if all coordinates could be extracted, otherwise FALSE.

delta_x ( Number ) –

TRUE if all coordinates could be extracted, otherwise FALSE.

delta_y ( Number ) –

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.

Parameters:

event ( Gst.Event ) –

A Gst.Event to inspect.

Returns a tuple made of:

( bool ) –

TRUE if all coordinates could be extracted, otherwise FALSE.

x ( float ) –

TRUE if all coordinates could be extracted, otherwise FALSE.

y ( float ) –

TRUE if all coordinates could be extracted, otherwise FALSE.

delta_x ( float ) –

TRUE if all coordinates could be extracted, otherwise FALSE.

delta_y ( float ) –

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.

Returns

The type of the GstMessage, or GST_NAVIGATION_MESSAGE_INVALID if the message is not a GstNavigation notification.


GstVideo.Navigation.prototype.message_get_type

function GstVideo.Navigation.prototype.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:

message ( Gst.Message ) –

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:

message ( Gst.Message ) –

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.

Returns

The new GstMessage.


GstVideo.Navigation.prototype.message_new_angles_changed

function GstVideo.Navigation.prototype.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:

src ( Gst.Object ) –

A Gst.Object to set as source of the new message.

cur_angle ( Number ) –

The currently selected angle.

n_angles ( Number ) –

The number of viewing angles now available.

Returns ( Gst.Message ) –

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:

src ( Gst.Object ) –

A Gst.Object to set as source of the new message.

cur_angle ( int ) –

The currently selected angle.

n_angles ( int ) –

The number of viewing angles now available.

Returns ( Gst.Message ) –

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.

Returns

The new GstMessage.


GstVideo.Navigation.prototype.message_new_commands_changed

function GstVideo.Navigation.prototype.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:

src ( Gst.Object ) –

A Gst.Object to set as source of the new message.

Returns ( Gst.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:

src ( Gst.Object ) –

A Gst.Object to set as source of the new message.

Returns ( Gst.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

Returns

The new GstMessage.

Since : 1.6


GstVideo.Navigation.prototype.message_new_event

function GstVideo.Navigation.prototype.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:

src ( Gst.Object ) –

A Gst.Object to set as source of the new message.

event ( Gst.Event ) –

A navigation Gst.Event

Returns ( Gst.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:

src ( Gst.Object ) –

A Gst.Object to set as source of the new message.

event ( Gst.Event ) –

A navigation Gst.Event

Returns ( Gst.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.

active

TRUE if the mouse has entered a clickable area of the display. FALSE if it over a non-clickable area.

Returns

The new GstMessage.


GstVideo.Navigation.prototype.message_new_mouse_over

function GstVideo.Navigation.prototype.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:

src ( Gst.Object ) –

A Gst.Object to set as source of the new message.

active ( Number ) –

true if the mouse has entered a clickable area of the display. false if it over a non-clickable area.

Returns ( Gst.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:

src ( Gst.Object ) –

A Gst.Object to set as source of the new message.

active ( bool ) –

True if the mouse has entered a clickable area of the display. False if it over a non-clickable area.

Returns ( Gst.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.

Returns

TRUE if the message could be successfully parsed. FALSE if not.


GstVideo.Navigation.prototype.message_parse_angles_changed

function GstVideo.Navigation.prototype.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:

message ( Gst.Message ) –

A Gst.Message to inspect.

Returns a tuple made of:

( Number ) –

true if the message could be successfully parsed. false if not.

cur_angle ( Number ) –

true if the message could be successfully parsed. false if not.

n_angles ( Number ) –

true if the message could be successfully parsed. false if not.


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:

message ( Gst.Message ) –

A Gst.Message to inspect.

Returns a tuple made of:

( bool ) –

True if the message could be successfully parsed. False if not.

cur_angle ( int ) –

True if the message could be successfully parsed. False if not.

n_angles ( int ) –

True if the message could be successfully parsed. False if not.


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.

Returns

TRUE if the message could be successfully parsed. FALSE if not.

Since : 1.6


GstVideo.Navigation.prototype.message_parse_event

function GstVideo.Navigation.prototype.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:

message ( Gst.Message ) –

A Gst.Message to inspect.

Returns a tuple made of:

( Number ) –

true if the message could be successfully parsed. false if not.

event ( Gst.Event ) –

true if the message could be successfully parsed. false if not.

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:

message ( Gst.Message ) –

A Gst.Message to inspect.

Returns a tuple made of:

( bool ) –

True if the message could be successfully parsed. False if not.

event ( Gst.Event ) –

True if the message could be successfully parsed. False if not.

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.

Returns

TRUE if the message could be successfully parsed. FALSE if not.


GstVideo.Navigation.prototype.message_parse_mouse_over

function GstVideo.Navigation.prototype.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:

message ( Gst.Message ) –

A Gst.Message to inspect.

Returns a tuple made of:

( Number ) –

true if the message could be successfully parsed. false if not.

active ( Number ) –

true if the message could be successfully parsed. false if not.


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:

message ( Gst.Message ) –

A Gst.Message to inspect.

Returns a tuple made of:

( bool ) –

True if the message could be successfully parsed. False if not.

active ( bool ) –

True if the message could be successfully parsed. False if not.


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

Returns

The GstNavigationQueryType of the query, or GST_NAVIGATION_QUERY_INVALID


GstVideo.Navigation.prototype.query_get_type

function GstVideo.Navigation.prototype.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:

query ( Gst.Query ) –

The query to inspect


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:

query ( Gst.Query ) –

The query to inspect


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.

Returns

The new query.


GstVideo.Navigation.prototype.query_new_angles

function GstVideo.Navigation.prototype.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.

Returns ( Gst.Query ) –

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.

Returns ( Gst.Query ) –

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.

Returns

The new query.


GstVideo.Navigation.prototype.query_new_commands

function GstVideo.Navigation.prototype.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.

Returns ( Gst.Query ) –

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.

Returns ( Gst.Query ) –

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

Returns

TRUE if the query could be successfully parsed. FALSE if not.


GstVideo.Navigation.prototype.query_parse_angles

function GstVideo.Navigation.prototype.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.

Parameters:

query ( Gst.Query ) –

a Gst.Query

Returns a tuple made of:

( Number ) –

true if the query could be successfully parsed. false if not.

cur_angle ( Number ) –

true if the query could be successfully parsed. false if not.

n_angles ( Number ) –

true if the query could be successfully parsed. false if not.


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.

Parameters:

query ( Gst.Query ) –

a Gst.Query

Returns a tuple made of:

( bool ) –

True if the query could be successfully parsed. False if not.

cur_angle ( int ) –

True if the query could be successfully parsed. False if not.

n_angles ( int ) –

True if the query could be successfully parsed. False if not.


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.

Parameters:

query

a GstQuery

n_cmds ( [out] [optional] ) –

the number of commands in this query.

Returns

TRUE if the query could be successfully parsed. FALSE if not.


GstVideo.Navigation.prototype.query_parse_commands_length

function GstVideo.Navigation.prototype.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.

Parameters:

query ( Gst.Query ) –

a Gst.Query

Returns a tuple made of:

( Number ) –

true if the query could be successfully parsed. false if not.

n_cmds ( Number ) –

true if the query could be successfully parsed. false if not.


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.

Parameters:

query ( Gst.Query ) –

a Gst.Query

Returns a tuple made of:

( bool ) –

True if the query could be successfully parsed. False if not.

n_cmds ( int ) –

True if the query could be successfully parsed. False if not.


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.

Returns

TRUE if the query could be successfully parsed. FALSE if not.


GstVideo.Navigation.prototype.query_parse_commands_nth

function GstVideo.Navigation.prototype.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.

Parameters:

query ( Gst.Query ) –

a Gst.Query

nth ( Number ) –

the nth command to retrieve.

Returns a tuple made of:

( Number ) –

true if the query could be successfully parsed. false if not.

true if the query could be successfully parsed. false if not.


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.

Parameters:

query ( Gst.Query ) –

a Gst.Query

nth ( int ) –

the nth command to retrieve.

Returns a tuple made of:

( bool ) –

True if the query could be successfully parsed. False if not.

True if the query could be successfully parsed. False if not.


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.Navigation.prototype.query_set_angles

function GstVideo.Navigation.prototype.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:

query ( Gst.Query ) –

a Gst.Query

cur_angle ( Number ) –

the current viewing angle to set.

n_angles ( Number ) –

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:

query ( Gst.Query ) –

a Gst.Query

cur_angle ( int ) –

the current viewing angle to set.

n_angles ( int ) –

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 ( [array length=n_cmds] ) –

An array containing n_cmds GstNavigationCommand values.


GstVideo.Navigation.prototype.query_set_commandsv

function GstVideo.Navigation.prototype.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:

query ( Gst.Query ) –

a Gst.Query

n_cmds ( Number ) –

the number of commands to set.

cmds ( [ GstVideo.NavigationCommand ] ) –

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:

query ( Gst.Query ) –

a Gst.Query

n_cmds ( int ) –

the number of commands to set.

cmds ( [ GstVideo.NavigationCommand ] ) –

An array containing n_cmds GstNavigationCommand values.


Virtual Methods

send_event

send_event (GstNavigation * navigation,
            GstStructure * structure)

sending a navigation event

Parameters:

navigation
No description available
structure
No description available

send_event

function send_event(navigation: GstVideo.Navigation, structure: Gst.Structure): {
    // javascript implementation of the 'send_event' virtual method
}

sending a navigation event

Parameters:

navigation ( GstVideo.Navigation ) –
No description available
structure ( Gst.Structure ) –
No description available

send_event

def send_event (navigation, structure):
    #python implementation of the 'send_event' virtual method

sending a navigation event

Parameters:

navigation ( GstVideo.Navigation ) –
No description available
structure ( Gst.Structure ) –
No description available

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.Navigation.prototype.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.Navigation.prototype.event_get_type when the passed event is not a navigation event.

GstVideo.NavigationEventType.KEY_PRESS (1) –

A key press event. Use GstVideo.Navigation.prototype.event_parse_key_event to extract the details from the event.

GstVideo.NavigationEventType.KEY_RELEASE (2) –

A key release event. Use GstVideo.Navigation.prototype.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.prototype.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.prototype.event_parse_mouse_button_event to extract the details from the event.

GstVideo.NavigationEventType.MOUSE_MOVE (5) –

A mouse movement event. Use GstVideo.Navigation.prototype.event_parse_mouse_move_event to extract the details from the event.

GstVideo.NavigationEventType.COMMAND (6) –

A navigation command event. Use GstVideo.Navigation.prototype.event_parse_command to extract the details from the event.

GstVideo.NavigationEventType.MOUSE_SCROLL (7) –

A mouse scroll event. Use GstVideo.Navigation.prototype.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.Navigation.prototype.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