RDK-B
VOICE HAL APIs

Description

Functions

int32_t voice_hal_Init (void)
 
int32_t voice_hal_InitDB (void)
 
int32_t voice_hal_Deinit (void)
 
int32_t voice_hal_DeinitDB (void)
 
int32_t voice_hal_setVoiceProcessState (uint32_t service, VoiceProcessStateRequest_e voice_state)
 
int32_t voice_hal_getVoiceProcessState (uint32_t service, VoiceProcessStateRequest_e *pvoice_state)
 
int32_t voice_hal_getVoiceProcessStatus (uint32_t service, VoiceProcessStatus_e *pvoice_status)
 
int32_t voice_hal_getServiceVersion (char *service_version, uint32_t *pLength)
 
int32_t voice_hal_getConfigSoftwareVersion (uint32_t service, char *config_version, uint32_t *pLength)
 
int32_t voice_hal_getCountServices (uint32_t *serviceCount)
 
int32_t voice_hal_getCountProfiles (uint32_t service, uint32_t *profileCount)
 
int32_t voice_hal_getCountLines (uint32_t service, uint32_t profile, uint32_t *lineCount)
 
int32_t voice_hal_getCountPhyInterfaces (uint32_t service, uint32_t *phyCount)
 
int32_t voice_hal_getBoundIfName (uint32_t service, char *bound_if_name, uint32_t *pLength)
 
int32_t voice_hal_setBoundIfName (uint32_t service, const char *bound_if_name)
 
int32_t voice_hal_setIpAddressFamily (uint32_t service, const char *address_family)
 
int32_t voice_hal_getIpAddressFamily (uint32_t service, char *address_family, uint32_t *pLength)
 
int32_t voice_hal_setLinkState (VoiceHalIpLinkState_e state)
 
int32_t voice_hal_setIpWanAddress (uint32_t service, const char *boundIpAddress)
 
int32_t voice_hal_getIpWanAddress (uint32_t service, char *boundIpAddress, uint32_t *pLength)
 
int32_t voice_hal_getTestState (uint32_t service, uint32_t phy_interface, char *testState, uint32_t *pLength)
 
int32_t voice_hal_setTestState (uint32_t service, uint32_t phy_interface, char *testState)
 
int32_t voice_hal_getTestResult (uint32_t service, uint32_t phy_interface, char *test_result, uint32_t *pLength)
 
int32_t voice_hal_setTestSelector (uint32_t service, uint32_t phy_interface, char *test_selector)
 
int32_t voice_hal_getTestSelector (uint32_t service, uint32_t phy_interface, char *testSelector, uint32_t *pLength)
 
int32_t voice_hal_getPOSTTipGroundVoltageACParameter (uint32_t service, uint32_t phy_interface, char *pValue, uint32_t *pLength)
 
int32_t voice_hal_getPOSTTipGroundVoltageDCParameter (uint32_t service, uint32_t phy_interface, char *pValue, uint32_t *pLength)
 
int32_t voice_hal_getPOSTRingGroundVoltageACParameter (uint32_t service, uint32_t phy_interface, char *pValue, uint32_t *pLength)
 
int32_t voice_hal_getPOSTRingGroundVoltageDCParameter (uint32_t service, uint32_t phy_interface, char *pValue, uint32_t *pLength)
 
int32_t voice_hal_getPOSTTipGroundImpedanceParameter (uint32_t service, uint32_t phy_interface, char *pValue, uint32_t *pLength)
 
int32_t voice_hal_getPOSTRingGroundImpedanceParameter (uint32_t service, uint32_t phy_interface, char *pValue, uint32_t *pLength)
 
int32_t voice_hal_getPOSTTipRingImpedanceParameter (uint32_t service, uint32_t phy_interface, char *pValue, uint32_t *pLength)
 
int32_t voice_hal_setCallingFeatures (uint32_t service, uint32_t profile, uint32_t line, VoiceCallFeatureType_e eFeature, bool bStatus)
 
int32_t voice_hal_getCallingFeatures (uint32_t service, uint32_t profile, uint32_t line, VoiceCallFeatureType_e eFeature, bool *pStatus)
 
int32_t voice_hal_getOutboundProxyAddresses (uint32_t service, uint32_t profile, uint32_t line, char *pProxyAddresses, uint32_t *pLength)
 
int32_t voice_hal_getOutboundProxy (uint32_t service, uint32_t profile, char *ipNameAddress, uint32_t *pLength)
 
int32_t voice_hal_setOutboundProxy (uint32_t service, uint32_t profile, const char *ipNameAddress)
 
int32_t voice_hal_getOutboundProxyPort (uint32_t service, uint32_t profile, uint32_t *port)
 
int32_t voice_hal_setOutboundProxyPort (uint32_t service, uint32_t profile, uint32_t port)
 
int32_t voice_hal_getProxyServer (uint32_t service, uint32_t profile, char *proxyServer, uint32_t *pLength)
 
int32_t voice_hal_setProxyServer (uint32_t service, uint32_t profile, const char *proxyServer)
 
int32_t voice_hal_getProxyServerPort (uint32_t service, uint32_t profile, uint32_t *port)
 
int32_t voice_hal_setProxyServerPort (uint32_t service, uint32_t profile, uint32_t port)
 
int32_t voice_hal_getRegistrarServerPort (uint32_t service, uint32_t profile, uint32_t *port)
 
int32_t voice_hal_setRegistrarServerPort (uint32_t service, uint32_t profile, uint32_t port)
 
int32_t voice_hal_setRegistrarServer (uint32_t service, uint32_t profile, const char *ipNameAddress)
 
int32_t voice_hal_getRegistrarServer (uint32_t service, uint32_t profile, char *ipNameAddress, uint32_t *pLength)
 
int32_t voice_hal_setLogServer (uint32_t service, uint32_t profile, const char *ipNameAddress)
 
int32_t voice_hal_setLogServerPort (uint32_t service, uint32_t profile, uint32_t ipPort)
 
int32_t voice_hal_getLogServer (uint32_t service, uint32_t profile, char *logServerName, uint32_t *puiLength)
 
int32_t voice_hal_getLogServerPort (uint32_t service, uint32_t profile, uint32_t *ipPort)
 
