documentation.HELP! ClockStone Audio Toolkit Documentation

ClockStone Audio Toolkit for Unity - Documentation

ClockStone Audio Toolkit

Table of contents

• ( Default Namespace )
• AudioCategory Class
• AudioCategory Constructor
• AudioCategory Properties
• audioController Property
• isFadeOutComplete Property
• isFadingIn Property
• isFadingOut Property
• parentCategory Property
• Volume Property
• VolumeTotal Property
• AudioCategory Methods
• FadeIn Method
• FadeOut Method
• GetAudioMixerGroup Method
• GetAudioObjectPrefab Method
• UnloadAllAudioClips Method
• AudioCategory Fields
• AudioItems Field
• audioMixerGroup Field
• AudioObjectPrefab Field
• Name Field
• AudioController Class
• AudioController Constructor
• AudioController Properties
• ambienceSoundCrossFadeTime_In Property
• ambienceSoundCrossFadeTime_Out Property
• ambienceSoundEnabled Property
• DisableAudio Property
• isAdditionalAudioController Property
• isSingletonObject Property
• musicCrossFadeTime_In Property
• musicCrossFadeTime_Out Property
• musicEnabled Property
• soundMuted Property
• systemDeltaTime Property
• systemTime Property
• Volume Property
• AudioController Methods
• AddPlaylist Method
• AddToCategory Method
• AddToCategory Method (AudioCategory, AudioItem)
• AddToCategory Method (AudioCategory, AudioClip, String)
• ClearPlaylists Method
• DetachAllAudios Method
• EnableAmbienceSound Method
• EnableMusic Method
• EnqueueMusic Method
• FadeInCategory Method
• FadeOutCategory Method
• GetAudioItem Method
• GetAudioItemMaxDistance Method
• GetCategory Method
• GetCategoryVolume Method
• GetCurrentAmbienceSound Method
• GetCurrentAudioListener Method
• GetCurrentMusic Method
• GetGlobalVolume Method
• GetMusicPlaylist Method
• GetPlayingAudioObjects Method
• GetPlayingAudioObjects Method (Boolean)
• GetPlayingAudioObjects Method (String, Boolean)
• GetPlayingAudioObjectsCount Method
• GetPlayingAudioObjectsInCategory Method
• GetPlaylistByName Method
• InitializeAudioItems Method
• IsAmbienceSoundEnabled Method
• IsAmbienceSoundPaused Method
• IsMusicEnabled Method
• IsMusicPaused Method
• IsPlaying Method
• IsPlaylistPlaying Method
• IsSoundMuted Method
• IsValidAudioID Method
• MuteSound Method
• NewCategory Method
• OnAfterDeserialize Method
• OnBeforeSerialize Method
• PauseAll Method
• PauseAmbienceSound Method
• PauseCategory Method
• PauseMusic Method
• Play Method
• Play Method (String)
• Play Method (String, Transform)
• Play Method (String, Vector3, Transform)
• Play Method (String, Single, Single, Single)
• Play Method (String, Transform, Single, Single, Single)
• Play Method (String, Vector3, Transform, Single, Single, Single)
• PlayAfter Method
• PlayAmbienceSound Method
• PlayAmbienceSound Method (String, Single, Single, Single)
• PlayAmbienceSound Method (String, Transform, Single, Single, Single)
• PlayAmbienceSound Method (String, Vector3, Transform, Single, Single, Single)
• PlayAudioItem Method
• PlayAudioSubItem Method
• PlayMusic Method
• PlayMusic Method (String, Single, Single, Single)
• PlayMusic Method (String, Transform, Single, Single, Single)
• PlayMusic Method (String, Vector3, Transform, Single, Single, Single)
• PlayMusicPlaylist Method
• PlayNextMusicOnPlaylist Method
• PlayPreviousMusicOnPlaylist Method
• PlayScheduled Method
• RemoveAudioItem Method
• RemoveCategory Method
• SetCategoryVolume Method
• SetCurrentMusicPlaylist Method
• SetGlobalVolume Method
• Stop Method
• Stop Method (String)
• Stop Method (String, Single)
• StopAll Method
• StopAll Method
• StopAll Method (Single)
• StopAmbienceSound Method
• StopAmbienceSound Method
• StopAmbienceSound Method (Single)
• StopCategory Method
• StopMusic Method
• StopMusic Method
• StopMusic Method (Single)
• UnloadAllAudioClips Method
• UnpauseAll Method
• UnpauseAmbienceSound Method
• UnpauseCategory Method
• UnpauseMusic Method
• AudioController Fields
• _currentInspectorSelection Field
• ambienceSoundCrossFadeTime Field
• AUDIO_TOOLKIT_VERSION Field
• AudioCategories Field
• AudioObjectPrefab Field
• crossfadePlaylist Field
• delayBetweenPlaylistTracks Field
• EqualPowerCrossfade Field
• loopPlaylist Field
• musicCrossFadeTime Field
• musicPlaylist Field
• musicPlaylists Field
• Persistent Field
• PlayWithZeroVolume Field
• shufflePlaylist Field
• specifyCrossFadeInAndOutSeperately Field
• UnloadAudioClipsOnDestroy Field
• UsePooledAudioObjects Field
• AudioItem Class
• AudioItem Constructor
• AudioItem Constructor
• AudioItem Constructor (AudioItem)
• AudioItem Properties
• category Property
• AudioItem Methods
• ResetSequence Method
• UnloadAudioClip Method
• AudioItem Fields
• audioSource_MaxDistance Field
• audioSource_MinDistance Field
• Delay Field
• DestroyOnLoad Field
• Loop Field
• loopSequenceCount Field
• loopSequenceOverlap Field
• loopSequenceRandomDelay Field
• loopSequenceRandomPitch Field
• loopSequenceRandomVolume Field
• MaxInstanceCount Field
• MinTimeBetweenPlayCalls Field
• Name Field
• overrideAudioSourceSettings Field
• RandomDelay Field
• RandomPitch Field
• RandomVolume Field
• spatialBlend Field
• SubItemPickMode Field
• subItems Field
• Volume Field
• AudioItem.LoopMode Enumeration
• AudioLog Class
• AudioLog Methods
• Clear Method
• Log Method
• AudioLog Fields
• logData Field
• onLogUpdated Field
• AudioLog.LogData Class
• LogData Fields
• time Field
• AudioLog.LogData_Destroy Class
• AudioLog.LogData_Destroy Constructor
• LogData_Destroy Fields
• audioID Field
• category Field
• clipName Field
• parentObject Field
• position Field
• AudioLog.LogData_PlayClip Class
• AudioLog.LogData_PlayClip Constructor
• LogData_PlayClip Fields
• audioID Field
• category Field
• clipName Field
• delay Field
• parentObject Field
• pitch Field
• position Field
• scheduledDspTime Field
• startTime Field
• volume Field
• AudioLog.LogData_SkippedPlay Class
• AudioLog.LogData_SkippedPlay Constructor
• LogData_SkippedPlay Fields
• audioID Field
• category Field
• delay Field
• parentObject Field
• position Field
• reasonForSkip Field
• scheduledDspTime Field
• startTime Field
• volume Field
• AudioLog.LogData_Stop Class
• AudioLog.LogData_Stop Constructor
• LogData_Stop Fields
• audioID Field
• category Field
• clipName Field
• parentObject Field
• position Field
• AudioObject Class
• AudioObject Constructor
• AudioObject Properties
• audioID Property
• audioItem Property
• audioObjectTime Property
• audioTime Property
• category Property
• clipLength Property
• completelyPlayedDelegate Property
• isFadeOutComplete Property
• isFadingIn Property
• isFadingOut Property
• isFadingOutOrScheduled Property
• isPlayedAsMusicOrAmbienceSound Property
• pan Property
• pitch Property
• playCalledAtTime Property
• primaryAudioSource Property
• scheduledPlayingAtDspTime Property
• secondaryAudioSource Property
• startedPlayingAtTime Property
• stopAfterFadeOut Property
• subItem Property
• timeUntilEnd Property
• volume Property
• volumeItem Property
• volumeTotal Property
• volumeTotalWithoutFade Property
• AudioObject Methods
• DestroyAudioObject Method
• DoesBelongToCategory Method
• FadeIn Method
• FadeOut Method
• FadeOut Method (Single)
• FadeOut Method (Single, Single)
• FinishSequence Method
• InverseTransformPitch Method
• InverseTransformVolume Method
• IsPaused Method
• IsPlaying Method
• IsPrimaryPlaying Method
• IsSecondaryPlaying Method
• Pause Method
• Pause Method
• Pause Method (Single)
• Play Method
• PlayAfter Method
• PlayNow Method
• PlayScheduled Method
• Stop Method
• Stop Method
• Stop Method (Single)
• Stop Method (Single, Single)
• SwitchAudioSources Method
• TransformPitch Method
• TransformVolume Method
• Unpause Method
• Unpause Method
• Unpause Method (Single)
• AudioObject.AudioEventDelegate Delegate
• AudioPickSubItemMode Enumeration
• AudioSubItem Class
• AudioSubItem Constructor
• AudioSubItem Constructor
• AudioSubItem Constructor (AudioSubItem, AudioItem)
• AudioSubItem Properties
• item Property
• AudioSubItem Methods
• ToString Method
• AudioSubItem Fields
• Clip Field
• ClipStartTime Field
• ClipStopTime Field
• Delay Field
• DisableOtherSubitems Field
• FadeIn Field
• FadeOut Field
• individualSettings Field
• ItemModeAudioID Field
• Pan2D Field
• PitchShift Field
• Probability Field
• RandomDelay Field
• RandomPitch Field
• RandomStartPosition Field
• RandomVolume Field
• SubItemType Field
• Volume Field
• AudioSubItemType Enumeration
• IRegisteredComponent Interface
• IRegisteredComponent Methods
• GetRegisteredComponentBaseClassType Method
• ObjectPoolController Class
• ObjectPoolController Properties
• isDuringPreload Property
• ObjectPoolController Methods
• Destroy Method
• Instantiate Method
• Instantiate Method (GameObject)
• Instantiate Method (GameObject, Vector3, Quaternion)
• InstantiateWithoutPool Method
• InstantiateWithoutPool Method (GameObject)
• InstantiateWithoutPool Method (GameObject, Vector3, Quaternion)
• Preload Method
• Playlist Class
• Playlist Constructor
• Playlist Constructor
• Playlist Constructor (String, String[])
• Playlist Fields
• name Field
• playlistItems Field
• PoolableObject Class
• PoolableObject Constructor
• PoolableObject Methods
• DeactivateAllPoolableObjectsOfMyKind Method
• GetAllPoolableObjectsOfMyKind Method
• GetSerialNumber Method
• GetUsageCount Method
• IsDeactivated Method
• PoolableObject Fields
• doNotDestroyOnLoad Field
• maxPoolSize Field
• preloadCount Field
• sendAwakeStartOnDestroyMessage Field
• sendPoolableActivateDeactivateMessages Field
• PoolableReference(T) Class
• PoolableReference(T) Constructor
• PoolableReference(T) Constructor
• PoolableReference(T) Constructor (T)
• PoolableReference(T) Constructor (PoolableReference(T))
• PoolableReference(T) Methods
• Get Method
• Reset Method
• Set Method
• Set Method (T)
• Set Method (T, Boolean)
• RegisteredComponent Class
• RegisteredComponent Methods
• GetRegisteredComponentBaseClassType Method
• RegisteredComponentController Class
• RegisteredComponentController Methods
• GetAllOfType Method
• GetAllOfType(T) Method
• GetAllOfType Method (Type)
• InstanceCountOfType(T) Method
• SingletonMonoBehaviour(T) Class
• SingletonMonoBehaviour(T) Properties
• Instance Property
• isSingletonObject Property
• SingletonMonoBehaviour(T) Methods
• ActivateSingletonInstance Method
• DoesInstanceExist Method
• SetSingletonAutoCreate Method
• SetSingletonType Method

next page

Get in touch

Submit feedback about this site to:

• [email protected]