adiRecordToMemory

Initiates recording of an RTP stream into a single memory-resident buffer.

Supported board types

• AG

• CG

Prototype

DWORD adiRecordToMemory ( CTAHD ctahd, unsigned encoding, void *buffer, unsigned bufsize, ADI_RECORD_PARMS *parms)

Return values

Events

Details

When recording or playing speech files on AG boards, a specific DSP file must be loaded for each encoding type. For more information, refer to Voice encoding formats.

When recording or playing speech files on CG boards, a specific DSP file must be loaded for each encoding type except when using the native play and record feature. The native play and record feature combines an ADI port with an MSPP endpoint and plays or records speech data directly to or from an IP endpoint with no transcoding. For information on the native play and record feature, refer to Performing NMS native play and record.

For more information, see Encoding formats and DSP files. The table lists the DSP files that must be loaded on the AG and CG boards. Refer to the board installation and developer's manual for MIPS usage.

Use adiRecordToMemory to initiate recording to memory-resident buffer of size bufsize and return to the application. The ADI service records data into the buffer until one of the terminating conditions described in ADIEVN_RECORDING_DONE occurs.

Note: You cannot initiate a record operation while playing voice or generating tones unless you disable the record beep by setting either ADI_RECORD.beeptime or ADI_RECORD.beepfreq to 0 (zero). You cannot start a record operation if the energy detector is active, unless both ADI_RECORD.novoicetime and ADI_RECORD.silencetime are 0 (zero).

For more information, refer to Recording.

See also

adiCommandRecord, adiGetEncodingInfo, adiSetNativeInfo, adiStopRecording

Example

/*  Record to supplied buffer, stopping after 1 second of silence. */
int myRecord( CTAHD ctahd, unsigned encoding,
          void *buf, unsigned bufsize, unsigned *bytesrecorded )
{
    ADI_RECORD_PARMS parms;
    CTA_EVENT        event;
    unsigned         datarate;                /* average bytes/sec */
    int              myret;
    unsigned         silencetime = 1000;
    unsigned         trimsize = 0;

    /* Modify default silence timeout */
    ctaGetParms (ADI_RECORD_PARMID, &parms, sizeof parms);
    parms.silencetime = silencetime;

    if( adiRecordToMemory (ctahd, encoding, buf, bufsize, &parms) != SUCCESS )
        return MYFAILURE;

    do
    {
        myGetEvent( &event );          /* see ctaWaitEvent example */
    } while (event.id != ADIEVN_RECORD_DONE);

    switch (event.value)
    {
        case CTA_REASON_FINISHED:                 /* Buffer filled */
            myret = SUCCESS;
            break;

        case CTA_REASON_NO_VOICE:             /* No voice detected */
            *bytesrecorded = 0;
            myret = SUCCESS;
            break;

        case CTA_REASON_RELEASED:       /* The call was terminated */
            myret = MYDISCONNECT;
            break;

        case CTA_REASON_STOPPED:    /* adiStopRecording was called */
        case CTA_REASON_DIGIT:         /* Aborted due to touchtone */
                      /* DTMF is trimmed automatically by AG board */
            *bytesrecorded = event.size;
            myret = SUCCESS;
            break;
        case CTA_REASON_VOICE_END:          /* Silence after voice */
            *bytesrecorded = event.size;
            adiGetEncodingInfo (ctahd, encoding, NULL, &datarate, NULL);
            trimsize = datarate * silencetime / 1000;
            myret = SUCCESS;
            break;

        default:                             /* an error code      */
            myret = MYFAILURE;
            break;
    }

    if (myret == SUCCESS)
    {
        if (*bytesrecorded > trimsize)
            *bytesrecorded -= trimsize;
        else
            *bytesrecorded = 0;
    }

    return myret;
}