UVivoxGameInstance Class Reference

#include <VivoxGameInstance.h>

Inheritance diagram for UVivoxGameInstance:

Public Member Functions
	UVivoxGameInstance ()
virtual void	Init () override
virtual void	Shutdown () override
void	OnClientTravel (const FString &PendingURL, ETravelType TravelType, bool bIsSeamlessTravel)
virtual const FString	GetPlatformAccountID ()
float	GetParticipantVolume () const
bool	IsUsingPushToTalk () const
void	UpdateParticipantVolume (const float Volume)
void	UpdatePushToTalk (const bool bNewPushToTalk)
virtual bool	Exec (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Out= *GLog) override
	Runtime console commands. More...
virtual void	InitBeaconHost () override
virtual void	InitBeaconClient (const FOnlineSessionSearchResult &DesiredHost) override
virtual void	InitBeaconClientForServerPlayer () override
void	BindLoginSessionHandlers (bool DoBind, ILoginSession &LoginSession)
	Bind or unbind event handlers for ILoginSession property changes. More...
void	BindChannelSessionHandlers (bool DoBind, IChannelSession &ChannelSession)
	Bind or unbind event handlers for IChannelSession property changes. More...
VivoxCoreError	Initialize (int logLevel)
void	Uninitialize ()
VivoxCoreError	Login (const FString &PlayerName)
void	ReLog ()
void	Logout ()
void	ReJoinVoiceChannels ()
void	ReJoinLastKnownSquadChannel ()
void	RejoinPartyVoiceChannel ()
VivoxCoreError	JoinVoiceChannels (FString OnlineSessionId, int32 TeamNum=-1)
VivoxCoreError	JoinVoiceChannels (FString OnlineSessionId, int32 TeamNum, bool bUseOpenMic)
VivoxCoreError	Join (ChannelType Type, bool IsOpenMic, FString ChannelName)
VivoxCoreError	MultiChanPushToTalk (bool PTTKeyPressed)
void	LeaveVoiceChannels (FVoiceChannelInfo Exception=FVoiceChannelInfo())
void	LeaveVoiceChannel (FVoiceChannelInfo ChannelToLeave)
void	Update3DPosition (APawn *Pawn)
void	MutePlayerByPlayerState (const class AProjectXPlayerState *PlayerState, bool bToggle)
void	OnLoginSessionStateChanged (LoginState State)
void	OnChannelParticipantAdded (const IParticipant &Participant)
void	OnChannelParticipantRemoved (const IParticipant &Participant)
void	OnChannelParticipantUpdated (const IParticipant &Participant)
void	OnChannelAudioStateChanged (const IChannelConnectionState &State)
void	OnChannelTextStateChanged (const IChannelConnectionState &State)
void	OnChannelTextMessageReceived (const IChannelTextMessage &Message)
virtual bool	IsInitialized ()
virtual bool	IsLoggedIn ()
TSharedPtr< IChannelSession >	GetChannelSessionForRoster ()

Static Public Member Functions
static FString	GetVivoxSafeName (const FString BaseName)
static FString	GetVivoxSafePlayerName (const FString BaseName)
static APlayerState *	GetPlayerStateByVivoxName (const UObject *WorldContextObject, UPARAM(ref) const FString &ID)

Public Attributes
FParticipantUpdated	OnParticipantUpdated
IClient *	VivoxVoiceClient
AccountId	LoggedInAccountID
bool	bInitialized
bool	bInitializing
bool	bLoggedIn
bool	bLoggingIn
bool	bRelogging
FVoiceChannelInfo	PartyVoiceChannel

Protected Member Functions
virtual void	OnPlayerStateEvent (ASteamBeaconPlayerState *InPlayerState) override
virtual void	OnSteamBeaconHostConnectionFailureEvent () override

Constructor & Destructor Documentation

UVivoxGameInstance()

UVivoxGameInstance::UVivoxGameInstance

(

)

Member Function Documentation

