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

OVRPlatformEnums.h File

Enumeration Types

Enumeration EOvrAbuseReportType

AbuseReportType enumeration.
Unknown
No description available
Object
A report for something besides a user, like a world.
User
A report for a user's behavior or profile.

Enumeration EOvrAccountAgeCategory

AccountAgeCategory enumeration.
Unknown
No description available
Ch
No description available
Tn
No description available
Ad
No description available

Enumeration EOvrAchievementType

AchievementType enumeration.
Unknown
No description available
Simple
No description available
Bitfield
No description available
Count
No description available

Enumeration EOvrAppAgeCategory

AppAgeCategory enumeration.
Unknown
No description available
Ch
No description available
Nch
No description available

Enumeration EOvrAppInstallResult

AppInstallResult enumeration.
Unknown
No description available
LowStorage
No description available
NetworkError
No description available
DuplicateRequest
No description available
InstallerError
No description available
UserCancelled
No description available
AuthorizationError
No description available
Success
No description available

Enumeration EOvrAppStatus

AppStatus enumeration.
Unknown
No description available
Entitled
No description available
DownloadQueued
No description available
Downloading
No description available
Installing
No description available
Installed
No description available
Uninstalling
No description available
InstallQueued
No description available

Enumeration EOvrChallengeCreationType

ChallengeCreationType enumeration.
Unknown
No description available
UserCreated
No description available
DeveloperCreated
No description available

Enumeration EOvrChallengeViewerFilter

ChallengeViewerFilter enumeration.
Unknown
No description available
AllVisible
No description available
Participating
No description available
Invited
No description available
ParticipatingOrInvited
No description available

Enumeration EOvrChallengeVisibility

ChallengeVisibility enumeration.
Unknown
No description available
InviteOnly
Only those invited can participate in it. Everyone can see it
Public
Everyone can participate and see this challenge
Private
Only those invited can participate and see this challenge

Enumeration EOvrKeyValuePairType

KeyValuePairType enumeration.
String
No description available
Int
No description available
Double
No description available
Unknown
No description available

Enumeration EOvrLaunchResult

LaunchResult enumeration.
Unknown
No description available
Success
No description available
FailedRoomFull
No description available
FailedGameAlreadyStarted
No description available
FailedRoomNotFound
No description available
FailedUserDeclined
No description available
FailedOtherReason
No description available

Enumeration EOvrLaunchType

LaunchType enumeration.
Unknown
No description available
Normal
Normal launch from the user's library
Invite
Launch from the user accepting an invite. Check field FOvrLaunchDetails::LobbySessionID, field FOvrLaunchDetails::MatchSessionID, field FOvrLaunchDetails::DestinationApiName and field FOvrLaunchDetails::DeeplinkMessage.
Coordinated
DEPRECATED
Deeplink
Launched from Application_LaunchOtherApp(). Check field FOvrLaunchDetails::LaunchSource and field FOvrLaunchDetails::DeeplinkMessage.

Enumeration EOvrLeaderboardFilterType

LeaderboardFilterType enumeration.
None
No description available
Friends
No description available
Unknown
No description available
UserIds
No description available

Enumeration EOvrLeaderboardStartAt

LeaderboardStartAt enumeration.
Top
No description available
CenteredOnViewer
No description available
CenteredOnViewerOrTop
No description available
Unknown
No description available

Enumeration EOvrLivestreamingStartStatus

LivestreamingStartStatus enumeration.
Success
= 1
Unknown
= 0
NoPackageSet
= uint8(-1)
NoFbConnect
= uint8(-2)
NoSessionId
= uint8(-3)
MissingParameters
= uint8(-4)

Enumeration EOvrLogEventName

LogEventName enumeration.
Unknown
No description available
AdClick
No description available
AdImpression
No description available
VrCompleteRegistration
No description available
VrTutorialCompletion
No description available
Contact
No description available
CustomizeProduct
No description available
Donate
No description available
FindLocation
No description available
VrRate
No description available
Schedule
No description available
VrSearch
No description available
SmartTrial
No description available
SubmitApplication
No description available
Subscribe
No description available
VrContentView
No description available
VrSdkInitialize
No description available
VrSdkBackgroundStatusAvailable
No description available
VrSdkBackgroundStatusDenied
No description available
VrSdkBackgroundStatusRestricted
No description available
VrAddPaymentInfo
No description available
VrAddToCart
No description available
VrAddToWishlist
No description available
VrInitiatedCheckout
No description available
VrPurchase
No description available
VrCatalogUpdate
No description available
VrPurchaseFailed
No description available
VrPurchaseRestored
No description available
SubscriptionInitiatedCheckout
No description available
SubscriptionFailed
No description available
SubscriptionRestore
No description available
VrLevelAchieved
No description available
VrAchievementUnlocked
No description available
VrSpentCredits
No description available
VrObtainPushToken
No description available
VrPushOpened
No description available
VrActivateApp
No description available
VrDeactivateApp
No description available

