SoundToolKit.Unity.SoundToolKitAmbientSource Class Reference

SoundToolKit Ambient Source. Capable of playing multiple SoundToolKit Samples with various Play methods. More...

Inheritance diagram for SoundToolKit.Unity.SoundToolKitAmbientSource:

Public Member Functions
override void	OnStkInitialized (SoundToolKitManager soundToolKitManager)
override void	Play ()
	Play all the Playbacks on the Source's list. More...
override void	Stop ()
	Stops all incoming sounds from that Source. More...
void	Pause ()
	Pauses all incoming sounds from that Source. More...
void	PlaySingle (int playbackToPlayIndex=0)
	Play a single Playback from the Source's Playback list. More...
void	PlayRange (int firstPlaybackToPlayIndex, int lastPlaybackToPlayIndex)
	Play a specified range of Playbacks from Source's list. More...
void	PlayRandom (int firstPlaybackToRandomFromIndex=0, int? lastPlaybackToRandomFromIndex=null)
	Play a random Playback from the specified range on the Source's Playback List (whole List by default). More...
void	StopSingle (int playbackToStopIndex=0)
	Stop a single Playback from the Source's Playback list. More...
void	StopRange (int firstPlaybackToStopIndex, int lastPlaybackToStopIndex)
	Stop a specified range of Playbacks from Source's list. More...
void	PauseSingle (int playbackToPauseIndex=0)
	Pause a single Playback from the Source's Playback list. More...
void	PauseRange (int firstPlaybackToPauseIndex, int lastPlaybackToPauseIndex)
	Pause a specified range of Playbacks from Source's list. Pauses all by default. More...

Protected Member Functions
override void	Awake ()
override void	OnDestroy ()
override void	OnDisable ()
override void	OnEnable ()

Properties
override bool	IsPlaying [get]
override bool?	Muted [get, set]
override float?	Volume [get, set]
List< SoundToolKitPlayback >	Playbacks [get, set]
	List of Playbacks, which consist of StkSample, Looped control, PlayOnAwake control and internal StkPlayback. More...
Properties inherited from SoundToolKit.Unity.SourceComponent
bool	Initialized [get, protected set]
abstract bool	IsPlaying [get]
abstract bool	Muted [get, set]
abstract float	Volume [get, set]

Additional Inherited Members
Public Attributes inherited from SoundToolKit.Unity.SourceComponent
bool	playOnAwake = true
Protected Attributes inherited from SoundToolKit.Unity.SourceComponent
bool	m_muted = false
float	m_volume = 0.75f
bool	m_isPlayingPreviousState

Detailed Description

SoundToolKit Ambient Source. Capable of playing multiple SoundToolKit Samples with various Play methods.

Member Function Documentation

Awake()

override void SoundToolKit.Unity.SoundToolKitAmbientSource.Awake ( )

protectedvirtual

Implements SoundToolKit.Unity.SourceComponent.

OnDestroy()

override void SoundToolKit.Unity.SoundToolKitAmbientSource.OnDestroy ( )

protectedvirtual

Implements SoundToolKit.Unity.SourceComponent.

OnDisable()

override void SoundToolKit.Unity.SoundToolKitAmbientSource.OnDisable ( )

protectedvirtual

Implements SoundToolKit.Unity.SourceComponent.

OnEnable()

override void SoundToolKit.Unity.SoundToolKitAmbientSource.OnEnable ( )

protectedvirtual

Implements SoundToolKit.Unity.SourceComponent.

OnStkInitialized()

override void SoundToolKit.Unity.SoundToolKitAmbientSource.OnStkInitialized ( SoundToolKitManager  soundToolKitManager )

virtual

Implements SoundToolKit.Unity.SourceComponent.

Pause()

void SoundToolKit.Unity.SoundToolKitAmbientSource.Pause

(

)

Pauses all incoming sounds from that Source.

PauseRange()

void SoundToolKit.Unity.SoundToolKitAmbientSource.PauseRange	(	int	firstPlaybackToPauseIndex,
		int	lastPlaybackToPauseIndex
	)

Pause a specified range of Playbacks from Source's list. Pauses all by default.

PauseSingle()

void SoundToolKit.Unity.SoundToolKitAmbientSource.PauseSingle

(

int

playbackToPauseIndex = 0

)

Pause a single Playback from the Source's Playback list.

Parameters

playbackToPauseIndex

Index of Playback to pause. Defaults to the first Playback on the list.

Play()

override void SoundToolKit.Unity.SoundToolKitAmbientSource.Play ( )

virtual

Play all the Playbacks on the Source's list.

Implements SoundToolKit.Unity.SourceComponent.

PlayRandom()

void SoundToolKit.Unity.SoundToolKitAmbientSource.PlayRandom	(	int	firstPlaybackToRandomFromIndex = 0,
		int?	lastPlaybackToRandomFromIndex = null
	)

Play a random Playback from the specified range on the Source's Playback List (whole List by default).

Parameters

firstPlaybackToRandomFromIndex	Index of first Playback to randomize from. Defaults to the first Playback on the list.
lastPlaybackToRandomFromIndex	Index of last Playback to randomize from. Defaults to the last Playback on the list.

PlayRange()

void SoundToolKit.Unity.SoundToolKitAmbientSource.PlayRange	(	int	firstPlaybackToPlayIndex,
		int	lastPlaybackToPlayIndex
	)

Play a specified range of Playbacks from Source's list.

PlaySingle()

void SoundToolKit.Unity.SoundToolKitAmbientSource.PlaySingle

(

int

playbackToPlayIndex = 0

)

Play a single Playback from the Source's Playback list.

Parameters

playbackToPlayIndex

Index of Playback to play by the Source. Defaults to the first Playback on the list.

Stop()

override void SoundToolKit.Unity.SoundToolKitAmbientSource.Stop ( )

virtual

Stops all incoming sounds from that Source.

Implements SoundToolKit.Unity.SourceComponent.

StopRange()

void SoundToolKit.Unity.SoundToolKitAmbientSource.StopRange	(	int	firstPlaybackToStopIndex,
		int	lastPlaybackToStopIndex
	)

Stop a specified range of Playbacks from Source's list.

StopSingle()

void SoundToolKit.Unity.SoundToolKitAmbientSource.StopSingle

(

int

playbackToStopIndex = 0

)

Stop a single Playback from the Source's Playback list.

Parameters

playbackToStopIndex

Index of Playback to stop. Defaults to the first Playback on the list.

Property Documentation

IsPlaying

override bool SoundToolKit.Unity.SoundToolKitAmbientSource.IsPlaying

get

Muted

override bool? SoundToolKit.Unity.SoundToolKitAmbientSource.Muted

getset

Playbacks

List<SoundToolKitPlayback> SoundToolKit.Unity.SoundToolKitAmbientSource.Playbacks

getset

List of Playbacks, which consist of StkSample, Looped control, PlayOnAwake control and internal StkPlayback.

Volume

override float? SoundToolKit.Unity.SoundToolKitAmbientSource.Volume

getset