Zephyr API Documentation  3.7.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
bt_iso_big_sync_param Struct Reference

Broadcast Isochronous Group (BIG) Sync Parameters. More...

#include <iso.h>

Data Fields

struct bt_iso_chan ** bis_channels
 Array of pointers to BIS channels.
 
uint8_t num_bis
 Number channels in bis_channels.
 
uint32_t bis_bitfield
 Bitfield of the BISes to sync to.
 
uint32_t mse
 Maximum subevents.
 
uint16_t sync_timeout
 Synchronization timeout for the BIG (N * 10 MS)
 
bool encryption
 Whether or not the streams of the BIG are encrypted.
 
uint8_t bcode [16]
 Broadcast code.
 

Detailed Description

Broadcast Isochronous Group (BIG) Sync Parameters.

Field Documentation

◆ bcode

uint8_t bt_iso_big_sync_param::bcode[16]

Broadcast code.

The code used to derive the session key that is used to encrypt and decrypt BIS payloads.

If the value is a string or a the value is less than 16 octets, the remaining octets shall be 0.

Example: The string "Broadcast Code" shall be [42 72 6F 61 64 63 61 73 74 20 43 6F 64 65 00 00]

◆ bis_bitfield

uint32_t bt_iso_big_sync_param::bis_bitfield

Bitfield of the BISes to sync to.

The BIS indexes start from 0x01, so the lowest allowed bit is BIT(1) that represents index 0x01. To synchronize to e.g. BIS indexes 0x01 and 0x02, the bitfield value should be BIT(1) | BIT(2).

◆ bis_channels

struct bt_iso_chan** bt_iso_big_sync_param::bis_channels

Array of pointers to BIS channels.

◆ encryption

bool bt_iso_big_sync_param::encryption

Whether or not the streams of the BIG are encrypted.

◆ mse

uint32_t bt_iso_big_sync_param::mse

Maximum subevents.

The MSE (Maximum Subevents) parameter is the maximum number of subevents that a Controller should use to receive data payloads in each interval for a BIS.

Value range is BT_ISO_SYNC_MSE_MIN to BT_ISO_SYNC_MSE_MAX, or BT_ISO_SYNC_MSE_ANY to let the controller choose.

◆ num_bis

uint8_t bt_iso_big_sync_param::num_bis

Number channels in bis_channels.

Maximum number of channels in a single group is BT_ISO_MAX_GROUP_ISO_COUNT

◆ sync_timeout

uint16_t bt_iso_big_sync_param::sync_timeout

Synchronization timeout for the BIG (N * 10 MS)

Value range is BT_ISO_SYNC_TIMEOUT_MIN to BT_ISO_SYNC_TIMEOUT_MAX.


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