Skip to content

Commit

Permalink
Clarify documentation of MultiChannel methods
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinstadler committed Dec 22, 2023
1 parent 09b69b7 commit 75e4d7b
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions src/processing/sound/MultiChannel.java
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
import com.jsyn.unitgen.ChannelOut;

/**
* Controls the routing of sounds on multi-channel devices
* This class provides methods for querying the multi-channel output
* capabilities of audio devices, and for providing fine-grained control for the
* routing of sounds when outputting on a device with more than 2 channels.
*
* @webref I/O:MultiChannel
*/
Expand Down Expand Up @@ -86,10 +88,11 @@ public static void disconnectFromOutput(SoundObject o, int channel) {
}

/**
* Gets the number of output channels available on an output device
* Gets the number of output channels available on a given device
*
* @param deviceId if none is given, gets information about the current device.
* @return the number of output channels available on the current output device
* @param deviceId the id of the device whose number of output channels should
* be returned. If none is given, gets information about the current device.
* @return the number of output channels available on the given device
*
* @webref I/O:MultiChannel
* @see Sound#outputDevice(int)
Expand Down

0 comments on commit 75e4d7b

Please sign in to comment.