int32_t voice_hal_setUserAgentDomain (uint32_t service, uint32_t profile, const char *ipDomain)
 
int32_t voice_hal_getUserAgentDomain (uint32_t service, uint32_t profile, char *ipDomain, uint32_t *pLength)
 
int32_t voice_hal_setConferencingUri (uint32_t service, uint32_t profile, const char *pUri)
 
int32_t voice_hal_getConferencingUri (uint32_t service, uint32_t profile, char *uri, uint32_t *pLength)
 
int32_t voice_hal_setEnableNetworkDisconnect (uint32_t service, uint32_t profile, bool enableDisconnect)
 
int32_t voice_hal_getEnableNetworkDisconnect (uint32_t service, uint32_t profile, bool *enableDisconnect)
 
int32_t voice_hal_setEnablePrackRequired (uint32_t service, uint32_t profile, bool enablePrackRequired)
 
int32_t voice_hal_getEnablePrackRequired (uint32_t service, uint32_t profile, bool *enablePrackRequired)
 
int32_t voice_hal_getDigitMap (uint32_t service, uint32_t profile, VoiceHalDigitMap_e map_type, char *digit_map_string, uint32_t *uiBufLen)
 
int32_t voice_hal_setDigitMap (uint32_t service, uint32_t profile, VoiceHalDigitMap_e map_type, const char *digit_map_string)
 
int32_t voice_hal_setSipDscpMark (uint32_t service, uint32_t profile, uint32_t dscp)
 
int32_t voice_hal_getSipDscpMark (uint32_t service, uint32_t profile, uint32_t *dscp)
 
int32_t voice_hal_setSipEthernetPriorityMark (uint32_t service, uint32_t profile, int32_t priority)
 
int32_t voice_hal_getSipEthernetPriorityMark (uint32_t service, uint32_t profile, int32_t *priority)
 
int32_t voice_hal_getSipSKBMark (uint32_t service, uint32_t profile, uint32_t *mark)
 
int32_t voice_hal_setRtpDscpMark (uint32_t service, uint32_t profile, uint32_t dscp)
 
int32_t voice_hal_getRtpDscpMark (uint32_t service, uint32_t profile, uint32_t *dscp)
 
int32_t voice_hal_setRtpEthernetPriorityMark (uint32_t service, uint32_t profile, int32_t priority)
 
int32_t voice_hal_getRtpEthernetPriorityMark (uint32_t service, uint32_t profile, int32_t *priority)
 
int32_t voice_hal_getRtpSKBMark (uint32_t service, uint32_t profile, uint32_t *mark)
 
int32_t voice_hal_setReceiveGain (uint32_t service, uint32_t profile, uint32_t line, int32_t gain)
 
int32_t voice_hal_getReceiveGain (uint32_t service, uint32_t profile, uint32_t line, int32_t *gain)
 
int32_t voice_hal_setTransmitGain (uint32_t service, uint32_t profile, uint32_t line, int32_t gain)
 
int32_t voice_hal_getTransmitGain (uint32_t service, uint32_t profile, uint32_t line, int32_t *gain)
 
int32_t voice_hal_setDisableLoopCurrentUntilRegistered (uint32_t service, bool disable)
 
int32_t voice_hal_getDisableLoopCurrentUntilRegistered (uint32_t service, bool *disabled)
 
int32_t voice_hal_setLoggingEnable (bool enable)
 
int32_t voice_hal_getLoggingEnable (bool *enable)
 
int32_t voice_hal_setCCTKTraceGroup (uint32_t service, const char *bitmask)
 
int32_t voice_hal_getCCTKTraceGroup (uint32_t service, char *bitmask, uint32_t *pLength)
 
int32_t voice_hal_setCCTKTraceLevel (uint32_t service, const char *logLevel)
 
int32_t voice_hal_getCCTKTraceLevel (uint32_t service, char *traceLevel, uint32_t *pLength)
 
int32_t voice_hal_setLoggingLevel (uint32_t service, uint32_t uLevel)
 
int32_t voice_hal_getLoggingLevel (uint32_t service, uint32_t *pLevel)
 
int32_t voice_hal_setModuleLogLevels (uint32_t service, const char *logLevels)
 
int32_t voice_hal_getModuleLogLevels (uint32_t service, char *logLevels, uint32_t *pLength)
 
int32_t voice_hal_getCallState (uint32_t service, uint32_t profile, uint32_t line, VoiceHalCallState_e *callState)
 
int32_t voice_hal_getDirectoryNumber (uint32_t service, uint32_t profile, uint32_t line, char *directoryNumber, uint32_t *pLength)
 
int32_t voice_hal_setDirectoryNumber (uint32_t service, uint32_t profile, uint32_t line, char *buffer)
 
int32_t voice_hal_setLineEnable (uint32_t service, uint32_t profile, uint32_t line, VoiceHalLineEnable_e eLineEnable)
 
int32_t voice_hal_getLineEnable (uint32_t service, uint32_t profile, uint32_t line, VoiceHalLineEnable_e *peLineEnable)
 
int32_t voice_hal_getAuthCredentials (uint32_t service, uint32_t profile, uint32_t line, VoiceHalAuthCredentialType_e eAuthCredential, char *pBuffer, uint32_t *pLength)
 
int32_t voice_hal_setAuthCredentials (uint32_t service, uint32_t profile, uint32_t line, VoiceHalAuthCredentialType_e eAuthCredential, char *pBuffer)
 
int32_t voice_hal_getSipURI (uint32_t service, uint32_t profile, uint32_t line, char *pSipUri, uint32_t *pLength)
 
int32_t voice_hal_setSipUri (uint32_t service, uint32_t profile, uint32_t line, const char *buffer)
 
int32_t voice_hal_getLineStatus (uint32_t service, uint32_t profile, uint32_t line, VoiceHalLineStatus_e *lineState)
 
int32_t voice_hal_setDigitTimer (uint32_t service, uint32_t profile, VoiceHalDigitTimer_e digit_timer, uint32_t timer_value)
 
int32_t voice_hal_getDigitTimer (uint32_t service, uint32_t profile, VoiceHalDigitTimer_e digit_timer, uint32_t *timer_value)
 
