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

Platform Namespace

Enumeration Types

Enumeration AbuseReportType

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 AbuseReportVideoMode

Unknown
No description available
Collect
The UI will collect video evidence if the object_type supports it.
Optional
The UI will try to collect video evidence if the object_type supports it, but will allow the user to skip that step if they wish.
Skip
The UI will not collect video evidence.

Enumeration AccountAgeCategory

Unknown
No description available
Ch
Child age group for users between the ages of 10-12 (age may vary by region)
Tn
Teenage age group for users between the ages of 13-17 (age may vary by region)
Ad
Adult age group for users ages 18 and up (age may vary by region)

Enumeration AchievementType

Unknown
No description available
Simple
No description available
Bitfield
No description available
Count
No description available

Enumeration AppAgeCategory

Unknown
No description available
Ch
Child age group for users between the ages of 10-12 (age may vary by region)
Nch
Non-child age group for users ages 13 and up (age may vary by region)

Enumeration AppInstallResult

Unknown
No description available
LowStorage
Install of the app failed due to low storage on the device.
NetworkError
Install of the app failed due to a network error.
DuplicateRequest
Install of the app failed as another install request for this application is already being processed by the installer
InstallerError
Install of the app failed due to an internal installer error.
UserCancelled
Install of the app failed because the user cancelled the install operation.
AuthorizationError
Install of the app failed due to a user authorization error.
Success
Install of the app succeeded.

Enumeration AppStatus

Unknown
No description available
Entitled
User has valid entitlement to the app but it is not currently installed on the device.
DownloadQueued
Download of the app is currently queued.
Downloading
Download of the app is currently in progress.
Installing
Install of the app is currently in progress.
Installed
App is installed on the device.
Uninstalling
App is being uninstalled from the device.
InstallQueued
Install of the app is currently queued.

Enumeration ChallengeCreationType

Unknown
No description available
UserCreated
No description available
DeveloperCreated
No description available

Enumeration ChallengeViewerFilter

Unknown
No description available
AllVisible
No description available
Participating
No description available
Invited
No description available
ParticipatingOrInvited
No description available

Enumeration ChallengeVisibility

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 InitConfigOptions

DisableP2pNetworking
Disables the initialization of the WebRTC networking stack, when you don't need to use any of the ovr_Voip_* or ovr_Net_* functions.
EnableCowatching
Enables the initialization of cowatching stack to use ovr_Cowatching_* functions.

Enumeration KeyValuePairType

String
No description available
Int
No description available
Double
No description available
Unknown
No description available

Enumeration LaunchResult

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 LaunchType

Unknown
No description available
Normal
Normal launch from the user's library.
Invite
Launch from the user accepting an invite. Check LaunchDetails.GetLobbySessionID(), LaunchDetails.GetMatchSessionID(), LaunchDetails.GetDestinationApiName() and LaunchDetails.GetDeeplinkMessage().
Coordinated
DEPRECATED.
Deeplink
Launched from Application.LaunchOtherApp(). Check LaunchDetails.GetLaunchSource() and LaunchDetails.GetDeeplinkMessage().

Enumeration LeaderboardFilterType

None
No description available
Friends
No description available
Unknown
No description available
UserIds
No description available

Enumeration LeaderboardStartAt

Top
No description available
CenteredOnViewer
No description available
CenteredOnViewerOrTop
No description available
Unknown
No description available

Enumeration LivestreamingAudience

Unknown
No description available
Public
No description available
Friends
No description available
OnlyMe
No description available

Enumeration LivestreamingMicrophoneStatus

Unknown
No description available
MicrophoneOn
No description available
MicrophoneOff
No description available

Enumeration LivestreamingStartStatus

Success
= 1
Unknown
= 0
NoPackageSet
= -1
NoFbConnect
= -2
NoSessionId
= -3
MissingParameters
= -4

Enumeration LogEventName

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 LogEventParameter

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 MediaContentType

Unknown
No description available
Photo
No description available

Enumeration MultiplayerErrorErrorKey

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 NetSyncConnectionStatus

Unknown
No description available
Connecting
No description available
Disconnected
No description available
Connected
No description available

Enumeration NetSyncDisconnectReason

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

Enumeration NetSyncVoipMicSource

Unknown
No description available
None
No description available
Internal
No description available

Enumeration NetSyncVoipStreamMode

Unknown
No description available
Ambisonic
No description available
Mono
No description available

Enumeration PartyMicState

Unknown
No description available
Party
No description available
App
No description available
Mute
No description available
Inactive
No description available
InputShared
No description available

Enumeration PartyUpdateAction

Unknown
No description available
Join
No description available
Leave
No description available
Invite
No description available
Uninvite
No description available

Enumeration PermissionGrantStatus

Unknown
No description available
Granted
No description available
Denied
No description available
Blocked
No description available

Enumeration PermissionType

Unknown
No description available
Microphone
No description available
WriteExternalStorage
No description available

Enumeration PlatformInitializeResult

Success
= 0
Uninitialized
= -1
PreLoaded
= -2
FileInvalid
= -3
SignatureInvalid
= -4
UnableToVerify
= -5
VersionMismatch
= -6
Unknown
= -7
InvalidCredentials
= -8
NotEntitled
= -9

Enumeration ReportRequestResponse

Unknown
No description available
Handled
Response to the platform notification that the in-app reporting flow request is handled.
Unhandled
Response to the platform notification that the in-app reporting flow request is not handled.
Unavailable
Response to the platform notification that the in-app reporting flow is unavailable or non-existent.

Enumeration RichPresenceExtraContext

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 SdkAccountType

Unknown
No description available
Oculus
No description available
FacebookGameroom
No description available

Enumeration ServiceProvider

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 ShareMediaStatus

Unknown
No description available
Shared
No description available
Canceled
No description available

Enumeration SystemVoipStatus

Unknown
No description available
Unavailable
No description available
Suppressed
No description available
Active
No description available

Enumeration TimeWindow

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 UserOrdering

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 UserPresenceStatus

Unknown
No description available
Online
No description available
Offline
No description available

Enumeration VoipBitrate

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 VoipDtxState

Unknown
No description available
Enabled
No description available
Disabled
No description available

Enumeration VoipMuteState

Unknown
No description available
Muted
No description available
Unmuted
No description available

Enumeration VoipSampleRate

Unknown
No description available
HZ24000
No description available
HZ44100
No description available
HZ48000
No description available

Typedefs

System.ComponentModel.DescriptionAttribute Description

See Also

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