ホーム › Devices.Tapi › lineSetMediaControl

lineSetMediaControl

関数

デジットやメディア種別などの検出をトリガーとするメディア制御を設定する。

DLLTAPI32.dll呼出規約winapi

シグネチャ

// TAPI32.dll
#include <windows.h>

INT lineSetMediaControl(
    DWORD hLine,
    DWORD dwAddressID,
    DWORD hCall,
    DWORD dwSelect,
    const LINEMEDIACONTROLDIGIT* lpDigitList,
    DWORD dwDigitNumEntries,
    const LINEMEDIACONTROLMEDIA* lpMediaList,
    DWORD dwMediaNumEntries,
    const LINEMEDIACONTROLTONE* lpToneList,
    DWORD dwToneNumEntries,
    const LINEMEDIACONTROLCALLSTATE* lpCallStateList,
    DWORD dwCallStateNumEntries
);

パラメーター

名前	型	方向	説明
hLine	DWORD	in	オープンされている回線デバイスのハンドル。
dwAddressID	DWORD	in	指定されたオープン済み回線デバイス上のアドレス識別子。アドレス識別子はアドレスに恒久的に関連付けられており、オペレーティングシステムのアップグレードをまたいでも一定のままです。
hCall	DWORD	in	通話のハンドル。アプリケーションはその通話の所有者である必要があります。hCall の通話状態は任意の状態でかまいません。
dwSelect	DWORD	in	要求するメディア制御が、単一の通話に関連付けられるのか、あるアドレス上のすべての通話に対する既定となるのか、ある回線上のすべての通話に対する既定となるのかを指定します。このパラメーターには、 LINECALLSELECT_ Constants のうち 1 つだけを指定します。
lpDigitList	LINEMEDIACONTROLDIGIT*	in	メディア制御アクションのトリガーとなる数字を格納した、型 LINEMEDIACONTROLDIGIT の配列へのポインター。数字リスト内の数字が検出されるたびに、指定されたメディア制御アクションが通話のメディアストリームに対して実行されます。パルスモードで有効な数字は '0' から '9' です。DTMF モードで有効な数字は '0' から '9'、'A'、'B'、'C'、'D'、'*'、'#' です。
dwDigitNumEntries	DWORD	in	lpDigitList 内のエントリ数。
lpMediaList	LINEMEDIACONTROLMEDIA*	in	型 LINEMEDIACONTROLMEDIA のエントリを持つ配列へのポインター。この配列は dwMediaNumEntries 個のエントリを持ちます。各エントリには、監視対象のメディアタイプ、メディアタイプ固有の情報 (継続時間など)、およびメディア制御フィールドが含まれます。リスト内のメディアタイプが検出されると、対応するメディア制御アクションが通話のメディアストリームに対して実行されます。
dwMediaNumEntries	DWORD	in	lpMediaList 内のエントリ数。
lpToneList	LINEMEDIACONTROLTONE*	in	型 LINEMEDIACONTROLTONE のエントリを持つ配列へのポインター。この配列は dwToneNumEntries 個のエントリを持ちます。各エントリには、監視対象のトーンの記述、トーンの継続時間、およびメディア制御フィールドが含まれます。リスト内のトーンが検出されると、対応するメディア制御アクションが通話のメディアストリームに対して実行されます。
dwToneNumEntries	DWORD	in	lpToneList 内のエントリ数。
lpCallStateList	LINEMEDIACONTROLCALLSTATE*	in	型 LINEMEDIACONTROLCALLSTATE のエントリを持つ配列へのポインター。この配列は dwCallStateNumEntries 個のエントリを持ちます。各エントリには、通話状態とメディア制御アクションが含まれます。指定された通話がリスト内のいずれかの通話状態へ遷移するたびに、対応するメディア制御アクションが呼び出されます。
dwCallStateNumEntries	DWORD	in	lpCallStateList 内のエントリ数。

戻り値の型: INT

公式ドキュメント

lineSetMediaControl 関数は、指定した回線、アドレス、または通話に関連付けられたメディアストリームに対する制御アクションを有効または無効にします。

戻り値

要求が成功した場合は 0 を、エラーが発生した場合は負のエラー番号を返します。返される可能性のある値は次のとおりです。

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

解説(Remarks)

