roi

(H.264 only) The roi command is used to create a static region of interest (one per video encoder) to enhance the quality of the encoded video within the region. This allows you to choose what portion of the image is important to have maximum quality.

The region position can either be relative (top left, top right, centered, etc.) or absolute (positioned at the exact X and Y coordinates specified). You can also specify the scaling and transparency display settings.

Synopsis

roi create
roi ID set [parameter=value]
roi ID delete
roi ID get
roi ID enable
roi ID disable

Actions

Action	Description
create	Creates a region of interest on an encoder.
set	Configures ROI parameters. A series of one or more `parameter=value` pairs can be specified at once. See Parameters below.
delete	Removes the region of interest.
get	Displays information on the region of interest.
enable	Enables a created but disabled region of interest
disable	Disables a created region of interest

Parameters

Parameter	Default	Description/Values
`name`	n/a	Optional name for this region of interest.
`encoder`	n/a	Specifies the ID of the video encoder.
`type`	normal	Specifies the effect of the region: normal: ROI is translucent, therefore enhances the video in the region. privacy: ROI is opaque to block out the ROI video.
`emphasis`	4	Sets the difference in quality between the background and the ROI. 1 to 8
`positioning`	Centered	Specifies where the region should appear: BottomRight TopRight BottomLeft Centered Absolute: Uses the exact X and Y coordinates.
`x`	910	Horizontal coordinate of the top left point of the region in Absolute mode.
`y`	490	Vertical coordinate of the top left point of the region in absolute mode.
`width`	100	Width in pixels of the region of interest.
`height`	100	Height in pixels of the region of interest.
`border`	none	Applies a border to the region: `none, corners, box`
`enable`	on	Enables the region of interest. `on,off`.

Example

# roi 0 set type=privacy

Sets the region of interest type to privacy, i.e., opaque to block out the ROI video.

Related Topics

Region of Interest (ROI) (H.264 only) under Video Encoder Settings