Component that represents a client voice connection to Photon Servers. More...

Inherits ConnectionHandler, and ILoggable.

Public Member Functions
bool	ConnectUsingSettings (AppSettings overwriteSettings=null)
	Connect to Photon server using Settings More...

void	InitRecorder (Recorder rec)
	Initializes the Recorder component to be able to transmit audio. More...

void	SetPlaybackDelaySettings (PlaybackDelaySettings gpds)
	Sets the global configuration for the playback behaviour in case of delays. More...

void	SetGlobalPlaybackDelaySettings (int low, int high, int max)
	Sets the global configuration for the playback behaviour in case of delays. More...

virtual bool	TryLateLinkingUsingUserData (Speaker speaker, object userData)
	Tries to link local Speaker with remote voice stream using UserData. Useful if Speaker created after stream is started. More...

Public Attributes
AppSettings	Settings
	Settings to be used by this voice connection More...

Func< int, byte, object, Speaker >	SpeakerFactory
	Special factory to link Speaker components with incoming remote audio streams More...

float	MinimalTimeScaleToDispatchInFixedUpdate = -1f
	Configures the minimal Time.timeScale at which Voice client will dispatch incoming messages within LateUpdate. More...

bool	AutoCreateSpeakerIfNotFound = true
	Auto instantiate a GameObject and attach a Speaker component to link to a remote audio stream if no candidate could be found More...

int	MaxDatagrams = 3
	Limits the number of datagrams that are created in each LateUpdate. More...

bool	SendAsap
	Signals that outgoing messages should be sent in the next LateUpdate call. More...

Protected Member Functions
override void	Awake ()

virtual void	Update ()

virtual void	FixedUpdate ()

void	Dispatch ()
	Dispatches incoming network messages for Voice client. Called in FixedUpdate or LateUpdate. More...

override void	OnDisable ()

virtual void	OnDestroy ()

virtual Speaker	SimpleSpeakerFactory (int playerId, byte voiceId, object userData)

virtual void	OnVoiceStateChanged (ClientState fromState, ClientState toState)

void	CalcStatistics ()

void	LinkSpeaker (Speaker speaker, RemoteVoiceLink remoteVoice)

virtual void	OnOperationResponseReceived (OperationResponse operationResponse)

Protected Attributes
List< RemoteVoiceLink >	cachedRemoteVoices = new List<RemoteVoiceLink>()

Properties
VoiceLogger	Logger `[get, protected set]`
	Logger used by this component More...

DebugLevel	LogLevel `[get, set]`
	Log level for this component More...

new LoadBalancingTransport	Client `[get]`

VoiceClient	VoiceClient `[get]`
	Returns underlying Photon Voice client. More...

ClientState	ClientState `[get]`
	Returns Photon Voice client state. More...

float	FramesReceivedPerSecond `[get]`
	Number of frames received per second. More...

float	FramesLostPerSecond `[get]`
	Number of frames lost per second. More...

float	FramesLostPercent `[get]`
	Percentage of lost frames. More...

GameObject	SpeakerPrefab `[get, set]`
	Prefab that contains Speaker component to be instantiated when receiving a new remote audio source info More...

Recorder	PrimaryRecorder `[get, set]`
	Main Recorder to be used for transmission by default More...

DebugLevel	GlobalRecordersLogLevel `[get, set]`

DebugLevel	GlobalSpeakersLogLevel `[get, set]`

int	GlobalPlaybackDelay `[get, set]`

string	BestRegionSummaryInPreferences `[get, set]`
	Used to store and access the "Best Region Summary" in the Player Preferences. More...

int	GlobalPlaybackDelayMinSoft `[get]`
	Gets the global value in ms above which the audio player tries to keep the delay. More...

int	GlobalPlaybackDelayMaxSoft `[get]`
	Gets the global value in ms below which the audio player tries to keep the delay. More...

int	GlobalPlaybackDelayMaxHard `[get]`
	Gets the global value in ms that audio play delay will not exceed. More...

Properties inherited from ILoggable
DebugLevel	LogLevel `[get, set]`

VoiceLogger	Logger `[get]`

Events
Action< Speaker >	SpeakerLinked
	Fires when a speaker has been linked to a remote audio stream More...

Action< RemoteVoiceLink >	RemoteVoiceAdded
	Fires when a remote voice stream is added More...

Detailed Description

Component that represents a client voice connection to Photon Servers.

Member Function Documentation

◆ ConnectUsingSettings()

bool ConnectUsingSettings ( AppSettings overwriteSettings = null )

Connect to Photon server using Settings

Parameters

overwriteSettings Overwrites Settings before connecting

Returns: If true voice connection command was sent from client

◆ Dispatch()

void Dispatch ( )

protected

Dispatches incoming network messages for Voice client. Called in FixedUpdate or LateUpdate.

It may make sense to dispatch incoming messages, even if the timeScale is near 0. That can be configured with MinimalTimeScaleToDispatchInFixedUpdate.

Without dispatching messages, Voice client won't change state and does not handle updates.

◆ InitRecorder()

void InitRecorder ( Recorder rec )

Initializes the Recorder component to be able to transmit audio.

Parameters

rec	The Recorder to be initialized.

◆ SetGlobalPlaybackDelaySettings()

