Template:WavePlayerProperties - Revision history

Mellinger: /* enum Error */

2010-07-15T12:55:17Z

enum Error

← Older revision		Revision as of 12:55, 15 July 2010
Line 15:		Line 15:

	==Enumerations==		==Enumerations==
	===enum Error===		===enum WavePlayer::Error===
	*No Error		*No Error
	*File Opening Error		*File Opening Error

Mellinger: /* enum Error ErrorState (r) */

2010-07-15T12:54:12Z

enum Error ErrorState (r)

← Older revision		Revision as of 12:54, 15 July 2010
Line 11:		Line 11:
	===bool IsPlaying (r)===		===bool IsPlaying (r)===
	True during playback, false otherwise.		True during playback, false otherwise.
	===enum Error ErrorState (r)===		===enum WavePlayer::Error ErrorState (r)===
	The result of the preceding operation, represented by one of the members of the Error enumerated type.		The result of the preceding operation, represented by one of the members of the Error enumerated type.

Mellinger at 15:55, 10 September 2008

2008-09-10T15:55:15Z

← Older revision		Revision as of 15:55, 10 September 2008
Line 13:		Line 13:
	===enum Error ErrorState (r)===		===enum Error ErrorState (r)===
	The result of the preceding operation, represented by one of the members of the Error enumerated type.		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.

Mellinger at 15:53, 10 September 2008

2008-09-10T15:53:34Z

New page

===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 to 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.