Contents Menu Expand Light mode Dark mode Auto light/dark mode
XCORE-VOICE SOLUTION v2.2.0
Logo
XCORE-VOICE SOLUTION v2.2.0
PDFs:
  • XCORE-VOICE Quick Start Guide
    • Product Description
    • Key Features
    • Obtaining the Hardware
    • Obtaining the Software
    • Example Designs
      • Far-field Voice Local Command
      • Low Power Far-field Voice Local Command
      • Far-field Voice Assistant
    • Licenses
  • XCORE-VOICE Programming Guide
    • Product Description
    • Key Features
    • Obtaining the Hardware
    • Obtaining the Software
    • Prerequisites
    • Example Designs
      • Far-field Voice Local Command
        • Overview
        • Supported Hardware
        • Configuring the Firmware
        • Deploying the Firmware with Linux or macOS
        • Deploying the Firmware with Native Windows
        • Modifying the Software
          • Host Integration
          • Audio Pipeline
          • Software Description
            • Overview
            • bsp_config
            • ext
            • filesystem_support
            • src
            • src/intent_engine
            • src/intent_handler
          • Software Modifications
          • Speech Recognition - Sensory
          • Speech Recognition - Cyberon
      • Low Power Far-field Voice Local Command
        • Overview
        • Supported Hardware
        • Configuring the Firmware
        • Deploying the Firmware with Linux or macOS
        • Deploying the Firmware with Native Windows
        • Modifying the Software
          • Host Integration
          • Audio Pipeline
          • Software Description
            • Overview
            • bsp_config
            • filesystem_support
            • model
            • src
            • src/gpio_ctrl
            • src/intent_engine
            • src/intent_handler
            • src/power
            • src/wakeword
          • Software Modifications
          • Speech Recognition
      • Far-field Voice Assistant
        • Overview
        • Supported Hardware
        • Deploying the Firmware with Linux or macOS
        • Deploying the Firmware with Native Windows
        • Modifying the Software
          • Host Integration
          • Design Architecture
          • Audio Pipeline
          • Software Description
            • Overview
            • bsp_config
            • filesystem_support
            • Audio Pipelines
            • src
          • Software Modifications
      • PDM Microphone Aggregator Example
      • ASRC Application
        • Overview
        • Software Architecture
        • Resource Usage
    • Speech Recognition Ports
    • Memory and CPU Requirements
    • How-Tos
    • Frequently Asked Questions
    • Licenses
  • Audio Processing
    • Acoustic Echo Canceller Library
      • Repository Structure
      • Requirements
      • API Structure
      • Getting and Building
      • AEC Overview
      • API Reference
        • AEC Data Structure and Enum Definitions
        • AEC #define constants
        • AEC API
          • AEC High Level API Functions
          • AEC Low Level API Functions (STILL WIP)
        • lib_aec Header Files
    • Noise Suppression Library
      • Repository Structure
      • Requirements
      • Getting and Building
      • NS Overview
      • API Reference
        • NS API Functions
        • NS API Structure Definitions
        • NS Header Files
    • Automatic Gain Control Library
      • Repository Structure
      • Requirements
      • Getting and Building
      • AGC Overview
      • API Reference
        • AGC API Functions
        • AGC Pre-Defined Profiles
        • AGC API Structure Definitions
        • AGC Header Files
    • Automatic Delay Estimation and Correction Library
      • Repository Structure
      • Getting and Building
      • ADEC Overview
      • API Reference
        • ADEC API Functions
        • ADEC #define constants
        • ADEC Data Structure and Enum definitions
        • ADEC Header Files
    • Interference Canceller Library
      • Repository Structure
      • Requirements
      • API Structure
      • Getting and Building
      • IC Overview
      • API Reference
        • lib_ic API Functions
        • lib_ic API State Structure
        • lib_ic API Definitions
        • lib_ic Header Files
    • Voice To Noise Ratio Estimator Library
      • Repository Structure
      • Requirements
      • API Structure
      • Getting and Building
      • VNR Inference Model
        • Integrating a TensorFlow Lite model into the VNR module
      • VNR Overview
      • API Reference
        • lib_vnr feature extraction API Functions
        • lib_vnr inference engine API Functions
        • lib_vnr #defines common to feature extraction and inference
        • lib_vnr feature extraction #defines and data structure definitions
        • lib_vnr Header Files
  • RTOS Programming Guide
    • XCORE Platform
    • Tutorials
      • FreeRTOS Application Programming
      • RTOS Application Design
      • Board Support Configurations
      • RTOS Application DFU
    • API Reference
      • RTOS Drivers
        • GPIO RTOS Driver
        • I2C RTOS Driver
          • I2C Master RTOS Driver
          • I2C Slave RTOS Driver
        • I2S RTOS Driver
          • I2S Master Initialization API
          • I2S Slave Initialization API
        • Microphone Array RTOS Driver
        • QSPI Flash RTOS Driver
        • SPI RTOS Driver
          • SPI Master RTOS Driver
          • SPI Slave RTOS Driver
        • UART RTOS Driver
          • UART Tx RTOS Driver
          • UART Rx RTOS Driver
        • USB RTOS Driver
        • Trace Driver
        • Clock Control RTOS Driver
        • Device Firmware Update RTOS Driver
        • Intertile RTOS Driver
        • L2 Cache RTOS Driver
        • Software Memory RTOS Driver
      • RTOS Services
        • Device Control
          • Device Control Shared API
          • Device Control XCORE API
          • Device Control Host API
          • Command Transport Protocol
        • Concurrency Support
          • Concurrency Support API
        • Generic Pipeline
          • Generic Pipeline Example
          • Generic Pipeline API
    • FAQs
    • Common Issues
  • Build System User Guide
    • Build System
    • Example CMakeLists.txt
    • Targets
    • Macros
  • Peripheral IO Programming Guide
    • Overview
    • API Reference
      • UART Library
        • UART Tx
        • UART Rx
      • I2C Library
        • I2C Master
        • I2C Slave
        • I2C Registers
      • I2S Library
        • I2S Common API
        • I2S Master
        • I2S Slave
        • TDM Slave
      • SPI Library
        • SPI Master
        • SPI Slave
  • Mic Array Library
    • Introduction
    • Overview
    • Getting Started
    • Decimator Stages
    • Sample Filters
    • Software Structure
    • Mic Array Resource Usage
    • Vanilla API
    • API Reference
      • C++ API Reference
      • C API Reference
        • filters_default.h
        • pdm_resources.h
        • setup.h
        • frame_transfer.h
        • dc_elimination.h
        • util.h
        • mic_array_vanilla.h
  • lib_xcore_math Programming Guide
    • Introduction
    • Getting Started
    • Block Floating-Point Background
    • API Reference
      • XMath Types
      • Block Floating-Point API
        • BFP API Quick Reference
        • 16-Bit Block Floating-Point API
        • 32-Bit Block Floating-Point API
        • Complex 16-Bit Block Floating-Point API
        • Complex 32-Bit Block Floating-Point API
      • Discrete Cosine Transform API
      • Fast Fourier Transform API
      • Filtering API
      • Scalar API
        • Scalar API Quick Reference
        • 16-bit Scalar API
        • 32-bit Scalar API
        • Scalar IEEE 754 Float API
        • 32-bit Scalar Float API
        • 16-bit Complex Scalar Floating-Point API
        • 32-bit Complex Scalar Floating-Point API
        • Miscellaneous Scalar API
      • Vector API
        • Vector API Quick Reference
        • 8-Bit Vector API
        • 16-Bit Vector API
        • 32-Bit Vector API
        • 32-Bit IEEE 754 Float API
        • Complex 16-Bit Vector API
        • Complex 32-Bit Vector API
        • Mixed-Precision Vector API
        • 16-Bit Vector Prepare Functions
        • 32-Bit Vector Prepare Functions
        • 16-Bit Complex Vector Prepare Functions
        • 32-Bit Complex Vector Prepare Functions
        • 32-Bit Vector Chunk (8-Element) API
      • Q-Format Macros
      • XMath Util Functions and Macros
      • Library Configuration
      • Library Notes
    • Example Applications
Back to top

API Reference#

  • UART Library
  • I2C Library
  • I2S Library
  • SPI Library
Next
UART Library
Previous
Overview
Copyright © 2023, XMOS Ltd
Made with Furo
Last updated on Dec 06, 2023