UOperatingSystemAudioPlayer

#include <OperatingSystemSimulator/Public/Programs/MusicPlayer/OperatingSystemAudioPlayer.h>

class UOperatingSystemAudioPlayer

Defined in OperatingSystemAudioPlayer.h:30

Inherits: UOperatingSystemBaseProgram

Inheritance diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemAudioPlayer["UOperatingSystemAudioPlayer"]
  class UOperatingSystemBaseProgram["UOperatingSystemBaseProgram"]
  UOperatingSystemBaseProgram <|-- UOperatingSystemAudioPlayer

Collaboration diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemAudioPlayer["UOperatingSystemAudioPlayer"]
  class UOperatingSystemBaseProgram["UOperatingSystemBaseProgram"]
  UOperatingSystemAudioPlayer *-- UOperatingSystemBaseProgram

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemAudioPlayer {
    +OnAudioPlayStateChanged : FOnOperatingSystemAudioPlayStateChanged(
    +OnAudioPlaybackChanged : FOnOperatingSystemAudioPlayerPlaybackCha
    +OnAudioPlaybackFinished : FOnOperatingSystemAudioPlaybackFinished(
    +UOperatingSystemAudioPlayer()
    +PlayAudio(const float StartTime=0.f) const bool()
    +StopAudio() const bool()
    +SetVolumeMultiplier(const float NewMultiplier) const bool()
    +SetPaused(const bool bPause) const bool()
    +GetPlayState() const EAudioComponentPlayState()
    +GetAudioDuration() const float()
    +OnOpenFile(UOperatingSystemFile *TargetFile, FGenericE void()
    +OnClose(FGenericError &OutError) override void()
    +CurrentAudioComponent : TObjectPtr()< UAudioComponent() >
    +Internal_OnAudioPlayStateChanged(EAudioComponentPlayState NewState) void()
    +Internal_OnAudioPlaybackChanged(const USoundWave *PlayingSoundWave, const f void()
    +Internal_OnAudioFinished() void()
  }

The UOperatingSystemAudioPlayer class is an abstract class that represents an audio player in the operating system. It inherits from UOperatingSystemBaseProgram and provides functionality to play audio files, control playback, and retrieve information about the audio.

This class includes the following features:

• Playing audio: The PlayAudio method starts the playback of the audio file and triggers the OnAudioPlayStateChanged delegate.

• Stopping audio: The StopAudio method stops the playback of the audio file and triggers the OnAudioPlaybackFinished and OnAudioPlayStateChanged delegates.

• Changing volume: The SetVolumeMultiplier method sets the volume multiplier of the audio file.

• Pausing and unpausing: The SetPaused method toggles the pause state of the audio file and triggers the OnAudioPlayStateChanged delegate.

• Retrieving play state: The GetPlayState method returns the current play state of the audio file.

• Retrieving audio duration: The GetAudioDuration method returns the duration of the audio file.

See also: UOperatingSystemBaseProgram

Public Attributes

Return	Name	Description
FOnOperatingSystemAudioPlayStateChanged	OnAudioPlayStateChanged	Delegate that is triggered when the play state of the audio changes.
FOnOperatingSystemAudioPlayerPlaybackChanged	OnAudioPlaybackChanged	Delegate that is triggered when the audio playback changes.
FOnOperatingSystemAudioPlaybackFinished	OnAudioPlaybackFinished	Delegate that is triggered when the audio playback is finished.

---

OnAudioPlayStateChanged

FOnOperatingSystemAudioPlayStateChanged OnAudioPlayStateChanged

Defined in OperatingSystemAudioPlayer.h:41 Delegate that is triggered when the play state of the audio changes.

Referenced by

• Internal_OnAudioPlayStateChanged
• OnOpenFile

---

OnAudioPlaybackChanged

FOnOperatingSystemAudioPlayerPlaybackChanged OnAudioPlaybackChanged

Defined in OperatingSystemAudioPlayer.h:50 Delegate that is triggered when the audio playback changes.

Parameters

• PlaybackTime The current playback time in seconds.

• PlaybackPercent The current playback progress as a percentage (0-1).

Referenced by

• Internal_OnAudioPlaybackChanged

---

OnAudioPlaybackFinished

FOnOperatingSystemAudioPlaybackFinished OnAudioPlaybackFinished

Defined in OperatingSystemAudioPlayer.h:54 Delegate that is triggered when the audio playback is finished.

Referenced by

• Internal_OnAudioFinished

Public Methods

Return	Name	Description
	UOperatingSystemAudioPlayer
bool	PlayAudio const	Plays the audio. Triggers ‘On Audio Play State Changed’ delegate.
bool	StopAudio const	Stops audio playback. Triggers ‘On Audio Playback Finished’ and ‘On Audio Play State Changed’ delegates.
bool	SetVolumeMultiplier const	Sets volume multiplier.
bool	SetPaused const	Toggles pause state. Triggers ‘On Audio Play State Changed’ delegate.
EAudioComponentPlayState	GetPlayState const	Returns current play state of audio component.
float	GetAudioDuration const	Returns the duration of audio component.

---

UOperatingSystemAudioPlayer

UOperatingSystemAudioPlayer()

Defined in OperatingSystemAudioPlayer.h:56

References

• bAllowResizing
• Default
• DoNotSave
• GetSettings
• IconObject
• Identifier
• SaveMethod
• SpaceRequiredInMB
• StartWindowState

---

PlayAudio

const

bool PlayAudio(constfloat StartTime = 0.f) const

Defined in OperatingSystemAudioPlayer.h:65 Plays the audio. Triggers ‘On Audio Play State Changed’ delegate.

Parameters

• StartTime Optional time to start playback from.

Returns

True if playback was started. False otherwise.

References

• CurrentAudioComponent

---

StopAudio

const

bool StopAudio() const

Defined in OperatingSystemAudioPlayer.h:73 Stops audio playback. Triggers ‘On Audio Playback Finished’ and ‘On Audio Play State Changed’ delegates.

Returns

True if audio was stopped. False otherwise.

Referenced by

• OnClose

References

• CurrentAudioComponent

---

SetVolumeMultiplier

const

bool SetVolumeMultiplier(constfloat NewMultiplier) const

Defined in OperatingSystemAudioPlayer.h:82 Sets volume multiplier.

Parameters

• NewMultiplier Volume Multiplier (0-1 range).

Returns

True if volume multiplier was set. False otherwise.

References

• CurrentAudioComponent
• GetSettings

---

SetPaused

const

bool SetPaused(constbool bPause) const

Defined in OperatingSystemAudioPlayer.h:91 Toggles pause state. Triggers ‘On Audio Play State Changed’ delegate.

Parameters

• bPause True to pause audio. False to unpause.

Returns

True if the pause state was changed. False otherwise.

References

• CurrentAudioComponent
• GetSettings

---

GetPlayState

const

EAudioComponentPlayState GetPlayState() const

Defined in OperatingSystemAudioPlayer.h:99 Returns current play state of audio component.

Returns

Current state of the audio component.

References

• CurrentAudioComponent

---

GetAudioDuration

const

float GetAudioDuration() const

Defined in OperatingSystemAudioPlayer.h:107 Returns the duration of audio component.

Returns

Duration of audio.

References

• CurrentAudioComponent

Protected Methods

Return	Name	Description
void	OnOpenFile virtual override	Handles the event of opening a file in the audio player.
void	OnClose virtual override	Handles the event of closing the audio player.

---

OnOpenFile

virtual override

virtual void OnOpenFile(UOperatingSystemFile * TargetFile, FGenericError & OutError) override

Defined in OperatingSystemAudioPlayer.h:124 Handles the event of opening a file in the audio player.

This method is called when a file is opened in the audio player. It creates the audio component and sets up the necessary delegates for playback control. If the file is not supported by the audio player, an error is generated.

Parameters

• TargetFile The file to be opened.

• OutError (out) The error message, if any.

See also: UOperatingSystemFile

See also: FGenericError

References

• CurrentAudioComponent
• GetOperatingSystem
• GetProgramName
• GetSettings
• Internal_OnAudioFinished
• Internal_OnAudioPlaybackChanged
• Internal_OnAudioPlayStateChanged
• MAKE_ERROR
• OnAudioPlayStateChanged
• OP_BIND

Reimplements

• OnOpenFile

---

OnClose

virtual override

virtual void OnClose(FGenericError & OutError) override

Defined in OperatingSystemAudioPlayer.h:136 Handles the event of closing the audio player.

This method is called when the audio player is being closed. It stops the audio playback if it is currently playing and marks the current audio component as garbage. The current audio component is then set to nullptr.

Parameters

• OutError (out) The error message, if any.

See also: FGenericError

References

• CurrentAudioComponent
• StopAudio

Reimplements

• OnClose

Private Attributes

Return	Name	Description
TObjectPtr< UAudioComponent >	CurrentAudioComponent

---

CurrentAudioComponent

TObjectPtr< UAudioComponent > CurrentAudioComponent

Defined in OperatingSystemAudioPlayer.h:35

Referenced by

• GetAudioDuration
• GetPlayState
• OnClose
• OnOpenFile
• PlayAudio
• SetPaused
• SetVolumeMultiplier
• StopAudio

Private Methods

Return	Name	Description
void	Internal_OnAudioPlayStateChanged	Handles the event of audio play state change.
void	Internal_OnAudioPlaybackChanged	Handles the event of audio playback change.
void	Internal_OnAudioFinished	Handles the event of audio playback finished.

---

Internal_OnAudioPlayStateChanged

void Internal_OnAudioPlayStateChanged(EAudioComponentPlayState NewState)

Defined in OperatingSystemAudioPlayer.h:151 Handles the event of audio play state change.

This method is called when the play state of the audio changes. It triggers the OnAudioPlayStateChanged delegate.

Parameters

• NewState The new play state of the audio component.

See also: EAudioComponentPlayState

See also: OnAudioPlayStateChanged

Referenced by

• OnOpenFile

References

• GetSettings
• OnAudioPlayStateChanged

---

Internal_OnAudioPlaybackChanged

void Internal_OnAudioPlaybackChanged(constUSoundWave * PlayingSoundWave, constfloat PlaybackPercent)

Defined in OperatingSystemAudioPlayer.h:164 Handles the event of audio playback change.

This method is called when the audio playback changes. It triggers the OnAudioPlaybackChanged delegate.

Parameters

• PlayingSoundWave The USoundWave being played.

• PlaybackPercent The current playback progress as a percentage (0-1).

See also: OnAudioPlaybackChanged

Referenced by

• OnOpenFile

References

• GetSettings
• OnAudioPlaybackChanged

---

Internal_OnAudioFinished

void Internal_OnAudioFinished()

Defined in OperatingSystemAudioPlayer.h:174 Handles the event of audio playback finished.

This method is called when the audio playback is finished. It triggers the OnAudioPlaybackFinished delegate.

See also: OnAudioPlaybackFinished

Referenced by

• OnOpenFile

References

• OnAudioPlaybackFinished