developers
Login

Platform 1.32 Reference Guide

OVR_Platform.h File Reference

Macros

#define
ovr_Platform_InitializeStandaloneOculus
#define
ovr_PlatformInitializeWithAccessToken
#define
ovr_PlatformInitializeWindows
#define
ovr_PlatformInitializeWindowsAsynchronous

Enumerations

enum
ovrPlatformStructureType_ {
}

Typedefs

enum ovrPlatformStructureType_

Functions

bool
ovrRequest
ovr_Platform_InitializeStandaloneOculusEx ( const ovrOculusInitParams * params, ovrPlatformInitializeResult * outResult, int productVersion, int majorVersion )
ovrRequest
ovr_PlatformInitializeWithAccessTokenEx ( ovrID appId, const char * serviceAccessToken, ovrPlatformInitializeResult * outResult, int productVersion, int majorVersion )
ovrPlatformInitializeResult
ovr_PlatformInitializeWindowsEx ( const char * appId, int productVersion, int majorVersion )
ovrRequest
ovr_PlatformInitializeWindowsAsynchronousEx ( const char * appId, ovrPlatformInitializeResult * outResult, int productVersion, int majorVersion )
ovrID
const char *
ovrMessageHandle
void
void
ovr_SetDeveloperAccessToken ( const char * accessToken )

Macros Documentation

#define ovr_Platform_InitializeStandaloneOculus
Wrapper for ovr_Platform_InitializeStandaloneOculusEx that automatically passes the key version information as defined in this header package. This is used to ensure that the version in your headers matches the version of the static library.
#define ovr_PlatformInitializeWithAccessToken
#define ovr_PlatformInitializeWindows
Wrapper for ovr_PlatformInitializeWindowsEx that automatically passes the key version information as defined in this header package. This is used to ensure that the version in your headers matches the version of the static library.
#define ovr_PlatformInitializeWindowsAsynchronous
Wrapper for ovr_PlatformInitializeWindowsAsynchronousEx that automatically passes the key version information as defined in this header package. This is used to ensure that the version in your headers matches the version of the static library.outResult will contain the result of attempting to load the DLL. If that fails, the returning ovrRequest will be 0.NOTE: Just because the DLL is loaded successfully does NOT mean that the initialization was successful, you still need to check the message queue for the result in ovrMessage_PlatformInitializeWindowsAsynchronous

Enumeration Type Documentation

enum OVR_Platform.h.ovrPlatformStructureType_
Enumerator
ovrPlatformStructureType_Unknown= 0
ovrPlatformStructureType_OculusInitParams= 1

Typedef Documentation

typedef enum ovrPlatformStructureType_ ovrPlatformStructureType ( )
This enum describes the type of versionable structs in the Oculus Platform API. Older versions of structs will not be declared here, but they will be seamlessly updated for all supported older versions of the SDK.

Function Documentation

