Programmer Guide/Macro Library/XWave - Revision history

Jw: /* SetFrame */

2018-04-17T10:04:39Z

SetFrame

← Older revision		Revision as of 12:04, 17 April 2018
Line 130:		Line 130:
	;<var>length</var>		;<var>length</var>

	:The frame length (a time expression).		:The frame length ([[Programmer_Guide/Command_Reference/SEGMENT#Segment_Expression\|a time expression]]).

	;<var>shift</var>		;<var>shift</var>

2018-04-17T07:34:37Z

2018-04-17T07:30:41Z

XWave Construction

← Older revision		Revision as of 09:30, 17 April 2018
Line 7:		Line 7:
	====XWave Construction====		====XWave Construction====

	Create a new <code>XWAVE</code> instance. The <code>XWAVE</code> references either a segment (<var>aseg</var>), a whole sound file (<var>soundfile</var>) or a wave-item signal (<var>wave</var>). Information and error messages are written to the script console. If no optional arguments are specified, only the instance is created, otherwise the frame-setup is also performed (see member [[~~../~~#~~SETFRAME~~\|SETFRAME]]).		Create a new <code>XWAVE</code> instance. The <code>XWAVE</code> references either a segment (<var>aseg</var>), a whole sound file (<var>soundfile</var>) or a wave-item signal (<var>wave</var>). Information and error messages are written to the script console. If no optional arguments are specified, only the instance is created, otherwise the frame-setup is also performed (see member [[#SetFrame\|SETFRAME]]).

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

2018-04-17T07:28:57Z

XWave Construction

← Older revision		Revision as of 09:28, 17 April 2018
Line 7:		Line 7:
	====XWave Construction====		====XWave Construction====

	Create a new <code>XWAVE</code> instance. The <code>XWAVE</code> references either a segment (<var>aseg</var>), a whole sound file (<var>soundfile</var>) or a wave-item signal (<var>wave</var>). Information and error messages are written to the script console. If no optional arguments are specified, only the instance is created, otherwise the frame-setup is also performed (see member SETFRAME).		Create a new <code>XWAVE</code> instance. The <code>XWAVE</code> references either a segment (<var>aseg</var>), a whole sound file (<var>soundfile</var>) or a wave-item signal (<var>wave</var>). Information and error messages are written to the script console. If no optional arguments are specified, only the instance is created, otherwise the frame-setup is also performed (see member [[../#SETFRAME\|SETFRAME]]).

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

2018-04-17T07:27:51Z

Parameters:

← Older revision		Revision as of 09:27, 17 April 2018
Line 17:		Line 17:
	<code>XWAVE <var>wave</var> [; <var>mode</var> ; <var>length</var> ; <var>shift</var> ; <var>amax</var> ; <var>aref</var>]</code>		<code>XWAVE <var>wave</var> [; <var>mode</var> ; <var>length</var> ; <var>shift</var> ; <var>amax</var> ; <var>aref</var>]</code>

	~~=====~~Parameters:~~=====~~		;Parameters:

	;<var>aset</var>		;<var>aset</var>
Line 33:		Line 33:
	;<var>soundfile</var>		;<var>soundfile</var>

	:The path to a ~~soundfile~~ on disk.		:The path to a sound file on disk.

	;<var>wave</var>		;<var>wave</var>

2018-04-17T07:19:31Z

Result:

← Older revision		Revision as of 09:19, 17 April 2018
Line 143:		Line 143:
	:The reference signal amplitude (=0dB). This is only used if <var>amax</var> is a number.		:The reference signal amplitude (=0dB). This is only used if <var>amax</var> is a number.

	~~=====~~Result:~~=====~~		;Result:Returns the number of frames (>1) or 0 for error.

	Returns the number of frames (>1) or 0 for error.

	===TBegin===		===TBegin===

2018-04-17T07:19:17Z

Usage:

← Older revision		Revision as of 09:19, 17 April 2018
Line 119:		Line 119:
	Set the I/O frame parameters.		Set the I/O frame parameters.

	~~=====~~Usage:~~=====~~		;Usage:<code><var>xwave</var> SetFrame <var>mode</var> ; <var>length</var> ; <var>shift</var>=25% ; <var>amax</var>=1 ; <var>aref</var>=1</code>

	<code><var>xwave</var> SetFrame <var>mode</var> ; <var>length</var> ; <var>shift</var>=25% ; <var>amax</var>=1 ; <var>aref</var>=1</code>

	;Parameters		;Parameters

2018-04-17T07:18:40Z

Parameters:

← Older revision		Revision as of 09:18, 17 April 2018
Line 123:		Line 123:
	<code><var>xwave</var> SetFrame <var>mode</var> ; <var>length</var> ; <var>shift</var>=25% ; <var>amax</var>=1 ; <var>aref</var>=1</code>		<code><var>xwave</var> SetFrame <var>mode</var> ; <var>length</var> ; <var>shift</var>=25% ; <var>amax</var>=1 ; <var>aref</var>=1</code>

	~~=====~~Parameters~~:=====~~		;Parameters

	;<var>mode</var>		;<var>mode</var>

2018-04-17T07:17:46Z

Result:

← Older revision		Revision as of 09:17, 17 April 2018
Line 113:		Line 113:
	;Usage:<code><var>xwave</var> ReadQ</code>		;Usage:<code><var>xwave</var> ReadQ</code>

	~~=====~~Result:~~=====~~		;Result:A signal vector of the next frame.

	A signal vector of the next frame.

	===SetFrame===		===SetFrame===

2018-04-17T07:17:24Z

Usage:

← Older revision		Revision as of 09:17, 17 April 2018
Line 111:		Line 111:
	Quickly read the next frame.		Quickly read the next frame.

	~~=====~~Usage:~~=====~~		;Usage:<code><var>xwave</var> ReadQ</code>

	<code><var>xwave</var> ReadQ</code>

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