GstNavigation

GstVideo.Navigation

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.

GstVideo.Navigation.prototype.send_event

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

GstVideo.Navigation.prototype.send_event_simple

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

Sends an event to the navigation interface.

Since : 1.22

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'
}

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.

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.

Since : 1.18

GstVideo.prototype.navigation_event_get_coordinates

function GstVideo.prototype.navigation_event_get_coordinates(event: Gst.Event): {
    // javascript wrapper for 'gst_navigation_event_get_coordinates'
}

Try to retrieve x and y coordinates of a GstVideo.Navigation event.

Since : 1.22

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.prototype.navigation_event_new_command

function GstVideo.prototype.navigation_event_new_command(command: GstVideo.NavigationCommand): {
    // javascript wrapper for 'gst_navigation_event_new_command'
}

Create a new navigation event given navigation command..

Since : 1.22

GstVideo.prototype.navigation_event_new_key_press

function GstVideo.prototype.navigation_event_new_key_press(key: String, state: GstVideo.NavigationModifierType): {
    // javascript wrapper for 'gst_navigation_event_new_key_press'
}

Create a new navigation event for the given key press.

Since : 1.22

GstVideo.prototype.navigation_event_new_key_release

function GstVideo.prototype.navigation_event_new_key_release(key: String, state: GstVideo.NavigationModifierType): {
    // javascript wrapper for 'gst_navigation_event_new_key_release'
}

Create a new navigation event for the given key release.

Since : 1.22

GstVideo.prototype.navigation_event_new_mouse_button_press

function GstVideo.prototype.navigation_event_new_mouse_button_press(button: Number, x: Number, y: Number, state: GstVideo.NavigationModifierType): {
    // javascript wrapper for 'gst_navigation_event_new_mouse_button_press'
}

Create a new navigation event for the given key mouse button press.

Since : 1.22

GstVideo.prototype.navigation_event_new_mouse_button_release

function GstVideo.prototype.navigation_event_new_mouse_button_release(button: Number, x: Number, y: Number, state: GstVideo.NavigationModifierType): {
    // javascript wrapper for 'gst_navigation_event_new_mouse_button_release'
}

Create a new navigation event for the given key mouse button release.

Since : 1.22

GstVideo.prototype.navigation_event_new_mouse_move

function GstVideo.prototype.navigation_event_new_mouse_move(x: Number, y: Number, state: GstVideo.NavigationModifierType): {
    // javascript wrapper for 'gst_navigation_event_new_mouse_move'
}

Create a new navigation event for the new mouse location.

Since : 1.22

GstVideo.prototype.navigation_event_new_mouse_scroll

function GstVideo.prototype.navigation_event_new_mouse_scroll(x: Number, y: Number, delta_x: Number, delta_y: Number, state: GstVideo.NavigationModifierType): {
    // javascript wrapper for 'gst_navigation_event_new_mouse_scroll'
}

Create a new navigation event for the mouse scroll.

Since : 1.22

GstVideo.prototype.navigation_event_new_touch_cancel

function GstVideo.prototype.navigation_event_new_touch_cancel(state: GstVideo.NavigationModifierType): {
    // javascript wrapper for 'gst_navigation_event_new_touch_cancel'
}

Create a new navigation event signalling that all currently active touch points are cancelled and should be discarded. For example, under Wayland this event might be sent when a swipe passes the threshold to be recognized as a gesture by the compositor.

Since : 1.22

GstVideo.prototype.navigation_event_new_touch_down

function GstVideo.prototype.navigation_event_new_touch_down(identifier: Number, x: Number, y: Number, pressure: Number, state: GstVideo.NavigationModifierType): {
    // javascript wrapper for 'gst_navigation_event_new_touch_down'
}

Create a new navigation event for an added touch point.

Since : 1.22

GstVideo.prototype.navigation_event_new_touch_frame

function GstVideo.prototype.navigation_event_new_touch_frame(state: GstVideo.NavigationModifierType): {
    // javascript wrapper for 'gst_navigation_event_new_touch_frame'
}

Create a new navigation event signalling the end of a touch frame. Touch frames signal that all previous down, motion and up events not followed by another touch frame event already should be considered simultaneous.

Since : 1.22

GstVideo.prototype.navigation_event_new_touch_motion

function GstVideo.prototype.navigation_event_new_touch_motion(identifier: Number, x: Number, y: Number, pressure: Number, state: GstVideo.NavigationModifierType): {
    // javascript wrapper for 'gst_navigation_event_new_touch_motion'
}

Create a new navigation event for a moved touch point.

Since : 1.22

GstVideo.prototype.navigation_event_new_touch_up

function GstVideo.prototype.navigation_event_new_touch_up(identifier: Number, x: Number, y: Number, state: GstVideo.NavigationModifierType): {
    // javascript wrapper for 'gst_navigation_event_new_touch_up'
}

Create a new navigation event for a removed touch point.

Since : 1.22

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.

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'
}

Note: Modifier keys (as defined in GstVideo.NavigationModifierType) press and release events are generated even if those states are present on all other related events

GstVideo.prototype.navigation_event_parse_modifier_state

function GstVideo.prototype.navigation_event_parse_modifier_state(event: Gst.Event, state: GstVideo.NavigationModifierType): {
    // javascript wrapper for 'gst_navigation_event_parse_modifier_state'
}

Since : 1.22

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.

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.

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.

Since : 1.18

GstVideo.prototype.navigation_event_parse_touch_event

function GstVideo.prototype.navigation_event_parse_touch_event(event: Gst.Event): {
    // javascript wrapper for 'gst_navigation_event_parse_touch_event'
}

Retrieve the details of a GstVideo.Navigation touch-down or touch-motion event. Determine which type the event is using GstVideo.prototype.navigation_event_get_type to retrieve the GstVideo.NavigationEventType.

Since : 1.22

GstVideo.prototype.navigation_event_parse_touch_up_event

function GstVideo.prototype.navigation_event_parse_touch_up_event(event: Gst.Event): {
    // javascript wrapper for 'gst_navigation_event_parse_touch_up_event'
}

Retrieve the details of a GstVideo.Navigation touch-up event.

Since : 1.22

GstVideo.prototype.navigation_event_set_coordinates

function GstVideo.prototype.navigation_event_set_coordinates(event: Gst.Event, x: Number, y: Number): {
    // javascript wrapper for 'gst_navigation_event_set_coordinates'
}

Try to set x and y coordinates on a GstVideo.Navigation event. The event must be writable.

Since : 1.22

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.

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.

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

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.

Since : 1.6

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.

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.

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.

Since : 1.6

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.

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.

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.

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.

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.

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.

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

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.

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

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)

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

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.

GstVideo.NavigationMessageType

A set of notifications that may be received on the bus when navigation related status changes.

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.

Since : 1.22

GstVideo.NavigationQueryType

Types of navigation interface queries.