bool ovr_IsPlatformInitialized ( )
ovrRequest ovr_Platform_InitializeStandaloneOculusEx ( const ovrOculusInitParams * params, ovrPlatformInitializeResult * outResult, int productVersion, int majorVersion )
Initializes the SDK in Standalone mode and doesn't try to connect to a locally running Oculus Service process. Not all functionality will work when when the SDK is initialized this way. In particular: IAP, Cloud Storage, Parties, Events, Live Streaming. Listen for the message ovrMessage_Platform_InitializeStandaloneOculus to detect when the platform has finished initializing.
Parameters
params
non-nullptr to a struct with the required Oculus Authentication data.
ovrRequest ovr_PlatformInitializeWithAccessTokenEx ( ovrID appId, const char * serviceAccessToken, ovrPlatformInitializeResult * outResult, int productVersion, int majorVersion )
(BETA) For use on platforms where the Oculus service isn't running. You'll need to know how to get an access token for the user to use this. While the platform is in an initializing state, it's not fully functional. [Requests]: will queue up and run once platform is initialized. For example: ovr_User_GetLoggedInUser() can be called immediately after asynchronous init and once platform is initialized, this request will run [Synchronous Methods]: will return the default value; For example: ovr_GetLoggedInUserID() will return 0 until platform is fully initialized
outResult will contain the result of attempting to load the DLL. If that fails, the returning ovrRequest will be 0.
NOTE: Just because the DLL is loaded successfully does NOT mean that the initialization was successful. Listen for the message ovrMessage_PlatformInitializeWithAccessToken to detect when the platform has finished initializing.
Not all functionality will work when when the SDK is initialized this way. In particular: In-App Purchases, Cloud Storage, Parties, Events, Live Streaming will not work.
ovrPlatformInitializeResult ovr_PlatformInitializeWindowsEx ( const char * appId, int productVersion, int majorVersion )
Performs the initialization of the platform for use on Windows. Requires your app ID (not access token). This call may fail for a variety of reasons, and will return an error code in that case. It is critical to respect this error code and either exit or make no further platform calls.
ovrRequest ovr_PlatformInitializeWindowsAsynchronousEx ( const char * appId, ovrPlatformInitializeResult * outResult, int productVersion, int majorVersion )
Performs the initialization of the platform for use on Windows. Requires your app ID (not access token). This call may fail for a variety of reasons, and will return an error code in that case. It is critical to respect this error code and either exit or make no further platform calls.
outResult will contain the result of attempting to load the DLL. If that fails, the returning ovrRequest will be 0.
NOTE: Just because the DLL is loaded successfully does NOT mean that the initialization was successful, you still need to check the message queue for the result in ovrMessage_PlatformInitializeWindowsAsynchronous
ovrID ovr_GetLoggedInUserID ( )
Returns the id of the currently logged in user, or a 0 id if there is none.
const char* ovr_GetLoggedInUserLocale ( )
Returns the currently logged-in user's locale as a string, or empty string on error. Return value format conforms to BCP47: https://tools.ietf.org/html/bcp47 The return value is borrowed, and should not be freed
ovrMessageHandle ovr_PopMessage ( )
Return the next message in the queue (FIFO order), or null if none is available. Safe to call on any thread. Each returned message should eventually be freed with ovr_FreeMessage.
TODO: comment on whether it's safe to process messages out of order.
void ovr_FreeMessage ( ovrMessageHandle )
void ovr_SetDeveloperAccessToken ( const char * accessToken )
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
149
150
151
152
153
159
160
161
162
163
164
165
166
167
168
175
176
177
178
179
186
187
188
204
205
206
207
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
233
234
235
239
240
262
263
264
265
266
267
268
269
270
271
272
273
278
279
283
284
285
297
298
309
310
311
312
315
316
320
321
322
329
330
331
332
333
334
335
// This file was @generated with LibOVRPlatform/codegen/main. Do not modify it!

#ifndef OVR_PLATFORM_H
#define OVR_PLATFORM_H

#include <stdbool.h>

#include "OVR_Types.h"
#include "OVR_MessageType.h"
#include "OVR_Platform_Defs.h"
#include "OVR_Voip_LowLevel.h"
#include "OVR_PlatformVersion.h"

