Core

actual class Core

SDK Core. This is the entry point of JCV Face SDK. It holds common configuration and the state of SDK APIs. Most applications don't need to interact with this class.

For a vast majority of apps, mobile.japancv.jcvfacesdk.provider.SdkInitProvider will handle the initialization of SDK for the default project that it's configured to work with, via the data contained in the app's jcv-sdk.json file. This ContentProvider is merged into the app's manifest by default when building with Gradle, and it runs automatically at app launch. No additional lines of code are needed in this case.

In the event that an app requires access to another JCV project in addition to the default project, initialize must be used to create that relationship programmatically. The name parameter must be unique. To connect to the resources exposed by that project, use the Core object returned by getInstance, passing it the same name used with initialize. This object must be passed to the static accessor of the feature that provides the resource. For example, getInstance is used to access the Guesture provided by the additional project, whereas getInstance is used to access the default project.

Any Core initialization must occur only in the main process of the app. Use of SDK in processes other than the main process is not supported and will likely cause problems related to resource contention.

expect class Core

SDK Core. This is the entry point of JCV Face SDK. It holds common configuration and the state of SDK APIs. Most applications don't need to interact with this class.

In the event that an app requires access to another JCV project in addition to the default project, initialize must be used to create that relationship programmatically. The name parameter must be unique. To connect to the resources exposed by that project, use the Core object returned by getInstance, passing it the same name used with initialize. This object must be passed to the static accessor of the feature that provides the resource. For example, getInstance is used to access the Guesture provided by the additional project, whereas getInstance is used to access the default project.

Any Core initialization must occur only in the main process of the app. Use of SDK in processes other than the main process is not supported and will likely cause problems related to resource contention.

actual class Core

Constructors

Link copied to clipboard
actual constructor()
expect constructor()
constructor()

Types

Link copied to clipboard
actual object Companion
expect object Companion
actual object Companion

Properties

Link copied to clipboard
Link copied to clipboard