Table of Contents

Index

NMS Glossary

Previous Page

Next Page

(Page 67 of 69 in this chapter) Version

adiSubmitRecordBuffer

Description

Supplies an empty buffer to an asynchronous record operation that was initiated using adiRecordAsync.

Prototype

DWORD adiSubmitRecordBuffer ( CTAHD ctahd,
void *buffer,
unsigned size)
ctahd CTA context handle returned by ctaCreateContext.
buffer Pointer into process memory where recorded voice data will be written.
size Size of the buffer (bytes).

Return Values

SUCCESS
ADIERR_TOO_MANY_BUFFERS
More than two buffers have been submitted (a maximum of two buffers may be submitted to a record operation at any given time).
CTAERR_BAD_ARGUMENT
buffer is NULL.
CTAERR_BAD_SIZE
size is zero.
CTAERR_FUNCTION_NOT_ACTIVE
Either not recording, or the recording operation was not initiated by calling adiRecordAsync.
CTAERR_INVALID_CTAHD
CTAERR_INVALID_SEQUENCE
adiStopRecording has already been invoked.
CTAERR_INVALID_STATE

Events

ADIEVN_RECORD_BUFFER_FULL
Generated by the ADI service when a buffer is filled with recorded voice data.
The event will contain the following fields:

buffer Pointer to a previously submitted user buffer.
size Number of bytes recorded into buffer.
value Flags; if the ADI_RECORD_BUFFER_REQ bit is set, more buffers are needed and the application must submit another empty buffer. If the ADI_RECORD_UNDERRUN bit is set, an underrun occurred. There was no new buffer to record information when this one was completed.

ADIEVN_RECORD_DONE
Generated by the ADI service when the record operation terminates. The event size field contains the total number of bytes recorded during the function instance. The value field contains one of the following termination reasons, or an error code:
CTA_REASON_DIGIT
Aborted due to DTMF.
CTA_REASON_NO_VOICE
The remote party never spoke.
CTA_REASON_RELEASED
The call was terminated.
CTA_REASON_STOPPED
Stopped by application request.
CTA_REASON_TIMEOUT
The maximum record limit reached.
CTA_REASON_VOICE_END
The remote party stopped speaking.
CTAERR_xxx or ADIERR_xxx
Error code indicates record failed.

Details

This function allows the application to asynchronously submit empty buffers to a record operation, provided that the: Record operation was initiated by calling adiRecordAsync. Record operation is active. Application does not already have two buffers actively submitted.
Refer to the ADI Service Developer's Manual for details concerning asynchronous record operations.
Note: The ADI service truncates the size so that the effective size is a multiple of the encoding framesize selected in adiRecordAsync. If the effective size is zero, then CTAERR_BAD_SIZE is returned.

See Also

adiRecordAsync, adiStopRecording, adiGetRecordStatus

Example

Refer to the playrec demonstration program.

Table of Contents

Index

NMS Glossary

Previous Page

Next Page

(Page 67 of 69 in this chapter) Version

Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com

Copyright © 2000, Natural MicroSystems, Inc. All rights reserved.