API reference
API reference
Select your platform
No SDKs available
No versions available

OVR_Types.h File

Overview

Typedefs

uint64_t
uint64_t
ovrID ( )
void(*
void(*
void(*

Variables

const uint64_t
const uint64_t

Functions

ovrKeyValuePair_makeInt
( const char * key,
int value )
ovrKeyValuePair_makeDouble
( const char * key,
double value )
ovrKeyValuePair_makeString
( const char * key,
const char * value )
bool
ovrID_FromString
( ovrID * outId,
const char * inId )
bool
ovrID_ToString
( char * outParam,
size_t bufferLength,
ovrID id )

Details

Typedefs

typedef uint64_t ovrRequest ( )
Represents a single state change in the platform such as the response to a request, or some new information from the backend.
typedef uint64_t ovrID ( )
A unique identifier for some entity in the system (user, room, etc).
typedef void(* LogFunctionPtr) (const char *, const char *) ( )
No description available.
typedef void( * VoipFilterCallback) (int16_t pcmData[], size_t pcmDataLength, int frequency, int numChannels) ( )
Callback used by the Voip subsystem for audio filtering
typedef void(* MicrophoneDataAvailableCallback) (void *) ( )
Callback used by the ovrMicrophone class to signal that data is available

Variables

const uint64_t invalidRequestID
No description available.
const uint64_t invalidMessageID
No description available.
LogFunctionPtr DoLogging
No description available.

Functions

ovrKeyValuePair ovrKeyValuePair_makeInt
( const char * key,
int value )
Helper function for making an int ovrKeyValuePair.
For example, ovrKeyValuePair_makeInt("key", 1);
ovrKeyValuePair ovrKeyValuePair_makeDouble
( const char * key,
double value )
Helper function for making a double ovrKeyValuePair.
For example, ovrKeyValuePair_makeDouble("key", 1.1);
ovrKeyValuePair ovrKeyValuePair_makeString
( const char * key,
const char * value )
Helper function for making a string ovrKeyValuePair.
For example, ovrKeyValuePair_makeString("key", "value");
bool ovrID_FromString
( ovrID * outId,
const char * inId )
Convert a string into an ovrID. Returns false if the input is malformed (either out of range, or not an integer).
bool ovrID_ToString
( char * outParam,
size_t bufferLength,
ovrID id )
Convert an ID back into a string. This function round trips with ovrID_FromString(). Note: the id format may change in the future. Developers should not rely on the string representation being an integer.
Length of outParam should be > 20.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon