◆ sdc_hci_cmd_le_terminate_big()

uint8_t sdc_hci_cmd_le_terminate_big ( const sdc_hci_cmd_le_terminate_big_t * p_params )

#include <softdevice_controller/include/sdc_hci_cmd_le.h>

LE Terminate BIG.

The description below is extracted from Core_v6.3, Vol 4, Part E, Section 7.8.105

This command is used to terminate a BIG identified by the BIG_Handle parameter. The command also terminates the transmission of all BISes of the BIG, destroys the associated connection handles of the BISes in the BIG and removes the data paths for all BISes in the BIG.

The Reason parameter is used to indicate the reason why the BIG is to be terminated.

Errors:

See Section 4.5.2 for a list of error types and descriptions.

Type   Condition                                                      Error code
MC     BIG_Handle does not identify a BIG.                            Unknown Advertising
                                                                      Identifier (0x42)
MC     The Controller is not the Isochronous Broadcaster for the      Command Disallowed (0x0C)
       BIG identified by BIG_Handle.

Event(s) generated (unless masked away):

When the Controller receives the HCI_LE_Terminate_BIG command, the Controller sends the HCI_Command_Status event to the Host.

When the HCI_LE_Terminate_BIG command has completed, the HCI_LE_Terminate_BIG_Complete event will be generated.

If the Host attempts to terminate a BIG while the process of establishment of the BIG is in progress (i.e. HCI_LE_Create_BIG_Complete event has not been generated) the process of establishment shall stop and the Controller shall generate the HCI_LE_- Create_BIG_Complete event to the Host with the error code Operation Cancelled by Host (0x44).

Parameters

[in] p_params Input parameters.

Return values

0	if success.

Returns: Returns value between 0x01-0xFF in case of error. See Vol 2, Part D, Error for a list of error codes and descriptions.