BindChannelSessionHandlers()

void UVivoxGameInstance::BindChannelSessionHandlers	(	bool	DoBind,
		IChannelSession &	ChannelSession
	)

Bind or unbind event handlers for IChannelSession property changes.

Parameters

DoBind	Whether to bind or unbind the handlers.
IChannelSession	Object for which to bind or unbind handlers.

BindLoginSessionHandlers()

void UVivoxGameInstance::BindLoginSessionHandlers	(	bool	DoBind,
		ILoginSession &	LoginSession
	)

Bind or unbind event handlers for ILoginSession property changes.

Parameters

DoBind	Whether to bind or unbind the handlers.
ILoginSession	Object for which to bind or unbind handlers.

Exec()

bool UVivoxGameInstance::Exec ( UWorld *  InWorld, const TCHAR *  Cmd, FOutputDevice &  Out = *GLog  )

overridevirtual

Runtime console commands.

GetChannelSessionForRoster()

TSharedPtr< IChannelSession > UVivoxGameInstance::GetChannelSessionForRoster

(

)

GetParticipantVolume()

float UVivoxGameInstance::GetParticipantVolume

(

)

const

GetPlatformAccountID()

const FString UVivoxGameInstance::GetPlatformAccountID ( )

virtual

GetPlayerStateByVivoxName()

APlayerState * UVivoxGameInstance::GetPlayerStateByVivoxName ( const UObject *  WorldContextObject, UPARAM(ref) const FString &  ID  )

static

GetVivoxSafeName()

FString UVivoxGameInstance::GetVivoxSafeName ( const FString  BaseName )

static

GetVivoxSafePlayerName()

FString UVivoxGameInstance::GetVivoxSafePlayerName ( const FString  BaseName )

static

Init()

void UVivoxGameInstance::Init ( )

overridevirtual

Reimplemented in UGameInstanceLoadingScreen, and UProjectXGameInstance.

InitBeaconClient()

void UVivoxGameInstance::InitBeaconClient ( const FOnlineSessionSearchResult &  DesiredHost )

overridevirtual

InitBeaconClientForServerPlayer()

void UVivoxGameInstance::InitBeaconClientForServerPlayer ( )

overridevirtual

InitBeaconHost()

void UVivoxGameInstance::InitBeaconHost ( )

overridevirtual

Initialize()

VivoxCoreError UVivoxGameInstance::Initialize

(

int

logLevel

)

IsInitialized()

bool UVivoxGameInstance::IsInitialized ( )

virtual

IsLoggedIn()

bool UVivoxGameInstance::IsLoggedIn ( )

virtual

IsUsingPushToTalk()

bool UVivoxGameInstance::IsUsingPushToTalk ( ) const

inline

Join()

VivoxCoreError UVivoxGameInstance::Join	(	ChannelType	Type,
		bool	IsOpenMic,
		FString	ChannelName
	)

JoinVoiceChannels() [1/2]

VivoxCoreError UVivoxGameInstance::JoinVoiceChannels	(	FString	OnlineSessionId,
		int32	TeamNum,
		bool	bUseOpenMic
	)

JoinVoiceChannels() [2/2]

VivoxCoreError UVivoxGameInstance::JoinVoiceChannels	(	FString	OnlineSessionId,
		int32	TeamNum = -1
	)

LeaveVoiceChannel()

void UVivoxGameInstance::LeaveVoiceChannel

(

FVoiceChannelInfo

ChannelToLeave

)

LeaveVoiceChannels()

void UVivoxGameInstance::LeaveVoiceChannels

(

FVoiceChannelInfo

Exception = FVoiceChannelInfo()

)

Login()

VivoxCoreError UVivoxGameInstance::Login

(

const FString &

PlayerName

)

Logout()

void UVivoxGameInstance::Logout

(

)

MultiChanPushToTalk()

VivoxCoreError UVivoxGameInstance::MultiChanPushToTalk