void SetGlobalPlaybackDelaySettings	(	int	low,
		int	high,
		int	max
	)

Sets the global configuration for the playback behaviour in case of delays.

Parameters

low	In milliseconds, audio player tries to keep the playback delay above this value.
high	In milliseconds, audio player tries to keep the playback below above this value.
max	In milliseconds, audio player guarantees that the playback delay never exceeds this value.

◆ SetPlaybackDelaySettings()

void SetPlaybackDelaySettings ( PlaybackDelaySettings gpds )

Sets the global configuration for the playback behaviour in case of delays.

Parameters

gpds	Playback delay configuration struct.

◆ TryLateLinkingUsingUserData()

virtual bool TryLateLinkingUsingUserData	(	Speaker	speaker,
		object	userData
	)

virtual

Tries to link local Speaker with remote voice stream using UserData. Useful if Speaker created after stream is started.

Parameters

speaker	Speaker ot try linking.
userData	UserData object used to bind local Speaker with remote voice stream.

Returns

Member Data Documentation

◆ AutoCreateSpeakerIfNotFound

bool AutoCreateSpeakerIfNotFound = true

Auto instantiate a GameObject and attach a Speaker component to link to a remote audio stream if no candidate could be found

◆ MaxDatagrams

int MaxDatagrams = 3

Limits the number of datagrams that are created in each LateUpdate.

Helps spreading out sending of messages minimally.

◆ MinimalTimeScaleToDispatchInFixedUpdate

float MinimalTimeScaleToDispatchInFixedUpdate = -1f

Configures the minimal Time.timeScale at which Voice client will dispatch incoming messages within LateUpdate.

It may make sense to dispatch incoming messages, even if the timeScale is near 0. In some cases, stopping the game time makes sense, so this option defaults to -1f, which is "off". Without dispatching messages, Voice client won't change state and does not handle updates.

◆ SendAsap

bool SendAsap

Signals that outgoing messages should be sent in the next LateUpdate call.

Up to MaxDatagrams are created to send queued messages.

◆ Settings

AppSettings Settings

Settings to be used by this voice connection

◆ SpeakerFactory

Func<int, byte, object, Speaker> SpeakerFactory

Special factory to link Speaker components with incoming remote audio streams

Property Documentation

◆ BestRegionSummaryInPreferences

string BestRegionSummaryInPreferences

getset

Used to store and access the "Best Region Summary" in the Player Preferences.

◆ ClientState

ClientState ClientState

get

Returns Photon Voice client state.

◆ FramesLostPercent

float FramesLostPercent

get

Percentage of lost frames.

◆ FramesLostPerSecond

float FramesLostPerSecond

get

Number of frames lost per second.

◆ FramesReceivedPerSecond

float FramesReceivedPerSecond

get

Number of frames received per second.

◆ GlobalPlaybackDelayMaxHard

int GlobalPlaybackDelayMaxHard

get

Gets the global value in ms that audio play delay will not exceed.

◆ GlobalPlaybackDelayMaxSoft

int GlobalPlaybackDelayMaxSoft

get

Gets the global value in ms below which the audio player tries to keep the delay.

◆ GlobalPlaybackDelayMinSoft

int GlobalPlaybackDelayMinSoft

get

Gets the global value in ms above which the audio player tries to keep the delay.

◆ Logger

VoiceLogger Logger

getprotected set

Logger used by this component

◆ LogLevel

DebugLevel LogLevel

getset

Log level for this component

◆ PrimaryRecorder

Recorder PrimaryRecorder

getset

Main Recorder to be used for transmission by default

◆ SpeakerPrefab

GameObject SpeakerPrefab

getset

Prefab that contains Speaker component to be instantiated when receiving a new remote audio source info

◆ VoiceClient

VoiceClient VoiceClient

get

Returns underlying Photon Voice client.

Event Documentation

◆ RemoteVoiceAdded

Action<RemoteVoiceLink> RemoteVoiceAdded

Fires when a remote voice stream is added

◆ SpeakerLinked

Action<Speaker> SpeakerLinked

Fires when a speaker has been linked to a remote audio stream

Photon Voice v2.31

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Events

Detailed Description

Member Function Documentation

◆ ConnectUsingSettings()

◆ Dispatch()

◆ InitRecorder()

◆ SetGlobalPlaybackDelaySettings()

◆ SetPlaybackDelaySettings()

◆ TryLateLinkingUsingUserData()

Member Data Documentation

◆ AutoCreateSpeakerIfNotFound

◆ MaxDatagrams

◆ MinimalTimeScaleToDispatchInFixedUpdate

◆ SendAsap

◆ Settings

◆ SpeakerFactory

Property Documentation

◆ BestRegionSummaryInPreferences

◆ ClientState

◆ FramesLostPercent

◆ FramesLostPerSecond

◆ FramesReceivedPerSecond

◆ GlobalPlaybackDelayMaxHard

◆ GlobalPlaybackDelayMaxSoft

◆ GlobalPlaybackDelayMinSoft

◆ Logger

◆ LogLevel

◆ PrimaryRecorder

◆ SpeakerPrefab

◆ VoiceClient

Event Documentation

◆ RemoteVoiceAdded

◆ SpeakerLinked