CryEngine.AudioFile

Public Member Functions | Properties | List of all members

CryEngine.AudioFile

AudioFile is most direct with minimal setup in the Sandbox editor to playback an audio file More...

Inherits IDisposable.

Public Member Functions
	AudioFile (string filePath)
	Creates an audio file to playback with the specified file path. Note: filePath should not have the file extension. Eg "helloworld.wav" should be passed as "helloworld" More...

void	Dispose ()

void	Play ()
	Plays the audio file More...

void	Stop ()
	Stops the audio file More...

Properties
string	FilePath `[get]`
	Returns the file path of audio file for playback More...

Detailed Description

AudioFile is most direct with minimal setup in the Sandbox editor to playback an audio file

Constructor & Destructor Documentation

◆ AudioFile()

CryEngine.AudioFile.AudioFile

(

string

filePath

)

inline

Creates an audio file to playback with the specified file path. Note: filePath should not have the file extension. Eg "helloworld.wav" should be passed as "helloworld"

Parameters

filePath

Member Function Documentation

◆ Dispose()

void CryEngine.AudioFile.Dispose

(

)

inline

◆ Play()

void CryEngine.AudioFile.Play

(

)

inline

Plays the audio file

◆ Stop()

void CryEngine.AudioFile.Stop

(

)

inline

Stops the audio file

Property Documentation

◆ FilePath

string CryEngine.AudioFile.FilePath

get

Returns the file path of audio file for playback