hi_mpi_rgn_attach_to_chn

Applicability

Product

Supported

Atlas 350 Accelerator Card

Atlas A3 training product / Atlas A3 inference product

Atlas A2 training product / Atlas A2 inference product

Atlas 200I/500 A2 inference product

Atlas inference product

Atlas training product

Function Description

Overlays a region on a channel.

This API is not supported in the Ascend EP form of Atlas 200I/500 A2 inference product .

Prototype

hi_s32 hi_mpi_rgn_attach_to_chn(hi_rgn_handle handle, const hi_mpp_chn *chn, const hi_rgn_chn_attr *chn_attr)

Parameters

Parameter

Input/Output

Description

handle

Input

Region handle ID.

Value range: [0, 1024)

chn

Input

Pointer to the channel structure. The parameter cannot be null.

For details about how to set this parameter, see Table 2.

chn_attr

Input

Pointer to the channel display attributes of a region. The parameter cannot be empty.

Returns

Restrictions

  • The regions must be created before you call this API.
  • This API can be called for multiple times. However, this API cannot be used to change the attributes of the region created by calling hi_mpi_rgn_create.
  • If a region is repeatedly overlaid on a specified channel, a code indicating success is returned after this API is called, but the previously configured channel display attributes of the region are not changed.
  • A maximum of four MOSAIC regions can be bound to the same channel.
  • A maximum of eight COVER regions can be bound to the same channel.
  • A maximum of eight OVERLAYEX regions can be bound to the same channel.

See Also

For details about the API call sequence, see Video Decoding, Processing, and Display (NVR Scenario).