RDK-B
Data Structures | Macros | Typedefs | Enumerations
VOICE HAL Data Types
VOICE HAL

Description

Data Structures

struct  TelcoVoipAgent_VoiceService_Stats_t
 
struct  TelcoVoipAgent_Voice_Calling_Features_t
 
struct  TelcoVoipAgent_Voice_Credentials_t
 

Macros

#define RETURN_ERROR   (-1)
 
#define RETURN_OK   0
 
#define RDK_SUCCESS   (0) /*No Error*/
 
#define RDK_FAILURE   (-1) /*any other failure*/
 
#define RDK_ERROR_PARAM   (-2) /* NULL pointers mainly */
 
#define RDK_ERROR_RANGE   (-3) /* Value provided, but out of permitted range */
 
#define RDK_ERROR_OOM   (-4) /* Out of memory, usually malloc failed */
 
#define VOICE_HAL_USERNAME_LENGTH   (40)
 
#define VOICE_HAL_PASSWORD_LENGTH   (40)
 

Typedefs

typedef struct TelcoVoipAgent_Voice_Calling_Features_t * pTelcoVoipAgent_Voice_Calling_Features_t
 
typedef struct TelcoVoipAgent_Voice_Credentials_t * pTelcoVoipAgent_Voice_Credentials_t
 

Enumerations

enum  VoiceHalLineStatus_e {
  VOICE_HAL_LINE_STATE_UP = 0, VOICE_HAL_LINE_STATE_INITIALIZING, VOICE_HAL_LINE_STATE_REGISTERING, VOICE_HAL_LINE_STATE_UNREGISTERING,
  VOICE_HAL_LINE_STATE_ERROR, VOICE_HAL_LINE_STATE_TESTING, VOICE_HAL_LINE_STATE_QUIESCENT, VOICE_HAL_LINE_STATE_DISABLED
}
 
enum  VoiceHalLineEnable_e { VOICE_HAL_LINE_DISABLED = 0, VOICE_HAL_LINE_QUIESCENT, VOICE_HAL_LINE_ENABLED }
 
enum  VoiceHalCallState_e {
  VOICE_HAL_CALL_STATE_IDLE = 0, VOICE_HAL_CALL_STATE_CALLING, VOICE_HAL_CALL_STATE_RINGING, VOICE_HAL_CALL_STATE_CONNECTING,
  VOICE_HAL_CALL_STATE_INCALL, VOICE_HAL_CALL_STATE_HOLD, VOICE_HAL_CALL_STATE_DISCONNECTING
}
 
enum  VoiceHalDiagnosticState_e {
  VOICE_HAL_DIAG_STATE_TYPE_NONE = 0, VOICE_HAL_DIAG_STATE_TYPE_REQUESTED, VOICE_HAL_DIAG_STATE_TYPE_COMPLETE, VOICE_HAL_DIAG_STATE_TYPE_ERROR_INTERNAL,
  VOICE_HAL_DIAG_STATE_TYPE_ERROR_OTHER
}
 
enum  VoiceHalDigitMap_e { VOICE_HAL_NORMAL_DIGIT_MAP = 0, VOICE_HAL_EMERGENCY_DIGIT_MAP }
 
enum  VoiceHalIpAddressFamily_e { VOICE_HAL_AF_INET_V4 = 0, VOICE_HAL_AF_INET_V6 }
 
enum  VoiceHalIpLinkState_e { VOICE_HAL_IP_LINK_STATE_DOWN = 0, VOICE_HAL_IP_LINK_STATE_UP }
 
enum  VoiceHalDigitTimer_e { VOICE_HAL_S_TIMER = 0, VOICE_HAL_Z_TIMER }
 
enum  VoiceHalAuthCredentialType_e { VOICE_HAL_AUTH_UNAME = 0, VOICE_HAL_AUTH_PWD }
 
enum  VoiceProcessStateRequest_e { VOICE_PROCESS_STATE_STOP = 0, VOICE_PROCESS_STATE_START, VOICE_PROCESS_STATE_RESTART, VOICE_PROCESS_STATE_FACTORY_DEFAULT }
 
