Table of Contents

Class Navigation

Namespace
GstVideo.Internal
Assembly
GstVideo-1.0.dll
public class Navigation
Inheritance
Navigation
Inherited Members

Methods

EventGetCoordinates(EventHandle, out double, out double)

Calls native function gst_navigation_event_get_coordinates. Version: 1.22

[Version("1.22")]
public static extern bool EventGetCoordinates(EventHandle @event, out double x, out double y)

Parameters

event EventHandle
x double

Transfer ownership: Full Nullable: False

y double

Transfer ownership: Full Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

EventGetType(EventHandle)

Calls native function gst_navigation_event_get_type.

public static extern NavigationEventType EventGetType(EventHandle @event)

Parameters

event EventHandle

Returns

NavigationEventType

Transfer ownership: None Nullable: False

EventNewCommand(NavigationCommand)

Calls native function gst_navigation_event_new_command. Version: 1.22

[Version("1.22")]
public static extern EventOwnedHandle EventNewCommand(NavigationCommand command)

Parameters

command NavigationCommand

Transfer ownership: None Nullable: False

Returns

EventOwnedHandle

Transfer ownership: Full Nullable: False

EventNewKeyPress(NonNullableUtf8StringHandle, NavigationModifierType)

Calls native function gst_navigation_event_new_key_press. Version: 1.22

[Version("1.22")]
public static extern EventOwnedHandle EventNewKeyPress(NonNullableUtf8StringHandle key, NavigationModifierType state)

Parameters

key NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

state NavigationModifierType

Transfer ownership: None Nullable: False

Returns

EventOwnedHandle

Transfer ownership: Full Nullable: False

EventNewKeyRelease(NonNullableUtf8StringHandle, NavigationModifierType)

Calls native function gst_navigation_event_new_key_release. Version: 1.22

[Version("1.22")]
public static extern EventOwnedHandle EventNewKeyRelease(NonNullableUtf8StringHandle key, NavigationModifierType state)

Parameters

key NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

state NavigationModifierType

Transfer ownership: None Nullable: False

Returns

EventOwnedHandle

Transfer ownership: Full Nullable: False

EventNewMouseButtonPress(int, double, double, NavigationModifierType)

Calls native function gst_navigation_event_new_mouse_button_press. Version: 1.22

[Version("1.22")]
public static extern EventOwnedHandle EventNewMouseButtonPress(int button, double x, double y, NavigationModifierType state)

Parameters

button int

Transfer ownership: None Nullable: False

x double

Transfer ownership: None Nullable: False

y double

Transfer ownership: None Nullable: False

state NavigationModifierType

Transfer ownership: None Nullable: False

Returns

EventOwnedHandle

Transfer ownership: Full Nullable: False

EventNewMouseButtonRelease(int, double, double, NavigationModifierType)

Calls native function gst_navigation_event_new_mouse_button_release. Version: 1.22

[Version("1.22")]
public static extern EventOwnedHandle EventNewMouseButtonRelease(int button, double x, double y, NavigationModifierType state)

Parameters

button int

Transfer ownership: None Nullable: False

x double

Transfer ownership: None Nullable: False

y double

Transfer ownership: None Nullable: False

state NavigationModifierType

Transfer ownership: None Nullable: False

Returns

EventOwnedHandle

Transfer ownership: Full Nullable: False

EventNewMouseMove(double, double, NavigationModifierType)

Calls native function gst_navigation_event_new_mouse_move. Version: 1.22

[Version("1.22")]
public static extern EventOwnedHandle EventNewMouseMove(double x, double y, NavigationModifierType state)

Parameters

x double

Transfer ownership: None Nullable: False

y double

Transfer ownership: None Nullable: False

state NavigationModifierType

Transfer ownership: None Nullable: False

Returns

EventOwnedHandle

Transfer ownership: Full Nullable: False

EventNewMouseScroll(double, double, double, double, NavigationModifierType)

Calls native function gst_navigation_event_new_mouse_scroll. Version: 1.22

[Version("1.22")]
public static extern EventOwnedHandle EventNewMouseScroll(double x, double y, double deltaX, double deltaY, NavigationModifierType state)

Parameters

x double

Transfer ownership: None Nullable: False

y double

Transfer ownership: None Nullable: False

deltaX double

Transfer ownership: None Nullable: False

deltaY double

Transfer ownership: None Nullable: False

state NavigationModifierType

Transfer ownership: None Nullable: False

Returns

EventOwnedHandle

Transfer ownership: Full Nullable: False

EventNewTouchCancel(NavigationModifierType)

Calls native function gst_navigation_event_new_touch_cancel. Version: 1.22

[Version("1.22")]
public static extern EventOwnedHandle EventNewTouchCancel(NavigationModifierType state)

