index :: snd

snd.play~

Sound file player on steroids

available since version: 0.9.7

---

information

Supports variable speed playing, pausing, seeking, time-stretching and resampling

arguments:

• N number of output channels
  type: int
  

• NAME absolute or relative to patch sound file name
  type: symbol
  

methods:

• ff fast forward by specified amount of time
  parameters:
  • [TIME] time amount. Can't be in seconds, milliseconds, samples, SMPTE. If the time unit is not specified treat float values as samples. If argument is not specified: jump one second forward.
    type: atom
    
• open sets @name property
  parameters:
  • FILENAME absolute or relative to patch soundfile name
    type: symbol
    required: True
    
• pause pause
  parameters:
  • [FLAG] pause/resume flag. If true or omitted: pause, if false: resume.
    type: bool
    
• rewind move backwards by specified amount of time (relative value)
  parameters:
  • [TIME] time amount. Can't be in seconds, milliseconds, samples, SMPTE. If the time unit is not specified treat float values as milliseconds. If arguments is not specified jump: one second backward.
    type: atom
    
• seek move to specified time (absolute value)
  parameters:
  • [TIME] Time position. Can't be in seconds, milliseconds, samples, SMPTE. If the time unit is not specified treat float values as milliseconds. If arguments is not specified jump: seek to the beginning
    type: atom
    
• start start playing
  parameters:
  • [FLAG] start/stop flag. If true or omitted: start, if false: stop.
    type: bool
    
• stop stop playing
  parameters:
  • [FLAG] start/stop flag. If true or omitted: stop, if false: start.
    type: bool
    

properties:

• @begin Get/set start playing position
  type: atom
  units: samp, sec, ms, smpte
  default: 0
  

• @end Get/set end playing position
  type: atom
  units: samp, sec, ms, smpte
  default: -1
  

• @loop Get/set play in the loop
  type: bool
  default: 0
  

• @n (initonly) Get/set number of output channels
  type: int
  range: 1..32
  default: 2
  

• @name Get/set absolute or relative to patch soundfile name
  type: symbol
  

• @on_err Get/set the error send destination. For example, if soundfile was not found, the message [not_found( will be send to this global name
  type: symbol
  

• @pitch Get/set pitch-shift correction. Used only if @stretch mode enabled.
  type: float
  range: 0.25..4
  default: 1
  

• @speed Get/set playing speed. If @stretch mode is disabled (default): changes playing speed (also with pitch change respectively) in real time. If @stretch mode is enabled: can only change speed (without pitch change) only on the next playing cycle
  type: float
  range: 0.25..4
  default: 1
  

• @stretch Get/set stretch mode. If true: use timestretch and pitch-shifting
  type: bool
  default: 0
  

• @sync Get/set sync mode. 'now': immediately starts playing (abort previous) after receiving start message. 'defer': wait until previous playing will be done, that starts new. 'wait': do not playing until previous playing will not finished
  type: symbol
  enum: now, defer, wait
  default: now
  

inlets:

• 1: start playing, 0: stop
  type: control

outlets:

• first output channel
  type: audio
• … output channel
  type: audio
• n-th output channel
  type: audio
• control output
  type: control

keywords:

play sound

Authors: Serge Poltavsky

License: GPL3 or later