StreamConfigurationMap.GetOutputMinFrameDuration Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| GetOutputMinFrameDuration(Class, Size) |
Get the minimum |
| GetOutputMinFrameDuration(Int32, Size) |
Get the minimum |
GetOutputMinFrameDuration(Class, Size)
Get the minimum CaptureRequest#SENSOR_FRAME_DURATION frame duration
for the class/size combination (in nanoseconds).
[Android.Runtime.Register("getOutputMinFrameDuration", "(Ljava/lang/Class;Landroid/util/Size;)J", "")]
[Java.Interop.JavaTypeParameters(new System.String[] { "T" })]
public long GetOutputMinFrameDuration(Java.Lang.Class? klass, Android.Util.Size? size);
[<Android.Runtime.Register("getOutputMinFrameDuration", "(Ljava/lang/Class;Landroid/util/Size;)J", "")>]
[<Java.Interop.JavaTypeParameters(new System.String[] { "T" })>]
member this.GetOutputMinFrameDuration : Java.Lang.Class * Android.Util.Size -> int64
Parameters
- klass
- Class
a class which is supported by #isOutputSupportedFor(Class) and has a
non-empty array returned by #getOutputSizes(Class)
- size
- Size
an output-compatible size
Returns
a minimum frame duration > 0 in nanoseconds, or
0 if the minimum frame duration is not available.
- Attributes
Remarks
Get the minimum CaptureRequest#SENSOR_FRAME_DURATION frame duration for the class/size combination (in nanoseconds).
This assumes that the klass is set up to use ImageFormat#PRIVATE. For user-defined formats, use #getOutputMinFrameDuration(int, Size).
klass should be one of the ones which is supported by #isOutputSupportedFor(Class).
size should be one of the ones returned by #getOutputSizes(int).
This corresponds to the minimum frame duration (maximum frame rate) possible when only that stream is configured in a session, with all processing (typically in android.*.mode) set to either OFF or FAST.
When multiple streams are used in a session, the minimum frame duration will be max(individual stream min durations). See #getOutputStallDuration for details of timing for formats that may cause frame rate slowdown when they are targeted by a capture request.
For devices that do not support manual sensor control (android.hardware.camera2.CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_MANUAL_SENSOR), this function may return 0.
The minimum frame duration of a stream (of a particular format, size) is the same regardless of whether the stream is input or output.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Applies to
GetOutputMinFrameDuration(Int32, Size)
Get the minimum CaptureRequest#SENSOR_FRAME_DURATION frame duration
for the format/size combination (in nanoseconds).
[Android.Runtime.Register("getOutputMinFrameDuration", "(ILandroid/util/Size;)J", "")]
public long GetOutputMinFrameDuration(int format, Android.Util.Size? size);
[<Android.Runtime.Register("getOutputMinFrameDuration", "(ILandroid/util/Size;)J", "")>]
member this.GetOutputMinFrameDuration : int * Android.Util.Size -> int64
Parameters
- format
- Int32
an image format from ImageFormat or PixelFormat
- size
- Size
an output-compatible size
Returns
a minimum frame duration > 0 in nanoseconds, or
0 if the minimum frame duration is not available.
- Attributes
Exceptions
if format or size was not supported
if size was null
Remarks
Get the minimum CaptureRequest#SENSOR_FRAME_DURATION frame duration for the format/size combination (in nanoseconds).
format should be one of the ones returned by #getOutputFormats().
size should be one of the ones returned by #getOutputSizes(int).
This corresponds to the minimum frame duration (maximum frame rate) possible when only that stream is configured in a session, with all processing (typically in android.*.mode) set to either OFF or FAST.
When multiple streams are used in a session, the minimum frame duration will be max(individual stream min durations). See #getOutputStallDuration for details of timing for formats that may cause frame rate slowdown when they are targeted by a capture request.
For devices that do not support manual sensor control (android.hardware.camera2.CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_MANUAL_SENSOR), this function may return 0.
The minimum frame duration of a stream (of a particular format, size) is the same regardless of whether the stream is input or output.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
See also
- SensorFrameDuration
- <xref:Android.Hardware.Camera2.Params.StreamConfigurationMap.GetOutputStallDuration(System.Int32%2c+Android.Util.Size)>
- ImageFormat
- PixelFormat