index :: array

array.play~

aliases: [array.p~]

array player with variable speed and amplitude

available since version: 0.9.1

---

arguments:

• ARRAY array name
  type: symbol
  

• SPEED play speed
  type: float
  

methods:

• pause pause/resume playback
  parameters:
  • [anonym=1] if true: pause, else resume playing
    type: int
    

• play start playback from current play position
  

• range set @begin and @end property
  parameters:

  • BEGIN begin position. If float value given: interpret as phase in [0..1] range. Otherwise unit value expected. Examples: 10ms, 5%, 4sec, 20samp etc.
    type: atom
    required: True
    

  • END end position. Value type same as for first argument
    type: atom
    required: True
    

• stop stop playback and reset play position
  

properties:

• @array Get/set array name
  type: symbol
  

• @begin Get/set playback start position. Negative value means position relative to the end of the array
  type: float
  units: samp
  default: 0
  

• @end Get/set playback end position. Negative value means position relative to the end of the array
  type: float
  units: samp
  default: -1
  

• @speed Get/set playback speed. Negative value means reversed playback
  type: float
  default: 1
  

• @amp Get/set playback amplitude
  type: float
  min value: 0
  default: 1
  

• @loop Get/set samplewise loop playing mode
  type: bool
  default: 0
  

• @interp Get/set interpolation type. 0: no interpolation 1: linear, 3: cubic.
  type: int
  enum: 0, 1, 3
  default: 1
  

• @clock Get/set clock output period. Zero means: no clock output (by default).
  type: float
  units: sec
  range: 0..20
  default: 0
  

• @cfmt Get/set clock output format
  type: symbol
  enum: sec, ms, samp, phase
  default: sec
  

• @state (readonly) Get playing state. 0: stopped, 1: playing, 2: paused.
  type: int
  default: 0
  

• @cursor_ms Get/set current play position
  type: float
  units: ms
  default: 0
  

• @cursor_sec Get/set current play position
  type: float
  units: sec
  default: 0
  

• @cursor_phase Get/set current play position
  type: float
  default: 0
  

• @cursor_samp Get/set current play position
  type: float
  units: samp
  default: 0
  

• @select_samp Get/set selection range
  type: list
  units: samp
  default: 0 0
  

• @select_ms Get/set selection range
  type: list
  units: ms
  default: 0 0
  

• @select_sec Get/set selection range
  type: list
  units: sec
  default: 0 0
  

• @select_phase Get/set selection range in [0, 1] range
  type: list
  default: 0 0
  

inlets:

• resets play position and starts playback
  type: control

outlets:

• played signal
  type: audio
• output current playing position according to @cfmt property. By default output seconds
  type: control
• output bang when finished
  type: control

keywords:

array play

See also: [tabplay~]

Authors: Serge Poltavsky

License: GPL3 or later