~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/sound/sound.man

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH sound 1 "April 1993" "Scilab Group" "Scilab Function"
2
 
.so ../sci.an
3
 
.SH NAME
4
 
sound -  sound player facility
5
 
.SH CALLING SEQUENCE
6
 
.nf
7
 
sound(y)
8
 
sound(y,fs)
9
 
sound(y,fs,bits)
10
 
.fi
11
 
.SH PARAMETERS
12
 
.TP
13
 
y
14
 
: real vector
15
 
.TP
16
 
fs
17
 
: real number, sampling frequency
18
 
.TP
19
 
bits
20
 
: real number, number of bits (usually 8 or 16)
21
 
.SH DESCRIPTION
22
 
\fVsound(y,fs)\fR sends the signal in vector y (with sample frequency
23
 
fs) out to the speaker. Values in y are assumed to be in the 
24
 
range -1.0 <= y <= 1.0. Values outside that range are ugnored.  
25
 
Stereo sounds are played, on platforms that support it, when y is 
26
 
an N-by-2 matrix. 
27
 
\fVsound(y)\fR plays the sound at the default sample rate of 8192 Hz.
28
 
\fVsound(y,fs,nbits)\fR plays the sound using nbits bits/sample if
29
 
possible.  Most platforms support bits=8 or 16.
30
 
.SH SEE ALSO
31
 
playsnd
32
 
 
33
 
 
34
 
 
35
 
 
36