SF.net SVN: supercollider:[7695] trunk/build/Help/ServerArchitecture/ ServerOptions.html

View: New views

1 Messages — Rating Filter: Alert me

SF.net SVN: supercollider:[7695] trunk/build/Help/ServerArchitecture/ ServerOptions.html

by danstowell :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Revision: 7695
http://supercollider.svn.sourceforge.net/supercollider/?rev=7695&view=rev
Author: danstowell
Date: 2008-07-21 18:44:03 +0000 (Mon, 21 Jul 2008)

Log Message:
-----------
Update documentation for ServerOptions re Axel Balley's patch to expose in/out device options

Modified Paths:
--------------
trunk/build/Help/ServerArchitecture/ServerOptions.html

Modified: trunk/build/Help/ServerArchitecture/ServerOptions.html
===================================================================
--- trunk/build/Help/ServerArchitecture/ServerOptions.html 2008-07-21 18:33:34 UTC (rev 7694)
+++ trunk/build/Help/ServerArchitecture/ServerOptions.html 2008-07-21 18:44:03 UTC (rev 7695)
@@ -5,29 +5,30 @@
<meta http-equiv="Content-Style-Type" content="text/css">
<title></title>
<meta name="Generator" content="Cocoa HTML Writer">
-<meta name="CocoaVersion" content="949.33">
+<meta name="CocoaVersion" content="824.48">
<style type="text/css">
p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; min-height: 12.0px}
-p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; color: #0000ff}
+p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; color: #0027ee}
p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px Helvetica}
p.p6 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 9.0px Monaco; min-height: 12.0px}
p.p7 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 12.0px Helvetica}
p.p8 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 12.0px Helvetica; min-height: 14.0px}
p.p9 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 14.0px Helvetica}
p.p10 {margin: 0.0px 0.0px 0.0px 85.0px; text-indent: -85.0px; font: 12.0px Helvetica}
-p.p11 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #bf0000}
-p.p12 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #000000; min-height: 12.0px}
-p.p13 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #000000}
-p.p14 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #0000bf}
+p.p11 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #992b19}
+p.p12 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco}
+p.p13 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #0030b5}
span.s1 {font: 18.0px Helvetica}
-span.s2 {color: #0000ff}
+span.s2 {color: #0040f2}
span.s3 {color: #000000}
-span.s4 {font: 9.0px Monaco}
-span.s5 {color: #0000bf}
-span.s6 {color: #606060}
-span.s7 {color: #007300}
+span.s4 {text-decoration: underline}
+span.s5 {color: #0000ff}
+span.s6 {font: 9.0px Monaco}
+span.s7 {color: #0030b5}
+span.s8 {color: #606060}
+span.s9 {color: #41691a}
span.Apple-tab-span {white-space:pre}
</style>
</head>
@@ -42,7 +43,7 @@
 
N.B. A ServerOptions' instance variables are translated into commandline arguments when a server app is booted. Thus a running Server must be rebooted before changes will take effect. There are also a few commandline options which are not currently encapsulated in ServerOptions. See <a href="Server-Architecture.html">Server-Architecture</a> for more details.
 
-See also: <a href="Server.html">Server</a>, <a href="Server-Architecture.html">Server-Architecture</a>, and <a href="Server-Command-Reference.html">Server-Command-Reference</a>.
+See also: <a href="Server.html">Server</a>, <a href="Server-Architecture.html">Server-Architecture</a>, and <a href="Server-Command-Reference.html">Server-Command-Reference</a>.
 
Creation / Class Methods
 
@@ -50,6 +51,18 @@
 
 Create and return a new instance of ServerOptions.
 
+ *devices
+ 
+ Return an <a href="../Collections/Array.html">Array</a> of <a href="../Collections/String.html">Strings</a> listing the audio devices currently available on the system.
+ 
+ *inDevices
+ 
+ Return an <a href="../Collections/Array.html">Array</a> of <a href="../Collections/String.html">Strings</a> listing the audio devices currently available on the system which have input channels.
+ 
+ *outDevices
+ 
+ Return an <a href="../Collections/Array.html">Array</a> of <a href="../Collections/String.html">Strings</a> listing the audio devices currently available on the system which have output channels.
+ 
 
Accessing Instance and Class Variables (The Options)
 
@@ -61,7 +74,17 @@
 device_(arg1)
 device
 
- A String that allows you to chose a sound device. The default, nil will use the system's default device (more below in the examples).
+ A String that allows you to choose a sound device to use as input and output. The default, nil will use the system's default input and output device(s) (more below in the examples). 
+ 
+ inDevice_(arg1)
+ inDevice
+ 
+ A String that allows you to choose an input sound device. The default, nil will use the system's default input device (more below in the examples).
+ 
+ outDevice_(arg1)
+ outDevice
+ 
+ A String that allows you to choose an output sound device. The default, nil will use the system's default output device (more below in the examples).
 
 hardwareBufferSize_(arg1)
 hardwareBufferSize
@@ -173,7 +196,7 @@
 Returns a <a href="../Collections/String.html">String</a> specifying the options in the format required by the command-line scsynth app.
 port - The port number for the resulting server app. Default value is 57110.
 
- firstPrivateBus
+ firstPrivateBus
 
 Returns the index of the first audio bus on this server which is not used by the input and output hardware.
 
@@ -183,36 +206,36 @@
Examples
 
// Get the local server's options
- 
-o = Server.local.options;
- 
+ 
+o = Server.local.options;
+ 
// Post the number of output channels
- 
-o.numOutputBusChannels.postln;
- 
+ 
+o.numOutputBusChannels.postln;
+ 
// Set them to a new number
- 
+ 
o.numOutputBusChannels = 6; // The next time it boots, this will take effect
- 
+ 
// specify a device
- 
-o.device ="MOTU Traveler"; // use a specific soundcard
-o.device = nil; // use the system default soundcard
- 
+ 
+o.device ="MOTU Traveler"; // use a specific soundcard
+o.device = nil; // use the system default soundcard
+ 
// Create a new instance of ServerOptions
- 
-o = ServerOptions.new;
- 
+ 
+o = ServerOptions.new;
+ 
// Set the memory size to twice the default
- 
-o.memSize = 4096;
- 
+ 
+o.memSize = 4096;
+ 
// Create a new Server on the local machine using o for its options
- 
-t = Server(\Local2, NetAddr("127.0.0.1", 57111), o);
-t.makeWindow;
-t.boot;
-t.quit;
 
+t = Server(\Local2, NetAddr("127.0.0.1", 57111), o);
+t.makeWindow;
+t.boot;
+t.quit;
+ 
</body>
</html>

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

_______________________________________________
sc-dev mailing list

info (subscribe and unsubscribe): http://swiki.hfbk-hamburg.de:8888/MusicTechnology/880
archive: http://www.listarc.bham.ac.uk/marchives/sc-dev/
search: http://www.listarc.bham.ac.uk/lists/sc-dev/search/

LightInTheBox - Buy quality products at wholesale price