Inheritance diagram for SCR_VoNComponent:

[legend]

Public Member Functions
SCR_VonDisplay	GetDisplay ()
	Get Display Info script.

bool	IsTransmiting ()
	Simple getter for when transmission was recently active, we assume that player's avatar should not produce various sounds while he's talking.

bool	IsTransmitingRadio ()
	Radio transmission was recently active.

Public Member Functions inherited from VoNComponent
proto external bool	SetCapture (bool isCapturing)
	Request to starts/stop audio capturing.

proto external void	SetCommMethod (ECommMethod type)
	Sets communication method used.

proto external ECommMethod	GetCommMethod ()

proto external void	SetTransmitRadio (BaseTransceiver transceiver)
	Sets the transceiver used for VoN transmission.

proto external BaseTransceiver	GetTransmitRadio ()

proto external void	SoundEventPriority (string eventname, array< float > values, int priority, bool ignoreQueue=false)
	Transfer AI sound message through VoN.

Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Public Attributes
ref ScriptInvoker	m_OnReceivedVON = new ScriptInvoker()

ref ScriptInvoker	m_OnCaptureVON = new ScriptInvoker()

Protected Member Functions
override void	OnCapture (BaseTransceiver transmitter)
	Event polled each frame while component is recording audio.

override void	OnReceive (int playerId, BaseTransceiver receiver, int frequency, float quality)
	Event invoked when component receives audio data for playback.

void	OnCapture (BaseTransceiver transmitter)
	Event polled each frame while component is recording audio.

void	OnReceive (int playerId, BaseTransceiver receiver, int frequency, float quality)
	Event invoked when component receives audio data for playback.

Member Function Documentation

◆ GetDisplay()

SCR_VonDisplay SCR_VoNComponent.GetDisplay ( )

Get Display Info script.

Returns: SCR_VonDisplay reference

◆ IsTransmiting()

bool SCR_VoNComponent.IsTransmiting ( )

Simple getter for when transmission was recently active, we assume that player's avatar should not produce various sounds while he's talking.

Returns: true if recently active

◆ IsTransmitingRadio()

bool SCR_VoNComponent.IsTransmitingRadio ( )

Radio transmission was recently active.

Returns: true if recently active

◆ OnCapture()

override void SCR_VoNComponent.OnCapture ( BaseTransceiver transmitter )

protected

Event polled each frame while component is recording audio.

Parameters

transmitter Transceiver used. Null if only direct speech.

Implements VoNComponent.

◆ OnReceive()

override void SCR_VoNComponent.OnReceive	(	int	playerId,
		BaseTransceiver	receiver,
		int	frequency,
		float	quality
	)

protected

Event invoked when component receives audio data for playback.

Parameters

playerId	Senders PlayerId
receiver	Receiving transceiver
frequency	Frequency in kHz, on which the transmission came from. Can be different from the frequency which transceiver have set. This is very questionable and could be changed in future.
quality	Value in range <0,1> describing quality of the transmission

Implements VoNComponent.

Member Data Documentation

◆ m_OnCaptureVON

ref ScriptInvoker SCR_VoNComponent.m_OnCaptureVON = new ScriptInvoker()

◆ m_OnReceivedVON

ref ScriptInvoker SCR_VoNComponent.m_OnReceivedVON = new ScriptInvoker()

The documentation for this interface was generated from the following file:

GameCode/Network/SCR_VoNComponent.c

Public Member Functions

Public Attributes

Protected Member Functions