Meta Developers

Build with Meta

Social Technologies

About us

Virtual reality / Meta Horizon

Meta Horizon Creator Program

Discover

Why Meta Quest?

What is mixed reality?

Platforms and tools

2D apps for Meta Horizon OS

Success stories

Support and legal

Developer policies

Build with Meta

Social Technologies

About us

Virtual reality / Meta Horizon

Meta Horizon Creator Program

Discover

Why Meta Quest?

What is mixed reality?

Platforms and tools

2D apps for Meta Horizon OS

Success stories

Support and legal

Developer policies

Build with Meta

Social Technologies

About us

Virtual reality / Meta Horizon

Meta Horizon Creator Program

Discover

Why Meta Quest?

What is mixed reality?

Platforms and tools

2D apps for Meta Horizon OS

Success stories

Support and legal

Developer policies

English (US)

© 2025 Meta

API reference

API reference

Select your platform

No SDKs available

No versions available

FNetworkProtocolTypes

FOvrAbuseReportOptions

FOvrAbuseReportRecording

FOvrAchievementDefinition

FOvrAchievementDefinitionPages

FOvrAchievementProgress

FOvrAchievementProgressPages

FOvrAchievementUpdate

FOvrAdvancedAbuseReportOptions

FOvrAppDownloadProgressResult

FOvrAppDownloadResult

FOvrApplicationInvite

FOvrApplicationInvitePages

FOvrApplicationOptions

FOvrApplicationVersion

FOvrAssetDetails

FOvrAssetFileDeleteResult

FOvrAssetFileDownloadCancelResult

FOvrAssetFileDownloadResult

FOvrAssetFileDownloadUpdate

FOvrAvatarEditorOptions

FOvrAvatarEditorResult

FOvrBlockedUser

FOvrBlockedUserPages

FOvrChallengeEntry

FOvrChallengeEntryPages

FOvrChallengeOptions

FOvrChallengePages

FOvrCowatchViewer

FOvrCowatchViewerPages

FOvrCowatchViewerUpdate

FOvrCowatchingState

FOvrDestination

FOvrDestinationPages

FOvrGroupPresenceJoinIntent

FOvrGroupPresenceLeaveIntent

FOvrGroupPresenceOptions

FOvrHttpTransferUpdate

FOvrInstalledApplication

FOvrInviteOptions

FOvrInvitePanelResultInfo

FOvrLanguagePackInfo

FOvrLaunchBlockFlowResult

FOvrLaunchDetails

FOvrLaunchFriendRequestFlowResult

FOvrLaunchInvitePanelFlowResult

FOvrLaunchReportFlowResult

FOvrLaunchUnblockFlowResult

FOvrLeaderboard

FOvrLeaderboardEntry

FOvrLeaderboardEntryPages

FOvrLeaderboardPages

FOvrLeaderboardUpdateStatus

FOvrLinkedAccount

FOvrLivestreamingApplicationStatus

FOvrLivestreamingStartResult

FOvrLivestreamingStatus

FOvrLivestreamingVideoStats

FOvrManagedInfo

FOvrMicrophoneAvailabilityState

FOvrMultiplayerErrorOptions

FOvrNetSyncConnection

FOvrNetSyncOptions

FOvrNetSyncSession

FOvrNetSyncSessionsChangedNotification

FOvrNetSyncSetSessionPropertyResult

FOvrNetSyncVoipAttenuationValue

FOvrOrgScopedID

FOvrPageRequestLatentAction

FOvrPartyUpdateNotification

FOvrPlatformInitialize

FOvrPlatformModule

FOvrPreemptableLatentAction

FOvrProductPages

FOvrPurchasePages

FOvrRejoinDialogResult

FOvrRequestLatentAction

FOvrRichPresenceOptions

FOvrRosterOptions

FOvrSendInvitesResult

FOvrShareMediaResult

FOvrSupplementaryMetric

FOvrSystemVoipState

FOvrUserAccountAgeCategory