enum  VoiceProcessStatus_e {
  VOICE_PROCESS_STATUS_STOPPED = 0, VOICE_PROCESS_STATUS_STARTING, VOICE_PROCESS_STATUS_STARTED, VOICE_PROCESS_STATUS_STOPPING,
  VOICE_PROCESS_STATUS_ERROR
}
 
enum  VoiceCallFeatureType_e {
  VOICE_CALLING_FEATURE_CALL_WAITING = 0, VOICE_CALLING_FEATURE_MSG_WAIT_INDICATOR, VOICE_CALLING_FEATURE_CONF_CALL, VOICE_CALLING_FEATURE_HOLD,
  VOICE_CALLING_FEATURE_CALLER_ID
}
 

Data Structure Documentation

◆ TelcoVoipAgent_VoiceService_Stats_t

struct TelcoVoipAgent_VoiceService_Stats_t

Definition at line 206 of file voice_hal.h.

Collaboration diagram for TelcoVoipAgent_VoiceService_Stats_t:
Collaboration graph

Data Fields

bool ResetStatistics
 
uint32_t PacketsSent
 
uint32_t PacketsReceived
 
uint32_t BytesSent
 
uint32_t BytesReceived
 
uint32_t PacketsLost
 
uint32_t IncomingCallsReceived
 
uint32_t IncomingCallsAnswered
 
uint32_t IncomingCallsConnected
 
uint32_t IncomingCallsFailed
 
uint32_t OutgoingCallsAttempted
 
uint32_t OutgoingCallsAnswered
 
uint32_t OutgoingCallsConnected
 
uint32_t OutgoingCallsFailed
 
uint32_t ReceivePacketLossRate
 
uint32_t FarEndPacketLossRate
 
uint32_t ReceiveInterarrivalJitter
 
uint32_t FarEndInterarrivalJitter
 
uint32_t RoundTripDelay
 
uint32_t AverageReceiveInterarrivalJitter
 
uint32_t AverageFarEndInterarrivalJitter
 
uint32_t AverageRoundTripDelay
 

Field Documentation

◆ ResetStatistics

bool TelcoVoipAgent_VoiceService_Stats_t::ResetStatistics

ResetStatistics

Definition at line 210 of file voice_hal.h.

◆ PacketsSent

uint32_t TelcoVoipAgent_VoiceService_Stats_t::PacketsSent

Total number of RTP packets sent for this line.

Definition at line 211 of file voice_hal.h.

◆ PacketsReceived

uint32_t TelcoVoipAgent_VoiceService_Stats_t::PacketsReceived

Total number of RTP payload bytes received for this line.

Definition at line 212 of file voice_hal.h.

◆ BytesSent

uint32_t TelcoVoipAgent_VoiceService_Stats_t::BytesSent

Total number of RTP payload bytes sent for this line.

Definition at line 213 of file voice_hal.h.

◆ BytesReceived

uint32_t TelcoVoipAgent_VoiceService_Stats_t::BytesReceived

Total number of RTP payload bytes received for this line.

Definition at line 214 of file voice_hal.h.

◆ PacketsLost

uint32_t TelcoVoipAgent_VoiceService_Stats_t::PacketsLost

Total number of RTP packets that have been lost for this line.

Definition at line 215 of file voice_hal.h.

◆ IncomingCallsReceived

uint32_t TelcoVoipAgent_VoiceService_Stats_t::IncomingCallsReceived

Total incoming calls received.

Definition at line 216 of file voice_hal.h.

◆ IncomingCallsAnswered

uint32_t TelcoVoipAgent_VoiceService_Stats_t::IncomingCallsAnswered

Total incoming calls answered by the local user.

Definition at line 217 of file voice_hal.h.

◆ IncomingCallsConnected

uint32_t TelcoVoipAgent_VoiceService_Stats_t::IncomingCallsConnected

Total incoming calls that successfully completed call setup signalling.

Definition at line 218 of file voice_hal.h.

◆ IncomingCallsFailed

uint32_t TelcoVoipAgent_VoiceService_Stats_t::IncomingCallsFailed