Parameters

state NavigationModifierType

Transfer ownership: None Nullable: False

Returns

EventOwnedHandle

Transfer ownership: Full Nullable: False

EventNewTouchDown(uint, double, double, double, NavigationModifierType)

Calls native function gst_navigation_event_new_touch_down. Version: 1.22

[Version("1.22")]
public static extern EventOwnedHandle EventNewTouchDown(uint identifier, double x, double y, double pressure, NavigationModifierType state)

Parameters

identifier uint

Transfer ownership: None Nullable: False

x double

Transfer ownership: None Nullable: False

y double

Transfer ownership: None Nullable: False

pressure double

Transfer ownership: None Nullable: False

state NavigationModifierType

Transfer ownership: None Nullable: False

Returns

EventOwnedHandle

Transfer ownership: Full Nullable: False

EventNewTouchFrame(NavigationModifierType)

Calls native function gst_navigation_event_new_touch_frame. Version: 1.22

[Version("1.22")]
public static extern EventOwnedHandle EventNewTouchFrame(NavigationModifierType state)

Parameters

state NavigationModifierType

Transfer ownership: None Nullable: False

Returns

EventOwnedHandle

Transfer ownership: Full Nullable: False

EventNewTouchMotion(uint, double, double, double, NavigationModifierType)

Calls native function gst_navigation_event_new_touch_motion. Version: 1.22

[Version("1.22")]
public static extern EventOwnedHandle EventNewTouchMotion(uint identifier, double x, double y, double pressure, NavigationModifierType state)

Parameters

identifier uint

Transfer ownership: None Nullable: False

x double

Transfer ownership: None Nullable: False

y double

Transfer ownership: None Nullable: False

pressure double

Transfer ownership: None Nullable: False

state NavigationModifierType

Transfer ownership: None Nullable: False

Returns

EventOwnedHandle

Transfer ownership: Full Nullable: False

EventNewTouchUp(uint, double, double, NavigationModifierType)

Calls native function gst_navigation_event_new_touch_up. Version: 1.22

[Version("1.22")]
public static extern EventOwnedHandle EventNewTouchUp(uint identifier, double x, double y, NavigationModifierType state)

Parameters

identifier uint

Transfer ownership: None Nullable: False

x double

Transfer ownership: None Nullable: False

y double

Transfer ownership: None Nullable: False

state NavigationModifierType

Transfer ownership: None Nullable: False

Returns

EventOwnedHandle

Transfer ownership: Full Nullable: False

EventParseCommand(EventHandle, out IntPtr)

Calls native function gst_navigation_event_parse_command.

public static extern bool EventParseCommand(EventHandle @event, out IntPtr command)

Parameters

event EventHandle
command IntPtr

Transfer ownership: Full Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

EventParseKeyEvent(EventHandle, out NonNullableUtf8StringUnownedHandle)

Calls native function gst_navigation_event_parse_key_event.

public static extern bool EventParseKeyEvent(EventHandle @event, out NonNullableUtf8StringUnownedHandle key)

Parameters

event EventHandle
key NonNullableUtf8StringUnownedHandle

Transfer ownership: None Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

EventParseModifierState(EventHandle, ref NavigationModifierType)

Calls native function gst_navigation_event_parse_modifier_state. Version: 1.22

[Version("1.22")]
public static extern bool EventParseModifierState(EventHandle @event, ref NavigationModifierType state)

Parameters

event EventHandle
state NavigationModifierType

Transfer ownership: None Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

EventParseMouseButtonEvent(EventHandle, out int, out double, out double)

Calls native function gst_navigation_event_parse_mouse_button_event.

public static extern bool EventParseMouseButtonEvent(EventHandle @event, out int button, out double x, out double y)

Parameters

event EventHandle
button int

Transfer ownership: Full Nullable: False

x double

Transfer ownership: Full Nullable: False

y double

Transfer ownership: Full Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

EventParseMouseMoveEvent(EventHandle, out double, out double)

Calls native function gst_navigation_event_parse_mouse_move_event.

public static extern bool EventParseMouseMoveEvent(EventHandle @event, out double x, out double y)

Parameters

event EventHandle
x double

Transfer ownership: Full Nullable: False

y double

Transfer ownership: Full Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

EventParseMouseScrollEvent(EventHandle, out double, out double, out double, out double)

Calls native function gst_navigation_event_parse_mouse_scroll_event. Version: 1.18

[Version("1.18")]
public static extern bool EventParseMouseScrollEvent(EventHandle @event, out double x, out double y, out double deltaX, out double deltaY)

Parameters

event EventHandle
x double

Transfer ownership: Full Nullable: False

y double

Transfer ownership: Full Nullable: False

deltaX double

Transfer ownership: Full Nullable: False

