SoundToolKit  1.5
SoundToolKit.Unity.SoundToolKitPlayback Class Reference

Utilized by SoundSources, Playback consist of SoundToolKitSample to be played plus Looped and AutoPlay controls. More...

Public Member Functions

 SoundToolKitPlayback (SoundToolKitSample sample=null)
 

Properties

SoundToolKitSample SoundToolKitSample [get, set]
 StkSample that is used to create this playback More...
 
bool? Looped [get, set]
 Whether the playback is supposed to be looped More...
 
bool AutoPlay [get, set]
 Whether the Playback is supposed to play automatically when the scene is initialized or when there are changes made to the Playback's editor fields More...
 
bool? IsPlaying [get]
 
string Name [get, set]
 

Events

Action< SoundToolKitPlaybackOnPaused
 
Action< SoundToolKitPlaybackOnStarted
 
Action< SoundToolKitPlaybackOnEnded
 

Detailed Description

Utilized by SoundSources, Playback consist of SoundToolKitSample to be played plus Looped and AutoPlay controls.

Constructor & Destructor Documentation

◆ SoundToolKitPlayback()

SoundToolKit.Unity.SoundToolKitPlayback.SoundToolKitPlayback ( SoundToolKitSample  sample = null)

Property Documentation

◆ AutoPlay

bool SoundToolKit.Unity.SoundToolKitPlayback.AutoPlay
getset

Whether the Playback is supposed to play automatically when the scene is initialized or when there are changes made to the Playback's editor fields

◆ IsPlaying

bool? SoundToolKit.Unity.SoundToolKitPlayback.IsPlaying
get

◆ Looped

bool? SoundToolKit.Unity.SoundToolKitPlayback.Looped
getset

Whether the playback is supposed to be looped

◆ Name

string SoundToolKit.Unity.SoundToolKitPlayback.Name
getset

◆ SoundToolKitSample

SoundToolKitSample SoundToolKit.Unity.SoundToolKitPlayback.SoundToolKitSample
getset

StkSample that is used to create this playback

Event Documentation

◆ OnEnded

Action<SoundToolKitPlayback> SoundToolKit.Unity.SoundToolKitPlayback.OnEnded

◆ OnPaused

Action<SoundToolKitPlayback> SoundToolKit.Unity.SoundToolKitPlayback.OnPaused

◆ OnStarted

Action<SoundToolKitPlayback> SoundToolKit.Unity.SoundToolKitPlayback.OnStarted