Leviathan::AudioSource Class Reference

Small ReferenceCounted wrapper around an audio source. More...

#include <AudioSource.h>

Inheritance diagram for Leviathan::AudioSource:

Public Member Functions
DLLEXPORT	~AudioSource ()
DLLEXPORT bool	HasInternalSource () const
DLLEXPORT void	Play2D (const Sound::AudioBuffer::pointer &buffer)
DLLEXPORT void	PlayWithDecoder (const Sound::ProceduralSoundData::pointer &data, size_t chunksize=12000, size_t chunkstoqueue=4)
DLLEXPORT void	Resume ()
DLLEXPORT void	Stop ()
DLLEXPORT void	Pause ()
DLLEXPORT bool	IsPlaying () const
	Also returns true if the source will start playing once a buffer is loaded. More...
DLLEXPORT void	SetVolume (float volume)
DLLEXPORT void	SetGain (float gain)
DLLEXPORT void	SetLooping (bool looping)
	REFERENCE_COUNTED_PTR_TYPE (AudioSource)
Public Member Functions inherited from Leviathan::GUI::JSProxyable
	JSProxyable (int id=IDFactory::GetID())
virtual	~JSProxyable ()
int	GetID () const
Public Member Functions inherited from Leviathan::ReferenceCounted
	ReferenceCounted (const ReferenceCounted &other)=delete
ReferenceCounted &	operator= (const ReferenceCounted &other)=delete
FORCE_INLINE void	AddRef () const
FORCE_INLINE void	Release () const
	removes a reference and deletes the object if reference count reaches zero More...
FORCE_INLINE void	AddRef ()
FORCE_INLINE void	Release ()
int32_t	GetRefCount () const
	Returns the reference count. More...

Protected Member Functions
DLLEXPORT	AudioSource (alure::Source sourcetowrap)
Protected Member Functions inherited from Leviathan::ReferenceCounted
DLLEXPORT	ReferenceCounted ()
virtual DLLEXPORT	~ReferenceCounted ()

Protected Attributes
friend	ReferenceCounted
Protected Attributes inherited from Leviathan::GUI::JSProxyable
const int	ID

Additional Inherited Members
Public Types inherited from Leviathan::GUI::JSProxyable
using	pointer = boost::intrusive_ptr< JSProxyable >
Public Types inherited from Leviathan::ReferenceCounted
using	basepointer = boost::intrusive_ptr< ReferenceCounted >
using	refcountedpointer = boost::intrusive_ptr< ReferenceCounted >
Static Public Member Functions inherited from Leviathan::ReferenceCounted
template<class ActualType >
static boost::intrusive_ptr< ActualType >	WrapPtr (ActualType *ptr)
	Creates an intrusive_ptr from raw pointer. More...
template<class ActualType , class... Args>
static boost::intrusive_ptr< ActualType >	MakeShared (Args &&... args)
	Constructs a new instance and wraps it. More...

Detailed Description

Small ReferenceCounted wrapper around an audio source.

Definition at line 16 of file AudioSource.h.

Constructor & Destructor Documentation

AudioSource()

DLLEXPORT AudioSource::AudioSource ( alure::Source  sourcetowrap )

protected

Definition at line 8 of file AudioSource.cpp.

: Source(sourcetowrap) {}

~AudioSource()

DLLEXPORT AudioSource::~AudioSource

(

)

Definition at line 10 of file AudioSource.cpp.

{
    if(Source) {

        if(Engine::Get()->IsOnMainThread()) {

            Source.destroy();

        } else {
            Engine::Get()->Invoke([source = Source]() mutable { source.destroy(); });
        }

        Source = nullptr;
    }

    PlayedBuffer.reset();
}

Member Function Documentation

HasInternalSource()

DLLEXPORT bool Leviathan::AudioSource::HasInternalSource ( ) const

inline

Definition at line 32 of file AudioSource.h.

    {
        // Returns true if the source has the impl pointer set
        return Source.operator bool();
    }

IsPlaying()

DLLEXPORT bool Leviathan::AudioSource::IsPlaying ( ) const

inline

Also returns true if the source will start playing once a buffer is loaded.

Definition at line 59 of file AudioSource.h.

    {
        return Source.isPlayingOrPending();
    }

Pause()

DLLEXPORT void Leviathan::AudioSource::Pause ( )

inline

Definition at line 53 of file AudioSource.h.

    {
        Source.pause();
    }

Play2D()

DLLEXPORT void AudioSource::Play2D

(

const Sound::AudioBuffer::pointer &

buffer

)

Definition at line 28 of file AudioSource.cpp.

{
    Engine::Get()->AssertIfNotMainThread();

    PlayedBuffer = buffer;

    if(PlayedBuffer && PlayedBuffer->GetBuffer()) {

        Source.set3DSpatialize(alure::Spatialize::Off);
        Source.play(PlayedBuffer->GetBuffer());

    } else {
        Source.stop();
    }
}

PlayWithDecoder()

DLLEXPORT void AudioSource::PlayWithDecoder	(	const Sound::ProceduralSoundData::pointer &	data,
		size_t	chunksize = 12000,
		size_t	chunkstoqueue = 4
	)

Definition at line 44 of file AudioSource.cpp.

{
    Engine::Get()->AssertIfNotMainThread();

    PlayedBuffer.reset();

    if(data) {

        Source.play(data, chunksize, chunkstoqueue);

    } else {
        Source.stop();
    }
}

REFERENCE_COUNTED_PTR_TYPE()

Leviathan::AudioSource::REFERENCE_COUNTED_PTR_TYPE

(

AudioSource

)

Resume()

DLLEXPORT void Leviathan::AudioSource::Resume ( )

inline

Definition at line 43 of file AudioSource.h.

    {
        Source.resume();
    }

SetGain()

DLLEXPORT void Leviathan::AudioSource::SetGain ( float  gain )

inline

Definition at line 70 of file AudioSource.h.

    {
        Source.setGain(gain);
    }

SetLooping()

DLLEXPORT void Leviathan::AudioSource::SetLooping ( bool  looping )

inline

Definition at line 75 of file AudioSource.h.

    {
        Source.setLooping(looping);
    }

SetVolume()

DLLEXPORT void Leviathan::AudioSource::SetVolume ( float  volume )

inline

Parameters

volume

0-1.f is normal range

Definition at line 65 of file AudioSource.h.

    {
        Source.setGain(volume);
    }

Stop()

DLLEXPORT void Leviathan::AudioSource::Stop ( )

inline

Definition at line 48 of file AudioSource.h.

    {
        Source.stop();
    }

Member Data Documentation

ReferenceCounted

friend Leviathan::AudioSource::ReferenceCounted

protected

Definition at line 20 of file AudioSource.h.

---

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

• AudioSource.h
• AudioSource.cpp