Programming Reference:WavePlayer Class - Revision history

JoshGoldberg: /* Remarks */

2013-08-20T13:55:05Z

Remarks

← Older revision		Revision as of 13:55, 20 August 2013
Line 20:		Line 20:
	==Remarks==		==Remarks==
	Copying or assigning <tt>WavePlayer</tt> instances may require re-loading audio data into memory. Write operations to STL containers may imply copying of a contained object, followed by destruction of the original object after copying. Consequently, manipulations to STL containers that contain <tt>WavePlayer</tt> objects are not advisable during playback from one or more of its contained objects, or in time-critical situations. Typically, one would set up such containers at initialization time, and perform only read operations on containers during playback.		Copying or assigning <tt>WavePlayer</tt> instances may require re-loading audio data into memory. Write operations to STL containers may imply copying of a contained object, followed by destruction of the original object after copying. Consequently, manipulations to STL containers that contain <tt>WavePlayer</tt> objects are not advisable during playback from one or more of its contained objects, or in time-critical situations. Typically, one would set up such containers at initialization time, and perform only read operations on containers during playback.

	~~include "application\audio\WavePlayer.h"~~

	==See also==		==See also==

JoshGoldberg: /* Remarks */

2013-08-20T13:50:05Z

Remarks

← Older revision		Revision as of 13:50, 20 August 2013
Line 20:		Line 20:
	==Remarks==		==Remarks==
	Copying or assigning <tt>WavePlayer</tt> instances may require re-loading audio data into memory. Write operations to STL containers may imply copying of a contained object, followed by destruction of the original object after copying. Consequently, manipulations to STL containers that contain <tt>WavePlayer</tt> objects are not advisable during playback from one or more of its contained objects, or in time-critical situations. Typically, one would set up such containers at initialization time, and perform only read operations on containers during playback.		Copying or assigning <tt>WavePlayer</tt> instances may require re-loading audio data into memory. Write operations to STL containers may imply copying of a contained object, followed by destruction of the original object after copying. Consequently, manipulations to STL containers that contain <tt>WavePlayer</tt> objects are not advisable during playback from one or more of its contained objects, or in time-critical situations. Typically, one would set up such containers at initialization time, and perform only read operations on containers during playback.

			include "application\audio\WavePlayer.h"

	==See also==		==See also==

Mellinger: /* Remarks */

2010-10-20T13:43:20Z

Remarks

← Older revision		Revision as of 13:43, 20 October 2010
Line 19:		Line 19:

	==Remarks==		==Remarks==
	Copying or assigning <tt>WavePlayer</tt> instances may require re-loading audio data into memory. Write operations to STL containers may imply copying of a contained object, followed by destruction of the original object after copying. Consequently, manipulations to STL containers that contain <tt>WavePlayer</tt> objects are not advisable during playback from one or more of its contained objects, or in time-critical situations. Typically, one would set up such containers at initialization time, and ~~use reading~~ operations ~~only~~ during playback.		Copying or assigning <tt>WavePlayer</tt> instances may require re-loading audio data into memory. Write operations to STL containers may imply copying of a contained object, followed by destruction of the original object after copying. Consequently, manipulations to STL containers that contain <tt>WavePlayer</tt> objects are not advisable during playback from one or more of its contained objects, or in time-critical situations. Typically, one would set up such containers at initialization time, and perform only read operations on containers during playback.

	==See also==		==See also==

Mellinger at 15:56, 10 September 2008

2008-09-10T15:56:26Z

@@ Line 8: / Line 8: @@
 ==Properties==
-For each property, there is a getter method carrying the plain property name. Writable properties have an additional setter method prefixed with "Set".
+{{WavePlayerProperties}}
 ==Methods==

Mellinger: /* Synopsis */

2008-06-19T13:08:29Z

Synopsis

← Older revision		Revision as of 13:08, 19 June 2008
Line 1:		Line 1:
			==Location==
			<tt>BCI2000/src/shared/modules/application/audio</tt>

	==Synopsis==		==Synopsis==
	The <tt>WavePlayer</tt> class is a wrapper for audio output from audio data recorded in PCM format (Windows WAV files).		The <tt>WavePlayer</tt> class is a wrapper for audio output from audio data recorded in PCM format (Windows WAV files).

Mellinger: /* Remarks */

2008-06-16T12:37:47Z

Remarks

← Older revision		Revision as of 12:37, 16 June 2008
Line 44:		Line 44:

	==Remarks==		==Remarks==
	Copying or assigning <tt>WavePlayer</tt> instances may require re-loading audio data into memory~~; consequently~~, manipulations to STL containers that contain <tt>WavePlayer</tt> objects are not advisable in time-critical situations. Typically, one would set up such containers at initialization time, and use ~~use <tt>WavePlayer::Play()</tt> to play back from contained objects when appropriate~~.		Copying or assigning <tt>WavePlayer</tt> instances may require re-loading audio data into memory. Write operations to STL containers may imply copying of a contained object, followed by destruction of the original object after copying. Consequently, manipulations to STL containers that contain <tt>WavePlayer</tt> objects are not advisable during playback from one or more of its contained objects, or in time-critical situations. Typically, one would set up such containers at initialization time, and use reading operations only during playback.

	==See also==		==See also==

