SFileWaveformPlayerI Class Reference

Simple audio file playback. More...

#include <bsapi.h>

Inheritance diagram for SFileWaveformPlayerI:

List of all members.

Public Member Functions
virtual bool BSAPI_METHOD	SetFormat (SWaveformSourceCallbackI::wave_format_type waveformFormat, int sampleFreq, int nChannels)=0
	Set format of input audio file.
virtual bool BSAPI_METHOD	SetFormatStr (const char *pWaveformFormat, int sampleFreq, int nChannels)=0
	Set format of input audio file.
virtual bool BSAPI_METHOD	Play (char *pFile, bool wait=false)=0
	Start audio file playback.
virtual bool BSAPI_METHOD	PlayOrUnpause (char *pFile)=0
	Start or unpause audio file playback.
virtual void BSAPI_METHOD	Pause (bool pause=true)=0
	Pause or unpause audio file playback.
virtual void BSAPI_METHOD	PauseOrUnpause ()=0
	Pause or unpause audio file playback.
virtual void BSAPI_METHOD	Stop ()=0
	Stop audio file playback.

---

Detailed Description

Simple audio file playback.

---

Member Function Documentation

virtual void BSAPI_METHOD SFileWaveformPlayerI::Pause

(

bool

pause = true

)

[pure virtual]

Pause or unpause audio file playback.

Parameters:

pause

- true pause playback false unpause playback

virtual void BSAPI_METHOD SFileWaveformPlayerI::PauseOrUnpause

(

)

[pure virtual]

Pause or unpause audio file playback.

Pauses playback if it is playing or unpauses playback if it is paused.

virtual bool BSAPI_METHOD SFileWaveformPlayerI::Play	(	char *	pFile,
		bool	wait = false
	)			[pure virtual]

Start audio file playback.

Parameters:

	pFile	file name
	wait	- true block until the file is played false return immediately after playback is started

Returns:

true playback was started correctly

virtual bool BSAPI_METHOD SFileWaveformPlayerI::PlayOrUnpause

(

char *

pFile

)

[pure virtual]

Start or unpause audio file playback.

Unpauses playback if it is paused and the file name passed is same as the one passed initially. Otherwise playback is started from begin.

Parameters:

pFile

file name

Returns:

true playback was started or unpaused correctly

virtual bool BSAPI_METHOD SFileWaveformPlayerI::SetFormat	(	SWaveformSourceCallbackI::wave_format_type	waveformFormat,
		int	sampleFreq,
		int	nChannels
	)			[pure virtual]

Set format of input audio file.

Parameters:

	waveformFormat	waveform format
	sampleFreq	sampling frequency in Hz
	nChannels	number of channels

Returns:

true format was set correctly

virtual bool BSAPI_METHOD SFileWaveformPlayerI::SetFormatStr	(	const char *	pWaveformFormat,
		int	sampleFreq,
		int	nChannels
	)			[pure virtual]

Set format of input audio file.

Parameters:

	pWaveformFormat	waveform format
	sampleFreq	sampling frequency in Hz
	nChannels	number of channels

Returns:

true format was set correctly

---

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

• bsapi.h

---