Segment_Interesting

Detailed Description

group Segment_Interesting

Function Documentation

void HIC_Set_Segment_Interesting(HIC_Rendition const *nr, HIC_Segment_Info const *si)

This function sets a segment to interesting.

Parameters:
  • nr – A pointer to a const HIC_Rendition.
  • si – A pointer to a const HIC_Segment_Info.
void HIC_UnSet_Segment_Interesting(HIC_Rendition const *nr, HIC_Segment_Info const *si)

This function sets a segment to not interesting.

Parameters:
  • nr – A pointer to a const HIC_Rendition.
  • si – A pointer to a const HIC_Segment_Info.
int HIC_Check_Segment_Interesting(HIC_Rendition const *nr, HIC_Segment_Info const *si)

This function returns a boolean, true if segment is interesting, false if segment is not interesting.

Parameters:
  • nr – A pointer to a const HIC_Rendition.
  • si – A pointer to a const HIC_Segment_Info.
Returns:

A boolean, true if segment is interesting, otherwise false.