Oculus.Platform Namespace Reference

Namespaces

namespace  Models
 
namespace  Samples
 

Classes

class  AbuseReport
 
class  AbuseReportOptions
 
class  Achievements
 
class  AdvancedAbuseReportOptions
 
class  AndroidPlatform
 
class  Application
 
class  ApplicationLifecycle
 
class  ApplicationOptions
 
class  AssetFile
 
class  Avatar
 
class  Cal
 
class  Callback
 
class  CallbackRunner
 
class  CAPI
 
class  ChallengeOptions
 
class  Challenges
 
class  CloudStorage
 
class  CloudStorage2
 
class  Colocation
 
class  Core
 
class  Entitlements
 
class  GraphAPI
 
class  GroupPresence
 
class  GroupPresenceOptions
 
class  GUIHelper
 
class  HTTP
 
class  IAP
 
interface  IMicrophone
 
class  InviteOptions
 
interface  IVoipPCMSource
 
class  LanguagePack
 
class  Leaderboards
 
class  Livestreaming
 
class  Matchmaking
 
class  MatchmakingOptions
 
class  Media
 
class  Message
 
class  MessageWithAbuseReportRecording
 
class  MessageWithAchievementDefinitions
 
class  MessageWithAchievementProgressList
 
class  MessageWithAchievementUpdate
 
class  MessageWithApplicationVersion
 
class  MessageWithAssetDetails
 
class  MessageWithAssetDetailsList
 
class  MessageWithAssetFileDeleteResult
 
class  MessageWithAssetFileDownloadCancelResult
 
class  MessageWithAssetFileDownloadResult
 
class  MessageWithAssetFileDownloadUpdate
 
class  MessageWithCalApplicationFinalized
 
class  MessageWithCalApplicationProposed
 
class  MessageWithCalApplicationSuggestionList
 
class  MessageWithChallenge
 
class  MessageWithChallengeEntryList
 
class  MessageWithChallengeList
 
class  MessageWithCloudStorageConflictMetadata
 
class  MessageWithCloudStorageData
 
class  MessageWithCloudStorageMetadataList
 
class  MessageWithCloudStorageMetadataUnderLocal
 
class  MessageWithCloudStorageUpdateResponse
 
class  MessageWithDataStoreUnderPrivateUserDataStore
 
class  MessageWithDataStoreUnderPublicUserDataStore
 
class  MessageWithDestinationList
 
class  MessageWithGroupPresenceJoinIntent
 
class  MessageWithGroupPresenceLeaveIntent
 
class  MessageWithHttpTransferUpdate
 
class  MessageWithInstalledApplicationList
 
class  MessageWithInvitePanelResultInfo
 
class  MessageWithLaunchBlockFlowResult
 
class  MessageWithLaunchFriendRequestFlowResult
 
class  MessageWithLaunchInvitePanelFlowResult
 
class  MessageWithLaunchReportFlowResult
 
class  MessageWithLaunchUnblockFlowResult
 
class  MessageWithLeaderboardDidUpdate
 
class  MessageWithLeaderboardEntryList
 
class  MessageWithLeaderboardList
 
class  MessageWithLinkedAccountList
 
class  MessageWithLivestreamingApplicationStatus
 
class  MessageWithLivestreamingStartResult
 
class  MessageWithLivestreamingStatus
 
class  MessageWithLivestreamingVideoStats
 
class  MessageWithMatchmakingAdminSnapshot
 
class  MessageWithMatchmakingBrowseResult
 
class  MessageWithMatchmakingEnqueueResult
 
class  MessageWithMatchmakingEnqueueResultAndRoom
 
class  MessageWithMatchmakingNotification
 
class  MessageWithMatchmakingStatsUnderMatchmakingStats
 
class  MessageWithMicrophoneAvailabilityState
 
class  MessageWithNetSyncConnection
 
class  MessageWithNetSyncSessionList
 
class  MessageWithNetSyncSessionsChangedNotification
 
class  MessageWithNetSyncSetSessionPropertyResult
 
class  MessageWithNetSyncVoipAttenuationValueList
 
