Falco Engine 3.9.0.1 (beta)
Public Member Functions | Properties | List of all members
FalcoEngine.AudioSource Class Reference
Inheritance diagram for FalcoEngine.AudioSource:
FalcoEngine.Component

Public Member Functions

void Play ()
 Play current audio clip More...
 
void Pause ()
 Pause playing More...
 
void Resume ()
 Resume playing More...
 
void Stop ()
 Stop playing More...
 
int GetTotalLength ()
 Get total length in seconds More...
 
int GetPlaybackPosition ()
 Get current playback position in seconds More...
 
void SetPlaybackPosition (int seconds)
 Set current playback position in seconds More...
 

Properties

bool isPlaying [get]
 Returns if this audio source is playing More...
 
bool isPaused [get]
 Returns if this audio source is paused More...
 
bool loop [getset]
 Return or set whether the audio clip replays after it finishes or not More...
 
bool playOnStart [getset]
 Returns or sets if audio source should start playing after scene is loaded More...
 
float pitch [getset]
 The pitch of the audio source More...
 
float volume [getset]
 The volume of the audio source (0.0 to 1.0) More...
 
float minDistance [getset]
 Within the min distance the audio source will cease to grow louder in volume More...
 
float maxDistance [getset]
 Max distance is the distance where the sound is completely inaudible More...
 
bool is2D [getset]
 Is this audio source 2D or 3D? More...
 
AudioClip audioClip [getset]
 Get or set the audio clip for this audio source More...
 
- Properties inherited from FalcoEngine.Component
bool enabled [getset]
 Enable or disable this component More...
 
GameObject gameObject [get]
 Get game object at which this component is attached More...
 
bool isUiComponent [get]
 Returns if this component is derived from UIElement (or this is a canvas) or not More...
 

Additional Inherited Members

- Protected Member Functions inherited from FalcoEngine.Component
 Component ()
 

Detailed Description

Definition at line 7 of file AudioSource.cs.

Member Function Documentation

◆ GetPlaybackPosition()

int FalcoEngine.AudioSource.GetPlaybackPosition ( )

Get current playback position in seconds

Returns

◆ GetTotalLength()

int FalcoEngine.AudioSource.GetTotalLength ( )

Get total length in seconds

Returns

◆ Pause()

void FalcoEngine.AudioSource.Pause ( )

Pause playing

Definition at line 77 of file AudioSource.cs.

◆ Play()

void FalcoEngine.AudioSource.Play ( )

Play current audio clip

Definition at line 69 of file AudioSource.cs.

◆ Resume()

void FalcoEngine.AudioSource.Resume ( )

Resume playing

Definition at line 85 of file AudioSource.cs.

◆ SetPlaybackPosition()

void FalcoEngine.AudioSource.SetPlaybackPosition ( int  seconds)

Set current playback position in seconds

Parameters
seconds

◆ Stop()

void FalcoEngine.AudioSource.Stop ( )

Stop playing

Definition at line 93 of file AudioSource.cs.

Property Documentation

◆ audioClip

AudioClip FalcoEngine.AudioSource.audioClip
getset

Get or set the audio clip for this audio source

Definition at line 64 of file AudioSource.cs.

◆ is2D

bool FalcoEngine.AudioSource.is2D
getset

Is this audio source 2D or 3D?

Definition at line 59 of file AudioSource.cs.

◆ isPaused

bool FalcoEngine.AudioSource.isPaused
get

Returns if this audio source is paused

Definition at line 24 of file AudioSource.cs.

◆ isPlaying

bool FalcoEngine.AudioSource.isPlaying
get

Returns if this audio source is playing

Definition at line 19 of file AudioSource.cs.

◆ loop

bool FalcoEngine.AudioSource.loop
getset

Return or set whether the audio clip replays after it finishes or not

Definition at line 29 of file AudioSource.cs.

◆ maxDistance

float FalcoEngine.AudioSource.maxDistance
getset

Max distance is the distance where the sound is completely inaudible

Definition at line 54 of file AudioSource.cs.

◆ minDistance

float FalcoEngine.AudioSource.minDistance
getset

Within the min distance the audio source will cease to grow louder in volume

Definition at line 49 of file AudioSource.cs.

◆ pitch

float FalcoEngine.AudioSource.pitch
getset

The pitch of the audio source

Definition at line 39 of file AudioSource.cs.

◆ playOnStart

bool FalcoEngine.AudioSource.playOnStart
getset

Returns or sets if audio source should start playing after scene is loaded

Definition at line 34 of file AudioSource.cs.

◆ volume

float FalcoEngine.AudioSource.volume
getset

The volume of the audio source (0.0 to 1.0)

Definition at line 44 of file AudioSource.cs.

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