#include <ISoundControl.h>

Inheritance diagram for xl7::directsound::ISoundControl:

Public Types
enum	PlayFlags { None = 0, Restart = 1, Continue = 2, Loop = 4 }
Public Member Functions
virtual bool	IsPlaying () const =0
virtual unsigned	GetCurrentPosition () const =0
virtual bool	SetCurrentPosition (unsigned position)=0
virtual float	GetVolume () const =0
virtual bool	SetVolume (float volume)=0
virtual bool	Play (PlayFlags play_flags=Restart)=0
virtual bool	Pause ()=0
virtual bool	Stop ()=0

Detailed Description

The sound control interface to play, pause and stop the sound buffer as well as to set and get specific sound settings.

Member Enumeration Documentation

Enumerator:

virtual unsigned xl7::directsound::ISoundControl::GetCurrentPosition ( ) const [pure virtual]

Returns the current position, in bytes, within the sound buffer.

virtual float xl7::directsound::ISoundControl::GetVolume ( ) const [pure virtual]

Returns the volume, from 0 (silence) to 1 ("full throttle").

virtual bool xl7::directsound::ISoundControl::IsPlaying ( ) const [pure virtual]

Returns true, if the sound is currently playing.

virtual bool xl7::directsound::ISoundControl::Pause ( ) [pure virtual]

Causes the sound buffer to stop playing (retaining the current position).

virtual bool xl7::directsound::ISoundControl::Play ( PlayFlags play_flags = Restart ) [pure virtual]

Causes the sound buffer to play.

virtual bool xl7::directsound::ISoundControl::SetCurrentPosition ( unsigned position ) [pure virtual]

Seeks to the given position, in bytes, within the sound buffer.

virtual bool xl7::directsound::ISoundControl::SetVolume ( float volume ) [pure virtual]

Sets the volume, from 0 (silence) to 1 ("full throttle").

virtual bool xl7::directsound::ISoundControl::Stop ( ) [pure virtual]

Causes the sound buffer to stop playing (resetting the current position).

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