Component responsible for recording and playback of voice over network. More...

Inheritance diagram for VoNComponent:

Public Member Functions
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 ()

Protected Member Functions
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.

Detailed Description

Component responsible for recording and playback of voice over network.

Member Function Documentation

◆ GetCommMethod()

proto external ECommMethod VoNComponent.GetCommMethod ( )

◆ GetTransmitRadio()

proto external BaseTransceiver VoNComponent.GetTransmitRadio ( )

◆ OnCapture()

void VoNComponent.OnCapture ( BaseTransceiver transmitter )

protected

Event polled each frame while component is recording audio.

Parameters

transmitter Transceiver used. Null if only direct speech.

Implemented in SCR_VoNComponent.

◆ OnReceive()

void 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

Implemented in SCR_VoNComponent.

◆ SetCapture()

proto external bool VoNComponent.SetCapture ( bool isCapturing )

Request to starts/stop audio capturing.

Returns: if the request suceeded

◆ SetCommMethod()

proto external void VoNComponent.SetCommMethod ( ECommMethod type )

Sets communication method used.

◆ SetTransmitRadio()

proto external void VoNComponent.SetTransmitRadio ( BaseTransceiver transceiver )

Sets the transceiver used for VoN transmission.

◆ SoundEventPriority()

proto external void VoNComponent.SoundEventPriority	(	string	eventname,
		array< float >	values,
		int	priority,
		bool	ignoreQueue = `false`
	)

Transfer AI sound message through VoN.

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

Game/generated/Components/VoNComponent.c

Public Member Functions

Protected Member Functions