Stay organized with collections
Save and categorize content based on your preferences.
QpOffsetRect
class QpOffsetRect
QpOffsetRect constitutes the metadata required for encoding a region of interest in an image or a video frame. The region of interest is represented by a rectangle. The four integer coordinates of the rectangle are stored in fields left, top, right, bottom. Note that the right and bottom coordinates are exclusive. This is paired with a suggestive qp offset information that is to be used during encoding of the blocks belonging to the to the box.
Summary
| Public constructors |
|
Create a new region of interest with the specified coordinates and qpOffset.
|
| Public methods |
| String |
|
| static String |
|
| Unit |
Update the region of interest information with the specified coordinates and qpOffset
|
Public constructors
QpOffsetRect
QpOffsetRect(
contour: Rect,
qpOffset: Int)
Create a new region of interest with the specified coordinates and qpOffset. Note: no range checking is performed, so the caller must ensure that left >= 0, left <= right, top >= 0 and top <= bottom. Note that the right and bottom coordinates are exclusive.
| Parameters |
contour |
Rect: Rectangle specifying the region of interest This value cannot be null. |
qpOffset |
Int: qpOffset to be used for the blocks in the specified rectangle |
Public methods
flattenToString
fun flattenToString(): String
| Return |
String |
Return a string representation of qpOffsetRect in a compact form. Helper function to insert key #PARAMETER_KEY_QP_OFFSET_RECTS in MediaFormat This value cannot be null. |
flattenToString
static fun flattenToString(qpOffsetRects: MutableList<MediaFormat.QpOffsetRect!>): String
| Return |
String |
Return a string representation of qpOffsetRect in a compact form. Helper function to insert key #PARAMETER_KEY_QP_OFFSET_RECTS in MediaFormat This value cannot be null. |
set
fun set(
contour: Rect,
qpOffset: Int
): Unit
Update the region of interest information with the specified coordinates and qpOffset
| Parameters |
contour |
Rect: Rectangle specifying the region of interest This value cannot be null. |
qpOffset |
Int: qpOffset to be used for the blocks in the specified rectangle |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# MediaFormat.QpOffsetRect\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nQpOffsetRect\n============\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/media/MediaFormat.QpOffsetRect \"View this page in Java\") \n\n```\nclass QpOffsetRect\n```\n\n|---|---------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [android.media.MediaFormat.QpOffsetRect](#) |\n\nQpOffsetRect constitutes the metadata required for encoding a region of interest in an image or a video frame. The region of interest is represented by a rectangle. The four integer coordinates of the rectangle are stored in fields left, top, right, bottom. Note that the right and bottom coordinates are exclusive. This is paired with a suggestive qp offset information that is to be used during encoding of the blocks belonging to the to the box.\n\nSummary\n-------\n\n| Public constructors ||\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| [QpOffsetRect](#QpOffsetRect(android.graphics.Rect,%20kotlin.Int))`(`contour:` `[Rect](../graphics/Rect.html#)`, `qpOffset:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Create a new region of interest with the specified coordinates and qpOffset. |\n\n| Public methods ||\n|-----------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [flattenToString](#flattenToString())`()` \u003cbr /\u003e |\n| static [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [flattenToString](#flattenToString(kotlin.collections.MutableList))`(`qpOffsetRects:` `[MutableList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)\u003c[MediaFormat.QpOffsetRect](#)!\u003e`)` \u003cbr /\u003e |\n| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [set](#set(android.graphics.Rect,%20kotlin.Int))`(`contour:` `[Rect](../graphics/Rect.html#)`, `qpOffset:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Update the region of interest information with the specified coordinates and qpOffset |\n\nPublic constructors\n-------------------\n\n### QpOffsetRect\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nQpOffsetRect(\n contour: Rect, \n qpOffset: Int)\n```\n\nCreate a new region of interest with the specified coordinates and qpOffset. Note: no range checking is performed, so the caller must ensure that left \\\u003e= 0, left \\\u003c= right, top \\\u003e= 0 and top \\\u003c= bottom. Note that the right and bottom coordinates are exclusive.\n\n| Parameters ||\n|------------|-------------------------------------------------------------------------------------------------------------------------------------------|\n| `contour` | [Rect](../graphics/Rect.html#): Rectangle specifying the region of interest This value cannot be `null`. |\n| `qpOffset` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): qpOffset to be used for the blocks in the specified rectangle |\n\nPublic methods\n--------------\n\n### flattenToString\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun flattenToString(): String\n```\n\n| Return ||\n|----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | Return a string representation of qpOffsetRect in a compact form. Helper function to insert key #PARAMETER_KEY_QP_OFFSET_RECTS in MediaFormat This value cannot be `null`. |\n\n### flattenToString\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic fun flattenToString(qpOffsetRects: MutableList\u003cMediaFormat.QpOffsetRect!\u003e): String\n```\n\n| Parameters ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `qpOffsetRects` | [MutableList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)\\\u003c[MediaFormat.QpOffsetRect](#)!\\\u003e: This value cannot be `null`. |\n\n| Return ||\n|----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | Return a string representation of qpOffsetRect in a compact form. Helper function to insert key #PARAMETER_KEY_QP_OFFSET_RECTS in MediaFormat This value cannot be `null`. |\n\n### set\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun set(\n contour: Rect, \n qpOffset: Int\n): Unit\n```\n\nUpdate the region of interest information with the specified coordinates and qpOffset\n\n| Parameters ||\n|------------|-------------------------------------------------------------------------------------------------------------------------------------------|\n| `contour` | [Rect](../graphics/Rect.html#): Rectangle specifying the region of interest This value cannot be `null`. |\n| `qpOffset` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): qpOffset to be used for the blocks in the specified rectangle |"]]
