PartyRegionUpdateMode

Article
02/07/2024

Configuration modes representing how the Party library performs automatic region discovery and connection quality measurement as part of the PartyRegionUpdateConfiguration structure.

Syntax

enum class PartyRegionUpdateMode    
{  
    Immediate = 0,  
    Deferred = 1,  
}

Constants

Constant	Description
Immediate	Automatically begin retrieving the list of available regions and measuring connection quality to them as soon as possible. The Party library automatically discovers the available regions and measures connection quality to them when PartyManager::Initialize() is first invoked. The Party library also periodically refreshes the list and quality measurements until PartyManager::Cleanup() is called. If already connected or in the process of connecting to an existing Party network, then refreshing is delayed until disconnected from all Party networks. The periodic refresh interval can be configured using the refreshIntervalInSeconds field in the containing PartyRegionUpdateConfiguration structure. The application is automatically provided a PartyRegionsChangedStateChange indicating available regions or the failure PartyStateChangeResult whenever a measurement operation completes. This mode is the default value when PartyOption::RegionUpdateConfiguration hasn't been configured.
Deferred	Delay retrieving the list of available regions and measuring connection quality to them until creating a new Party network or using certain text-to-speech or speech-to-text functionality. The Party library doesn't automatically discover the available regions or measure connection quality to them unless the application calls PartyManager::CreateNewNetwork() with a region list array with zero entries, or isn't connected to an existing network but calls PartyLocalChatControl::PopulateAvailableTextToSpeechProfiles(), PartyLocalChatControl::SetTextToSpeechProfile(), or PartyLocalChatControl::SetTranscriptionOptions() with option flags that include PartyVoiceChatTranscriptionOptions::TranscribeSelfRegardlessOfNetworkState. Once deferred region discovery and quality measurement start, a PartyRegionsChangedStateChange indicating available regions or the failure PartyStateChangeResult is provided prior to the triggering operation's PartyCreateNewNetworkCompletedStateChange, PartyPopulateAvailableTextToSpeechProfilesCompletedStateChange, PartySetTextToSpeechProfileCompletedStateChange, or PartySetTranscriptionOptionsCompletedStateChange completion state change. On subsequent calls to the above functions with the described parameters, the region list is retrieved and measured again if the refresh interval has elapsed since the last measurements were successfully performed. If already connected or in the process of connecting to an existing Party network, then refreshing is delayed until disconnected from all Party networks. The refresh interval can be configured using the refreshIntervalInSeconds field in the containing PartyRegionUpdateConfiguration structure. Chat controls internally use local device region latency estimates to optimize service usage for text-to-speech synthesis, speech-to-text transcription, and translation. Using PartyRegionUpdateMode::Deferred may result in these features experiencing higher latency.

Constant

Description

Immediate

Automatically begin retrieving the list of available regions and measuring connection quality to them as soon as possible.

The Party library automatically discovers the available regions and measures connection quality to them when PartyManager::Initialize() is first invoked.

The Party library also periodically refreshes the list and quality measurements until PartyManager::Cleanup() is called. If already connected or in the process of connecting to an existing Party network, then refreshing is delayed until disconnected from all Party networks. The periodic refresh interval can be configured using the refreshIntervalInSeconds field in the containing PartyRegionUpdateConfiguration structure.

The application is automatically provided a PartyRegionsChangedStateChange indicating available regions or the failure PartyStateChangeResult whenever a measurement operation completes.

This mode is the default value when PartyOption::RegionUpdateConfiguration hasn't been configured.

Deferred

Delay retrieving the list of available regions and measuring connection quality to them until creating a new Party network or using certain text-to-speech or speech-to-text functionality.

The Party library doesn't automatically discover the available regions or measure connection quality to them unless the application calls PartyManager::CreateNewNetwork() with a region list array with zero entries, or isn't connected to an existing network but calls PartyLocalChatControl::PopulateAvailableTextToSpeechProfiles(), PartyLocalChatControl::SetTextToSpeechProfile(), or PartyLocalChatControl::SetTranscriptionOptions() with option flags that include PartyVoiceChatTranscriptionOptions::TranscribeSelfRegardlessOfNetworkState. Once deferred region discovery and quality measurement start, a PartyRegionsChangedStateChange indicating available regions or the failure PartyStateChangeResult is provided prior to the triggering operation's PartyCreateNewNetworkCompletedStateChange, PartyPopulateAvailableTextToSpeechProfilesCompletedStateChange, PartySetTextToSpeechProfileCompletedStateChange, or PartySetTranscriptionOptionsCompletedStateChange completion state change.

On subsequent calls to the above functions with the described parameters, the region list is retrieved and measured again if the refresh interval has elapsed since the last measurements were successfully performed. If already connected or in the process of connecting to an existing Party network, then refreshing is delayed until disconnected from all Party networks. The refresh interval can be configured using the refreshIntervalInSeconds field in the containing PartyRegionUpdateConfiguration structure.

Chat controls internally use local device region latency estimates to optimize service usage for text-to-speech synthesis, speech-to-text transcription, and translation. Using PartyRegionUpdateMode::Deferred may result in these features experiencing higher latency.

Requirements

Header: Party.h

Share via

PartyRegionUpdateMode

Syntax

Constants

Requirements

See also

Feedback

Additional resources