TSPI_lineSetMediaControl関数 (tspi.h)

[アーティクル]
03/03/2024

TSPI_lineSetMediaControl関数は、指定した行、アドレス、または呼び出しに関連付けられているメディアストリームに対する制御アクションを有効または無効にします。メディア制御アクションは、指定した数字、メディアの種類、カスタムトーン、および呼び出し状態の検出によってトリガーできます。指定された新しいメディアコントロールは、この要求の前にこの行、アドレス、または呼び出しに対して有効であったすべてのメディアコントロールを置き換えます。

構文

LONG TSPIAPI TSPI_lineSetMediaControl(
  HDRVLINE                          hdLine,
  DWORD                             dwAddressID,
  HDRVCALL                          hdCall,
  DWORD                             dwSelect,
  LPLINEMEDIACONTROLDIGIT const     lpDigitList,
  DWORD                             dwDigitNumEntries,
  LPLINEMEDIACONTROLMEDIA const     lpMediaList,
  DWORD                             dwMediaNumEntries,
  LPLINEMEDIACONTROLTONE const      lpToneList,
  DWORD                             dwToneNumEntries,
  LPLINEMEDIACONTROLCALLSTATE const lpCallStateList,
  DWORD                             dwCallStateNumEntries
);

パラメーター

hdLine

行へのハンドル。

dwAddressID

指定されたオープンラインデバイス上のアドレス。アドレス識別子は、アドレスに完全に関連付けられます。識別子は、オペレーティングシステムのアップグレード間で一定のままです。 TAPI は、この関数が呼び出されたときにこのパラメーターを検証しません。

hdCall

呼び出しのハンドル。 hdCall の呼び出し状態は任意の状態にすることができます。

dwSelect

メディアコントロールが要求されるのが 1 つの呼び出しに関連付けられているか、アドレス上のすべての呼び出しの既定値か、回線上のすべての呼び出しの既定値かを指定します。このパラメーターでは、次の LINECALLSELECT_定数を使用します。

lpDigitList

LINEMEDIACONTROLDIGIT 型のメディア制御アクションをトリガーする桁数を含む配列へのポインター。数字リストにリストされている数字が検出されるたびに、指定されたメディア制御アクションが呼び出しのメディア・ストリームで実行されます。

パルスモードの有効な数字は、'0' から '9' です。 DTMF モードの有効な数字は、'0' から '9'、'A'、'B'、'C'、'D'、'*'、'#' です。

dwDigitNumEntries

lpDigitList 内のエントリの数。 TAPI は、この関数が呼び出されたときにこのパラメーターを検証しません。

lpMediaList

LINEMEDIACONTROLMEDIA 型のエントリを含む配列へのポインター。配列には dwMediaNumEntries エントリがあります。各エントリには、監視対象のメディアタイプ、メディアタイプ固有の情報(期間など)、およびメディア制御フィールドが含まれます。リスト内のメディアの種類が検出されると、対応するメディア制御アクションが呼び出しのメディアストリームに対して実行されます。

dwMediaNumEntries

lpMediaList 内のエントリの数。 TAPI は、この関数が呼び出されたときにこのパラメーターを検証しません。

lpToneList

LINEMEDIACONTROLTONE 型のエントリを含む配列へのポインター。配列には dwToneNumEntries エントリがあります。各エントリには、監視するトーン、トーンの継続時間、メディアコントロールフィールドの説明が含まれています。リスト内のトーンが検出されると、対応するメディア制御アクションが呼び出しのメディアストリームに対して実行されます。

dwToneNumEntries

lpToneList 内のエントリの数。 TAPI は、この関数が呼び出されたときにこのパラメーターを検証しません。

lpCallStateList

LINEMEDIACONTROLCALLSTATE 型のエントリを持つ配列へのポインター。配列には dwCallStateNumEntries エントリがあります。各エントリには、通話状態とメディアコントロールアクションが含まれます。

dwCallStateNumEntries

lpCallStateList 内のエントリの数。 TAPI は、この関数が呼び出されたときにこのパラメーターを検証しません。

戻り値

関数が成功した場合は 0 を返し、エラーが発生した場合はエラー番号を返します。可能な戻り値は次のとおりです。

LINEERR_INVALADDRESSID、LINEERR_INVALPOINTER、LINEERR_INVALCALLHANDLE、LINEERR_INVALTONELIST、LINEERR_INVALCALLSELECT、LINEERR_NOMEM、LINEERR_INVALCALLSTATELIST、LINEERR_OPERATIONUNAVAIL、LINEERR_INVALDIGITLIST、LINEERR_OPERATIONFAILED、LINEERR_INVALLINEHANDLE、LINEERR_RESOURCEUNAVAIL、LINEERR_INVALMEDIALIST。

注釈

この関数は、メディアコントロールが正しく開始されると、メディアコントロールが有効になったときではなく、0 (成功) を返します。実行中のメディアコントロールが変更されるか、この関数が異なるパラメーターまたは NULLで再度呼び出されると取り消されます。

呼び出しで一度に未処理にできるのは、1 つのメディア制御要求のみです。要求は、未処理の可能性があるすべての要求を置き換えます。

このようなリソースを競合するサービスプロバイダーやその他のアクティビティによっては、同時に検出できる量は時間の経過と同時に異なる場合があります。サービスプロバイダーリソースがオーバーコミットされた場合は、LINEERR_RESOURCEUNAVAILを返します。

メディア制御がサービスプロバイダーによってサポートされているかどうかは、 LINEDEVCAPS に示されているデバイス機能です。

TSPI_lineSetMediaControlが呼び出されるたびに、新しい要求は現在有効になっているメディアコントロールをオーバーライドします。 1 つ以上のパラメーター lpDigitList、 lpMediaList、 lpToneList、および lpCallStateList が NULL の場合、対応する数字、メディアの種類、トーン、または呼び出し状態によってトリガーされるメディアコントロールは無効になります。残りの設定を有効のままにしたままメディアコントロールパラメーターの一部だけを変更するには、アプリケーションでを呼び出す必要があります TSPI_lineSetMediaControl 、有効にしておく必要がある部分の前のパラメーターと、変更する部分の新しいパラメーターを指定します。