(

bool

PTTKeyPressed

)

MutePlayerByPlayerState()

void UVivoxGameInstance::MutePlayerByPlayerState	(	const class AProjectXPlayerState *	PlayerState,
		bool	bToggle
	)

OnChannelAudioStateChanged()

void UVivoxGameInstance::OnChannelAudioStateChanged

(

const IChannelConnectionState &

State

)

OnChannelParticipantAdded()

void UVivoxGameInstance::OnChannelParticipantAdded

(

const IParticipant &

Participant

)

OnChannelParticipantRemoved()

void UVivoxGameInstance::OnChannelParticipantRemoved

(

const IParticipant &

Participant

)

OnChannelParticipantUpdated()

void UVivoxGameInstance::OnChannelParticipantUpdated

(

const IParticipant &

Participant

)

OnChannelTextMessageReceived()

void UVivoxGameInstance::OnChannelTextMessageReceived

(

const IChannelTextMessage &

Message

)

OnChannelTextStateChanged()

void UVivoxGameInstance::OnChannelTextStateChanged

(

const IChannelConnectionState &

State

)

OnClientTravel()

void UVivoxGameInstance::OnClientTravel	(	const FString &	PendingURL,
		ETravelType	TravelType,
		bool	bIsSeamlessTravel
	)

OnLoginSessionStateChanged()

void UVivoxGameInstance::OnLoginSessionStateChanged

(

LoginState

State

)

OnPlayerStateEvent()

void UVivoxGameInstance::OnPlayerStateEvent ( ASteamBeaconPlayerState *  InPlayerState )

overrideprotectedvirtual

OnSteamBeaconHostConnectionFailureEvent()

void UVivoxGameInstance::OnSteamBeaconHostConnectionFailureEvent ( )

overrideprotectedvirtual

ReJoinLastKnownSquadChannel()

void UVivoxGameInstance::ReJoinLastKnownSquadChannel

(

)

RejoinPartyVoiceChannel()

void UVivoxGameInstance::RejoinPartyVoiceChannel

(

)

ReJoinVoiceChannels()

void UVivoxGameInstance::ReJoinVoiceChannels

(

)

ReLog()

void UVivoxGameInstance::ReLog

(

)

Shutdown()

void UVivoxGameInstance::Shutdown ( )

overridevirtual

Reimplemented in UProjectXGameInstance.

Uninitialize()

void UVivoxGameInstance::Uninitialize

(

)

Update3DPosition()

void UVivoxGameInstance::Update3DPosition

(

APawn *

Pawn

)

Return if argument is invalid.

Return if we're not in a positional channel.

Update cached 3D position and orientation.

Return If there's no change from cached values.

Set new position and orientation in connected positional channel.

UpdateParticipantVolume()

void UVivoxGameInstance::UpdateParticipantVolume

(

const float

Volume

)

UpdatePushToTalk()

void UVivoxGameInstance::UpdatePushToTalk

(

const bool

bNewPushToTalk

)

Member Data Documentation

bInitialized

bool UVivoxGameInstance::bInitialized

bInitializing

bool UVivoxGameInstance::bInitializing

bLoggedIn

bool UVivoxGameInstance::bLoggedIn

bLoggingIn

bool UVivoxGameInstance::bLoggingIn

bRelogging

bool UVivoxGameInstance::bRelogging

LoggedInAccountID

AccountId UVivoxGameInstance::LoggedInAccountID

OnParticipantUpdated

FParticipantUpdated UVivoxGameInstance::OnParticipantUpdated

PartyVoiceChannel

FVoiceChannelInfo UVivoxGameInstance::PartyVoiceChannel

VivoxVoiceClient

IClient* UVivoxGameInstance::VivoxVoiceClient

---

The documentation for this class was generated from the following files:

• E:/ProjectY/Source/ProjectX/Public/System/VivoxGameInstance.h
• E:/ProjectY/Source/ProjectX/Private/System/VivoxGameInstance.cpp