# 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

### Methods

### Functions

### Virtual Methods

#### send_event

    send_event (GstNavigation * navigation,
                GstStructure * structure)

sending a navigation event

Parameters:

`navigation` –
No description available
`structure` –
No description available

#### 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:

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

#### do_send_event

    def do_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

#### send_event_simple

    send_event_simple (GstNavigation * navigation,
                       GstEvent * event)

sending a navigation event (Since: 1.22)

Parameters:

`navigation` –
No description available
`event` –
No description available

#### vfunc_send_event_simple

    function vfunc_send_event_simple(navigation: GstVideo.Navigation, event: Gst.Event): {
        // javascript implementation of the 'send_event_simple' virtual method
    }

sending a navigation event (Since: 1.22)

Parameters:

`navigation` (GstVideo.Navigation) –
No description available
`event` (Gst.Event) –
No description available

#### do_send_event_simple

    def do_send_event_simple (navigation, event):
        #python implementation of the 'send_event_simple' virtual method

sending a navigation event (Since: 1.22)

Parameters:

`navigation` (GstVideo.Navigation) –
No description available
`event` (Gst.Event) –
No description available

## Function Macros

## 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. Touch events have been inspired by the libinput API, and have the same meaning here.

##### 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.

`GST_NAVIGATION_EVENT_TOUCH_DOWN` (8) –

An event describing a new touch point, which will be assigned an identifier that is unique to it for the duration of its movement on the screen. Use gst_navigation_event_parse_touch_event to extract the details from the event.

`GST_NAVIGATION_EVENT_TOUCH_MOTION` (9) –

An event describing the movement of an active touch point across the screen. Use gst_navigation_event_parse_touch_event to extract the details from the event.

`GST_NAVIGATION_EVENT_TOUCH_UP` (10) –

An event describing a removed touch point. After this event, its identifier may be reused for any new touch points. Use gst_navigation_event_parse_touch_up_event to extract the details from the event.

`GST_NAVIGATION_EVENT_TOUCH_FRAME` (11) –

An event signaling the end of a sequence of simultaneous touch events.

`GST_NAVIGATION_EVENT_TOUCH_CANCEL` (12) –

An event cancelling all currently active touch points.

### GstVideo.NavigationEventType

Enum values for the various events that an element implementing the GstNavigation interface might send up the pipeline. Touch events have been inspired by the libinput API, and have the same meaning here.

##### 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.

`GstVideo.NavigationEventType.TOUCH_DOWN` (8) –

An event describing a new touch point, which will be assigned an identifier that is unique to it for the duration of its movement on the screen. Use GstVideo.prototype.navigation_event_parse_touch_event to extract the details from the event.

`GstVideo.NavigationEventType.TOUCH_MOTION` (9) –

An event describing the movement of an active touch point across the screen. Use GstVideo.prototype.navigation_event_parse_touch_event to extract the details from the event.

`GstVideo.NavigationEventType.TOUCH_UP` (10) –

An event describing a removed touch point. After this event, its identifier may be reused for any new touch points. Use GstVideo.prototype.navigation_event_parse_touch_up_event to extract the details from the event.

`GstVideo.NavigationEventType.TOUCH_FRAME` (11) –

An event signaling the end of a sequence of simultaneous touch events.

`GstVideo.NavigationEventType.TOUCH_CANCEL` (12) –

An event cancelling all currently active touch points.

### GstVideo.NavigationEventType

Enum values for the various events that an element implementing the GstNavigation interface might send up the pipeline. Touch events have been inspired by the libinput API, and have the same meaning here.

##### 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.

`GstVideo.NavigationEventType.TOUCH_DOWN` (8) –

An event describing a new touch point, which will be assigned an identifier that is unique to it for the duration of its movement on the screen. Use GstVideo.navigation_event_parse_touch_event to extract the details from the event.

`GstVideo.NavigationEventType.TOUCH_MOTION` (9) –

An event describing the movement of an active touch point across the screen. Use GstVideo.navigation_event_parse_touch_event to extract the details from the event.

`GstVideo.NavigationEventType.TOUCH_UP` (10) –

An event describing a removed touch point. After this event, its identifier may be reused for any new touch points. Use GstVideo.navigation_event_parse_touch_up_event to extract the details from the event.

`GstVideo.NavigationEventType.TOUCH_FRAME` (11) –

An event signaling the end of a sequence of simultaneous touch events.

`GstVideo.NavigationEventType.TOUCH_CANCEL` (12) –

An event cancelling all currently active touch points.

### 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)

### GstNavigationModifierType

Flags to indicate the state of modifier keys and mouse buttons in events.

Typical modifier keys are Shift, Control, Meta, Super, Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.

##### Members

`GST_NAVIGATION_MODIFIER_NONE` (0) –
No description available
`GST_NAVIGATION_MODIFIER_SHIFT_MASK` (1) –

the Shift key.

`GST_NAVIGATION_MODIFIER_LOCK_MASK` (2) –
No description available
`GST_NAVIGATION_MODIFIER_CONTROL_MASK` (4) –

the Control key.

`GST_NAVIGATION_MODIFIER_MOD1_MASK` (8) –

the third modifier key

`GST_NAVIGATION_MODIFIER_MOD2_MASK` (16) –

the fourth modifier key

`GST_NAVIGATION_MODIFIER_MOD3_MASK` (32) –

the fifth modifier key

`GST_NAVIGATION_MODIFIER_MOD4_MASK` (64) –

