TRAU_LOAD_DONE_DATA Structure

TRAU_LOAD_DONE_DATA Fields

TRAU_INFO Structure

TRAU_INFO Fields

TRAU_CHN_INFO_DATA Structure

TRAU_CHN_INFO_DATA Fields

TRAU_ATTACH_DATA Structure

TRAU_ATTACH_DATA Fields

TRAU_LOAD_DONE_DATA Structure

Calls to trauLoad return a TRAU_LOAD_DONE_DATA structure. This structure provides information about the number and type of channels running on loaded AG TRAU programs.

The TRAU_LOAD_DONE_DATA structure is defined as follows:

typedef struct _TRAU_LOAD_DONE_DATA
{
 unsigned   type;                   /* Vocoder type identifier         */    
 TRAUDSPID   dspid;                  /* The associated TRAU identifier  */        
 unsigned   board;                /* Board ( 0-15 )                  */     
 unsigned   dsp;                /* DSP ( 1-48 )                    */     
 unsigned   channels;            /* Channels created                       */
 unsigned   frame_tic;        /* Tics in .25ms increments        */
 unsigned   max_frame_size;         /* Host-based Fusion specific         */
/* SWITCHING INFORMATION FOLLOWS                   */
DWORD    bus;              /* Bus used                              */
 int   pcm_stream_from_dsp;      /* Stream used for voice PCM             */
 int   pcm_stream_to_dsp;      /* Stream used for voice PCM             */
int    pcm_count;              /* Number of PCM slots used            */
DWORD    pcm_slot[ PCM_MAX_SLOTS ]; /* Array of PCM slots                   */
/* COMPRESSED TX FUSION DATA ONLY (set to 0 if HB)                               */
int    tx_stream_from_dsp;      /* Stream used for data from TX          */
int    tx_stream_to_dsp;      /* Stream used for data to TX            */
int    tx_count;      /* Number of bonded time slots           */
DWORD    tx_slot[ TX_MAX_SLOTS ];/* Array of data slots                   */

} TRAU_LOAD_DONE_DATA;

TRAU_LOAD_DONE_DATA Fields

The TRAU_LOAD_DONE_DATA structure

type

Type	unsigned
Units	Not applicable.
Values	Valid AG TRAU program name.
Description	Type of AG TRAU program loaded.

includes the following fields:

Type	TRAUDSPID
Units	Not applicable.
Values	Not applicable.
Description	AG TRAU service identifier assigned to the DSP to which the AG TRAU program was loaded.

dspid

board

Type	unsigned
Units	Integer
Values	0 - 15
Description	NMS board on which the AG TRAU program was loaded.

dsp

Type	unsigned
Units	Integer
Values	1 - 48
Description	DSP on the specified board onto which the AG TRAU program was loaded.

channels

Type	unsigned
Units	Integer
Values	0 - 7
Description	Number of channels of that may be attached on the loaded AG TRAU program.

frame_tic

Type	unsigned
Units	.25 ms increments
Values	Not applicable.
Description	Duration of voice data stored within HDLC frame created by the AG TRAU channel.

max_frame_size

Type	unsigned
Units	.25 ms increments
Values	Not applicable.
Description	Maximum duration of voice data stored within HDLC frame created by the AG TRAU channel.

bus

Type	DWORD
Units	Not applicable.
Values	00 = Local bus 01 = H.100 bus
Description	Type of physical bus used to transfer data.

pcm_stream_from_dsp

Type	integer
Units	MVIP-95 stream number
Values	28
Description	Stream used to transfer voice PCM data from the AG TRAU program to the PSTN interface (timeslots vary according to channel).

pcm_stream_to_dsp

Type	integer
Units	MVIP-95 stream number
Values	29
Description	Stream used to transfer voice PCM data from the PSTN interface to the AG TRAU program (timeslots vary according to channel).

pcm_count

Type	integer
Units	Integer.
Values	0 - 7
Description	Total number of timeslots used to carry channel data between the specified AG TRAU program and the PSTN interface.

pcm_slot[ PCM_MAX_SLOTS ]

Type	DWORD
Units	MVIP-95 timeslot number
Values	0 - 383
Description	Array containing timeslot numbers of all timeslots used to transfer channel data from the specified AG TRAU program to the PSTN interface.

