view release on metacpan or  search on metacpan

lib/Audio/Nama/Help.pm  view on Meta::CPAN

HELP

project => <<'PROJECT',
   load-project, load      - load an existing project, e.g 'load <project-name>'
   create-project, create  - create a new project (usually under $HOME/nama/project-name/)
   list-projects, lp       - list all projects
   undo                    - go back in time to the state before the last command
   redo                    - reapply the step rolled back by undo
   exit, quit              - exit program, saving state 


PROJECT

track_basics => <<'TRACKBASICS',
   add-track, add          - Create a new track

      Example: add sax     - Add a new track 'sax', mono by default.
                           - Sax is selected, and receives next commands.
               source 3    - Use soundcard channel 3 as input
               rec         - Arm for recording an audio file (e.g. sax_1.wav)
               start       - Start engine, begin recording
               stop        - Stop engine, close file and queue for playback
     
               <SPACE> can be used at the prompt to start and stop engine
   
      Example: add piano; source synth; stereo; rec
   
      This line of commands prepares to record track 'piano' in stereo 
      width from JACK client 'synth'. Use of semicolons allow several 
      commands in one line of input.

   import-audio, import    - Import a .wav file, resampling if necessary
   remove-track            - Remove effects, parameters and GUI for current track
TRACKBASICS

track_status => <<'TRACKSTATUS',

Prepare conditions for next engine run

   rec              -  REC: record and monitor audio source
   mon              -  MON: monitor audio source
   play             -  PLAY: queue .wav file for playback
   off              -  OFF: omit track from audio network
   show-tracks,show - show status, all tracks
   show-track,sh    - show status of current track, including effects, versions, etc.
   chains           - show the audio network configuration
TRACKSTATUS


wav_versions => <<'WAV_VERSIONS',
   list-version, lver       - list version numbers of audio files in the current track
                            - (this information also appears in the show-track listing)
   set-version, version, n  - select a version number for the current track

A track can record multiple audio files ('takes'). The audio filenames
follow the trackname so that recording a track named 'piano' will
produce files with names with names like piano_1.wav, piano_2.wav.
Audio files recorded by Nama are considered immutable resources and
stored outside of version control.

One version can be selected as streaming source when when the track is
set to PLAY. The version number is zero by default, which means
select the most recent (highest numbered) take. The bus-version command
will set default version number for all tracks belonging to the current 
bus.
WAV_VERSIONS

transport => <<TRANSPORT,
   start, t, SPACE    -  Start processing. SPACE must be at beginning of command line.
   stop, s, SPACE     -  Stop processing. SPACE must be at beginning of command line.
   rewind, rw         -  Rewind  some number of seconds, i.e. rw 15
   forward, fw        -  Forward some number of seconds, i.e. fw 75
   setpos, sp         -  Set the playback head position, i.e. setpos 49.2
   getpos, gp         -  Get the current head position 
   jump-to-start, beg   - set playback head to beginning of audio file(s)
   jump-to-end, end     - set playback head to end
TRANSPORT
track_fader => <<'TRACKFADER',
   Track volume/pan fader can be used to change settings for the current track.

   pan, p                   -  get/set pan position
   pan-back, pb             -  restore pan after pr/pl/pc  
   pan-center, pc           -  set pan center    
   pan-left, pl             -  pan track fully left    
   pan-right, pr            -  pan track fully right    
   volume, vol              -  set or adjust track volume (in dB)
       Examples:
       vol 0   (set level to 0 dB or unity gain)
       vol -20 (set level to -20 dB)
       vol - 3 (reduce vol by 3 dB) 
                                      
   unity                    -  set volume gain to unity
   mute, c, cut             -  mute track volume 
   unmute, nomute, uncut, C -  restore muted volume
   solo                     -  mute all tracks but current track
   all, nosolo              -  return to pre-solo status
TRACKFADER
effect_info => <<'EFFECT_INFO',
   ladspa-register, lrg     - list LADSPA effects
   preset-register, prg     - list Ecasound presets
   ctrl-register, crg       - list Ecasound controllers 
   find-effect, fe          - list available effects matching arguments
                              example: find-effect reverb
   help-effect, he          - full information about an effect 
                              example: help-effect 1209 
                                (information about LADSPA plugin 1209)
                              example: help-effect valve
                                (information about LADSPA plugin valve)
EFFECT_INFO
effect_manipulation => <<'EFFECT_DO',
   add-effect,     afx           - add an effect to the current track
                                   Example: afx ea 50
   add-controller, acl           - add an Ecasound controller to the parameter
                                   of an effect  
   insert-effect,  ifx           - insert an effect before another effect
   modify-effect,  mfx           - set, increment or decrement effect parameter
   remove-effect,  rfx           - remove an effect or controller
   append-effect,  apfx          - add effect to the end of current track effect list 
   bypass-effects, bypass, bye   - suspend current track effects except vol/pan
   restore-effects, restore, ref - restore track effects
EFFECT_DO