VoNComponent Interface Reference

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.
proto external void	ConnectEditorToVoNSystem (int playerId)
	Connects this VoNComponent to the VoNSystem and tells this VoNComponent that is is used by an editor.
proto external void	DisconnectEditorFromVoNSystem ()
	Disconnects this VoNComponent from the VoNSystem.
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, bool isSenderEditor, BaseTransceiver receiver, int frequency, float quality)
	Event invoked when component receives audio data for playback.
void	OnVoNUsed (int senderId)
	Event invoked on the server, each time VoN is used.
IEntity	GetEditorEntity (int playerId)
	returns the SCR_EditorManagerEntity for a given player id if it exists.
vector	GetEditorWorldLocation (int playerId)
	returns the position of the camera used by the editor for a given player id, if it exists.
bool	IsEntityActiveEditor (IEntity entity)
	returns true if the entity is a SCR_EditorManagerEntity that is opened.

Detailed Description

Component responsible for recording and playback of voice over network.

Member Function Documentation

ConnectEditorToVoNSystem()

proto external void VoNComponent.ConnectEditorToVoNSystem

(

int

playerId

)

Connects this VoNComponent to the VoNSystem and tells this VoNComponent that is is used by an editor.

This is required for the VoNComponent to be properly updated.

DisconnectEditorFromVoNSystem()

proto external void VoNComponent.DisconnectEditorFromVoNSystem

(

)

Disconnects this VoNComponent from the VoNSystem.

This will stop de VoNSystem from updating this VoNComponent.

GetCommMethod()

proto external ECommMethod VoNComponent.GetCommMethod

(

)

GetEditorEntity()

IEntity VoNComponent.GetEditorEntity ( int playerId )

protected

returns the SCR_EditorManagerEntity for a given player id if it exists.

Implemented in SCR_VoNComponent.

GetEditorWorldLocation()

vector VoNComponent.GetEditorWorldLocation ( int playerId )

protected

returns the position of the camera used by the editor for a given player id, if it exists.

Implemented in SCR_VoNComponent.

GetTransmitRadio()

proto external BaseTransceiver VoNComponent.GetTransmitRadio

(

)

IsEntityActiveEditor()

bool VoNComponent.IsEntityActiveEditor ( IEntity entity )

protected

returns true if the entity is a SCR_EditorManagerEntity that is opened.

Implemented in SCR_VoNComponent.

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, bool isSenderEditor, BaseTransceiver receiver, int frequency, float quality )

protected

Event invoked when component receives audio data for playback.

Parameters

playerId	Senders PlayerId
isSenderEditor	true if sender is active editor.
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.

OnVoNUsed()

void VoNComponent.OnVoNUsed ( int senderId )

protected

Event invoked on the server, each time VoN is used.

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