IWMWriter

IWMWriter インターフェースは、ASF ファイルの書き込みに使用します。

SetProfileByID メソッドは、現在の書き込みタスクで使用するプロファイルを、その GUID によって識別して指定します。

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

ID を持つのはシステムプロファイルのみです。システムプロファイルを調べるには、IWMProfileManager インターフェースのメソッドを使用してください。ヘッダーファイル Wmsysprf.h に、システムプロファイルとその ID の一覧が記載されています。

SetProfile メソッドは、現在の書き込みタスクで使用するプロファイルを指定します。

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

このメソッドを呼び出すと、それまでに設定されたヘッダー属性情報はすべて削除されます。

このメソッドを呼び出した後にプロファイルオブジェクトへ加えた変更は、SetProfile を再度呼び出すまで有効になりません。

プロファイル内のストリームの最大数は、定数 WM_MAX_STREAMS で定義されているとおり 63 です。別の定数 WM_MAX_VIDEO_STREAMS はビデオストリームの最大数を定義しており、これも 63 です。

SetOutputFilename メソッドは、書き込むファイルの名前を指定します。

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

このメソッドは、インデックス 0 のファイルシンクを作成し、IWMWriterAdvanced::AddSink の呼び出しを通じて追加することと同等であり、便宜のために提供されています。

このメソッドで作成されたファイルシンクの IWMWriterSink インターフェースへのポインターは、IWMWriterAdvanced::GetSink を呼び出すことで取得できます。ライターは、関連付けられたシンクのステータスメッセージを配信しないため、これは重要です。IWMWriterSink に対して QueryInterface を呼び出すことで、IWMRegisterCallback へのポインターを取得できます。これは、シンクがステータスメッセージを配信する先の IWMStatusCallback::OnStatus コールバックメソッドを設定するために使用します。

GetInputCount メソッドは、非圧縮入力ストリームの数を取得します。

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

このメソッドは GetInputProps とともに使用して、さまざまな入力を列挙し、それぞれの入力フォーマットを取得できます。これらは、プロファイルで指定される出力 Windows Media ストリームではありません。マルチビットレートのシナリオでは、1 つの入力ストリームが複数の Windows Media ストリームに対応することがあります。

GetInputProps メソッドは、指定した入力ストリームの現在のメディアプロパティを取得します。

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

dwInputNum パラメーターに使用するインデックスの範囲は、GetInputCount を呼び出すことで確認できます。

IWMInputMediaProps オブジェクトを操作しても、アプリケーションが入力を構成するために SetInputProps メソッドを呼び出さない限り、ライターには影響しません。

SetInputProps メソッドは、入力ストリームのメディアプロパティを指定します。

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

IWMInputMediaProps オブジェクトを操作しても、アプリケーションが入力を構成するためにこのメソッドを呼び出すまでは、ライターには影響しません。

入力が、再圧縮されずに (IWMWriterAdvanced::WriteStreamSample を使用して) 新しいストリームに直接書き込まれる圧縮済みサンプルを含む場合は、pInput に NULL を指定してください。

GetInputFormatCount メソッドは、ライター上のこの入力がサポートするメディアフォーマットタイプの数を取得します。

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

GetInputFormat メソッドは、指定した入力に対して可能なメディアフォーマットを取得します。

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

BeginWriting メソッドは、書き込みプロセスを初期化します。

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

BeginWriting メソッドは、サンプルを書き込む前に呼び出す必要があります。このメソッドは実際に書き込みを開始するのではなく、プロセスを初期化します。この呼び出しから EndWriting の呼び出しまでの間、ライターの構成を変更することはできません。サンプルの書き込みを正常に終了するには、EndWriting メソッドを呼び出す必要があります。

次の操作は、BeginWriting を呼び出す前にのみ実行できます:

• SetProfile によるプロファイルの設定
• 出力ファイル名の設定 (IWMWriter::SetOutputFilename を使用する場合)
• IWMHeaderInfo::SetAttribute による属性の設定
• マーカー操作 (IWMHeaderInfo::GetMarkerCount、GetMarker、AddMarker、RemoveMarker。ただし AddMarker はライターには実装されておらず、マーカーがない場合は残りのメソッドも役に立ちません)
• 入力ストリームが WriteStreamSample を使用して書き込まれることを示すために、NULL の IWMInputMediaProps パラメーターを指定して IWMWriter::SetInputProps を呼び出す。
• ヘッダースクリプト操作 (IWMHeaderInfo::GetScriptCount、GetScript、AddScript、RemoveScript)
• コーデック情報操作 (IWMHeaderInfo2::GetCodecInfoCount と GetCodecInfo)
• IWMWriterPostView::SetPostViewProps

• IWMHeaderInfo::GetAttributeCount
• IWMHeaderInfo::GetAttributeByIndex
• IWMHeaderInfo::GetAttributeByName
• IWMWriterAdvanced2::SetInputSetting

注: SetInputSetting は、g_wszDeinterlaceMode、g_wszInitialPatternForInverseTelecine、g_wszInterlacedCoding、および g_wszJPEGCompressionQuality については BeginWriting の後に呼び出すことができます。

次の操作は、プロファイルが設定された後であればいつでも実行できます:

• SetPostViewProps を除くすべてのポストビュー操作
• IWMWriter::SetInputProps。ただし NULL の IWMInputMediaProps パラメーターを渡す場合を除きます。
• IWMWriter::GetInputProps
• IWMWriter::GetInputFormatCount
• IWMWriter::GetInputFormat