#include "OVR_AbuseReportRecording.h"
#include "OVR_AchievementDefinition.h"
#include "OVR_AchievementDefinitionArray.h"
#include "OVR_AchievementProgress.h"
#include "OVR_AchievementProgressArray.h"
#include "OVR_AchievementUpdate.h"
#include "OVR_ApplicationVersion.h"
#include "OVR_AssetDetails.h"
#include "OVR_AssetDetailsArray.h"
#include "OVR_AssetFileDeleteResult.h"
#include "OVR_AssetFileDownloadCancelResult.h"
#include "OVR_AssetFileDownloadResult.h"
#include "OVR_AssetFileDownloadUpdate.h"
#include "OVR_CalApplicationFinalized.h"
#include "OVR_CalApplicationProposed.h"
#include "OVR_CalApplicationSuggestion.h"
#include "OVR_CalApplicationSuggestionArray.h"
#include "OVR_CloudStorageConflictMetadata.h"
#include "OVR_CloudStorageData.h"
#include "OVR_CloudStorageMetadata.h"
#include "OVR_CloudStorageMetadataArray.h"
#include "OVR_CloudStorageUpdateResponse.h"
#include "OVR_DataStore.h"
#include "OVR_Error.h"
#include "OVR_HttpTransferUpdate.h"
#include "OVR_InstalledApplication.h"
#include "OVR_InstalledApplicationArray.h"
#include "OVR_LanguagePackInfo.h"
#include "OVR_LaunchBlockFlowResult.h"
#include "OVR_LaunchDetails.h"
#include "OVR_LaunchFriendRequestFlowResult.h"
#include "OVR_LaunchReportFlowResult.h"
#include "OVR_LaunchUnblockFlowResult.h"
#include "OVR_LeaderboardEntry.h"
#include "OVR_LeaderboardEntryArray.h"
#include "OVR_LeaderboardUpdateStatus.h"
#include "OVR_LinkedAccount.h"
#include "OVR_LinkedAccountArray.h"
#include "OVR_LivestreamingApplicationStatus.h"
#include "OVR_LivestreamingStartResult.h"
#include "OVR_LivestreamingStatus.h"
#include "OVR_LivestreamingVideoStats.h"
#include "OVR_MatchmakingAdminSnapshot.h"
#include "OVR_MatchmakingAdminSnapshotCandidate.h"
#include "OVR_MatchmakingAdminSnapshotCandidateArray.h"
#include "OVR_MatchmakingBrowseResult.h"
#include "OVR_MatchmakingEnqueueResult.h"
#include "OVR_MatchmakingEnqueueResultAndRoom.h"
#include "OVR_MatchmakingEnqueuedUser.h"
#include "OVR_MatchmakingEnqueuedUserArray.h"
#include "OVR_MatchmakingRoom.h"
#include "OVR_MatchmakingRoomArray.h"
#include "OVR_MatchmakingStats.h"
#include "OVR_Message.h"
#include "OVR_Microphone.h"
#include "OVR_NetworkingPeer.h"
#include "OVR_OrgScopedID.h"
#include "OVR_Packet.h"
#include "OVR_Party.h"
#include "OVR_PartyID.h"
#include "OVR_Pid.h"
#include "OVR_PidArray.h"
#include "OVR_PingResult.h"
#include "OVR_PlatformInitialize.h"
#include "OVR_Product.h"
#include "OVR_ProductArray.h"
#include "OVR_Purchase.h"
#include "OVR_PurchaseArray.h"
#include "OVR_Room.h"
#include "OVR_RoomArray.h"
#include "OVR_RoomInviteNotification.h"
#include "OVR_RoomInviteNotificationArray.h"
#include "OVR_SdkAccount.h"
#include "OVR_SdkAccountArray.h"
#include "OVR_ShareMediaResult.h"
#include "OVR_SystemPermission.h"
#include "OVR_SystemVoipState.h"
#include "OVR_User.h"
#include "OVR_UserAndRoom.h"
#include "OVR_UserAndRoomArray.h"
#include "OVR_UserArray.h"
#include "OVR_UserProof.h"
#include "OVR_UserReportID.h"
#include "OVR_VoipDecoder.h"
#include "OVR_VoipEncoder.h"

#include "OVR_Requests_Achievements.h"
#include "OVR_Requests_Application.h"
#include "OVR_Requests_ApplicationLifecycle.h"
#include "OVR_Requests_AssetFile.h"
#include "OVR_Requests_CloudStorage.h"
#include "OVR_Requests_Entitlement.h"
#include "OVR_Requests_IAP.h"
#include "OVR_Requests_LanguagePack.h"
#include "OVR_Requests_Leaderboard.h"
#include "OVR_Requests_Livestreaming.h"
#include "OVR_Requests_Matchmaking.h"
#include "OVR_Requests_Media.h"
#include "OVR_Requests_Notification.h"
#include "OVR_Requests_Party.h"
#include "OVR_Requests_Room.h"
#include "OVR_Requests_User.h"
#include "OVR_Requests_Voip.h"
#include "OVR_AbuseReportOptions.h"
#include "OVR_ApplicationOptions.h"
#include "OVR_MatchmakingOptions.h"
#include "OVR_RoomOptions.h"
#include "OVR_UserOptions.h"
#include "OVR_VoipOptions.h"
#include "OVR_Functions_ApplicationLifecycle.h"
#include "OVR_Functions_Networking.h"
#include "OVR_Functions_Voip.h"

OVRP_PUBLIC_FUNCTION(bool) ovr_IsPlatformInitialized();

#ifdef __ANDROID__
#include <jni.h>
OVRP_PUBLIC_FUNCTION(ovrPlatformInitializeResult) ovr_PlatformInitializeAndroid(constchar* appId, jobject activityObject, JNIEnv * jni);

// Asynchronously Initialize Platform SDK. The result will be put on the message
// queue with the message type: ovrMessage_PlatformInitializeAndroidAsynchronous
//
// While the platform is in an initializing state, it's not fully functional.
// [Requests]: will queue up and run once platform is initialized.
//    For example: ovr_User_GetLoggedInUser() can be called immediately after
//    asynchronous init and once platform is initialized, this request will run
// [Synchronous Methods]: will return the default value;
//    For example: ovr_GetLoggedInUserID() will return 0 until platform is
//    fully initialized
OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_PlatformInitializeAndroidAsynchronous(constchar* appId, jobject activityObject, JNIEnv * jni);
#endif