lineSetMediaControl 関数は、メディア制御が正しく開始された時点で成功と見なされます。メディア制御が実際に作用した時点ではありません。実行中のメディア制御は、異なるパラメーターまたは NULL を指定してこの関数を再度呼び出すことで変更または取り消されます。パラメーター lpDigitList、lpMediaList、lpToneList、lpCallStateList のいずれかに NULL を指定すると、対応する数字、メディアタイプ、トーン、または通話状態によってトリガーされるメディア制御が無効になります。メディア制御パラメーターの一部だけを変更し、残りの設定を有効なまま維持するには、アプリケーションは lineSetMediaControl を呼び出す際に、有効なまま維持する部分には以前のパラメーターを、変更する部分には新しいパラメーターを指定します。

hCall が選択されている場合、その通話が終了するか、アプリケーションがそのハンドルを解放すると、その通話に対するメディア制御は取り消されます。

通話の所有者であるすべてのアプリケーションは、原則としてその通話に対してメディア制御を要求できます。ただし、通話を所有するすべてのアプリケーションを通じて、1 つの通話に対して未処理のメディア制御要求は 1 つだけです。 lineSetMediaControl が呼び出されるたびに、新しい要求は、呼び出し元のアプリケーションが設定したものか他の所有アプリケーションが設定したものかにかかわらず、その通話で有効になっているメディア制御を上書きします。

サービスプロバイダーや、そのようなリソースを奪い合う他の処理に応じて、同時に実行できる検出の数は時間とともに変化することがあります。サービスプロバイダーのリソースが過剰に割り当てられている場合は、LINEERR_RESOURCEUNAVAIL エラーが返されます。

サービスプロバイダーがメディア制御をサポートするかどうかは、デバイスの機能 (device capability) です。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// TAPI32.dll
#include <windows.h>

INT lineSetMediaControl(
    DWORD hLine,
    DWORD dwAddressID,
    DWORD hCall,
    DWORD dwSelect,
    const LINEMEDIACONTROLDIGIT* lpDigitList,
    DWORD dwDigitNumEntries,
    const LINEMEDIACONTROLMEDIA* lpMediaList,
    DWORD dwMediaNumEntries,
    const LINEMEDIACONTROLTONE* lpToneList,
    DWORD dwToneNumEntries,
    const LINEMEDIACONTROLCALLSTATE* lpCallStateList,
    DWORD dwCallStateNumEntries
);

[DllImport("TAPI32.dll", ExactSpelling = true)]
static extern int lineSetMediaControl(
    uint hLine,   // DWORD
    uint dwAddressID,   // DWORD
    uint hCall,   // DWORD
    uint dwSelect,   // DWORD
    IntPtr lpDigitList,   // LINEMEDIACONTROLDIGIT*
    uint dwDigitNumEntries,   // DWORD
    IntPtr lpMediaList,   // LINEMEDIACONTROLMEDIA*
    uint dwMediaNumEntries,   // DWORD
    IntPtr lpToneList,   // LINEMEDIACONTROLTONE*
    uint dwToneNumEntries,   // DWORD
    IntPtr lpCallStateList,   // LINEMEDIACONTROLCALLSTATE*
    uint dwCallStateNumEntries   // DWORD
);

<DllImport("TAPI32.dll", ExactSpelling:=True)>
Public Shared Function lineSetMediaControl(
    hLine As UInteger,   ' DWORD
    dwAddressID As UInteger,   ' DWORD
    hCall As UInteger,   ' DWORD
    dwSelect As UInteger,   ' DWORD
    lpDigitList As IntPtr,   ' LINEMEDIACONTROLDIGIT*
    dwDigitNumEntries As UInteger,   ' DWORD
    lpMediaList As IntPtr,   ' LINEMEDIACONTROLMEDIA*
    dwMediaNumEntries As UInteger,   ' DWORD
    lpToneList As IntPtr,   ' LINEMEDIACONTROLTONE*
    dwToneNumEntries As UInteger,   ' DWORD
    lpCallStateList As IntPtr,   ' LINEMEDIACONTROLCALLSTATE*
    dwCallStateNumEntries As UInteger   ' DWORD
) As Integer
End Function

