Prosody Audio Video Format (AVF): API: sm_avfplay_create

This function is deprecated.

Prototype Definition

int sm_avfplay_create(struct sm_avfplay_create_parms *avfcp)

Parameters

*avfcp

a structure of the following type:

typedef struct sm_avfplay_create_parms {
	tSMAVFplayId avfplay;					/* out */
	tSMModuleId module;					/* in */
} SM_AVFPLAY_CREATE_PARMS;

Description

Creates a player which can replay an AVF stream. An AVF player is a task which accepts as input an AVF stream from the host, and generates as output one of a number of data formats including the raw unchanged AVF stream and linear audio.

Fields

avfplay (Deprecated)

The created AVF player.

module (Deprecated)

A value obtained from sm_open_module() which indicates the module on which the AVF player is to be created.

Returns

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

• ERR_SM_DEVERR - device error
• ERR_SM_NO_RESOURCES - if no suitable output channel free
• ERR_SM_NO_SUCH_MODULE - if invalid module identifier specified

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