Win32 API 日本語リファレンス
ホーム › Media.MediaFoundation › IMFTimedTextRegion

IMFTimedTextRegion

COM
📘 Microsoft Learn (日本語) · English
IIDc8d22afc-bc47-4bdf-9b04-787e49ce3f58継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

タイムドテキストオブジェクトの表示領域を表します。

メソッド 12

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

vtbl 3 HRESULT GetName(LPWSTR* name)

領域の名前を取得します。

nameLPWSTR*out領域の名前を格納した、null 終端のワイド文字文字列を受け取る変数へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 4 HRESULT GetPosition(DOUBLE* pX, DOUBLE* pY, MF_TIMED_TEXT_UNIT_TYPE* unitType)

領域の位置を取得します。

pXDOUBLE*out位置の X 座標を受け取る変数へのポインター。
pYDOUBLE*out位置の Y 座標を受け取る変数へのポインター。
unitTypeMF_TIMED_TEXT_UNIT_TYPE*outタイムドテキスト領域を計測する単位を指定する MF_TIMED_TEXT_UNIT_TYPE 型の値を受け取る変数へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 5 HRESULT GetExtent(DOUBLE* pWidth, DOUBLE* pHeight, MF_TIMED_TEXT_UNIT_TYPE* unitType)

領域の範囲(エクステント)を取得します。

pWidthDOUBLE*out領域の幅を受け取る変数へのポインター。
pHeightDOUBLE*out領域の高さを受け取る変数へのポインター。
unitTypeMF_TIMED_TEXT_UNIT_TYPE*outタイムドテキスト領域を計測する単位を指定する MF_TIMED_TEXT_UNIT_TYPE 型の値を受け取る変数へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 6 HRESULT GetBackgroundColor(MFARGB* bgColor)

領域の背景色を取得します。

bgColorMFARGB*out背景色を記述する MFARGB 構造体を受け取る変数へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 7 HRESULT GetWritingMode(MF_TIMED_TEXT_WRITING_MODE* writingMode)

領域の書字方向(ライティングモード)を取得します。

writingModeMF_TIMED_TEXT_WRITING_MODE*out領域の書字方向を指定する MF_TIMED_TEXT_WRITING_MODE 型の値を受け取る変数へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 8 HRESULT GetDisplayAlignment(MF_TIMED_TEXT_DISPLAY_ALIGNMENT* displayAlign)

領域の表示配置(ディスプレイアラインメント)を取得します。

displayAlignMF_TIMED_TEXT_DISPLAY_ALIGNMENT*out領域の表示配置を指定する MF_TIMED_TEXT_DISPLAY_ALIGNMENT 型の値を受け取る変数へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 9 HRESULT GetLineHeight(DOUBLE* pLineHeight, MF_TIMED_TEXT_UNIT_TYPE* unitType)

領域内の各テキスト行の高さを取得します。

pLineHeightDOUBLE*out領域内の各テキスト行の高さを受け取る変数へのポインター。
unitTypeMF_TIMED_TEXT_UNIT_TYPE*outタイムドテキスト領域を計測する単位を指定する MF_TIMED_TEXT_UNIT_TYPE 型の値を受け取る変数へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 10 HRESULT GetClipOverflow(BOOL* clipOverflow)

テキストのクリップが領域からはみ出したかどうかを判定します。

clipOverflowBOOL*outテキストのクリップが領域からはみ出したかどうかを示す値を受け取る変数へのポインター。クリップがはみ出した場合は TRUE を、それ以外の場合は FALSE を格納します。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 11 HRESULT GetPadding(DOUBLE* before, DOUBLE* start, DOUBLE* after, DOUBLE* end, MF_TIMED_TEXT_UNIT_TYPE* unitType)

領域を囲むパディングを取得します。

beforeDOUBLE*out領域の開始前のパディングを受け取る変数へのポインター。
startDOUBLE*out領域の開始位置を受け取る変数へのポインター。
afterDOUBLE*out領域の終端後のパディングを受け取る変数へのポインター。
endDOUBLE*out領域の終了位置を受け取る変数へのポインター。
unitTypeMF_TIMED_TEXT_UNIT_TYPE*outタイムドテキスト領域を計測する単位を指定する MF_TIMED_TEXT_UNIT_TYPE 型の値を受け取る変数へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 12 HRESULT GetWrap(BOOL* wrap)

領域内でワードラップ機能が有効かどうかを判定します。

wrapBOOL*out領域内でワードラップ機能が有効かどうかを示す値を受け取る変数へのポインター。ワードラップが有効な場合は TRUE を、それ以外の場合は FALSE を格納します。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 13 HRESULT GetZIndex(INT* zIndex)

領域の Z インデックス(奥行き)を取得します。

zIndexINT*out領域の Z インデックス(奥行き)を受け取る変数へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 14 HRESULT GetScrollMode(MF_TIMED_TEXT_SCROLL_MODE* scrollMode)

領域のスクロールモードを取得します。

scrollModeMF_TIMED_TEXT_SCROLL_MODE*out領域のスクロールモードを指定する MF_TIMED_TEXT_SCROLL_MODE 型の値を受け取る変数へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IMFTimedTextRegion "{C8D22AFC-BC47-4BDF-9B04-787E49CE3F58}"
#usecom global IMFTimedTextRegion IID_IMFTimedTextRegion "{}"
#comfunc global IMFTimedTextRegion_GetName              3 var
#comfunc global IMFTimedTextRegion_GetPosition          4 var,var,var
#comfunc global IMFTimedTextRegion_GetExtent            5 var,var,var
#comfunc global IMFTimedTextRegion_GetBackgroundColor   6 var
#comfunc global IMFTimedTextRegion_GetWritingMode       7 var
#comfunc global IMFTimedTextRegion_GetDisplayAlignment  8 var
#comfunc global IMFTimedTextRegion_GetLineHeight        9 var,var
#comfunc global IMFTimedTextRegion_GetClipOverflow      10 var
#comfunc global IMFTimedTextRegion_GetPadding           11 var,var,var,var,var
#comfunc global IMFTimedTextRegion_GetWrap              12 var
#comfunc global IMFTimedTextRegion_GetZIndex            13 var
#comfunc global IMFTimedTextRegion_GetScrollMode        14 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。