API reference

BaseAudioSystem Class

Extends MonoBehaviour
An abstract audio system class that defaults to use RawAudioClipStream and

Properties

ClipSettings : AudioClipSettings
[Get][Set]
The clip settings accessor
Signature
AudioClipSettings Meta.Voice.Audio.BaseAudioSystem< TAudioClipStream, TAudioPlayer >.ClipSettings
Logger : IVLogger
[Get]
Signature
IVLogger Meta.Voice.Audio.BaseAudioSystem< TAudioClipStream, TAudioPlayer >.Logger

Protected Methods

GenerateClip ()
Attempts to generate the specified clip stream if possible
Signature
virtual TAudioClipStream Meta.Voice.Audio.BaseAudioSystem< TAudioClipStream, TAudioPlayer >.GenerateClip()
Returns
TAudioClipStream
GeneratePool ()
Generate pool if missing
Signature
virtual void Meta.Voice.Audio.BaseAudioSystem< TAudioClipStream, TAudioPlayer >.GeneratePool()
Returns
void
OnDestroy ()
Destroy all audio clips in the cache
Signature
virtual void Meta.Voice.Audio.BaseAudioSystem< TAudioClipStream, TAudioPlayer >.OnDestroy()
Returns
void
UnloadAudioClipStream ( clipStream )
Unload method to add back to the pool
Signature
virtual void Meta.Voice.Audio.BaseAudioSystem< TAudioClipStream, TAudioPlayer >.UnloadAudioClipStream(IAudioClipStream clipStream)
Parameters
clipStream: IAudioClipStream
Returns
void

Methods

GetAudioClipStream ()
Returns a new audio clip stream for audio stream handling
Signature
virtual IAudioClipStream Meta.Voice.Audio.BaseAudioSystem< TAudioClipStream, TAudioPlayer >.GetAudioClipStream()
GetAudioPlayer ( root )
Returns a new audio player for managing audio clip stream playback states
Signature
virtual IAudioPlayer Meta.Voice.Audio.BaseAudioSystem< TAudioClipStream, TAudioPlayer >.GetAudioPlayer(GameObject root)
Parameters
root: GameObject  The gameobject to add the player to if applicable
PreloadClipStreams ( total )
A method for preloading clip streams into a cache
Signature
virtual void Meta.Voice.Audio.BaseAudioSystem< TAudioClipStream, TAudioPlayer >.PreloadClipStreams(int total)
Parameters
total: int  Total clip streams to be preloaded
Returns
void