tx_stream_from_dsp

Type	integer
Units	MVIP-95 stream number
Values	30
Description	Stream used to transfer data from the TX board to the AG TRAU program (timeslots vary by channel). This value is only returned for TX-based Fusion configurations. For Fusion host-based configurations, 0 is returned.

tx_stream_to_dsp

Type	integer
Units	MVIP-95 stream number
Values	31
Description	Stream used to transfer data from the AG TRAU program to the TX board (timeslots vary by channel). This value is only returned for TX-based Fusion configurations. For Fusion host-based configurations, 0 is returned.

tx_count

Type	integer
Units	Integer
Values	0 - 7
Description	Total number of timeslots used to carry channel data between the specified AG TRAU program and the TX board. This value is only returned for TX-based Fusion configurations. For Fusion host-based configurations, 0 is returned.

tx_slot[ TX_MAX_SLOTS ]

Type	DWORD
Units	Not applicable.
Values	0 - 383
Description	Array containing timeslot numbers of all timeslots used to transfer channel data from the specified AG TRAU program to the TX board. This value is only returned for TX-based Fusion configurations. For Fusion host-based configurations, 0 is returned.

TRAU_INFO Structure

Calls to trauShowDSPInfo return a TRAU_INFO structure. This structure provides information about the number and type of channels running on the specified AG TRAU program (i.e., associated with the specified dspid).

Note: More specific information about individual channels on the specified AG TRAU program is returned in an array of TRAU_CHN_INFO_DATA substructures. For details about information returned in TRAU_CHN_INFO_DATA substructures, refer to Attach Channel Info Substructure later in this appendix.

The TRAU_INFO structure is defined as follows:

typedef struct _TRAU_INFO
{
unsigned size;                  /* Size used (determined by #chns  */
CTAHD    loadhd;                /* Associated load handle                   */
unsigned type;                  /* Vocoder type                   */
unsigned max_channels;          /* Max channels supported                   */
unsigned detached_channels;     /* Number of detached chns                   */
unsigned frame_tic;         /* Tics in .25ms increments        */
unsigned max_frame_size;         /* Host-based: max chn frame size  */
unsigned underrun_count_read;         /* Underrun up since load_done     */
unsigned underrun_count_write;    /* Underrun down since load_done   */
TRAU_CHN_INFO_DATA   pChannel[MAX_CHANNELS_DSP]; /* Channel info */

} TRAU_INFO;

TRAU_INFO Fields

The TRAU_INFO structure

size

Type	unsigned
Units	Bytes
Values	Not applicable.
Description	Size of structure (determined by number of channels running on the DSP).

includes the following fields:

Type	CTAHD
Units	Not applicable.
Values	Not applicable.
Description	AG TRAU service load handle associated with specified AG TRAU program/dspid.

loadhd

type

Type	unsigned
Units	Not applicable.
Values	Valid AG TRAU program type
Description	Type of AG TRAU program loaded.

max_channels

Type	unsigned
Units	Integer
Values	0 - 7
Description	Maximum number of channels that may be attached for the specified AG TRAU program.

detach_channels

Type	unsigned
Units	Integer
Values	0 - 7
Description	Number of channels that may be attached.

frame_tic

Type	unsigned
Units	.25 ms increments
Values	Not applicable.
Description	Duration of voice data stored within HDLC frame created by the AG TRAU channel.

max_frame_size

Type	unsigned
Units	.25 ms increments
Values	Not applicable.
Description	Maximum duration of voice data stored within HDLC frame created by the AG TRAU channel.

underrun_count_read

Type	unsigned
Units	Integer
Values	Not applicable.
Description	Number of underruns up that have occurred since the specified AG TRAU program was loaded.

underrun_count_read

Type	unsigned
Units	Integer
Values	Not applicable.
Description	Number of underruns down that have occurred since the specified AG TRAU program was loaded.

pChannel[MAX_CHANNELS_DSP]

Type	TRAU_CHN_INFO_DATA
Units	Not applicable.
Values	Not applicable.
Description	Array of TRAU_CHN_INFO_DATA structures containing status and switching information concerning AG TRAU channels associated with the specified AG TRAU program.