int32_t voice_hal_getLineStats (uint32_t service, uint32_t profile, uint32_t lineIndex, TelcoVoipAgent_VoiceService_Stats_t *output_stats_struct)
 
int32_t voice_hal_resetLineStats (uint32_t service, uint32_t profile, uint32_t lineIndex)
 
void voice_hal_print_debug_counters ()
 

Function Documentation

◆ voice_hal_Init()

int32_t voice_hal_Init ( void  )

@description Init the Voice Hal.

Parameters
None
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls.

◆ voice_hal_InitDB()

int32_t voice_hal_InitDB ( void  )

@description Retrieves the global information for all shared DBs and makes them accessible locally.

Parameters
None
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls.

◆ voice_hal_Deinit()

int32_t voice_hal_Deinit ( void  )

@description Releases all resources & closes all connections made during voice_hal_Init().

Parameters
None
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. Since no sensible action can be taken on the RDK_FAILURE case, just log it & ignore.

◆ voice_hal_DeinitDB()

int32_t voice_hal_DeinitDB ( void  )

@description Releases all resources & closes all connections made during voice_hal_InitDB().

Parameters
None
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. Since no sensible action can be taken on the RDK_FAILURE case, just log it & ignore.

◆ voice_hal_setVoiceProcessState()

int32_t voice_hal_setVoiceProcessState ( uint32_t  service,
VoiceProcessStateRequest_e  voice_state 
)

◆ voice_hal_getVoiceProcessState()

int32_t voice_hal_getVoiceProcessState ( uint32_t  service,
VoiceProcessStateRequest_e pvoice_state 
)

◆ voice_hal_getVoiceProcessStatus()

int32_t voice_hal_getVoiceProcessStatus ( uint32_t  service,
VoiceProcessStatus_e pvoice_status 
)

◆ voice_hal_getServiceVersion()

int32_t voice_hal_getServiceVersion ( char *  service_version,
uint32_t *  pLength 
)

@description Get a string identifying the voice software present

Parameters
char*service_version - output a pointer to a null-terminated string identifying the voice software version The returned string will be ASCII (7-bit, no Unicode/UTF-8)
uint32_t*pLength - input/output the buffer length
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getConfigSoftwareVersion()

int32_t voice_hal_getConfigSoftwareVersion ( uint32_t  service,
char *  config_version,
uint32_t *  pLength 
)

@description Get a string identifying the software configuration version

Parameters
char*config_version - output a pointer to a null-terminated string identifying the software configuration version The returned string will be ASCII (7-bit, no Unicode/UTF-8)
uint32_t*pLength - input/output the buffer length
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getCountServices()

int32_t voice_hal_getCountServices ( uint32_t *  serviceCount)

@description Get the count of voice services present. Used to enumerate through services

Parameters
uint32_t*serviceCount - output on return the number of voice services present
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getCountProfiles()

int32_t voice_hal_getCountProfiles ( uint32_t  service,
uint32_t *  profileCount 
)

@description Get the count of profiles present. Used to enumerate through profiles

Parameters
uint32_tservice - input the voice service whose profiles are being queried
uint32_t*profileCount - output on return the number of voice profiles present
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getCountLines()

int32_t voice_hal_getCountLines ( uint32_t  service,
uint32_t  profile,
uint32_t *  lineCount 
)

@description Get the count of voice lines present. Used to enumerate through servcies/profiles/lines

Parameters
uint32_tservice - input the voice service whose profiles are being queried
uint32_tprofile - input the profile being queried
uint32_t*lineCount - output on return the number of voice profiles present
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getCountPhyInterfaces()

int32_t voice_hal_getCountPhyInterfaces ( uint32_t  service,
uint32_t *  phyCount 
)

@description Get the count of physical interfaces present. Used to enumerate them in testing

Parameters
uint32_tservice - input the voice service for which the number of interfaces is being queried
uint32_t*phyCount - output on return the number of v present
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getBoundIfName()

int32_t voice_hal_getBoundIfName ( uint32_t  service,
char *  bound_if_name,
uint32_t *  pLength 
)

@description Get a string idntifying the interface to which this service is bound

Parameters
uint32_tservice - input the voice service being queried
char*bound_if_name - output pointer to the name of the interface, or the special values 'Any_WAN', 'Any_LAN'.
unsignedint *pLength - input/output the buffer length
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setBoundIfName()

int32_t voice_hal_setBoundIfName ( uint32_t  service,
const char *  bound_if_name 
)

@description Set the interface to which the specified service is bound

Parameters
uint32_tservice - input the voice service being configured
constchar *bound_if_name - input the name of the interface, or the special values 'Any_WAN', 'Any_LAN'.
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setIpAddressFamily()

int32_t voice_hal_setIpAddressFamily ( uint32_t  service,
const char *  address_family 
)

@description Set either IPv4 or IPv6 addressing for voice

Parameters
uint32_tservice - input the voice service being configured
char*address_family - input the AF type,
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getIpAddressFamily()

int32_t voice_hal_getIpAddressFamily ( uint32_t  service,
char *  address_family,
uint32_t *  pLength 
)

@description get the address family for voice either IPv4 or IPv6

Parameters
uint32_tservice - input the voice service being configured
char*p_address_family - output pointer to the AF type,
uint32_t*pLength - input/output the buffer length
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
return RDK_SUCCESS;

◆ voice_hal_setLinkState()

int32_t voice_hal_setLinkState ( VoiceHalIpLinkState_e  state)

@description In response to the link state event, set the link state to up or down

Parameters
VoiceHalIpLinkState_estate - input either VOICE_HAL_IP_LINK_STATE_DOWN or VOICE_HAL_IP_LINK_STATE_UP
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setIpWanAddress()

int32_t voice_hal_setIpWanAddress ( uint32_t  service,
const char *  boundIpAddress 
)

@description In response to the ipv4/ipv6_wan_ipaddr events, set the IPv6 WAN address

Parameters
uint32_tservice - input the voice service whose IP address is to be set
constchar *boundIpAddress - IP address of WAN interface
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getIpWanAddress()

