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

FOvrSystemVoipState Struct

The state of the voip that is used in parties and horizon home. This class contains different statuses that is used to control the microphone and input/output for commands or chat in your application. You can read more about system voip here.

Constructors

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

Fields

MicrophoneMuted : EOvrVoipMuteState
A flag that is used to indicate the current state of the microphone. The status can be of the following types:
  • Unknown: EOvrVoipMuteState::Unknown
  • Muted: EOvrVoipMuteState::Muted
  • Unmuted: EOvrVoipMuteState::Unmuted
Signature 
EOvrVoipMuteState FOvrSystemVoipState::MicrophoneMuted
The status enum that indicates the current state of the system voip. The status can be of the following types:
  • Unknown: EOvrSystemVoipStatus::Unknown
  • Unavailable: EOvrSystemVoipStatus::Unavailable
  • Suppressed: EOvrSystemVoipStatus::Suppressed
  • Active: EOvrSystemVoipStatus::Active
Signature 
EOvrSystemVoipStatus FOvrSystemVoipState::Status

Member Functions

Clear ()
Setting all values to their defaults, effectively clearing the struct.
Signature 
void FOvrSystemVoipState::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 FOvrSystemVoipState::Update(ovrSystemVoipStateHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrSystemVoipStateHandle
MessageHandlePtr: TOvrMessageHandlePtr
Returns
void
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta