CeresEngine::Play Struct Reference

An entity action that can be dispatched to a AudioSource to start playing a new audio buffer. More...

#include <CeresEngine/Audio/AudioSource.hpp>

Inheritance diagram for CeresEngine::Play:

Public Member Functions
	Play (AudioAPIBufferPtr buffer)
	Creates a new Play action.

Public Attributes
AudioAPIBufferPtr	buffer
	The buffer to be played by the audio source.

Additional Inherited Members
Public Types inherited from CeresEngine::EntityAction< Play >
using	ReturnType = void
	The type that must be returned by action handlers.
Static Public Attributes inherited from CeresEngine::EntityAction< Play >
static const EntityActionID	actionID
	This action type ID.

Detailed Description

An entity action that can be dispatched to a AudioSource to start playing a new audio buffer.

Constructor & Destructor Documentation

Play()

CeresEngine::Play::Play ( AudioAPIBufferPtr  buffer )

inlineexplicit

Creates a new Play action.

Parameters

buffer

The buffer to be played.

Member Data Documentation

buffer

AudioAPIBufferPtr CeresEngine::Play::buffer

The buffer to be played by the audio source.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Audio/AudioSource.hpp