int32_t voice_hal_getIpWanAddress ( uint32_t  service,
char *  boundIpAddress,
uint32_t *  pLength 
)

@description Get the WAN address (IPv4 or IPv6)

Parameters
uint32_tservice - input the voice service whose IP address is to be retrieved
char*boundIpAddress - IP address of WAN interface, space is allocated by the caller
uint32_t*pLength - max input buffer length
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getTestState()

int32_t voice_hal_getTestState ( uint32_t  service,
uint32_t  phy_interface,
char *  testState,
uint32_t *  pLength 
)

@description get the state of the diagnostic test system - ready/busy/in error

Parameters
uint32_tservice - input the voice service being configured
char*phy_interface - input the physical network interface being queried
char*testState - output the AF type,
uint32_t*pLength - input/output buffer length
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setTestState()

int32_t voice_hal_setTestState ( uint32_t  service,
uint32_t  phy_interface,
char *  testState 
)

@description set the state of the diagnostic test system - requested

Parameters
uint32_tservice - input the voice service being configured
uint32_tphy_interface - input the physical network interface being queried
char*testState - state of the diag test,
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getTestResult()

int32_t voice_hal_getTestResult ( uint32_t  service,
uint32_t  phy_interface,
char *  test_result,
uint32_t *  pLength 
)

@description get the result of the selected test

Parameters
uint32_tservice - input the voice service being queried
uint32_tphy_interface - input the physical network interface being queried
char*test_result - output the test result
uint32_t*pLength - input/output buffer length
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setTestSelector()

int32_t voice_hal_setTestSelector ( uint32_t  service,
uint32_t  phy_interface,
char *  test_selector 
)

@description select the test to be performed

Parameters
uint32_tservice - input the voice service being queried
uint32_tphy_interface - input the physical network interface being queried
char*test_selector - input the GR-909 test to perform
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getTestSelector()

int32_t voice_hal_getTestSelector ( uint32_t  service,
uint32_t  phy_interface,
char *  testSelector,
uint32_t *  pLength 
)

@description read the number of the most recently performed test

Parameters
uint32_tservice - input the voice service being queried
uint32_tphy_interface - input the physical network interface being queried
uint32_t*test_selector - output the GR-909 test last started
uint32_t*pLength - input/output buffer length
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getPOSTTipGroundVoltageACParameter()

int32_t voice_hal_getPOSTTipGroundVoltageACParameter ( uint32_t  service,
uint32_t  phy_interface,
char *  pValue,
uint32_t *  pLength 
)

@description get the POST result for Tip Ground Voltage AC

Parameters
uint32_tservice - input the voice service index
uint32_tuiPhyInterface - input the uiPhyInterface index
char*pValue - output the POST parameter value
uint32_t*pLength - input/output the buffer size
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
RDK_ERROR_OOMif buffer length insufficient
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getPOSTTipGroundVoltageDCParameter()

int32_t voice_hal_getPOSTTipGroundVoltageDCParameter ( uint32_t  service,
uint32_t  phy_interface,
char *  pValue,
uint32_t *  pLength 
)

@description get the POST result for Tip Ground Voltage DC

Parameters
uint32_tservice - input the voice service index
uint32_tuiPhyInterface - input the uiPhyInterface index
char*pValue - output the POST parameter value
uint32_t*pLength - input/output the buffer size
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
RDK_ERROR_OOMif buffer length insufficient
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getPOSTRingGroundVoltageACParameter()

int32_t voice_hal_getPOSTRingGroundVoltageACParameter ( uint32_t  service,
uint32_t  phy_interface,
char *  pValue,
uint32_t *  pLength 
)

@description get the POST result for Ring Ground Voltage AC

Parameters
uint32_tservice - input the voice service index
uint32_tuiPhyInterface - input the uiPhyInterface index
char*pValue - output the POST parameter value
uint32_t*pLength - input/output the buffer size
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
RDK_ERROR_OOMif buffer length insufficient
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getPOSTRingGroundVoltageDCParameter()

int32_t voice_hal_getPOSTRingGroundVoltageDCParameter ( uint32_t  service,
uint32_t  phy_interface,
char *  pValue,
uint32_t *  pLength 
)

@description get the POST result for Ring Ground Voltage DC

Parameters
uint32_tservice - input the voice service index
uint32_tuiPhyInterface - input the uiPhyInterface index
char*pValue - output the POST parameter value
uint32_t*pLength - input/output the buffer size
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
RDK_ERROR_OOMif buffer length insufficient
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getPOSTTipGroundImpedanceParameter()

int32_t voice_hal_getPOSTTipGroundImpedanceParameter ( uint32_t  service,
uint32_t  phy_interface,
char *  pValue,
uint32_t *  pLength 
)

@description get the POST result for Tip Ground Impedance

Parameters
uint32_tservice - input the voice service index
uint32_tuiPhyInterface - input the uiPhyInterface index
char*pValue - output the POST parameter value
uint32_t*pLength - input/output the buffer size
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
RDK_ERROR_OOMif buffer length insufficient
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getPOSTRingGroundImpedanceParameter()

int32_t voice_hal_getPOSTRingGroundImpedanceParameter ( uint32_t  service,
uint32_t  phy_interface,
char *  pValue,
uint32_t *  pLength 
)

@description get the POST result for Ring Ground Impedance

Parameters
uint32_tservice - input the voice service index
uint32_tuiPhyInterface - input the uiPhyInterface index
char*pValue - output the POST parameter value
uint32_t*pLength - input/output the buffer size
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
RDK_ERROR_OOMif buffer length insufficient
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getPOSTTipRingImpedanceParameter()

int32_t voice_hal_getPOSTTipRingImpedanceParameter ( uint32_t  service,
uint32_t  phy_interface,
char *  pValue,
uint32_t *  pLength 
)

@description get the POST result for Tip Ring Impedance

Parameters
uint32_tservice - input the voice service index
uint32_tuiPhyInterface - input the uiPhyInterface index
char*pValue - output the POST parameter value
uint32_t*pLength - input/output the buffer size
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
RDK_ERROR_OOMif buffer length insufficient
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setCallingFeatures()

int32_t voice_hal_setCallingFeatures ( uint32_t  service,
uint32_t  profile,
uint32_t  line,
VoiceCallFeatureType_e  eFeature,
bool  bStatus 
)