deltaY double

Transfer ownership: Full Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

EventParseTouchEvent(EventHandle, out uint, out double, out double, out double)

Calls native function gst_navigation_event_parse_touch_event. Version: 1.22

[Version("1.22")]
public static extern bool EventParseTouchEvent(EventHandle @event, out uint identifier, out double x, out double y, out double pressure)

Parameters

event EventHandle
identifier uint

Transfer ownership: Full Nullable: False

x double

Transfer ownership: Full Nullable: False

y double

Transfer ownership: Full Nullable: False

pressure double

Transfer ownership: Full Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

EventParseTouchUpEvent(EventHandle, out uint, out double, out double)

Calls native function gst_navigation_event_parse_touch_up_event. Version: 1.22

[Version("1.22")]
public static extern bool EventParseTouchUpEvent(EventHandle @event, out uint identifier, out double x, out double y)

Parameters

event EventHandle
identifier uint

Transfer ownership: Full Nullable: False

x double

Transfer ownership: Full Nullable: False

y double

Transfer ownership: Full Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

EventSetCoordinates(EventHandle, double, double)

Calls native function gst_navigation_event_set_coordinates. Version: 1.22

[Version("1.22")]
public static extern bool EventSetCoordinates(EventHandle @event, double x, double y)

Parameters

event EventHandle
x double

Transfer ownership: None Nullable: False

y double

Transfer ownership: None Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

GetGType()

Calls native function gst_navigation_get_type.

public static extern nuint GetGType()

Returns

nuint

Transfer ownership: None Nullable: False

MessageGetType(MessageHandle)

Calls native function gst_navigation_message_get_type.

public static extern NavigationMessageType MessageGetType(MessageHandle message)

Parameters

message MessageHandle

Transfer ownership: None Nullable: False

Returns

NavigationMessageType

Transfer ownership: None Nullable: False

MessageNewAnglesChanged(IntPtr, uint, uint)

Calls native function gst_navigation_message_new_angles_changed.

public static extern MessageOwnedHandle MessageNewAnglesChanged(IntPtr src, uint curAngle, uint nAngles)

Parameters

src IntPtr

Transfer ownership: None Nullable: False

curAngle uint

Transfer ownership: None Nullable: False

nAngles uint

Transfer ownership: None Nullable: False

Returns

MessageOwnedHandle

Transfer ownership: Full Nullable: False

MessageNewCommandsChanged(IntPtr)

Calls native function gst_navigation_message_new_commands_changed.

public static extern MessageOwnedHandle MessageNewCommandsChanged(IntPtr src)

Parameters

src IntPtr

Transfer ownership: None Nullable: False

Returns

MessageOwnedHandle

Transfer ownership: Full Nullable: False

MessageNewEvent(IntPtr, EventHandle)

Calls native function gst_navigation_message_new_event. Version: 1.6

[Version("1.6")]
public static extern MessageOwnedHandle MessageNewEvent(IntPtr src, EventHandle @event)

Parameters

src IntPtr

Transfer ownership: None Nullable: False

event EventHandle

Returns

MessageOwnedHandle

Transfer ownership: Full Nullable: False

MessageNewMouseOver(IntPtr, bool)

Calls native function gst_navigation_message_new_mouse_over.

public static extern MessageOwnedHandle MessageNewMouseOver(IntPtr src, bool active)

Parameters

src IntPtr

Transfer ownership: None Nullable: False

active bool

Transfer ownership: None Nullable: False

Returns

MessageOwnedHandle

Transfer ownership: Full Nullable: False

MessageParseAnglesChanged(MessageHandle, out uint, out uint)

Calls native function gst_navigation_message_parse_angles_changed.

public static extern bool MessageParseAnglesChanged(MessageHandle message, out uint curAngle, out uint nAngles)

Parameters

message MessageHandle

Transfer ownership: None Nullable: False

curAngle uint

Transfer ownership: Full Nullable: False

nAngles uint

Transfer ownership: Full Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

MessageParseMouseOver(MessageHandle, out bool)

Calls native function gst_navigation_message_parse_mouse_over.

public static extern bool MessageParseMouseOver(MessageHandle message, out bool active)

Parameters

message MessageHandle

Transfer ownership: None Nullable: False

active bool

Transfer ownership: Full Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

QueryGetType(QueryHandle)

Calls native function gst_navigation_query_get_type.

public static extern NavigationQueryType QueryGetType(QueryHandle query)

Parameters

query QueryHandle

Transfer ownership: None Nullable: False

Returns

NavigationQueryType

Transfer ownership: None Nullable: False

QueryNewAngles()

Calls native function gst_navigation_query_new_angles.

public static extern QueryOwnedHandle QueryNewAngles()

Returns

QueryOwnedHandle

