lipsync/Boare.Lib.Media/Boare.Lib.Media.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Boare.Lib.Media</name>
    </assembly>
    <members>
        <member name="T:Boare.Lib.Media.AviReader">
            <summary>
            Extract bitmaps from AVI files
            </summary>
        </member>
        <member name="M:Boare.Lib.Media.AviReader.Open(System.String)">
            <summary>
            Opens an AVI file and creates a GetFrame object
            </summary>
            <param name="fileName">Name of the AVI file</param>
        </member>
        <member name="M:Boare.Lib.Media.AviReader.Close">
            <summary>Closes all streams, files and libraries</summary>
        </member>
        <member name="M:Boare.Lib.Media.AviReader.ExportBitmap(System.Int32,System.String)">
            <summary>Exports a frame into a bitmap file</summary>
            <param name="position">Position of the frame</param>
            <param name="dstFileName">Name ofthe file to store the bitmap</param>
        </member>
        <member name="F:Boare.Lib.Media.AviWriterVcm.m_this_movi_size">
            <summary>
            現在記入中のmoviチャンクのサイズ
            </summary>
        </member>
        <member name="P:Boare.Lib.Media.AviWriterVcm.VfwBugCompatible">
            <summary>
            Video For Windows APIとバグコンパチブルな動作をするかどうかを表す値を取得または設定します
            </summary>
        </member>
        <member name="M:Boare.Lib.Media.AviWriterVcm.Open(System.String,System.UInt32,System.UInt32,System.Int32,System.Int32,System.Boolean,System.Boolean,System.IntPtr)">
            <summary>
            指定したAVI_CONTAINER構造体にAVIファイルの情報を格納すると共に，
            ファイルにヘッダー情報を書き込みます．
            </summary>
            <param name="file">書き込み対象のファイル</param>
            <param name="scale"></param>
            <param name="rate"></param>
            <param name="compressed"></param>
        </member>
        <member name="M:Boare.Lib.Media.AviWriterVcm.UpdateIndex">
            <summary>
            全てのインデックスを更新し、ファイルが（動画ファイルとして）使用できる状態にします
            この関数を読んだあとでも，さらにaviAddFrame関数を使うことでフレームを追加することが出来ます．
            </summary>
        </member>
        <member name="M:Boare.Lib.Media.AviWriterVcm.Close">
            <summary>
            aviファイルを閉じます
            </summary>
        </member>
        <member name="M:Boare.Lib.Media.AviWriterVcm.UpdateIndexOfIndex">
            <summary>
            最初の[AVI :AVI[LIST:hdrl[LIST:strl]]]に書き込まれているsuper indexチャンク[indx]を更新します
            </summary>
        </member>
        <member name="M:Boare.Lib.Media.AviWriterVcm.AddFrame(System.Drawing.Bitmap)">
            <summary>
            aviファイルにフレームを1つ追加します．
            </summary>
            <param name="bmp"></param>
        </member>
        <member name="T:Boare.Lib.Media.MediaPlayer">
            <summary>
            Sound player using mciSendSring command operation
            </summary>
        </member>
        <member name="F:Boare.Lib.Media.MediaPlayer.m_load_failed">
            <summary>
            the number of Load failure
            </summary>
        </member>
        <member name="P:Boare.Lib.Media.MediaPlayer.Speed">
            <summary>
            Gets or Sets the speed
            </summary>
        </member>
        <member name="M:Boare.Lib.Media.MediaPlayer.SetSpeed(System.Single)">
            <summary>
            Sets the speed
            </summary>
            <param name="speed">the value of speed to set</param>
        </member>
        <member name="P:Boare.Lib.Media.MediaPlayer.Volume">
            <summary>
            Gets or Sets the volume (0 &gt;= volume &gt;= 1000)
            </summary>
        </member>
        <member name="M:Boare.Lib.Media.MediaPlayer.SetVolume(System.Int32)">
            <summary>
            Sets the volume (0 &gt;= volume &gt;= 1000)
            </summary>
            <param name="value"></param>
        </member>
        <member name="M:Boare.Lib.Media.MediaPlayer.GetVolume">
            <summary>
            Gets the volume (0 &lt;= volume &lt;= 1000)
            </summary>
            <returns></returns>
        </member>
        <member name="P:Boare.Lib.Media.MediaPlayer.IsMuted">
            <summary>
            Gets or Sets whether sound is muted or not
            </summary>
        </member>
        <member name="P:Boare.Lib.Media.MediaPlayer.SoundLocation">
            <summary>
            Gets the pass of the sound file
            </summary>
        </member>
        <member name="M:Boare.Lib.Media.MediaPlayer.mciSendString(System.String,System.Text.StringBuilder,System.Int32,System.Int32)">
            <summary>
            external declaration of mciSendString
            </summary>
            <param name="s1">Command String</param>
            <param name="s2">Return String</param>
            <param name="i1">Return String Size</param>
            <param name="i2">Callback Hwnd</param>
            <returns>true when successed, false if not</returns>
        </member>
        <member name="M:Boare.Lib.Media.MediaPlayer.w_mciSendString(System.String,System.String@)">
            <summary>
            mciSendString wrapper with exception handling
            </summary>
            <param name="command">command sending to MCI</param>
            <param name="result">returned string of mciSendString</param>
            <returns>command successedd or not</returns>
        </member>
        <member name="M:Boare.Lib.Media.MediaPlayer.UnLoad">
            <summary>
            Closes sound file temporary
            </summary>
            <returns></returns>
        </member>
        <member name="M:Boare.Lib.Media.MediaPlayer.ReLoad">
            <summary>
            Opens sound file which was closed with "UnLoad" method
            </summary>
            <returns></returns>
        </member>
        <member name="M:Boare.Lib.Media.MediaPlayer.Load(System.String)">
            <summary>
            Opens sound file
            </summary>
            <param name="filename">Path of sound file to open</param>
            <returns>successed opening the file or not</returns>
        </member>
        <member name="M:Boare.Lib.Media.MediaPlayer.PlayFrom(System.Double)">
            <summary>
            Plays sound from specified second
            </summary>
            <param name="time">Sound position start to play</param>
            <returns>true if play command successed</returns>
        </member>
        <member name="M:Boare.Lib.Media.MediaPlayer.Close">
            <summary>
            Closes sound file
            </summary>
            <returns>true if successed closing sound file</returns>
        </member>
        <member name="M:Boare.Lib.Media.MediaPlayer.Play">
            <summary>
            Plays sound from time 0 second
            </summary>
            <returns>true if successed to play</returns>
        </member>
        <member name="M:Boare.Lib.Media.MediaPlayer.Seek(System.Double)">
            <summary>
            Seeks to specified position
            </summary>
            <param name="pos_second">position to seek in second</param>
            <returns>true if successed to seek</returns>
        </member>
        <member name="M:Boare.Lib.Media.MediaPlayer.Pause">
            <summary>
            Pauses sound
            </summary>
            <returns>true if successed to pause</returns>
        </member>
        <member name="M:Boare.Lib.Media.MediaPlayer.GetPosition">
            <summary>
            Gets the current playing position in millisecond
            </summary>
            <returns>playing position in millisecond</returns>
        </member>
        <member name="M:Boare.Lib.Media.MediaPlayer.GetLength">
            <summary>
            Gets the sound length in millisecond
            </summary>
            <returns>Sound length in millisecond</returns>
        </member>
        <member name="M:Boare.Lib.Media.MediaPlayer.Stop">
            <summary>
            Stops sound
            </summary>
            <returns>true if successed to stop</returns>
        </member>
        <member name="M:Boare.Lib.Media.RawAvi2Writer.Open(System.String,System.UInt32,System.UInt32,System.Int32,System.Int32,System.IntPtr)">
            <summary>
            指定したAVI_CONTAINER構造体にAVIファイルの情報を格納すると共に，
            ファイルにヘッダー情報を書き込みます．
            </summary>
            <param name="file">書き込み対象のファイル</param>
            <param name="frameRate">AVIファイルのフレームレート</param>
        </member>
        <member name="M:Boare.Lib.Media.RawAvi2Writer.UpdateIndex">
            <summary>
            全てのインデックスを更新し、ファイルが（動画ファイルとして）使用できる状態にします
            この関数を読んだあとでも，さらにaviAddFrame関数を使うことでフレームを追加することが出来ます．
            </summary>
        </member>
        <member name="M:Boare.Lib.Media.RawAvi2Writer.Close">
            <summary>
            aviファイルを閉じます
            </summary>
        </member>
        <member name="M:Boare.Lib.Media.RawAvi2Writer.UpdateIndexOfIndex">
            <summary>
            最初の[AVI :AVI[LIST:hdrl[LIST:strl]]]に書き込まれているsuper indexチャンク[indx]を更新します
            </summary>
        </member>
        <member name="M:Boare.Lib.Media.RawAvi2Writer.AddFrame(System.Drawing.Bitmap)">
            <summary>
            aviファイルにフレームを1つ追加します．
            </summary>
            <param name="bmp"></param>
        </member>
        <member name="M:Boare.Lib.Media.Util.aviWriteStreamHeader(Boare.Lib.Media.AVIStreamHeader,Boare.Lib.Media.MainAVIHeader,System.IO.BinaryWriter)">
            <summary>
            ファイルにAVIStreamHeader構造体の値を書き込みます
            </summary>
        </member>
        <member name="M:Boare.Lib.Media.Util.aviWriteMainHeader(Boare.Lib.Media.MainAVIHeader,System.IO.BinaryWriter)">
            <summary>
            ファイルにMainAviHeader構造体の値を書き込みます
            </summary>
        </member>
        <member name="M:Boare.Lib.Media.Util.WriteBYTE(System.Byte,System.IO.BinaryWriter)">
            <summary>
            BYTE値を1byte分ファイルに書き込みます．
            </summary>
            <param name="number"></param>
            <param name="fp"></param>
        </member>
        <member name="M:Boare.Lib.Media.Util.WriteWORD(System.UInt16,System.IO.BinaryWriter)">
            <summary>
            integer(2)のDWORD値を2byte分ファイルに書き込みます．
            </summary>
            <param name="number"></param>
            <param name="fp"></param>
        </member>
        <member name="M:Boare.Lib.Media.Util.WriteDWORD(System.UInt32,System.IO.BinaryWriter)">
            <summary>
            integer(4)のDWORD値を4byte分ファイルに書き込みます
            </summary>
            <param name="number"></param>
            <param name="fp"></param>
        </member>
        <member name="M:Boare.Lib.Media.Util.WriteQWORD(System.UInt64,System.IO.BinaryWriter)">
            <summary>
            integer(8)のQWORD値を8byte分ファイルに書き込みます
            </summary>
            <param name="number"></param>
            <param name="fp"></param>
        </member>
        <member name="M:Boare.Lib.Media.AviWriterVfw.RequireAudioCompressOption">
            <summary>
            オーディオ圧縮の設定ダイアログを表示し、オーディオ圧縮の設定を取得します
            </summary>
            <returns></returns>
        </member>
        <member name="T:Boare.Lib.Media.FormantoDetectionArguments">
            <summary>
            Parameters of first formanto detection algorithm
            </summary>
        </member>
        <member name="P:Boare.Lib.Media.FormantoDetectionArguments.PeakDetectionThreshold">
            <summary>
            ピークを検出する閾値。フーリエ変換後の周波数の強度分布関数の値がこの値よりも大きい箇所で
            密度関数の導関数の符号が正から負へ変わる位置をピークとみなす。周波数密度関数は、最大値で
            規格化したのを使う。従って、0～1の値を指定する。
            </summary>
        </member>
        <member name="P:Boare.Lib.Media.FormantoDetectionArguments.MovingAverageWidth">
            <summary>
            フーリエ変換した生の周波数の強度分布を平滑化する幅を2で割った値。Hzで指定。
            </summary>
        </member>
        <member name="M:Boare.Lib.Media.Wave.GetF0(System.UInt32,System.Double[],Boare.Lib.Media.FormantoDetectionArguments)">
            <summary>
            第timeサンプルにおけるフォルマントを取得する
            </summary>
            <param name="time"></param>
            <param name="window_function"></param>
            <returns></returns>
        </member>
        <member name="M:Boare.Lib.Media.Wave.GetFormanto(System.UInt32,System.Double[])">
            <summary>
            第timeサンプルにおけるフォルマントを取得する
            </summary>
            <param name="time"></param>
            <param name="window_function"></param>
            <returns></returns>
        </member>
        <member name="M:Boare.Lib.Media.Wave.GetVolume(System.Int32,System.Int32,bocoree.math.WindowFunctionType)">
            <summary>
            指定したサンプル位置における音量を計算します
            </summary>
            <param name="start_sample"></param>
            <param name="window_size"></param>
            <param name="window_function_type"></param>
            <returns></returns>
        </member>
        <member name="M:Boare.Lib.Media.Wave.GetVolume(System.Int32,bocoree.math.WindowFunctionType)">
            <summary>
            音量の時間変化を取得します
            </summary>
            <param name="window_size">窓の幅（サンプル数）</param>
            <param name="window_function_type">使用する窓関数</param>
            <param name="resulution">解像度（サンプル数）</param>
            <returns></returns>
        </member>
        <member name="M:Boare.Lib.Media.Wave.getNormalizedWave(System.Int32,System.Int64)">
            <summary>
            -1から1までに規格化された波形を取得します
            </summary>
            <returns></returns>
        </member>
        <member name="M:Boare.Lib.Media.Wave.convertTo8Bit">
            <summary>
            サンプルあたりのビット数を8に変更する
            </summary>
        </member>
        <member name="M:Boare.Lib.Media.Wave.write(System.String)">
            <summary>
            ファイルに保存
            </summary>
            <param name="file"></param>
        </member>
        <member name="M:Boare.Lib.Media.Wave.monoralize">
            <summary>
            ステレオをモノラル化
            </summary>
        </member>
        <member name="M:Boare.Lib.Media.Wave.trimSilence">
            <summary>
            前後の無音部分を削除します
            </summary>
        </member>
        <member name="M:Boare.Lib.Media.WavePlay.wave_callback(System.IntPtr,System.UInt32,System.UInt32,System.UInt32,System.UInt32)">
            コールバック関数
        </member>
        <member name="M:Boare.Lib.Media.WavePlay.#ctor(System.Int32,System.Int32)">
            初期化関数
        </member>
        <member name="M:Boare.Lib.Media.WavePlay.append(System.Single**,System.UInt32,System.Double,System.Double)">
            波形データをバッファに追加する。バッファが再生中などの理由で即座に書き込めない場合、バッファが書き込み可能となるまで待機させられる
        </member>
        <member name="M:Boare.Lib.Media.WavePlay.abort">
            再生中断を要求する
        </member>
        <member name="M:Boare.Lib.Media.WavePlay.get_play_time">
            現在の再生位置を取得する。再生中でない場合負の値となる。
        </member>
        <member name="M:Boare.Lib.Media.WavePlay.reset">
            リセットする。abort関数でも呼び出される。
        </member>
        <member name="M:Boare.Lib.Media.WavePlay.on_your_mark(System.String[],System.Int64)">
            再生のための準備を行う。この関数を呼び出した後は、バッファが再生開始されるまでget_play_timeの戻り値は0となる（負値にならない）。
            戻り値は、filesに指定されたファイルの内、最も再生時間の長いwaveファイルの、合計サンプル数
        </member>
        <member name="M:Boare.Lib.Media.WavePlay.set_first_buffer_written_callback(Boare.Lib.Media.FirstBufferWrittenCallback)">
            コールバック関数を設定する
        </member>
        <member name="M:Boare.Lib.Media.WavePlay.is_alive">
            現在再生中かどうかを取得する
        </member>
        <member name="M:Boare.Lib.Media.WavePlay.change_block_size(System.Int32)">
            ブロックサイズを変更します
        </member>
        <member name="F:Boare.Lib.Media.WaveReader.m_header_offset">
            <summary>
             ファイル先頭から，dataチャンクまでのオフセット
            </summary>
        </member>
        <member name="M:Boare.Lib.Media.WaveWriter.writeHeader">
            <summary>
            Writes header of WAVE file
            </summary>
        </member>
    </members>
</doc>