@description enable or disable the calling features for this line

Parameters
uint32_tservice - input the voice service
uint32_tprofile - input the voice profile
uint32_tline - input the voice line number
VoiceCallFeatureType_eeFeature - input the voice calling feature type
boolbStatus - input the voice calling feature status
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getCallingFeatures()

int32_t voice_hal_getCallingFeatures ( uint32_t  service,
uint32_t  profile,
uint32_t  line,
VoiceCallFeatureType_e  eFeature,
bool *  pStatus 
)

@description read the calling features for this line

Parameters
uint32_tservice - input the voice service
uint32_tprofile - input the voice profile
uint32_tline - input the voice line number
VoiceCallFeatureType_eeFeature - input the voice calling feature type
bool*pStatus - output the voice calling feature status
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getOutboundProxyAddresses()

int32_t voice_hal_getOutboundProxyAddresses ( uint32_t  service,
uint32_t  profile,
uint32_t  line,
char *  pProxyAddresses,
uint32_t *  pLength 
)

@description get a list of the resolved IP addresses from the FQDN of the configured outbound proxy

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tline - input the voice line number
char**pProxyAddresses - output the list of resolved IP addresses as a null-terminated string e.g. "192.168.0.1 192.168.20.10" etc
uint32_t*pLength - input/output buffer length
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getOutboundProxy()

int32_t voice_hal_getOutboundProxy ( uint32_t  service,
uint32_t  profile,
char *  ipNameAddress,
uint32_t *  pLength 
)

@description get the name/address of the SIP outbound proxy

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
char*ipNameAddress - output the name or IP address of Outbound proxy e.g. "10.241.16.3" or "proxy.sky.com"
uint32_t*pLength - input/output buffer length
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setOutboundProxy()

int32_t voice_hal_setOutboundProxy ( uint32_t  service,
uint32_t  profile,
const char *  ipNameAddress 
)

@description set the name/address of the SIP outbound proxy

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
char*ipNameAddress - input the name or IP address of Outbound proxy e.g. "10.241.16.3" or "proxy.sky.com"
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getOutboundProxyPort()

int32_t voice_hal_getOutboundProxyPort ( uint32_t  service,
uint32_t  profile,
uint32_t *  port 
)

@description get the port of the SIP outbound proxy

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_t*port - output the port value of Outbound proxy e.g. "888"
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setOutboundProxyPort()

int32_t voice_hal_setOutboundProxyPort ( uint32_t  service,
uint32_t  profile,
uint32_t  port 
)

@description set the port of the SIP outbound proxy

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tport - input the port value of Outbound proxy e.g. "888"
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getProxyServer()

int32_t voice_hal_getProxyServer ( uint32_t  service,
uint32_t  profile,
char *  proxyServer,
uint32_t *  pLength 
)

@description get the name/address of the SIP proxy server

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
char* proxyServer - output buffer to get proxy server name e.g. "voip.sky.com"
uint32_t*pLength - input/output buffer length
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setProxyServer()

int32_t voice_hal_setProxyServer ( uint32_t  service,
uint32_t  profile,
const char *  proxyServer 
)

@description set the name/address of the SIP proxy server

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
char* proxyServer - input buffer to set proxy server name e.g. "voip.sky.com"
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getProxyServerPort()

int32_t voice_hal_getProxyServerPort ( uint32_t  service,
uint32_t  profile,
uint32_t *  port 
)

@description get the port of the SIP proxy server

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_t*port - output the port value of proxy server
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setProxyServerPort()

int32_t voice_hal_setProxyServerPort ( uint32_t  service,
uint32_t  profile,
uint32_t  port 
)

@description set the port of the proxy server

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tport - input the port value of proxy server e.g. "888"
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getRegistrarServerPort()

int32_t voice_hal_getRegistrarServerPort ( uint32_t  service,
uint32_t  profile,
uint32_t *  port 
)

@description get the port of the Registrar server port

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_t*port - output the port value of Registrar server port
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setRegistrarServerPort()

int32_t voice_hal_setRegistrarServerPort ( uint32_t  service,
uint32_t  profile,
uint32_t  port 
)

@description set the port of the Registrar server port

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tport - input the port value of Registrar server port
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setRegistrarServer()

int32_t voice_hal_setRegistrarServer ( uint32_t  service,
uint32_t  profile,
const char *  ipNameAddress 
)

@description set the name/address of the SIP registrar server

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
char*ipNameAddress - input the name or IP address as a null-terminated string e.g. "10.241.16.3" or "proxy.sky.com"
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getRegistrarServer()

int32_t voice_hal_getRegistrarServer ( uint32_t  service,
uint32_t  profile,
char *  ipNameAddress,
uint32_t *  pLength 
)

@description get the name/address of the SIP registrar server

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
char**ipNameAddress - output the name or IP address as a null-terminated string e.g. "10.241.16.3" or "proxy.sky.com"
uint32_t*pLength - input/output buffer length Where a host name is supplied, it will meet RFC1123
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setLogServer()

int32_t voice_hal_setLogServer ( uint32_t  service,
uint32_t  profile,
const char *  ipNameAddress 
)

@description set the name/address and port of the voice logging server

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
char*ipNameAddress - input the name or IP address as a null-terminated string e.g. "10.241.16.3" or "proxy.sky.com" Where a host name is returned, it will meet RFC1123
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setLogServerPort()

int32_t voice_hal_setLogServerPort ( uint32_t  service,
uint32_t  profile,
uint32_t  ipPort 
)

@description set the name/address and port of the voice logging server

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tipPort - the IP port number Where a host name is returned, it will meet RFC1123
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getLogServer()

int32_t voice_hal_getLogServer ( uint32_t  service,
uint32_t  profile,
char *  logServerName,
uint32_t *  puiLength 
)

@description get the name/address and port of the voice logging server

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
char*ipNameAddress - output the name or IP address as a null-terminated string e.g. "10.241.16.3" or "proxy.sky.com"
uint32_t*puiLength - Output/input the buffer size Where a host name is returned, it will meet RFC1123
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getLogServerPort()

