AStopAudio(3X) — Series 700 Only

NAME

AStopAudio − stop specified audio transaction

SYNOPSIS

#include <audio/Alib.h>

void AStopAudio (

Audio .*audio,

ATransID xid,

AStopMode mode,

ATransStatus *trans_status_return,

long *status_return

);

DESCRIPTION

AStopAudio() stops the transaction specified in xid. A stopped transaction cannot be resumed.

audio specifies the Audio structure associated with this connection.

xid specifies the transaction ID that was returned by ACreateSBucket() or ALoadAFile().

mode specifies the stop mode: ASMLinkedTrans, ASMThisTrans, or ASMEndLoop.

To stop the current and subsequent transactions in a linked list, use ASMLinkedTrans and specify the first transaction in the linked list as xid. The current and subsequent transactions in the linked list cannot be resumed after this stop.

To stop only the current transaction in a linked list, use ASMThisTrans. The specified transaction stops immediately, even if it is in the middle of a loop, and the remaining transactions in the linked list continue immediately.

To stop a looping transaction, use ASMEndLoop. The specified transaction stops at the end of the current loop. If the loop transaction is in a linked list, the remaining transactions continue.

If xid is not in a linked list, ASMLinkedTrans() has the same effect as ASMThisTrans.

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

3 AEBadValue

15 AEBadTransactionID

EXAMPLES

The following example stops the transaction identified by xid, sets mode to stop the specified transaction, passes NULL for trans_stat, and sets up status to receive an error status.

Audio *audio;       /* audio connection */
ATransID xid;       /* transaction ID */
AStopMode smode;    /* stop mode */
long status;        /* error status */
.
.
.
/* stop transaction - xid returned from prior call */
smode = ASMThisTrans;
AStopAudio(audio, xid, smode, NULL, &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

AStopAudio() was developed by HP.

Museum

Related Articles