[DOC] - Add New Call Quality and Security Parameters to Status Callback Documentation

[briankwest]

Add New Call Quality and Security Parameters to Status Callback Documentation

Description

The SignalWire Voice Status Callback Parameters documentation needs to be updated to include new parameters related to call quality, jitter, packet handling, and Secure RTP encryption. These parameters provide enhanced analytics and security details for calls and should be documented under the status callbacks section.

Affected Documentation Page

SignalWire Status Callbacks - Voice

New Parameters to Add

Parameter	Type	Description
AudioInSkipPacketCount	integer	Number of incoming audio packets skipped due to jitter or network instability.
AudioInFlushPacketCount	integer	Number of incoming audio packets flushed due to excessive buffering or network congestion.
AudioInLargestJbSize	integer	Largest jitter buffer size recorded during the call.
AudioInJitterMinVariance	float	Minimum variance in network jitter observed during the call.
AudioInJitterMaxVariance	float	Maximum variance in network jitter observed during the call.
AudioOutMediaPacketCount	integer	Total number of outbound media packets transmitted.
AudioOutDtmfPacketCount	integer	Total number of DTMF packets sent outbound.
RemoteAudioCryptoKey	string	Encryption key used for Secure RTP (SRTP) transmission.
RemoteAudioCryptoType	string	Encryption method used for Secure RTP, e.g., AES_256_CM_HMAC_SHA1_80.

Justification for Change

• These parameters enhance call quality analytics by providing insights into jitter, packet loss, and buffering.
• They introduce security-related details by exposing Secure RTP encryption methods used in the call.
• This data is useful for troubleshooting, diagnostics, and compliance verification for encrypted communications.
• The information is already being generated in call events and should be reflected in the documentation to inform users.

Proposed Changes

1. Add these new parameters under the Voice Status Callback Parameter section.
2. Include descriptions and example values for each parameter.
3. Clarify usage scenarios where these parameters are beneficial (e.g., debugging poor call quality, verifying encrypted calls).