Operating System Simulator Plugin  3.5.1
Unreal Engine plugin that simulates an Operating System Environment
Loading...
Searching...
No Matches
UOperatingSystemAudioFile Class Reference

#include "OperatingSystemAudioFile.h"

Inheritance diagram for UOperatingSystemAudioFile:
[legend]
Collaboration diagram for UOperatingSystemAudioFile:
[legend]

Public Member Functions

 UOperatingSystemAudioFile ()
 
USoundBase * GetAudio () const
 Retrieves the audio data represented by the audio file.
 
- Public Member Functions inherited from UOperatingSystemFile
 UOperatingSystemFile ()
 
void OpenFile (FGenericError &OutError)
 
void CloseFile ()
 Closes the file and cleans up any associated resources.
 
FText GetFileName (const bool bWithExtension=true) const
 
FText GetExtension () const
 
bool IsSameFile (const UOperatingSystemFile *OtherFile) const
 
FORCEINLINE TSoftObjectPtr< UObject > GetIconObject () const
 
FORCEINLINE TScriptInterface< IOperatingSystemExplorerInterfaceGetExplorerInterface () const
 This method returns the TScriptInterface of the IOperatingSystemExplorer.
 

Protected Member Functions

virtual void OnValidate (FGenericError &OutError) override
 Validates the audio file.
 
- Protected Member Functions inherited from UOperatingSystemFile
UOperatingSystemFileIconWidgetCreateIconWidget ()
 
void K2_OnOpen ()
 

Protected Attributes

TSoftObjectPtr< USoundBase > AudioFile
 
- Protected Attributes inherited from UOperatingSystemFile
FText Name
 
FText Extension
 
TSoftObjectPtr< UObject > IconObject
 
float SpaceRequiredInMB
 
uint8 bIsDeletable: 1
 
uint8 bIsMovable: 1
 
TSoftClassPtr< UOperatingSystemBaseProgramTargetProgramClass
 
TSoftClassPtr< UOperatingSystemFileIconWidgetIconWidgetClass
 
TSoftClassPtr< UOperatingSystemFileWidgetWidgetClass
 
TWeakObjectPtr< UOperatingSystemBaseProgramParentProgram
 
TObjectPtr< UOperatingSystemFileWidgetFileWidget
 
TScriptInterface< IOperatingSystemExplorerInterfaceParentExplorerInterface
 
bool bHasBlueprintOnOpen
 

Additional Inherited Members

- Static Public Member Functions inherited from UOperatingSystemFile
static UOperatingSystemFileCreateFile (TScriptInterface< IOperatingSystemExplorerInterface > ExplorerInterface, const TSoftClassPtr< UOperatingSystemFile > &FileSoftClass, FGenericError &OutError)
 Creates a new file in the operating system.
 
static UOperatingSystemFileCreateRuntimeFile (UOperatingSystemFile *ParentFile)
 Creates a runtime file based on the given parent file.
 

Detailed Description

This class represents an audio file in the operating system. It is a child class of UOperatingSystemFile. It provides functionality to retrieve audio data represented by the file.

Constructor & Destructor Documentation

◆ UOperatingSystemAudioFile()

UOperatingSystemAudioFile::UOperatingSystemAudioFile ( )

Member Function Documentation

◆ GetAudio()

USoundBase * UOperatingSystemAudioFile::GetAudio ( ) const

Retrieves the audio data represented by the audio file.

This method returns a pointer to the USoundBase object that represents the audio data of the audio file.

Returns
A pointer to the USoundBase object that represents the audio data.

◆ OnValidate()

void UOperatingSystemAudioFile::OnValidate ( FGenericError & OutError)
overrideprotectedvirtual

Validates the audio file.

This method is called to validate the audio file. It checks if the audio file is null and sets an error if it is.

Parameters
OutErrorThe error object to set if the audio file is null.
See also
FGenericError

Reimplemented from UOperatingSystemFile.

Here is the call graph for this function:

Member Data Documentation

◆ AudioFile

TSoftObjectPtr<USoundBase> UOperatingSystemAudioFile::AudioFile
protected

Audio to play.


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