SoundToolKit Spatial Source, capable of playing multiple SoundToolKit Samples with various Play methods. More...

Inheritance diagram for SoundToolKit.Unity.SoundToolKitSpatialSource:

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...

Public Member Functions inherited from SoundToolKit.Unity.SpatialComponent
override void	OnStkInitialized (SoundToolKitManager soundToolKitManager)

Protected Member Functions
override void	Awake ()

override void	OnDestroy ()

override void	OnDisable ()

override void	OnEnable ()

Protected Member Functions inherited from SoundToolKit.Unity.SpatialComponent
override void	OnDestroy ()

Properties
override bool	IsPlaying `[get]`

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.SpatialComponent
override bool?	Muted `[get, set]`

override float?	Volume `[get, set]`

float?	SimulationQuality `[get, set]`
	This currently has no effect. Will be added in the future releases. Determines the quality of source processing. The value affects how many engine resources are delegated for processing sound emitted by this source. The simulation quality also determines the priority of given source, meaning, that sources with higher simulation quality can have lower latency. Quality in range 0 to 1.0, where: 1.0 - the best possible quality 0.0 - source not processed at all More...

bool?	HrtfSpatializationEnabled `[get, set]`
	Enables/Disables HRTF's More...

AnimationCurve	AttenuationCurve `[get]`
	The custom Attenuation curve interpreted from Unity's AnimationCurve. It will be used if Attenuation is set to Custom. Axis x represents distance while axis y represents attenuation in range 0 to 1.0, where: 1.0 - no attenuation 0.0 - full attenuation More...

float?	MaxDistance `[get, set]`
	Max distance of virtual sphere that simulates boundary of source volume This is only valid in Linear and ReverseLog Attenuation curve. More...

float?	Radius `[get, set]`
	Radius of virtual sphere that simulates boundary of source volume. This means that below this distance from source attenuation will not occur. Above that distance attenuation will be calculated according to chosen attenuation curve (see setAttenuation) More...

SoundSourceAttenuation?	Attenuation `[get, set]`
	The attenuation model which should be used by this source 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.SpatialComponent
float	m_simulationQuality = 1f

bool	m_hrtfSpatializationEnabled = true

float	m_maxDistance = 300

float	m_radius = 0.25f

SoundSourceAttenuation	m_attenuation = SoundSourceAttenuation.InverseDistance

AnimationCurve	m_attenuationCurve = AnimationCurve.Linear(0, 1, 300, 0)

SourceSpatial	m_spatialSoundSource

Protected Attributes inherited from SoundToolKit.Unity.SourceComponent
bool	m_muted = false

float	m_volume = 0.75f

bool	m_isPlayingPreviousState

Detailed Description

SoundToolKit Spatial Source, capable of playing multiple SoundToolKit Samples with various Play methods.

Member Function Documentation

◆ Awake()

override void SoundToolKit.Unity.SoundToolKitSpatialSource.Awake ( )

protectedvirtual

Implements SoundToolKit.Unity.SourceComponent.

◆ OnDestroy()

override void SoundToolKit.Unity.SoundToolKitSpatialSource.OnDestroy ( )

protectedvirtual

Implements SoundToolKit.Unity.SourceComponent.

◆ OnDisable()

override void SoundToolKit.Unity.SoundToolKitSpatialSource.OnDisable ( )

protectedvirtual

Implements SoundToolKit.Unity.SourceComponent.

◆ OnEnable()

override void SoundToolKit.Unity.SoundToolKitSpatialSource.OnEnable ( )

protectedvirtual

Implements SoundToolKit.Unity.SourceComponent.

◆ OnStkInitialized()

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

virtual

Implements SoundToolKit.Unity.SourceComponent.

◆ Pause()

void SoundToolKit.Unity.SoundToolKitSpatialSource.Pause ( )

Pauses all incoming sounds from that Source.

◆ PauseRange()

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

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

◆ PauseSingle()

void SoundToolKit.Unity.SoundToolKitSpatialSource.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.SoundToolKitSpatialSource.Play ( )

virtual

Play all the Playbacks on the Source's list.

Implements SoundToolKit.Unity.SourceComponent.

◆ PlayRandom()

void SoundToolKit.Unity.SoundToolKitSpatialSource.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.SoundToolKitSpatialSource.PlayRange	(	int	firstPlaybackToPlayIndex,
		int	lastPlaybackToPlayIndex
	)

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

◆ PlaySingle()

void SoundToolKit.Unity.SoundToolKitSpatialSource.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.SoundToolKitSpatialSource.Stop ( )

virtual

Stops all incoming sounds from that Source.

Implements SoundToolKit.Unity.SourceComponent.

◆ StopRange()

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

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

◆ StopSingle()

void SoundToolKit.Unity.SoundToolKitSpatialSource.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.SoundToolKitSpatialSource.IsPlaying

get

◆ Playbacks

List<SoundToolKitPlayback> SoundToolKit.Unity.SoundToolKitSpatialSource.Playbacks

getset

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

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Awake()

◆ OnDestroy()

◆ OnDisable()

◆ OnEnable()

◆ OnStkInitialized()

◆ Pause()

◆ PauseRange()

◆ PauseSingle()

◆ Play()

◆ PlayRandom()

◆ PlayRange()

◆ PlaySingle()

◆ Stop()

◆ StopRange()

◆ StopSingle()

Property Documentation

◆ IsPlaying

◆ Playbacks