Detailed Description

Fetches settings from the DefaultYourOpenMetaverse.ini.

Inheritance diagram for UYomSettings:

Static Public Member Functions
static int	PreviewImageSizeXY ()
	The size of the preview image in both the x and y direction. More...

static int	PreviewImageQuality ()
	The compression quality of the preview image. More...

static bool	LocalPreviewImages ()
	If YomPortals should fetch images from the web or from the disk Fetching from disk will show image of the portal itself. More...

static bool	TestPortals ()
	Whether the portals are in testing mode, if in testing mode they will fetch fake api calls from the disk It is recommended to set this value to true as the api call goes to a matchmaker that will not exist on your pc. More...

static const FString &	PortalImageDir ()
	The directory to store and fetch preview images from (cannot be set) More...

static FString	PortalImagePath (const FString &pFileName)
	Gets the path of a preview image. More...

static bool	DisableVoiceChat ()
	Disables voice chat but does state whether it was enabled correctly. More...

static float	GlobalFalloffDistance ()
	The maximum value at which players can talk to each other. More...

static int	SamplingRate ()
	The sample rate of the voice send over the unreal network. More...

static int	NumChannels ()
	The number of channels that are used internally for voice in unreal. More...

static int	VoiceChatFPS ()
	The fps at which the voice chat runs, increasing this improves latency, but increases amount of packets send. More...

static float	MinSpeakingTime ()
	The amount of time a player needs to speak in order for sound to be send over the network. More...

static float	ReleaseTimeSeconds ()
	The amount of seconds the noise gate will be opened after the player stopped talking. More...

static float	SignallingBufferSeconds ()
	The amount of delay for the udp buffer of the signalling server, this buffer ensures that the voice of the signalling server does not sound robotic. More...

static float	PlaybackBufferSeconds ()
	The amount of jitter buffer for playback of a voice, this buffer ensures that packets are played fluently to the current client. More...

static float	InternalBufferSeconds ()
	The amount of seconds of the buffer between two clients in unreal, this buffer ensures that packets are played in the correct order. More...

static int	AudioCutoffThreshold ()
	The threshold for how much sound there must be before sound is sent over the network. More...

static bool	ListenToSelf ()
	Whether the player can listen to themselves. More...

static bool	IsSoundLogEnabled ()
	Display logs about sound recording. More...

static bool	IsConnectionLogEnabled ()
	Display logs about the connection between the client and the server. More...

static bool	IsPlaybackLogEnabled ()
	Display logs about playing sound back to the players. More...

static bool	IsRecordingYomVoiceEnabled ()
	Whether we should record the YomVoice RawPCM data to the disk Puts the recording file under {projectRoot}/recording.bin. More...

YomCore settings
static bool	UseSolanaDevnet ()
	Whether to use devnet instead of mainnet of Solana. More...

static bool	UseTestPlayer ()
	Whether to use the TestWallet instead of the a blockchain wallet. More...

static bool	SpawnDefaultPlayer ()
	Whether to spawn a default player in the metaspace If set to false the player can only spawn through the signalling server. More...

static bool	SimulateEmptyOverlayPress ()
	Whether to simulate the pressing of a player without a wallet, for testing the virtual camera NOTE: is overriden by SpawnDefaultPlayer. More...

static const FString &	DefaultPlayerID ()
	Returns the default PlayerID for a player that is spawned with SpawnDefaultPlayer set to true. More...

static bool	DisablePixelStreamInput ()
	Disables the pixel streaming input for better play in editor. More...

static const FString &	ServerIP ()
	Returns the current serverIP setting. More...

static const FString &	MetaspaceId ()
	Returns the current metasapceId setting. More...

YomPortals Settings
static FString	GetPortalUrl (int pIndex)
	Gets the portal url from the settings. More...

Blueprint Functions
static void	SetAudioCutoffThreshold (int pThreshold)
	Sets a new audio cutoff threshold for this instance. More...

static bool	GetEnvironmentBool (const FString &pKey)
	Get the value of a boolean EnvironmentVariable by providing its name. More...

static FString	GetEnvironmentString (const FString &pKey)
	Get the value of a string EnvironmentVariable by providing its name. More...

static float	GetEnvironmentFloat (const FString &pKey)
	Get the value of a float EnvironmentVariable by providing its name. More...

static int	GetEnvironmentInt (const FString &pKey)
	Get the value of an int EnvironmentVariable by providing its name. More...

static void	AddOrUpdateEnvironmentBool (const FString &pKey, bool pValue)
	Add or Update the value of a bool EnvironmentVariable by providing its name. More...

