Prosody generic: API: sm_channel_datafeed_connect

Prototype Definition

int sm_channel_datafeed_connect(struct sm_channel_datafeed_connect_parms *datafeedp)

Parameters

*datafeedp

a structure of the following type:

typedef struct sm_channel_datafeed_connect_parms {
	tSMDatafeedId data_source;				/* in */
	tSMChannelId channel;					/* in */
} SM_CHANNEL_DATAFEED_CONNECT_PARMS;

Description

Connects a datafeed to an input channel. The data_source must be a datafeed obtained a call to any of the *_get_datafeed() functions. The input channel, channel, will receive any data that is generated by the object from which data_source was derived.

To disconnect a channel from a datafeed, specify kSMNullDatafeedId as the tSMDatafeedId in data_source.

Requires the module datafeed to have been downloaded.

Fields

data_source

The datafeed acting as a source of data

channel

The channel that will receive the data

Returns

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

• ERR_SM_DEVERR - device error

This function is part of the Prosody generic API.