Get Started
Integrate the Android SDK using the public declarations in its :api modules. This reference follows SDK source version 1.1.129. Signatures use Kotlin syntax, including nullable types and default arguments. Use the same SDK version for all Coryn artifacts; see Get Started for installation.
Modules and packages
| Artifact | Public package |
|---|---|
ai.coryn.replay.api:core | ai.coryn.replay.api.core.main and ai.coryn.replay.api.core.model.* |
ai.coryn.replay.api:recorder | Includes core and enables View recording |
ai.coryn.replay.api:recorder-compose | ai.coryn.replay.api.recordercompose; includes the View recorder and core |
ai.coryn.replay.api.state-serialization:gson | ai.coryn.replay.api.stateserialization.gson.model and .provider |
ai.coryn.replay.api.state-serialization:moshi | ai.coryn.replay.api.stateserialization.moshi.model and .provider |
ai.coryn.replay.api:log-viewer | Adds the optional in-app Log Viewer; configured through core |
The recorder and log-viewer modules add capabilities and do not declare additional public client classes. Core alone does not record sessions. Include a recorder to capture data, and call Coryn.init() before other SDK operations.
Kotlin and Java
Import the entry point with import ai.coryn.replay.api.core.main.Coryn. Core operations are available as Java static methods.
Kotlin receiver lambdas configure initialisation and recording. Java callers can use the configuration builders; initialisation also accepts CorynConsumer<CorynInitialisationScope>. View extensions are members of Coryn: import them explicitly, for example import ai.coryn.replay.api.core.main.Coryn.corynHideFromUiCapture. Compose functions and modifiers are top-level declarations in the Compose package.
Threading and recorded data
Most lifecycle, screen, State Provider, and Event operations accept calls from any thread and dispatch work to the main thread. View operations also use the affected View's UI thread. Exceptions and callback threads are documented on each reference page. A dispatched call can return before the operation runs.
UI hiding applies to visual captures and eligible automatic Screen Text. It does not redact custom States, Events, screen arguments, Toast text, or network diagnostics. Supply safe data to those APIs. See the Guides for integration examples and Synchronisation for upload behaviour.