# ref link: https://alinex.gitlab.io/env/mkdocs/ #===================================================================================# # Site Information #===================================================================================# site_name: Phaten Audio | XMOS AI Professional Audio Solutions Provider | OFFICIAL VALUE-ADDED RESELLER OF XMOS LIMITED site_description: Shenzhen Phaten Technology Co., Ltd. - OFFICIAL VALUE-ADDED RESELLER OF XMOS LIMITED site_author: Phaten site_dir: '../../site/en' copyright: Copyright © 2024 Shenzhen Phaten Technology Co., Ltd. site_login: true login_name: Login/Register login_url: /en/login #===================================================================================# # Mkdocs Theme (Material Mkdocs) + Extras #===================================================================================# theme: name: material custom_dir: material/templates language: en logo: assets/images/logos/phaten-logo-cn.png favicon: assets/images/logos/phaten-logo-ico.png font: text: Roboto code: Roboto Mono features: - content.code.annotate - content.code.copy - content.code.select - content.footnote.tooltips - content.tooltips - navigation.footer - navigation.indexes - navigation.instant - navigation.instant.prefetch - navigation.instant.progress - navigation.instant.preview - navigation.tabs - navigation.top - navigation.path - search.highlight - search.share - search.suggest - toc.follow palette: - media: "(prefers-color-scheme: light)" scheme: default primary: indigo accent: indigo toggle: icon: material/toggle-switch-outline name: Switch to dark mode - media: "(prefers-color-scheme: dark)" scheme: slate primary: black accent: indigo toggle: icon: material/toggle-switch-off-outline name: Switch to light mode plugins: - blog - search: separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])' - minify: minify_html: true - glightbox: touchNavigation: true loop: false effect: zoom slide_effect: slide width: 100% height: auto zoomable: true draggable: true skip_classes: - custom-skip-class-name auto_caption: true caption_position: bottom background: white shadow: true extra_css: - assets/stylesheets/extra.css extra_javascript: - assets/javascripts/extra.js extra: status: new: Recently added deprecated: Deprecated analytics: provider: google property: G-XXXXXXXXXX alternate: # Switch to English - name: English #link: https://leverage.binbash.co link: /en/ lang: en # Switch to Chinese - name: 简体中文 #link: https://leverage.binbash.co/zh/ link: /zh/ lang: zh #===================================================================================# # Mkdocs Markdown Extentions, Plugins & extras #===================================================================================# markdown_extensions: - abbr - admonition - attr_list - def_list - footnotes - md_in_html - toc: permalink: true - pymdownx.arithmatex: generic: true - pymdownx.betterem: smart_enable: all - pymdownx.caret - pymdownx.details - pymdownx.emoji: emoji_generator: !!python/name:material.extensions.emoji.to_svg emoji_index: !!python/name:material.extensions.emoji.twemoji - pymdownx.highlight: anchor_linenums: true line_spans: __spanpymdownx.tilde pygments_lang_class: true - pymdownx.inlinehilite - pymdownx.keys - pymdownx.magiclink: normalize_issue_symbols: true repo_url_shorthand: true user: squidfunk repo: mkdocs-material - pymdownx.mark - pymdownx.smartsymbols - pymdownx.snippets: base_path: - docs check_paths: true dedent_subsections: true - pymdownx.superfences: custom_fences: - name: mermaid class: mermaid format: !!python/name:pymdownx.superfences.fence_code_format - pymdownx.tabbed: alternate_style: true combine_header_slug: true slugify: !!python/object/apply:pymdownx.slugs.slugify kwds: case: lower - pymdownx.tasklist: custom_checkbox: true - pymdownx.tilde #===================================================================================# # Mkdocs Navigation Tree #===================================================================================# nav: - Home: index.md - Application Solutions: - solutions/index.md - Multi-Channel USB HiFi Decoder Solution: solutions/hifi_audio/multi_channel_usb_hifi_decoder_solution.md - Portable USB Low-Power HiFi Decoder Solution: solutions/hifi_audio/portable_usb_hifi_lowpower_decoder.md - USB AI Noise Reduction Streaming Microphone Solution: solutions/xu316_usb_ai/xu316_usb_ai_suoltion.md # - Virtual 7.1 Gaming Sound Card Solution: solutions/v71_gaming_sound_solution.md - Core Modules: - products/index.md - USB HiFi Decoders Core Modules: - products/hifi_audio/index.md - HF87621(Q)-VB1: products/hifi_audio/hf87621_vb1.md - HF87621(Q)-VC1: products/hifi_audio/hf87621_vc1.md - HF87611(Q)-VB1: products/hifi_audio/hf87611_vb1.md - HF87611(Q)-VC1: products/hifi_audio/hf87611_vc1.md - HF86611(Q)-VB1: products/hifi_audio/hf86611_vb1.md - HF86611(Q)-VC1: products/hifi_audio/hf86611_vc1.md - HF83311(Q)-VB1: products/hifi_audio/hf83311_vb1.md - HF83311(Q)-VC1: products/hifi_audio/hf83311_vc1.md - USB Low-Power HiFi Decoders Core Modules: - products/phifi_audio/index.md - PH83311L(Q)-VC1: products/phifi_audio/ph83311l_vc1.md - PH83211L(Q)-VC1: products/phifi_audio/ph83211l_vc1.md - PH73311L(Q)-VC1: products/phifi_audio/ph73311l_vc1.md - PH73211L(Q)-VC1: products/phifi_audio/ph73211l_vc1.md - USB Live Streaming Microphones Core Modules: - products/ai_mic/index.md - LS67211-VC1: products/ai_mic/ls67211_vc1.md - Virtual 7.1 Gaming Sound Cards Core Modules: - products/game/index.md - GM68311-VC1: products/game/gm68311_vc1.md - GM67211-VC1: products/game/gm67211_vc1.md # - Microphone Arrays: # - products/array_mic/index.md - AI DNR(Deep Noise Reduction) Core Modules: - products/ai_dnr/index.md - DNR65211-VC1: products/ai_dnr/dnr65211_vc1.md - DNR65221-VC1: products/ai_dnr/dnr65221_vc1.md - DNR65231-VC1: products/ai_dnr/dnr65231_vc1.md - USB OTG Integrated ASRC Core Modules: - products/usb_otg/index.md - OT82111-VC1: products/usb_otg/ot82111_vc1.md - OT83211-VC1: products/usb_otg/ot83211_vc1.md - SRC(Audio Sample Rate Conversion) Core Modules: - products/src/index.md - XMSRC4392-VC1: products/src/xmsrc4392_vc1.md - XMSRC4194-VC1: products/src/xmsrc4194_vc1.md - XMSRC4192-VC1: products/src/xmsrc4192_vc1.md - PDM to I2S/TDM Conversion Core Modules: - products/pdm_2_i2s/index.md - XMAU7118-VC1: products/pdm_2_i2s/xmau7118_vc1.md - Design & Development: - dev_doc/index.md - Core Modules Datasheets: - dev_doc/datasheet/index.md - Standard Core Modules: - A316-1926-V1: dev_doc/datasheet/modules/a316_1926_v1_datasheet.md - A316-Mini-V1: dev_doc/datasheet/modules/a316_mini_v1_datasheet.md - A316-Codec-V1: dev_doc/datasheet/modules/a316_codec_v1_datasheet.md - USB HiFi Decoders Core Modules: - HF87621(Q)-VB1: dev_doc/datasheet/std_product/hifi_audio/hf87621_vb1.md - HF87621(Q)-VC1: dev_doc/datasheet/std_product/hifi_audio/hf87621_vc1.md - HF87611(Q)-VB1: dev_doc/datasheet/std_product/hifi_audio/hf87611_vb1.md - HF87611(Q)-VC1: dev_doc/datasheet/std_product/hifi_audio/hf87611_vc1.md - HF86611(Q)-VB1: dev_doc/datasheet/std_product/hifi_audio/hf86611_vb1.md - HF86611(Q)-VC1: dev_doc/datasheet/std_product/hifi_audio/hf86611_vc1.md - HF83311(Q)-VB1: dev_doc/datasheet/std_product/hifi_audio/hf83311_vb1.md - HF83311(Q)-VC1: dev_doc/datasheet/std_product/hifi_audio/hf83311_vc1.md - USB Low-Power HiFi Decoders Core Modules: - PH83311L(Q)-VC1: dev_doc/datasheet/std_product/phifi_audio/ph83311l_vc1.md - PH83211L(Q)-VC1: dev_doc/datasheet/std_product/phifi_audio/ph83211l_vc1.md - PH73311L(Q)-VC1: dev_doc/datasheet/std_product/phifi_audio/ph73311l_vc1.md - PH73211L(Q)-VC1: dev_doc/datasheet/std_product/phifi_audio/ph73211l_vc1.md # - USB Live Streaming Microphones: # - dev_doc/datasheet/std_product/ai_mic/index.md - Virtual 7.1 Gaming Sound Cards Core Modules: - GM68311_VC1: dev_doc/datasheet/std_product/game/gm68311_vc1.md - GM67211_VC1: dev_doc/datasheet/std_product/game/gm67211_vc1.md # - Microphone Arrays: # - dev_doc/datasheet/std_product/array_mic/index.md - AI DNR(Deep Noise Reduction) Core Modules: - DNR65211-VC1: dev_doc/datasheet/std_product/ai_dnr/dnr65211_vc1.md - DNR65221-VC1: dev_doc/datasheet/std_product/ai_dnr/dnr65221_vc1.md - DNR65231-VC1: dev_doc/datasheet/std_product/ai_dnr/dnr65231_vc1.md - USB OTG Integrated ASRC Core Modules: - OT82111_VC1: dev_doc/datasheet/std_product/usb_otg/ot82111_vc1.md - OT83211_VC1: dev_doc/datasheet/std_product/usb_otg/ot83211_vc1.md - SRC(Audio Sample Rate Conversion) Core Modules: - XMSRC4392-VC1: dev_doc/datasheet/std_product/src/xmsrc4392_vc1.md - XMSRC4194-VC1: dev_doc/datasheet/std_product/src/xmsrc4194_vc1.md - XMSRC4192-VC1: dev_doc/datasheet/std_product/src/xmsrc4192_vc1.md - PDM to I2S/TDM Conversion Core Modules: - XMAU7118-VC1: dev_doc/datasheet/std_product/pdm_2_i2s/xmau7118_vc1.md - Evaluation Board Resources: - dev_doc/evb/index.md - A316-HF-DAC-V1: - dev_doc/evb/a316_hf_dac_v1/index.md - Low-Power Testing Guide: dev_doc/evb/a316_hf_dac_v1/LP_Testing_Guide.md - User Guide: dev_doc/evb/a316_hf_dac_v1/user_guide.md - Test Specifications: dev_doc/evb/a316_hf_dac_v1/test_spec.md - Design Files: dev_doc/evb/a316_hf_dac_v1/design_files.md # - Authorization Guide: dev_doc/evb/a316_hf_dac_v1/a316_dac_auth_tool.md - A316-PH-DAC-V1: - Real 7.1 SA Game Play Guide: dev_doc/evb/a316_ph_dac_v1/v71_game_play_guide.md - Real 7.1 SA Principles And Advantages: dev_doc/evb/a316_ph_dac_v1/v71_sa_principles_advantages.md - A316-HF-I2S-V1: - dev_doc/evb/a316_hf_i2s_v1/index.md - Hardware Datasheet: dev_doc/evb/a316_hf_i2s_v1/datasheet.md - A316-LS-MIC-V2: - dev_doc/evb/a316_ls_mic_v2/index.md - Streaming Microphone Firmware User Guide: - Product User Manual: dev_doc/evb/a316_ls_mic_v2/user_guide.md - AI Noise Reduction Effect Demo: dev_doc/evb/a316_ls_mic_v2/dnr_effect.md - OTG Firmware Testing Guide: dev_doc/evb/a316_ls_mic_v2/otg_firmware_test_guide.md - A316-V71-Game-V1: - dev_doc/evb/a316_v71_game_v1/index.md - User Guide: dev_doc/evb/a316_v71_game_v1/user_guide-en.md - Communication Protocols: - dev_doc/protocols/index.md - XU316 USB HiFi Decoder Zero-Code Product Configuration Protocol: dev_doc/protocols/xu316_zerocode_protocol.md - XMOS EQ HID Product Configuration Protocol: dev_doc/protocols/XMOS_EQ_HID_Protocol.md - Development SDK and Examples: - dev_doc/sdk_examples/index.md - A316 Zero-Code Firmware MCU Development Guide: - dev_doc/sdk_examples/XU316_MCU_Communication_Examples/index.md - Code Examples: - XU316 MCU Development Example: dev_doc/sdk_examples/XU316_MCU_Communication_Examples/Development_Guide.md - Zero-Code Test Script: dev_doc/sdk_examples/XU316_MCU_Communication_Examples/ZeroCode_Test_Script.md - Zero-Code Firmware Development FAQ: dev_doc/faq/technical_faq/a316_firmware_dev_faq.md # - 5.1 Standard Firmware Usage Examples: # - 8711 Development Board Connection Guide: dev_doc/hifi_audio/a316_1926v1/RTL8711dome.md # - Development Board Hardware Connection Guide: dev_doc/hifi_audio/a316_1926v1/A316-8711-5.1解码无线音频套装制作说明.md # - PC Audio Device Settings: dev_doc/hifi_audio/a316_1926v1/used.md # - OTA Tool Usage Guide: dev_doc/hifi_audio/a316_1926v1/OTA升级dongle-8711工具使用说明.md - Frequently Asked Questions: - dev_doc/faq/index.md - Product FAQs: - PC Audio Device Settings: dev_doc/hifi_audio/a316_1926v1/used.md - Driver Recognition and Device Exception Issues: dev_doc/faq/product_faq/driver_recognition_and_device_exception.md # - General Technical FAQs: # - Zero-Code Firmware Development FAQ: dev_doc/faq/technical_faq/a316_firmware_dev_faq.md # - WiFi Speaker + Bluetooth Module Technical FAQs: dev_doc/faq/technical_faq/technical_faq.md - Services & Support: - services_support/index.md - Configuration and Debugging Tools: - services_support/tools_software/index.md - Drivers: - services_support/driver/index.md - Product Firmware Downloads: - services_support/firmware/index.md - Factory Firmware Downloads: - services_support/factory_img/index.md - Consultation and Services: - services_support/acquire_services/index.md - News & Updates: - blog/index.md - About Us: - about_us/index.md - About XMOS: about_us/xmos.md - Join Us: about_us/join_us.md - Contact Us: about_us/contact_us.md