Prosody signal path processing: API: sm_path_datafeed_connect

Prototype Definition

int sm_path_datafeed_connect(struct sm_path_datafeed_connect_parms *datafeedp)

Parameters

*datafeedp

a structure of the following type:

typedef struct sm_path_datafeed_connect_parms {
	tSMPathId path;						/* in */
	tSMDatafeedId data_source;				/* in */
} SM_PATH_DATAFEED_CONNECT_PARMS;

Description

Connects a datafeed to a signal path. The data_source must be a datafeed obtained from sm_channel_get_datafeed(), sm_tdmrx_get_datafeed() sm_vmprx_get_datafeed() or sm_path_get_datafeed(). Datafeed connections can only be made between objects allocated on the same tSMModuleId. The signal path path will receive any data that is generated by the output task from which data_source was derived.

To disconnect a signal path from a datafeed, specify kSMNullDatafeedId as the tSMDatafeedId in data_source

Requires the module datafeed to have been downloaded.

Fields

path

The signal path that will receive and process the data

data_source

The datafeed acting as a source of data for the signal path

Returns

0 if call completed successfully, otherwise a standard error.

This function is part of the Prosody signal path processing API.