Prosody Audio Video Format (AVF): API: sm_avfplay_stop

This function is deprecated.

Prototype Definition

int sm_avfplay_stop(struct sm_avfplay_stop_parms *avfsp)

Parameters

*avfsp

a structure of the following type:

typedef struct sm_avfplay_stop_parms {
	tSMAVFplayId avfplay;					/* in */
	tSM_INT immediate;					/* in */
} SM_AVFPLAY_STOP_PARMS;

Description

Stops the AVF player tasks.

Fields

avfplay (Deprecated)

A tSMAVFplayId that has been prevously created by a call to sm_avfplay_create().

immediate (Deprecated)

The type of stop to perform. Set to a non zero value to stop immediately, discarding any data which has been supplied but not yet played. Otherwise, the play will stop once all data supplied has been played.

Returns

0 if call completed successfully, otherwise a standard error such as:

• ERR_SM_DEVERR - device error

This function is part of the Prosody Audio Video Format (AVF) API.