Stops the play operation.
AG
CG
DWORD adiStopPlaying ( CTAHD ctahd)
|
Argument |
Description |
|
ctahd |
Context handle returned by ctaCreateContext or ctaAttachContext. |
|
Return value |
Description |
|
SUCCESS |
|
|
CTAERR_FUNCTION_NOT_ACTIVE |
Attempt made to stop a function that was not running. |
|
CTAERR_INVALID_CTAHD |
Context handle is invalid. |
|
CTAERR_INVALID_SEQUENCE |
Attempt made to stop a function that is already being stopped. |
|
CTAERR_INVALID_STATE |
Function not available in the current port state. |
|
CTAERR_SVR_COMM |
Server communication error. |
|
Event |
Description |
|
ADIEVN_PLAY_DONE |
After playing stops, the ADI service generates a DONE event with the value field set to CTA_REASON_STOPPED. |
Use adiStopPlaying to stop the play operation started by either adiStartPlaying, adiPlayFromMemory, or adiPlayAsync. When the DONE event is received, you can restart the play operation and any other operation requiring voice output.
For more information, refer to Playing.