API reference

Ffi Class

Fields

InvalidId : const int
Signature
const int Oculus.Haptics.Ffi.InvalidId

Methods

clip_duration ( clipId , clip_duration )
Signature
static Result Oculus.Haptics.Ffi.clip_duration(int clipId, out float clip_duration)
Parameters
clipId: int
clip_duration: out float
Returns
Result
create_player ( player_id )
Signature
static Result Oculus.Haptics.Ffi.create_player(out int player_id)
Parameters
player_id: out int
Returns
Result
get_null_backend_statistics ()
Signature
static NullBackendStatistics Oculus.Haptics.Ffi.get_null_backend_statistics()
Returns
NullBackendStatistics
initialize_logging ( logCallback )
Signature
static Result Oculus.Haptics.Ffi.initialize_logging([MarshalAs(UnmanagedType.FunctionPtr)] LogCallback? logCallback)
Parameters
logCallback: LogCallback?
Returns
Result
initialize_with_null_backend ()
Signature
static Result Oculus.Haptics.Ffi.initialize_with_null_backend()
Returns
Result
initialized ( initialized )
Signature
static Result Oculus.Haptics.Ffi.initialized(out bool initialized)
Parameters
initialized: out bool
Returns
Result
LogCallback ( level , message )
Signature
delegate void Oculus.Haptics.Ffi.LogCallback(LogLevel level, string message)
Parameters
level: LogLevel
message: string
Returns
delegate void
player_amplitude ( playerId , amplitude )
Signature
static Result Oculus.Haptics.Ffi.player_amplitude(int playerId, out float amplitude)
Parameters
playerId: int
amplitude: out float
Returns
Result
player_frequency_shift ( playerId , frequency_shift )
Signature
static Result Oculus.Haptics.Ffi.player_frequency_shift(int playerId, out float frequency_shift)
Parameters
playerId: int
frequency_shift: out float
Returns
Result
player_looping_enabled ( playerId , looping_enabled )
Signature
static Result Oculus.Haptics.Ffi.player_looping_enabled(int playerId, out bool looping_enabled)
Parameters
playerId: int
looping_enabled: out bool
Returns
Result
player_play ( playerId , controller )
Signature
static Result Oculus.Haptics.Ffi.player_play(int playerId, Controller controller)
Parameters
playerId: int
controller: Controller
Returns
Result
player_priority ( playerId , priority )
Signature
static Result Oculus.Haptics.Ffi.player_priority(int playerId, out uint priority)
Parameters
playerId: int
priority: out uint
Returns
Result
player_set_amplitude ( playerId , amplitude )
Signature
static Result Oculus.Haptics.Ffi.player_set_amplitude(int playerId, float amplitude)
Parameters
playerId: int
amplitude: float
Returns
Result
player_set_clip ( playerId , clipId )
Signature
static Result Oculus.Haptics.Ffi.player_set_clip(int playerId, int clipId)
Parameters
playerId: int
clipId: int
Returns
Result
player_set_frequency_shift ( playerId , amount )
Signature
static Result Oculus.Haptics.Ffi.player_set_frequency_shift(int playerId, float amount)
Parameters
playerId: int
amount: float
Returns
Result
player_set_looping_enabled ( playerId , enabled )
Signature
static Result Oculus.Haptics.Ffi.player_set_looping_enabled(int playerId, bool enabled)
Parameters
playerId: int
enabled: bool
Returns
Result
player_set_priority ( playerId , priority )
Signature
static Result Oculus.Haptics.Ffi.player_set_priority(int playerId, uint priority)
Parameters
playerId: int
priority: uint
Returns
Result
player_stop ( playerId )
Signature
static Result Oculus.Haptics.Ffi.player_stop(int playerId)
Parameters
playerId: int
Returns
Result
release_clip ( clipId )
Signature
static Result Oculus.Haptics.Ffi.release_clip(int clipId)
Parameters
clipId: int
Returns
Result
release_player ( playerId )
Signature
static Result Oculus.Haptics.Ffi.release_player(int playerId)
Parameters
playerId: int
Returns
Result
set_suspended ( suspended )
Signature
static Result Oculus.Haptics.Ffi.set_suspended(bool suspended)
Parameters
suspended: bool
Returns
Result
uninitialize ()
Signature
static Result Oculus.Haptics.Ffi.uninitialize()
Returns
Result
version ()
Signature
static SdkVersion Oculus.Haptics.Ffi.version()
Returns
SdkVersion

Static Methods

error_message ()
Signature
static string Oculus.Haptics.Ffi.error_message()
Returns
string
Failed ( result )
Signature
static bool Oculus.Haptics.Ffi.Failed(Result result)
Parameters
result: Result
Returns
bool
initialize_with_ovr_plugin ( game_engine_name , game_engine_version , game_engine_haptics_sdk_version )
Signature
static Result Oculus.Haptics.Ffi.initialize_with_ovr_plugin(string game_engine_name, string game_engine_version, string game_engine_haptics_sdk_version)
Parameters
game_engine_name: string
game_engine_version: string
game_engine_haptics_sdk_version: string
Returns
Result
load_clip ( data , clip_id_out )
Signature
static Result Oculus.Haptics.Ffi.load_clip(string data, out int clip_id_out)
Parameters
data: string
clip_id_out: out int
Returns
Result
Succeeded ( result )
Signature
static bool Oculus.Haptics.Ffi.Succeeded(Result result)
Parameters
result: Result
Returns
bool

Inner Structs

NullBackendStatistics Struct

Fields

play_call_count : long
Signature
long Oculus.Haptics.Ffi.NullBackendStatistics.play_call_count
samples_played : long
Signature
long Oculus.Haptics.Ffi.NullBackendStatistics.samples_played

SdkVersion Struct

Fields

major : ushort
Signature
ushort Oculus.Haptics.Ffi.SdkVersion.major
minor : ushort
Signature
ushort Oculus.Haptics.Ffi.SdkVersion.minor
patch : ushort
Signature
ushort Oculus.Haptics.Ffi.SdkVersion.patch

Inner Enums

Result Enum

Enumeration Constants

MemberValue
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

Controller Enum

Enumeration Constants

MemberValue
Left
0
Right
1
Both
2

LogLevel Enum

Enumeration Constants

MemberValue
Trace
0
Debug
1
Info
2
Warn
3
Error
4