Programmer Guide/Macro Library/BDataSet - Revision history

Toni: /* OpenAutoAFile */

2023-08-28T13:50:26Z

OpenAutoAFile

← Older revision		Revision as of 15:50, 28 August 2023
Line 139:		Line 139:
	:;<var>srate</var>: sampling rate in Hz		:;<var>srate</var>: sampling rate in Hz
	:;<var>channels</var>: number of signal channels		:;<var>channels</var>: number of signal channels
	:;<var>code</var> sample code (see [[Programmer_Guide/Command_Reference/LOAD#LOAD_SOUNDFILE\|command LOAD SOUNDFILE)		:;<var>code</var> sample code (see [[Programmer_Guide/Command_Reference/LOAD#LOAD_SOUNDFILE\|command LOAD SOUNDFILE]])
	;Result: '<var>iref ; created</var>' with:		;Result: '<var>iref ; created</var>' with:
	::* <var>iref</var>: the audio set reference of the autofile		::* <var>iref</var>: the audio set reference of the autofile

Jw: /* AddASet */

2019-09-18T08:23:08Z

AddASet

← Older revision		Revision as of 10:23, 18 September 2019
Line 101:		Line 101:
	:;<var>update</var>: if set to '''1''' (or '''yes''') the function <code>DataSetCmd RefreshAll</code> is called to refresh the project GUI		:;<var>update</var>: if set to '''1''' (or '''yes''') the function <code>DataSetCmd RefreshAll</code> is called to refresh the project GUI
	;Result: if successful, the the reference (iref) of the added audio set if returned, otherwise an empty string		;Result: if successful, the the reference (iref) of the added audio set if returned, otherwise an empty string
	;Description: This function ~~add~~ an audio set (sound file or sequence) to the project.		;Description: This function adds an audio set (sound file or sequence) to the project.

	===AFileIsLinked===		===AFileIsLinked===

Jw: /* AddASet */

2019-09-18T08:22:56Z

AddASet

← Older revision		Revision as of 10:22, 18 September 2019
Line 101:		Line 101:
	:;<var>update</var>: if set to '''1''' (or '''yes''') the function <code>DataSetCmd RefreshAll</code> is called to refresh the project GUI		:;<var>update</var>: if set to '''1''' (or '''yes''') the function <code>DataSetCmd RefreshAll</code> is called to refresh the project GUI
	;Result: if successful, the the reference (iref) of the added audio set if returned, otherwise an empty string		;Result: if successful, the the reference (iref) of the added audio set if returned, otherwise an empty string
	:Description: This function add an audio set (sound file or sequence) to the project.		;Description: This function add an audio set (sound file or sequence) to the project.

	===AFileIsLinked===		===AFileIsLinked===

Jw: /* GetSegment */

2019-06-24T07:35:33Z

GetSegment

← Older revision		Revision as of 09:35, 24 June 2019
Line 224:		Line 224:
	\| <code>channel [<var>unit</var>]</code> \|\| channel assigned to segment \|\| attribute CH		\| <code>channel [<var>unit</var>]</code> \|\| channel assigned to segment \|\| attribute CH
	\|-		\|-
	\| <var>attrname</var> \|\| value of attribute <var>attrname</var> \|\| attribute names are case ~~sentive~~!		\| <var>attrname</var> \|\| value of attribute <var>attrname</var> \|\| attribute names are case sensitive!
	\|}		\|}

	Note: The optional argument <var>unit</var> specifies the unit for time values. It can be '''samples''' (default), '''seconds''', '''~~miliseconds~~''' (or '''ms''') or '''hms'''		Note: The optional argument <var>unit</var> specifies the unit for time values. It can be '''samples''' (default), '''seconds''', '''milliseconds''' (or '''ms''') or '''hms'''

	===FindSegment===		===FindSegment===

Jw: /* FindSegment */

2019-06-24T07:07:13Z

FindSegment

← Older revision		Revision as of 09:07, 24 June 2019
Line 241:		Line 241:
	;Usage: <code>$bdataset findsegment reset; <var>table\|asegpos ; delete=0</var></code>		;Usage: <code>$bdataset findsegment reset; <var>table\|asegpos ; delete=0</var></code>
	;Result: none (void)		;Result: none (void)
	;Description: This function variant clears the position <var>asegpos</var> or the segments positions stored in <var>table</var>. If <var>delete</var> is set to '''1''' also the segments ~~themselve~~ are deleted. It must be called to reset the segment position if an iteration loop is ~~leaved~~ early and to reset positions of segments found by the <code>all</code> variant.		;Description: This function variant clears the position <var>asegpos</var> or the segments positions stored in <var>table</var>. If <var>delete</var> is set to '''1''' also the segments themselves are deleted. It must be called to reset the segment position if an iteration loop is left early and to reset positions of segments found by the <code>all</code> variant.

	;Arguments:		;Arguments:

Jw: /* GetASetInfo */

2019-04-05T09:20:02Z

GetASetInfo

← Older revision		Revision as of 11:20, 5 April 2019
Line 127:		Line 127:
	:;<var>type</var>: assumed type of the audio set: '''AFile''', '''Soundfile''', '''ASequence''', '''Sequence''' or '''*''' (default) if type is unknown		:;<var>type</var>: assumed type of the audio set: '''AFile''', '''Soundfile''', '''ASequence''', '''Sequence''' or '''*''' (default) if type is unknown
	;Result: an empty string for error or the available attributes of the selected audio set:		;Result: an empty string for error or the available attributes of the selected audio set:
	::* for sound files: <code>Soundfile~~</code>~~ ; <var>id</var> ; <var>sr</var> ; <var>ch</var> ; <var>filepath</var>		::* for sound files: <code>Soundfile ; <var>id</var> ; <var>sr</var> ; <var>ch</var> ; <var>filepath</var></code>
	::* for sequences: <code>Sequence~~</code>~~ ; <var>id</var> ; <var>sr</var> ; <var>ch</var>		::* for sequences: <code>Sequence ; <var>id</var> ; <var>sr</var> ; <var>ch</var></code>
	;Description: This function retrieves information about the selected audio set. If arguments are specified, they are passed to the function <code>SelectASet</code> to select the audio set, before the audio set information is returned.		;Description: This function retrieves information about the selected audio set. If arguments are specified, they are passed to the function <code>SelectASet</code> to select the audio set, before the audio set information is returned.

Jw: /* GetASetInfo */

2019-04-05T09:19:30Z

GetASetInfo

← Older revision		Revision as of 11:19, 5 April 2019
Line 127:		Line 127:
	:;<var>type</var>: assumed type of the audio set: '''AFile''', '''Soundfile''', '''ASequence''', '''Sequence''' or '''*''' (default) if type is unknown		:;<var>type</var>: assumed type of the audio set: '''AFile''', '''Soundfile''', '''ASequence''', '''Sequence''' or '''*''' (default) if type is unknown
	;Result: an empty string for error or the available attributes of the selected audio set:		;Result: an empty string for error or the available attributes of the selected audio set:
	::* for sound files: <code>Soundfile</code>;<var>id</var>;<var>sr</var>;<var>ch</var>;<var>filepath</var>		::* for sound files: <code>Soundfile</code> ; <var>id</var> ; <var>sr</var> ; <var>ch</var> ; <var>filepath</var>
	::* for sequences: <code>Sequence</code>;<var>id</var>;<var>sr</var>;<var>ch</var>		::* for sequences: <code>Sequence</code> ; <var>id</var> ; <var>sr</var> ; <var>ch</var>
	;Description: This function retrieves information about the selected audio set. If arguments are specified, they are passed to the function <code>SelectASet</code> to select the audio set, before the audio set information is returned.		;Description: This function retrieves information about the selected audio set. If arguments are specified, they are passed to the function <code>SelectASet</code> to select the audio set, before the audio set information is returned.

Jw: correcting return values

2019-04-05T09:18:54Z

correcting return values

← Older revision		Revision as of 11:18, 5 April 2019
Line 127:		Line 127:
	:;<var>type</var>: assumed type of the audio set: '''AFile''', '''Soundfile''', '''ASequence''', '''Sequence''' or '''*''' (default) if type is unknown		:;<var>type</var>: assumed type of the audio set: '''AFile''', '''Soundfile''', '''ASequence''', '''Sequence''' or '''*''' (default) if type is unknown
	;Result: an empty string for error or the available attributes of the selected audio set:		;Result: an empty string for error or the available attributes of the selected audio set:
	::* for sound files: <code>Soundfile</code~~>;<var>id</var~~>;<var>id</var>;<var>sr</var>;<var>ch</var>;<var>filepath</var>		::* for sound files: <code>Soundfile</code>;<var>id</var>;<var>sr</var>;<var>ch</var>;<var>filepath</var>
	::* for sequences: <code>Sequence</code~~>;<var>id</var~~>;<var>id</var>;<var>sr</var>;<var>ch</var>		::* for sequences: <code>Sequence</code>;<var>id</var>;<var>sr</var>;<var>ch</var>
	;Description: This function retrieves information about the selected audio set. If arguments are specified, they are passed to the function <code>SelectASet</code> to select the audio set, before the audio set information is returned.		;Description: This function retrieves information about the selected audio set. If arguments are specified, they are passed to the function <code>SelectASet</code> to select the audio set, before the audio set information is returned.

Jw: /* AddASet */

2018-12-04T09:28:01Z

AddASet

← Older revision		Revision as of 11:28, 4 December 2018
Line 100:		Line 100:
	:;<var>channels</var>: the number of channels for a new soundfile or a sequence		:;<var>channels</var>: the number of channels for a new soundfile or a sequence
	:;<var>update</var>: if set to '''1''' (or '''yes''') the function <code>DataSetCmd RefreshAll</code> is called to refresh the project GUI		:;<var>update</var>: if set to '''1''' (or '''yes''') the function <code>DataSetCmd RefreshAll</code> is called to refresh the project GUI
	;Result: if ~~successfulthe~~ the reference (iref) of the added audio set if returned, otherwise an empty string		;Result: if successful, the the reference (iref) of the added audio set if returned, otherwise an empty string
	:Description: This function add an audio set (sound file or sequence) to the project.		:Description: This function add an audio set (sound file or sequence) to the project.

	===AFileIsLinked===		===AFileIsLinked===

Jw: /* Save */

2018-10-29T09:25:32Z

Save

← Older revision		Revision as of 11:25, 29 October 2018
Line 43:		Line 43:
	;Usage: <code>$bdataset save [ <var>path=* ; auto=0 ; pbh=* ]</var></code>		;Usage: <code>$bdataset save [ <var>path=* ; auto=0 ; pbh=* ]</var></code>
	:;<var>path</var>: project file path; if not specified or '''*''', the last load/save path is used		:;<var>path</var>: project file path; if not specified or '''*''', the last load/save path is used
	:;<var>auto</var>: if set to '''1''' the user is prompted (yes/no dialog~~), before the project is saved~~		:;<var>auto</var>: if set to '''1''' the user is '''not''' prompted with a yes/no dialog as to whether they want to save or not.
	:;<var>pbh</var>: a progress dialog handle (see [[Programmer_Guide/Macro_Library/ProgressBox\|macro ProgressBox]]); use '''*''' if no progress box should be displayed		:;<var>pbh</var>: a progress dialog handle (see [[Programmer_Guide/Macro_Library/ProgressBox\|macro ProgressBox]]); use '''*''' if no progress box should be displayed
	;Result: '''0''' for success or a non-zero error code		;Result: '''0''' for success or a non-zero error code