Prosody speech processing: API: sm_channel_set_input_threshold

Prototype Definition

int sm_channel_set_input_threshold(struct sm_channel_set_input_threshold_parms *thp)

Parameters

*thp

a structure of the following type:

typedef struct sm_channel_set_input_threshold_parms {
	tSMChannelId channel;					/* in */
	tSM_INT minimum_bits;					/* in */
} SM_CHANNEL_SET_INPUT_THRESHOLD_PARMS;

Description

A channel is considered to be ready for you to fetch data from it when there is enough data. This call allows you to specify how much is 'enough'.

While there is enough data to make a channel ready, the channel's associated read event (as configured with sm_channel_set_event()) remains set.

See also the document Prosody application note: considerations for data transfer thresholds.

Fields

channel

The channel whose threshold is to be set.

minimum_bits

The new threshold. When this much data is available to be read, the channel is ready.

Returns

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

• ERR_SM_DEVERR - device error

This function is part of the Prosody speech processing API.