Base Data Exported Functions

group Base_Data_Exported_Functions

Functions

bool base_data_add_group(uint8_t *p_group_idx, uint32_t presentation_delay)

Add base data group.

base_data_generate.h

参数:
  • p_group_idx -- [inout] Pointer to base data group index.

  • presentation_delay -- [in] Base data presentation delay.

返回值:
  • true -- Add base data group success.

  • false -- Add base data group failed.

返回:

The result of add base data group.

bool base_data_del_group(uint8_t group_idx)

Delete base data group.

base_data_generate.h

参数:

group_idx -- [in] Base data group index.

返回值:
  • true -- Delete base data group success.

  • false -- Delete base data group failed.

返回:

The result of delete base data group.

bool base_data_add_subgroup(uint8_t *p_subgroup_idx, uint8_t group_idx, uint8_t *codec_id, uint8_t codec_cfg_len, uint8_t *p_codec_cfg, uint8_t metadata_len, uint8_t *p_metadata)

Base data add subgroup.

base_data_generate.h

参数:
  • p_subgroup_idx -- [inout] Pointer to base data subgroup index.

  • group_idx -- [in] Base data group index.

  • codec_id -- [in] Pointer to codec id.

  • codec_cfg_len -- [in] Codec configuration length.

  • p_codec_cfg -- [in] Pointer to codec configuration.

  • metadata_len -- [in] Metadata length.

  • p_metadata -- [in] Pointer to metadata.

返回值:
  • true -- Base data add subgroup success.

  • false -- Base data add subgroup failed.

返回:

The result of base data add subgroup.

bool base_data_add_bis(uint8_t *p_bis_idx, uint8_t group_idx, uint8_t subgroup_idx, uint8_t codec_cfg_len, uint8_t *p_codec_cfg)

Base data add BIS.

base_data_generate.h

参数:
  • p_bis_idx -- [inout] Pointer to base data BIS index.

  • group_idx -- [in] Base data group index.

  • subgroup_idx -- [in] Pointer to codec id.

  • codec_cfg_len -- [in] Codec configuration length.

  • p_codec_cfg -- [in] Pointer to codec configuration.

返回值:
  • true -- Base data add BIS success.

  • false -- Base data add BIS failed.

返回:

The result of base data add BIS.

bool base_data_gen_pa_data(uint8_t group_idx, uint16_t *p_pa_len, uint8_t **pp_pa_data)

Base data generate periodic advertising data.

base_data_generate.h

参数:
  • group_idx -- [in] Base data group index.

  • p_pa_len -- [inout] Pointer to periodic advertising data length.

  • pp_pa_data -- [inout] Pointer to periodic advertising data.

返回值:
  • true -- Base data generate periodic advertising data success.

  • false -- Base data generate periodic advertising data failed.

返回:

The result of base data generate periodic advertising data.

bool base_data_update_metadata(uint8_t group_idx, uint8_t subgroup_idx, uint8_t metadata_len, uint8_t *p_metadata)

Base data update metadata.

base_data_generate.h

参数:
  • group_idx -- [in] Base data group index.

  • subgroup_idx -- [in] Base data subgroup index.

  • metadata_len -- [in] Metadata length.

  • p_metadata -- [in] Pointer to metadata.

返回值:
  • true -- Base data update metadata success.

  • false -- Base data update metadata failed.

返回:

The result of base data update metadata.

bool base_data_get_bis_num(uint8_t group_idx, uint8_t *p_bis_num)

Get base data BIS number.

base_data_generate.h

参数:
  • group_idx -- [in] Base data group index.

  • p_bis_num -- [inout] Pointer to base data BIS number.

返回值:
  • true -- Get base data BIS number success.

  • false -- Get base data BIS number failed.

返回:

The result of get base data BIS number.

T_BASE_DATA_MAPPING *base_data_parse_data(uint16_t pa_data_len, uint8_t *p_pa_data)

Base data parse data.

base_data_parse.h

参数:
  • pa_data_len -- [in] Periodic advertising data length.

  • p_pa_data -- [in] Pointer to periodic advertising data.

返回:

The pointer to base data mapping: T_BASE_DATA_MAPPING.

bool base_data_cmp(T_BASE_DATA_MAPPING *p_mapping_a, T_BASE_DATA_MAPPING *p_mapping_b)

Compare two base data mappings.

base_data_parse.h

参数:
返回值:
  • true -- Base data mappings are the same.

  • false -- Base data mappings are not the same.

返回:

The result of compare two base data mappings.

bool base_data_get_bis_codec_cfg(T_BASE_DATA_MAPPING *p_mapping, uint8_t bis_idx, T_CODEC_CFG *p_cfg)

Get base data BIS codec configuration.

base_data_parse.h

参数:
  • p_mapping -- [in] Pointer to base data mapping: T_BASE_DATA_MAPPING.

  • bis_idx -- [in] BIS index.

  • p_cfg -- [inout] Pointer to codec configuration: T_CODEC_CFG.

返回值:
  • true -- Get BIS codec configuration success.

  • false -- Get BIS codec configuration failed.

返回:

The result of get BIS codec configuration.

void base_data_free(T_BASE_DATA_MAPPING *p_mapping)

Free base data.

base_data_parse.h

参数:

p_mapping -- [in] Pointer to base data mapping: T_BASE_DATA_MAPPING.