fonction lineSetupConference (tapi.h)

Article
08/26/2023

La fonction lineSetupConference configure une téléconférence pour l’ajout du tiers.

Syntaxe

LONG lineSetupConference(
  HCALL                  hCall,
  HLINE                  hLine,
  LPHCALL                lphConfCall,
  LPHCALL                lphConsultCall,
  DWORD                  dwNumParties,
  LPLINECALLPARAMS const lpCallParams
);

Paramètres

hCall

Gérez l’appel initial qui identifie la première partie d’une téléconférence. Dans certains environnements (comme décrit dans Fonctionnalités de l’appareil), un appel doit exister pour démarrer une téléconférence, et l’application doit être propriétaire de cet appel. Dans d’autres environnements de téléphonie, aucun appel n’existe initialement, hCall doit être laissé null et hLine doit être spécifié pour identifier la ligne sur laquelle la téléconférence doit être lancée. L’état d’appel de hCall doit être connecté.

hLine

Handle jusqu’à la ligne. Ce handle est utilisé pour identifier l’appareil de ligne sur lequel la téléconférence doit provenir si hCall a la valeur NULL. Le paramètre hLine est ignoré si hCall n’a pas la valeur NULL.

lphConfCall

Pointeur vers un handle HCALL. Cet emplacement est ensuite chargé avec un handle identifiant la conférence téléphonique nouvellement créée. L’application est le propriétaire unique initial de cet appel. L’état de l’appel de hConfCall n’est pas applicable.

lphConsultCall

Pointeur vers un handle HCALL. Lors de la configuration d’un appel pour l’ajout d’une nouvelle partie, un nouvel appel temporaire (appel de consultation) est automatiquement alloué. Initialement, l’application est le seul propriétaire de cet appel.

dwNumParties

Nombre attendu de parties à la téléconférence. Ce numéro est passé au fournisseur de services. Le fournisseur de services est libre de faire ce qu’il veut avec ce nombre : ignorez-le, utilisez-le comme indicateur pour allouer la bonne taille de pont de conférence à l’intérieur du commutateur, et ainsi de suite.

lpCallParams

Pointeur vers une structure LINECALLPARAMS contenant des paramètres d’appel à utiliser lors de l’établissement de l’appel de consultation. Ce paramètre peut être défini sur NULL si aucun paramètre de configuration d’appel spécial n’est souhaité.

Valeur retournée

Retourne un identificateur de requête positif si la fonction est terminée de manière asynchrone, ou un numéro d’erreur négatif si une erreur se produit. Le paramètre dwParam2 du message LINE_REPLY correspondant est égal à zéro si la fonction réussit ou s’il s’agit d’un nombre d’erreur négatif si une erreur se produit. Les valeurs de retour possibles sont les suivantes :

LINEERR_BEARERMODEUNAVAIL, LINEERR_UNINITIALIZED, LINEERR_CALLUNAVAIL, LINEERR_INVALMEDIAMODE, LINEERR_CONFERENCEFULL, LINEERR_INVALPOINTER, LINEERR_INUSE, LINEERR_INVALRATE, LINEERR_INVALADDRESSMODE, LINEERR_NOMEM, LINEERR_INVALBEARERMODE, LINEERR_NOTOWNER, LINEERR_INVALCALLHANDLE, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALCALLSTATE, LINEERR_OPERATIONFAILED, LINEERR_INVALCALLPARAMS, LINEERR_RATEUNAVAIL, LINEERR_INVALLINEHANDLE, LINEERR_RESOURCEUNAVAIL, LINEERR_ INVALLINESTATE, LINEERR_STRUCTURETOOSMALL, LINEERR_USERUSERINFOTOOBIG.

Remarques

Si LINEERR_INVALLINESTATE est retourné, la ligne n’est actuellement pas dans un état dans lequel cette opération peut être effectuée. Vous trouverez la liste des opérations actuellement valides dans le membre dwLineFeatures (de type LINEFEATURE) de la structure LINEDEVSTATUS . (L’appel de lineGetLineDevStatus met à jour les informations dans LINEDEVSTATUS.) Si LINEERR_INVALMEDIAMODE est retourné, case activée pour les types de médias pris en charge sur la ligne dans le membre dwMediaModes de la structure LINEDEVCAPS.

La fonction lineSetupConference offre deux façons d’établir une nouvelle téléconférence, selon qu’un appel bipartitique normal est nécessaire pour préexister ou non. Lors de la configuration d’une téléconférence à partir d’un appel biparte existant, le paramètre hCall est un handle d’appel valide qui est initialement ajouté à la téléconférence par la demande lineSetupConference ; hLine est ignoré. Sur les commutateurs où la configuration de la téléconférence ne commence pas par un appel existant, hCall doit avoir la valeur NULL et hLine doit être spécifié pour identifier l’appareil de ligne sur lequel lancer la téléconférence. Dans les deux cas, un appel de consultation est alloué pour la connexion à la partie qui doit être ajoutée à l’appel. L’application peut ensuite utiliser lineDial pour composer l’adresse de l’autre partie.

La téléconférence passe généralement à l’état onHoldPendingConference, l’appel de consultation à l’état de numérotation et l’appel initial (le cas échéant) à l’état conférence.

Une téléconférence peut également être configurée par un lineCompleteTransfer qui est résolu en une conférence triple. L’application peut être en mesure de basculer entre l’appel de consultation et la téléconférence à l’aide de lineSwapHold.

Un appel de consultation peut être annulé en appelant lineDrop dessus. Lors de la suppression d’un appel de consultation, la téléconférence existante revient généralement à l’état connecté . L’application doit observer les messages LINE_CALLSTATE pour déterminer exactement ce qui se passe aux appels. Par exemple, si la téléconférence revient à un appel régulier à deux parties, la téléconférence devient inactive et l’appel du participant d’origine peut revenir à la connexion.

Si une application spécifie le handle de l’appel d’origine (hCall) dans un appel à la fonction lineUnhold , la téléconférence et l’appel de consultation sont généralement inactifs.