Vivox allows developers to control how frequently participant update events are generated in their applications. In the Core SDK, this is managed by the participant_property_frequency setting, while in the Unity and Unreal SDKs, it is set via ParticipantPropertyUpdateFrequency and SetParticipantSpeakingUpdateRate, respectively. Options include updates on speech state changes only (default), at set intervals (1, 5, or 10 Hz), or disabling updates entirely, offering flexible event management.
CORE
In the Vivox Core SDK, the req_account_anonymous_login member participant_property_frequency controls how often participant update events are generated.
| Frequency | participant_property_frequency |
| Never | 0 |
| 10 Hz | 5 |
| 5 Hz | 10 |
| 1 Hz | 50 |
| Participant speaking state change (default) | 100 |
Example:
vx_req_account_anonymous_login_t *req; vx_req_account_anonymous_login_create(&req); req->participant_property_frequency = 10; // update frequency of 5 Hz
UNITY
In the Vivox Unity SDK, the LoginOptions property ParticipantPropertyUpdateFrequency controls how often participant update events are generated.
| Frequency | ParticipantPropertyUpdateFrequency |
| Never | ParticipantPropertyUpdateFrequency.Never |
| 10 Hz | ParticipantPropertyUpdateFrequency.TenPerSecond |
| 5 Hz | ParticipantPropertyUpdateFrequency.FivePerSecond |
| 1 Hz | ParticipantPropertyUpdateFrequency.OnePerSecond |
| Participant speaking state change (default) | ParticipantPropertyUpdateFrequency.StateChange |
Example:
var loginOptions = new LoginOptions()
{
ParticipantUpdateFrequency = ParticipantPropertyUpdateFrequency.FivePerSecond
};
await VivoxService.Instance.LoginAsync(loginOptions);
UNREAL
In the Vivox Unreal SDK, the ILoginSession function SetParticipantSpeakingUpdateRate controls how often participant update events are generated.
| Frequency | SetParticipantSpeakingUpdateRate |
| Never | ParticipantSpeakingUpdateRate::Never |
| 10 Hz | ParticipantSpeakingUpdateRate::Update1Hz |
| 5 Hz | ParticipantSpeakingUpdateRate::Update5Hz |
| 1 Hz | ParticipantSpeakingUpdateRate::Update10Hz |
| Participant speaking state change (default) | ParticipantSpeakingUpdateRate::StateChange |
Example:
LoginSession = &VivoxVoiceClient->GetLoginSession(MyAccount); LoginSession->SetParticipantSpeakingUpdateRate(ParticipantSpeakingUpdateRate::Update5Hz); LoginSession->BeginLogin(VIVOX_VOICE_SERVER, GetLoginToken(LoginSession), OnBeginLoginCompleteCallback);