Interface

GstVideo-1.0 ▶ GstVideo ▶ NavigationNamespace

interface NavigationNamespace {
    $gtype: GType<GstVideo.Navigation>;
    prototype: GstVideo.Navigation;
    event_get_coordinates(event: Gst.Event): [boolean, number, number];
    event_get_type(event: Gst.Event): GstVideo.NavigationEventType;
    event_new_command(command: GstVideo.NavigationCommand): Gst.Event;
    event_new_key_press(
        key: string,
        state: GstVideo.NavigationModifierType,
    ): Gst.Event;
    event_new_key_release(
        key: string,
        state: GstVideo.NavigationModifierType,
    ): Gst.Event;
    event_new_mouse_button_press(
        button: number,
        x: number,
        y: number,
        state: GstVideo.NavigationModifierType,
    ): Gst.Event;
    event_new_mouse_button_release(
        button: number,
        x: number,
        y: number,
        state: GstVideo.NavigationModifierType,
    ): Gst.Event;
    event_new_mouse_move(
        x: number,
        y: number,
        state: GstVideo.NavigationModifierType,
    ): Gst.Event;
    event_new_mouse_scroll(
        x: number,
        y: number,
        delta_x: number,
        delta_y: number,
        state: GstVideo.NavigationModifierType,
    ): Gst.Event;
    event_new_touch_cancel(state: GstVideo.NavigationModifierType): Gst.Event;
    event_new_touch_down(
        identifier: number,
        x: number,
        y: number,
        pressure: number,
        state: GstVideo.NavigationModifierType,
    ): Gst.Event;
    event_new_touch_frame(state: GstVideo.NavigationModifierType): Gst.Event;
    event_new_touch_motion(
        identifier: number,
        x: number,
        y: number,
        pressure: number,
        state: GstVideo.NavigationModifierType,
    ): Gst.Event;
    event_new_touch_up(
        identifier: number,
        x: number,
        y: number,
        state: GstVideo.NavigationModifierType,
    ): Gst.Event;
    event_parse_command(
        event: Gst.Event,
    ): [boolean, GstVideo.NavigationCommand];
    event_parse_key_event(event: Gst.Event): [boolean, string];
    event_parse_modifier_state(
        event: Gst.Event,
        state: GstVideo.NavigationModifierType,
    ): boolean;
    event_parse_mouse_button_event(
        event: Gst.Event,
    ): [boolean, number, number, number];
    event_parse_mouse_move_event(event: Gst.Event): [boolean, number, number];
    event_parse_mouse_scroll_event(
        event: Gst.Event,
    ): [boolean, number, number, number, number];
    event_parse_touch_event(
        event: Gst.Event,
    ): [boolean, number, number, number, number];
    event_parse_touch_up_event(
        event: Gst.Event,
    ): [boolean, number, number, number];
    event_set_coordinates(event: Gst.Event, x: number, y: number): boolean;
    message_get_type(message: Gst.Message): GstVideo.NavigationMessageType;
    message_new_angles_changed(
        src: Gst.Object,
        cur_angle: number,
        n_angles: number,
    ): Gst.Message;
    message_new_commands_changed(src: Gst.Object): Gst.Message;
    message_new_event(src: Gst.Object, event: Gst.Event): Gst.Message;
    message_new_mouse_over(src: Gst.Object, active: boolean): Gst.Message;
    message_parse_angles_changed(
        message: Gst.Message,
    ): [boolean, number, number];
    message_parse_event(message: Gst.Message): [boolean, Gst.Event];
    message_parse_mouse_over(message: Gst.Message): [boolean, boolean];
    query_get_type(query: Query): GstVideo.NavigationQueryType;
    query_new_angles(): Query;
    query_new_commands(): Query;
    query_parse_angles(query: Query): [boolean, number, number];
    query_parse_commands_length(query: Query): [boolean, number];
    query_parse_commands_nth(
        query: Query,
        nth: number,
    ): [boolean, GstVideo.NavigationCommand];
    query_set_angles(query: Query, cur_angle: number, n_angles: number): void;
    query_set_commandsv(query: Query, cmds: GstVideo.NavigationCommand[]): void;
}

Index

Properties

$gtype prototype

Methods

event_get_coordinates event_get_type event_new_command event_new_key_press event_new_key_release event_new_mouse_button_press event_new_mouse_button_release event_new_mouse_move event_new_mouse_scroll event_new_touch_cancel event_new_touch_down event_new_touch_frame event_new_touch_motion event_new_touch_up event_parse_command event_parse_key_event event_parse_modifier_state event_parse_mouse_button_event event_parse_mouse_move_event event_parse_mouse_scroll_event event_parse_touch_event event_parse_touch_up_event event_set_coordinates message_get_type message_new_angles_changed message_new_commands_changed message_new_event message_new_mouse_over message_parse_angles_changed message_parse_event message_parse_mouse_over query_get_type query_new_angles query_new_commands query_parse_angles query_parse_commands_length query_parse_commands_nth query_set_angles query_set_commandsv

Properties

$gtype

$gtype: GType<GstVideo.Navigation>

prototype

prototype: GstVideo.Navigation

Methods

event_get_coordinates

event_get_coordinates(event: Gst.Event): [boolean, number, number]
Try to retrieve x and y coordinates of a GstVideo.Navigation event.
Parameters
- event: Gst.Event
  The Gst.Event to inspect.
Returns [boolean, number, number]
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9485

event_get_type

event_get_type(event: Gst.Event): GstVideo.NavigationEventType
Inspect a Gst.Event and return the GstVideo.NavigationEventType of the event, or #GST_NAVIGATION_EVENT_INVALID if the event is not a GstVideo.Navigation event.
Parameters
- event: Gst.Event
  A Gst.Event to inspect.
Returns GstVideo.NavigationEventType
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9491

event_new_command

event_new_command(command: GstVideo.NavigationCommand): Gst.Event
Create a new navigation event given navigation command..
Parameters
- command: GstVideo.NavigationCommand
  The navigation command to use.
Returns Gst.Event
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9496

event_new_key_press

event_new_key_press(
key: string,
state: GstVideo.NavigationModifierType,
): Gst.Event
Create a new navigation event for the given key press.
Parameters
- key: string
  A string identifying the key press.
- state: GstVideo.NavigationModifierType
  a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt).
Returns Gst.Event
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9502

event_new_key_release

event_new_key_release(
key: string,
state: GstVideo.NavigationModifierType,
): Gst.Event
Create a new navigation event for the given key release.
Parameters
- key: string
  A string identifying the released key.
- state: GstVideo.NavigationModifierType
  a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt).
Returns Gst.Event
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9508

event_new_mouse_button_press

event_new_mouse_button_press(
    button: number,
    x: number,
    y: number,
    state: GstVideo.NavigationModifierType,
): Gst.Event
Create a new navigation event for the given key mouse button press.
Parameters
- button: number
  The number of the pressed mouse button.
- x: number
  The x coordinate of the mouse cursor.
- y: number
  The y coordinate of the mouse cursor.
- state: GstVideo.NavigationModifierType
  a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt).
Returns Gst.Event
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9516

event_new_mouse_button_release

event_new_mouse_button_release(
    button: number,
    x: number,
    y: number,
    state: GstVideo.NavigationModifierType,
): Gst.Event
Create a new navigation event for the given key mouse button release.
Parameters
- button: number
  The number of the released mouse button.
- x: number
  The x coordinate of the mouse cursor.
- y: number
  The y coordinate of the mouse cursor.
- state: GstVideo.NavigationModifierType
  a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt).
Returns Gst.Event
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9524

event_new_mouse_move

