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

Broadcast Isochronous Group (BIG) creation parameters. More...

#include <iso.h>

Data Fields

struct bt_iso_chan ** bis_channels
 Array of pointers to BIS channels.
 
uint8_t num_bis
 Number of channels in bis_channels.
 
uint32_t interval
 Channel interval in us.
 
uint16_t latency
 Channel Latency in ms.
 
uint8_t packing
 Channel packing mode.
 
uint8_t framing
 Channel framing mode.
 
bool encryption
 Whether or not to encrypt the streams.
 
uint8_t bcode [16]
 Broadcast code.
 
uint8_t irc
 Immediate Repetition Count.
 
uint8_t pto
 Pre-transmission offset.
 
uint16_t iso_interval
 ISO interval.
 

Detailed Description

Broadcast Isochronous Group (BIG) creation parameters.

Field Documentation

◆ bcode

uint8_t bt_iso_big_create_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 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_channels

struct bt_iso_chan** bt_iso_big_create_param::bis_channels

Array of pointers to BIS channels.

◆ encryption

bool bt_iso_big_create_param::encryption

Whether or not to encrypt the streams.

◆ framing

uint8_t bt_iso_big_create_param::framing

Channel framing mode.

BT_ISO_FRAMING_UNFRAMED for unframed and BT_ISO_FRAMING_FRAMED for framed.

◆ interval

uint32_t bt_iso_big_create_param::interval

Channel interval in us.

Value range BT_ISO_SDU_INTERVAL_MIN to BT_ISO_SDU_INTERVAL_MAX.

◆ irc

uint8_t bt_iso_big_create_param::irc

Immediate Repetition Count.

The number of times the scheduled payloads are transmitted in a given event.

Value range from BT_ISO_IRC_MIN to BT_ISO_IRC_MAX.

◆ iso_interval

uint16_t bt_iso_big_create_param::iso_interval

ISO interval.

Time between consecutive BIS anchor points.

Value range from BT_ISO_ISO_INTERVAL_MIN to BT_ISO_ISO_INTERVAL_MAX.

◆ latency

uint16_t bt_iso_big_create_param::latency

Channel Latency in ms.

Value range BT_ISO_LATENCY_MIN to BT_ISO_LATENCY_MAX.

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

◆ num_bis

uint8_t bt_iso_big_create_param::num_bis

Number of channels in bis_channels.

Maximum number of channels in a single group is BT_ISO_MAX_GROUP_ISO_COUNT

◆ packing

uint8_t bt_iso_big_create_param::packing

◆ pto

uint8_t bt_iso_big_create_param::pto

Pre-transmission offset.

Offset used for pre-transmissions.

Value range from BT_ISO_PTO_MIN to BT_ISO_PTO_MAX.


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