#include <output_plugin.h>
◆ author
const char* _output_plugin::author |
◆ close
◆ get_latency
Returns the latency of the output device in bytes. This function is optional.
◆ get_queue_count
Returns the number of bytes pending in the hardware buffer of output device. This function is optional.
◆ init
Initialize output plugin. Called before the plugin is opened for use
◆ name
const char* _output_plugin::name |
◆ open
- Parameters
-
path | The path or device designation that should be used |
Opens the output plugin. A value of 1 should be returned on success, 0 on failure.
◆ set_buffer
- Parameters
-
frag_size | Fragment size to use (in bytes) |
frag_count | Fragment count to use (in bytes) |
channels | Number of channels to use |
Set up the output device with the given parameters. Some output devices do not accept such configurations in which case they should just be ignored, but still expect frag_size data chunks in the write function. A value of 1 should be returned on success, 0 on failure.
◆ set_sample_rate
- Parameters
-
Set the sample rate of the output device. A value of 1 should be returned on success, 0 on failure.
◆ start_callbacks
- Parameters
-
data | pointer to bufs structure in AlsaNode |
This function is used for callback based plugins like JACK
◆ version
Version of output plugin. Must be OUTPUT_PLUGIN_VERSION
◆ write
- Parameters
-
data | Buffer that contains the data Number of bytes that should be read from the buffer |
Write out data to the output device. This is a byte count and will typically be the same size as a fragment. A value of 1 should be returned on success, 0 on failure.
The documentation for this struct was generated from the following file: