AudioClaim

Message

AudioClaim <audiodevicenumber> [–alias <alias>]

AudioClaim <devicegroup> <devicename> [–alias <alias>]

Originator

Client

Details

Suppose there are four physical stereo sound cards in the server. By default, the server is configured to allocate these as audio devices 0–3. However, each sound card may be split to isolate the left and right stereo channels, in order to double the number of available sound devices. In this case, the audio devices would be numbered 0–7, where device 0 is the left channel of the first sound card, 1 is the right channel of the first card, 2 the left channel of the second card, etc.

Note that this is a server-side feature, configured on the server console.

If you need one client wants to address the left and right channels of a single sound card independently, you can either split the sound cards and have the client control two notional audio devices (left and right), or leave them as stereo devices and allow the client to provide a stereo sound source.

As with lines, you can give the audio device an alias as you claim it.

Server device names. If you use the second form of the command, the device specified by the combination of the devicegroup and devicename parameters is claimed.

Response

SyntaxError: insufficient parameters to AudioClaim

SyntaxError: invalid parameters to AudioClaim

ClaimAccepted: <audiodevicenumber>

ClaimRejected: <audiodevicenumber> <reason>

ClaimRejected: group/device <devicegroup>/<devicenumber> not recognized

For example,

       ClaimRejected: 112 is a non-existent audio device

       ClaimRejected: 5 is already claimed        

Response (immediate socket)

Either of

       Success

       Failure

If you request an alias, you will only get Success if the alias command also succeeds.        

Revision history

Implemented by WhiskerServer version 2.3.

See also