class  MessageWithNetworkingPeer
 
class  MessageWithOrgScopedID
 
class  MessageWithParty
 
class  MessageWithPartyID
 
class  MessageWithPartyUnderCurrentParty
 
class  MessageWithPartyUpdateNotification
 
class  MessageWithPidList
 
class  MessageWithPingResult
 
class  MessageWithPlatformInitialize
 
class  MessageWithProductList
 
class  MessageWithPurchase
 
class  MessageWithPurchaseList
 
class  MessageWithRejoinDialogResult
 
class  MessageWithRoom
 
class  MessageWithRoomInviteNotification
 
class  MessageWithRoomInviteNotificationList
 
class  MessageWithRoomList
 
class  MessageWithRoomUnderCurrentRoom
 
class  MessageWithRoomUnderViewerRoom
 
class  MessageWithSdkAccountList
 
class  MessageWithShareMediaResult
 
class  MessageWithString
 
class  MessageWithSystemVoipState
 
class  MessageWithUser
 
class  MessageWithUserAndRoomList
 
class  MessageWithUserDataStoreUpdateResponse
 
class  MessageWithUserList
 
class  MessageWithUserProof
 
class  MessageWithUserReportID
 
class  MultiplayerErrorOptions
 
class  Net
 
class  NetSync
 
class  NetSyncOptions
 
class  Notifications
 
class  OculusPlatformSettingsEditor
 
class  OculusStandalonePlatformResponse
 
class  Packet
 
class  Parties
 
class  PlatformInternal
 
class  PlatformSettings
 
class  Request
 
class  RichPresence
 
class  RichPresenceOptions
 
class  RoomOptions
 
class  Rooms
 
class  RosterOptions
 
class  Session
 
class  StandalonePlatform
 
class  StandalonePlatformSettings
 
class  UserDataStore
 
class  UserOptions
 
class  Users
 
class  Voip
 
class  VoipAudioSourceHiLevel
 
class  VoipOptions
 
class  VoipPCMSourceNative
 
class  Vrcamera
 
class  WindowsPlatform
 

Typedefs

using Description = System.ComponentModel.DescriptionAttribute
 

Enumerations

enum  AbuseReportType : int { AbuseReportType.Unknown, AbuseReportType.Object, AbuseReportType.User }
 
enum  AbuseReportVideoMode : int { AbuseReportVideoMode.Unknown, AbuseReportVideoMode.Collect, AbuseReportVideoMode.Optional, AbuseReportVideoMode.Skip }
 
enum  AchievementType : int { AchievementType.Unknown, AchievementType.Simple, AchievementType.Bitfield, AchievementType.Count }
 
enum  ChallengeCreationType : int { ChallengeCreationType.Unknown, ChallengeCreationType.UserCreated, ChallengeCreationType.DeveloperCreated }
 
enum  ChallengeViewerFilter : int {
  ChallengeViewerFilter.Unknown, ChallengeViewerFilter.AllVisible, ChallengeViewerFilter.Participating, ChallengeViewerFilter.Invited,
  ChallengeViewerFilter.ParticipatingOrInvited
}
 
enum  ChallengeVisibility : int { ChallengeVisibility.Unknown, ChallengeVisibility.InviteOnly, ChallengeVisibility.Public, ChallengeVisibility.Private }
 
enum  CloudStorageDataStatus : int {
  CloudStorageDataStatus.Unknown, CloudStorageDataStatus.InSync, CloudStorageDataStatus.NeedsDownload, CloudStorageDataStatus.RemoteDownloading,
  CloudStorageDataStatus.NeedsUpload, CloudStorageDataStatus.LocalUploading, CloudStorageDataStatus.InConflict
}
 
enum  CloudStorageUpdateStatus : int { CloudStorageUpdateStatus.Unknown, CloudStorageUpdateStatus.Ok, CloudStorageUpdateStatus.BetterVersionStored, CloudStorageUpdateStatus.ManualMergeRequired }
 
enum  KeyValuePairType : int { KeyValuePairType.String, KeyValuePairType.Int, KeyValuePairType.Double, KeyValuePairType.Unknown }
 
