Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
sound_play::SoundClient::Sound Class Reference

#include <sound_play.h>

Public Member Functions

void play ()
 Play the Sound. More...
 
void repeat ()
 Play the Sound repeatedly. More...
 
void stop ()
 Stop Sound playback. More...
 

Private Member Functions

 Sound (SoundClient *sc, int snd, const std::string &arg, const std::string arg2=std::string(), const float vol=1.0f)
 

Private Attributes

std::string arg2_
 
std::string arg_
 
SoundClientclient_
 
int snd_
 
float vol_
 

Friends

class SoundClient
 

Detailed Description

Definition at line 64 of file sound_play.h.

Constructor & Destructor Documentation

◆ Sound()

sound_play::SoundClient::Sound::Sound ( SoundClient sc,
int  snd,
const std::string &  arg,
const std::string  arg2 = std::string(),
const float  vol = 1.0f 
)
inlineprivate

Definition at line 74 of file sound_play.h.

Member Function Documentation

◆ play()

void sound_play::SoundClient::Sound::play ( )
inline

Play the Sound.

This method causes the Sound to be played once.

Definition at line 88 of file sound_play.h.

◆ repeat()

void sound_play::SoundClient::Sound::repeat ( )
inline

Play the Sound repeatedly.

This method causes the Sound to be played repeatedly until stop() is called.

Definition at line 98 of file sound_play.h.

◆ stop()

void sound_play::SoundClient::Sound::stop ( )
inline

Stop Sound playback.

This method causes the Sound to stop playing.

Definition at line 107 of file sound_play.h.

Friends And Related Function Documentation

◆ SoundClient

friend class SoundClient
friend

Definition at line 66 of file sound_play.h.

Member Data Documentation

◆ arg2_

std::string sound_play::SoundClient::Sound::arg2_
private

Definition at line 71 of file sound_play.h.

◆ arg_

std::string sound_play::SoundClient::Sound::arg_
private

Definition at line 70 of file sound_play.h.

◆ client_

SoundClient* sound_play::SoundClient::Sound::client_
private

Definition at line 72 of file sound_play.h.

◆ snd_

int sound_play::SoundClient::Sound::snd_
private

Definition at line 68 of file sound_play.h.

◆ vol_

float sound_play::SoundClient::Sound::vol_
private

Definition at line 69 of file sound_play.h.


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


sound_play
Author(s): Blaise Gassend
autogenerated on Wed Mar 27 2019 02:46:31