File: README.md

package info (click to toggle)
octave-audio 2.0.9-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 1,632 kB
  • sloc: sh: 2,869; cpp: 886; python: 438; makefile: 228; xml: 21
file content (50 lines) | stat: -rw-r--r-- 1,214 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
Introduction
============

The Octave Audio package provides MIDI device functions for GNU Octave

Requirements
============

* Octave >= 4.0.0

* [RTMIDI](https://github.com/thestk/rtmidi) library and include files 


Installing
==========

To install, run the octave package manager:

1. If running Windows, the package may already be installed:

   pkg list audio

2. To install from source forge:
   pkg install -forge audio

3. To install from a local tarball.
   pkg install audio-XXXXXXX.tar.gz
   Where XXXXXXX is the version of the the downloaded tarball.

Usage:
======

1. Load the package.
   pkg load audio
   (Required each time Octave is started)

2. Type help audio at the octave prompt to display a list of functions

Documentation
==============

See the function list for octave-audio on [octave github](https://gnu-octave.github.io/octave-audio/functions/) for function documentation.

See the online manual for octave-audio on [octave github](https://gnu-octave.github.io/octave-audio/manual/) for complete documentation.

Read the Octave [Octave audio package wiki](https://wiki.octave.org/Audio_package) for install tips and examples.

Known limitations and bugs
==========================