ホーム › Media.MediaFoundation › ITocParser

ITocParser

COM

📘 Microsoft Learn (日本語) · English

IIDecfb9a55-9298-4f49-887f-0b36206599d2継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITocParser インターフェイスは TOC パーサーオブジェクトを表します。ビデオファイルに目次を格納したり、ビデオファイルから目次を取得したりするためのメソッドを提供します。

メソッド 8

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

vtbl 3 HRESULT Init(LPWSTR pwszFileName)

Init メソッドは TOC パーサーオブジェクトを初期化し、メディアファイルと関連付けます。

pwszFileName

LPWSTR

メディアファイルのパスを指定する、NULL 終端のワイド文字列へのポインター。「解説」を参照してください。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。

解説(Remarks)

pwszFileName に渡すパスは、長い Universal Naming Convention (UNC) ファイルパスである必要があります。長い UNC ファイルパスは "\?" で始まります。次のコード行は、ファイル c:\experiment\seattle.wmv のパスを設定する方法を示しています。

pTocParser->Init(L"\\?\c:\experiment\seattle.wmv");

vtbl 4 HRESULT GetTocCount(TOC_POS_TYPE enumTocPosType, DWORD* pdwTocCount)

GetTocCount メソッドは、TOC パーサーオブジェクト内にある、指定された位置タイプの目次の数を取得します。

enumTocPosType	TOC_POS_TYPE	in	目次の格納位置種別を示すTOC_POS_TYPE列挙値。ヘッダーやデータ部などを指定する。
pdwTocCount	DWORD*	inout	目次の数を受け取る DWORD へのポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。

vtbl 5 HRESULT GetTocByIndex(TOC_POS_TYPE enumTocPosType, DWORD dwTocIndex, IToc** ppToc)

GetTocByIndex メソッドは、インデックスで指定された目次を TOC パーサーオブジェクトから取得します。

enumTocPosType	TOC_POS_TYPE	in	目次の格納位置種別を示すTOC_POS_TYPE列挙値。
dwTocIndex	DWORD	in	取得する目次のインデックス。
ppToc	IToc**	out	取得された目次を表す IToc インターフェイスへのポインターを受け取る変数へのポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。

vtbl 6 HRESULT GetTocByType(TOC_POS_TYPE enumTocPosType, GUID guidTocType, ITocCollection** ppTocs)

GetTocByType は、指定されたタイプのすべての目次を TOC パーサーオブジェクトから取得します。

enumTocPosType	TOC_POS_TYPE	in	目次の格納位置種別を示すTOC_POS_TYPE列挙値。
guidTocType	GUID	in	取得する目次のタイプを指定するグローバル一意識別子 (GUID)。「解説」を参照してください。
ppTocs	ITocCollection**	out	取得された目次のコレクションを表す ITocCollection インターフェイスへのポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。

解説(Remarks)

複数の異なるタイプの目次を設計したい場合があります。その場合、各タイプを表す GUID を作成することでタイプを区別できます。TOC_DESCRIPTOR 構造体の guidType メンバーを設定し、その TOC_DESCRIPTOR 構造体を IToc::SetDescriptor に渡すことで、目次を特定のタイプとして識別できます。

vtbl 7 HRESULT AddToc(TOC_POS_TYPE enumTocPosType, IToc* pToc, DWORD* pdwTocIndex)

AddToc メソッドは、TOC パーサーオブジェクトに目次を追加し、追加された目次にインデックスを割り当てます。

enumTocPosType	TOC_POS_TYPE	in	目次を追加する格納位置種別を示すTOC_POS_TYPE列挙値。
pToc	IToc*	in	追加する目次を表す IToc インターフェイスへのポインター。
pdwTocIndex	DWORD*	inout	追加された目次のインデックスを受け取る DWORD へのポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。

vtbl 8 HRESULT RemoveTocByIndex(TOC_POS_TYPE enumTocPosType, DWORD dwTocIndex)

RemoveTocByIndex メソッドは、インデックスで指定された目次を TOC パーサーオブジェクトから削除します。

enumTocPosType	TOC_POS_TYPE	in	削除対象の格納位置種別を示すTOC_POS_TYPE列挙値。
dwTocIndex	DWORD	in	削除する目次のインデックス。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。

vtbl 9 HRESULT RemoveTocByType(TOC_POS_TYPE enumTocPosType, GUID guidTocType)

RemoveTocByType メソッドは、指定されたタイプのすべての目次を TOC パーサーオブジェクトから削除します。

enumTocPosType	TOC_POS_TYPE	in	削除対象の格納位置種別を示すTOC_POS_TYPE列挙値。
guidTocType	GUID	in	削除する目次のタイプを指定するグローバル一意識別子 (GUID)。「解説」を参照してください。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。

解説(Remarks)

vtbl 10 HRESULT Commit()

Commit メソッドは、TOC パーサーオブジェクトの現在の状態を、関連付けられたメディアファイルに格納します。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは成功しました。

解説(Remarks)

ITocParser::Init を呼び出すことで、TOC パーサーオブジェクトをメディアファイルと関連付けることができます。TOC パーサーオブジェクトに対して目次を追加、変更、または削除しても、それらの変更はメモリ内の TOC パーサーオブジェクトにのみ反映され、メディアファイルには反映されません。変更をメディアファイルに格納するには、ITocParser::Commit を呼び出す必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITocParser "{ECFB9A55-9298-4F49-887F-0B36206599D2}"
#usecom global ITocParser IID_ITocParser "{}"
#comfunc global ITocParser_Init              3 wstr
#comfunc global ITocParser_GetTocCount       4 int,var
#comfunc global ITocParser_GetTocByIndex     5 int,int,sptr
#comfunc global ITocParser_GetTocByType      6 int,int,sptr
#comfunc global ITocParser_AddToc            7 int,sptr,var
#comfunc global ITocParser_RemoveTocByIndex  8 int,int
#comfunc global ITocParser_RemoveTocByType   9 int,int
#comfunc global ITocParser_Commit            10
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ITocParser "{ECFB9A55-9298-4F49-887F-0B36206599D2}"
#usecom global ITocParser IID_ITocParser "{}"
#comfunc global ITocParser_Init              3 wstr
#comfunc global ITocParser_GetTocCount       4 int,sptr
#comfunc global ITocParser_GetTocByIndex     5 int,int,sptr
#comfunc global ITocParser_GetTocByType      6 int,int,sptr
#comfunc global ITocParser_AddToc            7 int,sptr,sptr
#comfunc global ITocParser_RemoveTocByIndex  8 int,int
#comfunc global ITocParser_RemoveTocByType   9 int,int
#comfunc global ITocParser_Commit            10
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。