CA_TDD_Play_String()

Purpose

Play text as TDD characters.

For information on TDD, refer to the Blueworx Voice Response for AIX: Designing and Managing State Table Applications information.

Libraries

Blueworx Voice Response library (libvae.a) Custom Server library (libca.a) TDD library (libtdd.a)

C Syntax

#include “CA_header.h”
#include “CA_access_db.h”
int CA_TDD_Play_String (
 CHANNEL_INFO_ST   *channel_info_sp,
 char              *string
);

Description

This subroutine converts the specified ASCII text string to TDD characters and plays them on the specified channel. It is similar to CA_Play_Voice_Stream(), but takes a string as input instead of digitized voice data.

Parameters

channel_info_sp: A pointer to a CHANNEL_INFO_ST structure, returned from a previous CA_Open_Channel(), filled in as described in CHANNEL_INFO_ST.
string: Contains the text to be converted into TDD characters. The text must consist of valid TDD characters, as described in Valid TDD Characters.

Return codes

0: Successful
-1: Unsuccessful (CA_errno is set to an error code that indicates the error)

Error names

CA_CHANNEL_NOT_OPEN
CA_CHANNEL_WOULD_BLOCK
CA_FUNC_FAILED
CA_INV_ADDR
CA_INV_CHANNEL
CA_INV_CHANNEL_MODE
CA_INV_TDD_CHARS
CA_INV_VOICE_FORMAT
CA_NOT_CHANNEL_OWNER
CA_MALLOC_FAILED
CA_NOT_INIT
CA_TERMINATING

Related information

CA_TDD_Create_Segment(), CA_Play_Voice_Elements(), CA_Play_Voice_Stream(), CA_Open_Channel(), and CA_Close_Channel().