Prosody signal path processing: API: sm_path_create

Prototype Definition

int sm_path_create(struct sm_path_create_parms *createp)

Parameters

*createp

a structure of the following type:

typedef struct sm_path_create_parms {
	tSMPathId path;						/* out */
	tSMModuleId module;					/* in */
} SM_PATH_CREATE_PARMS;

Description

Creates a signal path. A signal path permits a variety of transformations to be performed on a signal. If no transformations are enabled, a path acts as a pass through.

The modules inchan and passthru are required.

Fields

path

The created signal path.

module

A value obtained from sm_open_module() which indicates the module on which the path 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 signal path processing API.