Leviathan::AudioSource Class Reference

Small ReferenceCounted wrapper around a sound stream. More...

#include <AudioSource.h>

Inheritance diagram for Leviathan::AudioSource:

Public Member Functions
DLLEXPORT	~AudioSource ()
DLLEXPORT cAudio::IAudioSource *	Get ()
DLLEXPORT bool	HasInternalSource () const
DLLEXPORT bool	Play2D ()
DLLEXPORT void	Stop ()
DLLEXPORT void	Pause ()
DLLEXPORT bool	IsPlaying () const
DLLEXPORT void	SetVolume (float volume)
	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 ()
FORCE_INLINE void	Release ()
	removes a reference and deletes the object if reference count reaches zero More...
int32_t	GetRefCount () const
	Returns the reference count. More...

Protected Member Functions
DLLEXPORT	AudioSource (cAudio::IAudioSource *sourcetowrap, SoundDevice *owner)
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 a sound stream.

Definition at line 20 of file AudioSource.h.

Constructor & Destructor Documentation

AudioSource()

DLLEXPORT AudioSource::AudioSource ( cAudio::IAudioSource *  sourcetowrap, SoundDevice *  owner  )

protected

Definition at line 9 of file AudioSource.cpp.

                                                                                       :
    Source(sourcetowrap), Owner(owner)
{

    LEVIATHAN_ASSERT(Owner, "AudioSource must be associated with a SoundDevice");
}

~AudioSource()

DLLEXPORT AudioSource::~AudioSource

(

)

Definition at line 16 of file AudioSource.cpp.

{
    // TODO: should this invoke if not called on the main thread
    if(Source) {

        auto manager = Owner->GetAudioManager();
        if(manager)
            manager->release(Source);
    }
}

Member Function Documentation

Get()

DLLEXPORT cAudio::IAudioSource* Leviathan::AudioSource::Get ( )

inline

Definition at line 31 of file AudioSource.h.

    {
        return Source;
    }

HasInternalSource()

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

inline

Definition at line 36 of file AudioSource.h.

    {
        return Source != nullptr;
    }

IsPlaying()

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

inline

Definition at line 62 of file AudioSource.h.

    {
        if(Source)
            return Source->isPlaying();
        return false;
    }

Pause()

DLLEXPORT void Leviathan::AudioSource::Pause ( )

inline

Definition at line 56 of file AudioSource.h.

    {
        if(Source)
            Source->pause();
    }

Play2D()

DLLEXPORT bool Leviathan::AudioSource::Play2D ( )

inline

Definition at line 43 of file AudioSource.h.

    {
        if(Source)
            return Source->play2d();
        return false;
    }

REFERENCE_COUNTED_PTR_TYPE()

Leviathan::AudioSource::REFERENCE_COUNTED_PTR_TYPE

(

AudioSource

)

SetVolume()

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

inline

Parameters

volume

0-1.f is normal range

Definition at line 70 of file AudioSource.h.

    {
        if(Source)
            Source->setVolume(volume);
    }

Stop()

DLLEXPORT void Leviathan::AudioSource::Stop ( )

inline

Definition at line 50 of file AudioSource.h.

    {
        if(Source)
            Source->stop();
    }

Member Data Documentation

ReferenceCounted

friend Leviathan::AudioSource::ReferenceCounted

protected

Definition at line 24 of file AudioSource.h.

---

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

• AudioSource.h
• AudioSource.cpp