FOvrUserCapability

FOvrUserCapabilityPages

FOvrUserDataStoreUpdateResponse

FOvrUserOptions

FOvrUserReportID

FOvrVoipDecoder

FOvrVoipEncoder

FOvrVoipOptions

OVRPlatformCppPageRequests.h

OVRPlatformCppRequests.h

OVRPlatformEnums.h

OVRPlatformFunctions.h

OVRPlatformModels.h

OVRPlatformOptions.h

OVRPlatformPageRequests.h

OVRPlatformRequests.h

OVRPlatformRequestsSupport.h

OVRPlatformSubsystem.h

OVRPlatformTypes.h

OVRPlatformUtils.h

OVR_AbuseReportOptions.h

OVR_AbuseReportRecording.h

OVR_AbuseReportType.h

OVR_AbuseReportVideoMode.h

OVR_AccountAgeCategory.h

OVR_AchievementDefinition.h

OVR_AchievementDefinitionArray.h

OVR_AchievementProgress.h

OVR_AchievementProgressArray.h

OVR_AchievementType.h

OVR_AchievementUpdate.h

OVR_AdvancedAbuseReportOptions.h

OVR_AppAgeCategory.h

OVR_AppDownloadProgressResult.h

OVR_AppDownloadResult.h

OVR_AppInstallResult.h

OVR_AppStatus.h

OVR_ApplicationInvite.h

OVR_ApplicationInviteArray.h

OVR_ApplicationOptions.h

OVR_ApplicationVersion.h

OVR_AssetDetails.h

OVR_AssetDetailsArray.h

OVR_AssetFileDeleteResult.h

OVR_AssetFileDownloadCancelResult.h

OVR_AssetFileDownloadResult.h

OVR_AssetFileDownloadUpdate.h

OVR_AvatarEditorOptions.h

OVR_AvatarEditorResult.h

OVR_BlockedUser.h

OVR_BlockedUserArray.h

OVR_Challenge.h

OVR_ChallengeArray.h

OVR_ChallengeCreationType.h

OVR_ChallengeEntry.h

OVR_ChallengeEntryArray.h

OVR_ChallengeOptions.h

OVR_ChallengeViewerFilter.h

OVR_ChallengeVisibility.h

OVR_CowatchViewer.h

OVR_CowatchViewerArray.h

OVR_CowatchViewerUpdate.h

OVR_CowatchingState.h

OVR_DataStore.h

OVR_Destination.h

OVR_DestinationArray.h

OVR_Functions_ApplicationLifecycle.h

OVR_Functions_Voip.h

OVR_GroupPresenceJoinIntent.h

OVR_GroupPresenceLeaveIntent.h

OVR_GroupPresenceOptions.h

OVR_HttpTransferUpdate.h

OVR_InstalledApplication.h

OVR_InstalledApplicationArray.h

OVR_InviteOptions.h

OVR_InvitePanelResultInfo.h

OVR_KeyValuePairType.h

OVR_LanguagePackInfo.h

OVR_LaunchBlockFlowResult.h

OVR_LaunchDetails.h

OVR_LaunchFriendRequestFlowResult.h

OVR_LaunchInvitePanelFlowResult.h

OVR_LaunchReportFlowResult.h

OVR_LaunchResult.h

OVR_LaunchType.h

OVR_LaunchUnblockFlowResult.h

OVR_Leaderboard.h

OVR_LeaderboardArray.h

OVR_LeaderboardEntry.h

OVR_LeaderboardEntryArray.h

OVR_LeaderboardFilterType.h

OVR_LeaderboardStartAt.h

OVR_LeaderboardUpdateStatus.h

OVR_LinkedAccount.h

OVR_LinkedAccountArray.h

OVR_LivestreamingApplicationStatus.h

OVR_LivestreamingAudience.h

OVR_LivestreamingMicrophoneStatus.h

OVR_LivestreamingStartResult.h

OVR_LivestreamingStartStatus.h

