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

IEncoderAPI

COM
📘 Microsoft Learn (日本語) · English
IID70423839-6acc-4b23-b079-21dbf08156a5継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IEncoderAPI は現在使用できません。(IEncoderAPI)

解説(Remarks)

各インターフェイスメソッドでは、設定または取得の対象となるパラメーターを示すために、uuids.h で定義された次の GUID を使用します。

パラメーター 説明
ENCAPIPARAM_BITRATE ビットレートをビット/秒単位で指定します。固定ビットレート (CBR) モードでは、この値は固定ビットレートを表します。いずれかの可変ビットレートモードでは、平均ビットレートを表します。値は 32 ビットの unsigned long です。
ENCAPIPARAM_PEAK_BITRATE ピークビットレートを指定します。このパラメーターは、ENCAPIPARAM_BITRATE_MODE が VariableBitRatePeak に設定されている場合にのみ有効です。
ENCAPIPARAM_BITRATE_MODE ビットレートモードを VIDEOENCODER_BITRATE_MODE 列挙値 (32 ビットの signed long) として指定します。

次の表は、VIDEOENCODER_BITRATE_MODE で定義された 2 つの可変ビットレートモードにおいて、極端に高いまたは低いビットレート条件下でエンコーダーが示す想定動作を説明します。

条件 モード 動作
シーンが真っ黒になる、または動きがまったくない VariableBitRateAverage 短時間 (数秒間) のうちに、ビットレートは ENCAPIPARAM_BITRATE パラメーターで指定されたレートを下回ります。ただし 4 分間という期間で見ると、エンコーダーは必要に応じてストリームに "ダミー" ビットを追加することで平均レートを維持します。
シーンが真っ黒になる、または動きがまったくない。 VariableBitRatePeak ビットレートは、ENCAPIPARAM_BITRATE パラメーターの値で指定された想定レートを下回ります。より複雑なシーンが始まるまで、レートはそのレベルにとどまります。
シーンが極めて複雑である。 VariableBitRateAverage 数秒間はレートが上昇します。複雑なシーンが続く場合、レートは元に戻り、ENCAPIPARAM_BITRATE パラメーターの値で指定された平均を維持するために画像はブロックノイズが目立つようになります。
シーンが極めて複雑である。 VariableBitRatePeak レートは上昇したまま維持され、ENCAPIPARAM_BITRATE パラメーターの値で指定された想定レートを超える場合もありますが、ENCAPIPARAM_PEAK_BITRATE パラメーターで指定されたピークを超えることはありません。

OCUR デバイス

このインターフェイスは OpenCable Unidirectional Cable Receiver (OCUR) デバイスをサポートします。OCUR Devices を参照してください。

メソッド 7

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

vtbl 3 HRESULT IsSupported(GUID* Api)

IsSupported メソッドは、指定したパラメーターがサポートされているかどうかを照会します。

ApiGUID*inパラメーターを指定する GUID へのポインター。

戻り値

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

戻り値 説明
S_OK
 エンコーダーはこのパラメーターをサポートしています。
E_NOTIMPL
 エンコーダーはこのパラメーターをサポートしていません。

解説(Remarks)

エンコーダーが GUID を認識した場合、このメソッドは S_OK を返します。パラメーターの読み取りまたは変更が可能かどうかを確認するには、IEncoderAPI::IsAvailable メソッドを呼び出してください。

上記の表に示したもの以外のエラーは、呼び出しを処理できなかったことを示します。

vtbl 4 HRESULT IsAvailable(GUID* Api)

IEncoderAPI は現在使用できません。(IEncoderAPI.IsAvailable)

ApiGUID*inパラメーターを指定する GUID へのポインター。

戻り値

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

戻り値 説明
S_OK
 パラメーターの読み取りと変更が可能です。(このパラメーターでは set および get 操作がサポートされています。)
E_NOTIMPL
 パラメーターの読み取りまたは変更はできません。

解説(Remarks)

上記の表に示したもの以外のエラーは、呼び出しを処理できなかったことを示します。

vtbl 5 HRESULT GetParameterRange(GUID* Api, VARIANT* ValueMin, VARIANT* ValueMax, VARIANT* SteppingDelta)

GetParameterRange メソッドは、パラメーターが特定の値のリストではなく段階的な範囲をサポートしている場合に、そのパラメーターがサポートする有効な値の範囲を取得します。