enum  LaunchResult : int {
  LaunchResult.Unknown, LaunchResult.Success, LaunchResult.FailedRoomFull, LaunchResult.FailedGameAlreadyStarted,
  LaunchResult.FailedRoomNotFound, LaunchResult.FailedUserDeclined, LaunchResult.FailedOtherReason
}
 
enum  LaunchType : int {
  LaunchType.Unknown, LaunchType.Normal, LaunchType.Invite, LaunchType.Coordinated,
  LaunchType.Deeplink
}
 
enum  LeaderboardFilterType : int { LeaderboardFilterType.None, LeaderboardFilterType.Friends, LeaderboardFilterType.Unknown, LeaderboardFilterType.UserIds }
 
enum  LeaderboardStartAt : int { LeaderboardStartAt.Top, LeaderboardStartAt.CenteredOnViewer, LeaderboardStartAt.CenteredOnViewerOrTop, LeaderboardStartAt.Unknown }
 
enum  LivestreamingAudience : int { LivestreamingAudience.Unknown, LivestreamingAudience.Public, LivestreamingAudience.Friends, LivestreamingAudience.OnlyMe }
 
enum  LivestreamingMicrophoneStatus : int { LivestreamingMicrophoneStatus.Unknown, LivestreamingMicrophoneStatus.MicrophoneOn, LivestreamingMicrophoneStatus.MicrophoneOff }
 
enum  LivestreamingStartStatus : int {
  LivestreamingStartStatus.Success = 1, LivestreamingStartStatus.Unknown = 0, LivestreamingStartStatus.NoPackageSet = -1, LivestreamingStartStatus.NoFbConnect = -2,
  LivestreamingStartStatus.NoSessionId = -3, LivestreamingStartStatus.MissingParameters = -4
}
 
enum  MatchmakingCriterionImportance : int {
  MatchmakingCriterionImportance.Required, MatchmakingCriterionImportance.High, MatchmakingCriterionImportance.Medium, MatchmakingCriterionImportance.Low,
  MatchmakingCriterionImportance.Unknown
}
 
enum  MatchmakingStatApproach : int { MatchmakingStatApproach.Unknown, MatchmakingStatApproach.Trailing, MatchmakingStatApproach.Swingy }
 
enum  MediaContentType : int { MediaContentType.Unknown, MediaContentType.Photo }
 
enum  MultiplayerErrorErrorKey : int {
  MultiplayerErrorErrorKey.Unknown, MultiplayerErrorErrorKey.DestinationUnavailable, MultiplayerErrorErrorKey.DlcRequired, MultiplayerErrorErrorKey.General,
  MultiplayerErrorErrorKey.GroupFull, MultiplayerErrorErrorKey.InviterNotJoinable, MultiplayerErrorErrorKey.LevelNotHighEnough, MultiplayerErrorErrorKey.LevelNotUnlocked,
  MultiplayerErrorErrorKey.NetworkTimeout, MultiplayerErrorErrorKey.NoLongerAvailable, MultiplayerErrorErrorKey.UpdateRequired, MultiplayerErrorErrorKey.TutorialRequired
}
 
enum  NetSyncConnectionStatus : int { NetSyncConnectionStatus.Unknown, NetSyncConnectionStatus.Connecting, NetSyncConnectionStatus.Disconnected, NetSyncConnectionStatus.Connected }
 
enum  NetSyncDisconnectReason : int {
  NetSyncDisconnectReason.Unknown, NetSyncDisconnectReason.LocalTerminated, NetSyncDisconnectReason.ServerTerminated, NetSyncDisconnectReason.Failed,
  NetSyncDisconnectReason.Lost
}
 
enum  NetSyncVoipMicSource : int { NetSyncVoipMicSource.Unknown, NetSyncVoipMicSource.None, NetSyncVoipMicSource.Internal }
 
enum  NetSyncVoipStreamMode : int { NetSyncVoipStreamMode.Unknown, NetSyncVoipStreamMode.Ambisonic, NetSyncVoipStreamMode.Mono }
 
