Platform v18 Reference Guide

OVR_Types.h File Reference

Typedefs

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

Variables

const uint64_t
const uint64_t
LogFunctionPtr

Functions

ovrKeyValuePair
ovrKeyValuePair_makeInt ( const char * key, int value )
ovrKeyValuePair
ovrKeyValuePair_makeDouble ( const char * key, double value )
ovrKeyValuePair
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 )

Typedef Documentation

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 *) ( )
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

Variable Documentation

const uint64_t invalidRequestID ( )
const uint64_t invalidMessageID ( )
LogFunctionPtr DoLogging ( )

Function Documentation

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.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
42
43
47
48
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
73
74
77
78
85
86
87
88
89
92
93
94
97
98
99
100
101
102
103
104
105
106
107
108
109
#ifndef OVR_TYPES_H
#define OVR_TYPES_H

#include "OVR_KeyValuePairType.h"
#include "OVR_MatchmakingCriterionImportance.h"
#include "OVR_VoipSampleRate.h"
#include "OVR_MediaContentType.h"

#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>

#ifdef __cplusplus
extern"C" {
#endif

typedef uint64_t ovrRequest;

// Represents an RequestID that can used as a default.
// We guarantee that no valid Request ID will equal invalidRequestID
const uint64_t invalidRequestID = 0;

// Represents an invalid MessageID that can used as a default.
// We guarantee that no valid Message ID will equal invalidMessageID
const uint64_t invalidMessageID = 0;

typedefstruct {
constchar* key;
  ovrKeyValuePairType valueType;

constchar* stringValue;
int intValue;
double doubleValue;

} ovrKeyValuePair;

ovrKeyValuePair ovrKeyValuePair_makeInt(constchar* key, int value);

ovrKeyValuePair ovrKeyValuePair_makeDouble(constchar* key, double value);

ovrKeyValuePair ovrKeyValuePair_makeString(constchar* key, constchar* value);

typedefstruct {
constchar* key;
  ovrMatchmakingCriterionImportance importance;

  ovrKeyValuePair* parameterArray;
unsignedint parameterArrayCount;

} ovrMatchmakingCriterion;

typedefstruct {
  ovrKeyValuePair* customQueryDataArray;
unsignedint customQueryDataArrayCount;

  ovrMatchmakingCriterion* customQueryCriterionArray;
unsignedint customQueryCriterionArrayCount;
} ovrMatchmakingCustomQueryData;

typedef uint64_t ovrID;

bool ovrID_FromString(ovrID* outId, constchar* inId);

bool ovrID_ToString(char* outParam, size_t bufferLength, ovrID id);

typedef void (*LogFunctionPtr)(constchar*, constchar*);
extern LogFunctionPtr DoLogging;

typedef void (
    *VoipFilterCallback)(int16_t pcmData[], size_t pcmDataLength, int frequency, int numChannels);

typedef void (*MicrophoneDataAvailableCallback)(void*);

typedefstruct {
float x;
float y;
float z;
} ovrNetSyncVec3;

#ifdef __cplusplus
}
#endif

#endif
The documentation for this file was generated from the following file: OVR_Types.h