Dali 3D User Interface Engine
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
Dali::Internal::Adaptor::SoundPlayer Class Reference

Plays haptic effects. More...

#include <sound-player-impl.h>

Inheritance diagram for Dali::Internal::Adaptor::SoundPlayer:
Inheritance graph
[legend]
Collaboration diagram for Dali::Internal::Adaptor::SoundPlayer:
Collaboration graph
[legend]

Public Types

typedef
Dali::SoundPlayer::SoundPlayFinishedSignalType 
SoundPlayFinishedSignalType
 

Public Member Functions

int PlaySound (const std::string fileName)
  More...
 
void Stop (int handle)
  More...
 
SoundPlayFinishedSignalTypeSoundPlayFinishedSignal ()
  More...
 
- Public Member Functions inherited from Dali::BaseObject
template<class T >
bool ConnectSignal (ConnectionTrackerInterface *connectionTracker, const std::string &signalName, const T &functor)
 Connects a void() functor to a specified signal. More...
 
bool DoAction (const std::string &actionName, const Property::Map &attributes)
 Perform action on this object with the given action name and attributes. More...
 
const std::string & GetTypeName () const
 Returns the type name for the Handle. More...
 
bool GetTypeInfo (Dali::TypeInfo &info) const
 Returns the type info for the Handle. More...
 
bool DoConnectSignal (ConnectionTrackerInterface *connectionTracker, const std::string &signalName, FunctorDelegate *functorDelegate)
 Not intended for application developers. More...
 
- Public Member Functions inherited from Dali::RefObject
void Reference ()
 Increment the object's reference count. More...
 
void Unreference ()
 Decrement the object's reference count. More...
 
int ReferenceCount ()
 Retrieve the object's reference count. More...
 

Static Public Member Functions

static Dali::SoundPlayer New ()
 Create a SoundPlayer. More...
 
static Dali::SoundPlayer Get ()
 Retrieve a handle to the SoundPlayer. More...
 
static bool DoConnectSignal (BaseObject *object, ConnectionTrackerInterface *tracker, const std::string &signalName, FunctorDelegate *functor)
 Connects a callback function with the object's signals. More...
 

Private Member Functions

 SoundPlayer ()
 Private Constructor; see also soundPlayer::New() More...
 
virtual ~SoundPlayer ()
 Destructor. More...
 
void EmitSoundPlayFinishedSignal ()
 Emits the SoundPlayFinished signal. More...
 
 SoundPlayer (const SoundPlayer &)
 
SoundPlayeroperator= (SoundPlayer &)
 

Private Attributes

FeedbackPluginProxy mPlugin
 
SoundPlayFinishedSignalType mSoundPlayFinishedSignal
 

Additional Inherited Members

- Protected Member Functions inherited from Dali::BaseObject
 BaseObject ()
 Default constructor. More...
 
virtual ~BaseObject ()
 A reference counted object may only be deleted by calling Unreference(). More...
 
void RegisterObject ()
 Registers the object as created with the Object registry. More...
 
void UnregisterObject ()
 Unregisters the object from Object registry. More...
 

Detailed Description

Plays haptic effects.

Definition at line 41 of file sound-player-impl.h.

Member Typedef Documentation

typedef Dali::SoundPlayer::SoundPlayFinishedSignalType Dali::Internal::Adaptor::SoundPlayer::SoundPlayFinishedSignalType

Definition at line 46 of file sound-player-impl.h.

Constructor & Destructor Documentation

Dali::Internal::Adaptor::SoundPlayer::SoundPlayer ( )
private

Private Constructor; see also soundPlayer::New()

Parameters
[in]soundPlayerThe public sound player class

Definition at line 116 of file sound-player-impl.cpp.

Referenced by New().

Here is the caller graph for this function:

Dali::Internal::Adaptor::SoundPlayer::~SoundPlayer ( )
privatevirtual

Destructor.

Definition at line 121 of file sound-player-impl.cpp.

Dali::Internal::Adaptor::SoundPlayer::SoundPlayer ( const SoundPlayer )
private

Member Function Documentation

bool Dali::Internal::Adaptor::SoundPlayer::DoConnectSignal ( BaseObject object,
ConnectionTrackerInterface tracker,
const std::string &  signalName,
FunctorDelegate functor 
)
static

Connects a callback function with the object's signals.

Parameters
[in]objectThe object providing the signal.
[in]trackerUsed to disconnect the signal.
[in]signalNameThe signal to connect to.
[in]functorA newly allocated FunctorDelegate.
Returns
True if the signal was connected.
Postcondition
If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.

Definition at line 98 of file sound-player-impl.cpp.

References SoundPlayFinishedSignal().

Here is the call graph for this function:

void Dali::Internal::Adaptor::SoundPlayer::EmitSoundPlayFinishedSignal ( )
private

Emits the SoundPlayFinished signal.

Definition at line 125 of file sound-player-impl.cpp.

References mSoundPlayFinishedSignal.

Dali::SoundPlayer Dali::Internal::Adaptor::SoundPlayer::Get ( )
static

Retrieve a handle to the SoundPlayer.

This creates an instance if none has been created.

Returns
A handle to the SoundPlayer.

Definition at line 59 of file sound-player-impl.cpp.

References Dali::Internal::Adaptor::SingletonService::Get(), Dali::BaseHandle::GetObjectPtr(), Dali::SingletonService::GetSingleton(), New(), and Dali::SingletonService::Register().

Referenced by Dali::Internal::Adaptor::anonymous_namespace{sound-player-impl.cpp}::GetInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

Dali::SoundPlayer Dali::Internal::Adaptor::SoundPlayer::New ( )
static

Create a SoundPlayer.

Returns
A newly created SoundPlayer.

Definition at line 53 of file sound-player-impl.cpp.

References SoundPlayer().

Referenced by Get().

Here is the call graph for this function:

Here is the caller graph for this function:

SoundPlayer& Dali::Internal::Adaptor::SoundPlayer::operator= ( SoundPlayer )
private
int Dali::Internal::Adaptor::SoundPlayer::PlaySound ( const std::string  fileName)

Definition at line 83 of file sound-player-impl.cpp.

References mPlugin, and Dali::Internal::Adaptor::FeedbackPluginProxy::PlaySound().

Here is the call graph for this function:

SoundPlayer::SoundPlayFinishedSignalType & Dali::Internal::Adaptor::SoundPlayer::SoundPlayFinishedSignal ( )

Definition at line 93 of file sound-player-impl.cpp.

References mSoundPlayFinishedSignal.

Referenced by DoConnectSignal().

Here is the caller graph for this function:

void Dali::Internal::Adaptor::SoundPlayer::Stop ( int  handle)

Definition at line 88 of file sound-player-impl.cpp.

References mPlugin, and Dali::Internal::Adaptor::FeedbackPluginProxy::StopSound().

Here is the call graph for this function:

Member Data Documentation

FeedbackPluginProxy Dali::Internal::Adaptor::SoundPlayer::mPlugin
private

Definition at line 112 of file sound-player-impl.h.

Referenced by PlaySound(), and Stop().

SoundPlayFinishedSignalType Dali::Internal::Adaptor::SoundPlayer::mSoundPlayFinishedSignal
private

Definition at line 113 of file sound-player-impl.h.

Referenced by EmitSoundPlayFinishedSignal(), and SoundPlayFinishedSignal().


The documentation for this class was generated from the following files:
Dali Docs Home
Read more about Dali