IPAT

COM

IID6623b511-4b5f-43c3-9a01-e8ff84188060継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IPAT インターフェースを使用すると、クライアントは Program Association Table (PAT) から情報を取得できます。このインターフェースへのポインターは、IAtscPsipParser::GetPAT メソッドが返します。

メソッド 11

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

vtbl 3 HRESULT Initialize(ISectionList* pSectionList, IMpeg2Data* pMPEGData)

Initialize メソッドは、キャプチャしたテーブルセクションのデータを使用してオブジェクトを初期化します。このメソッドは IAtscPsipParser::GetPAT メソッドによって内部的に呼び出されるため、通常、アプリケーションはこのメソッドを呼び出すべきではありません。

pSectionList	ISectionList*	in	セクションデータを含む SectionList オブジェクトの ISectionList インターフェースへのポインター。
pMPEGData	IMpeg2Data*	in	MPEG-2 Sections and Tables フィルターの IMpeg2Data インターフェースへのポインター。

戻り値

このメソッドは HRESULT を返します。取り得る値には次の表のものが含まれます。

戻り値	説明
E_INVALIDARG	引数が無効です。
MPEG2_E_ALREADY_INITIALIZED	オブジェクトはすでに初期化されています。
S_OK	メソッドは成功しました。

vtbl 4 HRESULT GetTransportStreamId(WORD* pwVal)

GetTransportStreamId メソッドは、PAT のトランスポートストリーム識別子 (TSID) を返します。

pwVal

WORD*

out

transport_stream_id フィールドを受け取ります。

戻り値

このメソッドは HRESULT を返します。取り得る値には次の表のものが含まれます。

戻り値	説明
E_POINTER	NULL ポインター引数です。
S_OK	メソッドは成功しました。

vtbl 5 HRESULT GetVersionNumber(BYTE* pbVal)

GetVersionNumber メソッドは、PAT のバージョン番号を返します。

pbVal

BYTE*

out

version_number フィールドを受け取ります。

戻り値

このメソッドは HRESULT を返します。取り得る値には次の表のものが含まれます。

戻り値	説明
E_POINTER	NULL ポインター引数です。
S_OK	メソッドは成功しました。

vtbl 6 HRESULT GetCountOfRecords(DWORD* pdwVal)

GetCountOfRecords メソッドは、PAT 内のレコード数を返します。各レコードは 1 つのプログラムに対応します。

pdwVal

DWORD*

out

レコード数を受け取ります。

戻り値

このメソッドは HRESULT を返します。取り得る値には次の表のものが含まれます。

戻り値	説明
E_POINTER	NULL ポインター引数です。
S_OK	メソッドは成功しました。

vtbl 7 HRESULT GetRecordProgramNumber(DWORD dwIndex, WORD* pwVal)

GetRecordProgramNumber メソッドは、PAT からプログラム番号を取得します。

dwIndex	DWORD	in	取得するレコードを指定します。インデックスは 0 から始まります。PAT 内のレコード数を取得するには、IPAT::GetCountOfRecords メソッドを呼び出します。
pwVal	WORD*	out	プログラム番号を受け取ります。

戻り値

このメソッドは HRESULT を返します。取り得る値には次の表のものが含まれます。

戻り値	説明
E_POINTER	NULL ポインター引数です。
MPEG2_E_OUT_OF_BOUNDS	インデックスが範囲外です。
S_OK	メソッドは成功しました。

vtbl 8 HRESULT GetRecordProgramMapPid(DWORD dwIndex, WORD* pwVal)

GetRecordProgramMapPid メソッドは、PAT 内の指定したレコードのパケット識別子 (PID) を返します。

dwIndex	DWORD	in	取得するレコードを指定します。インデックスは 0 から始まります。PAT 内のレコード数を取得するには、IPAT::GetCountOfRecords メソッドを呼び出します。
pwVal	WORD*	out	PID を受け取ります。この値は、関連するプログラムの program map table (PMT) を含むパケットの PID を示します。

戻り値

このメソッドは HRESULT を返します。取り得る値には次の表のものが含まれます。

戻り値	説明
E_POINTER	NULL ポインター引数です。
MPEG2_E_OUT_OF_BOUNDS	インデックスが範囲外です。
S_OK	メソッドは成功しました。

vtbl 9 HRESULT FindRecordProgramMapPid(WORD wProgramNumber, WORD* pwVal)

FindRecordProgramMapPid メソッドは、指定したプログラム番号に関連付けられた program map table (PMT) のパケット識別子 (PID) を返します。

wProgramNumber	WORD	in	プログラム番号を指定します。
pwVal	WORD*	out	PID を受け取ります。

戻り値

このメソッドは HRESULT を返します。取り得る値には次の表のものが含まれます。

戻り値	説明
E_POINTER	NULL ポインター引数です。
MPEG2_E_NOT_PRESENT	テーブルに指定されたプログラム番号が含まれていません。
S_OK	メソッドは成功しました。

vtbl 10 HRESULT RegisterForNextTable(HANDLE hNextTableAvailable)

RegisterForNextTable メソッドは、current テーブルを置き換える next テーブルが到着したときに通知を受け取るよう、クライアントを登録します。

