venc_get_roi_attr

Applicability

Product

Supported

Atlas 350 Accelerator Card

x

Atlas A3 training product/Atlas A3 inference product

x

Atlas A2 training product/Atlas A2 inference product

x

Atlas training product

x

Atlas inference product

Atlas 200I/500 A2 inference product

Description

Obtains the ROI attributes of an H.264/H.265 channel. For details about the ROI encoding function, see ROI Encoding Function.

Prototype

  • C Prototype
    1
    hi_s32 hi_mpi_venc_get_roi_attr(hi_venc_chn chn, hi_u32 idx, hi_venc_roi_attr *roi_attr)
    
  • Python Function
    1
    roi_attr, ret = acl.himpi.venc_get_roi_attr(chn, idx)
    

Parameters

Parameter

Description

chn

Int, encoding channel ID.
  • For the Atlas inference product, the value range of the encoding channel ID is [0, 256). The JPEGE and VENC functions share channels. The maximum number of channels is 256.
  • For the Atlas 200I/500 A2 inference product, the value range of the encoding channel ID is [0, 128). The JPEGE and VENC functions share channels. The maximum number of channels is 128.

idx

Int, index of the ROI for an H.264/H.265 encoding channel.

Return Value

Return Value

Description

roi_attr

Dict, ROI parameter dictionary. For details, see hi_venc_roi_attr.

ret

Int, error code.

Restrictions

  • This API is used to obtain the configuration of an ROI with a specified index in an H.264/H.265 encoding channel.
  • This API must be called after an encoding channel is created and before the channel is destroyed.
  • It is recommended that this API be called after an encoding channel is created and before encoding is started, to reduce the number of the API calls during encoding.