event_new_mouse_move(
    x: number,
    y: number,
    state: GstVideo.NavigationModifierType,
): Gst.Event
Create a new navigation event for the new mouse location.
Parameters
- x: number
  The x coordinate of the mouse cursor.
- y: number
  The y coordinate of the mouse cursor.
- state: GstVideo.NavigationModifierType
  a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt).
Returns Gst.Event
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9531

event_new_mouse_scroll

event_new_mouse_scroll(
    x: number,
    y: number,
    delta_x: number,
    delta_y: number,
    state: GstVideo.NavigationModifierType,
): Gst.Event
Create a new navigation event for the mouse scroll.
Parameters
- x: number
  The x coordinate of the mouse cursor.
- y: number
  The y coordinate of the mouse cursor.
- delta_x: number
  The x component of the scroll movement.
- delta_y: number
  The y component of the scroll movement.
- state: GstVideo.NavigationModifierType
  a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt).
Returns Gst.Event
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9540

event_new_touch_cancel

event_new_touch_cancel(state: GstVideo.NavigationModifierType): Gst.Event
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.
Parameters
- state: GstVideo.NavigationModifierType
  a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt).
Returns Gst.Event
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9554

event_new_touch_down

event_new_touch_down(
    identifier: number,
    x: number,
    y: number,
    pressure: number,
    state: GstVideo.NavigationModifierType,
): Gst.Event
Create a new navigation event for an added touch point.
Parameters
- identifier: number
  A number uniquely identifying this touch point. It must stay unique to this touch point at least until an up event is sent for the same identifier, or all touch points are cancelled.
- x: number
  The x coordinate of the new touch point.
- y: number
  The y coordinate of the new touch point.
- pressure: number
  Pressure data of the touch point, from 0.0 to 1.0, or NaN if no data is available.
- state: GstVideo.NavigationModifierType
  a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt).
Returns Gst.Event
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9563

event_new_touch_frame

event_new_touch_frame(state: GstVideo.NavigationModifierType): Gst.Event
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.
Parameters
- state: GstVideo.NavigationModifierType
  a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt).
Returns Gst.Event
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9576

event_new_touch_motion

event_new_touch_motion(
    identifier: number,
    x: number,
    y: number,
    pressure: number,
    state: GstVideo.NavigationModifierType,
): Gst.Event
Create a new navigation event for a moved touch point.
Parameters
- identifier: number
  A number uniquely identifying this touch point. It must correlate to exactly one previous touch_start event.
- x: number
  The x coordinate of the touch point.
- y: number
  The y coordinate of the touch point.
- pressure: number
  Pressure data of the touch point, from 0.0 to 1.0, or NaN if no data is available.
- state: GstVideo.NavigationModifierType
  a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt).
Returns Gst.Event
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9585

event_new_touch_up

event_new_touch_up(
    identifier: number,
    x: number,
    y: number,
    state: GstVideo.NavigationModifierType,
): Gst.Event
Create a new navigation event for a removed touch point.
Parameters
- identifier: number
  A number uniquely identifying this touch point. It must correlate to exactly one previous down event, but can be reused after sending this event.
- x: number
  The x coordinate of the touch point.
- y: number
  The y coordinate of the touch point.
- state: GstVideo.NavigationModifierType
  a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt).
Returns Gst.Event
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9599

event_parse_command

event_parse_command(event: Gst.Event): [boolean, GstVideo.NavigationCommand]
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 [boolean, GstVideo.NavigationCommand]
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9605

event_parse_key_event

event_parse_key_event(event: Gst.Event): [boolean, string]
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
Parameters
- event: Gst.Event
  A Gst.Event to inspect.
Returns [boolean, string]
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9613

event_parse_modifier_state

event_parse_modifier_state(
event: Gst.Event,
state: GstVideo.NavigationModifierType,
): boolean
Parameters
- event: Gst.Event
  The Gst.Event to modify.
- state: GstVideo.NavigationModifierType
  a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt).
Returns boolean
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9618

event_parse_mouse_button_event

