hi_mpi_venc_get_roi_attr

Applicability

Product	Supported
Atlas A3 training products/Atlas A3 inference products	☓
Atlas A2 training products/Atlas A2 inference products	☓
Atlas 200I/500 A2 inference products	√
Atlas inference products	√
Atlas training products	☓

Description

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

Call this API 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. This can reduce the number of API calls during encoding.

Prototype

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

Parameters

Parameter	Input/Output	Description
chn	Input	Encoding channel ID. 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. 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.
idx	Input	Index of the ROI for an H.264/H.265 encoding channel.
roi_attr	Output	Pointer to the ROI parameters.

Parameter

Input/Output

Description

chn

Input

Encoding channel ID.

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.

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.

idx

Input

Index of the ROI for an H.264/H.265 encoding channel.

roi_attr

Output

Pointer to the ROI parameters.

Returns

0: success
Other values: failure. For details, see VENC/JPEGE Return Codes.

Parent topic: Video Encoding (VENC) and JPEG Encoder (JPEGE)