int32_t voice_hal_getLogServerPort ( uint32_t  service,
uint32_t  profile,
uint32_t *  ipPort 
)

@description get the name/address and port of the voice logging server

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint16_t*ipPort - output the IP port number Where a host name is returned, it will meet RFC1123
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setUserAgentDomain()

int32_t voice_hal_setUserAgentDomain ( uint32_t  service,
uint32_t  profile,
const char *  ipDomain 
)

@description set the name/address of the CPE domain string

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
char*ipDomain - input the CPE domain as a null-terminated string e.g. "voip.sky.com" Where a host name is supplied, it will meet RFC1123
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getUserAgentDomain()

int32_t voice_hal_getUserAgentDomain ( uint32_t  service,
uint32_t  profile,
char *  ipDomain,
uint32_t *  pLength 
)

@description get the name/address of the CPE domain string

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
char**ipDomain - output the CPE domain as a null-terminated string e.g. "voip.sky.com"
uint32_t*pLength - input/output buffer length Where a host name is supplied, it will meet RFC1123 (no IDNA)
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setConferencingUri()

int32_t voice_hal_setConferencingUri ( uint32_t  service,
uint32_t  profile,
const char *  pUri 
)

@description set the URI of the conferencing server

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
char*pUri - input the URI as a null-terminated string e.g. "sip:conf@sky.com" The domain name is supplied as a UTF-8 string meeting RFC1123 (no IDNA)
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getConferencingUri()

int32_t voice_hal_getConferencingUri ( uint32_t  service,
uint32_t  profile,
char *  uri,
uint32_t *  pLength 
)

@description set the URI of the conferencing server

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
char**uri - output the URI as a null-terminated string e.g. "sip:conf@sky.com"
uint32_t*pLength - input/output buffer length
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setEnableNetworkDisconnect()

int32_t voice_hal_setEnableNetworkDisconnect ( uint32_t  service,
uint32_t  profile,
bool  enableDisconnect 
)

@description set the enable/disable state of the network disconnect flag

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
boolenableDisconnect
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getEnableNetworkDisconnect()

int32_t voice_hal_getEnableNetworkDisconnect ( uint32_t  service,
uint32_t  profile,
bool *  enableDisconnect 
)

@description set the enable/disable state of the network disconnect flag

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
bool*enableDisconnect - output the state of the disconnect flag
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setEnablePrackRequired()

int32_t voice_hal_setEnablePrackRequired ( uint32_t  service,
uint32_t  profile,
bool  enablePrackRequired 
)

@description set the enable/disable state of the PRACK required

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
boolenablePrackRequired
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getEnablePrackRequired()

int32_t voice_hal_getEnablePrackRequired ( uint32_t  service,
uint32_t  profile,
bool *  enablePrackRequired 
)

@description set the enable/disable state of the PRACK required

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
bool*enablePrackRequired - output the state of the PRACK required
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getDigitMap()

int32_t voice_hal_getDigitMap ( uint32_t  service,
uint32_t  profile,
VoiceHalDigitMap_e  map_type,
char *  digit_map_string,
uint32_t *  uiBufLen 
)

◆ voice_hal_setDigitMap()

int32_t voice_hal_setDigitMap ( uint32_t  service,
uint32_t  profile,
VoiceHalDigitMap_e  map_type,
const char *  digit_map_string 
)

@description Set the map of permissible digits for normal or emergency use in this region

Parameters
char*digit_map_string - input null-terminated list of digits
intlineIndex - the voice line to be configured (0 based)
VoiceHalDigitMap_emap_type - input normal or emergency digit map
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setSipDscpMark()

int32_t voice_hal_setSipDscpMark ( uint32_t  service,
uint32_t  profile,
uint32_t  dscp 
)

@description set the diffserv code point applied to outgoing SIP packets

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tdscp - input DSCP code point
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getSipDscpMark()

int32_t voice_hal_getSipDscpMark ( uint32_t  service,
uint32_t  profile,
uint32_t *  dscp 
)

@description get the diffserv code point applied to outgoing SIP packets

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tdscp - output DSCP code point
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setSipEthernetPriorityMark()

int32_t voice_hal_setSipEthernetPriorityMark ( uint32_t  service,
uint32_t  profile,
int32_t  priority 
)

@description set the ethernet priority code used for outgoing SIP packets

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
int32_tpriority - input ethernet priority code
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getSipEthernetPriorityMark()

int32_t voice_hal_getSipEthernetPriorityMark ( uint32_t  service,
uint32_t  profile,
int32_t *  priority 
)

@description get the ethernet priority code used for outgoing SIP packets

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
int32_tpriority - output ethernet priority code
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getSipSKBMark()

int32_t voice_hal_getSipSKBMark ( uint32_t  service,
uint32_t  profile,
uint32_t *  mark 
)

@description get the ethernet mark used for outgoing SIP packets

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tmark - ethernet mark value
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setRtpDscpMark()

int32_t voice_hal_setRtpDscpMark ( uint32_t  service,
uint32_t  profile,
uint32_t  dscp 
)

@description set the diffserv code point applied to outgoing RTP packets

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tdscp - input DSCP code point
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getRtpDscpMark()

int32_t voice_hal_getRtpDscpMark ( uint32_t  service,
uint32_t  profile,
uint32_t *  dscp 
)

@description get the diffserv code point applied to outgoing RTP packets

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tdscp - output DSCP code point
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setRtpEthernetPriorityMark()

int32_t voice_hal_setRtpEthernetPriorityMark ( uint32_t  service,
uint32_t  profile,
int32_t  priority 
)

@description set the ethernet priority code used for outgoing RTP packets

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
int32_tpriority - input ethernet priority code
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getRtpEthernetPriorityMark()

int32_t voice_hal_getRtpEthernetPriorityMark ( uint32_t  service,
uint32_t  profile,
int32_t *  priority 
)

@description get the ethernet priority code used for outgoing RTP packets

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
int32_tpriority - output ethernet priority code
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getRtpSKBMark()

int32_t voice_hal_getRtpSKBMark ( uint32_t  service,
uint32_t  profile,
uint32_t *  mark 
)

@description get the SKB(Socket Kernel Buffer) mark used for outgoing RTP packets

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tmark - ethernet mark value
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setReceiveGain()

