/usr/share/SuperCollider/HelpSource/Classes/ServerMeterView.schelp is in supercollider-common 1:3.8.0~repack-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 | TITLE:: ServerMeterView
summary:: A GUI widget that displays input/output levels
categories:: GUI>Views
related:: Classes/ScopeView, Classes/FreqScopeView, Classes/ServerMeter
DESCRIPTION::
A link::Classes/ServerMeterView:: is a modular widget for showing the volume levels of inputs/outputs on the server. link::Classes/ServerMeterView:: can be embedded inside of your custom graphical user interfaces just like a button or slider.
note::
If you are looking for a quick input/output levels display without having to build your own GUI from scratch, see link::Classes/ServerMeter:: and link::Classes/Server#-meter::
::
CLASSMETHODS::
METHOD:: height
Get the height in pixels of the standard link::Classes/ServerMeterView:: widget
returns:: an link::Classes/Integer::
METHOD:: getWidth
Get the width in pixels of a link::Classes/ServerMeterView:: widget with the given number of inputs and outputs
ARGUMENT:: numIns
number of inputs used to calculate the width
ARGUMENT:: numOuts
number of outputs used to calculate the width
ARGUMENT:: server
the server
returns:: an link::Classes/Integer::
METHOD:: new
Create a new link::Classes/ServerMeterView:: instance
ARGUMENT:: aserver
The link::Classes/Server:: whose inputs/outputs will be monitored
ARGUMENT:: parent
The parent link::Classes/View:: or link::Classes/Window:: where the new link::Classes/ServerMeterView:: will be embedded.
ARGUMENT:: leftUp
Where to position the new link::Classes/ServerMeterView:: inside the parent. strong::leftUp:: must be a link::Classes/Point::, describing where to place the upper left corner of the new link::Classes/ServerMeterView::.
ARGUMENT:: numIns
The number of inputs to monitor
ARGUMENT:: numOuts
The number of outputs to monitor
returns:: A new link::Classes/ServerMeterView::
INSTANCEMETHODS::
METHOD:: view
get the link::Classes/CompositeView:: used to construct the various elements of the link::Classes/ServerMeterView:: widget
returns:: a link::Classes/CompositeView::
METHOD:: remove
Removes this link::Classes/ServerMeterView:: from its parent view (if any) and then destroys it. Once this method is called you can no longer use this link::Classes/ServerMeterView::.
METHOD:: start
Enable the monitoring of input/outputs
returns:: this link::Classes/ServerMeterView::
METHOD:: stop
Disable the monitoring of input/outputs
returns:: this link::Classes/ServerMeterView::
PRIVATE:: setSynthFunc, startResponders, init
EXAMPLES::
subsection::Simple Usage
code::
// make a window and embed a ServerMeterView inside of it.
w = Window.new("Server Levels");
ServerMeterView.new(s, w, 0@0, 2, 2);
w.front; // show the window
::
subsection::A More Complex Example
code::
// make a GUI to monitor two servers running simultaneously
s = Server.local;
q = Server.internal;
s.boot; q.boot; // wait a moment for the servers to boot
// make a window big enough to hold 2 ServerMeterViews
r = Rect(0, 0, ServerMeterView.getWidth(2, 2) * 2, ServerMeterView.height)
w = Window.new("Local | Internal", r);
// make one ServerMeterView to monitor the input/output of each server
ServerMeterView.new(s, w, Point(0,0), 2, 2);
ServerMeterView.new(q, w, Point(ServerMeterView.getWidth(2,2), 0), 2, 2);
w.front; // show the window
::
|