static void	AddOrUpdateEnvironmentString (const FString &pKey, const FString &pValue)
	Add or Update the value of a string EnvironmentVariable by providing its name. More...

static void	AddOrUpdateEnvironmentFloat (const FString &pKey, float pValue)
	Add or Update the value of a float EnvironmentVariable by providing its name. More...

static void	AddOrUpdateEnvironmentInt (const FString &pKey, int pValue)
	Add or Update the value of an int EnvironmentVariable by providing its name. More...

Member Function Documentation

◆ AddOrUpdateEnvironmentBool()

void UYomSettings::AddOrUpdateEnvironmentBool	(	const FString &	pKey,
		bool	pValue
	)

static

Add or Update the value of a bool EnvironmentVariable by providing its name.

◆ AddOrUpdateEnvironmentFloat()

void UYomSettings::AddOrUpdateEnvironmentFloat	(	const FString &	pKey,
		float	pValue
	)

static

Add or Update the value of a float EnvironmentVariable by providing its name.

◆ AddOrUpdateEnvironmentInt()

void UYomSettings::AddOrUpdateEnvironmentInt	(	const FString &	pKey,
		int	pValue
	)

static

Add or Update the value of an int EnvironmentVariable by providing its name.

◆ AddOrUpdateEnvironmentString()

void UYomSettings::AddOrUpdateEnvironmentString	(	const FString &	pKey,
		const FString &	pValue
	)

static

Add or Update the value of a string EnvironmentVariable by providing its name.

◆ AudioCutoffThreshold()

int UYomSettings::AudioCutoffThreshold ( )

static

The threshold for how much sound there must be before sound is sent over the network.

◆ DefaultPlayerID()

const FString & UYomSettings::DefaultPlayerID ( )

static

Returns the default PlayerID for a player that is spawned with SpawnDefaultPlayer set to true.

◆ DisablePixelStreamInput()

bool UYomSettings::DisablePixelStreamInput ( )

static

Disables the pixel streaming input for better play in editor.

◆ DisableVoiceChat()

bool UYomSettings::DisableVoiceChat ( )

static

Disables voice chat but does state whether it was enabled correctly.

◆ GetEnvironmentBool()

bool UYomSettings::GetEnvironmentBool ( const FString & pKey )

static

Get the value of a boolean EnvironmentVariable by providing its name.

◆ GetEnvironmentFloat()

float UYomSettings::GetEnvironmentFloat ( const FString & pKey )

static

Get the value of a float EnvironmentVariable by providing its name.

◆ GetEnvironmentInt()

int UYomSettings::GetEnvironmentInt ( const FString & pKey )

static

Get the value of an int EnvironmentVariable by providing its name.

◆ GetEnvironmentString()

FString UYomSettings::GetEnvironmentString ( const FString & pKey )

static

Get the value of a string EnvironmentVariable by providing its name.

◆ GetPortalUrl()

FString UYomSettings::GetPortalUrl ( int pIndex )

static

Gets the portal url from the settings.

Parameters

pIndex The index of the url

Returns: An url to a portal or nothing if something went wrong

◆ GlobalFalloffDistance()

float UYomSettings::GlobalFalloffDistance ( )

static

The maximum value at which players can talk to each other.

◆ InternalBufferSeconds()

float UYomSettings::InternalBufferSeconds ( )

static

The amount of seconds of the buffer between two clients in unreal, this buffer ensures that packets are played in the correct order.

◆ IsConnectionLogEnabled()

bool UYomSettings::IsConnectionLogEnabled ( )

static

Display logs about the connection between the client and the server.

◆ IsPlaybackLogEnabled()

bool UYomSettings::IsPlaybackLogEnabled ( )

static

Display logs about playing sound back to the players.

◆ IsRecordingYomVoiceEnabled()

bool UYomSettings::IsRecordingYomVoiceEnabled ( )

static

Whether we should record the YomVoice RawPCM data to the disk Puts the recording file under {projectRoot}/recording.bin.

◆ IsSoundLogEnabled()

bool UYomSettings::IsSoundLogEnabled ( )

static

Display logs about sound recording.

◆ ListenToSelf()

bool UYomSettings::ListenToSelf ( )

static

Whether the player can listen to themselves.

◆ LocalPreviewImages()

bool UYomSettings::LocalPreviewImages ( )

static

If YomPortals should fetch images from the web or from the disk Fetching from disk will show image of the portal itself.

◆ MetaspaceId()

const FString & UYomSettings::MetaspaceId ( )

static

Returns the current metasapceId setting.

◆ MinSpeakingTime()

float UYomSettings::MinSpeakingTime ( )

static

