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

FOvrMicrophoneAvailabilityState Struct

It represents the availability of a microphone device. It can be retrieved using UOvrRequestsBlueprintLibrary::Voip_GetMicrophoneAvailability(). It has only one field, microphone_available, which is a boolean value that indicates whether a microphone is available or not. This data structure can be used by applications to determine whether they can use the microphone for audio input or not.

Constructors

FOvrMicrophoneAvailabilityState ()
This is the default constructor for the struct, which initializes the ::ovrMicrophoneAvailabilityStateHandle and TOvrMessageHandlePtr to their default values.
Signature
FOvrMicrophoneAvailabilityState::FOvrMicrophoneAvailabilityState()
FOvrMicrophoneAvailabilityState ( OvrHandle , MessageHandlePtr )
Copying values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
FOvrMicrophoneAvailabilityState::FOvrMicrophoneAvailabilityState(ovrMicrophoneAvailabilityStateHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrMicrophoneAvailabilityStateHandle
MessageHandlePtr: TOvrMessageHandlePtr

Fields

MicrophoneAvailable : bool
A boolean indicates whether the microphone is currently available or not. If there is any update on the microphone availability, it will be retrieved as a notification using UOvrPlatformSubsystem::OnVoipMicrophoneAvailabilityStateUpdate().
Signature
bool FOvrMicrophoneAvailabilityState::MicrophoneAvailable

Member Functions

Clear ()
Setting all values to their defaults, effectively clearing the struct.
Signature
void FOvrMicrophoneAvailabilityState::Clear()
Returns
void
Update ( OvrHandle , MessageHandlePtr )
Updating values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
void FOvrMicrophoneAvailabilityState::Update(ovrMicrophoneAvailabilityStateHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrMicrophoneAvailabilityStateHandle
MessageHandlePtr: TOvrMessageHandlePtr
Returns
void