Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
haptics_config Union Reference

Haptics source configuration. More...

#include <zephyr/drivers/haptics.h>

Data Fields

uint32_t idx
 Used to specify an effect from a list of waveforms stored in memory.
struct { 
   audio_dai_type_t   type 
 Digital audio interface type, e.g., I2S. More...
   audio_dai_cfg_t   cfg 
 Digital audio interface configuration details. More...
dai
 Digital audio interface configuration for "audio to haptics" features.

Detailed Description

Haptics source configuration.

Most haptic drivers provide pre-programmed effects or expose methods for programming new effects at run-time. Such effects are typically stored in what is called a wavetable, where individual effects can be referenced using an index. To specify a particular effect from a wavetable, use idx with haptics_select_source(). Otherwise, dai is provided to specify bus configuration details for digital audio interfaces, notably I2S and PCM.

Field Documentation

◆ cfg

audio_dai_cfg_t haptics_config::cfg

Digital audio interface configuration details.

◆ [struct]

struct { ... } haptics_config::dai

Digital audio interface configuration for "audio to haptics" features.

◆ idx

uint32_t haptics_config::idx

Used to specify an effect from a list of waveforms stored in memory.

◆ type

audio_dai_type_t haptics_config::type

Digital audio interface type, e.g., I2S.


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