Mellinger: /* float Volume (rw) */

2008-06-16T10:24:14Z

float Volume (rw)

← Older revision		Revision as of 10:24, 16 June 2008
Line 10:		Line 10:
	The path may be absolute, or relative to the current executable.		The path may be absolute, or relative to the current executable.
	===float Volume (rw)===		===float Volume (rw)===
	Playback volume in the range 0.0 ~~...~~ 1.0.		Playback volume in the range 0.0 to 1.0.

	===float Pan (rw)===		===float Pan (rw)===
	Panning position in the range -1.0 (leftmost) to +1.0 (rightmost).		Panning position in the range -1.0 (leftmost) to +1.0 (rightmost).

Mellinger: /* See also */

2008-06-16T10:24:01Z

Mellinger: /* See also */

2008-06-16T10:23:46Z

Mellinger at 10:22, 16 June 2008

2008-06-16T10:22:22Z

New page

==Synopsis==
The <tt>WavePlayer</tt> class is a wrapper for audio output from audio data recorded in PCM format (Windows WAV files).
In order to minimize playback delay, an audio file is loaded into memory prior to playback.
<tt>WavePlayer</tt> objects may be stored in STL containers.

==Properties==
For each property, there is a getter method carrying the plain property name. Writable properties have an additional setter method prefixed with "Set".
===string File (rw)===
Path to an audio file to be played back. The <tt>SetFile</tt> method loads audio data into memory.
The path may be absolute, or relative to the current executable.
===float Volume (rw)===
Playback volume in the range 0.0 ... 1.0.
===float Pan (rw)===
Panning position in the range -1.0 (leftmost) to +1.0 (rightmost).
===float PlayingPos (r)===
Playback position from start, in milliseconds. Zero if not playing.
===bool IsPlaying (r)===
True during playback, false otherwise.
===enum Error ErrorState (r)===
The result of the preceding operation, represented by one of the members of the Error enumerated type.

==Enumerations==
===enum Error===
*No Error
*File Opening Error
:the File property was set to a non-existent file, or a file that could not be loaded as an audio file.
*Feature not supported
:a feature provided by one of the properties (such as panning) is not supported by the current implementation.
*Invalid Parameters
:a property is out of range.
*Inititalization Error
:there was an error when initializing an underlying library (such as DirectX Audio under Windows).
*Generic Error
:an error occurred that does not fit into any of the remaining categories.

==Methods==
===Default Constructor, Copy Constructors, Assignment Operator, Destructor===
These provide the full set of methods required to use <tt>WavePlayer</tt> as a data type in STL containers, such as <tt>std::vector<WavePlayer></tt>.
===Play()===
Start playback. This method does nothing if the File property has not been specified.
===Stop()===
Stops playback, and resets the playback position to the beginning. This method does nothing when no audio is being played.

==Remarks==
Copying or assigning <tt>WavePlayer</tt> instances may require re-loading audio data into memory; consequently, manipulations to STL containers that contain <tt>WavePlayer</tt> objects are not advisable in time-critical situations. Typically, one would set up such containers at initialization time, and use use <tt>WavePlayer::Play()</tt> to play back from contained objects when appropriate.

==See also==
[[Programming Reference:C++ Coding Style]], [[Programming Reference:TextToSpeech Class]], [[Programming Reference:MidiPlayer Class]]

[[Category:Framework API]][[Category:Development]]

← Older revision		Revision as of 10:24, 16 June 2008
Line 46:		Line 46:

	==See also==		==See also==
	~~[[Programming Reference:Cpp Coding Style]],~~ [[Programming Reference:TextToSpeech Class]], [[Programming Reference:MidiPlayer Class]]		[[Programming Reference:TextToSpeech Class]], [[Programming Reference:MidiPlayer Class]]

	[[Category:Framework API]][[Category:Development]]		[[Category:Framework API]][[Category:Development]]

← Older revision		Revision as of 10:23, 16 June 2008
Line 46:		Line 46:

	==See also==		==See also==
	[[Programming Reference:~~C++~~ Coding Style]], [[Programming Reference:TextToSpeech Class]], [[Programming Reference:MidiPlayer Class]]		[[Programming Reference:Cpp Coding Style]], [[Programming Reference:TextToSpeech Class]], [[Programming Reference:MidiPlayer Class]]

	[[Category:Framework API]][[Category:Development]]		[[Category:Framework API]][[Category:Development]]