hi_mpi_venc_set_mod_param

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

Sets the encoding module parameters.

Ensure that this API is called before any channel is created. Otherwise, the error code HI_ERR_VENC_NOT_PERM is returned. Before calling this API, you are advised to call hi_mpi_venc_get_mod_param to obtain the encoding module parameter settings of the current channel, and then set the parameters as required.

Prototype

hi_s32 hi_mpi_venc_set_mod_param (const hi_venc_mod_param *mod_param)

Parameters

Parameter	Input/Output	Description
mod_param	Input	Pointer to the encoding module parameters.

Returns

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

Restrictions

This API is set at the global level. In the multi-process scenario:

After this API is called in a process to set parameters, the parameters take effect in other processes.
If process B calls hi_mpi_venc_set_mod_param after process A creates a channel, process B returns an error indicating invalid setting. However, process B continues encoding based on the default value or the parameter value that is successfully set in other processes. In this case, if process B is required to call the hi_mpi_venc_set_mod_param API to adjust parameter values, the channels in other processes must be destroyed first.