alexaClientSDK::audioEncoder::AudioEncoderParams Struct Reference

Audio encoder parameters. More...

#include <AudioEncoderParams.h>

Public Attributes
std::chrono::milliseconds	readTimeoutMs
	Reading timeout from input audio stream. More...
std::chrono::milliseconds	writeTimeoutMs
	Timeout between write retrying. More...
std::chrono::milliseconds	stopTimeoutMs
	Timeout for graceful stop operation. More...
std::size_t	maxOutputStreamReaders
	The maximum number of readers of the output stream. More...
std::size_t	maxOutputStreamBufferedPackets
	The maximum number of packets to be buffered to the output stream. More...

Detailed Description

Audio encoder parameters.

These parameters affect performance and memory consumption by audio encoder.

See also

createAudioEncoder()

Member Data Documentation

maxOutputStreamBufferedPackets

std::size_t alexaClientSDK::audioEncoder::AudioEncoderParams::maxOutputStreamBufferedPackets

The maximum number of packets to be buffered to the output stream.

Audio encoder constructs the output stream and it needs to know how much data to buffer.

maxOutputStreamReaders

std::size_t alexaClientSDK::audioEncoder::AudioEncoderParams::maxOutputStreamReaders

The maximum number of readers of the output stream.

Audio encoder constructs the output stream and it needs to know how many readers will consume the data.

readTimeoutMs

std::chrono::milliseconds alexaClientSDK::audioEncoder::AudioEncoderParams::readTimeoutMs

Reading timeout from input audio stream.

Read timeout control how frequently audio encoder checks for stop signal while reading frame.

stopTimeoutMs

std::chrono::milliseconds alexaClientSDK::audioEncoder::AudioEncoderParams::stopTimeoutMs

Timeout for graceful stop operation.

This timeout controls for how long the audio encoder tries to stop operation gracefully. Audio encoder will abort operation after timeout elapses.

writeTimeoutMs

std::chrono::milliseconds alexaClientSDK::audioEncoder::AudioEncoderParams::writeTimeoutMs

Timeout between write retrying.

Write timeout control how frequently audio encoder checks for stop signal while writing encoded frame.

---

The documentation for this struct was generated from the following file:

• /workplace/avs-device-sdk/core/AudioEncoder/AudioEncoder/include/acsdk/AudioEncoder/AudioEncoderParams.h