Total incoming calls that failed to successfully complete call setup signalling.

Definition at line 219 of file voice_hal.h.

◆ OutgoingCallsAttempted

uint32_t TelcoVoipAgent_VoiceService_Stats_t::OutgoingCallsAttempted

Total outgoing calls attempted.

Definition at line 220 of file voice_hal.h.

◆ OutgoingCallsAnswered

uint32_t TelcoVoipAgent_VoiceService_Stats_t::OutgoingCallsAnswered

Total outgoing calls answered by the remote user.

Definition at line 221 of file voice_hal.h.

◆ OutgoingCallsConnected

uint32_t TelcoVoipAgent_VoiceService_Stats_t::OutgoingCallsConnected

Total outgoing calls that successfully completed call setup signalling.

Definition at line 222 of file voice_hal.h.

◆ OutgoingCallsFailed

uint32_t TelcoVoipAgent_VoiceService_Stats_t::OutgoingCallsFailed

Total outgoing calls that failed to successfully complete call setup signaling.

Definition at line 223 of file voice_hal.h.

◆ ReceivePacketLossRate

uint32_t TelcoVoipAgent_VoiceService_Stats_t::ReceivePacketLossRate

Current receive packet loss rate in percent, calculated as defined in [section 6.4-RFC3550]

Definition at line 229 of file voice_hal.h.

◆ FarEndPacketLossRate

uint32_t TelcoVoipAgent_VoiceService_Stats_t::FarEndPacketLossRate

Current far end receive packet lost rate in percent, calculated as defined in [Section6.4/RFC3550].

Definition at line 230 of file voice_hal.h.

◆ ReceiveInterarrivalJitter

uint32_t TelcoVoipAgent_VoiceService_Stats_t::ReceiveInterarrivalJitter

Current receive interarrival jitter in microseconds. Calculated from J(i) as defined in [Section6.4/RFC3550], with units converted to microseconds.

Definition at line 231 of file voice_hal.h.

◆ FarEndInterarrivalJitter

uint32_t TelcoVoipAgent_VoiceService_Stats_t::FarEndInterarrivalJitter

Current Interarrival jitter in microseconds as reported from the far-end device via RTCP. Calculated from J(i) as defined in [Section64./RFC3550], with units converted to microseconds.

Definition at line 232 of file voice_hal.h.

◆ RoundTripDelay

uint32_t TelcoVoipAgent_VoiceService_Stats_t::RoundTripDelay

Current round trip delay in microseconds calculated as defined in [section 6.4-RFC3550].

Definition at line 233 of file voice_hal.h.

◆ AverageReceiveInterarrivalJitter

uint32_t TelcoVoipAgent_VoiceService_Stats_t::AverageReceiveInterarrivalJitter

Average receive interarrival jitter in microseconds since the beginning of the current call. Calculated as the average of D(i,j) as defined in [Section6.4/RFC3550], with units converted to microseconds.

Definition at line 234 of file voice_hal.h.

◆ AverageFarEndInterarrivalJitter

uint32_t TelcoVoipAgent_VoiceService_Stats_t::AverageFarEndInterarrivalJitter

Average far-end interarrival jitter in microseconds since the beginning of the current call. Calculated as the average of the interarrival jitter values reported by the far-end, with units converted to microseconds.

Definition at line 235 of file voice_hal.h.

◆ AverageRoundTripDelay

uint32_t TelcoVoipAgent_VoiceService_Stats_t::AverageRoundTripDelay

Average round trip delay in microseconds since the beginning of the current call. Average of the RoundTripDelay statistic accumulated each time the delay is calculated.

Definition at line 236 of file voice_hal.h.

◆ TelcoVoipAgent_Voice_Calling_Features_t

struct TelcoVoipAgent_Voice_Calling_Features_t

Definition at line 241 of file voice_hal.h.

Collaboration diagram for TelcoVoipAgent_Voice_Calling_Features_t:
Collaboration graph

Data Fields

bool EnableCallWaiting
 
bool EnableMessageWaitingIndicator
 
bool EnableConferenceCall
 
