lineMonitorTones

関数

通話上で指定したトーンの検出監視を有効化する。

DLLTAPI32.dll呼出規約winapi

シグネチャ

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

INT lineMonitorTones(
    DWORD hCall,
    const LINEMONITORTONE* lpToneList,
    DWORD dwNumEntries
);

パラメーター

名前	型	方向	説明
hCall	DWORD	in	音声チャネル上でトーンを監視する対象の通話へのハンドル。hCall の通話状態は、idle 以外の任意の状態を指定できます。
lpToneList	LINEMONITORTONE*	in	監視するトーンのリスト。このパラメーターの型は LINEMONITORTONE です。このリスト内の各トーンには、アプリケーションが定義するタグフィールドがあり、トーンの検出を報告する際にリスト内の個々のトーンを識別するために使用されます。実行中のトーン監視は、lpToneList に NULL を指定するか、別のトーンリストを指定してこの操作を呼び出すことで、取り消しまたは変更されます。
dwNumEntries	DWORD	in	lpToneList 内のエントリ数。lpToneList が NULL の場合、このパラメーターは無視されます。

戻り値の型: INT

公式ドキュメント

lineMonitorTones 関数は、通話でのインバンドトーンの検出を有効または無効にします。指定されたトーンが検出されるたびに、アプリケーションにメッセージが送信されます。

戻り値

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

LINEERR_INVALCALLHANDLE、LINEERR_INVALCALLSTATE、LINEERR_INVALPOINTER、LINEERR_INVALTONE、LINEERR_NOMEM、LINEERR_OPERATIONFAILED、LINEERR_OPERATIONUNAVAIL、LINEERR_RESOURCEUNAVAIL、LINEERR_UNINITIALIZED。

解説(Remarks)

この関数は、トーン監視が正しく開始された時点で成功します。トーン監視が終了した時点ではありません。トーン監視は、別のトーンリスト (または NULL) を指定して lineMonitorTones を呼び出して明示的に無効にするまで、通話が idle に遷移するまで、またはアプリケーションがその通話の通話ハンドルを解放するまで有効なままです。

この関数は任意の通話状態で呼び出せますが、通常、トーンを検出できるのは通話が connected 状態にある間だけです。トーン検出には一般に計算リソースが必要です。サービスプロバイダーや、そうしたリソースを奪い合う他の処理によっては、検出できるトーンの数は時間とともに変動する可能性があります。また、3 重周波数トーンを 1 つ監視する場合と、単一周波数トーンを 3 つ監視する場合とでは、同等の量のリソースが消費されることがあります。リソースが過剰に割り当てられた場合は、LINEERR_RESOURCEUNAVAIL エラーが返されます。

lineMonitorTones 関数は、無音の検出にも使用されます。無音は、周波数が 0 のトーンとして指定します。

会議通話でのトーンの監視は hConfCall にのみ適用され、個々の参加通話には適用されません。

LINEERR_INVALPOINTER エラー値が返された場合は、指定された lpToneList パラメーターが無効であるか、dwNumEntries パラメーターで指定された値が大きすぎます。

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

各言語での呼び出し定義

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

INT lineMonitorTones(
    DWORD hCall,
    const LINEMONITORTONE* lpToneList,
    DWORD dwNumEntries
);

[DllImport("TAPI32.dll", ExactSpelling = true)]
static extern int lineMonitorTones(
    uint hCall,   // DWORD
    IntPtr lpToneList,   // LINEMONITORTONE*
    uint dwNumEntries   // DWORD
);

<DllImport("TAPI32.dll", ExactSpelling:=True)>
Public Shared Function lineMonitorTones(
    hCall As UInteger,   ' DWORD
    lpToneList As IntPtr,   ' LINEMONITORTONE*
    dwNumEntries As UInteger   ' DWORD
) As Integer
End Function

' hCall : DWORD
' lpToneList : LINEMONITORTONE*
' dwNumEntries : DWORD
Declare PtrSafe Function lineMonitorTones Lib "tapi32" ( _
    ByVal hCall As Long, _
    ByVal lpToneList As LongPtr, _
    ByVal dwNumEntries As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

lineMonitorTones = ctypes.windll.tapi32.lineMonitorTones
lineMonitorTones.restype = ctypes.c_int
lineMonitorTones.argtypes = [
    wintypes.DWORD,  # hCall : DWORD
    ctypes.c_void_p,  # lpToneList : LINEMONITORTONE*
    wintypes.DWORD,  # dwNumEntries : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TAPI32.dll')
lineMonitorTones = Fiddle::Function.new(
  lib['lineMonitorTones'],
  [
    -Fiddle::TYPE_INT,  # hCall : DWORD
    Fiddle::TYPE_VOIDP,  # lpToneList : LINEMONITORTONE*
    -Fiddle::TYPE_INT,  # dwNumEntries : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "tapi32")]
extern "system" {
    fn lineMonitorTones(
        hCall: u32,  // DWORD
        lpToneList: *const LINEMONITORTONE,  // LINEMONITORTONE*
        dwNumEntries: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("TAPI32.dll")]
public static extern int lineMonitorTones(uint hCall, IntPtr lpToneList, uint dwNumEntries);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineMonitorTones' -Namespace Win32 -PassThru
# $api::lineMonitorTones(hCall, lpToneList, dwNumEntries)

#uselib "TAPI32.dll"
#func global lineMonitorTones "lineMonitorTones" sptr, sptr, sptr
; lineMonitorTones hCall, varptr(lpToneList), dwNumEntries   ; 戻り値は stat
; hCall : DWORD -> "sptr"
; lpToneList : LINEMONITORTONE* -> "sptr"
; dwNumEntries : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "TAPI32.dll"
#cfunc global lineMonitorTones "lineMonitorTones" int, var, int
; res = lineMonitorTones(hCall, lpToneList, dwNumEntries)
; hCall : DWORD -> "int"
; lpToneList : LINEMONITORTONE* -> "var"
; dwNumEntries : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "TAPI32.dll"
#cfunc global lineMonitorTones "lineMonitorTones" int, sptr, int
; res = lineMonitorTones(hCall, varptr(lpToneList), dwNumEntries)
; hCall : DWORD -> "int"
; lpToneList : LINEMONITORTONE* -> "sptr"
; dwNumEntries : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。