25.1 Overview

Plugins that have the capability flag HWPLUG_CAPS_SAVESAMPLE set can register one or more additional output sample formats. The user will then be able to save samples in the output formats supported by the plugin. Plugins have to register new output sample formats by passing the name of a constant that should be used to access the new format. For example, a plugin might choose to register a new output sample format under the constant #SMPFMT_CUSTOMFORMAT. Whenever the user calls SaveSample() now and passes #SMPFMT_CUSTOMFORMAT as the sample format, Hollywood will ask the plugin to save the sample.

Note that sample saver plugins need not implement all functions offered by the plugin API. Some functions are optional and need only be implemented in specific cases. Here's a list of optional functions:

BeginSampleStream()
Only used if you set the HWEXT_SAVESAMPLE_STREAM extension flag. See Extension plugins to learn how to use plugin extension bits.

FinishSampleStream()
Only used if you set the HWEXT_SAVESAMPLE_STREAM extension flag. See Extension plugins to learn how to use plugin extension bits.

WriteSampleStream()
Only used if you set the HWEXT_SAVESAMPLE_STREAM extension flag. See Extension plugins to learn how to use plugin extension bits.


Show TOC