TRAU_CHN_INFO_DATA Structure

An array of TRAU_CHN_INFO_DATA substructures is returned by calls to trauShowDSPInfo. Each structure provides status and switching information about a specific channel running on the specified AG TRAU program (i.e. associated with the specified dspid).

The TRAU_CHN_INFO_DATA substructure is defined as follows:

typedef struct _TRAU_CHN_INFO_DATA
{
CTAHD ctahd;        /* ctahd associated with this trauchn         */
TRAU_STATE  state;        /* State of the channel defined in TRAU_STATE */
unsigned chn_underrun_count_read;   /* Underrun up since load_done                    */
unsigned chn_underrun_count_write; /* Underrun down since load_done                    */
DWORD   bus;      /* Bus used             */
int  pcm_stream_from_dsp;      /* Stream used for voice PCM            */
int  pcm_stream_to_dsp;      /* Stream used for voice PCM            */
DWORD   pcm_slot;      /* PCM bus,stream,slot that voice is on            */
 /* TX FUSION ONLY DATA (set to 0 if HB)                   */
int  tx_stream_from_dsp;      /* Stream used for HDLC data from TX            */
int  tx_stream_to_dsp;      /* Stream used for HDLC data to TX            */
int  tx_count;      /* Number of bonded time slots used            */
DWORD   tx_slot[ TX_MAX_SLOTS ]; /* Array of compressed slots                    */

} TRAU_CHN_INFO_DATA;

TRAU_CHN_INFO_DATA Fields

Each TRAU_CHN_INFO_DATA substructure includes the following fields:

CTAHD

TRAU_STATE

Type	TRAU_STATE
Units	Not applicable.
Values	State of specified channel: · TRAU_CHAN_DETACHED: Channel is loaded but not attached. · TRAU_CHAN_OFF_LINE: Channel is loaded, and attached, but not enabled. · TRAU_CHAN_ON_LINE: Channel is loaded, attached, and enabled.
Description	State of the channel as defined in TRAU_STATE.

chn_underrun_count_read

Type	unsigned
Units	Integer
Values	Not applicable.
Description	Number of underruns up that have occurred since the AG TRAU channel was loaded.

chn_underrun_count_read

Type	unsigned
Units	Integer
Values	Not applicable.
Description	Number of underruns down that have occurred since the AG TRAU channel was loaded.

bus

Type	DWORD
Units	Not applicable.
Values	00 = Local bus 01 = H.100 bus
Description	Type of physical bus used to transfer data across the gateway.

pcm_stream_from_dsp

Type	integer
Units	MVIP-95 stream number
Values	28
Description	Stream used to transfer PCM voice data from the AG TRAU channel to the PSTN interface.

pcm_stream_to_dsp

Type	integer
Units	MVIP-95 stream number
Values	29
Description	Stream used to transfer PCM voice data from the PSTN interface to the AG TRAU channel.

pcm_slot

Type	DWORD
Units	MVIP-95 timeslot number
Values	0 - 383
Description	Timeslot used to carry PCM voice data from the PSTN interface to the AG TRAU channel, and from the AG TRAU channel to the PSTN interface (same timeslot number used for both).

tx_stream_from_dsp

Type	integer
Units	MVIP-95 stream number
Values	30
Description	Stream used to transfer HDLC voice data from the AG TRAU channel to the TX board. This value is only returned for TX-based Fusion configurations. For Fusion host-based configurations, 0 is returned.

tx_stream_to_dsp

Type	integer
Units	MVIP-95 stream number
Values	31
Description	Stream used to transfer HDLC voice data from the TX board to the AG TRAU channel. This value is only returned for TX-based Fusion configurations. For Fusion host-based configurations, 0 is returned.

tx_count

Type	integer
Units	Integer
Values	0 - 7
Description	Number of bonded timeslots used to carry HDLC voice data between the AG TRAU channel and the TX board. This value is only returned for TX-based Fusion configurations. For Fusion host-based configurations, 0 is returned.

tx_slot[ TX_MAX_SLOTS ]

Type	DWORD
Units	Not applicable.
Values	Not applicable.
Description	Array of containing the timeslot numbers of the bonded timeslots used to carry hyperchannelled HDLC voice data between the AG TRAU channel and the TX board. This value is only returned for TX-based Fusion configurations. For Fusion host-based configurations, 0 is returned.

