IAMStreamConfig

IAMStreamConfig インターフェースは、音声と映像の両方について、特定のキャプチャフィルターおよび圧縮フィルターの出力フォーマットを設定します。

フィルターは、このインターフェースを出力ピン上で公開します。このインターフェースを使用するには、フィルターのピンを列挙し、IAMStreamConfig をクエリします。あるいは、フィルターグラフの構築に Capture Graph Builder オブジェクトを使用している場合は、ICaptureGraphBuilder2::FindInterface メソッドを呼び出すことができます。キャプチャフィルターは、キャプチャ用とプレビュー用に別々のピンを持つ場合があることに注意してください。

フィルター開発者向け

SetFormat メソッドは、ピンの出力フォーマットを設定します。

HRESULT 値を返します。取り得る値には次のものがあります。

このメソッドは、出力ピンのフォーマットを指定します。ピンが接続されていない場合は、次回の接続時にこのフォーマットが使用されます。ピンが既に接続されている場合は、このフォーマットで再接続を試みます。相手側のピンが新しいタイプを拒否した場合、このメソッドは失敗することがあります。

このメソッドが成功すると、以降の IPin::EnumMediaTypes メソッドの呼び出しでは、新しいタイプのみが返され、それ以外は返されません。

ほとんどのフィルターでは、フィルターが一時停止中または実行中の場合、このメソッドは失敗します。一部の圧縮フィルターでは、フィルターの入力ピンが接続されていない場合にこのメソッドが失敗します。

一部のフィルターでは、値 NULL を指定してこのメソッドを呼び出すことで、ピンを既定のフォーマットにリセットできます。

フィルター開発者向け: 以下の解説では、このメソッドの実装方法を説明します。

出力ピンが接続されておらず、指定されたメディアタイプをピンがサポートしている場合は、S_OK を返します。そのメディアタイプを保存し、CBasePin::GetMediaType メソッドでフォーマット番号 0 として提供します。それ以外のフォーマットは提供せず、CBasePin::CheckMediaType メソッドで拒否します。

ピンが既に接続されており、そのメディアタイプをピンがサポートしている場合は、そのタイプでピンを再接続します。相手側のピンが新しいタイプを拒否した場合は、VFW_E_INVALIDMEDIATYPE を返し、元の接続を復元します。

GetFormat メソッドは、現在または優先される出力フォーマットを取得します。

HRESULT 値を返します。取り得る値には次のものがあります。

ピンが接続されている場合、このメソッドはピンが現在使用しているフォーマットを返します。それ以外の場合は、次回のピン接続に向けてピンが優先するフォーマットを返します。既に IAMStreamConfig::SetFormat メソッドを呼び出してフォーマットを設定している場合、GetFormat は同じフォーマットを返します。設定していない場合は、IPin::EnumMediaTypes メソッドで決定される、ピンの優先フォーマット一覧の最初のフォーマットを返します。

このメソッドは AM_MEDIA_TYPE 構造体のメモリを割り当て、構造体に値を設定して、pmt パラメーターで返します。呼び出し側は、フォーマットブロックを含め、このメモリを解放する必要があります。基底クラスライブラリの DeleteMediaType ヘルパー関数を使用できます。

一部の圧縮フィルターでは、フィルターの入力ピンが接続されていない場合にこのメソッドが失敗します。

例

IAMStreamConfig *pConfig = NULL;
// Query the output pin for IAMStreamConfig (not shown).
AM_MEDIA_TYPE *pmt = NULL;
hr = pConfig->GetFormat(&pmt);
if (SUCCEEDED(hr))
{
    /* Examine the media type for any information you need. */
    DeleteMediaType(pmt);
}
pConfig->Release();

GetNumberOfCapabilities メソッドは、このピンがサポートするフォーマット能力(capability)の数を取得します。

HRESULT 値を返します。取り得る値には次のものがあります。

出力ピンは、複数のフォーマット能力のセットをサポートできます。このメソッドは、ピンがサポートする能力の総数を返します。この数は piCount パラメーターで返されます。特定の能力のセットを取得するには、IAMStreamConfig::GetStreamCaps メソッドを呼び出します。フォーマット能力は 0 から始まるインデックスで管理されるため、piCount で返される値は上限より 1 大きい値になります。

ピンのフォーマットタイプに応じて、映像の場合は VIDEO_STREAM_CONFIG_CAPS 構造体、音声の場合は AUDIO_STREAM_CONFIG_CAPS 構造体になります。piSize パラメーターは、その構造体のサイズ(バイト単位)を受け取ります。

一部の圧縮フィルターでは、フィルターの入力ピンが接続されていない場合にこのメソッドが失敗します。

GetStreamCaps メソッドは、一組のフォーマット能力を取得します。

HRESULT 値を返します。取り得る値には次のものがあります。

このメソッドは、2 種類の情報を返します。

• pmt パラメーターは、サポートされる出力フォーマットの 1 つを記述する、値が設定済みの AM_MEDIA_TYPE 構造体を受け取ります。
• pSCC パラメーターは、追加のフォーマット情報を含む構造体を受け取ります。映像の場合、pSCC は VIDEO_STREAM_CONFIG_CAPS 構造体を受け取ります。音声の場合は、AUDIO_STREAM_CONFIG_CAPS 構造体を受け取ります。

SetFormat を呼び出す前に、pSCC の情報を使用して pmt 内の AM_MEDIA_TYPE 構造体を変更できます。たとえば、音声ピンは pmt パラメーターで既定のメディアタイプとして 44 kHz、16 ビット、ステレオを返すことがあります。AUDIO_STREAM_CONFIG_CAPS 構造体で返された値に基づいて、SetFormat を呼び出す前にこのフォーマットを 8 ビット、モノラルに変更できます。

このメソッドは、pmt パラメーターで返される AM_MEDIA_TYPE 構造体のメモリを割り当てます。呼び出し側は、フォーマットブロックを含め、このメモリを解放する必要があります。基底クラスライブラリの DeleteMediaType ヘルパー関数を使用できます。pSCC パラメーターのメモリは、呼び出し側が割り当てる必要があります。

一部の圧縮フィルターでは、フィルターの入力ピンが接続されていない場合にこのメソッドが失敗します。

フィルター開発者向け: このメソッドの実装に関する詳細については、Exposing Capture and Compression Formats を参照してください。

例

次の例は、映像出力ピンで最初にサポートされるフォーマット(インデックス 0)を取得し、そのフォーマットをピンに設定します。

int iCount, iSize;
BYTE *pSCC = NULL;
AM_MEDIA_TYPE *pmt;

hr = pConfig->GetNumberOfCapabilities(&iCount, &iSize);
pSCC = new BYTE[iSize];
if (pSCC == NULL)
{
    // TODO: Out of memory error.
}
// Get the first format.
hr = pConfig->GetStreamCaps(0, &pmt, pSCC));
if (hr == S_OK)
{
    // TODO: Examine the format. If it's not suitable for some
    // reason, call GetStreamCaps with the next index value (up
    // to iCount). Otherwise, set the format:
    hr = pConfig->SetFormat(pmt);
    if (FAILED(hr))
    {
        // TODO: Error handling.
    }
    DeleteMediaType(pmt);
}
delete [] pSCC;