FakeStreamConfigurationMap

Artifact: androidx.camera:camera-common-testing

View Source

Added in 1.7.0-alpha03

---

Kotlin |Java

class FakeStreamConfigurationMap : StreamConfigurationMapWrapper

---

A fake implementation of StreamConfigurationMapWrapper for testing.

This class enables a developer to specify a table of input and output formats, along with the properties associated with them.

Example

val fakeMap = FakeStreamConfigurationMap(
    outputsTable = linkedMapOf(
        OutputKey(ImageFormat.YUV_420_888, Size(1920, 1080)) to OutputValues(),
        OutputKey(ImageFormat.JPEG, Size(1920, 1080)) to OutputValues(
            stallDuration = 200000000L // 200ms stall duration for JPEG
        )
    )
)

Summary

Nested types
class FakeStreamConfigurationMap.InputTableEntry Defines a single entry for a valid input format for testing purposes.
class FakeStreamConfigurationMap.OutputKey Key used to identify an output configuration in FakeStreamConfigurationMap.
class FakeStreamConfigurationMap.OutputValues Values associated with an output configuration in FakeStreamConfigurationMap.

Public constructors
FakeStreamConfigurationMap(     outputsTable: LinkedHashMap<FakeStreamConfigurationMap.OutputKey, FakeStreamConfigurationMap.OutputValues>,     inputTable: List<FakeStreamConfigurationMap.InputTableEntry>,     outputFormatsForInputFormats: Map<Int, List<Int>>,     outputClassTypes: Set<Class<*>> )

Public functions
open List<Size>	getHighResolutionOutputSizes(format: Int)
open List<Range<Int>>	getHighSpeedVideoFpsRanges()
open List<Range<Int>>	getHighSpeedVideoFpsRangesFor(size: Size)
open List<Size>	getHighSpeedVideoSizes()
open List<Size>	getHighSpeedVideoSizesFor(fpsRange: Range<Int>)
open List<Int>	getInputFormats()
open List<Size>	getInputSizes(format: Int)
open List<Int>	getOutputFormats()
open Long	getOutputMinFrameDuration(format: Int, size: Size)
open Long	<T : Any?> getOutputMinFrameDuration(klass: Class<T>, size: Size)
open List<Size>	getOutputSizes(format: Int)
open List<Size>	<T : Any?> getOutputSizes(klass: Class<T>)
open Long	getOutputStallDuration(format: Int, size: Size)
open Long	<T : Any?> getOutputStallDuration(klass: Class<T>, size: Size)
open List<Int>	getValidOutputFormatsForInput(inputFormat: Int)
open Boolean	isOutputSupportedFor(format: Int)
open Boolean	<T : Any?> isOutputSupportedFor(klass: Class<T>) Converting this method to non-static for testability.
open Boolean	isOutputSupportedFor(surface: Surface)
open T?	<T : Any> unwrapAs(type: Class<T>) Attempts to unwrap this object into the specified underlying type.

Public constructors

FakeStreamConfigurationMap

FakeStreamConfigurationMap(
    outputsTable: LinkedHashMap<FakeStreamConfigurationMap.OutputKey, FakeStreamConfigurationMap.OutputValues>,
    inputTable: List<FakeStreamConfigurationMap.InputTableEntry> = emptyList(),
    outputFormatsForInputFormats: Map<Int, List<Int>> = emptyMap(),
    outputClassTypes: Set<Class<*>> = emptySet()
)

Parameters
outputsTable: LinkedHashMap<FakeStreamConfigurationMap.OutputKey, FakeStreamConfigurationMap.OutputValues>	The map of supported outputs, mapping OutputKey to OutputValues. Must be a LinkedHashMap to preserve insertion order. Used by output-related queries (e.g., getOutputFormats, getOutputSizes, getOutputMinFrameDuration).
inputTable: List<FakeStreamConfigurationMap.InputTableEntry> = emptyList()	The list of supported inputs. Used by getInputFormats and getInputSizes.
outputFormatsForInputFormats: Map<Int, List<Int>> = emptyMap()	Mapping of input formats to their valid output formats. Used by getValidOutputFormatsForInput.
outputClassTypes: Set<Class<*>> = emptySet()	Set of class types that are supported as outputs. Used by isOutputSupportedFor (class-based queries) and getOutputMinFrameDuration (class-based queries). Class-based queries internally map to GraphicsImageFormat.PRIVATE.