enum  PartyUpdateAction : int {
  PartyUpdateAction.Unknown, PartyUpdateAction.Join, PartyUpdateAction.Leave, PartyUpdateAction.Invite,
  PartyUpdateAction.Uninvite
}
 
enum  PeerConnectionState : int { PeerConnectionState.Unknown, PeerConnectionState.Connected, PeerConnectionState.Timeout, PeerConnectionState.Closed }
 
enum  PermissionGrantStatus : int { PermissionGrantStatus.Unknown, PermissionGrantStatus.Granted, PermissionGrantStatus.Denied, PermissionGrantStatus.Blocked }
 
enum  PermissionType : int { PermissionType.Unknown, PermissionType.Microphone, PermissionType.WriteExternalStorage }
 
enum  PlatformInitializeResult : int {
  PlatformInitializeResult.Success = 0, PlatformInitializeResult.Uninitialized = -1, PlatformInitializeResult.PreLoaded = -2, PlatformInitializeResult.FileInvalid = -3,
  PlatformInitializeResult.SignatureInvalid = -4, PlatformInitializeResult.UnableToVerify = -5, PlatformInitializeResult.VersionMismatch = -6, PlatformInitializeResult.Unknown = -7,
  PlatformInitializeResult.InvalidCredentials = -8, PlatformInitializeResult.NotEntitled = -9
}
 
enum  RichPresenceExtraContext : int {
  RichPresenceExtraContext.Unknown, RichPresenceExtraContext.None, RichPresenceExtraContext.CurrentCapacity, RichPresenceExtraContext.StartedAgo,
  RichPresenceExtraContext.EndingIn, RichPresenceExtraContext.LookingForAMatch
}
 
enum  RoomJoinability : int {
  RoomJoinability.Unknown, RoomJoinability.AreIn, RoomJoinability.AreKicked, RoomJoinability.CanJoin,
  RoomJoinability.IsFull, RoomJoinability.NoViewer, RoomJoinability.PolicyPrevents
}
 
enum  RoomJoinPolicy : int {
  RoomJoinPolicy.None, RoomJoinPolicy.Everyone, RoomJoinPolicy.FriendsOfMembers, RoomJoinPolicy.FriendsOfOwner,
  RoomJoinPolicy.InvitedUsers, RoomJoinPolicy.Unknown
}
 
enum  RoomMembershipLockStatus : int { RoomMembershipLockStatus.Unknown, RoomMembershipLockStatus.Lock, RoomMembershipLockStatus.Unlock }
 
enum  RoomType : int {
  RoomType.Unknown, RoomType.Matchmaking, RoomType.Moderated, RoomType.Private,
  RoomType.Solo
}
 
enum  SdkAccountType : int { SdkAccountType.Unknown, SdkAccountType.Oculus, SdkAccountType.FacebookGameroom }
 
enum  SendPolicy : int { SendPolicy.Unreliable, SendPolicy.Reliable, SendPolicy.Unknown }
 
enum  ServiceProvider : int {
  ServiceProvider.Unknown, ServiceProvider.Dropbox, ServiceProvider.Facebook, ServiceProvider.Google,
  ServiceProvider.Instagram, ServiceProvider.RemoteMedia
}
 
enum  ShareMediaStatus : int { ShareMediaStatus.Unknown, ShareMediaStatus.Shared, ShareMediaStatus.Canceled }
 
enum  SystemVoipStatus : int { SystemVoipStatus.Unknown, SystemVoipStatus.Unavailable, SystemVoipStatus.Suppressed, SystemVoipStatus.Active }
 
enum  TimeWindow : int {
  TimeWindow.Unknown, TimeWindow.OneHour, TimeWindow.OneDay, TimeWindow.OneWeek,
  TimeWindow.ThirtyDays, TimeWindow.NinetyDays
}
 
enum  UserOrdering : int { UserOrdering.Unknown, UserOrdering.None, UserOrdering.PresenceAlphabetical }
 
enum  UserPresenceStatus : int { UserPresenceStatus.Unknown, UserPresenceStatus.Online, UserPresenceStatus.Offline }
 
