API reference

SimulatedAudioPlayer Class

Audio player that simulates playback without playing audio. Useful for server based playback simulation.

Fields

CanSetElapsedSamples : override bool
Elapsed samples can be used for animation progress
Signature
override bool Meta.Voice.Audio.SimulatedAudioPlayer.CanSetElapsedSamples
ElapsedSamples : override int
The currently elapsed sample count
Signature
override int Meta.Voice.Audio.SimulatedAudioPlayer.ElapsedSamples
IsPlaying : override bool
Whether the player is currently playing back audio
Signature
override bool Meta.Voice.Audio.SimulatedAudioPlayer.IsPlaying

Properties

Logger : IVLogger
[Get]
Handles error logging
Signature
IVLogger Meta.Voice.Audio.SimulatedAudioPlayer.Logger

Protected Methods

Play ( offsetSamples )
Begins fake playback at a specified offset.
Signature
override void Meta.Voice.Audio.SimulatedAudioPlayer.Play(int offsetSamples=0)
Parameters
offsetSamples: int  The starting offset of the clip in samples
Returns
override void

Methods

GetPlaybackErrors ()
No playback errors possible
Signature
override string Meta.Voice.Audio.SimulatedAudioPlayer.GetPlaybackErrors()
Returns
override string
Init ()
No initialization required
Signature
override void Meta.Voice.Audio.SimulatedAudioPlayer.Init()
Returns
override void
Pause ()
Performs a pause if the current clip is playing
Signature
override void Meta.Voice.Audio.SimulatedAudioPlayer.Pause()
Returns
override void
Resume ()
Performs a resume if the current clip is paused
Signature
override void Meta.Voice.Audio.SimulatedAudioPlayer.Resume()
Returns
override void
Stop ()
Stops playback & removes the current clip reference
Signature
override void Meta.Voice.Audio.SimulatedAudioPlayer.Stop()
Returns
override void