Enumeration EOvrLogEventParameter

LogEventParameter enumeration.
Unknown
No description available
VrCurrency
No description available
VrRegistrationMethod
No description available
VrContentType
No description available
VrContent
No description available
VrContentId
No description available
VrSearchString
No description available
VrSuccess
No description available
VrMaxRatingValue
No description available
VrPaymentInfoAvailable
No description available
VrNumItems
No description available
VrLevel
No description available
VrDescription
No description available
AdType
No description available
VrOrderId
No description available
EventName
No description available
LogTime
No description available
ImplicitlyLogged
No description available
InBackground
No description available
VrPushCampaign
No description available
VrPushAction
No description available
VrIapProductType
No description available
VrContentTitle
No description available
VrTransactionId
No description available
VrTransactionDate
No description available
VrIapSubsPeriod
No description available
VrIapIsStartTrial
No description available
VrIapHasFreeTrial
No description available
VrIapTrialPeriod
No description available
VrIapTrialPrice
No description available
SessionId
No description available

Enumeration EOvrMediaContentType

MediaContentType enumeration.
Unknown
No description available
Photo
No description available

Enumeration EOvrMultiplayerErrorErrorKey

MultiplayerErrorErrorKey enumeration.
Unknown
No description available
DestinationUnavailable
No description available
DlcRequired
No description available
General
No description available
GroupFull
No description available
InviterNotJoinable
No description available
LevelNotHighEnough
No description available
LevelNotUnlocked
No description available
NetworkTimeout
No description available
NoLongerAvailable
No description available
UpdateRequired
No description available
TutorialRequired
No description available

Enumeration EOvrNetSyncConnectionStatus

NetSyncConnectionStatus enumeration.
Unknown
No description available
Connecting
No description available
Disconnected
No description available
Connected
No description available

Enumeration EOvrNetSyncDisconnectReason

NetSyncDisconnectReason enumeration.
Unknown
No description available
LocalTerminated
when disconnect was requested
ServerTerminated
server intentionally closed the connection
Failed
initial connection never succeeded
Lost
network timeout

Enumeration EOvrNetSyncVoipMicSource

NetSyncVoipMicSource enumeration.
Unknown
No description available
None
No description available
Internal
No description available

Enumeration EOvrNetSyncVoipStreamMode

NetSyncVoipStreamMode enumeration.
Unknown
No description available
Ambisonic
No description available
Mono
No description available

Enumeration EOvrPartyUpdateAction

PartyUpdateAction enumeration.
Unknown
No description available
Join
No description available
Leave
No description available
Invite
No description available
Uninvite
No description available

Enumeration EOvrPermissionGrantStatus

PermissionGrantStatus enumeration.
Unknown
No description available
Granted
No description available
Denied
No description available
Blocked
No description available

Enumeration EOvrPlatformInitializeResult

Describes the various results possible when attempting to initialize the platform. Anything other than ovrPlatformInitialize_Success should be considered a fatal error with respect to using the platform, as the platform is not guaranteed to be legitimate or work correctly.
Success
= 0
Uninitialized
= uint8(-1)
PreLoaded
= uint8(-2)
FileInvalid
= uint8(-3)
SignatureInvalid
= uint8(-4)
UnableToVerify
= uint8(-5)
VersionMismatch
= uint8(-6)
Unknown
= uint8(-7)
InvalidCredentials
= uint8(-8)
NotEntitled
= uint8(-9)

Enumeration EOvrReportRequestResponse

ReportRequestResponse enumeration.
Unknown
No description available
Handled
No description available
Unhandled
No description available
Unavailable
No description available

Enumeration EOvrRichPresenceExtraContext

