função TSPI_linePrepareAddToConference (tspi.h)

Artigo
08/26/2023

A função TSPI_linePrepareAddToConference prepara uma chamada de conferência existente para a adição de outra parte. Ele cria uma nova chamada de consulta temporária. A nova chamada de consulta pode ser adicionada posteriormente à chamada em conferência.

Sintaxe

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

Parâmetros

dwRequestID

O identificador da solicitação assíncrona.

hdConfCall

O identificador de uma chamada em conferência. O estado da chamada de hdConfCall pode ser conectado.

htConsultCall

O identificador TAPI para a nova chamada de consulta temporária. O provedor de serviços deve salvá-lo e usá-lo em todas as chamadas subsequentes para os eventos de relatório de procedimento LINEEVENT na nova chamada. O estado de chamada de hdAddCall não é aplicável.

lphdConsultCall

Um ponteiro para um HDRVCALL que representa o identificador do provedor de serviços para a nova chamada de consulta temporária. O provedor de serviços deve preencher esse local com seu identificador para a nova chamada antes que este procedimento retorne. Esse identificador será inválido se a função resultar em um erro.

lpCallParams

Um ponteiro para um LINECALLPARAMS que contém parâmetros de chamada a serem usados ao estabelecer a chamada de consulta. Esse parâmetro será definido como NULL se nenhum parâmetro de configuração de chamada especial for desejado.

Retornar valor

Retorna dwRequestID ou um número de erro se ocorrer um erro. O parâmetro real lResult do ASYNC_COMPLETION correspondente será zero se a função for bem-sucedida ou um número de erro se ocorrer um erro. Os possíveis valores retornados são os seguintes:

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.

Comentários

O provedor de serviços retornará LINEERR_INVALLINESTATE se a linha não estiver atualmente em um estado no qual essa operação pode ser executada. O provedor de serviços deve indicar uma lista de operações atualmente válidas no membro dwLineFeatures (do tipo LINEFEATURE) na estrutura LINEDEVSTATUS .

O provedor de serviços retornará LINEERR_INVALCALLSTATE se a chamada em conferência não estiver em um estado válido para a operação solicitada.

Essa função coloca uma chamada de conferência existente no estado onHoldPendingConference e cria uma chamada de consulta que pode ser adicionada posteriormente à chamada de conferência existente com TSPI_lineAddToConference.

A chamada de consulta pode ser cancelada usando TSPI_lineDrop. Também pode ser possível que a TAPI troque entre a chamada de consulta e a chamada em conferência realizada com TSPI_lineSwapHold. Inicialmente, o provedor de serviços faz o monitoramento de mídia na nova chamada para pelo menos o conjunto de tipos de mídia que foram monitorados na linha.

Essa função difere da função TAPI correspondente, pois segue o modelo TSPI para iniciar o tempo de vida de uma chamada. O TAPI e o provedor de serviços trocam identificadores opacos que representam a chamada entre si. Além disso, o provedor de serviços tem permissão para fazer retornos de chamada para a nova chamada antes de retornar desse procedimento. De qualquer forma, o provedor de serviços também deve tratar o identificador retornado como "ainda não válido" até que a mensagem de ASYNC_COMPLETION correspondente reporte êxito. Em outras palavras, ele não deve emitir nenhuma mensagem LINEEVENT para a nova chamada ou incluí-la em contagens de chamadas em mensagens ou estruturas de dados status para a linha.