enum  VoipBitrate : int {
  VoipBitrate.Unknown, VoipBitrate.B16000, VoipBitrate.B24000, VoipBitrate.B32000,
  VoipBitrate.B64000, VoipBitrate.B96000, VoipBitrate.B128000
}
 
enum  VoipDtxState : int { VoipDtxState.Unknown, VoipDtxState.Enabled, VoipDtxState.Disabled }
 
enum  VoipMuteState : int { VoipMuteState.Unknown, VoipMuteState.Muted, VoipMuteState.Unmuted }
 
enum  VoipSampleRate : int { VoipSampleRate.Unknown, VoipSampleRate.HZ24000, VoipSampleRate.HZ44100, VoipSampleRate.HZ48000 }
 

Typedef Documentation

◆ Description

typedef System ComponentModel DescriptionAttribute Oculus.Platform.Description

Enumeration Type Documentation

◆ AbuseReportType

Enumerator
Unknown 
Object 

A report for something besides a user, like a world.

User 

A report for a user's behavior or profile.

◆ AbuseReportVideoMode

Enumerator
Unknown 
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.

◆ AchievementType

Enumerator
Unknown 
Simple 
Bitfield 
Count 

◆ ChallengeCreationType

Enumerator
Unknown 
UserCreated 
DeveloperCreated 

◆ ChallengeViewerFilter

Enumerator
Unknown 
AllVisible 
Participating 
Invited 
ParticipatingOrInvited 

◆ ChallengeVisibility

Enumerator
Unknown 
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.

◆ CloudStorageDataStatus

Enumerator
Unknown 
InSync 
NeedsDownload 
RemoteDownloading 
NeedsUpload 
LocalUploading 
InConflict 

◆ CloudStorageUpdateStatus

Enumerator
Unknown 
Ok 
BetterVersionStored 
ManualMergeRequired 

◆ KeyValuePairType

Enumerator
String 
Int 
Double 
Unknown 

◆ LaunchResult

enum Oculus.Platform.LaunchResult : int
strong
Enumerator
Unknown 
Success 
FailedRoomFull 
FailedGameAlreadyStarted 
FailedRoomNotFound 
FailedUserDeclined 
FailedOtherReason 

◆ LaunchType

enum Oculus.Platform.LaunchType : int
strong
Enumerator
Unknown 
Normal 
Invite 
Coordinated 
Deeplink 

◆ LeaderboardFilterType

Enumerator
None 
Friends 
Unknown 
UserIds 

◆ LeaderboardStartAt

Enumerator
Top 
CenteredOnViewer 
CenteredOnViewerOrTop 
Unknown 

◆ LivestreamingAudience

Enumerator
Unknown 
Public 
Friends 
OnlyMe 

◆ LivestreamingMicrophoneStatus

Enumerator
Unknown 
MicrophoneOn 
MicrophoneOff 

◆ LivestreamingStartStatus

Enumerator
Success 
Unknown 
NoPackageSet 
NoFbConnect 
NoSessionId 
MissingParameters 

◆ MatchmakingCriterionImportance

Enumerator
Required 
High 
Medium 
Low 
Unknown 

◆ MatchmakingStatApproach

Enumerator
Unknown 
Trailing 
Swingy 

◆ MediaContentType

Enumerator
Unknown 
Photo 

◆ MultiplayerErrorErrorKey

Enumerator
Unknown 
DestinationUnavailable 
DlcRequired 
General 
GroupFull 
InviterNotJoinable 
LevelNotHighEnough 
LevelNotUnlocked 
NetworkTimeout 
NoLongerAvailable 
UpdateRequired 
TutorialRequired 

◆ NetSyncConnectionStatus

Enumerator
Unknown 
Connecting 
Disconnected 
Connected 

◆ NetSyncDisconnectReason

Enumerator
Unknown 
LocalTerminated 

when disconnect was requested

ServerTerminated 

server intentionally closed the connection

Failed 

initial connection never succeeded

Lost 

network timeout

◆ NetSyncVoipMicSource

