UOperatingSystemAudioFile
#include <OperatingSystemSimulator/Public/Files/OperatingSystemAudioFile.h>class UOperatingSystemAudioFileDefined in OperatingSystemAudioFile.h:18
Inherits:
UOperatingSystemFile
Inheritance diagram
Section titled “Inheritance diagram”---
config:
class:
hideEmptyMembersBox: true
---
classDiagram
class UOperatingSystemAudioFile["UOperatingSystemAudioFile"]
class UOperatingSystemFile["UOperatingSystemFile"]
UOperatingSystemFile <|-- UOperatingSystemAudioFile
Class detail
Section titled “Class detail”---
config:
class:
hideEmptyMembersBox: true
---
classDiagram
class UOperatingSystemAudioFile {
+UOperatingSystemAudioFile()
+GetAudio() const USoundBase *
+AudioFile : TSoftObjectPtr< USoundBase >
+OnValidate(FGenericError &OutError) override
}
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.
Public Methods
Section titled “Public Methods”| Return | Name | Description |
|---|---|---|
UOperatingSystemAudioFile | ||
USoundBase * | GetAudio const | Retrieves the audio data represented by the audio file. |
UOperatingSystemAudioFile
Section titled “UOperatingSystemAudioFile”UOperatingSystemAudioFile()Defined in OperatingSystemAudioFile.h:30
References
Section titled “References”GetAudio
Section titled “GetAudio”const
USoundBase * GetAudio() constDefined in OperatingSystemAudioFile.h:39 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
Section titled “Returns”A pointer to the USoundBase object that represents the audio data.
References
Section titled “References”Protected Attributes
Section titled “Protected Attributes”| Return | Name | Description |
|---|---|---|
TSoftObjectPtr< USoundBase > | AudioFile | Audio to play. |
AudioFile
Section titled “AudioFile”TSoftObjectPtr< USoundBase > AudioFileDefined in OperatingSystemAudioFile.h:26 Audio to play.
Referenced by
Section titled “Referenced by”Protected Methods
Section titled “Protected Methods”| Return | Name | Description |
|---|---|---|
void | OnValidate virtual override | Validates the audio file. |
OnValidate
Section titled “OnValidate”virtual override
virtual void OnValidate(FGenericError & OutError) overrideDefined in OperatingSystemAudioFile.h:50 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
Section titled “Parameters”OutErrorThe error object to set if the audio file is null.
See also: FGenericError
References
Section titled “References”AudioFileGetFileNameMAKE_ERROR