index :: array

array.vplay

simple array player for using with vline~

available since version: 0.5

---

arguments:

• ARRAY array name
  type: symbol
  

methods:

• play start playing
  

• range set play range.
  parameters:

  • VALUE start value. Negative values (offset from end) are supported for ms, sec and sample units. -1 sample means last sample.
    type: float
    required: True
    

  • UNIT value unit
    type: symbol
    required: True
    

  • [VALUE] end value
    type: float
    

  • UNIT value unit
    type: symbol
    required: True
    

• stop stop playing
  

properties:

• @array Get/set array name
  type: symbol
  

• @state (readonly) Get player state
  type: symbol
  enum: play, stop
  default: stop
  

• @speed Get/set play speed
  type: float
  min value: 0.1
  default: 1
  

• @begin Get/set begin position in samples
  type: int
  units: samp
  default: 0
  

• @end Get/set end position in samples
  type: int
  units: samp
  default: -1
  

• @abs_begin (readonly) Get absolute start position in samples
  type: int
  units: samp
  default: 0
  

• @abs_end (readonly) Get absolute stop position in samples
  type: int
  units: samp
  default: 0
  

• @reversed Get/set playing backwards (if set to 1)
  type: bool
  default: 0
  

inlets:

• start playing from the beginning
  type: control

outlets:

• message to vline~ object
  type: control
• bang after playing finished
  type: control

keywords:

array play vline

See also: [list.each]

Authors: Serge Poltavsky

License: GPL3 or later