Transfer ownership: Full Nullable: False

QueryNewCommands()

Calls native function gst_navigation_query_new_commands.

public static extern QueryOwnedHandle QueryNewCommands()

Returns

QueryOwnedHandle

Transfer ownership: Full Nullable: False

QueryParseAngles(QueryHandle, out uint, out uint)

Calls native function gst_navigation_query_parse_angles.

public static extern bool QueryParseAngles(QueryHandle query, out uint curAngle, out uint nAngles)

Parameters

query QueryHandle

Transfer ownership: None Nullable: False

curAngle uint

Transfer ownership: Full Nullable: False

nAngles uint

Transfer ownership: Full Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

QueryParseCommandsLength(QueryHandle, out uint)

Calls native function gst_navigation_query_parse_commands_length.

public static extern bool QueryParseCommandsLength(QueryHandle query, out uint nCmds)

Parameters

query QueryHandle

Transfer ownership: None Nullable: False

nCmds uint

Transfer ownership: Full Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

QueryParseCommandsNth(QueryHandle, uint, out IntPtr)

Calls native function gst_navigation_query_parse_commands_nth.

public static extern bool QueryParseCommandsNth(QueryHandle query, uint nth, out IntPtr cmd)

Parameters

query QueryHandle

Transfer ownership: None Nullable: False

nth uint

Transfer ownership: None Nullable: False

cmd IntPtr

Transfer ownership: Full Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

QuerySetAngles(QueryHandle, uint, uint)

Calls native function gst_navigation_query_set_angles.

public static extern void QuerySetAngles(QueryHandle query, uint curAngle, uint nAngles)

Parameters

query QueryHandle

Transfer ownership: None Nullable: False

curAngle uint

Transfer ownership: None Nullable: False

nAngles uint

Transfer ownership: None Nullable: False

QuerySetCommandsv(QueryHandle, int, NavigationCommand[])

Calls native function gst_navigation_query_set_commandsv.

public static extern void QuerySetCommandsv(QueryHandle query, int nCmds, NavigationCommand[] cmds)

Parameters

query QueryHandle

Transfer ownership: None Nullable: False

nCmds int

Transfer ownership: None Nullable: False

cmds NavigationCommand[]

Transfer ownership: None Nullable: False

SendCommand(IntPtr, NavigationCommand)

Calls native method gst_navigation_send_command.

public static extern void SendCommand(IntPtr navigation, NavigationCommand command)

Parameters

navigation IntPtr

Transfer ownership: None Nullable: False

command NavigationCommand

Transfer ownership: None Nullable: False

SendEvent(IntPtr, StructureHandle)

Calls native method gst_navigation_send_event.

public static extern void SendEvent(IntPtr navigation, StructureHandle structure)

Parameters

navigation IntPtr

Transfer ownership: None Nullable: False

structure StructureHandle

Transfer ownership: None Nullable: False

SendEventSimple(IntPtr, EventUnownedHandle)

Calls native method gst_navigation_send_event_simple. Version: 1.22

[Version("1.22")]
public static extern void SendEventSimple(IntPtr navigation, EventUnownedHandle @event)

Parameters

navigation IntPtr

Transfer ownership: None Nullable: False

event EventUnownedHandle

SendKeyEvent(IntPtr, NonNullableUtf8StringHandle, NonNullableUtf8StringHandle)

Calls native method gst_navigation_send_key_event.

public static extern void SendKeyEvent(IntPtr navigation, NonNullableUtf8StringHandle @event, NonNullableUtf8StringHandle key)

Parameters

navigation IntPtr

Transfer ownership: None Nullable: False

event NonNullableUtf8StringHandle
key NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

SendMouseEvent(IntPtr, NonNullableUtf8StringHandle, int, double, double)

Calls native method gst_navigation_send_mouse_event.

public static extern void SendMouseEvent(IntPtr navigation, NonNullableUtf8StringHandle @event, int button, double x, double y)

Parameters

navigation IntPtr

Transfer ownership: None Nullable: False

event NonNullableUtf8StringHandle
button int

Transfer ownership: None Nullable: False

x double

Transfer ownership: None Nullable: False

y double

Transfer ownership: None Nullable: False

SendMouseScrollEvent(IntPtr, double, double, double, double)

Calls native method gst_navigation_send_mouse_scroll_event. Version: 1.18

[Version("1.18")]
public static extern void SendMouseScrollEvent(IntPtr navigation, double x, double y, double deltaX, double deltaY)

Parameters

navigation IntPtr

Transfer ownership: None Nullable: False

x double

Transfer ownership: None Nullable: False

y double

Transfer ownership: None Nullable: False

deltaX double

Transfer ownership: None Nullable: False

deltaY double

Transfer ownership: None Nullable: False