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

Parameters for * bt_cap_initiator_broadcast_audio_create() More...

#include <cap.h>

Data Fields

size_t subgroup_count
 The number of parameters in subgroup_params.
 
struct bt_cap_initiator_broadcast_subgroup_paramsubgroup_params
 Array of stream parameters.
 
struct bt_bap_qos_cfgqos
 Quality of Service configuration.
 
uint8_t packing
 Broadcast Source packing mode.
 
bool encryption
 Whether or not to encrypt the streams.
 
uint8_t broadcast_code [BT_ISO_BROADCAST_CODE_SIZE]
 16-octet broadcast code.
 
uint8_t irc
 Immediate Repetition Count.
 
uint8_t pto
 Pre-transmission offset.
 
uint16_t iso_interval
 ISO interval.
 

Detailed Description

Field Documentation

◆ broadcast_code

uint8_t bt_cap_initiator_broadcast_create_param::broadcast_code[BT_ISO_BROADCAST_CODE_SIZE]

16-octet broadcast code.

Only valid if encrypt is true.

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]

◆ encryption

bool bt_cap_initiator_broadcast_create_param::encryption

Whether or not to encrypt the streams.

◆ irc

uint8_t bt_cap_initiator_broadcast_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_cap_initiator_broadcast_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.

◆ packing

uint8_t bt_cap_initiator_broadcast_create_param::packing

Broadcast Source packing mode.

BT_ISO_PACKING_SEQUENTIAL or BT_ISO_PACKING_INTERLEAVED.

Note
This is a recommendation to the controller, which the controller may ignore.

◆ pto

uint8_t bt_cap_initiator_broadcast_create_param::pto

Pre-transmission offset.

Offset used for pre-transmissions.

Value range from BT_ISO_PTO_MIN to BT_ISO_PTO_MAX.

◆ qos

struct bt_bap_qos_cfg* bt_cap_initiator_broadcast_create_param::qos

Quality of Service configuration.

◆ subgroup_count

size_t bt_cap_initiator_broadcast_create_param::subgroup_count

The number of parameters in subgroup_params.

◆ subgroup_params

struct bt_cap_initiator_broadcast_subgroup_param* bt_cap_initiator_broadcast_create_param::subgroup_params

Array of stream parameters.


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