the sixth modifier key

`GST_NAVIGATION_MODIFIER_MOD5_MASK` (128) –

the seventh modifier key

`GST_NAVIGATION_MODIFIER_BUTTON1_MASK` (256) –

the first mouse button (usually the left button).

`GST_NAVIGATION_MODIFIER_BUTTON2_MASK` (512) –

the second mouse button (usually the right button).

`GST_NAVIGATION_MODIFIER_BUTTON3_MASK` (1024) –

the third mouse button (usually the mouse wheel button or middle button).

`GST_NAVIGATION_MODIFIER_BUTTON4_MASK` (2048) –

the fourth mouse button (typically the "Back" button).

`GST_NAVIGATION_MODIFIER_BUTTON5_MASK` (4096) –

the fifth mouse button (typically the "forward" button).

`GST_NAVIGATION_MODIFIER_SUPER_MASK` (67108864) –

the Super modifier

`GST_NAVIGATION_MODIFIER_HYPER_MASK` (134217728) –

the Hyper modifier

`GST_NAVIGATION_MODIFIER_META_MASK` (268435456) –

the Meta modifier

`GST_NAVIGATION_MODIFIER_MASK` (469770239) –

A mask covering all entries in GdkModifierType.

### GstVideo.NavigationModifierType

Flags to indicate the state of modifier keys and mouse buttons in events.

Typical modifier keys are Shift, Control, Meta, Super, Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.

##### Members

`GstVideo.NavigationModifierType.NONE` (0) –
No description available
`GstVideo.NavigationModifierType.SHIFT_MASK` (1) –

the Shift key.

`GstVideo.NavigationModifierType.LOCK_MASK` (2) –
No description available
`GstVideo.NavigationModifierType.CONTROL_MASK` (4) –

the Control key.

`GstVideo.NavigationModifierType.MOD1_MASK` (8) –

the third modifier key

`GstVideo.NavigationModifierType.MOD2_MASK` (16) –

the fourth modifier key

`GstVideo.NavigationModifierType.MOD3_MASK` (32) –

the fifth modifier key

`GstVideo.NavigationModifierType.MOD4_MASK` (64) –

the sixth modifier key

`GstVideo.NavigationModifierType.MOD5_MASK` (128) –

the seventh modifier key

`GstVideo.NavigationModifierType.BUTTON1_MASK` (256) –

the first mouse button (usually the left button).

`GstVideo.NavigationModifierType.BUTTON2_MASK` (512) –

the second mouse button (usually the right button).

`GstVideo.NavigationModifierType.BUTTON3_MASK` (1024) –

the third mouse button (usually the mouse wheel button or middle button).

`GstVideo.NavigationModifierType.BUTTON4_MASK` (2048) –

the fourth mouse button (typically the "Back" button).

`GstVideo.NavigationModifierType.BUTTON5_MASK` (4096) –

the fifth mouse button (typically the "forward" button).

`GstVideo.NavigationModifierType.SUPER_MASK` (67108864) –

the Super modifier

`GstVideo.NavigationModifierType.HYPER_MASK` (134217728) –

the Hyper modifier

`GstVideo.NavigationModifierType.META_MASK` (268435456) –

the Meta modifier

`GstVideo.NavigationModifierType.MASK` (469770239) –

A mask covering all entries in GdkModifierType (not introspectable).

### GstVideo.NavigationModifierType

Flags to indicate the state of modifier keys and mouse buttons in events.

Typical modifier keys are Shift, Control, Meta, Super, Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.

##### Members

`GstVideo.NavigationModifierType.NONE` (0) –
No description available
`GstVideo.NavigationModifierType.SHIFT_MASK` (1) –

the Shift key.

`GstVideo.NavigationModifierType.LOCK_MASK` (2) –
No description available
`GstVideo.NavigationModifierType.CONTROL_MASK` (4) –

the Control key.

`GstVideo.NavigationModifierType.MOD1_MASK` (8) –

the third modifier key

`GstVideo.NavigationModifierType.MOD2_MASK` (16) –

the fourth modifier key

`GstVideo.NavigationModifierType.MOD3_MASK` (32) –

the fifth modifier key

`GstVideo.NavigationModifierType.MOD4_MASK` (64) –

the sixth modifier key

`GstVideo.NavigationModifierType.MOD5_MASK` (128) –

the seventh modifier key

`GstVideo.NavigationModifierType.BUTTON1_MASK` (256) –

the first mouse button (usually the left button).

`GstVideo.NavigationModifierType.BUTTON2_MASK` (512) –

the second mouse button (usually the right button).

`GstVideo.NavigationModifierType.BUTTON3_MASK` (1024) –

the third mouse button (usually the mouse wheel button or middle button).

`GstVideo.NavigationModifierType.BUTTON4_MASK` (2048) –

the fourth mouse button (typically the "Back" button).

`GstVideo.NavigationModifierType.BUTTON5_MASK` (4096) –

the fifth mouse button (typically the "forward" button).

`GstVideo.NavigationModifierType.SUPER_MASK` (67108864) –

the Super modifier

`GstVideo.NavigationModifierType.HYPER_MASK` (134217728) –

the Hyper modifier

`GstVideo.NavigationModifierType.META_MASK` (268435456) –

the Meta modifier

`GstVideo.NavigationModifierType.MASK` (469770239) –

A mask covering all entries in GdkModifierType (not introspectable).

### 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

The results of the search are