API reference

Ffi Class

Member Enumerations

Enumeration Result

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

Enumeration Controller

Left
= 0
Right
= 1
Both
= 2

Enumeration LogLevel

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

Fields

const int InvalidId[Get]

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

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 ( )
Did you find this page helpful?
Thumbs up icon
Thumbs down icon