Prosody Audio Video Format (AVF): API: sm_avfplay_status

This function is deprecated.

Prototype Definition

int sm_avfplay_status(struct sm_avfplay_status_parms *statusp)

Parameters

*statusp

a structure of the following type:

typedef struct sm_avfplay_status_parms {
	tSMAVFplayId avfplay;					/* in */
	enum kSMAVFplayStatus {
		kSMAVFplayStatusRunning,
		kSMAVFplayStatusUnderrun,
		kSMAVFplayStatusCompleteData,
		kSMAVFplayStatusComplete,
	} status;						/* out */
} SM_AVFPLAY_STATUS_PARMS;

Description

Returns the current status of the AVF player or an error to indicate that a problem occurred during start-up.

When the event, obtained from sm_avfplay_get_event(), is signalled the user must call this function to determine the nature of the status change. The change in status may indicate that an error occurred whilst processing a user request or it may be notifiying the user of a change to the previous state of the AVF player.

Fields

avfplay (Deprecated)

The AVF player to interrogate

status (Deprecated)

One of these values:

kSMAVFplayStatusRunning

Indicates that there is nothing significant to report

kSMAVFplayStatusUnderrun

Indicates that the AVF player has failed to play data because it did not have the data in time.

kSMAVFplayStatusCompleteData

Indicates that the replay job is still ongoing, all required data for replay has been supplied, the replay job will complete once all module buffered data has been transmitted

kSMAVFplayStatusComplete

Indicates that the replay job has completed, all module buffered data has been transmitted

Returns

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

• ERR_SM_DEVERR - device error
• ERR_SM_NO_RESOURCES - if insufficient resources existed to create

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