Enumerator
Unknown 
None 
Internal 

◆ NetSyncVoipStreamMode

Enumerator
Unknown 
Ambisonic 
Mono 

◆ PartyUpdateAction

Enumerator
Unknown 
Join 
Leave 
Invite 
Uninvite 

◆ PeerConnectionState

Enumerator
Unknown 
Connected 

Connection to the peer is established.

Timeout 

A timeout expired while attempting to (re)establish a connection. This can happen if peer is unreachable or rejected the connection.

Closed 

Connection to the peer is closed. A connection transitions into this state when it is explicitly closed by either the local or remote peer calling Net.Close(). It also enters this state if the remote peer no longer responds to our keep-alive probes.

◆ PermissionGrantStatus

Enumerator
Unknown 
Granted 
Denied 
Blocked 

◆ PermissionType

enum Oculus.Platform.PermissionType : int
strong
Enumerator
Unknown 
Microphone 
WriteExternalStorage 

◆ PlatformInitializeResult

Enumerator
Success 
Uninitialized 
PreLoaded 
FileInvalid 
SignatureInvalid 
UnableToVerify 
VersionMismatch 
Unknown 
InvalidCredentials 
NotEntitled 

◆ RichPresenceExtraContext

Enumerator
Unknown 
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.

◆ RoomJoinability

Enumerator
Unknown 
AreIn 
AreKicked 
CanJoin 
IsFull 
NoViewer 
PolicyPrevents 

◆ RoomJoinPolicy

enum Oculus.Platform.RoomJoinPolicy : int
strong
Enumerator
None 
Everyone 
FriendsOfMembers 
FriendsOfOwner 
InvitedUsers 
Unknown 

◆ RoomMembershipLockStatus

Enumerator
Unknown 
Lock 
Unlock 

◆ RoomType

enum Oculus.Platform.RoomType : int
strong
Enumerator
Unknown 
Matchmaking 
Moderated 
Private 
Solo 

◆ SdkAccountType

enum Oculus.Platform.SdkAccountType : int
strong
Enumerator
Unknown 
Oculus 
FacebookGameroom 

◆ SendPolicy

enum Oculus.Platform.SendPolicy : int
strong
Enumerator
Unreliable 

Sends a message using an unreliable data channel (UDP-based). No delivery or ordering guarantees are provided. Sending will fail unless a connection to the peer is already established, either via a previous call to Net.SendPacket() or an explicit Net.Connect().

Ideally, each message should fit into a single packet. Therefore, it is recommended to keep them under 1200 bytes.

Reliable 

Messages are delivered reliably and in order. The networking layer retries until each message is acknowledged by the peer. Outgoing messages are buffered until a working connection to the peer is established.

Unknown 

◆ ServiceProvider

Enumerator
Unknown 
Dropbox 
Facebook 
Google 
Instagram 
RemoteMedia 

◆ ShareMediaStatus

Enumerator
Unknown 
Shared 
Canceled 

◆ SystemVoipStatus

Enumerator
Unknown 
Unavailable 
Suppressed 
Active 

◆ TimeWindow

enum Oculus.Platform.TimeWindow : int
strong
Enumerator
Unknown 
OneHour 
OneDay 
OneWeek 
ThirtyDays 
NinetyDays 

◆ UserOrdering

enum Oculus.Platform.UserOrdering : int
strong
Enumerator
Unknown 
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

◆ UserPresenceStatus

Enumerator
Unknown 
Online 
Offline 

◆ VoipBitrate

enum Oculus.Platform.VoipBitrate : int
strong
Enumerator
Unknown 
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.

◆ VoipDtxState

enum Oculus.Platform.VoipDtxState : int
strong
Enumerator
Unknown 
Enabled 
Disabled 

◆ VoipMuteState

enum Oculus.Platform.VoipMuteState : int
strong
Enumerator
Unknown 
Muted 
Unmuted 

◆ VoipSampleRate

enum Oculus.Platform.VoipSampleRate : int
strong
Enumerator
Unknown 
HZ24000 
HZ44100 
HZ48000