RTP IPv6 endpoint parameter structure

When the endpoint type is MSP_ENDPOINT_RTPFDX_V6, MSP_ENDPOINT_RTPIN_V6, or MSP_ENDPOINT_RTPOUT_V6, the application provides the following endpoint parameters:

typedef struct tag_RTPRTCP_V6_ENDPOINT_PARMS
{

   DWORD   size;               
   BYTE    trafficClass               
   DWORD   flowLabel
   DWORD   startRcp;
RTCP_SESSION_PARMS rtcpParms;
   DWORD   RtpTsFreq;               
   DWORD   Session_bw;   
   DWORD   dtmf_event_control;
   DWORD   frameQuota; 
   DWORD   linkEvents;  
   RTP_ PAYLOAD_MAP   PayloadMap;  

} RTPRTCP_V6_ENDPOINT_PARMS;

RTPRTCP_ENDPOINT_PARMS

Dependent function: mspCreateEndpoint

Field

Type

Default

Units

Description

trafficClass

BYTE

0

N/A

Class or priority of the IPv6 packet.

flowLabel

DWORD

0

N/A

Specific sequence to which the IPv6 packet belongs.

startRcp

DWORD

0

integer

Set this to non-zero to start RTCP session.

RTCP_SESSION_PARMS parameters must be specified for active RTCP sessions.

rtcpParms

Structure

N/A

N/A

Structure specifying RTCP session parameters.

RtpTsFreq

DWORD

8000

Hz

Timestamp frequency.

Session_bw

DWORD

64000

Hz

Session bandwidth (for future use only).

dtmf_event_control

DWORD

SEND_FIRST_EVENT and SEND_LAST_EVENT

N/A

Combination of two 16 bit WORDs that determine how the endpoint responds when receiving an RFC 2833 compliant packet payload.

A control value specifies how the endpoint responds to RFC 2833 compliant packets. Defined control values include (control values can be ORed together):

SEND_NO_EVENTS

No MSPEVN_RFC2833_REPORT event is sent upon arrival of an RFC 2833 compliant packet.

SEND_FIRST_EVENT

MSPEVN_RFC2833_REPORT event is sent upon the arrival of the first RFC 2833 compliant packet for a given DTMF digit.

SEND_LAST_EVENT

MSPEVN_RFC2833_REPORT event is sent upon the arrival of the last RFC 2833 compliant packet for a given DTMF digit.

SEND_ALL_EVENTS

MSPEVN_RFC2833_REPORT event is sent upon arrival of all RFC 2833 compliant packets and is limited by the decimation value.

A decimation value specifies how many RFC 2833 compliant packets the filter should receive for a particular tone before sending another event.

frameQuota

DWORD

2

Number of frames

Number of media frames assembled in each packet payload.

linkEvents

DWORD

0

1=enabled

0=disabled

Whether the MSPP API returns route availability events that report CG board Ethernet interface status transitions.

PayloadMap

Structure

N/A

N/A

Structure for specifying payload ID map for the endpoint. The structure consists of the following:

typedef struct
tag_RTP_PAYLOAD_MAP {
DWORD vocoder;
DWORD payload_id;
} RTP_PAYLOAD_MAP;

Where vocoder specifies the string of a supported Fusion vocoder, and payload_id specifies a payload ID number to specify for this vocoder. For more information about vocoder identification strings and default payload IDs for supported vocoders, refer to the mspcmd.h header file.

RTCP session parameter substructure

If the application enables RTCP reports through the startrcp parameter in the RTPRTCP_ENDPOINT_PARMS structure, it must also include the following substructure:

typedef struct TAG_RTCP_SESSION_PARMS
{
    DWORD       forwardPkts; 
    char        cname[32];  
    char        name[32];   
    char        email[32];  
    char        phone[32];  
    char        location[32]; 
    char        tool[32]; 
    char        note[32]; 
} RTCP_SESSION_PARMS;

RTCP_SESSION_PARMS

Dependent function: mspCreateEndpoint

Field name

Type

Default

Units

Description

forwardPkts

DWORD

N/A

1, <>1

If set to true (1), all RTCP packets are forwarded to the application.

cname

char

N/A

N/A

NULL terminated string containing the canonical name identifier.

name

char

N/A

N/A

NULL terminated string containing the user name.

email

char

N/A

N/A

NULL terminated string containing the email address.

phone

char

N/A

N/A

NULL terminated string containing the phone number.

location

char

N/A

N/A

NULL terminated string containing the geographic user location.

tool

char

N/A

N/A

NULL terminated string containing the application or tool name.

note

char

N/A

N/A

NULL terminated string containing the notice/status.