ICodecAPI

ICodecAPI インターフェイス (strmif.h) は、エンコーダーまたはデコーダーフィルターの設定を取得および設定します。

このインターフェイスは、コーデック (エンコーダーまたはデコーダー) にプロパティを設定するための汎用的なメカニズムを定義します。コーデックプロパティはキー/値のペアであり、キーは GUID、値は VARIANT です。VARIANT データの解釈は、プロパティ GUID に依存します。コーデックプロパティ GUID の一覧については、Codec API Properties を参照してください。

コーデックプロファイル

HKEY_LOCAL_MACHINE
   Software
      Classes
         CLSID
            Category
               Profiles

  HLKM\Software\Classes\CLSID\<category>\Profiles\DVD
    default "HQ DVD"
    REG_SZ {...} = "0"
    REG_SZ {...} = "1234"

既定のコーデック機能は、HLKM\Software\Classes\CLSID<category>\Instance<Filter CLSID>\Capabilities に保存されます。各値は GUID 名を持ち、その後に数値の GUID 値を含む文字列値が続きます。例:

HLKM\Software\Classes\CLSID\<category>\Instance\<My DVD encoder>\Capabilities
     default "My DVD encoder"
     REG_SZ_MULTI {...}

IsSupported メソッドは、コーデックが指定されたプロパティをサポートしているかどうかを照会します。(ICodecAPI.IsSupported)

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

上記の表に記載されているもの以外のエラーは、呼び出しを処理できないことを示します。

IsModifiable メソッドは、コーデックの現在の構成において、コーデックプロパティを変更できるかどうかを照会します。(ICodecAPI.IsModifiable)

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

上記の表に記載されているもの以外のエラーは、呼び出しを処理できないことを示します。

GetParameterRange メソッドは、コーデックプロパティの値の範囲を取得します。(ICodecAPI.GetParameterRange)

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

プロパティの有効な範囲は [ValueMin... ValueMax] であり、増分は SteppingDelta です。プロパティが値の線形範囲をサポートしている場合、そのプロパティは次のいずれかの variant 型を使用する必要があります。

• 符号なし型: VT_UI8、VT_UI4、VT_UI2、VT_UI1
• 符号付き型: VT_I8、VT_I4、VT_I2
• 浮動小数点型: VT_R8、VT_R4

GetParameterValues メソッドは、コーデックプロパティに指定可能な値のリストを取得します。(ICodecAPI.GetParameterValues)

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

プロパティがリストではなく値の範囲をサポートしている場合、このメソッドは VFW_E_CODECAPI_LINEAR_RANGE を返します。その場合は、ICodecAPI::GetParameterRange を呼び出して値の範囲を取得してください。

GetDefaultValue メソッドは、コーデックプロパティの既定値を取得します。(ICodecAPI.GetDefaultValue)

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

GetValue メソッドは、コーデックプロパティの現在の値を取得します。

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

SetValue メソッドは、コーデックプロパティの値を設定します。(ICodecAPI.SetValue)

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

RegisterForEvent メソッドは、コーデックからイベントを受信するようにアプリケーションを登録します。(ICodecAPI.RegisterForEvent)

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

エンコーダーコーデックがイベントを送信するたびに、アプリケーションは EC_CODECAPI_EVENT イベント通知を受け取ります。イベントを取得するには、IMediaEventEx インターフェイスを使用します。

イベントの lParam2 パラメーターは、CodecAPIEventData 構造体へのポインターです。この構造体の後には、イベント GUID に応じて追加データが続く場合があります。このデータのサイズは、dataLength メンバーによって示されます。

コーデックが指定されたイベントをサポートしていない場合、このメソッドは E_NOTIMPL を返します。コーデックは他のイベントをサポートしている可能性があります。

イベントの通知を無効にするには、ICodecAPI::UnregisterForEvent を呼び出してください。

UnregisterForEvent メソッドは、指定されたエンコーダーイベントに対するアプリケーションの登録を解除します。(ICodecAPI.UnregisterForEvent)

メソッドが成功した場合は S_OK を返します。失敗した場合は HRESULT エラーコードを返します。

SetAllDefaults メソッドは、すべてのコーデックプロパティを既定値にリセットします。(ICodecAPI.SetAllDefaults)

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

SetValueWithNotify メソッドは、コーデックにプロパティを設定し、その結果として変更された他のプロパティのリストを返します。(ICodecAPI.SetValueWithNotify)

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

ICodecAPI を実装するコーデックは、このメソッドをサポートする必要はありません。

SetAllDefaultsWithNotify メソッドは、すべてのコーデックプロパティを既定値にリセットし、変更されたプロパティのリストを返します。(ICodecAPI.SetAllDefaultsWithNotify)

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

ICodecAPI を実装するコーデックは、このメソッドをサポートする必要はありません。

GetAllSettings メソッドは、コーデックの現在のプロパティを取得し、ストリームに書き込みます。(ICodecAPI.GetAllSettings)

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

ICodecAPI を実装するコーデックは、このメソッドをサポートする必要はありません。

ストリームからプロパティを読み込んでコーデックに戻すには、ICodecAPI::SetAllSettings または ICodecAPI::SetAllSettingsWithNotify を呼び出してください。

ストリームに書き込まれるデータの形式は、コーデックの実装に依存します。標準的なシリアル化形式はありません。アプリケーションは、あるコーデックからプロパティを保存し、それを別のコーデックに読み込もうとしてはなりません。

SetAllSettings メソッドは、ストリームからコーデックプロパティを読み取り、コーデックに設定します。(ICodecAPI.SetAllSettings)

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

ICodecAPI を実装するコーデックは、このメソッドをサポートする必要はありません。

SetAllSettingsWithNotify メソッドは、ストリームからコーデックプロパティを読み取ってコーデックに設定し、変更されたプロパティのリストを返します。(ICodecAPI.SetAllSettingsWithNotify)

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

ICodecAPI を実装するコーデックは、このメソッドをサポートする必要はありません。