int32_t voice_hal_setReceiveGain ( uint32_t  service,
uint32_t  profile,
uint32_t  line,
int32_t  gain 
)

@description set the post-decoding gain to be applied

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tline - input the telephone line number affected
int32_tgain - input signed post-decode gain applied in 0.1 dB steps
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getReceiveGain()

int32_t voice_hal_getReceiveGain ( uint32_t  service,
uint32_t  profile,
uint32_t  line,
int32_t *  gain 
)

@description get the post-decoding gain applied to the receive channel

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tline - input the telephone line number affected
int32_t*gain - output signed post-decode gain applied in 0.1 dB steps
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setTransmitGain()

int32_t voice_hal_setTransmitGain ( uint32_t  service,
uint32_t  profile,
uint32_t  line,
int32_t  gain 
)

@description set the pre-encoding gain to be applied

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tline - input the telephone line number affected
int32_tgain - input signed pre-encode gain applied in 0.1 dB steps
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getTransmitGain()

int32_t voice_hal_getTransmitGain ( uint32_t  service,
uint32_t  profile,
uint32_t  line,
int32_t *  gain 
)

@description get the pre-encoding gain applied to the transmit channel

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tline - input the telephone line number affected
int32_t*gain - output signed pre-encode gain applied in 0.1 dB steps
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setDisableLoopCurrentUntilRegistered()

int32_t voice_hal_setDisableLoopCurrentUntilRegistered ( uint32_t  service,
bool  disable 
)

@description

Parameters
uint32_tservice - input the voice service to be disabled until registered
booldisabled - input, true if loop current is to be disabled until line registered false otherwise
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous
Side Effects:\n None.

◆ voice_hal_getDisableLoopCurrentUntilRegistered()

int32_t voice_hal_getDisableLoopCurrentUntilRegistered ( uint32_t  service,
bool *  disabled 
)

@description

Parameters
uint32_tservice - input the voice service whose status is being queried
bool*disabled -= output, true if loop current is currently disabled until the line is registered false otherwise
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous
Side Effects:\n None.

◆ voice_hal_setLoggingEnable()

int32_t voice_hal_setLoggingEnable ( bool  enable)

@description enable/disable Ccsp logging in the TelcoVoIPAgent module

Parameters
boolenable - input true enables TelcoVoIP logging, false disables it
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getLoggingEnable()

int32_t voice_hal_getLoggingEnable ( bool *  enable)

@description enable/disable Ccsp logging in the TelcoVoIPAgent module

Parameters
bool*enable - input true TelcoVoIP logging is enabled, false otherwise
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setCCTKTraceGroup()

int32_t voice_hal_setCCTKTraceGroup ( uint32_t  service,
const char *  bitmask 
)

@description set the CCTK trace group bitmask

Parameters
uint32_tservice - input the voice affected
char*bitmask - input trace group bitmask
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous
Side Effects:\n None.

◆ voice_hal_getCCTKTraceGroup()

int32_t voice_hal_getCCTKTraceGroup ( uint32_t  service,
char *  bitmask,
uint32_t *  pLength 
)

@description get the CCTK trace group bitmask

Parameters
uint32_tservice - input the voice affected
char*bitmask - input trace group bitmask
uint32_t*pLength - input/output the buffer length
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous
Side Effects:\n None.

◆ voice_hal_setCCTKTraceLevel()

int32_t voice_hal_setCCTKTraceLevel ( uint32_t  service,
const char *  logLevel 
)

@description set the CCTK trace level

Parameters
uint32_tservice - input the voice service affected
char*logLevel - input trace log level as a null-terminated ASCII string
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous
Side Effects:\n None.

◆ voice_hal_getCCTKTraceLevel()

int32_t voice_hal_getCCTKTraceLevel ( uint32_t  service,
char *  traceLevel,
uint32_t *  pLength 
)

@description get the CCTK trace level

Parameters
uint32_tservice - input the voice service affected
char*traceLevel - input trace log level as a null-terminated ASCII string
uint32_t*pLength - input/output the buffer size
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous
Side Effects:\n None.

◆ voice_hal_setLoggingLevel()

int32_t voice_hal_setLoggingLevel ( uint32_t  service,
uint32_t  uLevel 
)

@description set the logging level for a voice service

Parameters
uint32_tservice - input the voice service affected
uint32_tuLevel - input the logging level to be applied
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous
Side Effects:\n None.

◆ voice_hal_getLoggingLevel()

int32_t voice_hal_getLoggingLevel ( uint32_t  service,
uint32_t *  pLevel 
)

@description get the logging level for a voice service

Parameters
uint32_tservice - input the voice service affected
uint32_t*pLevel - output the logging level for the service
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous
Side Effects:\n None.

◆ voice_hal_setModuleLogLevels()

int32_t voice_hal_setModuleLogLevels ( uint32_t  service,
const char *  logLevels 
)

@description set logging levels for specific voice modules

Parameters
uint32_tservice - input the voice service affected
char*bitmask - input trace group bitmask
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous
Side Effects:\n None.

◆ voice_hal_getModuleLogLevels()

int32_t voice_hal_getModuleLogLevels ( uint32_t  service,
char *  logLevels,
uint32_t *  pLength 
)

@description get logging levels for specific voice modules

Parameters
uint32_tservice - input the voice service affected
char*bitmask - output trace group bitmask
uint32_t*pLength - input/output the buffer size
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous
Side Effects:\n None.

◆ voice_hal_getCallState()

int32_t voice_hal_getCallState ( uint32_t  service,
uint32_t  profile,
uint32_t  line,
VoiceHalCallState_e callState 
)

@description get the call state for a specific line

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tline - input the telephone line number affected
VoiceHalCallState_e*callState - output the state of the call
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getDirectoryNumber()

int32_t voice_hal_getDirectoryNumber ( uint32_t  service,
uint32_t  profile,
uint32_t  line,
char *  directoryNumber,
uint32_t *  pLength 
)

@description get the directory number for the given line

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tline - input the telephone line number affected
char*directoryNumber - output a null terminated string giving the directory number
uint32_t*pLength - input/output the buffer size
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setDirectoryNumber()

