APauseAudio(3X) — Series 700 Only

NAME

APauseAudio − pause the specified audio transaction

SYNOPSIS

#include <audio/Alib.h>

void APauseAudio (

Audio *audio,

ATransID xid,

ATransStatus *trans_status_return,

long *status_return

);

DESCRIPTION

APauseAudio() pauses the transaction specified in xid. To continue with the operation, call AResumeAudio().

While one transaction is paused, another transaction can play or record.

To stop the transaction so that it cannot be resumed, call AStopAudio().

audio specifies the Audio structure associated with this connection.

xid specifies the transaction ID.

To use APauseAudio() on a series of linked transactions, specify the first transaction in the linked list. The pause affects the current transaction. A call to AResumeAudio() resumes the transaction and continues through the linked list.

trans_status_return receives the returned status value. Setting this argument to NULL prevents the data from being collected and returned, which may enhance performance.

status_return receives the returned status of the operation, unless it is set to NULL.

ERRORS

If status_return is not set to NULL, one of the following is returned in status_return.

0 AENoError

2 AEBadAudio

15 AEBadTransactionID

EXAMPLES

The following example pauses the transaction identified by xid, sets trans_stat to 0, and sets up status to receive an error status.

Audio *audio; /* audio connection */"
ATransID xid; /* transaction ID */"
ATransStatus trans_stat_return; /* transaction status return
long status; /* error status */"
.
.
.
/* pause transaction − xid returned by prior call */
trans_stat = 0;
APauseAudio(audio, xid, &trans_stat_return, &status);

DEPENDENCIES

This function belongs to the Audio Library of functions that manage connections to an audio server. The audio server must run on a system that has audio hardware. To find out whether or not your system has audio hardware, refer to the hardware manual that accompanies your system.

AUTHOR

APauseAudio() was developed by HP.

Museum

Related Articles