OVR_LivestreamingStatus.h

OVR_LivestreamingVideoStats.h

OVR_LogEventName.h

OVR_LogEventParameter.h

OVR_ManagedInfo.h

OVR_MediaContentType.h

OVR_MessageType.h

OVR_Microphone.h

OVR_MicrophoneAvailabilityState.h

OVR_MultiplayerErrorErrorKey.h

OVR_MultiplayerErrorOptions.h

OVR_NetSyncConnection.h

OVR_NetSyncConnectionStatus.h

OVR_NetSyncDisconnectReason.h

OVR_NetSyncOptions.h

OVR_NetSyncSession.h

OVR_NetSyncSessionArray.h

OVR_NetSyncSessionsChangedNotification.h

OVR_NetSyncSetSessionPropertyResult.h

OVR_NetSyncVoipAttenuationValue.h

OVR_NetSyncVoipAttenuationValueArray.h

OVR_NetSyncVoipMicSource.h

OVR_NetSyncVoipStreamMode.h

OVR_OrgScopedID.h

OVR_PartyMicState.h

OVR_PartyUpdateAction.h

OVR_PartyUpdateNotification.h

OVR_PermissionGrantStatus.h

OVR_PermissionType.h

OVR_PlatformInitialize.h

OVR_PlatformInitializeResult.h

OVR_PlatformVersion.h

OVR_Platform_Defs.h

OVR_ProductArray.h

OVR_ProductType.h

OVR_PurchaseArray.h

OVR_RejoinDialogResult.h

OVR_ReportRequestResponse.h

OVR_Requests_AbuseReport.h

OVR_Requests_Achievements.h

OVR_Requests_Application.h

OVR_Requests_ApplicationLifecycle.h

OVR_Requests_AssetFile.h

OVR_Requests_Avatar.h

OVR_Requests_Challenges.h

OVR_Requests_Cowatching.h

OVR_Requests_DeviceApplicationIntegrity.h

OVR_Requests_Entitlement.h

OVR_Requests_GroupPresence.h

OVR_Requests_IAP.h

OVR_Requests_LanguagePack.h

OVR_Requests_Leaderboard.h

OVR_Requests_Media.h

OVR_Requests_Notification.h

OVR_Requests_Party.h

OVR_Requests_RichPresence.h

OVR_Requests_User.h

OVR_Requests_UserAgeCategory.h

OVR_Requests_Voip.h

OVR_RichPresenceExtraContext.h

OVR_RichPresenceOptions.h

OVR_RosterOptions.h

OVR_SdkAccount.h

OVR_SdkAccountArray.h

OVR_SdkAccountType.h

OVR_SendInvitesResult.h

OVR_ServiceProvider.h

OVR_ShareMediaResult.h

OVR_ShareMediaStatus.h

OVR_SupplementaryMetric.h

OVR_SystemVoipState.h

OVR_SystemVoipStatus.h

OVR_TimeWindow.h

OVR_UserAccountAgeCategory.h

OVR_UserArray.h

OVR_UserCapability.h

OVR_UserCapabilityArray.h

OVR_UserDataStoreUpdateResponse.h

OVR_UserOptions.h

OVR_UserOrdering.h

OVR_UserPresenceStatus.h

OVR_UserProof.h

OVR_UserReportID.h

OVR_VoipBitrate.h

OVR_VoipDecoder.h

OVR_VoipDtxState.h

OVR_VoipEncoder.h

OVR_VoipMuteState.h

OVR_VoipOptions.h

OVR_VoipSampleRate.h

OVR_Voip_LowLevel.h

TOvrMessageHandle

UOvrAchievementDefinitionPagesMethods

UOvrAchievementProgressPagesMethods

UOvrApplicationInvitePagesMethods

UOvrBlockedUserPagesMethods

UOvrChallengeEntryPagesMethods

UOvrChallengePagesMethods

UOvrCowatchViewerPagesMethods

UOvrDestinationPagesMethods

UOvrFunctionsBlueprintLibrary

