Filter
Top Products
130 Voice API for Windows Operating Systems Library Reference — November 2003
dx_addvoldig( ) — set a DTMF digit to adjust volume
To start play volume at the origin, set digit to NULL and set adjval to SV_NORMAL.
!
!!
! Cautions
• Calls to this function are cumulative. To reset or remove any condition, you should clear all
adjustment conditions and reset if required. For example, if DTMF digit “1” has already been
set to increase play volume by one step, a second call that attempts to redefine digit “1” to the
origin will have no effect on the volume, but will be added to the array of conditions; the digit
will retain its original setting.
• The digit that causes the play adjustment will not be passed to the digit buffer, so it cannot be
retrieved using dx_getdig( ) and will not be included in the result of ATDX_BUFDIGS( )
which retrieves the number of digits in the buffer.
• On DM3 boards, digits that are used for play adjustment may also be used as a terminating
condition. If a digit is defined as both, then both actions are applied upon detection of that
digit.
• On Springware boards, digits that are used for play adjustment will not be used as a
terminating condition. If a digit is defined as both, then the play adjustment will take priority.
!
!!
! Errors
If the function returns -1, use the Standard Runtime Library (SRL) Standard Attribute function
ATDV_LASTERR( ) to obtain the error code or use ATDV_ERRMSGP( ) to obtain a descriptive
error message. One of the following error codes may be returned:
EDX_BADPARM
Invalid parameter
EDX_BADPROD
Function not supported on this board
adjval specifies a speed adjustment value to take effect whenever the digit specified
in digit occurs
On DM3 boards, the following are valid values:
• SV_ADD2DB – increase play volume by 2 dB
• SV_SUB2DB – decrease play volume by 2 dB
• SV_NORMAL – set play volume to origin when the play begins (digit must
be set to NULL)
On Springware boards, the following are valid values:
• SV_ADD2DB – increase play volume by 2 dB
• SV_ADD4DB – increase play volume by 4 dB
• SV_ADD6DB – increase play volume by 6 dB
• SV_ADD8DB – increase play volume by 8 dB
• SV_SUB2DB – decrease play volume by 2 dB
• SV_SUB4DB – decrease play volume by 4 dB
• SV_SUB6DB – decrease play volume by 6 dB
• SV_SUB8DB – decrease play volume by 8 dB
• SV_NORMAL – set play volume to origin when the play begins (digit must
be set to NULL)
Parameter Description