Prosody generic: API: sm_channel_get_datafeed

This function is only in Prosody version 2 (TiNG).

Prototype Definition

int sm_channel_get_datafeed(struct sm_channel_datafeed_parms *datafeedp)

Parameters

*datafeedp

a structure of the following type:

typedef struct sm_channel_datafeed_parms {
	tSMChannelId channel;					/* in */
	tSMDatafeedId datafeed;					/* out */
} SM_CHANNEL_DATAFEED_PARMS;

Description

Request a datafeed identifier from an output channel. This identifer can subsequently be used in a call to any of the *_datafeed_connect() functions to connect the output from the channel to a destination. It is valid until the channel is released. Datafeed connections can only be made between objects allocated on the same tSMModuleId.

Requires the module datafeed to have been downloaded.

Fields

channel (Only in Prosody version 2 (TiNG))

The output channel from which to obtain a datafeed

datafeed (Only in Prosody version 2 (TiNG))

The datafeed object associated with the output channel

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.