TRAU_ATTACH_DATA Structure

The TRAU_ATTACH_DATA structure is defined as follows:

typedef struct _TRAU_ATTACH_DATA
{
    TRAUDSPID     dspid;     /* ID of the DSP attached to          */
    unsigned     board;     /* Board ( 0-15 )          */  
    unsigned     dsp;     /* DSP ( 1-48 )          */
    unsigned     channel;     /* Channel number for DSP ( 0-7 )          */
    /* SWITCHING INFORMATION FOLLOWS                   */
    DWORD      bus;     /* Bus used          */
    int     pcm_stream_from_dsp;     /* Stream used for voice PCM          */
    int     pcm_stream_to_dsp;     /* Stream used for voice PCM          */
    DWORD     pcm_slot;            /* Timeslot that PCM voice is on               */
    /* TX FUSION ONLY DATA (set to 0 if HB)                   */
    int     tx_stream_from_dsp;     /* Stream used for data from TX              */
    int     tx_stream_to_dsp;     /* Stream used for data to TX         */
    int     tx_count;     /* Number of bonded slots used         */
    DWORD      tx_slot[ TX_MAX_SLOTS ] ;/* Array of compressed slots              */
} TRAU_ATTACH_DATA;

Calls to trauAttach return a TRAU_ATTACH_DATA structure. This structure provides status and switching information about the attached AG TRAU channel.

TRAU_ATTACH_DATA Fields

TRAU_ATTACH_DATA structures include the following fields:

dspid

Type	TRAUDSPID
Units	Not applicable.
Values	Not applicable.
Description	AG TRAU service identifier assigned to the DSP on which the AG TRAU program was loaded.

board

Type	unsigned
Units	Not applicable.
Values	0 - 15
Description	Board on which the AG TRAU program was loaded.

dsp

Type	unsigned
Units	Not applicable.
Values	1 - 48
Description	DSP on the specified board onto which the AG TRAU program was loaded.

channels

Type	unsigned
Units	Not applicable.
Values	0 - 7
Description	Number of channels of that maybe attached on the loaded AG TRAU program.

bus

Type	DWORD
Units	Not applicable.
Values	00 = Local bus 01 = H.100 bus
Description	Type of physical bus used to transfer data across the gateway.

pcm_stream_from_dsp

Type	integer
Units	MVIP-95 stream number
Values	28
Description	Stream used to transfer PCM voice data from the AG TRAU channel to the PSTN interface.

pcm_stream_to_dsp

Type	integer
Units	MVIP-95 stream number
Values	29
Description	Stream used to transfer PCM voice data from the PSTN interface to the AG TRAU channel.

pcm_slot

Type	DWORD
Units	MVIP-95 timeslot number
Values	0 - 383
Description	Timeslot used to carry PCM voice data from the PSTN interface to the AG TRAU channel, and from the AG TRAU channel to the PSTN interface (same timeslot number used for both).

tx_stream_from_dsp

Type	integer
Units	MVIP-95 stream number
Values	30
Description	Stream used to transfer HDLC voice data from the AG TRAU channel to the TX board. This value is only returned for TX-based Fusion configurations. For Fusion host-based configurations, 0 is returned.

Type	integer
Units	MVIP-95 stream number
Values	31
Description	Stream used to transfer HDLC voice data from the TX board to the AG TRAU channel. This value is only returned for TX-based Fusion configurations. For Fusion host-based configurations, 0 is returned.

tx_stream_to_dsp

tx_count

Type	integer
Units	Integer
Values	0 - 7
Description	Number of bonded time slots used to carry hyperchannelled HDLC voice data between the AG TRAU channel and the TX board. This value is only returned for TX-based Fusion configurations. For Fusion host-based configurations, 0 is returned.

tx_slot[ TX_MAX_SLOTS ]

Type	DWORD
Units	Not applicable.
Values	Not applicable.
Description	Array of containing the timeslot numbers of the bonded timeslots used to carry hyperchannelled HDLC voice data between the AG TRAU channel and the TX board. This value is only returned for TX-based Fusion configurations. For Fusion host-based configurations, 0 is returned.