Display extra information about the user's presence
Unknown
No description available
None
Display nothing
CurrentCapacity
Display the current amount with the user over the max
StartedAgo
Display how long ago the match/game/race/etc started
EndingIn
Display how soon the match/game/race/etc will end
LookingForAMatch
Display that this user is looking for a match

Enumeration EOvrSdkAccountType

SdkAccountType enumeration.
Unknown
No description available
Oculus
No description available
FacebookGameroom
No description available

Enumeration EOvrServiceProvider

ServiceProvider enumeration.
Unknown
No description available
Dropbox
No description available
Facebook
No description available
Google
No description available
Instagram
No description available
RemoteMedia
No description available

Enumeration EOvrShareMediaStatus

ShareMediaStatus enumeration.
Unknown
No description available
Shared
No description available
Canceled
No description available

Enumeration EOvrSystemVoipStatus

SystemVoipStatus enumeration.
Unknown
No description available
Unavailable
No description available
Suppressed
No description available
Active
No description available

Enumeration EOvrTimeWindow

How far should we go back in time looking at history? This is used in some requests such as User_GetLoggedInUserRecentlyMetUsersAndRooms()
Unknown
No description available
OneHour
No description available
OneDay
No description available
OneWeek
No description available
ThirtyDays
No description available
NinetyDays
No description available

Enumeration EOvrUserOrdering

The ordering that is used when returning a list of users. This is used in some requests such as Room_GetInvitableUsers2()
Unknown
No description available
None
No preference for ordering (could be in any or no order)
PresenceAlphabetical
Orders by online users first and then offline users. Within each group the users are ordered alphabetically by display name

Enumeration EOvrUserPresenceStatus

UserPresenceStatus enumeration.
Unknown
No description available
Online
No description available
Offline
No description available

Enumeration EOvrVoipBitrate

VoipBitrate enumeration.
Unknown
No description available
B16000
Very low audio quality for minimal network usage. This may not give the full range of Hz for audio, but it will save on network usage.
B24000
Lower audio quality but also less network usage.
B32000
This is the default bitrate for voip connections. It should be the best tradeoff between audio quality and network usage.
B64000
Higher audio quality at the expense of network usage. Good if there's music being streamed over the connections
B96000
Even higher audio quality for music streaming or radio-like quality.
B128000
At this point the audio quality should be preceptually indistinguishable from the uncompressed input.

Enumeration EOvrVoipDtxState

VoipDtxState enumeration.
Unknown
No description available
Enabled
No description available
Disabled
No description available

Enumeration EOvrVoipMuteState

VoipMuteState enumeration.
Unknown
No description available
Muted
No description available
Unmuted
No description available

Enumeration EOvrVoipSampleRate

VoipSampleRate enumeration.
Unknown
No description available
HZ24000
No description available
HZ44100
No description available
HZ48000
No description available

Functions