bool HoldEnable
 
bool EnableCallerId
 

Field Documentation

◆ EnableCallWaiting

bool TelcoVoipAgent_Voice_Calling_Features_t::EnableCallWaiting

Definition at line 243 of file voice_hal.h.

◆ EnableMessageWaitingIndicator

bool TelcoVoipAgent_Voice_Calling_Features_t::EnableMessageWaitingIndicator

Definition at line 244 of file voice_hal.h.

◆ EnableConferenceCall

bool TelcoVoipAgent_Voice_Calling_Features_t::EnableConferenceCall

Definition at line 245 of file voice_hal.h.

◆ HoldEnable

bool TelcoVoipAgent_Voice_Calling_Features_t::HoldEnable

Definition at line 246 of file voice_hal.h.

◆ EnableCallerId

bool TelcoVoipAgent_Voice_Calling_Features_t::EnableCallerId

Definition at line 247 of file voice_hal.h.

◆ TelcoVoipAgent_Voice_Credentials_t

struct TelcoVoipAgent_Voice_Credentials_t

Definition at line 255 of file voice_hal.h.

Collaboration diagram for TelcoVoipAgent_Voice_Credentials_t:
Collaboration graph

Data Fields

uint8_t UserName [(40)]
 
uint8_t Password [(40)]
 

Field Documentation

◆ UserName

uint8_t TelcoVoipAgent_Voice_Credentials_t::UserName[(40)]

Definition at line 257 of file voice_hal.h.

◆ Password

uint8_t TelcoVoipAgent_Voice_Credentials_t::Password[(40)]

Definition at line 258 of file voice_hal.h.

Macro Definition Documentation

◆ RETURN_ERROR

#define RETURN_ERROR   (-1)

Definition at line 92 of file voice_hal.h.

◆ RETURN_OK

#define RETURN_OK   0

Definition at line 93 of file voice_hal.h.

◆ RDK_SUCCESS

#define RDK_SUCCESS   (0) /*No Error*/

Definition at line 96 of file voice_hal.h.

◆ RDK_FAILURE

#define RDK_FAILURE   (-1) /*any other failure*/

Definition at line 98 of file voice_hal.h.

◆ RDK_ERROR_PARAM

#define RDK_ERROR_PARAM   (-2) /* NULL pointers mainly */

Definition at line 99 of file voice_hal.h.

◆ RDK_ERROR_RANGE

#define RDK_ERROR_RANGE   (-3) /* Value provided, but out of permitted range */

Definition at line 100 of file voice_hal.h.

◆ RDK_ERROR_OOM

#define RDK_ERROR_OOM   (-4) /* Out of memory, usually malloc failed */

Definition at line 101 of file voice_hal.h.

◆ VOICE_HAL_USERNAME_LENGTH

#define VOICE_HAL_USERNAME_LENGTH   (40)

Definition at line 251 of file voice_hal.h.

◆ VOICE_HAL_PASSWORD_LENGTH

#define VOICE_HAL_PASSWORD_LENGTH   (40)

Definition at line 252 of file voice_hal.h.

Typedef Documentation

◆ pTelcoVoipAgent_Voice_Calling_Features_t

typedef struct TelcoVoipAgent_Voice_Calling_Features_t * pTelcoVoipAgent_Voice_Calling_Features_t

◆ pTelcoVoipAgent_Voice_Credentials_t

typedef struct TelcoVoipAgent_Voice_Credentials_t * pTelcoVoipAgent_Voice_Credentials_t

Enumeration Type Documentation

◆ VoiceHalLineStatus_e

enum VoiceHalLineStatus_e
Enumerator
VOICE_HAL_LINE_STATE_UP 
VOICE_HAL_LINE_STATE_INITIALIZING 
VOICE_HAL_LINE_STATE_REGISTERING 
VOICE_HAL_LINE_STATE_UNREGISTERING 
VOICE_HAL_LINE_STATE_ERROR 
VOICE_HAL_LINE_STATE_TESTING 
VOICE_HAL_LINE_STATE_QUIESCENT 
VOICE_HAL_LINE_STATE_DISABLED 

