venc_get_roi_attr

Product	Supported (√/x)
Atlas A3 training products/Atlas A3 inference products	x
Atlas A2 training products/Atlas A2 inference products	x
Atlas training products	x
Atlas inference products	√
Atlas 200I/500 A2 inference products	√

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

C Prototype

hi_s32 hi_mpi_venc_get_roi_attr(hi_venc_chn chn, hi_u32 idx, hi_venc_roi_attr *roi_attr)

Python Function

roi_attr, ret = acl.himpi.venc_get_roi_attr(chn, idx)

Parameter	Description
chn	Int, encoding channel ID. Atlas inference products: The value range of the encoding channel ID is [0, 256). The JPEGE and VENC functions share the same channels, and the maximum number of channels is 256. Atlas 200I/500 A2 inference products: The value range of the encoding channel ID is [0, 128). The JPEGE and VENC functions share the same channels, and the maximum number of channels is 128.
idx	Int, index of the ROI for an H.264/H.265 encoding channel.

Return Value	Description
roi_attr	Dict, ROI parameter dictionary. For details, see hi_venc_roi_attr.
ret	Int, error code. 0: success. Other values: failures. For details, see VENC/JPEGE Return Codes.

Return Value

Description

roi_attr

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

ret

Int, error code.

This API is used to obtain the configuration of an ROI with a specified index in an H.264/H.265 encoding channel.

Call this API after an encoding channel is created and before the channel is destroyed.

You are advised to call this MPI after creating a channel but before starting encoding. This reduces the number of times of calling this MPI during encoding.

Parent topic: VENC/JPEGE APIs