Zephyr API Documentation 3.7.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
bt_audio_codec_qos Struct Reference

Codec QoS structure. More...

#include <audio.h>

Data Fields

uint32_t pd
 Presentation Delay in microseconds.
 
struct { 
 
   enum bt_audio_codec_qos_framing   framing 
 QoS Framing. More...
 
   uint8_t   phy 
 PHY. More...
 
   uint8_t   rtn 
 Retransmission Number. More...
 
   uint16_t   sdu 
 Maximum SDU size. More...
 
   uint16_t   latency 
 Maximum Transport Latency. More...
 
   uint32_t   interval 
 SDU Interval. More...
 
   uint16_t   max_pdu 
 Maximum PDU size. More...
 
   uint8_t   burst_number 
 Burst number. More...
 
   uint8_t   num_subevents 
 Number of subevents. More...
 
};  
 Connected Isochronous Group (CIG) parameters.
 

Detailed Description

Codec QoS structure.

Field Documentation

◆ [struct]

struct { ... } bt_audio_codec_qos

Connected Isochronous Group (CIG) parameters.

The fields in this struct affect the value sent to the controller via HCI when creating the CIG. Once the group has been created with bt_bap_unicast_group_create(), modifying these fields will not affect the group.

◆ burst_number

uint8_t bt_audio_codec_qos::burst_number

Burst number.

Value range BT_ISO_BN_MIN to BT_ISO_BN_MAX.

◆ framing

enum bt_audio_codec_qos_framing bt_audio_codec_qos::framing

QoS Framing.

◆ interval

uint32_t bt_audio_codec_qos::interval

SDU Interval.

Value range BT_ISO_SDU_INTERVAL_MIN to BT_ISO_SDU_INTERVAL_MAX

◆ latency

uint16_t bt_audio_codec_qos::latency

Maximum Transport Latency.

Not used for the CONFIG_BT_BAP_BROADCAST_SINK role.

◆ max_pdu

uint16_t bt_audio_codec_qos::max_pdu

Maximum PDU size.

Maximum size, in octets, of the payload from link layer to link layer.

Value range BT_ISO_CONNECTED_PDU_MIN to BT_ISO_PDU_MAX for connected ISO.

Value range BT_ISO_BROADCAST_PDU_MIN to BT_ISO_PDU_MAX for broadcast ISO.

◆ num_subevents

uint8_t bt_audio_codec_qos::num_subevents

Number of subevents.

Maximum number of subevents in each CIS or BIS event.

Value range BT_ISO_NSE_MIN to BT_ISO_NSE_MAX.

◆ pd

uint32_t bt_audio_codec_qos::pd

Presentation Delay in microseconds.

This value can be changed up and until bt_bap_stream_qos() has been called. Once a stream has been QoS configured, modifying this field does not modify the value. It is however possible to modify this field and call bt_bap_stream_qos() again to update the value, assuming that the stream is in the correct state.

Value range 0 to BT_AUDIO_PD_MAX.

◆ phy

uint8_t bt_audio_codec_qos::phy

◆ rtn

uint8_t bt_audio_codec_qos::rtn

Retransmission Number.

This a recommendation to the controller, and the actual retransmission number may be different than this.

◆ sdu

uint16_t bt_audio_codec_qos::sdu

Maximum SDU size.

Value range BT_ISO_MIN_SDU to BT_ISO_MAX_SDU.


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