Telematics SDK - API Reference  v1.55.0
Data Structures | Typedefs | Enumerations | Variables
telux::audio Namespace Reference

Data Structures

struct  AmrwbpParams
 
class  AudioFactory
 
struct  ChannelVolume
 
struct  DtmfTone
 
struct  FormatInfo
 
struct  FormatParams
 
class  IAudioBuffer
 
class  IAudioCaptureStream
 
class  IAudioDevice
 
class  IAudioListener
 
class  IAudioLoopbackStream
 
class  IAudioManager
 
class  IAudioPlayStream
 
class  IAudioStream
 
class  IAudioToneGeneratorStream
 
class  IAudioVoiceStream
 
class  IPlayListener
 
class  IStreamBuffer
 
class  ITranscodeListener
 
class  ITranscoder
 
class  IVoiceListener
 
struct  StreamConfig
 
struct  StreamMute
 
struct  StreamVolume
 

Typedefs

using ChannelTypeMask = int
 
using GetDevicesResponseCb = std::function< void(std::vector< std::shared_ptr< IAudioDevice >> devices, telux::common::ErrorCode error)>
 
using GetStreamTypesResponseCb = std::function< void(std::vector< StreamType > streamTypes, telux::common::ErrorCode error)>
 
using CreateStreamResponseCb = std::function< void(std::shared_ptr< IAudioStream > &stream, telux::common::ErrorCode error)>
 
using CreateTranscoderResponseCb = std::function< void(std::shared_ptr< ITranscoder > &transcoder, telux::common::ErrorCode error)>
 
using DeleteStreamResponseCb = std::function< void(telux::common::ErrorCode error)>
 
using GetCalInitStatusResponseCb = std::function< void(CalibrationInitStatus calInitStatus, telux::common::ErrorCode error)>
 
using GetStreamDeviceResponseCb = std::function< void(std::vector< DeviceType > devices, telux::common::ErrorCode error)>
 
using GetStreamVolumeResponseCb = std::function< void(StreamVolume volume, telux::common::ErrorCode error)>
 
using GetStreamMuteResponseCb = std::function< void(StreamMute mute, telux::common::ErrorCode error)>
 
using WriteResponseCb = std::function< void(std::shared_ptr< IStreamBuffer > buffer, uint32_t bytesWritten, telux::common::ErrorCode error)>
 
using ReadResponseCb = std::function< void(std::shared_ptr< IStreamBuffer > buffer, telux::common::ErrorCode error)>
 
using TranscoderReadResponseCb = std::function< void(std::shared_ptr< IAudioBuffer > buffer, uint32_t isLastBuffer, telux::common::ErrorCode error)>
 
using TranscoderWriteResponseCb = std::function< void(std::shared_ptr< IAudioBuffer > buffer, uint32_t bytesWritten, telux::common::ErrorCode error)>
 

Enumerations

enum  DeviceType {
  DEVICE_TYPE_NONE = -1, DEVICE_TYPE_SPEAKER = 1, DEVICE_TYPE_SPEAKER_2 = 2, DEVICE_TYPE_SPEAKER_3 = 3,
  DEVICE_TYPE_BT_SCO_SPEAKER = 4, DEVICE_TYPE_PROXY_SPEAKER = 5, DEVICE_TYPE_MIC = 257, DEVICE_TYPE_MIC_2 = 258,
  DEVICE_TYPE_MIC_3 = 259, DEVICE_TYPE_BT_SCO_MIC = 260, DEVICE_TYPE_PROXY_MIC = 261
}
 
enum  DeviceDirection { DeviceDirection::NONE = -1, DeviceDirection::RX = 1, DeviceDirection::TX = 2 }
 
enum  StreamType {
  StreamType::NONE = -1, StreamType::VOICE_CALL = 1, StreamType::PLAY = 2, StreamType::CAPTURE = 3,
  StreamType::LOOPBACK = 4, StreamType::TONE_GENERATOR = 5
}
 
enum  StreamDirection { StreamDirection::NONE = -1, StreamDirection::RX = 1, StreamDirection::TX = 2 }
 
enum  Direction { Direction::RX = 1, Direction::TX = 2 }
 
enum  ChannelType { LEFT = (1 << 0), RIGHT = (1 << 1) }
 
enum  AudioFormat {
  AudioFormat::UNKNOWN = -1, AudioFormat::PCM_16BIT_SIGNED = 1, AudioFormat::AMRNB = 20, AudioFormat::AMRWB,
  AudioFormat::AMRWB_PLUS
}
 
enum  DtmfLowFreq { DtmfLowFreq::FREQ_697 = 697, DtmfLowFreq::FREQ_770 = 770, DtmfLowFreq::FREQ_852 = 852, DtmfLowFreq::FREQ_941 = 941 }
 
enum  DtmfHighFreq { DtmfHighFreq::FREQ_1209 = 1209, DtmfHighFreq::FREQ_1336 = 1336, DtmfHighFreq::FREQ_1477 = 1477, DtmfHighFreq::FREQ_1633 = 1633 }
 
enum  StopType { StopType::FORCE_STOP, StopType::STOP_AFTER_PLAY }
 
enum  AmrwbpFrameFormat { AmrwbpFrameFormat::UNKNOWN = -1, AmrwbpFrameFormat::TRANSPORT_INTERFACE_FORMAT, AmrwbpFrameFormat::FILE_STORAGE_FORMAT }
 
enum  EcnrMode { EcnrMode::DISABLE = 0, EcnrMode::ENABLE = 1 }
 
enum  CalibrationInitStatus { CalibrationInitStatus::UNKNOWN = -1, CalibrationInitStatus::INIT_SUCCESS = 0, CalibrationInitStatus::INIT_FAILED = 1 }
 

Variables

const uint16_t INFINITE_DTMF_DURATION = 0xFFFF
 
const uint16_t INFINITE_TONE_DURATION = 0xFFFF
 

Variable Documentation

const uint16_t telux::audio::INFINITE_DTMF_DURATION = 0xFFFF

Specifies that the DTMF tone should be played indefinitely

const uint16_t telux::audio::INFINITE_TONE_DURATION = 0xFFFF

Specifies that the audio tone should be played indefinitely