' hLine : DWORD
' dwAddressID : DWORD
' hCall : DWORD
' dwSelect : DWORD
' lpDigitList : LINEMEDIACONTROLDIGIT*
' dwDigitNumEntries : DWORD
' lpMediaList : LINEMEDIACONTROLMEDIA*
' dwMediaNumEntries : DWORD
' lpToneList : LINEMEDIACONTROLTONE*
' dwToneNumEntries : DWORD
' lpCallStateList : LINEMEDIACONTROLCALLSTATE*
' dwCallStateNumEntries : DWORD
Declare PtrSafe Function lineSetMediaControl Lib "tapi32" ( _
    ByVal hLine As Long, _
    ByVal dwAddressID As Long, _
    ByVal hCall As Long, _
    ByVal dwSelect As Long, _
    ByVal lpDigitList As LongPtr, _
    ByVal dwDigitNumEntries As Long, _
    ByVal lpMediaList As LongPtr, _
    ByVal dwMediaNumEntries As Long, _
    ByVal lpToneList As LongPtr, _
    ByVal dwToneNumEntries As Long, _
    ByVal lpCallStateList As LongPtr, _
    ByVal dwCallStateNumEntries As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

lineSetMediaControl = ctypes.windll.tapi32.lineSetMediaControl
lineSetMediaControl.restype = ctypes.c_int
lineSetMediaControl.argtypes = [
    wintypes.DWORD,  # hLine : DWORD
    wintypes.DWORD,  # dwAddressID : DWORD
    wintypes.DWORD,  # hCall : DWORD
    wintypes.DWORD,  # dwSelect : DWORD
    ctypes.c_void_p,  # lpDigitList : LINEMEDIACONTROLDIGIT*
    wintypes.DWORD,  # dwDigitNumEntries : DWORD
    ctypes.c_void_p,  # lpMediaList : LINEMEDIACONTROLMEDIA*
    wintypes.DWORD,  # dwMediaNumEntries : DWORD
    ctypes.c_void_p,  # lpToneList : LINEMEDIACONTROLTONE*
    wintypes.DWORD,  # dwToneNumEntries : DWORD
    ctypes.c_void_p,  # lpCallStateList : LINEMEDIACONTROLCALLSTATE*
    wintypes.DWORD,  # dwCallStateNumEntries : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TAPI32.dll')
lineSetMediaControl = Fiddle::Function.new(
  lib['lineSetMediaControl'],
  [
    -Fiddle::TYPE_INT,  # hLine : DWORD
    -Fiddle::TYPE_INT,  # dwAddressID : DWORD
    -Fiddle::TYPE_INT,  # hCall : DWORD
    -Fiddle::TYPE_INT,  # dwSelect : DWORD
    Fiddle::TYPE_VOIDP,  # lpDigitList : LINEMEDIACONTROLDIGIT*
    -Fiddle::TYPE_INT,  # dwDigitNumEntries : DWORD
    Fiddle::TYPE_VOIDP,  # lpMediaList : LINEMEDIACONTROLMEDIA*
    -Fiddle::TYPE_INT,  # dwMediaNumEntries : DWORD
    Fiddle::TYPE_VOIDP,  # lpToneList : LINEMEDIACONTROLTONE*
    -Fiddle::TYPE_INT,  # dwToneNumEntries : DWORD
    Fiddle::TYPE_VOIDP,  # lpCallStateList : LINEMEDIACONTROLCALLSTATE*
    -Fiddle::TYPE_INT,  # dwCallStateNumEntries : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "tapi32")]
extern "system" {
    fn lineSetMediaControl(
        hLine: u32,  // DWORD
        dwAddressID: u32,  // DWORD
        hCall: u32,  // DWORD
        dwSelect: u32,  // DWORD
        lpDigitList: *const LINEMEDIACONTROLDIGIT,  // LINEMEDIACONTROLDIGIT*
        dwDigitNumEntries: u32,  // DWORD
        lpMediaList: *const LINEMEDIACONTROLMEDIA,  // LINEMEDIACONTROLMEDIA*
        dwMediaNumEntries: u32,  // DWORD
        lpToneList: *const LINEMEDIACONTROLTONE,  // LINEMEDIACONTROLTONE*
        dwToneNumEntries: u32,  // DWORD
        lpCallStateList: *const LINEMEDIACONTROLCALLSTATE,  // LINEMEDIACONTROLCALLSTATE*
        dwCallStateNumEntries: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("TAPI32.dll")]
public static extern int lineSetMediaControl(uint hLine, uint dwAddressID, uint hCall, uint dwSelect, IntPtr lpDigitList, uint dwDigitNumEntries, IntPtr lpMediaList, uint dwMediaNumEntries, IntPtr lpToneList, uint dwToneNumEntries, IntPtr lpCallStateList, uint dwCallStateNumEntries);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineSetMediaControl' -Namespace Win32 -PassThru
# $api::lineSetMediaControl(hLine, dwAddressID, hCall, dwSelect, lpDigitList, dwDigitNumEntries, lpMediaList, dwMediaNumEntries, lpToneList, dwToneNumEntries, lpCallStateList, dwCallStateNumEntries)

#uselib "TAPI32.dll"
#func global lineSetMediaControl "lineSetMediaControl" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; lineSetMediaControl hLine, dwAddressID, hCall, dwSelect, varptr(lpDigitList), dwDigitNumEntries, varptr(lpMediaList), dwMediaNumEntries, varptr(lpToneList), dwToneNumEntries, varptr(lpCallStateList), dwCallStateNumEntries   ; 戻り値は stat
; hLine : DWORD -> "sptr"
; dwAddressID : DWORD -> "sptr"
; hCall : DWORD -> "sptr"
; dwSelect : DWORD -> "sptr"
; lpDigitList : LINEMEDIACONTROLDIGIT* -> "sptr"
; dwDigitNumEntries : DWORD -> "sptr"
; lpMediaList : LINEMEDIACONTROLMEDIA* -> "sptr"
; dwMediaNumEntries : DWORD -> "sptr"
; lpToneList : LINEMEDIACONTROLTONE* -> "sptr"
; dwToneNumEntries : DWORD -> "sptr"
; lpCallStateList : LINEMEDIACONTROLCALLSTATE* -> "sptr"
; dwCallStateNumEntries : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "TAPI32.dll"
#cfunc global lineSetMediaControl "lineSetMediaControl" int, int, int, int, var, int, var, int, var, int, var, int
; res = lineSetMediaControl(hLine, dwAddressID, hCall, dwSelect, lpDigitList, dwDigitNumEntries, lpMediaList, dwMediaNumEntries, lpToneList, dwToneNumEntries, lpCallStateList, dwCallStateNumEntries)
; hLine : DWORD -> "int"
; dwAddressID : DWORD -> "int"
; hCall : DWORD -> "int"
; dwSelect : DWORD -> "int"
; lpDigitList : LINEMEDIACONTROLDIGIT* -> "var"
; dwDigitNumEntries : DWORD -> "int"
; lpMediaList : LINEMEDIACONTROLMEDIA* -> "var"
; dwMediaNumEntries : DWORD -> "int"
; lpToneList : LINEMEDIACONTROLTONE* -> "var"
; dwToneNumEntries : DWORD -> "int"
; lpCallStateList : LINEMEDIACONTROLCALLSTATE* -> "var"
; dwCallStateNumEntries : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "TAPI32.dll"
#cfunc global lineSetMediaControl "lineSetMediaControl" int, int, int, int, sptr, int, sptr, int, sptr, int, sptr, int
; res = lineSetMediaControl(hLine, dwAddressID, hCall, dwSelect, varptr(lpDigitList), dwDigitNumEntries, varptr(lpMediaList), dwMediaNumEntries, varptr(lpToneList), dwToneNumEntries, varptr(lpCallStateList), dwCallStateNumEntries)
; hLine : DWORD -> "int"
; dwAddressID : DWORD -> "int"
; hCall : DWORD -> "int"
; dwSelect : DWORD -> "int"
; lpDigitList : LINEMEDIACONTROLDIGIT* -> "sptr"
; dwDigitNumEntries : DWORD -> "int"
; lpMediaList : LINEMEDIACONTROLMEDIA* -> "sptr"
; dwMediaNumEntries : DWORD -> "int"
; lpToneList : LINEMEDIACONTROLTONE* -> "sptr"
; dwToneNumEntries : DWORD -> "int"
; lpCallStateList : LINEMEDIACONTROLCALLSTATE* -> "sptr"
; dwCallStateNumEntries : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。