TSPI_lineMonitorDigits, fonction (tspi.h)

Article
08/26/2023

La fonction TSPI_lineMonitorDigits active et désactive la détection sans débogage des chiffres reçus lors de l’appel. Chaque fois qu’un chiffre du ou des modes de chiffres spécifiés est détecté, un message LINE_MONITORDIGITS est envoyé à l’application par TAPI, indiquant le chiffre détecté.

Syntaxe

LONG TSPIAPI TSPI_lineMonitorDigits(
  HDRVCALL hdCall,
  DWORD    dwDigitModes
);

Paramètres

hdCall

Handle de l’appel sur lequel les chiffres doivent être détectés. L’état d’appel de hdCall peut être n’importe quel état sauf inactif ou déconnecté.

dwDigitModes

Mode(s) numérique(s) à surveiller. Un paramètre dwDigitModes avec la valeur 0 annule la surveillance des chiffres. Le paramètre dwDigitModes peut avoir l’une des constantes LINEDIGITMODE_.

Valeur retournée

Retourne zéro si la fonction réussit, ou un numéro d’erreur si une erreur se produit. Les valeurs de retour possibles sont les suivantes :

LINEERR_INVALCALLHANDLE, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALCALLSTATE, LINEERR_OPERATIONFAILED, LINEERR_INVALDIGITMODE, LINEERR_RESOURCEUNAVAIL, LINEERR_NOMEM.

Remarques

Cette fonction retourne zéro (réussite) lorsque l’analyse des chiffres est correctement lancée, et non lorsque l’analyse des chiffres est terminée. La surveillance des chiffres reste en vigueur jusqu’à ce qu’elle soit explicitement désactivée par un appel à TSPI_lineMonitorDigits avec dwDigitModes défini sur zéro, ou jusqu’à ce que l’appel passe à l’inactif. La fonction doit retourner zéro lorsque l’analyse des chiffres est annulée (autrement dit, lorsque le paramètre dwDigitModes est égal à zéro). Le fournisseur de services doit mettre fin à la surveillance des chiffres lorsque l’appel devient inactif. TAPI n’appelle pas spontanément TSPI_lineMonitorDigits pour mettre fin à la surveillance.

Bien que cette fonction puisse être appelée dans n’importe quel état d’appel, les chiffres sont généralement détectés uniquement lorsque l’appel est dans l’état connecté .

Chaque fois qu’un chiffre est détecté, le fournisseur de services envoie un message LINE_MONITORDIGITS à TAPI, en passant le chiffre détecté en tant que paramètre. Si LINEDIGITMODE_DTMF et LINEDIGITMODE_DTMFEND sont définis dans dwDigitModes, les deux messages LINE_MONITORDIGITS sont envoyés pour chaque chiffre.

TAPI peut utiliser TSPI_lineMonitorDigits pour activer ou désactiver la détection de chiffres sans tampon. Il peut utiliser TSPI_lineGatherDigits pour la détection de chiffres mis en mémoire tampon. Une fois la collecte de chiffres mis en mémoire tampon terminée, un message LINE_GATHERDIGITS est envoyé. La détection de chiffres mis en mémoire tampon et sans tampon peut être activée simultanément sur le même appel.