AudioPlayer Class Reference

Controls audio playing and gives it a UI. More...

Inheritance diagram for AudioPlayer:

Protected Member Functions
void	SetAudio (AudioClip clip)
override void	OnEnable ()
override void	OnDisable ()
void	Start ()
void	Update ()
override void	DrawGUI ()
	Override this. Use ImGui to draw most UI elements here.
void	DrawMainMenuItems (string menuName)
override void	OnPlayStart ()
	Override this. Called when the visualization starts playing. May be starting from the beginning or resuming.
override void	OnPlayStop ()
	Override this. Called when the visualization stops playing.
override void	Restart ()
	Override this. Called when the visualization restarts (R is pressed).
override void	LoadAudio ()
	Override this. Called when the audio needs to be loaded from the file.
Protected Member Functions inherited from OmidivComponent
virtual void	Awake ()
virtual void	OnDestroy ()
virtual void	ReadConfig ()
	Override this. Read from Config here. Don't forget to include ConfigTag in your config keys.
virtual void	WriteConfig ()
	Override this. Write to Config here. Don't forget to include ConfigTag in your config keys.
virtual void	Reset_ ()
	Override this. Called when SceneController.OnReset is fired. LoadAudio and LoadMidi will also be called afterwards, so don't do any of that here, but do reload any other resources your component needs.
virtual void	LoadMidi ()
	Override this. Called when the midi information needs to be loaded from the file. LoadVisuals will also be called afterwards, so don't do any of that here.
virtual void	LoadVisuals ()
	Override this. Called when the visuals need to be recreated (like when something in the MIDI Controls window is changed).

Protected Attributes
NAudioImporter	AudioImporter
AudioSource	Sound

Static Protected Attributes
static FileInfo	AudioPath
static AudioClip	AudioClip
static int	AudioOffset
	Milliseconds.
static bool	AudioOffsetChanged
static float	AudioTime = 0
	Seconds.
static bool	IsPaused = false

Additional Inherited Members
Public Attributes inherited from OmidivComponent
string	ConfigTag = "def"
	Use this to give different instances in difference scenes different saved config.
Properties inherited from OmidivComponent
static bool	IsPlaying [get]
	Is the visualization currently playing.
static double	FrameDeltaTime [get]
	Time.deltaTime when not recording, 1/recording framerate when recording. In most cases, use this instead of Time.deltaTime so that recordings work properly.

Detailed Description

Controls audio playing and gives it a UI.

Member Function Documentation

DrawGUI()

override void AudioPlayer.DrawGUI ( )

protectedvirtual

Override this. Use ImGui to draw most UI elements here.

Subscribe to ImGuiManager.DrawMainMenuItems to add to main menu bar menus instead of here.

Reimplemented from OmidivComponent.

LoadAudio()

override void AudioPlayer.LoadAudio ( )

protectedvirtual

Override this. Called when the audio needs to be loaded from the file.

Reimplemented from OmidivComponent.

OnDisable()

override void AudioPlayer.OnDisable ( )

protectedvirtual

Please call base.OnDisable() if overriding this, unless you really know what you're doing.

Reimplemented from OmidivComponent.

OnEnable()

override void AudioPlayer.OnEnable ( )

protectedvirtual

Please call base.OnEnable() if overriding this, unless you really know what you're doing.

Reimplemented from OmidivComponent.

OnPlayStart()

override void AudioPlayer.OnPlayStart ( )

protectedvirtual

Override this. Called when the visualization starts playing. May be starting from the beginning or resuming.

Reimplemented from OmidivComponent.

OnPlayStop()

override void AudioPlayer.OnPlayStop ( )

protectedvirtual

Override this. Called when the visualization stops playing.

Reimplemented from OmidivComponent.

Restart()

override void AudioPlayer.Restart ( )

protectedvirtual

Override this. Called when the visualization restarts (R is pressed).

Reimplemented from OmidivComponent.

---

The documentation for this class was generated from the following file:

• L:/Coding/Unity/OMIDIV/Assets/Scripts/AudioPlayer.cs