• IWMWriter::AllocateSample によるサンプルの割り当て
• IWMWriter::WriteSample および IWMWriterAdvanced::WriteStreamSample によるサンプルの書き込み
• IWMWriter::EndWriting

• IWMWriterAdvanced::AddSink および IWMWriterAdvanced::RemoveSink によるシンクの追加と削除
• IWMWriterAdvanced::SetLiveSource
• IWMWriterAdvanced::IsRealTime
• IWMWriterAdvanced::GetWriterTime (ただし意味のある値は返しません)
• IWMWriterAdvanced::GetStatistics
• IWMWriterAdvanced::SetSyncTolerance
• IWMWriterAdvanced::GetSyncTolerance

例

次のサンプルコードは、ライターをセットアップし、出力をネットワークシンクとアーカイブファイルの両方に送信する方法の概要を示しています。

IWMWriter *             pWriter = NULL;
IWMWriterAdvanced *     pWriterAdvanced = NULL;
IWMWriterFileSink2 *    pWriterFileSink = NULL;
IWMWriterNetworkSink2 * pWriterNetworkSink = NULL;
HRESULT                 hr = S_OK;
DWORD                   dwPort;

// エラー処理を簡単にするため、すべてをダミーループ内で行います。

do
{
    // 基本オブジェクトを作成します。

    hr = WMCreateWriter( &pWriter );
    if( FAILED( hr ) )
    {
        break;
    }

    hr = WMCreateWriterFileSink( &pWriterFileSink );
    if( FAILED( hr ) )
    {
        break;
    }

    hr = WMCreateWriterNetworkSink( &pWriterNetworkSink );
    if( FAILED( hr ) )
    {
        break;
    }

    // IWMWriterAdvanced インターフェースへのポインターを取得し、シンクを追加します。

    hr = pWriter->QueryInterface( IID_IWMWriterAdvanced, (void **)&pWriterAdvanced );
    if( FAILED( hr ) )
    {
        break;
    }

    hr = pWriterAdvanced->AddSink( pWriterFileSink );
    if( FAILED( hr ) )
    {
        break;
    }

    hr = pWriterAdvanced->AddSink( pWriterNetworkSink );
    if( FAILED( hr ) )
    {
        break;
    }

    hr = pWriterFileSink->Open( L"Archive file name" );
    if( FAILED( hr ) )
    {
        break;
    }

    // ポート番号をゼロに設定すると、SDK が適切な
    // ポート番号を選択できるようになります。
    dwPort = 0;
    hr = pWriterNetworkSink->Open( &dwPort );
    if( FAILED( hr ) )
    {
        break;
    }

    hr = pWriter->BeginWriting();
    if( FAILED( hr ) )
    {
        break;
    }

    // ライターへデータを送信するコードをここに記述します (省略)。

    // 両方のシンクを閉じます。
    hr = pWriterFileSink->Close();
    if( FAILED( hr ) )
    {
        break;
    }

    hr = pWriterNetworkSink->Close();
    if( FAILED( hr ) )
    {
        break;
    }

    hr = pWriter-> EndWriting();
    if( FAILED( hr ) )
    {
        break;
    }
}
while( FALSE );

// クリーンアップします。

if ( pWriter )
{
    pWriter->Release();
}
if ( pWriterAdvanced )
{
    pWriterAdvanced->Release();
}
if ( pWriterFileSink )
{
    pWriterFileSink->Release();
}
if ( pWriterNetworkSink )
{
    pWriterNetworkSink->Release();
}

EndWriting メソッドは、書き込みセッションの終了時に必要なタスクを実行します。

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

エンコードが完了する前にディスク領域を使い果たした場合でも、このメソッドは失敗コードを返しません。ファイル書き込みエラーの通知を受け取るには、アプリケーションで IWMStatusCallback メソッドを実装し、NS_E_FILE_WRITE イベントをリッスンする必要があります。

AllocateSample メソッドは、ライターにサンプルを提供するために使用できるバッファーを割り当てます。

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

ライターオブジェクトに渡す各サンプルには、新しいバッファーを使用する必要があります。IWMWriter::WriteSample の呼び出しに渡した後のバッファーを再利用すると、ライターオブジェクトはバッファーオブジェクトへの参照をすぐには解放しないため、エラーが発生します。バッファーオブジェクトのインターフェースは、WriteSample の呼び出しが返った後であればいつでも安全に解放できます。

WriteSample メソッドは、圧縮されて作成中のファイルに追加される非圧縮データを渡します。

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

出力ストリームにタイムコードのデータユニット拡張があり、サンプルにタイムコード拡張がない場合、後でファイルをインデックス化する際に問題を引き起こさないよう、このメソッドは失敗します。その他のデータユニット拡張は、サンプルでは省略可能です。つまり、ストリームに対してデータユニット拡張が指定されていても、サンプルに実際のデータ拡張が存在しない場合、このメソッドは成功します。WriteSample は、サンプルに拡張が指定されていないサンプルについては、ファイルにゼロを書き込みます。

Flush メソッドの機能は削除されました。IWMWriter::EndWriting が必要なチェックを内部で実行するためです。古いアプリケーションとの互換性のため、flush の呼び出しは何も行いませんが、常に S_OK を返します。

このメソッドは常に S_OK を返します。