目次 - SDL_mixer 3.0 - MIX_CreateAudioDecoder_IO

MIX_CreateAudioDecoder_IO

SDL_IOStreamからMIX_AudioDecoderを生成する

ヘッダ

SDL3_mixer/SDL_mixer.h

構文

MIX_AudioDecoder * MIX_CreateAudioDecoder_IO(SDL_IOStream *io, bool closeio, SDL_PropertiesID props);

引数

SDL_IOStream *ioデータを読み込むI/Oストリーム
boolcloseio真のとき戻る前にSDL_IOStreamを自動的に閉じる
SDL_PropertiesIDpropsデコーダのプロパティ. 0も可

戻り値

(MIX_AudioDecoder *) デコードの準備ができたオーディオデコーダを戻す.

詳細

SDL_mixerの通常のインターフェースは必要に応じてオーディオをデコードするため, この関数はほとんどのアプリケーションにとって必要ない. しかし, 再生せずにオーディオファイルからメモリバッファにデコードしたい場合は, このインターフェースで行える.

この関数はプロパティを設定できる. これは例えばMIDIファイルのためにサウンドフォントの場所のようなファイル固有の設定を行うためにある. MIX_LoadAudioWithProperties()で使用できるプロパティのほとんどはここでも適用できる. ほとんどの場合, 追加のプロパティがない0を渡すことになる.

closeioが真の場合, デコーダを使い終えたときioが閉じる. closeioが真でこの関数が失敗した場合, この関数から戻る前に閉じる.

オーディオデコーダを使い終えたならば, MIX_DestroyAudioDecoder()で破棄できる.

この関数はMIX_Init()の呼び出しに成功してSDL_mixerが初期化されている必要があるが, MIX_Mixerが生成されている必要はない.

スレッドセーフ

この関数はどのスレッドからも安全に呼べる.

バージョン

SDL_image 3.0.0以降

関連項目

SDL Wikiへのリンク

SDL3_mixer/MIX_CreateAudioDecoder_IO