Prosody generic: API: sm_channel_info

Prototype Definition

int sm_channel_info(struct sm_channel_info_parms *infop)

Parameters

*infop
a structure of the following type:
typedef struct sm_channel_info_parms {
	tSMChannelId channel;					/* in */
	tSM_INT card;						/* out */
	tSM_INT ost;						/* out */
	tSM_INT ots;						/* out */
	enum kSMTimeslotType otype;				/* out */
	tSM_INT ist;						/* out */
	tSM_INT its;						/* out */
	enum kSMTimeslotType itype;				/* out */
	tSM_INT group;						/* out */
	tSM_INT caps_mask;					/* out */
} SM_CHANNEL_INFO_PARMS;

Description

This call allows an application to locate a previously allocated speech processing resource so that a data can be switched through to it by means of a call to the Aculab switch driver API.

If channel is an identifier for a previously allocated input, half-duplex, or full-duplex channel, then the parameters ist, and its returned by this call may be assigned to the ost and ots parameters of a switch driver CONNECT_MODE call to sw_set_output, with <ist, its> in the OUTPUT_PARMS parameter block being set to the source of the data to be processed by the channel.

If channel is an identifier for a previously allocated output, half-duplex, or full-duplex channel, then the parameters ost, and ots returned by this call may be assigned to the ist and its parameters of a switch driver CONNECT_MODE call to sw_set_output with <ost, ots> int the OUTPUT_PARMS parameter block being set to the destination for data to be generated by the channel.

The parameter card is an obsolete parameter set to the value -1

The parameter group is an obsolete parameter set to the value zero.

The parameter caps_mask is an obsolete parameter set to the value zero.

Fields

channel
The channel whose information is required.
card
Obsolete parameter
ost
The channel's output stream.
ots
The channel's output timeslot.
otype
The output timeslot type. One of these values:
kSMTimeslotTypeALaw
Signals encoded with A-law companding.
kSMTimeslotTypeMuLaw
Signals encoded with mu-law companding.
kSMTimeslotTypeData
Digital data - no companding used.
ist
The channel's input stream.
its
The channel's input timeslot.
itype
The input timeslot type. One of these values:
kSMTimeslotTypeALaw
Signals encoded with A-law companding.
kSMTimeslotTypeMuLaw
Signals encoded with mu-law companding.
kSMTimeslotTypeData
Digital data - no companding used.
group
Obsolete parameter.
caps_mask
Obsolete parameter.

Returns

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


This function is part of the Prosody generic API.