Programmer Guide/Macro Library/Playwave - Revision history

Jw: /* Playwave : CObj */

2016-04-05T12:23:36Z

Playwave : CObj

← Older revision		Revision as of 14:23, 5 April 2016
Line 3:		Line 3:
	=Playwave : CObj=		=Playwave : CObj=

	The <code>Playwave</code> class is a convenient way to play back one or more wave items with the optional use of a dialog for user interaction.		The <code>Playwave</code> class is a convenient way to play back one or more [[Programmer_Guide/Shell_Items/Wave\|wave items]] with the optional use of a dialog for user interaction.

	[[File:dialog_playback.png]]		[[File:dialog_playback.png]]

Jw: /* Examples: */

2016-04-05T12:22:31Z

Examples:

← Older revision		Revision as of 14:22, 5 April 2016
Line 119:		Line 119:
	:<code>waveItem\|xWaveObject ; text</code>		:<code>waveItem\|xWaveObject ; text</code>

	===Examples:===		==Examples:==

	Playback a wave signal from disk.		Playback a wave signal from disk.

Jw at 12:18, 5 April 2016

2016-04-05T12:18:08Z

← Older revision		Revision as of 14:18, 5 April 2016
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	{{TOC limit\|3}}		{{TOC limit\|4}}
	=Playwave : CObj=		=Playwave : CObj=

Line 119:		Line 119:
	:<code>waveItem\|xWaveObject ; text</code>		:<code>waveItem\|xWaveObject ; text</code>

	=====Examples:=====		===Examples:===

	Playback a wave signal from disk.		Playback a wave signal from disk.

Jw: /* Playwave : CObj */

2016-04-05T12:17:13Z

Playwave : CObj

← Older revision		Revision as of 14:17, 5 April 2016
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	{{TOC limit\|3}}		{{TOC limit\|3}}
	==Playwave : CObj==		=Playwave : CObj=

	The <code>Playwave</code> class is a convenient way to play back one or more wave items with the optional use of a dialog for user interaction.		The <code>Playwave</code> class is a convenient way to play back one or more wave items with the optional use of a dialog for user interaction.
Line 7:		Line 7:
	[[File:dialog_playback.png]]		[[File:dialog_playback.png]]

	====Playwave Member Functions====		==Playwave Member Functions==

	The <code>Playwave</code> class has the following member functions. See CObj Member Functions for a list of functions implemented in the parent class.		The <code>Playwave</code> class has the following member functions. See CObj Member Functions for a list of functions implemented in the parent class.

Jw at 12:15, 5 April 2016

2016-04-05T12:15:26Z

← Older revision		Revision as of 14:15, 5 April 2016
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
			{{TOC limit\|3}}
	==Playwave : CObj==		==Playwave : CObj==

Toni: moved Programmer Guide/Class Library/Playwave : CObj to Programmer Guide/Macro Library/Playwave

2011-04-28T08:02:09Z

moved Programmer Guide/Class Library/Playwave : CObj to Programmer Guide/Macro Library/Playwave

← Older revision	Revision as of 10:02, 28 April 2011
(No difference)

Admin: 1 revision: Initial import

2010-11-18T16:31:29Z

1 revision: Initial import

← Older revision	Revision as of 18:31, 18 November 2010
(No difference)

193.171.195.8: initial import

2010-05-17T13:05:27Z

initial import

New page

{{DISPLAYTITLE:{{SUBPAGENAME}}}}
==Playwave : CObj==

The <code>Playwave</code> class is a convenient way to play back one or more wave items with the optional use of a dialog for user interaction.

[[File:dialog_playback.png]]

====Playwave Member Functions====

The <code>Playwave</code> class has the following member functions. See CObj Member Functions for a list of functions implemented in the parent class.

===Construct===

Initializes the playback instance. If mode equals <code>DIALOG</code> a playback dialog box is created and displayed which contains a playback progress bar, a stop button and a pause button. If the wave item count is greater than one, also buttons to select the next/previous wave item and to repeat playback of the current wave item are displayed.

=====Usage:=====

<code>construct <var>mode</var> ; <var>count</var></code>

=====Parameters:=====

;<var>mode</var>

:The dialog mode. The following values are supported:

:<code>DIALOG</code> - A dialog displays the playback progress.

:<code>NODIALOG</code> - Playback uses no visual aid.

;<var>count</var>

:The number of wave items.

=====Result:=====

0 for success and 1 for error

===Destruct===

Deletes the playback dialog (if created) and cleans up the internal items.

=====Usage:=====

<code>Destruct</code>

=====Result:=====

none

===DoDialog===

See the <code>Playwave</code> member function <code>DoPlay</code> for details.

===DoPlay===

Plays the specified wave item <var>wave</var>. If the dialog was created, the playback progress is displayed and the dialog can be used to stop playback and select the next or previous wave item, or repeat the current one. The user of the <code>Playwave</code> class must then act upon the returned index and play back the corresponding wave item with another call to <code>DoPlay</code>.

=====Usage:=====

<code>DoPlay <var>wave</var> ; <var>index</var> ; <var>text</var></code>

<code>DoDialog <var>wave</var> ; <var>index</var> ; <var>title</var></code>

=====Parameters:=====

;<var>wave</var>

:The name of the wave item to be played.

;<var>index</var>

:The index of this wave item (0 <= index < count).

;<var>title</var>

:The dialog window caption.

=====Result:=====

The index of the next wave item to be played or <code>-1</code> for error / end.

====Playwave Static Functions====

The <code>PlayWave</code> class supports the following static functions:

===PlayWave===

Playback one or more <code>WAVE</code> or <code>[[Programmer Guide/Class Library/XWave : CObjEx|XWAVE]]</code> items. Note that a dialog is displayed during playback.

=====Usage:=====

<code>PlayWave <var>waveItem</var>|<var>xWaveObject</var> ; <var>text</var></code>

=====Parameters:=====

;<var>waveItem</var>

:The wave item to play. See the shell item WAVE for details.

;<var>xWaveObject</var>

:The xWaveObject to play. See [[Programmer Guide/Class Library/XWave : CObjEx|XWAVE]] for details.

;<var>text</var>

:The text to display in the play dialog.

=====Usage:=====

<code>PlayWave <var>simpleTable</var></code>

=====Parameters:=====

;<var>simpleTable</var>

:A simple shell table. Each entry with the following format is then played:

:<code>waveItem|xWaveObject ; text</code>

=====Examples:=====

Playback a wave signal from disk.

<pre>
#xwave := xwave 'd:\data\audio\test.wav'
if '$#xwave[?]' != 'instance' em -1 ; Failed to create the xwave item.
PlayWave $#xwave
</pre>
Note that in the case of an <code>XWAVE</code> object, the <code>XWAVE</code> member function <code>play</code> can be used instead.

<pre>
#xwave := xwave 'd:\data\audio\test.wav'
if '$#xwave[?]' != 'instance' em -1 ; Failed to create the xwave item.
$#xwave play
</pre>