typedefenum ovrPlatformStructureType_ {
  ovrPlatformStructureType_Unknown = 0,
  ovrPlatformStructureType_OculusInitParams = 1,
} ovrPlatformStructureType;

typedefstruct {
  ovrPlatformStructureType sType;
constchar *email;
constchar *password;
  ovrID appId;
constchar *uriPrefixOverride;
} ovrOculusInitParams;

#ifdef __ANDROID__ //Needed for compatibility. 1.13 introduced this method

OVRPL_PUBLIC_FUNCTION(ovrRequest) ovr_Platform_InitializeStandaloneOculus(
const ovrOculusInitParams *params);
#else
#if defined(OVRPL_DISABLED)

OVRPL_PUBLIC_FUNCTION(ovrRequest) ovr_Platform_InitializeStandaloneOculus(
const ovrOculusInitParams *params);

OVRPL_PUBLIC_FUNCTION(ovrRequest) ovr_PlatformInitializeWithAccessToken(
  ovrID appId,
constchar *serviceAccessToken);

OVRPL_PUBLIC_FUNCTION(ovrPlatformInitializeResult) ovr_PlatformInitializeWindows(constchar* appId);

// Asynchronously Initialize Platform SDK. The result will be put on the message
// queue with the message type: ovrMessage_PlatformInitializeWindowsAsynchronous
//
// While the platform is in an initializing state, it's not fully functional.
// [Requests]: will queue up and run once platform is initialized.
//    For example: ovr_User_GetLoggedInUser() can be called immediately after
//    asynchronous init and once platform is initialized, this request will run
// [Synchronous Methods]: will return the default value;
//    For example: ovr_GetLoggedInUserID() will return 0 until platform is
//    fully initialized
OVRPL_PUBLIC_FUNCTION(ovrRequest) ovr_PlatformInitializeWindowsAsynchronous(constchar* appId);
#else

OVRPL_PUBLIC_FUNCTION(ovrRequest) ovr_Platform_InitializeStandaloneOculusEx(
const ovrOculusInitParams *params, ovrPlatformInitializeResult *outResult, int productVersion, int majorVersion);

#define ovr_Platform_InitializeStandaloneOculus(params, outResult) ovr_Platform_InitializeStandaloneOculusEx(params, outResult, PLATFORM_PRODUCT_VERSION, PLATFORM_MAJOR_VERSION)


OVRPL_PUBLIC_FUNCTION(ovrRequest) ovr_PlatformInitializeWithAccessTokenEx(
  ovrID appId,
constchar *serviceAccessToken,
  ovrPlatformInitializeResult *outResult,
int productVersion,
int majorVersion);

#define ovr_PlatformInitializeWithAccessToken(appId, serviceAccessToken, outResult) \
  ovr_PlatformInitializeWithAccessTokenEx(appId, serviceAccessToken, outResult, \
  PLATFORM_PRODUCT_VERSION, PLATFORM_MAJOR_VERSION)

OVRPL_PUBLIC_FUNCTION(ovrPlatformInitializeResult) ovr_PlatformInitializeWindowsEx(constchar* appId, int productVersion, int majorVersion);

#define ovr_PlatformInitializeWindows(appId) ovr_PlatformInitializeWindowsEx((appId), PLATFORM_PRODUCT_VERSION, PLATFORM_MAJOR_VERSION)


OVRPL_PUBLIC_FUNCTION(ovrRequest) ovr_PlatformInitializeWindowsAsynchronousEx(constchar* appId, ovrPlatformInitializeResult *outResult, int productVersion, int majorVersion);

#define ovr_PlatformInitializeWindowsAsynchronous(appId, outResult) ovr_PlatformInitializeWindowsAsynchronousEx(appId, outResult, PLATFORM_PRODUCT_VERSION, PLATFORM_MAJOR_VERSION)
#endif
#endif //Android

OVRP_PUBLIC_FUNCTION(ovrID) ovr_GetLoggedInUserID();

OVRP_PUBLIC_FUNCTION(constchar*) ovr_GetLoggedInUserLocale();


OVRPL_PUBLIC_FUNCTION(ovrMessageHandle) ovr_PopMessage();

OVRP_PUBLIC_FUNCTION(void) ovr_FreeMessage(ovrMessageHandle);

OVRP_PUBLIC_FUNCTION(void) ovr_SetDeveloperAccessToken(constchar *accessToken);

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