From ftm
Jump to: navigation, search
(→‎Reference under construction...)
m (→‎Reference under construction...)
Line 1: Line 1:
 
=== Reference under construction... ===
 
=== Reference under construction... ===
 +
  
 
* ftm.absargs
 
* ftm.absargs

Revision as of 03:24, 3 March 2008

Reference under construction...

  • ftm.absargs
  • ftm.buffer
  • ftm.clone
  • ftm.copy
  • ftm.guilistener
  • ftm.inter
  • ftm.iter
  • ftm.jitter
  • ftm.list
  • ftm.m
  • ftm.mess
  • ftm.midiparse
  • ftm.midiunparse
  • ftm.o
  • ftm.object
  • ftm.play
  • ftm.print
  • ftm.record
  • ftm.schedule
  • ftm.sdif.info
  • ftm.sdif.write
  • ftm.tween
  • ftm.value


ftm.absargs '
arguments: none
attributes: none
messages: bang - output abstraction arguments and attributes
inlets: none
outlets: 1 - name of the abstraction
2 - list of abstraction arguments
3 - dump attributes as attribute/value pairs (one list for each attribute)
ftm.buffer '
arguments: initialisation arguments
attributes: none
messages: #name - buffer~ name
inlets: none
outlets: 1 - output (reference to) fmat
ftm.clone '
arguments: none
attributes: none
messages: none
inlets: 1 - FTM object reference (original)
outlets: 1 - FTM object reference (clone)
ftm.copy '
arguments: init class by name (optionally) and copy destination
attributes: none
messages: set - set copy destination
inlets: 1 - FTM object to copy
2 - set copy destination
outlets: 1 - output (reference to) copy destination
ftm.guilistener '
arguments: initialize guiobj in guilistener
attributes: none
messages: none
inlets: none
outlets: 1 - output gui interactions as list: <name, values ... >
ftm.inter '
arguments: 1 - fmat of values corresponding to the interpolation factor 0
2 - fmat of values corresponding to the interpolation factor 1
attributes: out - set output fmat
messages: out - set output fmat
inlets: 1 - interpolation factor (fraction between 0 and 1)
2 - fmat of values corresponding to the interpolation factor 0
3 - fmat of values corresponding to the interpolation factor 1
outlets: 1 - interpolated FTM fmat object containing interpolated values
ftm.iter '
arguments: none
attributes: mode - set iterator mode
messages: none
inlets: 1 - Input FTM object reference
2 - Input start time for track iteration (default: 0)
3 - Input end time for track iteration (default: end of track)
outlets: 1 - Output element
2 - Output index, time tag, key ...
ftm.jitter '
arguments: define target (FTM or Jitter object)
attributes: plane - define plane to copy outof Jitter matrix
messages: plane - define plane to copy outof Jitter matrix
inlets: 1 - FTM or Jitter object to be copied to target
2 - set target Jitter or FTM object
outlets: 1 - output target object
ftm.list '
arguments: none
attributes: mess -
messages: anything -
inlets: 1 -
outlets: 1 -
ftm.m '
arguments: init expression
attributes: trigger <'left'|'all'> - set trigger mode (left-most or all inlets)
init [<expression arguments> ...] - initial arguments and private variables
messages: #set - set expression
bang - bang input
inlets: 1 - arbitrary values, lists and messages
outlets: 1 - resulting values, lists and messages
ftm.mess '
arguments: none
attributes: none
messages: none
inlets: 1 - input list
outlets: 1 - message outlet
ftm.midiparse '
arguments: none
attributes: none
messages: none
inlets: 1 - Input int or list of int to be parsed
outlets: 1 - Output midi event reference
ftm.midiunparse '
arguments: none
attributes: none
messages: GM -
gm -
off -
panic -
inlets: 1 - Messages or Midi events to be unparsed
outlets: 1 - Output list of int
ftm.o '
arguments: initialization arguments
attributes: persist - switch FTM object persitence: 'yes' | 'no' (default is 'no')
scope - FTM object scope: 'global' | 'local' (default is 'local')
name - FTM object name
messages: save - dump object content to file
load - reload object content to file
bang - output (reference to) FTM object
anything - messages redirected to FTM object
inlets: none
outlets: 1 - (reference to) the FTM object
2 - return values of messages send to the FTM object
ftm.object '
arguments: none
attributes: none
messages: bang - output reference
anything - message to object
inlets: none
outlets: 1 - object reference (when bang)
2 - method return values
ftm.play play a sequence
Plays a sequence outputting the sequence elements.
arguments: initialize sequence and optionally begin, end and speed
attributes: erase - switch whether to successively erase objects from sequence while playing
messages: stop - stop playing (resets current position)
pause - pause playing
start - start playing
loop - loop current or optionally given sequence and segment (begin and end)
play - play current or optionally given sequence and segment (begin and end)
bang - play sequence from beginning
next - jump to next event
sync - sync to given position
locate - locate to given position (stops playing)
jump - jump to given position
reset - stop and reset playing segment to entire sequence
set - set sequence and optionally begin, end and speed
duration - set duration of playing segment (sets speed so that the playing segment fits given duration)
speed - set playing speed
end - set end of playing segment
begin - set beginning of playing segment
erase - switch whether to successively erase objects from sequence while playing
inlets: 1 - messages only
2 - set beginning of playing segment
3 - set end of playing segment
4 - set playing speed
outlets: 1 - events while playing
2 - time while playing
3 - bang at end of segment or sequence
ftm.print print to the console
Prints any input (single values, lists, messages) to the console.

