SoundToolKit.Unity.SourceComponent Class Reference

Base class for Stk SoundSources. More...

Inheritance diagram for SoundToolKit.Unity.SourceComponent:

Public Member Functions
abstract void	OnStkInitialized (SoundToolKitManager soundToolKitManager)
abstract void	Play ()
abstract void	Stop ()

Public Attributes
bool	playOnAwake = true

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

Protected Attributes
bool	m_muted = false
float	m_volume = 0.75f
bool	m_isPlayingPreviousState

Properties
bool	Initialized [get, protected set]
abstract bool	IsPlaying [get]
abstract bool	Muted [get, set]
abstract float	Volume [get, set]

Detailed Description

Base class for Stk SoundSources.

Member Function Documentation

Awake()

abstract void SoundToolKit.Unity.SourceComponent.Awake ( )

protectedpure virtual

Implemented in SoundToolKit.Unity.SoundToolKitAmbientSource, SoundToolKit.Unity.SoundToolKitSpatialSource, and SoundToolKit.Unity.SoundToolKitStreamingSource.

OnDestroy()

abstract void SoundToolKit.Unity.SourceComponent.OnDestroy ( )

protectedpure virtual

Implemented in SoundToolKit.Unity.SoundToolKitAmbientSource, SoundToolKit.Unity.SpatialComponent, SoundToolKit.Unity.SoundToolKitSpatialSource, and SoundToolKit.Unity.SoundToolKitStreamingSource.

OnDisable()

abstract void SoundToolKit.Unity.SourceComponent.OnDisable ( )

protectedpure virtual

Implemented in SoundToolKit.Unity.SoundToolKitAmbientSource, SoundToolKit.Unity.SoundToolKitSpatialSource, and SoundToolKit.Unity.SoundToolKitStreamingSource.

OnEnable()

abstract void SoundToolKit.Unity.SourceComponent.OnEnable ( )

protectedpure virtual

Implemented in SoundToolKit.Unity.SoundToolKitAmbientSource, SoundToolKit.Unity.SoundToolKitSpatialSource, and SoundToolKit.Unity.SoundToolKitStreamingSource.

OnStkInitialized()

abstract void SoundToolKit.Unity.SourceComponent.OnStkInitialized ( SoundToolKitManager  soundToolKitManager )

pure virtual

Implemented in SoundToolKit.Unity.SpatialComponent, SoundToolKit.Unity.SoundToolKitAmbientSource, SoundToolKit.Unity.SoundToolKitSpatialSource, and SoundToolKit.Unity.SoundToolKitStreamingSource.

Play()

abstract void SoundToolKit.Unity.SourceComponent.Play ( )

pure virtual

Implemented in SoundToolKit.Unity.SoundToolKitAmbientSource, SoundToolKit.Unity.SoundToolKitSpatialSource, and SoundToolKit.Unity.SoundToolKitStreamingSource.

Stop()

abstract void SoundToolKit.Unity.SourceComponent.Stop ( )

pure virtual

Implemented in SoundToolKit.Unity.SoundToolKitAmbientSource, SoundToolKit.Unity.SoundToolKitSpatialSource, and SoundToolKit.Unity.SoundToolKitStreamingSource.

Member Data Documentation

m_isPlayingPreviousState

bool SoundToolKit.Unity.SourceComponent.m_isPlayingPreviousState

protected

m_muted

bool SoundToolKit.Unity.SourceComponent.m_muted = false

protected

m_volume

float SoundToolKit.Unity.SourceComponent.m_volume = 0.75f

protected

playOnAwake

bool SoundToolKit.Unity.SourceComponent.playOnAwake = true

Property Documentation

Initialized

bool SoundToolKit.Unity.SourceComponent.Initialized

getprotected set

IsPlaying

abstract bool SoundToolKit.Unity.SourceComponent.IsPlaying

get

Muted

abstract bool SoundToolKit.Unity.SourceComponent.Muted

getset

Volume

abstract float SoundToolKit.Unity.SourceComponent.Volume

getset