s3d::AudioAssetData Struct Reference

#include <AudioAssetData.hpp>

Inherits s3d::IAsset.

Public Member Functions
SIV3D_NODISCARD_CXX20	AudioAssetData ()
SIV3D_NODISCARD_CXX20	AudioAssetData (FilePathView _path, const Optional< AudioLoopTiming > &_loopTiming, const Array< AssetTag > &tags={})
SIV3D_NODISCARD_CXX20	AudioAssetData (Audio::FileStreaming, FilePathView _path, const Array< AssetTag > &tags={})
SIV3D_NODISCARD_CXX20	AudioAssetData (Audio::FileStreaming, FilePathView _path, Arg::loopBegin_< uint64 > _loopBegin, const Array< AssetTag > &tags={})
SIV3D_NODISCARD_CXX20	AudioAssetData (GMInstrument instrument, uint8 key, const Duration &noteOn, const Duration &noteOff, double velocity, Arg::sampleRate_< uint32 > sampleRate, const Array< AssetTag > &tags={})
bool	load (const String &hint) override
void	loadAsync (const String &hint) override
void	wait () override
void	release () override
Public Member Functions inherited from s3d::IAsset
	IAsset ()
	IAsset (const Array< String > &tags)
virtual	~IAsset ()
AssetState	getState () const
const Array< AssetTag > &	getTags () const
bool	isAsyncLoading () const
bool	isFinished () const

Static Public Member Functions
static bool	DefaultLoad (AudioAssetData &asset, const String &hint)
static void	DefaultRelease (AudioAssetData &asset)

Public Attributes
FilePath	path
Optional< AudioLoopTiming >	loopTiming
bool	streaming = false
GMInstrument	instrument = GMInstrument::Piano1
uint8	key = 0
Duration	noteOn { 0.0 }
Duration	noteOff { 0.0 }
double	velocity = 1.0
uint32	sampleRate = Wave::DefaultSampleRate
Audio	audio
std::function< bool(AudioAssetData &, const String &)>	onLoad = DefaultLoad
std::function< void(AudioAssetData &)>	onRelease = DefaultRelease

Additional Inherited Members
Protected Member Functions inherited from s3d::IAsset
bool	isUninitialized () const
bool	isLoaded () const
void	setState (AssetState state)

Constructor & Destructor Documentation

AudioAssetData() [1/5]

SIV3D_NODISCARD_CXX20 s3d::AudioAssetData::AudioAssetData

(

)

AudioAssetData() [2/5]

SIV3D_NODISCARD_CXX20 s3d::AudioAssetData::AudioAssetData	(	FilePathView	_path,
		const Optional< AudioLoopTiming > &	_loopTiming,
		const Array< AssetTag > &	tags = {}
	)

AudioAssetData() [3/5]

SIV3D_NODISCARD_CXX20 s3d::AudioAssetData::AudioAssetData	(	Audio::FileStreaming	,
		FilePathView	_path,
		const Array< AssetTag > &	tags = {}
	)

AudioAssetData() [4/5]

SIV3D_NODISCARD_CXX20 s3d::AudioAssetData::AudioAssetData	(	Audio::FileStreaming	,
		FilePathView	_path,
		Arg::loopBegin_< uint64 >	_loopBegin,
		const Array< AssetTag > &	tags = {}
	)

AudioAssetData() [5/5]

SIV3D_NODISCARD_CXX20 s3d::AudioAssetData::AudioAssetData	(	GMInstrument	instrument,
		uint8	key,
		const Duration &	noteOn,
		const Duration &	noteOff,
		double	velocity,
		Arg::sampleRate_< uint32 >	sampleRate,
		const Array< AssetTag > &	tags = {}
	)

Member Function Documentation

DefaultLoad()

static bool s3d::AudioAssetData::DefaultLoad ( AudioAssetData &  asset, const String &  hint  )

static

DefaultRelease()

static void s3d::AudioAssetData::DefaultRelease ( AudioAssetData &  asset )

static

load()

bool s3d::AudioAssetData::load ( const String &  hint )

overridevirtual

Implements s3d::IAsset.

loadAsync()

void s3d::AudioAssetData::loadAsync ( const String &  hint )

overridevirtual

Implements s3d::IAsset.

release()

void s3d::AudioAssetData::release ( )

overridevirtual

Implements s3d::IAsset.

wait()

void s3d::AudioAssetData::wait ( )

overridevirtual

Implements s3d::IAsset.

Member Data Documentation

audio

Audio s3d::AudioAssetData::audio

instrument

GMInstrument s3d::AudioAssetData::instrument = GMInstrument::Piano1

key

uint8 s3d::AudioAssetData::key = 0

loopTiming

Optional<AudioLoopTiming> s3d::AudioAssetData::loopTiming

noteOff

Duration s3d::AudioAssetData::noteOff { 0.0 }

noteOn

Duration s3d::AudioAssetData::noteOn { 0.0 }

onLoad

std::function<bool(AudioAssetData&, const String&)> s3d::AudioAssetData::onLoad = DefaultLoad

onRelease

std::function<void(AudioAssetData&)> s3d::AudioAssetData::onRelease = DefaultRelease

path

FilePath s3d::AudioAssetData::path

sampleRate

uint32 s3d::AudioAssetData::sampleRate = Wave::DefaultSampleRate

streaming

bool s3d::AudioAssetData::streaming = false

velocity

double s3d::AudioAssetData::velocity = 1.0

---

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

• OpenSiv3D/Siv3D/include/Siv3D/AudioAssetData.hpp