carb::audio::fStreamFlagDisableOnFailure

constexpr OutputStreamFlags carb::audio::fStreamFlagDisableOnFailure = 0x00000002

flag to indicate that the stream should disable itself if an error is encountered writing a buffer of audio to the output.

And example of a failure could be that the output file fails to be opened (ie: permissions issue, path doesn’t exist, etc), or there was an encoding error with the chosen output format (extremely rare but possible). If such a failure occurs, the output stream will simply ignore new incoming data until the stream is closed. If this flag is not used, the default behavior is to continue trying to write to the stream. In this case, it is possible that the stream could recover and continue writing output again (ie: the folder containing the file suddenly was created), however doing so could lead to an audible artifact being introduced to the output stream.