fonction TSPI_linePrepareAddToConference (tspi.h)

Article
03/13/2024

La fonction TSPI_linePrepareAddToConference prépare une téléconférence existante pour l’ajout d’une autre partie. Il crée un nouvel appel de consultation temporaire. La nouvelle consultation peut être ajoutée ultérieurement à la téléconférence.

Syntaxe

LONG TSPIAPI TSPI_linePrepareAddToConference(
  DRV_REQUESTID          dwRequestID,
  HDRVCALL               hdConfCall,
  HTAPICALL              htConsultCall,
  LPHDRVCALL             lphdConsultCall,
  LPLINECALLPARAMS const lpCallParams
);

Paramètres

dwRequestID

Identificateur de la requête asynchrone.

hdConfCall

Handle d’une téléconférence. L’état de l’appel de hdConfCall peut être connecté.

htConsultCall

Le handle TAPI pour le nouvel appel de consultation temporaire. Le fournisseur de services doit l’enregistrer et l’utiliser dans tous les appels suivants à la procédure LINEEVENT rapportant les événements sur le nouvel appel. L’état de l’appel de hdAddCall n’est pas applicable.

lphdConsultCall

Pointeur vers un HDRVCALL représentant l’identificateur du fournisseur de services pour le nouvel appel de consultation temporaire. Le fournisseur de services doit remplir cet emplacement avec son handle pour le nouvel appel avant que cette procédure ne retourne. Ce handle n’est pas valide si la fonction génère une erreur.

lpCallParams

Pointeur vers un LINECALLPARAMS contenant des paramètres d’appel à utiliser lors de l’établissement de l’appel de consultation. Ce paramètre a la valeur NULL si aucun paramètre de configuration d’appel spécial n’est souhaité.

Valeur retournée

Retourne dwRequestID ou un numéro d’erreur si une erreur se produit. Le paramètre réel lResult du ASYNC_COMPLETION correspondant est 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_BEARERMODEUNAVAIL, LINEERR_INVALLINESTATE, LINEERR_CALLUNAVAIL, LINEERR_INVALMEDIAMODE, LINEERR_CONFERENCEFULL, LINEERR_INVALRATE, LINEERR_INUSE, LINEERR_NOMEM, LINEERR_INVALADDRESSMODE, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALBEARERMODE, LINEERR_OPERATIONFAILED, LINEERR_INVALCALLPARAMS, LINEERR_RATEUNAVAIL, LINEERR_INVALCALLSTATE, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALCONFCALLHANDLE, LINEERR_USERUSERINFOTOOBIG.

Remarques

Le fournisseur de services retourne LINEERR_INVALLINESTATE si la ligne n’est actuellement pas dans un état dans lequel cette opération peut être effectuée. Le fournisseur de services doit indiquer une liste d’opérations actuellement valides dans le membre dwLineFeatures (de type LINEFEATURE) dans la structure LINEDEVSTATUS .

Le fournisseur de services retourne LINEERR_INVALCALLSTATE si la téléconférence n’est pas dans un état valide pour l’opération demandée.

Cette fonction place une conférence téléphonique existante dans l’état onHoldPendingConference et crée un appel de consultation qui peut être ajouté ultérieurement à la téléconférence existante avec TSPI_lineAddToConference.

L’appel de consultation peut être annulé à l’aide de TSPI_lineDrop. Il peut également être possible pour TAPI d’échanger entre l’appel de consultation et la téléconférence tenue avec TSPI_lineSwapHold. Le fournisseur de services effectue initialement une surveillance des médias sur le nouvel appel pour au moins l’ensemble des types de médias qui ont été surveillés sur la ligne.

Cette fonction diffère de la fonction TAPI correspondante en ce qu’elle suit le modèle TSPI pour commencer la durée de vie d’un appel. TAPI et le fournisseur de services échangent des handles opaques représentant l’appel entre eux. En outre, le fournisseur de services est autorisé à effectuer des rappels pour le nouvel appel avant qu’il ne retourne à partir de cette procédure. Dans tous les cas, le fournisseur de services doit également traiter le handle qu’il a retourné comme « non encore valide » jusqu’à ce que l’ASYNC_COMPLETION message correspondant signale la réussite. En d’autres termes, il ne doit pas émettre de messages LINEEVENT pour le nouvel appel ni l’inclure dans le nombre d’appels dans les messages ou status structures de données pour la ligne.