Evokes print method of FTM objects when incoming as single value.

arguments: 1 <sym: prompt> - prompt symbol
attributes: none
messages: anything - print message or FTM object
bang - print bang
inlets: 1 [<any: values> ...] - print value or list
outlets: none
ftm.record '
arguments: 1 - initialize track to record
attributes: mode - select record mode (clear | erase | overdub)
clone - switch whether to clone objects before recording
messages: set - set track to record
stop - stop recording (resets current position)
pause - pause recording
start - start recording
locate - jump to given position (default 0.)
mode - select record mode (clear | erase | overdub)
clone - switch whether to clone objects before recording
inlets: 1 - value to record (has to match track type)
outlets: 1 - current recording time
ftm.schedule '
arguments: none
attributes: mode - mode <'list'|'nolist'> - allow list input and output, default 'nolist' (second argument as delay).
messages: bang - schedule a bang
anything - schedule a message
clear - clear scheduler (suppress all pending messages)
inlets: 1 - schedule an arbitrary value
2 - set schedule delay
outlets: 1 - output scheduled values and messages
ftm.sdif.info '
arguments: 1 - default file name
2 - outinfo [mat]: set mat to receive content summary info
3 - outnvt [dict]: set dict to receive header name-value tables
attributes: outnvt - outnvt [dict]: set dict to receive header name-value tables
outinfo - outinfo [mat]: set mat to receive content summary info
messages: print - print [filename]: print info of last file to console
bang - get info of last file
get - get [filename] [matrixref]: get info
set - set <filename> [matrixref]: set file name to get info of
outnvt - outnvt [dict]: set dict to receive header name-value tables
outinfo - outinfo [mat]: set mat to receive content summary info
inlets: none
outlets: 1 - duration of SDIF file in milliseconds
2 - summary of data in SDIF file in an FTM mat object, one line per occuring SDIF matrix
3 - NVT (Name-Value Table) header information in an FTM dict of dicts
ftm.sdif.write '
arguments: none
attributes: reserve <number: n> reserve m frame-slots for the write message, without adding inlets
messages: reserve <number: n> reserve m frame-slots for the write message, without adding inlets
close - stop writing and close file
stop - stop writing and close file
record - open, rewind, truncate file and write the header
start - open, rewind, truncate file and write the header
bang - open, rewind, truncate file and write the header
write - write
inlets: 1 - each inlet receives an element or tuple of data (int, float, symbol, fvec, fmat) and writes it to an SDIF frame
outlets: none
ftm.tween '
arguments: 1 - initialize sequence
attributes: none
messages: prev - jump to the position of the previous value
next - jump to the position of the next value
inlets: 1 - position in sequence
2 - set sequence
outlets: 1 - factor corresponding to the position between sucessive values in the sequence (fraction between 0 and 1)
2 - value at or right before the given position
3 - value right after the given position
4 - distance (time in msec) between the values at or before and after the given position
ftm.value '
arguments: 1 - initialize value
attributes: none
messages: bang - output current value
inlets: 1 - value to be stored and output
2 - value to be stored (without output)
outlets: 1 - current value
gbr.slice~ Signal slicing
Cuts incoming signal into frames of given size with given period (hop size).
arguments: 1 <num: size> - frame size [512]
2 <num: size> - hop size [256]
attributes: unit <'samp'|'msec'|'sec': unit> - set time unit to msecs, secs or samples ['samp']
enable <bool: switch> - enable/disable calculation and output ['on']
period <num: size> - set hop size
size <num: size> - set frame size
messages: unit <'samp'|'msec'|'sec': unit> - set time unit to msecs, secs or samples ['samp']
enable <bool: switch> - enable/disable calculation and output ['on']
period <num: size> - set hop size
size <num: size> - set frame size
inlets: 1 - input signal to be sliced into frames
outlets: 1 <fmat: vector> - signal frames
2 <undefined> - no description
Retrieved from "https://ftm2.ircam.fr/index.php?title=FTM_Modules&oldid=2393"