UOvrLeaderboardEntryPagesMethods

UOvrLeaderboardPagesMethods

UOvrMicrophoneMethods

UOvrPacketMethods

UOvrPageRequestsBlueprintLibrary

UOvrPlatformSubsystem

UOvrPlatformUtilsLibrary

UOvrProductPagesMethods

UOvrPurchasePagesMethods

UOvrRequestsBlueprintLibrary

UOvrUserCapabilityPagesMethods

UOvrUserPagesMethods

UOvrVoipDecoderMethods

UOvrVoipEncoderMethods

ovrKeyValuePair

ovrOculusInitParams

Supported platforms

OVR_Microphone.h

Back to Supported platforms

OVR_Microphone.h File

This object provides a comprehensive way to access and manipulate audio data from a microphone device. Its availability can be retrieving using ovr_MicrophoneAvailabilityState_GetMicrophoneAvailable(). With Microphone class, developers can build engaging and interactive applications that leverage real-time audio input, such as voice chat, audio recording, or speech recognition.

Typedefs

struct ovrMicrophone * ovrMicrophoneHandle

Functions

size_t ovr_Microphone_GetNumSamplesAvailable

( const ovrMicrophoneHandle obj )

Returns the minimum number of samples available to be read. This function is inherently racy, it is possible that more samples may be returned by the next call to getPCM. This function is only implemented on Android. Windows will always return 0.

size_t ovr_Microphone_GetOutputBufferMaxSize

( const ovrMicrophoneHandle obj )

Returns the size of the internal ringbuffer used by the microhone in elements. This size is the maximum number of elements that can ever be returned by ovr_Microphone_GetPCM()*.This function can be safely called from any thread.

size_t ovr_Microphone_GetPCM

( const ovrMicrophoneHandle obj,

int16_t * outputBuffer,

size_t outputBufferNumElements )

Gets all available samples of microphone data and copies it into outputBuffer. The microphone will generate data at roughly the rate of 480 samples per 10ms. The data format is 16 bit fixed point 48khz mono.This function can be safely called from any thread.

size_t ovr_Microphone_GetPCMFloat

( const ovrMicrophoneHandle obj,

float * outputBuffer,

size_t outputBufferNumElements )

Gets all available samples of microphone data and copies it into outputBuffer. The microphone will generate data at roughly the rate of 480 samples per 10ms. The data format is 32 bit floating point 48khz mono.This function can be safely called from any thread.

size_t ovr_Microphone_ReadData

( const ovrMicrophoneHandle obj,

float * outputBuffer,

size_t outputBufferSize )

Gets all available samples of microphone data and copies it into outputBuffer. The microphone will generate data at roughly the rate of 480 samples per 10ms. The data format is 32 bit floating point 48khz mono.This function can be safely called from any thread. Deprecated

Use ovr_Microphone_GetPCMFloat() instead.

void ovr_Microphone_SetAcceptableRecordingDelayHint

( const ovrMicrophoneHandle obj,

size_t delayMs )

Indicates that the caller is fine with a certain delay in the delivery of recorded audio frames. Setting this to a low value will reduce the latency at the cost of efficiency. Note that this is only a hint; the actual implementation may ignore it.

void ovr_Microphone_SetAudioDataAvailableCallback

( const ovrMicrophoneHandle obj,

MicrophoneDataAvailableCallback cb,

void * userData )

Register a callback that will be called whenever audio data is available for the microphone.

void ovr_Microphone_Start

( const ovrMicrophoneHandle obj )

Starts microphone recording. The VoIP session can be established by ovr_Voip_Start(). After this is called pcm data can be extracted using ovr_Microphone_GetPCM().This function can be safely called from any thread.

void ovr_Microphone_Stop

( const ovrMicrophoneHandle obj )

Stops microphone recording. The VoIP session can be terminated by ovr_Voip_Stop().This function can be safely called from any thread.

Did you find this page helpful?

Why Meta Quest?

Login