Zephyr API Documentation 4.0.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
bt_iso_cig_param Struct Reference

Connected Isochronous Group (CIG) parameters. More...

#include <iso.h>

Data Fields

struct bt_iso_chan ** cis_channels
 Array of pointers to CIS channels.
 
uint8_t num_cis
 Number of channels in cis_channels.
 
uint32_t c_to_p_interval
 Channel interval in us for SDUs sent from Central to Peripheral.
 
uint32_t p_to_c_interval
 Channel interval in us for SDUs sent from Peripheral to Central.
 
uint16_t c_to_p_latency
 Channel Latency in ms for SDUs sent from Central to Peripheral.
 
uint16_t p_to_c_latency
 Channel Latency in ms for SDUs sent from Peripheral to Central.
 
uint8_t sca
 Channel peripherals sleep clock accuracy Only for CIS.
 
uint8_t packing
 Channel packing mode.
 
uint8_t framing
 Channel framing mode.
 
uint8_t c_to_p_ft
 Central to Peripheral flush timeout.
 
uint8_t p_to_c_ft
 Peripheral to Central flush timeout.
 
uint16_t iso_interval
 ISO interval.
 

Detailed Description

Connected Isochronous Group (CIG) parameters.

Field Documentation

◆ c_to_p_ft

uint8_t bt_iso_cig_param::c_to_p_ft

Central to Peripheral flush timeout.

The flush timeout in multiples of ISO_Interval for each payload sent from the Central to Peripheral.

Value range from BT_ISO_FT_MIN to BT_ISO_FT_MAX

◆ c_to_p_interval

uint32_t bt_iso_cig_param::c_to_p_interval

Channel interval in us for SDUs sent from Central to Peripheral.

Value range BT_ISO_SDU_INTERVAL_MIN to BT_ISO_SDU_INTERVAL_MAX.

◆ c_to_p_latency

uint16_t bt_iso_cig_param::c_to_p_latency

Channel Latency in ms for SDUs sent from Central to Peripheral.

Value range BT_ISO_LATENCY_MIN to BT_ISO_LATENCY_MAX.

This value is ignored if any advanced ISO parameters are set.

◆ cis_channels

struct bt_iso_chan** bt_iso_cig_param::cis_channels

Array of pointers to CIS channels.

◆ framing

uint8_t bt_iso_cig_param::framing

Channel framing mode.

BT_ISO_FRAMING_UNFRAMED for unframed and BT_ISO_FRAMING_FRAMED for framed.

◆ iso_interval

uint16_t bt_iso_cig_param::iso_interval

ISO interval.

Time between consecutive CIS anchor points.

Value range from BT_ISO_ISO_INTERVAL_MIN to BT_ISO_ISO_INTERVAL_MAX.

◆ num_cis

uint8_t bt_iso_cig_param::num_cis

Number of channels in cis_channels.

Maximum number of channels in a single group is BT_ISO_MAX_GROUP_ISO_COUNT

◆ p_to_c_ft

uint8_t bt_iso_cig_param::p_to_c_ft

Peripheral to Central flush timeout.

The flush timeout in multiples of ISO_Interval for each payload sent from the Peripheral to Central.

Value range from BT_ISO_FT_MIN to BT_ISO_FT_MAX.

◆ p_to_c_interval

uint32_t bt_iso_cig_param::p_to_c_interval

Channel interval in us for SDUs sent from Peripheral to Central.

Value range BT_ISO_SDU_INTERVAL_MIN to BT_ISO_SDU_INTERVAL_MAX.

◆ p_to_c_latency

uint16_t bt_iso_cig_param::p_to_c_latency

Channel Latency in ms for SDUs sent from Peripheral to Central.

Value range BT_ISO_LATENCY_MIN to BT_ISO_LATENCY_MAX.

This value is ignored if any advanced ISO parameters are set.

◆ packing

uint8_t bt_iso_cig_param::packing

◆ sca

uint8_t bt_iso_cig_param::sca

Channel peripherals sleep clock accuracy Only for CIS.

Shall be worst case sleep clock accuracy of all the peripherals. For possible values see the BT_GAP_SCA_* values. If unknown for the peripherals, this should be set to BT_GAP_SCA_UNKNOWN.


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