ovrAbuseReportType ConvertAbuseReportType
EOvrAbuseReportType ConvertAbuseReportType
( ovrAbuseReportType Value )
ovrAccountAgeCategory ConvertAccountAgeCategory
EOvrAccountAgeCategory ConvertAccountAgeCategory
ovrAchievementType ConvertAchievementType
EOvrAchievementType ConvertAchievementType
( ovrAchievementType Value )
ovrAppAgeCategory ConvertAppAgeCategory
( EOvrAppAgeCategory Value )
EOvrAppAgeCategory ConvertAppAgeCategory
( ovrAppAgeCategory Value )
ovrAppInstallResult ConvertAppInstallResult
EOvrAppInstallResult ConvertAppInstallResult
ovrAppStatus ConvertAppStatus
( EOvrAppStatus Value )
EOvrAppStatus ConvertAppStatus
( ovrAppStatus Value )
ovrChallengeCreationType ConvertChallengeCreationType
EOvrChallengeCreationType ConvertChallengeCreationType
ovrChallengeViewerFilter ConvertChallengeViewerFilter
EOvrChallengeViewerFilter ConvertChallengeViewerFilter
ovrChallengeVisibility ConvertChallengeVisibility
EOvrChallengeVisibility ConvertChallengeVisibility
ovrKeyValuePairType ConvertKeyValuePairType
EOvrKeyValuePairType ConvertKeyValuePairType
ovrLaunchResult ConvertLaunchResult
( EOvrLaunchResult Value )
EOvrLaunchResult ConvertLaunchResult
( ovrLaunchResult Value )
ovrLaunchType ConvertLaunchType
( EOvrLaunchType Value )
EOvrLaunchType ConvertLaunchType
( ovrLaunchType Value )
ovrLeaderboardFilterType ConvertLeaderboardFilterType
EOvrLeaderboardFilterType ConvertLeaderboardFilterType
ovrLeaderboardStartAt ConvertLeaderboardStartAt
EOvrLeaderboardStartAt ConvertLeaderboardStartAt
ovrLivestreamingStartStatus ConvertLivestreamingStartStatus
EOvrLivestreamingStartStatus ConvertLivestreamingStartStatus
ovrLogEventName ConvertLogEventName
( EOvrLogEventName Value )
EOvrLogEventName ConvertLogEventName
( ovrLogEventName Value )
ovrLogEventParameter ConvertLogEventParameter
EOvrLogEventParameter ConvertLogEventParameter
ovrMediaContentType ConvertMediaContentType
EOvrMediaContentType ConvertMediaContentType
ovrMultiplayerErrorErrorKey ConvertMultiplayerErrorErrorKey
EOvrMultiplayerErrorErrorKey ConvertMultiplayerErrorErrorKey
ovrNetSyncConnectionStatus ConvertNetSyncConnectionStatus
EOvrNetSyncConnectionStatus ConvertNetSyncConnectionStatus
ovrNetSyncDisconnectReason ConvertNetSyncDisconnectReason
EOvrNetSyncDisconnectReason ConvertNetSyncDisconnectReason
ovrNetSyncVoipMicSource ConvertNetSyncVoipMicSource
EOvrNetSyncVoipMicSource ConvertNetSyncVoipMicSource
ovrNetSyncVoipStreamMode ConvertNetSyncVoipStreamMode
EOvrNetSyncVoipStreamMode ConvertNetSyncVoipStreamMode
ovrPartyUpdateAction ConvertPartyUpdateAction
EOvrPartyUpdateAction ConvertPartyUpdateAction
ovrPermissionGrantStatus ConvertPermissionGrantStatus
EOvrPermissionGrantStatus ConvertPermissionGrantStatus
ovrPlatformInitializeResult ConvertPlatformInitializeResult
EOvrPlatformInitializeResult ConvertPlatformInitializeResult
ovrReportRequestResponse ConvertReportRequestResponse
EOvrReportRequestResponse ConvertReportRequestResponse
ovrRichPresenceExtraContext ConvertRichPresenceExtraContext
EOvrRichPresenceExtraContext ConvertRichPresenceExtraContext
ovrSdkAccountType ConvertSdkAccountType
( EOvrSdkAccountType Value )
EOvrSdkAccountType ConvertSdkAccountType
( ovrSdkAccountType Value )
ovrServiceProvider ConvertServiceProvider
EOvrServiceProvider ConvertServiceProvider
( ovrServiceProvider Value )
ovrShareMediaStatus ConvertShareMediaStatus
EOvrShareMediaStatus ConvertShareMediaStatus
ovrSystemVoipStatus ConvertSystemVoipStatus
EOvrSystemVoipStatus ConvertSystemVoipStatus
ovrTimeWindow ConvertTimeWindow
( EOvrTimeWindow Value )
EOvrTimeWindow ConvertTimeWindow
( ovrTimeWindow Value )
ovrUserOrdering ConvertUserOrdering
( EOvrUserOrdering Value )
EOvrUserOrdering ConvertUserOrdering
( ovrUserOrdering Value )
ovrUserPresenceStatus ConvertUserPresenceStatus
EOvrUserPresenceStatus ConvertUserPresenceStatus
ovrVoipBitrate ConvertVoipBitrate
( EOvrVoipBitrate Value )
EOvrVoipBitrate ConvertVoipBitrate
( ovrVoipBitrate Value )
ovrVoipDtxState ConvertVoipDtxState
( EOvrVoipDtxState Value )
EOvrVoipDtxState ConvertVoipDtxState
( ovrVoipDtxState Value )
ovrVoipMuteState ConvertVoipMuteState
( EOvrVoipMuteState Value )
EOvrVoipMuteState ConvertVoipMuteState
( ovrVoipMuteState Value )
ovrVoipSampleRate ConvertVoipSampleRate
( EOvrVoipSampleRate Value )
EOvrVoipSampleRate ConvertVoipSampleRate
( ovrVoipSampleRate Value )
Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2025 Meta