int32_t voice_hal_setDirectoryNumber ( uint32_t  service,
uint32_t  profile,
uint32_t  line,
char *  buffer 
)

@description set the directory number for the given line

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tline - input the telephone line number affected
char*directoryNumber - input a null terminated string giving the directory number
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setLineEnable()

int32_t voice_hal_setLineEnable ( uint32_t  service,
uint32_t  profile,
uint32_t  line,
VoiceHalLineEnable_e  eLineEnable 
)

@description enable/disable a specific telephone line

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tline - input the telephone line number affected
VoiceHalLineStatus_eeLineEnable - input true to enable the given ATA line, false othewrwise
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getLineEnable()

int32_t voice_hal_getLineEnable ( uint32_t  service,
uint32_t  profile,
uint32_t  line,
VoiceHalLineEnable_e peLineEnable 
)

@description get the enable/disable state of a specific telephone line

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tline - input the telephone line number affected
VoiceHalLineStatus_e*peLineEnable - output true if the given ATA line is enabled, false othewrwise
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getAuthCredentials()

int32_t voice_hal_getAuthCredentials ( uint32_t  service,
uint32_t  profile,
uint32_t  line,
VoiceHalAuthCredentialType_e  eAuthCredential,
char *  pBuffer,
uint32_t *  pLength 
)

@description get the username+password used to authenticate the connection to the server This value always returns an empty string for password

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tline - input the telephone line number affected
VoiceHalAuthCredentialType_eeAuthCredential - input the user credential type
char*pBuffer - output the user name OR Password buffer
uint32_t*pLength - input/output buffer length
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
On reading, the password field will always be empty.

◆ voice_hal_setAuthCredentials()

int32_t voice_hal_setAuthCredentials ( uint32_t  service,
uint32_t  profile,
uint32_t  line,
VoiceHalAuthCredentialType_e  eAuthCredential,
char *  pBuffer 
)

@description set the username/password used to authenticate the connection to the server

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tline - input the telephone line number affected
VoiceHalAuthCredentialType_eeAuthCredential - input the user credential type
char*pBuffer - input the user name OR Password buffer
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
: this function is atomic. Either the call succeeds and both username and password are set, or the call fails and neither username nor password change

◆ voice_hal_getSipURI()

int32_t voice_hal_getSipURI ( uint32_t  service,
uint32_t  profile,
uint32_t  line,
char *  pSipUri,
uint32_t *  pLength 
)

@description get the URI by which the user agent will identify itself for this line

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tline - input the ATA line number affected
char*pSipUri - output pointer to a buffer holding the SIP URI
uint32_t*pLength - input the size of the buffer
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setSipUri()

int32_t voice_hal_setSipUri ( uint32_t  service,
uint32_t  profile,
uint32_t  line,
const char *  buffer 
)

@description set the URI by which the user agent identifies itself for this line

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tline - input the telephone line number affected
char*buffer - input a buffer holding the new URI as a null terminated string

NOTE: If empty, the actual URI used in the SIP signaling SHOULD be automatically formed by the CPE as: "sip:UserName@Domain" Where UserName is username given for this line in AuthUserName, and Domain is the domain given for this profile in VoiceProfile.{i}.SIP.UserAgentDomain. If VoiceProfile.{i}.SIP.UserAgentDomain is an empty string, then the IP address of the CPE SHOULD be used for the domain. If URI is non-empty, but is a SIP or SIPS URI that contains no "@" character, then the actual URI used in the SIP signaling SHOULD be automatically formed by the CPE by appending this parameter with an "@" character followed by the value of VoiceProfile.{i}.SIP.UserAgentDomain. If VoiceProfile.{i}.SIP.UserAgentDomain is an empty string, then the IP address of the CPE SHOULD be used for the domain.

Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getLineStatus()

int32_t voice_hal_getLineStatus ( uint32_t  service,
uint32_t  profile,
uint32_t  line,
VoiceHalLineStatus_e lineState 
)

@description get the status for a specific line

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tline - input the telephone line number affected
VoiceHalLineStatus_e*lineStatus - output the status of the line
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_setDigitTimer()

int32_t voice_hal_setDigitTimer ( uint32_t  service,
uint32_t  profile,
VoiceHalDigitTimer_e  digit_timer,
uint32_t  timer_value 
)

@description Set the digit timer, 'S' or 'Z

Parameters
VoiceHalDigitTimer_edigit_timer - input select the S or Z digit timers
intlineIndex - the voice line to be configured (0 based)
timer_value- input the number of seconds to set the timer value
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getDigitTimer()

int32_t voice_hal_getDigitTimer ( uint32_t  service,
uint32_t  profile,
VoiceHalDigitTimer_e  digit_timer,
uint32_t *  timer_value 
)

@description Get the digit timer, 'S' or 'Z

Parameters
VoiceHalDigitTimer_e*digit_timer - output value of the S or Z digit timers
intlineIndex - the voice line to be configured (0 based)
uint32_t*timer_value - output the number of seconds of the digit timer
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.

◆ voice_hal_getLineStats()

int32_t voice_hal_getLineStats ( uint32_t  service,
uint32_t  profile,
uint32_t  lineIndex,
TelcoVoipAgent_VoiceService_Stats_t output_stats_struct 
)

@description Get the statistics for a single voice line

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tline - input the telephone line number affected
TelcoVoipAgent_VoiceService_Stats_t*output_stats_struct - return structure with line stats
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function will take some time to complete

◆ voice_hal_resetLineStats()

int32_t voice_hal_resetLineStats ( uint32_t  service,
uint32_t  profile,
uint32_t  lineIndex 
)

@description Reset the voice line stats counters.

Parameters
uint32_tservice - input the voice service affected
uint32_tprofile - input the voice profile affected
uint32_tline - input the telephone line number affected
Returns
The status of the operation.
Return values
RDK_SUCCESSif successful.
RDK_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function may take some time to complete. It is assumed (but not required) that the stats are read before reset.

◆ voice_hal_print_debug_counters()

void voice_hal_print_debug_counters ( )

@description Prints global voice counters

Execution:\n Synchronous.
Side Effects:\n None.