Simple Sound for Small Devices
libsssd
last updated: 03 JUN 2003 (v0.6)

Function Name:  sssd_ctrlDevice

   Allows program to control supported parameters of the playback hardware.   Arguments are passed as tag-parameter paris in a float array.

C Prototype:

int sssd_ctrlDevice( struct sssdaudio* ga, float *parmArray);

  Other Prototypes:



Arguments:


struct gameaudio *ga

    Pointer to an initialized sssdaudio structure (returned by sssd_initAudio)

float *parmArray (tag pair list)

    An float array containing a taglist of parameters and values, terminated with CTRL_D_END.  All values for ctrlDevice parameters are normalized floating point numbers except where noted.   Currently, supported parameters are:

CTRL_D_VOLUME
    Sets the master volume of the playback device (PCM volume under Linux)

CTRL_D_PAN
    Sets the master pan of the playback device (not supported on all platforms.

CTRL_D_ARRAY
    The parameter is a pointer to a float array containting token-parameter pairs.

Returns:


0
    Success

ERR_DEVICE_UNKNOWN
    A parameter supplied was not recognized.   ctrlDevices() will process all tag pairs in the list regardless if it encounters one it does not recognize (unrecognized tags are skipped).  This error can be safely ignored.

Example:


float parmArray[]={CTRL_D_VOLUME, 1.0, CTRL_D_PAN, 0.5, CTRL_D_END};
ctrlDevice(ga, parmArray);


libsssd (c)2003 Patrick Roberts created from libgaudio (c) 1999-2000 A. Schiffler.  Release as open source under MPL 1.1.  Documentation (c)2003 Patrick Roberts.