ApiGUID*inパラメーターを指定する GUID へのポインター。
ValueMinVARIANT*outパラメーターの最小値を受け取る VARIANT 型へのポインター。
ValueMaxVARIANT*outパラメーターの最大値を受け取る VARIANT 型へのポインター。
SteppingDeltaVARIANT*outステッピングデルタを受け取る VARIANT 型へのポインター。ステッピングデルタは、ValueMin から ValueMax までの有効な増分を定義します。

戻り値

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

戻り値 説明
S_OK
 メソッドは成功しました。
E_NOTIMPL
 このプロパティは連続した範囲ではなく、取り得る値のリストをサポートしています。

解説(Remarks)

パラメーターの有効な範囲は [ValueMax...ValueMax] で、増分は SteppingDelta です。パラメーターが段階的な値の範囲をサポートする場合、次のいずれかの variant 型を使用する必要があります。

定義により、パラメーターは特定の型を返します。

任意のステッピング値が有効です。範囲にステッピングデルタがない場合 (つまり任意の値で増分できる場合)、エンコーダーは SteppingDelta に空の値 (VT_EMPTY) を返す必要があります。

Api が ENCAPIPARAM_BITRATE_MODE の場合、ビットレートモード定数は特定の値のリストであるため、このメソッドは E_NOTIMPL を返します。

vtbl 6 HRESULT GetParameterValues(GUID* Api, VARIANT** Values, DWORD* ValuesCount)

GetParameterValues メソッドは、指定したパラメーターがサポートする値のリストを取得します。

ApiGUID*inパラメーターを指定する GUID へのポインター。
ValuesVARIANT**out値を受け取る配列へのポインターのアドレス。
ValuesCountDWORD*out配列に格納されたエントリの数を示します。

戻り値

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

解説(Remarks)

このメソッドは、パラメーターがサポートする個々の値を表す VARIANT 型の配列を返します。この配列は呼び出される側が CoTaskMemAlloc を通じて割り当て、Values パラメーターに格納します。終了時、ValuesCount には配列内の要素数が格納されます。呼び出し側は CoTaskMemFree を呼び出して配列を解放する必要があります。

vtbl 7 HRESULT GetDefaultValue(GUID* Api, VARIANT* Value)

GetDefaultValue メソッドは、パラメーターに既定値が存在する場合、その既定値を取得します。

ApiGUID*inパラメーターを指定する GUID へのポインター。
ValueVARIANT*outApi で指定されたパラメーターの値を受け取ります。Api に ENCAPIPARAM_BITRATE_MODE を指定した場合、Value は VIDEOENCODER_BITRATE_MODE 定数のいずれかになります。

戻り値

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

vtbl 8 HRESULT GetValue(GUID* Api, VARIANT* Value)

GetValue メソッドは、指定したパラメーターの現在の値を取得します。

ApiGUID*inパラメーターを指定する GUID へのポインター。
ValueVARIANT*outApi で指定されたパラメーターの値を受け取ります。Api に ENCAPIPARAM_BITRATE_MODE を指定した場合、Value は VIDEOENCODER_BITRATE_MODE 定数のいずれかになります。

戻り値

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

vtbl 9 HRESULT SetValue(GUID* Api, VARIANT* Value)

SetValue メソッドは、パラメーターの現在の値を設定します。

ApiGUID*inパラメーターを指定する GUID へのポインター。
ValueVARIANT*inApi の値を指定するポインター。Api に ENCAPIPARAM_BITRATE_MODE を指定した場合、Value は VIDEOENCODER_BITRATE_MODE 定数のいずれかである必要があります。

戻り値

このメソッドが成功した場合は 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_IEncoderAPI "{70423839-6ACC-4B23-B079-21DBF08156A5}"
#usecom global IEncoderAPI IID_IEncoderAPI "{}"
#comfunc global IEncoderAPI_IsSupported         3 var
#comfunc global IEncoderAPI_IsAvailable         4 var
#comfunc global IEncoderAPI_GetParameterRange   5 var,var,var,var
#comfunc global IEncoderAPI_GetParameterValues  6 var,var,var
#comfunc global IEncoderAPI_GetDefaultValue     7 var,var
#comfunc global IEncoderAPI_GetValue            8 var,var
#comfunc global IEncoderAPI_SetValue            9 var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。