Overview

The On-Device Memory feature automatically stores video measurements results locally on the device, enabling historical analysis and trend tracking. Measurement results are stored separately for each user ID provided during initialization.

Disabling local memory

Local memory is enabled by default. Disable it before initialization when the SDK should not read locally persisted state on startup. When disabled, the SDK skips local reads and writes for persisted SDK state. Disabling local memory through initialization settings deletes the stored local profile for the initialized user ID and prevents the SDK from loading old history for that session. If no userId is provided during the initialization, the SDK uses the default local profile, so clearing the memory affects that default profile.

When local memory is disabled, history-backed UI features cannot use persisted state. The SDK automatically forces enableMeasurementsDashboard and saveHealthRisksFactors to false, including values supplied through Remote Configuration during that session.


final settings = InitializationSettings(localMemoryEnabled: false);
await ShenaiSdk.initialize(apiKey, userId, settings: settings);


import { initialize } from "react-native-shenai-sdk"
 
await initialize(apiKey, userId, { localMemoryEnabled: false })


await ShenaiSdkCapacitor.initialize({
  apiKey,
  userId,
  settings: { localMemoryEnabled: false }
})


await ShenaiSdk.InitializeAsync(apiKey, userId, new InitializationSettings
{
    LocalMemoryEnabled = false,
});


let settings = InitializationSettings()
settings.localMemoryEnabled = false
ShenaiSDK.initialize(apiKey, userID: userId, settings: settings)


ShenAIAndroidSDK.InitializationSettings settings = shenaiSDK.getDefaultInitializationSettings();
settings.localMemoryEnabled = false;
shenaiSDK.initialize(activity, apiKey, userId, settings);


shenaiSDK.initialize(apiKey, userId, { localMemoryEnabled: false }, onResult)


opts.disable_local_memory = 1;
shen_initialize(&opts, &ctx);


sdk = ShenaiSDK(auto_init=False)
sdk.initialize(api_key, user_id, local_memory_enabled=False)

Accessing the history

Call getMeasurementResultsHistory() to retrieve measurements results history from local memory. If no measurement has finished successfully yet, a null value will be returned. Below is a summary of the returned structure:


class MeasurementResultsWithMetadata {
  MeasurementResults measurementResults;
  int epochTimestamp;
  bool isCalibration;
}
 
class MeasurementResultsHistory {
  List<MeasurementResultsWithMetadata?> history;
}
 
final history = await ShenaiSdk.getMeasurementResultsHistory();


import { getMeasurementResultsHistory } from "@shenai/react-native-sdk"
 
interface MeasurementResultsWithMetadata {
  measurementResults: MeasurementResults
  epochTimestamp: number
  isCalibration: boolean
}
 
interface MeasurementResultsHistory {
  history: MeasurementResultsWithMetadata[]
}
 
async function example() {
  const history: MeasurementResultsHistory = await getMeasurementResultsHistory()
}


interface MeasurementResultsWithMetadata {
  measurementResults: MeasurementResults
  epochTimestamp: number
  isCalibration: boolean
}
 
interface MeasurementResultsHistory {
  history: MeasurementResultsWithMetadata[]
}
 
const { value: history } = await ShenaiSdkCapacitor.getMeasurementResultsHistory()


public sealed class MeasurementResultsWithMetadata
{
    public MeasurementResults MeasurementResults { get; set; }
    public double EpochTimestamp { get; set; }
    public bool IsCalibration { get; set; }
}
 
public sealed class MeasurementResultsHistory
{
    public IReadOnlyList<MeasurementResultsWithMetadata> History { get; set; }
}
 
var history = await ShenaiSdk.GetMeasurementResultsHistoryAsync();


class MeasurementResultsHistory {
  var history: [MeasurementResultsWithMetadata]
}
 
class MeasurementResultsWithMetadata {
var measurementResults: MeasurementResults
var epochTimestamp: NSNumber
var isCalibration: Bool
}
 
let history = ShenaiSDK.getMeasurementResultsHistory()


class MeasurementResultsWithMetadata {
    public MeasurementResults measurementResults;
    public int epochTimestamp;
    public boolean isCalibration;
}
 
class MeasurementResultsHistory {
    public MeasurementResultsWithMetadata[] history;
}
 
MeasurementResultsHistory history = shenaiSDKHandler.getMeasurementResultsHistory();


interface MeasurementResultsWithMetadata {
  measurement_results: MeasurementResults
  epoch_timestamp: number
  is_calibration: boolean
}
 
interface MeasurementResultsHistory {
  history: MeasurementResultsWithMetadata[]
}
 
const history = shenaiSDK.getMeasurementResultsHistory()


shen_measurement_results_history_t history = {0};
if (shen_get_measurement_results_history(ctx, &history) == SHEN_STATUS_OK) {
  shen_release_measurement_results_history(&history);
}


history = sdk.get_measurement_results_history()