CryEngine.AudioObject

Public Member Functions | List of all members

An audio object has more audio configuration options such as transformation in the 3D space. More...

Inherits IDisposable.

Public Member Functions
	AudioObject ()
	Creates an Audio object More...

void	SetTransformation (Vector3 position, Vector3 forward, Vector3 up)
	Sets the transformation of the audio object More...

void	SetTransformation (Matrix3x4 matrix)
	Sets the transformation of the audio object More...

void	Play (string triggerName)
	Executes the specified trigger name on this audio object More...

void	Play (AudioTriggerId triggerId)
	Executes the specified trigger id on this audio object More...

void	Stop (string triggerName)
	Stops the specified trigger name on this audio object More...

void	Stop (AudioTriggerId triggerId)
	Stops the specified trigger id on this audio object More...

void	Dispose ()

Detailed Description

An audio object has more audio configuration options such as transformation in the 3D space.

Constructor & Destructor Documentation

◆ AudioObject()

CryEngine.AudioObject.AudioObject

(

)

inline

Creates an Audio object

Member Function Documentation

◆ Dispose()

void CryEngine.AudioObject.Dispose

(

)

inline

◆ Play() [1/2]

void CryEngine.AudioObject.Play

(

string

triggerName

)

inline

Executes the specified trigger name on this audio object

Parameters

triggerName

◆ Play() [2/2]

void CryEngine.AudioObject.Play

(

AudioTriggerId

triggerId

)

inline

Executes the specified trigger id on this audio object

Parameters

triggerId

◆ SetTransformation() [1/2]

void CryEngine.AudioObject.SetTransformation	(	Vector3	position,
		Vector3	forward,
		Vector3	up
	)

inline

Sets the transformation of the audio object

Parameters

position
forward
up

◆ SetTransformation() [2/2]

void CryEngine.AudioObject.SetTransformation

(

Matrix3x4

matrix

)

inline

Sets the transformation of the audio object

Parameters

matrix

◆ Stop() [1/2]

void CryEngine.AudioObject.Stop

(

string

triggerName

)

inline

Stops the specified trigger name on this audio object

Parameters

triggerName

◆ Stop() [2/2]

void CryEngine.AudioObject.Stop

(

AudioTriggerId

triggerId

)

inline

Stops the specified trigger id on this audio object

Parameters

triggerId