EnhancementClient
@DoNotMock(value = "Use canonical fakes instead.")
public interface EnhancementClient extends HasApiKey, OptionalModuleApi
The Enhancement client provides a way to create a EnhancementSession. The client is also used to provide availability checks and module installation.
Summary
Nested types |
|---|
public interface EnhancementClient.InstallStatusCallbackA callback for the module installation status. |
Public methods |
|
|---|---|
abstract @NonNull Task<EnhancementSession> |
createSession(Creates a |
abstract @NonNull Task<@NonNull Boolean> |
installModule(Installs the |
abstract @NonNull Task<@NonNull Boolean> |
Checks if the module is supported on this device. |
abstract @NonNull Task<@NonNull Boolean> |
Checks if the module is already installed. |
abstract @NonNull Task<Void> |
Marks the |
Public methods
createSession
abstract @NonNull Task<EnhancementSession> createSession(
@NonNull EnhancementOptions options,
@NonNull EnhancementSessionCallback callback
)
Creates a EnhancementSession.
An enhancement session manages the necessary Surface to receive input frames from the app and send the enhanced frames to a Surface provided by the app.
| Parameters | |
|---|---|
@NonNull EnhancementOptions options |
The options for the session. |
@NonNull EnhancementSessionCallback callback |
An implementation of |
| Returns | |
|---|---|
@NonNull Task<EnhancementSession> |
A task that resolves to the created |
installModule
abstract @NonNull Task<@NonNull Boolean> installModule(
EnhancementClient.InstallStatusCallback installStatusCallback
)
Installs the Enhancement module.
| Parameters | |
|---|---|
EnhancementClient.InstallStatusCallback installStatusCallback |
A callback to receive status updates. |
isDeviceSupported
abstract @NonNull Task<@NonNull Boolean> isDeviceSupported()
Checks if the module is supported on this device.
Only devices which support image or video enhancement will be able to create a EnhancementSession.
isModuleInstalled
abstract @NonNull Task<@NonNull Boolean> isModuleInstalled()
Checks if the module is already installed.
releaseModule
abstract @NonNull Task<Void> releaseModule()
Marks the Enhancement module as no longer needed for this application. The module will be released at some point in the future.