Class LoginOptions#

The options used to control Login behaviour - like enabling Text to Speech, setting a display name, or loading a blocked user list

Namespace: Unity.Services.Vivox#

Syntax#

public sealed class LoginOptions

Properties#

BlockedUserList#

A list of Account identifiers to be blocked immediately upon login.

Declaration#

public List<string> BlockedUserList { get; set; }

Property Value#

DisplayName#

The DisplayName used by the LoginSession. This is not intended to be the unique ID of a user.

Declaration#

public string DisplayName { get; set; }

Property Value#

EnableTTS#

Whether or not to enable Text-to-Speech for this account - disabling it will prevent Text-to-Speech messages from being sent or received.

Declaration#

public bool EnableTTS { get; set; }

Property Value#

ParticipantUpdateFrequency#

How frequently you would like to receieve participant updates events for all channels.

Declaration#

public ParticipantPropertyUpdateFrequency ParticipantUpdateFrequency { get; set; }

Property Value#

PlayerId#

An override for a player's unique identifier that is only applied when the Authentication SDK is not in use. By default, the local user is signed into Vivox using either a generated GUID or the Authentication service's PlayerId if that SDK is being used in a project. Only a generated GUID can be overridden when using this property.

Declaration#

public string PlayerId { get; set; }

Property Value#

SpeechToTextLanguages#

A list of languages used as hints for audio transcription. The default is an empty array, which implies "en". You can specify up to three spoken languages in order of preference to inform transcription of all users in transcribed channels. IETF language tag strings are not validated, but are expected to conform to BCP 47.

Declaration#

public List<string> SpeechToTextLanguages { get; set; }

Property Value#