The amount of time a player needs to speak in order for sound to be send over the network.

◆ NumChannels()

int UYomSettings::NumChannels ( )

static

The number of channels that are used internally for voice in unreal.

◆ PlaybackBufferSeconds()

float UYomSettings::PlaybackBufferSeconds ( )

static

The amount of jitter buffer for playback of a voice, this buffer ensures that packets are played fluently to the current client.

◆ PortalImageDir()

const FString & UYomSettings::PortalImageDir ( )

static

The directory to store and fetch preview images from (cannot be set)

◆ PortalImagePath()

FString UYomSettings::PortalImagePath ( const FString & pFileName )

static

Gets the path of a preview image.

Parameters

pFileName The id of the portal

Returns: The path of the preview image

◆ PreviewImageQuality()

int UYomSettings::PreviewImageQuality ( )

static

The compression quality of the preview image.

◆ PreviewImageSizeXY()

int UYomSettings::PreviewImageSizeXY ( )

static

The size of the preview image in both the x and y direction.

◆ ReleaseTimeSeconds()

float UYomSettings::ReleaseTimeSeconds ( )

static

The amount of seconds the noise gate will be opened after the player stopped talking.

◆ SamplingRate()

int UYomSettings::SamplingRate ( )

static

The sample rate of the voice send over the unreal network.

◆ ServerIP()

const FString & UYomSettings::ServerIP ( )

static

Returns the current serverIP setting.

◆ SetAudioCutoffThreshold()

void UYomSettings::SetAudioCutoffThreshold ( int pThreshold )

static

Sets a new audio cutoff threshold for this instance.

Parameters

pThreshold The new threshold

◆ SignallingBufferSeconds()

float UYomSettings::SignallingBufferSeconds ( )

static

The amount of delay for the udp buffer of the signalling server, this buffer ensures that the voice of the signalling server does not sound robotic.

◆ SimulateEmptyOverlayPress()

bool UYomSettings::SimulateEmptyOverlayPress ( )

static

Whether to simulate the pressing of a player without a wallet, for testing the virtual camera NOTE: is overriden by SpawnDefaultPlayer.

◆ SpawnDefaultPlayer()

bool UYomSettings::SpawnDefaultPlayer ( )

static

Whether to spawn a default player in the metaspace If set to false the player can only spawn through the signalling server.

◆ TestPortals()

bool UYomSettings::TestPortals ( )

static

Whether the portals are in testing mode, if in testing mode they will fetch fake api calls from the disk It is recommended to set this value to true as the api call goes to a matchmaker that will not exist on your pc.

◆ UseSolanaDevnet()

bool UYomSettings::UseSolanaDevnet ( )

static

Whether to use devnet instead of mainnet of Solana.

◆ UseTestPlayer()

bool UYomSettings::UseTestPlayer ( )

static

Whether to use the TestWallet instead of the a blockchain wallet.

◆ VoiceChatFPS()

int UYomSettings::VoiceChatFPS ( )

static

The fps at which the voice chat runs, increasing this improves latency, but increases amount of packets send.

Detailed Description

Static Public Member Functions

Member Function Documentation

◆ AddOrUpdateEnvironmentBool()

◆ AddOrUpdateEnvironmentFloat()

◆ AddOrUpdateEnvironmentInt()

◆ AddOrUpdateEnvironmentString()

◆ AudioCutoffThreshold()

◆ DefaultPlayerID()

◆ DisablePixelStreamInput()

◆ DisableVoiceChat()

◆ GetEnvironmentBool()

◆ GetEnvironmentFloat()

◆ GetEnvironmentInt()

◆ GetEnvironmentString()

◆ GetPortalUrl()

◆ GlobalFalloffDistance()

◆ InternalBufferSeconds()

◆ IsConnectionLogEnabled()

◆ IsPlaybackLogEnabled()

◆ IsRecordingYomVoiceEnabled()

◆ IsSoundLogEnabled()

◆ ListenToSelf()

◆ LocalPreviewImages()

◆ MetaspaceId()

◆ MinSpeakingTime()

◆ NumChannels()

◆ PlaybackBufferSeconds()

◆ PortalImageDir()

◆ PortalImagePath()

◆ PreviewImageQuality()

◆ PreviewImageSizeXY()

◆ ReleaseTimeSeconds()

◆ SamplingRate()

◆ ServerIP()

◆ SetAudioCutoffThreshold()

◆ SignallingBufferSeconds()

◆ SimulateEmptyOverlayPress()

◆ SpawnDefaultPlayer()

◆ TestPortals()

◆ UseSolanaDevnet()

◆ UseTestPlayer()

◆ VoiceChatFPS()