Prosody generic: API: sm_channel_ix_info

This function is only in Prosody version 1 (see also the conversion guide for further details).

Prototype Definition

int sm_channel_ix_info(struct sm_channel_ix_info_parms *infop)

Parameters

*infop
a structure of the following type: 
typedef struct sm_channel_ix_info_parms {
	tSM_INT channel_ix;					/* in */
	tSM_INT switch_ix;					/* out */
	tSM_INT ost;						/* out */
	tSM_INT ots;						/* out */
	tSM_INT ist;						/* out */
	tSM_INT its;						/* out */
	tSM_INT group;						/* out */
	tSM_INT caps_mask;					/* out */
	tSM_INT type;						/* out */
	tSM_INT module;						/* out */
} SM_CHANNEL_IX_INFO_PARMS;

Description

This call is functionally identical to sm_channel_info() except the subject channel is referenced by a channel index, channel_ix, instead of a channel id, and two extra fields (type and module) of channel information are included in the returned parameter block (the card parameter has been renamed to switch_ix in this version of the call parameter block).

On return, the fields in the parameter block will be set as for sm_channel_info(), and in addition, type will be set to the channel type as specified on channel allocation, and module will be set to the value as would be returned by sm_get_channel_ix_module_ix() for channel_ix.

Fields

channel_ix (Only in Prosody version 1)
The index number of the channel whose information is required.
switch_ix (Only in Prosody version 1)
The switch driver's card number for this channel.
ost (Only in Prosody version 1)
The channel's output stream.
ots (Only in Prosody version 1)
The channel's output timeslot.
ist (Only in Prosody version 1)
The channel's input stream.
its (Only in Prosody version 1)
The channel's input timeslot.
group (Only in Prosody version 1)
The channel's group number.
caps_mask (Only in Prosody version 1)
The channel's capabilities as specified when it was allocated.
type (Only in Prosody version 1)
The channel's type (i.e. input, output, half-duplex, or full-duplex).
module (Only in Prosody version 1)
The channel's module.

Returns

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

This function is part of the Prosody generic API.