nRF Audio: Application-specific Kconfig options
Following are the application-specific configuration options that can be configured for the nRF Audio applications and their internal modules:
- CONFIG_APP_NRF_AUDIO
(bool) nRF Audio [EXPERIMENTAL]
- CONFIG_CUSTOM_BROADCASTER
(bool) Allow custom broadcasters
Incomplete feature for now, but will introduce support for multiple BIGs and subgroups.
- CONFIG_AUDIO_DEV
(int) Select which device type to compile for. 1=HEADSET or 2=GATEWAY
Setting this variable to 1 selects that the project is compiled as a HEADSET device. Setting to 2 will compile as a GATEWAY.
- CONFIG_TRANSPORT_BIS
(bool) Use BIS (Broadcast Isochronous Stream)
- CONFIG_TRANSPORT_CIS
(bool) Use CIS (Connected Isochronous Stream)
- CONFIG_REBOOT
(unknown)
- CONFIG_MAIN_THREAD_PRIORITY
(unknown)
- CONFIG_MAIN_STACK_SIZE
(unknown)
- CONFIG_SYSTEM_WORKQUEUE_STACK_SIZE
(unknown)
- CONFIG_THREAD_NAME
(unknown)
- CONFIG_RESET_ON_FATAL_ERROR
(unknown)
- CONFIG_BT
(unknown)
- CONFIG_ZBUS
(unknown)
- CONFIG_ZBUS_RUNTIME_OBSERVERS
(unknown)
- CONFIG_ZBUS_MSG_SUBSCRIBER
(unknown)
- CONFIG_SENSOR
(unknown)
- CONFIG_REGULATOR
(unknown)
- CONFIG_CONTIN_ARRAY
(unknown)
- CONFIG_NRFX_I2S
(unknown)
- CONFIG_PCM_MIX
(unknown)
- CONFIG_PSCM
(unknown)
- CONFIG_NRFX_CLOCK
(unknown)
- CONFIG_I2C
(unknown)
- CONFIG_FPU
(unknown)
- CONFIG_FPU_SHARING
(unknown)
- CONFIG_DISK_DRIVERS
(unknown)
- CONFIG_DISK_DRIVER_SDMMC
(unknown)
- CONFIG_SPI
(unknown)
- CONFIG_ADC
(unknown)
- CONFIG_SPI_NRFX_RAM_BUFFER_SIZE
(unknown)
- CONFIG_FILE_SYSTEM
(unknown)
- CONFIG_FAT_FILESYSTEM_ELM
(unknown)
- CONFIG_FS_FATFS_LFN
(unknown)
- CONFIG_FS_FATFS_EXFAT
(unknown)
- CONFIG_NRFX_TIMER
(unknown)
- CONFIG_NRFX_GPPI
(unknown)
- CONFIG_AUDIO_FRAME_DURATION_7_5_MS
(bool) 7.5 ms
- CONFIG_AUDIO_FRAME_DURATION_10_MS
(bool) 10 ms
- CONFIG_AUDIO_FRAME_DURATION_US
(int)
Audio frame duration in µs.
- CONFIG_AUDIO_MIN_PRES_DLY_US
(int) The minimum presentation delay
The minimum allowable presentation delay in microseconds. This needs to allow time for decoding and internal routing.
- CONFIG_AUDIO_MAX_PRES_DLY_US
(int) The maximum presentation delay
The maximum allowable presentation delay in microseconds. Increasing this will also increase the FIFO buffers to allow buffering.
- CONFIG_AUDIO_SAMPLE_RATE_16000_HZ
(bool) 16 kHz
Sample rate of 16 kHz is currently only valid for I2S/line-in.
- CONFIG_AUDIO_SAMPLE_RATE_24000_HZ
(bool) 24 kHz
Sample rate of 24 kHz is currently only valid for I2S/line-in.
- CONFIG_AUDIO_SAMPLE_RATE_48000_HZ
(bool) 48 kHz
Sample rate of 48 kHz is valid for both I2S/line-in and USB.
- CONFIG_AUDIO_SAMPLE_RATE_HZ
(int)
I2S supports 16, 24, and 48 kHz sample rates for both input and output. USB supports only 48 kHz for input.
- CONFIG_AUDIO_BIT_DEPTH_16
(bool) 16 bit audio
- CONFIG_AUDIO_BIT_DEPTH_32
(bool) 32 bit audio
- CONFIG_AUDIO_BIT_DEPTH_BITS
(int)
Bit depth of one sample in storage.
- CONFIG_AUDIO_BIT_DEPTH_OCTETS
(int)
Bit depth of one sample in storage given in octets.
- CONFIG_AUDIO_DECODE_CHANNELS_MAX
(int) Maximum number of audio channels to decode
Maximum number of audio channels that can be decoded. This number may have a large impact on memory and CPU usage.
- CONFIG_AUDIO_ENCODE_CHANNELS_MAX
(int) Maximum number of audio channels to encode
Maximum number of audio channels that can be encoded. This number may have a large impact on memory and CPU usage.
- CONFIG_AUDIO_INPUT_CHANNELS
(int) Maximum number of simultaneous audio input channels
Maximum number of audio channels that can be physically input. This is dependent on the HW itself.
- CONFIG_AUDIO_OUTPUT_CHANNELS
(int) Maximum number of simultaneous audio output channels
Maximum number of audio channels that can be physically output. This is dependent on the HW itself. Eg. for the nRF5340 Audio DK, the I2S supports 2 channels. However, the HW Codec’s (CS47L63) DAC only supports 1 channel out.
- CONFIG_AUDIO_SOURCE_USB
(bool) USB as audio source
Set USB as audio source. Note that this forces the stream to be unidirectional because of CPU load.
- CONFIG_AUDIO_SOURCE_I2S
(bool) I2S as audio source
Set I2S as audio source.
- CONFIG_DEVICE_LOCATION_SET_RUNTIME
(bool) Select at runtime
Make location selection at runtime. Selected value is stored in persistent memory. FRONT_LEFT: Hold volume-down button while resetting headset. FRONT_RIGHT: Hold volume-up button while resetting headset.
- CONFIG_DEVICE_LOCATION_SET_COMPILE_TIME
(bool) Set at compile-time
Set location at compile-time.
- CONFIG_DEVICE_LOCATION_AT_COMPILE_TIME
(int) Device location bitfield according to bt_audio_location
Sets FRONT_LEFT location as default.
- CONFIG_AUDIO_TEST_TONE
(bool) Test tone instead of doing user defined action
Use button 4 to set a test tone instead of doing a user defined action. The test tone is generated on the device itself.
- CONFIG_AUDIO_MUTE
(bool) Mute instead of doing user defined action
Use button 5 to mute audio instead of doing a user defined action.
- CONFIG_SW_CODEC_LC3
(bool) LC3
LC3 is the mandatory codec for LE Audio.
- CONFIG_SW_CODEC_NONE
(bool) None
Choose this if no software (SW) codec is needed.
- CONFIG_SW_CODEC_PLC_DISABLED
(bool) Skip PLC on a bad frame and fill the output buffer(s) with zeros instead
- CONFIG_LC3_BITRATE_MAX
(int) Max bitrate for LC3
- CONFIG_LC3_BITRATE_MIN
(int) Min bitrate for LC3
- CONFIG_LC3_BITRATE
(int)
- CONFIG_BUF_BLE_RX_PACKET_NUM
(int)
Value can be adjusted to affect the overall latency. This adjusts the number packets in the BLE FIFO RX buffer, which is where the main latency resides. A low value will decrease latency and reduce stability, and vice-versa. Two is recommended minimum to reduce the likelyhood of audio gaps due to BLE retransmits.
- CONFIG_STREAM_BIDIRECTIONAL
(bool) Bidirectional stream
Bidirectional stream enables encoder and decoder on both sides, and one device can both send and receive audio.
- CONFIG_WALKIE_TALKIE_DEMO
(bool) Walkie talkie demo
The walkie talkie demo will set up a bidirectional stream using PDM microphones on each side.
- CONFIG_MONO_TO_ALL_RECEIVERS
(bool) Send mono (first/left channel) to all receivers
With this flag set, the gateway will encode and send the same (first/left) channel on all ISO channels.
- CONFIG_ENCODER_THREAD_PRIO
(int) Priority for encoder thread
This is a preemptible thread.
- CONFIG_AUDIO_DATAPATH_THREAD_PRIO
(int) Priority for audio datapath thread
This is a preemptible thread.
- CONFIG_BUTTON_MSG_SUB_THREAD_PRIO
(int) Thread priority for button subscriber
This is a preemptible thread. This thread will subscribe to button events from zbus.
- CONFIG_LE_AUDIO_MSG_SUB_THREAD_PRIO
(int) Thread priority for LE Audio subscriber
This is a preemptible thread. This thread will subscribe to LE Audio events from zbus.
- CONFIG_BT_MGMT_MSG_SUB_THREAD_PRIO
(int) Thread priority for bt_mgmt subscriber
This is a preemptible thread. This thread will subscribe to BT management events from zbus.
- CONFIG_CONTENT_CONTROL_MSG_SUB_THREAD_PRIO
(int) Thread priority for content control subscriber
This is a preemptible thread. This thread will subscribe to content control events from zbus.
- CONFIG_ENCODER_STACK_SIZE
(int) Stack size for encoder thread
- CONFIG_AUDIO_DATAPATH_STACK_SIZE
(int) Stack size for audio datapath thread
- CONFIG_BUTTON_MSG_SUB_STACK_SIZE
(int) Stack size for button subscriber
- CONFIG_LE_AUDIO_MSG_SUB_STACK_SIZE
(int) Stack size for LE Audio subscriber
- CONFIG_BT_MGMT_MSG_SUB_STACK_SIZE
(int) Stack size for bt_mgmt subscriber
- CONFIG_CONTENT_CONTROL_MSG_SUB_STACK_SIZE
(int) Stack size for content control subscriber
- CONFIG_BUTTON_MSG_SUB_QUEUE_SIZE
(int) Queue size for button subscriber
- CONFIG_CONTENT_CONTROL_MSG_SUB_QUEUE_SIZE
(int) Queue size for content control subscriber
- CONFIG_BT_AUDIO
(unknown)
- CONFIG_BT_DEVICE_NAME
(unknown)
- CONFIG_BT_DEVICE_NAME_DYNAMIC
(unknown)
- CONFIG_BT_ECC
(unknown)
- CONFIG_BT_EXT_ADV
(unknown)
- CONFIG_BT_ATT_PREPARE_COUNT
(unknown)
- CONFIG_BLE_ACL_PER_ADV_INT_MIN
(hex) Minimum periodic advertising interval
Minimum hexadecimal value for the interval of periodic advertisements. For ms, multiply the provided value by 1.25.
- CONFIG_BLE_ACL_PER_ADV_INT_MAX
(hex) Maximum periodic advertising interval
Maximum hexadecimal value for the interval of periodic advertisements. For ms, multiply the provided value by 1.25.
- CONFIG_BLE_ACL_EXT_ADV_INT_MIN
(hex) Minimum extended advertising interval
Minimum hexadecimal value for the interval of extended advertisements. When the LE Audio Controller Subsystem for nRF53 is used, this interval should be a multiple of the ISO interval and maximum 4x larger than the lowest interval if using BIS. For ms, multiply the provided value by 0.625.
- CONFIG_BLE_ACL_EXT_ADV_INT_MAX
(hex) Maximum extended advertising interval
Maximum hexadecimal value for the interval of extended advertisements. When the LE Audio Controller Subsystem for nRF53 is used, this interval should be a multiple of the ISO interval and maximum 4x larger than the lowest interval if using BIS. For ms, multiply the provided value by 0.625.
- CONFIG_EXT_ADV_BUF_MAX
(int) Maximum number of extended advertising data parameters
- CONFIG_EXT_ADV_UUID_BUF_MAX
(int) Maximum number of UUIDs to add to extended advertisements
- CONFIG_BT_DEVICE_MANUFACTURER_ID
(hex) Manufacturer ID
Bluetooth manufacturer ID. For the list of possible values please consult the following link: https://www.bluetooth.com/specifications/assigned-numbers
- CONFIG_BLE_ACL_ADV_SID
(hex) Advertising set ID
- CONFIG_BT_MGMT_ADV_STACK_SIZE
(int) Stack size
Stack size for the Bluetooth management advertising thread.
- CONFIG_BT_MGMT_ADV_WQ_PRIO
(int) Work queue priority for bt_mgmt advertising
This work queue will subscribe to BT management advertising work items.
- CONFIG_BT_BACKGROUND_SCAN_INTERVAL
(unknown)
- CONFIG_BT_BACKGROUND_SCAN_WINDOW
(unknown)
- CONFIG_BT_SCAN_WITH_IDENTITY
(unknown)
- CONFIG_SCAN_MODE_PASSIVE
(bool) Passive Scan
- CONFIG_SCAN_MODE_ACTIVE
(bool) Active Scan
- CONFIG_BT_MGMT_CONNECT_BY_NAME
(bool) Name
If enabled, the scanner will look for a specific name instead of just connecting to the first device it finds. The name to look for is CONFIG_BT_DEVICE_NAME. This is useful for testing with a known device. Note: This is only used if no CSIP Set Identity Resolving Key (SIRK) is available in the bond information.
- CONFIG_BT_MGMT_CONNECT_BY_ADDR
(bool) Address
If enabled, the scanner will look for a specific address instead of a name. The address to look for is set in bt_mgmt_scan_for_conn.c in the addr_check() function. This is useful for testing with a known device. Note: This is only used if no CSIP Set Identity Resolving Key (SIRK) is available in the bond information.
- CONFIG_CONNECT_TO_BT_ADDR_LE_STR
(string) Bluetooth LE Address to connect to
The Bluetooth LE address to connect to. This is useful for testing with a specific device.
- CONFIG_BLE_ACL_CONN_INTERVAL
(int) Bluetooth LE ACL Connection Interval (x*1.25ms)
This interval should be a multiple of the ISO interval used. The recommendation is to increase the interval to something like BLE_ACL_CONN_INTERVAL_SLOW after the discovery process is done, to free up time on air.
- CONFIG_BLE_ACL_CONN_INTERVAL_SLOW
(int) Bluetooth LE ACL Connection Interval (x*1.25ms)
This interval should be a multiple of the ISO interval used. 72*1.25=90 which will suit both 7.5ms and 10ms.
- CONFIG_BLE_ACL_SLAVE_LATENCY
(int) Bluetooth LE Slave Latency
- CONFIG_BLE_ACL_SUP_TIMEOUT
(int) Bluetooth LE Supervision Timeout (x*10ms)
- CONFIG_BT_AUDIO_CODEC_CFG_MAX_METADATA_SIZE
(unknown)
- CONFIG_BT_AUDIO_BROADCAST_CONFIGURABLE
(bool) Configurable broadcast settings
Configurable option that doesn’t follow any preset. Allows for more flexibility.
- CONFIG_BT_BAP_BROADCAST_16_2_1
(bool) 16_2_1
Broadcast mandatory codec capability 16_2_1. 16kHz, 32kbps, 2 retransmits, 10ms transport latency, and 40ms presentation delay.
- CONFIG_BT_BAP_BROADCAST_16_2_2
(bool) 16_2_2
Broadcast mandatory codec capability 16_2_2. 16kHz, 32kbps, 4 retransmits, 60ms transport latency, and 40ms presentation delay.
- CONFIG_BT_BAP_BROADCAST_24_2_1
(bool) 24_2_1
Broadcast codec capability 24_2_1. 24kHz, 48kbps, 2 retransmits, 10ms transport latency, and 40ms presentation delay.
- CONFIG_BT_BAP_BROADCAST_24_2_2
(bool) 24_2_2
Broadcast codec capability 24_2_2. 24kHz, 48kbps, 4 retransmits, 60ms transport latency, and 40ms presentation delay.
- CONFIG_BT_BAP_BROADCAST_48_2_1
(bool) 48_2_1
Broadcast codec capability 48_2_1. 48kHz, 80kbps, 4 retransmits, 20ms transport latency, and 40ms presentation delay.
- CONFIG_BT_BAP_BROADCAST_48_2_2
(bool) 48_2_2
Broadcast codec capability 48_2_2. 48kHz, 80kbps, 4 retransmits, 65ms transport latency, and 40ms presentation delay.
- CONFIG_BT_BAP_BROADCAST_48_4_1
(bool) 48_4_1
Broadcast codec capability 48_4_1. 48kHz, 96kbps, 4 retransmits, 20ms transport latency, and 40ms presentation delay.
- CONFIG_BT_BAP_BROADCAST_48_4_2
(bool) 48_4_2
Broadcast codec capability 48_4_2. 48kHz, 96kbps, 4 retransmits, 65ms transport latency, and 40ms presentation delay.
- CONFIG_BT_BAP_BROADCAST_48_6_1
(bool) 48_6_1
Broadcast codec capability 48_6_1. 48kHz, 124kbps, 4 retransmits, 20ms transport latency, and 40ms presentation delay.
- CONFIG_BT_BAP_BROADCAST_48_6_2
(bool) 48_6_2
Broadcast codec capability 48_6_2. 48kHz, 124kbps, 4 retransmits, 65ms transport latency, and 40ms presentation delay.
- CONFIG_BT_AUDIO_BROADCAST_NAME
(string) Broadcast name
Name of the broadcast; not the same as BT_DEVICE_NAME.
- CONFIG_BT_AUDIO_BROADCAST_NAME_ALT
(string) Alternative broadcast name
Alternative name of the broadcast.
- CONFIG_BT_AUDIO_USE_BROADCAST_NAME_ALT
(bool) Use the alternative broadcast name
Use the alternative broadcast name.
- CONFIG_BT_AUDIO_BROADCAST_ENCRYPTED
(bool) Encrypted broadcast
Encrypt the broadcast to limit the connection possibilities.
- CONFIG_BT_AUDIO_BROADCAST_ENCRYPTION_KEY
(string) Broadcast encryption key
Key to use for encryption and decryption, with maximum BT_ISO_BROADCAST_CODE_SIZE characters. Encryption keys larger than BT_ISO_BROADCAST_CODE_SIZE will be truncated to BT_ISO_BROADCAST_CODE_SIZE.
- CONFIG_BT_AUDIO_USE_BROADCAST_ID_FICR
(bool) Use the FICR broadcast ID
Use the FICR broadcast ID. This is a fixed broadcast ID that is unique to each device. It is stored in the FICR NFC.TAGHEADER0 register.
- CONFIG_BT_AUDIO_USE_BROADCAST_ID_RANDOM
(bool) Use a random broadcast ID
Use a randomly generated broadcast ID.
- CONFIG_BT_AUDIO_USE_BROADCAST_ID_FIXED
(bool) Use a fixed broadcast ID
Use a fixed broadcast ID. This is useful for debugging purposes.
- CONFIG_BT_AUDIO_BROADCAST_ID_FIXED
(hex) Fixed broadcast ID
Fixed broadcast ID; 3 octets. Will only be used if BT_AUDIO_USE_BROADCAST_ID_FIXED=y. Only use for debugging.
- CONFIG_BT_AUDIO_BROADCAST_PBA_METADATA_SIZE
(int) Configure PBA meta data buffer size
Configure the maximum size of the Public Broadcast Announcement meata data buffer in octets. This is the number of meta data LVT records, or the number of meta data items multiplied by the size of the LTV (sizeof(bt_data)). Configurable option that doesn’t follow any preset. Allows for more flexibility.
- CONFIG_BT_AUDIO_BROADCAST_PARENTAL_RATING
(hex) Parental rating
Set the parental rating for the broadcast. BT_AUDIO_PARENTAL_RATING_NO_RATING = 0x00, BT_AUDIO_PARENTAL_RATING_AGE_ANY = 0x01, BT_AUDIO_PARENTAL_RATING_AGE_5_OR_ABOVE = 0x02, BT_AUDIO_PARENTAL_RATING_AGE_6_OR_ABOVE = 0x03, BT_AUDIO_PARENTAL_RATING_AGE_7_OR_ABOVE = 0x04, BT_AUDIO_PARENTAL_RATING_AGE_8_OR_ABOVE = 0x05, BT_AUDIO_PARENTAL_RATING_AGE_9_OR_ABOVE = 0x06, BT_AUDIO_PARENTAL_RATING_AGE_10_OR_ABOVE = 0x07, BT_AUDIO_PARENTAL_RATING_AGE_11_OR_ABOVE = 0x08, BT_AUDIO_PARENTAL_RATING_AGE_12_OR_ABOVE = 0x09, BT_AUDIO_PARENTAL_RATING_AGE_13_OR_ABOVE = 0x0A, BT_AUDIO_PARENTAL_RATING_AGE_14_OR_ABOVE = 0x0B, BT_AUDIO_PARENTAL_RATING_AGE_15_OR_ABOVE = 0x0C, BT_AUDIO_PARENTAL_RATING_AGE_16_OR_ABOVE = 0x0D, BT_AUDIO_PARENTAL_RATING_AGE_17_OR_ABOVE = 0x0E, BT_AUDIO_PARENTAL_RATING_AGE_18_OR_ABOVE = 0x0F
- CONFIG_BT_AUDIO_BROADCAST_IMMEDIATE_FLAG
(bool) Immediate rendering flag
Set the immediate rendering flag.
- CONFIG_AURACAST
(bool) Enable Auracast
When Auracast is enabled, a Public Broadcast Announcement will be included when advertising.
- CONFIG_BT_AUDIO_BITRATE_BROADCAST_SRC
(int) ISO stream bitrate
Bitrate for the broadcast source ISO stream.
- CONFIG_BT_AUDIO_SCAN_DELEGATOR
(bool) Enable scan delegator
When scan delegator feature is enabled, the broadcast sink will not search for a predefined broadcast source. Instead, it will wait for a broadcast assistant to connect and control.
- CONFIG_BT_SET_IDENTITY_RESOLVING_KEY_DEFAULT
(string)
Default string to configure the Set Identify Resolving Key (SIRK), must be changed before production uniquely for each coordinated set.
- CONFIG_BT_SET_IDENTITY_RESOLVING_KEY
(string) String used to configure the SIRK
Defines a string to configure the Set Identify Resolving Key (SIRK), must be changed before production uniquely for each coordinated set. The SIRK must be 16 characters (16 bytes).
- CONFIG_BT_AUDIO_BROADCAST_ZBUS_EVT_STREAM_SENT
(bool) Enable Zephyr bus event for stream sent
Enable ZBUS event signalling that a stream has been sent, and that the next frame can be prepared. As this event will trigger once for each frame it will cause significant overhead, even if the event is not used.
- CONFIG_BT_AUDIO_BROADCAST_BASE_PRINT
(bool) Print BASE information
Print the contents of the BASE when received. This is useful for debugging purposes.
- CONFIG_BT_GATT_CLIENT
(unknown)
- CONFIG_BT_BONDABLE
(unknown)
- CONFIG_BT_PRIVACY
(unknown)
- CONFIG_BT_FILTER_ACCEPT_LIST
(unknown)
- CONFIG_BT_SMP
(unknown)
- CONFIG_BT_GAP_AUTO_UPDATE_CONN_PARAMS
(unknown)
- CONFIG_BT_AUTO_PHY_UPDATE
(unknown)
- CONFIG_BT_AUTO_DATA_LEN_UPDATE
(unknown)
- CONFIG_BT_L2CAP_TX_BUF_COUNT
(unknown)
- CONFIG_BT_BUF_ACL_RX_SIZE
(unknown)
- CONFIG_BT_BUF_EVT_RX_COUNT
(unknown)
- CONFIG_SETTINGS
(unknown)
- CONFIG_BT_SETTINGS
(unknown)
- CONFIG_FLASH
(unknown)
- CONFIG_FLASH_MAP
(unknown)
- CONFIG_NVS
(unknown)
- CONFIG_NVS_LOG_LEVEL
(unknown)
- CONFIG_BT_BAP_UNICAST_CONFIGURABLE
(bool) Configurable unicast settings
Configurable option that doesn’t follow any preset. Allows for more flexibility.
- CONFIG_BT_BAP_UNICAST_16_2_1
(bool) 16_2_1
Unicast mandatory codec capability 16_2_1. 16kHz, 32kbps, 2 retransmits, 10ms transport latency, and 40ms presentation delay.
- CONFIG_BT_BAP_UNICAST_24_2_1
(bool) 24_2_1
Unicast codec capability 24_2_1. 24kHz, 48kbps, 2 retransmits, 10ms transport latency, and 40ms presentation delay.
- CONFIG_BT_BAP_UNICAST_48_4_1
(bool) 48_4_1
Unicast codec capability 48_4_1. 48kHz, 96kbps, 5 retransmits, 20ms transport latency, and 40ms presentation delay.
- CONFIG_BT_AUDIO_PRES_DELAY_SRCH_MIN
(bool) Largest minimum delay over all audio receivers
Search for the largest minimum delay over all audio receivers.
- CONFIG_BT_AUDIO_PRES_DELAY_SRCH_MAX
(bool) Smallest maximum delay over all audio receivers
Search for the smallest maximum delay over all audio receivers.
- CONFIG_BT_AUDIO_PRES_DELAY_SRCH_PREF_MIN
(bool) Largest minimum preferred delay over all audio receivers
Search for the largest minimum preferred delay over all audio receivers.
- CONFIG_BT_AUDIO_PRES_DELAY_SRCH_PREF_MAX
(bool) Smallest maximum preferred delay over all audio receivers
Search for the smallest maximum preferred delay over all audio receivers.
- CONFIG_BT_AUDIO_PRES_DELAY_SRCH_SOURCE
(bool) Use the presentation delay of audio source or client
Use the presentation delay defined by the broadcast_source or unicast_client if it is within the range set by AUDIO_MIN_PRES_DLY_US and AUDIO_MAX_PRES_DLY_US. This will override the audio receiver presentation delay as long as it is in range of the max and min supported by the audio receivers. If it is outside this range, then it will revert to the closest supported value.
- CONFIG_BT_AUDIO_PAC_REC_PRINT
(bool) Print discovered Published Audio Capabilities
Print the supported capabilities of a unicast server when it is discovered.
- CONFIG_CODEC_CAP_COUNT_MAX
(int) Max storage of codec capabilities
Max number of codec capabilities to store per stream.
- CONFIG_BT_AUDIO_PREFERRED_MIN_PRES_DLY_US
(int) The preferred minimum presentation delay
The preferred minimum presentation delay in microseconds. This can not be less than the absolute minimum presentation delay.
- CONFIG_BT_AUDIO_PREFERRED_MAX_PRES_DLY_US
(int) The preferred maximum presentation delay
The preferred maximum presentation delay in microseconds. This can not be less than the absolute maximum presentation delay.
- CONFIG_BT_AUDIO_BITRATE_UNICAST_SINK
(int) ISO stream bitrate
Bitrate for the unicast sink ISO stream.
- CONFIG_BT_AUDIO_BITRATE_UNICAST_SRC
(int) ISO stream bitrate
Bitrate for the unicast source ISO stream.
- CONFIG_NRF_AUDIO_TX_TGT_LEAD_TIME_US
(int)
Do not change this value unless you know what you are doing. Target lead time to send data to controller before it sends the next SDU on air. Used to make sure that the data is sent to controller just in time for the next SDU, which can help with reducing the overall latency and power consumption. Setting this too low may lead to flushed data, and too high will increase latency. Must be higher than HCI_ISO_TX_SDU_ARRIVAL_MARGIN_US + plus a margin depending on SoC.
- CONFIG_NRF_AUDIO_TX_LEAD_TIME_DEVIATION_US
(int)
Do not change this value unless you know what you are doing. Max allowed deviation in microseconds from NRF_AUDIO_TX_TGT_LEAD_TIME_US This deviation may take into account audio processing jitter, which is caused by e.g. variable LC3 encoding time. Modules may use this value in different ways.
- CONFIG_BT_AUDIO_PACKING_INTERLEAVED
(bool) Interleaved packing
ISO channels can either be interleaved or sequentially packed; sequential is the default one.
- CONFIG_BT_AUDIO_CONCURRENT_RX_STREAMS_MAX
(int) Max number of concurrent streams
The maximum number of concurrent streams supported in the RX direction. This is the maximum number of streams that can be active at the same time.
- CONFIG_BT_AUDIO_CONCURRENT_TX_STREAMS_MAX
(int) Max number of concurrent streams
The maximum number of concurrent streams supported in the TX direction. This is the maximum number of streams that can be active at the same time.
- CONFIG_BT_AUDIO_PREF_SINK_SAMPLE_RATE_VALUE
(hex)
- CONFIG_BT_AUDIO_PREF_SINK_SAMPLE_RATE_48KHZ
(bool) 48 kHz
Select 48000 Hz as the preferred sink sample rate.
- CONFIG_BT_AUDIO_PREF_SINK_SAMPLE_RATE_24KHZ
(bool) 24 kHz
Select 24000 Hz as the preferred sink sample rate.
- CONFIG_BT_AUDIO_PREF_SINK_SAMPLE_RATE_16KHZ
(bool) 16 kHz
Select 16000 Hz as the preferred sink sample rate.
- CONFIG_BT_AUDIO_PREF_SOURCE_SAMPLE_RATE_VALUE
(hex)
- CONFIG_BT_AUDIO_PREF_SOURCE_SAMPLE_RATE_48KHZ
(bool) 48 kHz
Select 48000 Hz as the preferred source sample rate.
- CONFIG_BT_AUDIO_PREF_SOURCE_SAMPLE_RATE_24KHZ
(bool) 24 kHz
Select 24000 Hz as the preferred source sample rate.
- CONFIG_BT_AUDIO_PREF_SOURCE_SAMPLE_RATE_16KHZ
(bool) 16 kHz
Select 16000 Hz as the preferred source sample rate.
- CONFIG_BT_AUDIO_PRESENTATION_DELAY_US
(int) Presentation delay
The audio source/client defined presentation delay if within AUDIO_MIN_PRES_DLY_US and AUDIO_MAX_PRES_DLY_US range. This will override the audio receivers presentation delay as long as it is in range of the max and min supported by the audio receivers. If it is outside this range, then it will revert to the closest supported value.
- CONFIG_BT_AUDIO_MAX_TRANSPORT_LATENCY_MS
(int) Max transport latency
Max transport latency for the ISO link.
- CONFIG_BT_AUDIO_RETRANSMITS
(int) Number of re-transmits
Number of re-transmits for the ISO link. 2 re-transmits means a total of 3 packets sent per stream.
- CONFIG_BT_AUDIO_VOL_DEFAULT
(int) Default volume
The default volume when starting a volume control renderer.
- CONFIG_BT_AUDIO_VOL_STEP_SIZE
(int) Volume adjust step size
- CONFIG_BT_CONTENT_CTRL_MEDIA
(bool) Bluetooth content control media
Bluetooth content control media module.
- CONFIG_TESTING_BLE_ADDRESS_RANDOM
(bool) Random address and bonding clear on every restart [EXPERIMENTAL]
If enabled the system will generate a new address on every restart (i.e. reset, re-flash). Any bonding information will be cleared. This is only for testing purposes.
- CONFIG_NRF_AUDIO_CS47L63_DRIVER
(bool) CS47L63 HW codec driver
Include the driver for the Cirrus Logic CS47L63 hardware codec chip
- CONFIG_CS47L63_THREAD_PRIO
(int) Priority for CS47L63 thread
This is a preemptible thread
- CONFIG_CS47L63_STACK_SIZE
(int) Stack size for CS47L63
- CONFIG_UDC_NRF_THREAD_STACK_SIZE
(unknown)
- CONFIG_USBD_THREAD_STACK_SIZE
(unknown)
- CONFIG_UDC_BUF_POOL_SIZE
(unknown)
- CONFIG_NRF_USBD_COMMON_LOG_LEVEL
(unknown)
- CONFIG_USBC_LOG_LEVEL
(unknown)
- CONFIG_USBD_LOG_LEVEL
(unknown)
- CONFIG_USBD_UAC2_LOG_LEVEL
(unknown)
- CONFIG_UDC_DRIVER_LOG_LEVEL
(unknown)
- CONFIG_USBD_MAX_SPEED
(unknown)
- CONFIG_BUTTON_DEBOUNCE_MS
(int) Button debounce time in ms
- CONFIG_AUDIO_SYNC_TIMER_USES_RTC
(bool)
- CONFIG_USBD_PID
(hex)
- CONFIG_USBD_VID
(hex)
- CONFIG_USBD_PRODUCT
(string)
- CONFIG_USBD_MANUFACTURER
(string)
- CONFIG_USBD_SELF_POWERED
(bool) USB device Self-powered attribute
Set the Self-powered attribute in the configuration.
- CONFIG_USBD_MAX_POWER
(int)
The maximum power consumption of the USB device in units of 2 mA (i.e., the value 50 represents 100 mA, the value 250 represents 500 mA).
- CONFIG_USBD_REMOTE_WAKEUP
(bool) USB device Remote Wakeup attribute
Set the Remote Wakeup attribute in the configuration.
- CONFIG_NRF5340_AUDIO_POWER_MEASUREMENT
(bool) Power measurement
Include the power measurement driver for the nRF5340 Audio DK
- CONFIG_POWER_MEAS_INTERVAL_MS
(int) Power measurement interval in milliseconds
Power measurement runs continuously, this option just establishes the results polling period. Note that this value needs to be >= the configured sampling interval on the current sensor. When below, repeated measurements will be observed.
- CONFIG_POWER_MEAS_START_ON_BOOT
(bool) Start power measurements for all rails on boot
This option will automatically start and periodically print the voltage, current consumption, and power usage for the following rails: VBAT, VDD1_CODEC, VDD2_CODEC, and VDD2_NRF
- CONFIG_I2S_LRCK_FREQ_HZ
(int)
The sample rate of I2S. For now this is tied directly to AUDIO_SAMPLE_RATE_HZ Note that this setting is only valid in I2S master mode.
- CONFIG_I2S_CH_NUM
(int)
The I2S driver itself supports both mono and stereo. Parts of the implementation are configured for only stereo.
- CONFIG_POWER_MEAS_THREAD_PRIO
(int) Priority for power measurement thread
This is a preemptible thread.
- CONFIG_BUTTON_PUBLISH_THREAD_PRIO
(int) Priority for button publish thread
This is a preemptible thread. This thread will publish button events to zbus.
- CONFIG_VOLUME_MSG_SUB_THREAD_PRIO
(int) Priority for volume message subscribe thread
This is a preemptible thread. This thread will subscribe to volume events from zbus.
- CONFIG_POWER_MEAS_STACK_SIZE
(int) Stack size for power measurement thread
- CONFIG_BUTTON_PUBLISH_STACK_SIZE
(int) Stack size for button publish thread
- CONFIG_VOLUME_MSG_SUB_STACK_SIZE
(int) Stack size for volume message subscribe thread
- CONFIG_VOLUME_MSG_SUB_QUEUE_SIZE
(int) Queue size for volume message subscriber
- CONFIG_NRF_AUDIO_SD_CARD_MODULE
(bool) Audio SD Card Module
Include the audio SD card module to support streaming audio files from an SD card.
- CONFIG_NRF_AUDIO_SD_CARD_LC3_FILE
(bool) SD card LC3 file support
Include support for reading and parsing LC3 files from an SD card.
- CONFIG_SD_CARD_PLAYBACK
(bool) Enable playback from SD card
- CONFIG_SD_CARD_PLAYBACK_STACK_SIZE
(int) Stack size for the SD card playback thread
- CONFIG_SD_CARD_PLAYBACK_RING_BUF_SIZE
(int) Size of the ring buffer for the SD card playback module
- CONFIG_SD_CARD_PLAYBACK_THREAD_PRIO
(int) Priority for the SD card playback thread
- CONFIG_NRF_AUDIO_SD_CARD_LC3_STREAMER
(bool) Audio SD Card LC3 Streamer
- CONFIG_SD_CARD_LC3_STREAMER_STACK_SIZE
(int) Stack size for the SD card LC3 streamer thread
- CONFIG_SD_CARD_LC3_STREAMER_THREAD_PRIO
(int) Priority for the SD card LC3 streamer thread
- CONFIG_SD_CARD_LC3_STREAMER_MAX_NUM_STREAMS
(int) Maximum number of concurrent LC3 streams
- CONFIG_SD_CARD_LC3_STREAMER_MAX_FRAME_SIZE
(int) Maximum frame size for LC3 streams
- CONFIG_NRFX_NVMC
(unknown)
- CONFIG_FIFO_FRAME_SPLIT_NUM
(int) Number of blocks to make up one frame of audio data
Easy DMA in I2S requires two buffers to be filled before I2S transmission will begin. In order to reduce latency, an audio frame can be split into multiple blocks with this parameter. USB sends data in 1 ms blocks, so we need the split to match that. If we set frame size to 10 ms for USB, 20 is selected as FIFO_FRAME_SPLIT_NUM
- CONFIG_FIFO_TX_FRAME_COUNT
(int) Max number of audio frames in TX slab
FIFO_TX is the buffer that holds decoded audio data before it is sent to either I2S or USB
- CONFIG_FIFO_RX_FRAME_COUNT
(int) Max number of audio frames in RX slab
FIFO_RX is the buffer that holds uncompressed audio data coming from either I2S or USB
- CONFIG_PRINT_STACK_USAGE_MS
(int) Print stack usage every x milliseconds