ITfFnPlayBack

COM

IIDa3a416a4-0f64-11d3-b5b7-00c04fc324a1継承元ITfFunction自前メソッド開始 vtbl4

公式ドキュメント

ITfFnPlayBack インターフェイスは、Speech API (SAPI) テキストサービスによって実装されます。このインターフェイスは、TSF マネージャーまたはクライアント (アプリケーションや他のテキストサービス) が、音声入力されたテキストのオーディオデータを制御するために使用します。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 4 HRESULT QueryRange(ITfRange* pRange, ITfRange** ppNewRange, BOOL* pfPlayable)

ITfFnPlayBack::QueryRange メソッド

pRange	ITfRange*	in	オーディオデータを含むテキストの全体または一部をカバーする ITfRange オブジェクトへのポインターです。
ppNewRange	ITfRange**	out	オーディオデータを含むテキスト全体をカバーする範囲 (レンジ) オブジェクトを受け取る ITfRange ポインターへのポインターです。pRange がカバーするテキストにオーディオデータが存在しない場合、このパラメーターは NULL を受け取ります。この場合でもメソッドは S_OK を返すため、呼び出し元はポインターを使用する前にこのパラメーターが NULL でないことを確認する必要があります。
pfPlayable	BOOL*	out	pRange がカバーするテキストにオーディオデータがまったく存在しない場合は 0 を、存在する場合は 0 以外を受け取る BOOL へのポインターです。

戻り値

このメソッドは次のいずれかの値を返します。

値	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	1 つ以上のパラメーターが無効です。
E_OUTOFMEMORY	メモリの割り当てに失敗しました。

解説(Remarks)

このメソッドの現在の実装は単純です。pRange を複製し、その複製を ppNewRange に格納して、pfPlayable に TRUE を設定し、S_OK を返します。

vtbl 5 HRESULT Play(ITfRange* pRange)

ITfFnPlayBack::Play メソッド

pRange

ITfRange*

オーディオデータを再生する対象のテキストをカバーする ITfRange オブジェクトへのポインターです。この範囲 (レンジ) オブジェクトは ITfFnPlayBack::QueryRange を呼び出して取得します。

範囲の長さが 0 の場合、再生される範囲は発話されたフレーズ全体をカバーするように拡張されます。範囲の長さが 0 以外の場合、再生される範囲は、その範囲が部分的にカバーしている単語全体を含むように拡張されます。

戻り値

このメソッドは次のいずれかの値を返します。

値	説明
S_OK	メソッドは成功しました。
E_FAIL	原因不明のエラーが発生しました。
E_OUTOFMEMORY	メモリの割り当てに失敗しました。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITfFnPlayBack "{A3A416A4-0F64-11D3-B5B7-00C04FC324A1}"
#usecom global ITfFnPlayBack IID_ITfFnPlayBack "{}"
#comfunc global ITfFnPlayBack_QueryRange  4 sptr,sptr,var
#comfunc global ITfFnPlayBack_Play        5 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ITfFnPlayBack "{A3A416A4-0F64-11D3-B5B7-00C04FC324A1}"
#usecom global ITfFnPlayBack IID_ITfFnPlayBack "{}"
#comfunc global ITfFnPlayBack_QueryRange  4 sptr,sptr,sptr
#comfunc global ITfFnPlayBack_Play        5 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。