Definition at line 109 of file voice_hal.h.

◆ VoiceHalLineEnable_e

enum VoiceHalLineEnable_e
Enumerator
VOICE_HAL_LINE_DISABLED 
VOICE_HAL_LINE_QUIESCENT 
VOICE_HAL_LINE_ENABLED 

Definition at line 121 of file voice_hal.h.

◆ VoiceHalCallState_e

enum VoiceHalCallState_e
Enumerator
VOICE_HAL_CALL_STATE_IDLE 
VOICE_HAL_CALL_STATE_CALLING 
VOICE_HAL_CALL_STATE_RINGING 
VOICE_HAL_CALL_STATE_CONNECTING 
VOICE_HAL_CALL_STATE_INCALL 
VOICE_HAL_CALL_STATE_HOLD 
VOICE_HAL_CALL_STATE_DISCONNECTING 

Definition at line 128 of file voice_hal.h.

◆ VoiceHalDiagnosticState_e

enum VoiceHalDiagnosticState_e
Enumerator
VOICE_HAL_DIAG_STATE_TYPE_NONE 
VOICE_HAL_DIAG_STATE_TYPE_REQUESTED 
VOICE_HAL_DIAG_STATE_TYPE_COMPLETE 
VOICE_HAL_DIAG_STATE_TYPE_ERROR_INTERNAL 
VOICE_HAL_DIAG_STATE_TYPE_ERROR_OTHER 

Definition at line 139 of file voice_hal.h.

◆ VoiceHalDigitMap_e

enum VoiceHalDigitMap_e
Enumerator
VOICE_HAL_NORMAL_DIGIT_MAP 
VOICE_HAL_EMERGENCY_DIGIT_MAP 

Definition at line 148 of file voice_hal.h.

◆ VoiceHalIpAddressFamily_e

enum VoiceHalIpAddressFamily_e
Enumerator
VOICE_HAL_AF_INET_V4 
VOICE_HAL_AF_INET_V6 

Definition at line 154 of file voice_hal.h.

◆ VoiceHalIpLinkState_e

enum VoiceHalIpLinkState_e
Enumerator
VOICE_HAL_IP_LINK_STATE_DOWN 
VOICE_HAL_IP_LINK_STATE_UP 

Definition at line 160 of file voice_hal.h.

◆ VoiceHalDigitTimer_e

enum VoiceHalDigitTimer_e
Enumerator
VOICE_HAL_S_TIMER 
VOICE_HAL_Z_TIMER 

Definition at line 166 of file voice_hal.h.

◆ VoiceHalAuthCredentialType_e

enum VoiceHalAuthCredentialType_e
Enumerator
VOICE_HAL_AUTH_UNAME 
VOICE_HAL_AUTH_PWD 

Definition at line 172 of file voice_hal.h.

◆ VoiceProcessStateRequest_e

enum VoiceProcessStateRequest_e
Enumerator
VOICE_PROCESS_STATE_STOP 
VOICE_PROCESS_STATE_START 
VOICE_PROCESS_STATE_RESTART 
VOICE_PROCESS_STATE_FACTORY_DEFAULT 

Definition at line 178 of file voice_hal.h.

◆ VoiceProcessStatus_e

enum VoiceProcessStatus_e
Enumerator
VOICE_PROCESS_STATUS_STOPPED 
VOICE_PROCESS_STATUS_STARTING 
VOICE_PROCESS_STATUS_STARTED 
VOICE_PROCESS_STATUS_STOPPING 
VOICE_PROCESS_STATUS_ERROR 

Definition at line 186 of file voice_hal.h.

◆ VoiceCallFeatureType_e

enum VoiceCallFeatureType_e
Enumerator
VOICE_CALLING_FEATURE_CALL_WAITING 
VOICE_CALLING_FEATURE_MSG_WAIT_INDICATOR 
VOICE_CALLING_FEATURE_CONF_CALL 
VOICE_CALLING_FEATURE_HOLD 
VOICE_CALLING_FEATURE_CALLER_ID 

Definition at line 194 of file voice_hal.h.