Toni at 13:28, 22 November 2018

2018-11-22T13:28:23Z

← Older revision		Revision as of 15:28, 22 November 2018
Line 102:		Line 102:

	:For virtual wave items, the type of real wave item is returned.		:For virtual wave items, the type of real wave item is returned.

			;<var>!MODE</var>

			:The <code>WAVE</code> item attribute <code>!MODE</code> returns <code>WRITE</code> if signal can be written to (stored in) the wave and <code>READ</code> if the signal can only be read but not changed

Jw at 07:41, 18 April 2018

2018-04-18T07:41:56Z

← Older revision		Revision as of 09:41, 18 April 2018
Line 87:		Line 87:
	:The <code>WAVE</code> item attribute <code>!PROGRESS</code> returns the amount of the signal which has been progressed as a percentage of its length.		:The <code>WAVE</code> item attribute <code>!PROGRESS</code> returns the amount of the signal which has been progressed as a percentage of its length.

	;<var>!SIGNAL</var>		;<var>!SIGNAL[,channel[,offset[,length]]]</var>

	:The <code>WAVE</code> item attribute <code>!SIGNAL</code> returns the signal as a vector of samples in a shell table.		:The <code>WAVE</code> item attribute <code>!SIGNAL</code> returns the signal as a vector of samples in a shell table.
			:You can also specify the channel, offset and length (e.g. <samp>$#wave[!signal,1]</samp>).

	;<var>!SRATE</var>		;<var>!SRATE</var>

Jw: adding template

2015-05-05T07:11:03Z

adding template

← Older revision		Revision as of 09:11, 5 May 2015
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	~~==WAVE~~ Item ~~Attributes==~~		{{Wave Item}}

	;<var>!BEGIN</var>		;<var>!BEGIN</var>

Admin: 1 revision: Initial import

2010-11-18T16:31:52Z

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}}}}
==WAVE Item Attributes==

;<var>!BEGIN</var>

:The <code>WAVE</code> item attribute !BEGIN returns the start address in samples.

;<var>!CHANNELS</var>

:The <code>WAVE</code> item attribute <code>!CHANNELS</code> returns the number of signal channels.

;<var>!DEVICE</var>

:The <code>WAVE</code> item attribute <code>!DEVICE</code> returns the type of device attached to wave item or an empty string if no device is attached. Possible values are:

:<code>PLAY</code>|<code>RECORD</code>

;<var>!INCAPS</var>

:The <code>WAVE</code> item attribute <code>!INCAPS</code> returns the capabilities of the selected input device in the following format:

:<code>devicename ; MME|ASIO|* maxch|* minsr|* maxsr|* anysr{0|1}; sr1 .. srN; fmt1 .. fmtN;</code>

;<var>!INDEVICE</var>

:The <code>WAVE</code> item attribute <code>!INDEVICE</code> returns the id of the input wave device referenced by the mandatory second parameter <var>index</var>.

:E.g.:

:<code>$#wave[!indevice,$#wave[!indevices]-1]</code> // returns the id of the last available input device.

;<var>!INDEVICES</var>

:The <code>WAVE</code> item attribute <code>!INDEVICES</code> returns the number of installed wave recording devices.

;<var>!INSELECTED</var>

:The <code>WAVE</code> item attribute <code>!INSELECTED</code> returns the index of the wave device selected for recording functions.

;<var>!LENGTH</var>

:The <code>WAVE</code> item attribute <code>!LENGTH</code> returns the length of the signal in samples.

;<var>!OUTCAPS</var>

:The <code>WAVE</code> item attribute <code>!OUTCAPS</code> returns the capabilities of the selected output device in the following format:

:<code>devicename ; MME|ASIO|* maxch|* minsr|* maxsr|* anysr{0|1}; sr1 .. srN; fmt1 .. fmtN;</code>

;<var>!OUTDEVICE</var>

:The <code>WAVE</code> item attribute <code>!OUTDEVICE</code> returns the id of the output wave device referenced by the mandatory second parameter <var>index</var>.

:E.g.:

<pre>
$#wave[!outdevice,0] // returns the id of the first playback device
</pre>
;<var>!OUTDEVICES</var>

:The <code>WAVE</code> item attribute <code>!OUTDEVICES</code> returns the number of installed wave playback devices.

;<var>!OUTSELECTED</var>

:The <code>WAVE</code> item attribute <code>!OUTSELECTED</code> returns the index of the wave device selected for playback functions.

;<var>!PLAYGAIN</var>

:The <code>WAVE</code> item attribute <code>!PLAYGAIN</code> returns the linear gain value currently being used for playback. If a second parameter, <var>NewGainValue</var>, is specified, then the playback gain value is changed. If playback is in progress, the new gain value is first used when the current buffer has been played.

:Examples:

<pre>
#linearGainValue := $#wave[!PlayGain] // retrieve gain value
#linearGainValue := $#wave[!PlayGain, $(num $#linearGainValue + 1)] // increase the gain value by one.
</pre>
;<var>!PLAYSRATE</var>

:The <code>WAVE</code> item attribute <code>!PLAYGAIN</code> returns the sampling rate used for playback. If a second parameter, <var>NewPlaybackSRate</var>, is specified, then the playback sampling rate is set to this new value. See the script <code>playsrate.sts</code> for an example.

;<var>!POSITION</var>

:The <code>WAVE</code> item attribute <code>!POSITION</code> returns access position in samples of the attached device. The signal between <code>!BEGIN</code> and this position has already been processed. This value is empty if the wave item is not being played.

;<var>!PROGRESS</var>

:The <code>WAVE</code> item attribute <code>!PROGRESS</code> returns the amount of the signal which has been progressed as a percentage of its length.

;<var>!SIGNAL</var>

:The <code>WAVE</code> item attribute <code>!SIGNAL</code> returns the signal as a vector of samples in a shell table.

;<var>!SRATE</var>

:The <code>WAVE</code> item attribute <code>!SRATE</code> returns the sampling rate in Hz.

;<var>!TYPE</var>

:The <code>WAVE</code> item attribute <code>!TYPE</code> returns the type of the wave item or an empty string if no signal is addressed by wave item. The type is one of the following values:

:<code>STREAM</code>|<code>SEQUENCE</code>|<code>WAVE</code>|<code>ADC</code>|<code>DAC</code>

:For virtual wave items, the type of real wave item is returned.

Programmer Guide/Shell Items/Wave/WAVE Item Attributes - Revision history

Toni at 13:28, 22 November 2018

Jw at 07:41, 18 April 2018

Jw: adding template

Admin: 1 revision: Initial import

193.171.195.8: initial import