hNextTableAvailable

HANDLE

呼び出し元が作成したイベントへのハンドル。next テーブルが到着すると、オブジェクトはこのイベントをシグナル状態にします。イベントがシグナル状態になったら、IPAT::GetNextTable メソッドを呼び出してテーブルを取得します。

戻り値

このメソッドは HRESULT を返します。取り得る値には次の表のものが含まれます。

戻り値	説明
E_ACCESSDENIED	このテーブルはすでに next テーブルです。
E_INVALIDARG	引数が無効です。hNextTableAvailable を NULL にすることはできません。
MPEG2_E_ALREADY_INITIALIZED	メソッドはすでに呼び出されています。
S_OK	メソッドは成功しました。

解説(Remarks)

このメソッドは current テーブルにのみ適用されます。それ以外の場合、このメソッドは E_ACCESSDENIED を返します。

vtbl 11 HRESULT GetNextTable(IPAT** ppPAT)

GetNextTable メソッドは、current テーブルに続く next テーブルを取得します。

ppPAT

IPAT**

out

IPAT インターフェースポインターを受け取る変数のアドレス。呼び出し元はこのインターフェースを解放する必要があります。

戻り値

このメソッドは HRESULT を返します。取り得る値には次の表のものが含まれます。

戻り値	説明
E_ACCESSDENIED	このテーブルは current ではありません。
E_FAIL	失敗しました。
S_OK	メソッドは成功しました。

解説(Remarks)

このメソッドは current テーブルにのみ適用されます。それ以外の場合、このメソッドは E_ACCESSDENIED を返します。

vtbl 12 HRESULT RegisterForWhenCurrent(HANDLE hNextTableIsCurrent)

RegisterForWhenCurrent メソッドは、テーブルが current になったときに通知を受け取るよう、クライアントを登録します。

hNextTableIsCurrent

HANDLE

呼び出し元が作成したイベントへのハンドル。テーブルが current になると、オブジェクトはこのイベントをシグナル状態にします。

戻り値

このメソッドは HRESULT を返します。取り得る値には次の表のものが含まれます。

戻り値	説明
E_ACCESSDENIED	このテーブルはすでに current テーブルです。
E_INVALIDARG	引数が無効です。hNextTableIsCurrent を NULL にすることはできません。
MPEG2_E_ALREADY_INITIALIZED	メソッドはすでに呼び出されています。
S_OK	メソッドは成功しました。

解説(Remarks)

このメソッドは next テーブルにのみ適用されます。それ以外の場合、このメソッドは E_ACCESSDENIED を返します。

vtbl 13 HRESULT ConvertNextToCurrent()

ConvertNextToCurrent メソッドは、next テーブルを current テーブルに変換します。

戻り値

このメソッドは HRESULT を返します。取り得る値には次の表のものが含まれます。

戻り値	説明
E_ACCESSDENIED	このテーブルはすでに current です。
E_INVALIDARG	RegisterForWhenCurrent メソッドが呼び出されていません。
MPEG2_E_MALFORMED_TABLE	新しい current テーブルの形式が正しくありません。
S_OK	メソッドは成功しました。

解説(Remarks)

このメソッドは、current になった next テーブルにのみ適用されます。このメソッドを呼び出す前に、IPAT::RegisterForWhenCurrent を呼び出し、イベントがシグナル状態になるのを待ちます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IPAT "{6623B511-4B5F-43C3-9A01-E8FF84188060}"
#usecom global IPAT IID_IPAT "{}"
#comfunc global IPAT_Initialize               3 sptr,sptr
#comfunc global IPAT_GetTransportStreamId     4 var
#comfunc global IPAT_GetVersionNumber         5 var
#comfunc global IPAT_GetCountOfRecords        6 var
#comfunc global IPAT_GetRecordProgramNumber   7 int,var
#comfunc global IPAT_GetRecordProgramMapPid   8 int,var
#comfunc global IPAT_FindRecordProgramMapPid  9 int,var
#comfunc global IPAT_RegisterForNextTable     10 sptr
#comfunc global IPAT_GetNextTable             11 sptr
#comfunc global IPAT_RegisterForWhenCurrent   12 sptr
#comfunc global IPAT_ConvertNextToCurrent     13
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IPAT "{6623B511-4B5F-43C3-9A01-E8FF84188060}"
#usecom global IPAT IID_IPAT "{}"
#comfunc global IPAT_Initialize               3 sptr,sptr
#comfunc global IPAT_GetTransportStreamId     4 sptr
#comfunc global IPAT_GetVersionNumber         5 sptr
#comfunc global IPAT_GetCountOfRecords        6 sptr
#comfunc global IPAT_GetRecordProgramNumber   7 int,sptr
#comfunc global IPAT_GetRecordProgramMapPid   8 int,sptr
#comfunc global IPAT_FindRecordProgramMapPid  9 int,sptr
#comfunc global IPAT_RegisterForNextTable     10 sptr
#comfunc global IPAT_GetNextTable             11 sptr
#comfunc global IPAT_RegisterForWhenCurrent   12 sptr
#comfunc global IPAT_ConvertNextToCurrent     13
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。