event_parse_mouse_button_event(
event: Gst.Event,
): [boolean, number, number, number]
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 gst_navigation_event_get_type() to retrieve the GstVideo.NavigationEventType.
Parameters
- event: Gst.Event
  A Gst.Event to inspect.
Returns [boolean, number, number, number]
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9625

event_parse_mouse_move_event

event_parse_mouse_move_event(event: Gst.Event): [boolean, number, number]
Inspect a GstVideo.Navigation mouse movement event and extract the coordinates of the event.
Parameters
- event: Gst.Event
  A Gst.Event to inspect.
Returns [boolean, number, number]
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9631

event_parse_mouse_scroll_event

event_parse_mouse_scroll_event(
event: Gst.Event,
): [boolean, number, number, number, number]
Inspect a GstVideo.Navigation mouse scroll event and extract the coordinates of the event.
Parameters
- event: Gst.Event
  A Gst.Event to inspect.
Returns [boolean, number, number, number, number]
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9637

event_parse_touch_event

event_parse_touch_event(
event: Gst.Event,
): [boolean, number, number, number, number]
Retrieve the details of a GstVideo.Navigation touch-down or touch-motion event. Determine which type the event is using gst_navigation_event_get_type() to retrieve the GstVideo.NavigationEventType.
Parameters
- event: Gst.Event
  A Gst.Event to inspect.
Returns [boolean, number, number, number, number]
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9644

event_parse_touch_up_event

event_parse_touch_up_event(event: Gst.Event): [boolean, number, number, number]
Retrieve the details of a GstVideo.Navigation touch-up event.
Parameters
- event: Gst.Event
  A Gst.Event to inspect.
Returns [boolean, number, number, number]
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9649

event_set_coordinates

event_set_coordinates(event: Gst.Event, x: number, y: number): boolean
Try to set x and y coordinates on a GstVideo.Navigation event. The event must be writable.
Parameters
- event: Gst.Event
  The Gst.Event to modify.
- x: number
  The x coordinate to set.
- y: number
  The y coordinate to set.
Returns boolean
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9657

message_get_type

message_get_type(message: Gst.Message): GstVideo.NavigationMessageType
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.
Returns GstVideo.NavigationMessageType
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9663

message_new_angles_changed

message_new_angles_changed(
    src: Gst.Object,
    cur_angle: number,
    n_angles: number,
): Gst.Message
Creates a new GstVideo.Navigation 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: 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
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9673

message_new_commands_changed

message_new_commands_changed(src: Gst.Object): Gst.Message
Creates a new GstVideo.Navigation message with type #GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED
Parameters
- src: Gst.Object
  A Gst.Object to set as source of the new message.
Returns Gst.Message
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9679

message_new_event

message_new_event(src: Gst.Object, event: Gst.Event): Gst.Message
Creates a new GstVideo.Navigation message with type #GST_NAVIGATION_MESSAGE_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
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9686

message_new_mouse_over

message_new_mouse_over(src: Gst.Object, active: boolean): Gst.Message
Creates a new GstVideo.Navigation message with type #GST_NAVIGATION_MESSAGE_MOUSE_OVER.
Parameters
- src: Gst.Object
  A Gst.Object to set as source of the new message.
- active: boolean
  true if the mouse has entered a clickable area of the display. false if it over a non-clickable area.
Returns Gst.Message
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9693

message_parse_angles_changed

message_parse_angles_changed(message: Gst.Message): [boolean, number, number]
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 [boolean, number, number]
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9699

message_parse_event

message_parse_event(message: Gst.Message): [boolean, Gst.Event]
Parse a GstVideo.Navigation message of type #GST_NAVIGATION_MESSAGE_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 [boolean, Gst.Event]
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9706

message_parse_mouse_over

message_parse_mouse_over(message: Gst.Message): [boolean, boolean]
Parse a GstVideo.Navigation 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: Gst.Message
  A Gst.Message to inspect.
