CA_Close_Music_Channel()

Purpose

Closes a music channel.

Libraries

Blueworx Voice Response library (libvae.a)

Custom Server library (libca.a)

Syntax

#include "CA_header.h"
int CA_Close_Music_Channel (
   CHANNEL_INFO_ST * chan_info_sp
)

Description

This subroutine closes a music channel previously opened using the CA_Open_Music_Channel() call. Applications using background music played on this channel will not know that the music has been stopped, but a caller listening to background music may notice that it has stopped.

Parameters

chan_info_sp: A pointer to a CHANNEL_INFO_ST, as returned from a previous call to CA_Open_Music_Channel().

Return codes

0: Successful
-1: Unsuccessful (global error number CA_errno is set to indicate which error)

Error names

CA_CHANNEL_NOT_OPEN
CA_FUNC_FAILED
CA_INV_ADDR
CA_INV_CHANNEL
CA_INTERNAL_FD_ERROR
CA_INTERNAL_CHANNEL_MODE_ERROR
CA_NOT_CHANNEL_OWNER
CA_NOT_INIT
CA_TERMINATING

Related information

CA_Open_Music_Channel(), CA_Play_Voice_Elements(), CA_Play_Voice_Stream(), CA_Poll().