Public functions

getHighResolutionOutputSizes

Added in 1.7.0-alpha03

open fun getHighResolutionOutputSizes(format: Int): List<Size>

See also
getHighResolutionOutputSizes

getHighSpeedVideoFpsRanges

Added in 1.7.0-alpha03

open fun getHighSpeedVideoFpsRanges(): List<Range<Int>>

See also
getHighSpeedVideoFpsRanges

getHighSpeedVideoFpsRangesFor

Added in 1.7.0-alpha03

open fun getHighSpeedVideoFpsRangesFor(size: Size): List<Range<Int>>

See also
getHighSpeedVideoFpsRangesFor

getHighSpeedVideoSizes

Added in 1.7.0-alpha03

open fun getHighSpeedVideoSizes(): List<Size>

See also
getHighSpeedVideoSizes

getHighSpeedVideoSizesFor

Added in 1.7.0-alpha03

open fun getHighSpeedVideoSizesFor(fpsRange: Range<Int>): List<Size>

See also
getHighSpeedVideoSizesFor

getInputFormats

Added in 1.7.0-alpha03

open fun getInputFormats(): List<Int>

See also
getInputFormats

getInputSizes

Added in 1.7.0-alpha03

open fun getInputSizes(format: Int): List<Size>

See also
getInputSizes

getOutputFormats

Added in 1.7.0-alpha03

open fun getOutputFormats(): List<Int>

See also
getOutputFormats

getOutputMinFrameDuration

Added in 1.7.0-alpha03

open fun getOutputMinFrameDuration(format: Int, size: Size): Long

See also
getOutputMinFrameDuration

getOutputMinFrameDuration

Added in 1.7.0-alpha03

open fun <T : Any?> getOutputMinFrameDuration(klass: Class<T>, size: Size): Long

See also
getOutputMinFrameDuration

getOutputSizes

Added in 1.7.0-alpha03

open fun getOutputSizes(format: Int): List<Size>

See also
getOutputSizes

getOutputSizes

Added in 1.7.0-alpha03

open fun <T : Any?> getOutputSizes(klass: Class<T>): List<Size>

See also
getOutputSizes

getOutputStallDuration

Added in 1.7.0-alpha03

open fun getOutputStallDuration(format: Int, size: Size): Long

See also
getOutputStallDuration

getOutputStallDuration

Added in 1.7.0-alpha03

open fun <T : Any?> getOutputStallDuration(klass: Class<T>, size: Size): Long

See also
getOutputStallDuration

getValidOutputFormatsForInput

Added in 1.7.0-alpha03

open fun getValidOutputFormatsForInput(inputFormat: Int): List<Int>

See also
getValidOutputFormatsForInput

isOutputSupportedFor

Added in 1.7.0-alpha03

open fun isOutputSupportedFor(format: Int): Boolean

See also
isOutputSupportedFor

isOutputSupportedFor

Added in 1.7.0-alpha03

open fun <T : Any?> isOutputSupportedFor(klass: Class<T>): Boolean

Converting this method to non-static for testability.

See also
isOutputSupportedFor

isOutputSupportedFor

Added in 1.7.0-alpha03

open fun isOutputSupportedFor(surface: Surface): Boolean

See also
isOutputSupportedFor

unwrapAs

Added in 1.7.0-alpha03

open fun <T : Any> unwrapAs(type: Class<T>): T?

Attempts to unwrap this object into the specified underlying type.

Callers should use this method to retrieve the wrapped platform object.

Implementation Notes

• If the requested type is not supported by this wrapper, this method must return null.

• Implementations designed for testing (e.g., fakes, mocks, or no-op wrappers) should return null to signal that no real underlying object is available.

Parameters
<T : Any>	The expected type of the underlying object.
type: Class<T>	The Class representing the expected type of the underlying object.

Returns
T?	The underlying object cast to T, or null if the object cannot be unwrapped into the requested type.