Returns [boolean, boolean]
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9713

query_get_type

query_get_type(query: Query): GstVideo.NavigationQueryType
Inspect a Gst.Query and return the GstVideo.NavigationQueryType associated with it if it is a GstVideo.Navigation query.
Parameters
- query: Query
  The query to inspect
Returns GstVideo.NavigationQueryType
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9719

query_new_angles

query_new_angles(): Query
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 Query
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9725

query_new_commands

query_new_commands(): Query
Create a new GstVideo.Navigation commands query. When executed, it will query the pipeline for the set of currently available commands.

Returns Query
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9730

query_parse_angles

query_parse_angles(query: Query): [boolean, number, number]
Parse the current angle number in the GstVideo.Navigation 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: Query
  a Gst.Query
Returns [boolean, number, number]
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9737

query_parse_commands_length

query_parse_commands_length(query: Query): [boolean, number]
Parse the number of commands in the GstVideo.Navigation commands query.
Parameters
- query: Query
  a Gst.Query
Returns [boolean, number]
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9742

query_parse_commands_nth

query_parse_commands_nth(
query: Query,
nth: number,
): [boolean, GstVideo.NavigationCommand]
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 #GST_NAVIGATION_COMMAND_INVALID.
Parameters
- query: Query
  a Gst.Query
- nth: number
  the nth command to retrieve.
Returns [boolean, GstVideo.NavigationCommand]
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9750

query_set_angles

query_set_angles(query: Query, cur_angle: number, n_angles: number): void
Set the GstVideo.Navigation angles query result field in query.
Parameters
- query: Query
  a Gst.Query
- cur_angle: number
  the current viewing angle to set.
- n_angles: number
  the number of viewing angles to set.
Returns void
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9757

query_set_commandsv

query_set_commandsv(query: Query, cmds: GstVideo.NavigationCommand[]): void
Set the GstVideo.Navigation command query result fields in query. The number of commands passed must be equal to n_commands.
Parameters
- query: Query
  a Gst.Query
- cmds: GstVideo.NavigationCommand[]
  An array containing n_cmds GstNavigationCommand values.
Returns void
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9764

GstVideo-1.0 ▶ GstVideo ▶ NavigationNamespace

Index

Properties

Methods

Properties

$gtype

prototype

Methods

event_get_coordinates

Parameters

Returns [boolean, number, number]

event_get_type

Parameters

Returns GstVideo.NavigationEventType

event_new_command

Parameters

Returns Gst.Event

event_new_key_press

Parameters

Returns Gst.Event

event_new_key_release

Parameters

Returns Gst.Event

event_new_mouse_button_press

Parameters

Returns Gst.Event

event_new_mouse_button_release

Parameters

Returns Gst.Event

event_new_mouse_move

Parameters

Returns Gst.Event

event_new_mouse_scroll

Parameters

Returns Gst.Event

event_new_touch_cancel

Parameters

Returns Gst.Event

event_new_touch_down

Parameters

Returns Gst.Event

event_new_touch_frame

Parameters

Returns Gst.Event

event_new_touch_motion

Parameters

Returns Gst.Event

event_new_touch_up

Parameters

Returns Gst.Event

event_parse_command

Parameters

Returns [boolean, GstVideo.NavigationCommand]

event_parse_key_event

Parameters

Returns [boolean, string]

event_parse_modifier_state

Parameters

Returns boolean

event_parse_mouse_button_event

Parameters

Returns [boolean, number, number, number]

event_parse_mouse_move_event

Parameters

Returns [boolean, number, number]

event_parse_mouse_scroll_event

Parameters

Returns [boolean, number, number, number, number]

event_parse_touch_event

Parameters

Returns [boolean, number, number, number, number]

event_parse_touch_up_event

Parameters

Returns [boolean, number, number, number]

event_set_coordinates

Parameters

Returns boolean

message_get_type

Parameters

Returns GstVideo.NavigationMessageType