ホーム › Devices.Tapi › ITCallMediaEvent

ITCallMediaEvent

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IIDff36b87f-ec3a-11d0-8ee4-00c04fb6809f継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

ITCallMediaEvent インターフェイスには、メディアイベントの説明を取得するメソッドが含まれます。

メソッド 6

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT get_Call(ITCallInfo** ppCallInfo)

get_Call メソッドは、このイベントに関連付けられたコールオブジェクトの ITCallInfo インターフェイスポインターを取得します。

ppCallInfo

ITCallInfo**

out

ITCallInfo インターフェイスへのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことができます。

値	意味
S_OK	メソッドが成功しました。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
E_POINTER	ppCallInfo パラメーターが有効なポインターではありません。

解説(Remarks)

TAPI は、ITCallMediaEvent::get_Call が返す ITCallInfo インターフェイスに対して AddRef メソッドを呼び出します。アプリケーションは、 ITCallInfo に関連付けられたリソースを解放するために Release を呼び出す必要があります。

vtbl 8 HRESULT get_Event(CALL_MEDIA_EVENT* pCallMediaEvent)

get_Event メソッドは、コールメディアイベントのインジケーターを取得します。

pCallMediaEvent

CALL_MEDIA_EVENT*

out

CALL_MEDIA_EVENT インジケーターへのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことができます。

戻り値	説明
S_OK	メソッドが成功しました。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
E_POINTER	pCallMediaEvent パラメーターが有効なポインターではありません。

解説(Remarks)

コールメディアイベントは、特定の操作を実行できるかどうかを示す重要なインジケーターです。たとえば、 IVideoWindow が Terminal オブジェクトで公開されている場合、CME_STREAM_ACTIVE を受信するまでは put_Visible メソッドのみが成功します。IVideoWindow と put_Visible の詳細については、DirectX のドキュメントを参照してください。

vtbl 9 HRESULT get_Error(HRESULT* phrError)

get_Error メソッドは、メディアイベントに関連付けられたエラー(存在する場合)を取得します。

phrError

HRESULT*

out

エラーへのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことができます。

戻り値	説明
S_OK	メソッドが成功しました。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
E_POINTER	phrError パラメーターが有効なポインターではありません。

vtbl 10 HRESULT get_Terminal(ITTerminal** ppTerminal)

get_Terminal メソッドは、イベントに関連付けられたターミナルを取得します。

ppTerminal

ITTerminal**

out

ITTerminal インターフェイスへのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことができます。

値	意味
S_OK	メソッドが成功しました。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
E_POINTER	ppTerminal パラメーターが有効なポインターではありません。

解説(Remarks)

TAPI は、ITCallMediaEvent::get_Terminal が返す ITTerminal インターフェイスに対して AddRef メソッドを呼び出します。アプリケーションは、 ITTerminal に関連付けられたリソースを解放するために Release を呼び出す必要があります。

vtbl 11 HRESULT get_Stream(ITStream** ppStream)

get_Stream メソッドは、コールメディアイベントに関連付けられた ITStream インターフェイスへのポインターを取得します。

ppStream

ITStream**

out

ITStream インターフェイスポインターへのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことができます。

値	意味
S_OK	メソッドが成功しました。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
E_POINTER	ppStream パラメーターが有効なポインターではありません。

解説(Remarks)

TAPI は、ITCallMediaEvent::get_Stream が返す ITStream インターフェイスに対して AddRef メソッドを呼び出します。アプリケーションは、 ITStream に関連付けられたリソースを解放するために Release を呼び出す必要があります。

vtbl 12 HRESULT get_Cause(CALL_MEDIA_EVENT_CAUSE* pCause)

get_Cause メソッドは、レンダラーデバイスのタイムアウトなど、コールメディアイベントの原因を取得します。

pCause

CALL_MEDIA_EVENT_CAUSE*

out

CALL_MEDIA_EVENT_CAUSE へのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことができます。

戻り値	説明
S_OK	メソッドが成功しました。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
E_POINTER	pCause パラメーターが有効なポインターではありません。

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

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_ITCallMediaEvent "{FF36B87F-EC3A-11D0-8EE4-00C04FB6809F}"
#usecom global ITCallMediaEvent IID_ITCallMediaEvent "{}"
#comfunc global ITCallMediaEvent_get_Call      7 sptr
#comfunc global ITCallMediaEvent_get_Event     8 var
#comfunc global ITCallMediaEvent_get_Error     9 var
#comfunc global ITCallMediaEvent_get_Terminal  10 sptr
#comfunc global ITCallMediaEvent_get_Stream    11 sptr
#comfunc global ITCallMediaEvent_get_Cause     12 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_ITCallMediaEvent "{FF36B87F-EC3A-11D0-8EE4-00C04FB6809F}"
#usecom global ITCallMediaEvent IID_ITCallMediaEvent "{}"
#comfunc global ITCallMediaEvent_get_Call      7 sptr
#comfunc global ITCallMediaEvent_get_Event     8 sptr
#comfunc global ITCallMediaEvent_get_Error     9 sptr
#comfunc global ITCallMediaEvent_get_Terminal  10 sptr
#comfunc global ITCallMediaEvent_get_Stream    11 sptr
#comfunc global ITCallMediaEvent_get_Cause     12 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。