Stops the currently active play or record.

DWORD vceStop ( CTAHD ctahd)

ctahd Handle returned by ctaCreateContext.

• SUCCESS
• CTAERR_INVALID_CTAHD
• CTAERR_INVALID_SEQUENCE
  Already stopping.

• VCEEVN_PLAY_DONE or VCEEVN_RECORD_DONE
  Playing or recording completed. The value field of the event contains CTA_REASON_STOPPED.

This function sends a command to the player/recorder service to stop playing or recording. Successful completion of the command is indicated with a VCEEVN_PLAY_DONE event or a VCEEVN_RECORD_DONE event with the value field of the event containing CTA_REASON_STOPPED. If playing or recording had already ended when the stop command was sent, the event will contain a different reason.

Because play or record may have already ended, this function returns SUCCESS even if play and record is not active. Therefore, a return of SUCCESS does not guarantee that a DONE event is pending. It is up to the application to determine whether play or record was started and, therefore, whether or not to expect a DONE event.

vcePlay, vcePlayList, vcePlayMessage, vceRecord, vceRecordMessage

/* Play message until stopped by keyboard event*/
extern CTAHD      CtaHd;
extern CTAQUEUEHD CtaQueueHd;

void myPlayMessage (VCEHD vh, unsigned message)
{
    CTA_EVENT event;

    vcePlayMessage (vh, message, NULL);
    do
    {
        ctaWaitEvent( CtaQueueHd, &event, CTA_WAIT_FOREVER);
        if (event.id == KBDEVN_KEY)
            vceStop(CtaHd);
    } while (event.id != VCEEVN_PLAY_DONE); /* Ignore other events */
}