Meta Developers

Ffi Class

See Also:

Public Types

enum	Result { Result.Success = 0, Result.Error = -1, Result.InstanceInitializationFailed = -2, Result.InstanceAlreadyInitialized = -3, Result.InstanceAlreadyUninitialized = -4, Result.InstanceNotInitialized = -5, Result.InvalidUtf8 = -6, Result.LoadClipFailed = -7, Result.CreatePlayerFailed = -8, Result.ClipIdInvalid = -9, Result.PlayerIdInvalid = -10, Result.PlayerInvalidAmplitude = -11, Result.PlayerInvalidFrequencyShift = -12, Result.PlayerInvalidPriority = -13, Result.NoClipLoaded = -14 }
enum	Controller { Controller.Left = 0, Controller.Right = 1, Controller.Both = 2 }
enum	LogLevel { LogLevel.Trace = 0, LogLevel.Debug = 1, LogLevel.Info = 2, LogLevel.Warn = 3, LogLevel.Error = 4 }

Data Fields

const int

InvalidId[Get]

Static Public Member Functions

static bool	Succeeded ( Result result )
static bool	Failed ( Result result )
static Result	initialize_with_ovr_plugin ( string game_engine_name, string game_engine_version, string game_engine_haptics_sdk_version )
static string	error_message ( )
static Result	load_clip ( string data, out int clip_id_out )

Public Member Functions

delegate void	LogCallback ( LogLevel level, string message )
SdkVersion	version ( )
Result	initialize_logging ( LogCallback? logCallback )
Result	initialize_with_null_backend ( )
Result	uninitialize ( )
Result	initialized ( out bool initialized )
Result	set_suspended ( bool suspended )
Result	clip_duration ( int clipId, out float clip_duration )
Result	release_clip ( int clipId )
Result	create_player ( out int player_id )
Result	release_player ( int playerId )
Result	player_set_clip ( int playerId, int clipId )
Result	player_play ( int playerId, Controller controller )
Result	player_stop ( int playerId )
Result	player_set_amplitude ( int playerId, float amplitude )
Result	player_amplitude ( int playerId, out float amplitude )
Result	player_set_frequency_shift ( int playerId, float amount )
Result	player_frequency_shift ( int playerId, out float frequency_shift )
Result	player_set_looping_enabled ( int playerId, bool enabled )
Result	player_looping_enabled ( int playerId, out bool looping_enabled )
Result	player_set_priority ( int playerId, uint priority )
Result	player_priority ( int playerId, out uint priority )
NullBackendStatistics	get_null_backend_statistics ( )

Member Enumerations

enum Oculus::Haptics::Ffi.Result

Enumerator

Success	= 0
Error	= -1
InstanceInitializationFailed	= -2
InstanceAlreadyInitialized	= -3
InstanceAlreadyUninitialized	= -4
InstanceNotInitialized	= -5
InvalidUtf8	= -6
LoadClipFailed	= -7
CreatePlayerFailed	= -8
ClipIdInvalid	= -9
PlayerIdInvalid	= -10
PlayerInvalidAmplitude	= -11
PlayerInvalidFrequencyShift	= -12
PlayerInvalidPriority	= -13
NoClipLoaded	= -14

enum Oculus::Haptics::Ffi.Controller

Enumerator

Left	= 0
Right	= 1
Both	= 2

enum Oculus::Haptics::Ffi.LogLevel

Enumerator

Trace	= 0
Debug	= 1
Info	= 2
Warn	= 3
Error	= 4

Fields

const int Oculus.Haptics.Ffi.InvalidId
No description available.

Static Member Functions

static bool Oculus.Haptics.Ffi.Succeeded ( Result result )
No description available.

static bool Oculus.Haptics.Ffi.Failed ( Result result )
No description available.

static Result Oculus.Haptics.Ffi.initialize_with_ovr_plugin ( string game_engine_name, string game_engine_version, string game_engine_haptics_sdk_version )
No description available.

static string Oculus.Haptics.Ffi.error_message ( )
No description available.

static Result Oculus.Haptics.Ffi.load_clip ( string data, out int clip_id_out )
No description available.

Member Functions

delegate void Oculus.Haptics.Ffi.LogCallback ( LogLevel level, string message )
No description available.

static SdkVersion Oculus.Haptics.Ffi.version ( )
No description available.

static Result Oculus.Haptics.Ffi.initialize_logging ( LogCallback? logCallback )
No description available.

static Result Oculus.Haptics.Ffi.initialize_with_null_backend ( )
No description available.

static Result Oculus.Haptics.Ffi.uninitialize ( )
No description available.

static Result Oculus.Haptics.Ffi.initialized ( out bool initialized )
No description available.

static Result Oculus.Haptics.Ffi.set_suspended ( bool suspended )
No description available.

static Result Oculus.Haptics.Ffi.clip_duration ( int clipId, out float clip_duration )
No description available.

static Result Oculus.Haptics.Ffi.release_clip ( int clipId )
No description available.

static Result Oculus.Haptics.Ffi.create_player ( out int player_id )
No description available.

static Result Oculus.Haptics.Ffi.release_player ( int playerId )
No description available.

static Result Oculus.Haptics.Ffi.player_set_clip ( int playerId, int clipId )
No description available.

static Result Oculus.Haptics.Ffi.player_play ( int playerId, Controller controller )
No description available.

static Result Oculus.Haptics.Ffi.player_stop ( int playerId )
No description available.

static Result Oculus.Haptics.Ffi.player_set_amplitude ( int playerId, float amplitude )
No description available.

static Result Oculus.Haptics.Ffi.player_amplitude ( int playerId, out float amplitude )
No description available.

static Result Oculus.Haptics.Ffi.player_set_frequency_shift ( int playerId, float amount )
No description available.

static Result Oculus.Haptics.Ffi.player_frequency_shift ( int playerId, out float frequency_shift )
No description available.

static Result Oculus.Haptics.Ffi.player_set_looping_enabled ( int playerId, bool enabled )
No description available.

static Result Oculus.Haptics.Ffi.player_looping_enabled ( int playerId, out bool looping_enabled )
No description available.

static Result Oculus.Haptics.Ffi.player_set_priority ( int playerId, uint priority )
No description available.

static Result Oculus.Haptics.Ffi.player_priority ( int playerId, out uint priority )
No description available.

static NullBackendStatistics Oculus.Haptics.Ffi.get_null_backend_statistics ( )
No description available.