AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Classes | Functions
alexaClientSDK::audioEncoder Namespace Reference

Namespaces

 test
 

Classes

struct  AudioEncoderParams
 Audio encoder parameters. More...
 

Functions

std::unique_ptr< audioEncoderInterfaces::AudioEncoderInterfacecreateAudioEncoder (const std::shared_ptr< audioEncoderInterfaces::BlockAudioEncoderInterface > &blockAudioEncoder)
 Create audio encoder with default parameters. More...
 
std::unique_ptr< audioEncoderInterfaces::AudioEncoderInterfacecreateAudioEncoderWithParams (const std::shared_ptr< audioEncoderInterfaces::BlockAudioEncoderInterface > &blockAudioEncoder, const AudioEncoderParams &params)
 Create audio encoder with given parameters. More...
 

Function Documentation

◆ createAudioEncoder()

std::unique_ptr<audioEncoderInterfaces::AudioEncoderInterface> alexaClientSDK::audioEncoder::createAudioEncoder ( const std::shared_ptr< audioEncoderInterfaces::BlockAudioEncoderInterface > &  blockAudioEncoder)

Create audio encoder with default parameters.

Method creates a new instance of audio encoder with default parameters.

By default, audio encoder uses 10 milliseconds for read timeout, 100 milliseconds for write timeout, and 1000 milliseconds for stop timeout. The output stream will buffer up to 20 packets in the output stream and will allow up to 10 readers.

Parameters
[in]blockAudioEncoderThe backend encoder implementation. This parameter must not be nullptr.
Returns
New instance of audio encoder or nullptr on error.
See also
createAudioEncoderWithParams()
AudioEncoderParams

◆ createAudioEncoderWithParams()

std::unique_ptr<audioEncoderInterfaces::AudioEncoderInterface> alexaClientSDK::audioEncoder::createAudioEncoderWithParams ( const std::shared_ptr< audioEncoderInterfaces::BlockAudioEncoderInterface > &  blockAudioEncoder,
const AudioEncoderParams params 
)

Create audio encoder with given parameters.

Parameters
[in]blockAudioEncoderThe backend encoder implementation. This parameter must not be nullptr.
[in]paramsEncoder parameters.
Returns
New instance of audio encoder or nullptr on error.
See also
createAudioEncoder()

AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0