LowLightBoostClient

@DoNotMock(value = "Use canonical fakes instead.")
interface LowLightBoostClient : HasApiKey, OptionalModuleApi

The Low Light Boost client is used to provide availability checks and module installation. The client also provides a way to create a LowLightBoostSession.

Summary

Nested types

A callback for the module installation status.

Public functions
Task<LowLightBoostSession?>
createSession(
    options: LowLightBoostOptions,
    callback: LowLightBoostCallback
)

Creates a LowLightBoostSession.
Task<Boolean>
installModule(
    context: Context,
    installStatusCallback: LowLightBoostClient.InstallStatusCallback?
)

Installs the LowLightBoost module.
Task<Boolean>

Queries whether a camera supports low light boost.
Task<Boolean>

Checks if the module is supported on this device.
Task<Boolean>

Checks if the module is already installed.
Task<Void>

Marks the LowLightBoost module as no longer needed for this application.

Public functions

createSession

fun createSession(
    options: LowLightBoostOptions,
    callback: LowLightBoostCallback
): Task<LowLightBoostSession?>

Creates a LowLightBoostSession.

A low light boost session manages the necessary camera capture targets for a low light capture session and provides rendering to a target surface, which the app can then display and encode as video or as a still image.

Parameters
options: LowLightBoostOptions

The options for the session.
callback: LowLightBoostCallback

An implementation of LowLightBoostCallback.

installModule

fun installModule(
    context: Context,
    installStatusCallback: LowLightBoostClient.InstallStatusCallback? = null
): Task<Boolean>

Installs the LowLightBoost module.

Parameters
context: Context

A context.

isCameraSupported

fun isCameraSupported(cameraId: String): Task<Boolean>

Queries whether a camera supports low light boost.

Parameters
cameraId: String

The camera id to query.

isDeviceSupported

fun isDeviceSupported(context: Context): Task<Boolean>

Checks if the module is supported on this device.

Only devices which support low light boost will be able to create a LowLightBoostSession.

Parameters
context: Context

A context.

isModuleInstalled

fun isModuleInstalled(context: Context): Task<Boolean>

Checks if the module is already installed.

Parameters
context: Context

A context.

releaseModule

fun releaseModule(context: Context): Task<Void>

Marks the LowLightBoost module as no longer needed for this application. The module will be released at some point in the future.

Parameters
context: Context

A context.