CA_Get_Channel_Play_Status

Purpose

Returns the current play status of a specified channel.

Libraries

Blueworx Voice Response library (libvae.a)

Custom Server library (libca.a)

Syntax

#include "CA_header.h"
int CA_Get_Channel_Play_Status (
 CHANNEL_INFO_ST  *chan_info_sp
 short * state
);

Description

This subroutine returns the current state of the record channel as specified by the chan_info_sp parameter. The current state of the channel will be returned in the state parameter field which can take a value of either CHSTAT_PLAYING when the state of the channel is play, or CHSTAT_NOT_PLAYING for all other states.

Parameters

channel_info_sp

A pointer to a CHANNEL_INFO_ST output structure as returned from a previous call to CA_Open_Record_Channel().

state

A pointer to the data area which will hold the current state of the channel.

Return codes

0

Successful

-1

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

Error names

CA_CHANNEL_NOT_OPEN
CA_NOT_CHANNEL_OWNER
CA_FUNC_FAILED
CA_INV_ADDR
CA_TERMINATING
CA_NOT_INIT

Related information

None.