CA_Create_Audio_Name()

Purpose

Creates an audio name.

Libraries

Blueworx Voice Response library (libvae.a)

Custom Server library (libca.a)

Syntax

#include "CA_header.h"
#include "CA_access_db.h"
int CA_Create_Audio_Name (
 AUDIO_NAME_INFO_ST  *audio_name_info_sp,
 unsigned long       start_element,
 unsigned long       element_count,
 unsigned char       *voice_data
);

Description

This subroutine creates an audio name by storing voice data referenced by the AUDIO_NAME_INFO_ST structure in the Blueworx Voice Response database. This structure determines whether the audio name is compressed or uncompressed.

The function is similar to the RecordAudioName state table action. Before calling this subroutine, the real voice data should already be accessible by the calling routine. The calling routine can then specify the starting voice element and the number of voice elements to add to the audio name.

If the audio name is very large, you may not want to pass the entire data in a single call to this subroutine. In this case, you can call the routine several times, with appropriate values for start_element, element_count, and voice_data. A return code of 0 indicates that the audio name is complete.

Parameters

audio_name_info_sp

A pointer to an AUDIO_NAME_INFO_ST input structure that is filled in as described in AUDIO_NAME_INFO_ST.

If the audio name specified by the AUDIO_NAME_INFO_ST structure already exists, the existing audio name is deleted. This happens whether the existing audio name is compressed or uncompressed.

start_element

Starting voice element (range from 1 to total_elements). If you are creating the entire audio name with a single call to this subroutine, the value of start_element will be 1.

element_count

Number of voice elements to add to the audio name (range from 1 to total_elements). If you are creating the entire audio name with a single call to this subroutine, the value of element_count will be the same as total_elements.

voice_data

Address of the voice data.

Return codes

0

Successful (entire audio name data stored in database)

>0

Successful number of voice elements left to be added to database

-1

Unsuccessful (global error number CA_errno is set to indicate the error)

Error names

CA_ACCESS_NOBUFS
CA_DISK_FULL
CA_INV_ADDR
CA_INV_COMPRESSION_TYPE
CA_INV_MAILBOX_ID
CA_INV_PROFILE_ID
CA_INV_ELEMENT_COUNT
CA_INV_REQUEST
CA_INV_START_ELEMENT
CA_INV_TOTAL_ELEMENTS
CA_INV_VOICE_ELEMENT
CA_NO_MSG_RECV
CA_NOT_INIT
CA_OM_REQ_FAILED
CA_REQ_FAILED
CA_TERMINATING

Related information

CA_Delete_Audio_Name(), CA_Get_Audio_Name(), CA_Get_Audio_Name_Info(), CA_Import_Voice().