Jumpvalley 0.5.0
An app and library that can be used to test and run 3D platformer levels. Currently being made with Godot.
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
Jumpvalley.Audio.AudioStreamReader Class Reference

Loads a file that's either imported as a resource (at one point or another) or somewhere on the filesystem. More...

Public Member Functions

 AudioStreamReader (string filePath)
 Creates a new AudioStreamReader for the specified file path.
 

Public Attributes

readonly string RESOURCE_PATH_ROOT = "res://"
 
readonly string FILE_NOT_FOUND_ERR = "No file could be found at the given file path. Please double check that the file path is correct."
 
readonly string INVALID_DATA_ERR = "The data format of the file is invalid. Please check that the audio's file format is either WAV, OGG, or MP3."
 
AudioStream Stream
 The result from reading the stream.
 
string FilePath
 The file path of the file that the data comes from.
 

Detailed Description

Loads a file that's either imported as a resource (at one point or another) or somewhere on the filesystem.

Constructor & Destructor Documentation

◆ AudioStreamReader()

Jumpvalley.Audio.AudioStreamReader.AudioStreamReader ( string filePath)
inline

Creates a new AudioStreamReader for the specified file path.

Parameters
filePathThe file path to the audio file
Exceptions
FileNotFoundExceptionThrown when the file path is invalid, or when no file could be found for the given file path.
InvalidDataExceptionThrown when the file was found for the given file path, but the file format is invalid.

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