Filter
Top Products
Voice API for Windows Operating Systems Library Reference — November 2003 297
pause on-going play — dx_pause( )
dx_pause( )
pause on-going play
!
!!
! Description
The dx_pause( ) function pauses an on-going play until a subsequent dx_resume( ) function is
issued. To stop the paused play, use dx_stopch( ). The application will not get an event when
dx_pause( ) is issued. This function does not return an error if the channel is already in the
requested state. This function returns -1 if no play is in progress on the channel.
You can also pause and resume play using a DTMF digit. For more information, see SV_PAUSE
and SV_RESUME in the DX_SVCB data structure and dx_setsvcond( ).
For more information on the pause and resume play feature, see the Voice API Programming
Guide.
!
!!
! Cautions
None.
!
!!
! Errors
An error of -1 is returned if you issue this function when no play is in progress.
If the function returns -1, use the Standard Runtime Library ATDV_LASTERR( ) standard
attribute function to return the error code or ATDV_ERRMSGP( ) to return the descriptive error
message. Possible errors for this function include:
EDX_BUSY
Invalid state. Returned when the function is issued but no play is in progress on the channel.
Name: int dx_pause(chdev)
Inputs: int chdev
• valid channel device handle
Returns: 0 if success
-1 if failure
Includes: srllib.h
dxxxlib.h
Category: I/O
Mode: synchronous
Platform: DM3
Parameter Description
chdev specifies the valid channel device handle obtained when the channel was opened
using dx_open( )