Skip to main content

Android Framework API References

Initialization Method​

GlamAr.init(
context: Context,
accessKey: String,
overrides: GlamAROverrides? = null,
webView: WebView? = null,
debug: Boolean = false
)

Parameter Descriptions​

ParameterTypeRequiredDescription
contextContextYesThe Android context, typically passed from an Activity or Fragment. Used for WebView creation and permission handling.
accessKeyStringYesYour unique Access key to authenticate the SDK usage.
overridesGlamAROverrides?NoOptional configuration object to control AR behavior, UI, and metadata. See GlamAROverrides for details.
webViewWebView?NoIf provided, the SDK will use this WebView instance instead of creating a new one. Allows full control over rendering. Defaults to null.
debugBooleanNoEnables detailed logging from the SDK. Useful for development/debugging. Defaults to false.

GlamAROverrides allows developers to customize the behavior, appearance, and initialization of the GlamAR SDK when integrating it into an Android app.

You can pass this configuration object directly into the SDK initialization:

GlamAr.initialize(
context = this,
accessKey = "your-access-key",
overrides = GlamAROverrides(...) // ← Custom behavior here
)

GlamAROverrides Structure​

category: String?

Defines the initial AR category (e.g. sunglasses, necklace,earrings). Optional.

meta: Map<String, Any?>?​

Contains initialization metadata. Use preloadMLModels to download ML models during SDK initialization. AR Try-On supports face, hair, hand, and light.

Full Example​

val overrides = GlamAROverrides(
category = "sunglasses",
meta = mapOf(
"preloadMLModels" to listOf("face", "hair", "hand", "light")
)
)

Post-Initialization Methods​

applyBySku​

GlamAr.applyBySku(skuId);

Load a virtual try-on using applyBySku method and passing the relevant SKU Id.
Return Value: None

ParametersTypeDescription
SKU Idstring A SKU ID.

applyByCategory​

GlamAr.applyByCategory(category)

Pass a category (e.g., makeup, eyewear, jewellery), which the SDK will use to fetch all corresponding SKUs from the Console’s product inventory.
Return Value: None

GlamAr.applyByCategory("makeup")

If storefront-specific filtering is required, pass storeFront as an optional second argument.

import io.pixelbin.glamar.model.ApplyCatalogOptions

GlamAr.applyByCategory(
"makeup",
ApplyCatalogOptions(storeFront = "store_a")
)
ParametersTypeDescriptionOptions
categorystringPass any compatible category

makeup, eyewear, jewellery etc.
Check supported categories

options (optional)ApplyCatalogOptions?Optional catalog filter object. Currently supports storeFront.ApplyCatalogOptions(storeFront = "store_a")

applyBySubCategory​

GlamAr.applyBySubCategory(subCategory)

Pass a subcategory (e.g., lipstick, sunglasses, necklace), which the SDK will use to fetch all corresponding SKUs from the Console’s product inventory.
Return Value: None

GlamAr.applyBySubCategory("lipstick")

If storefront-specific filtering is required, pass storeFront as an optional second argument.

import io.pixelbin.glamar.model.ApplyCatalogOptions

GlamAr.applyBySubCategory(
"lipstick",
ApplyCatalogOptions(storeFront = "store_a")
)
ParametersTypeDescriptionOptions
subCategorystringPass any compatible subcategory

lipstick, sunglasses, necklace etc.
Check supported subcategories

options (optional)ApplyCatalogOptions?Optional catalog filter object. Currently supports storeFront.ApplyCatalogOptions(storeFront = "store_a")

applyMultipleConfigData​

GlamAr.applyMultipleConfigData(skuConfigArray);

Display multiple SKU types at once. The input should be an array of sku configs. Each item can be of diffrent subcategory eg: sunglasses, caps, earrings, etc.
Return Value: None

ParametersTypeDescription
skuConfigArrayobjectAn Array of SKU Configs

Following is an example of above skuConfigArray for applyMultipleConfigData.

data class EffectAsset3D(
val id: String,
val url: String
)

data class EnvSettings(
val useDefaultEnvironment: Boolean
)

data class ArEffect(
val envSettings: EnvSettings,
val effectAssets3D: List<EffectAsset3D>
)

data class SkuConfig(
val category: String,
val subCategory: String,
val status: String,
val productName: String? = null,
val productImage: String? = null,
val arEffect: ArEffect,
val meta: Map<String, Any?>? = null
)

val data = listOf(
SkuConfig(
category = "eyewear",
subCategory = "eyeglasses",
status = "PUBLISHED",
arEffect = ArEffect(
envSettings = EnvSettings(useDefaultEnvironment = true),
effectAssets3D = listOf(
EffectAsset3D(id = "full", url = "VALID-ASSET-URL") // Valid Asset url
)
)
),
SkuConfig(
category = "accessories",
subCategory = "caps",
status = "PUBLISHED",
productName = "Test cap",
productImage = "VALID-ASSET-IMAGE-URL", // Valid image url
arEffect = ArEffect(
envSettings = EnvSettings(useDefaultEnvironment = true),
effectAssets3D = listOf(
EffectAsset3D(id = "full", url = "VALID-ASSET-URL") // Valid Asset url
)
)
),
)

GlamAr.applyMultipleConfigData(data);

Users will see separate tabs for each category type in the SDK UI.

addEventListener​

GlamAr.addEventListener(eventName, handlerFunction);

Adds the listener to the given event name.
Return Value: None

ParametersTypeDescription
eventNamestring

A Name of specific event or "*" To listen to the all the events.

handlerFunctionfunction Your handler function that will listen to callback.

removeEventListener​

GlamAr.removeEventListener(eventName, handlerFunction);

Removes the given listener for the event name.
Return Value: None

ParametersTypeDescription
eventNamestring

A Name of specific event or "*" To remove all the events.

handlerFunctionfunction Your handler function that will listen to callback.

isLoaded​

GlamAr.isLoaded();

Returns the status of module loading.
Return Value: true if loaded, otherwise false

ParametersDescription

None

No parameters required.

reset​

Removes all applied effects when called without arguments. In multi-try-on, pass a subcategory string or an options object/map to remove selected effects while keeping the others.

GlamAr.reset()
GlamAr.reset("blush")
GlamAr.reset(mapOf("subCategory" to "blush"))
GlamAr.reset(mapOf("skuIds" to listOf("sku-1", "sku-2")))
ParameterTypeDescription
valueString or Map<String, Any>Optional. A subcategory string is shorthand for the subCategory option.
subCategoryStringSubcategory to clear, such as blush.
skuIdsList<String>IDs of applied SKUs to remove. Pass individual IDs as list entries.

If both filters are supplied, a nonempty skuIds list takes precedence over subCategory. Omitting the argument, passing an empty string, or passing options with no nonempty filter clears all effects.

Returns no value.

configChange​

Updates an adjustment for the active try-on. Availability depends on the current product and experience. skuId and subCategory select the makeup opacity target during multi-try-on; they do not scope finger, position, or scale adjustments.

Use configChange(type, value, skuId, subCategory). Only type is required; Kotlin named arguments let you omit unused optional parameters.

GlamAr.configChange("opacity", 0.5)
GlamAr.configChange("fingers", 2)
GlamAr.configChange("horizontal", 0)
GlamAr.configChange("vertical", 0)

// Target makeup opacity during multi-try-on.
GlamAr.configChange("opacity", 0.5, skuId = "sku-1")
GlamAr.configChange("opacity", 0.5, subCategory = "lipstick")

// Select the makeup opacity target without changing its value.
GlamAr.configChange("opacity", subCategory = "lipstick")
ParameterTypeDescription
typeStringRequired. opacity (also accepted as intensity), fingers, horizontal, vertical, or scale.
valueNumber?Numeric adjustment. Supply a value when changing an adjustment. For opacity/intensity, omitting the value selects the target without changing its opacity.
skuIdStringOptional applied makeup SKU ID to target.
subCategoryStringOptional applied makeup subcategory to target, such as lipstick or blush.

Pass one target selector per call. With neither selector, the SDK uses its active makeup target. Returns no value.

setViewportMirrored​

GlamAr.setViewportMirrored(state);

Enables or disables mirrored viewport rendering for AR Try-On.
Return Value: None

GlamAr.setViewportMirrored(true); // Enable mirrored viewport
GlamAr.setViewportMirrored(false); // Disable mirrored viewport
ParametersTypeDescriptionOptions
stateBooleanControls whether the AR viewport should render in mirrored mode.

true: enable mirror mode
false: disable mirror mode

close​

GlamAr.close();

Closes canvas and returns to the main widget page.
Return Value: None

ParametersDescription

None

No parameters required.

snapshot​

GlamAr.snapshot();

Takes a snapshot of the current result window. Result of the screen can be get from photo-loaded event in base64 formate.
Return Value: none

ParametersDescription

None

No parameters required.

comparison​

GlamAr.comparison(state, skus);

Toggles comparison mode in AR widget.
Return Value: None

Pass a state (i.e, open or close) to toggle between UI and with it 2 SKU ids or Skuconfig of same subcategory say sunglasses or necklace. Diffrent subcategory comparision is not supoorted. The first sku will be shown on the left side and the other one on the right side.

ParametersTypeDescriptionOptions
statestringState to show or hide the UI respectivelyopen close
skusstring[] | object[]Provide 2 SKU Ids or 2 SKU json in an array

["skudID1", "skudID2"]
["SkuConfig1", "SkuConfig2"]

GlamAr.comparison("open", ["skudID1", "skudID2"]); // replace skudID1 and skudID2 with two SKU id's
GlamAr.comparison("close"); // When we send close we don't need to send SKUs

setExperience​

GlamAr.setExperience(experience, options)

Switches the active SDK experience without reloading the full SDK. Use this to move between AR Try-On and Skin Analysis faster after the GlamAR module is already loaded.
Return Value: None

import io.pixelbin.glamar.model.VtoExperienceOptions
import io.pixelbin.glamar.model.SkinAnalysisExperienceOptions

GlamAr.setExperience("vto", VtoExperienceOptions(category = "eyewear"))
GlamAr.setExperience("vto", VtoExperienceOptions(subCategory = "lipstick"))
GlamAr.setExperience("vto", VtoExperienceOptions(skuId = "Your sku id"))

GlamAr.setExperience(
"skinAnalysis",
SkinAnalysisExperienceOptions(appId = "0732f85d-5768-462e-a50a-174840438a69")
)
ParametersTypeRequiredDescription
experienceStringYesExperience to switch to. Valid values are vto and skinAnalysis.
options

VtoExperienceOptions or SkinAnalysisExperienceOptions

YesExperience-specific options used to start the selected flow.
categoryString?Required for VTO if subCategory or skuId is not providedCategory to load when switching to AR Try-On.
subCategoryString?Required for VTO if category or skuId is not providedSubcategory to load when switching to AR Try-On.
skuIdString?Required for VTO if category or subCategory is not providedThe exact merchant SKU from variants[].skuId, not a product ID or variant UUID.
appIdStringRequired for Skin AnalysisSkin Analysis app ID to load when switching to Skin Analysis.

For AR Try-On, pass only one selector in a single call: category, subCategory, or skuId. Do not pass multiple selectors together, such as category with subCategory, because only one value will be used.

Selector values are trimmed. If multiple selectors are supplied, the SDK uses the first nonblank value in this priority order: category, then subCategory, then skuId. For example, if both category and subCategory are passed, a nonblank category will be preferred.

Listen to experience-changing, experience-changed, and experience-change-failed events to track switch progress and handle failures.

open​

Use open and its mode variants only when you disable or override the SDK's built-in hero screen and implement your own screen or launch buttons. The built-in hero screen already provides buttons to open the SDK, so no open call is needed when using it. After applying a SKU, call the appropriate variant from your custom button handler.

GlamAr.open();

Opens the AR widget.
Return Value: None

ParametersTypeDescriptionOptions
modestringOpens Live-Tryon, Model/Image-tryon and Model ViewermodelViewer imgTryOn
imgURLstringValid image URLAny valid URL
  • No parameters: Start Live VTO

    GlamAr.open();
  • Model Viewer: Start Model Viewer

    GlamAr.open("modelViewer");
  • Image Try-On:

    • Opens the image/model selection screen:
      GlamAr.open("imgTryOn");
    • Opens try-on directly with a specific image:
      GlamAr.open("imgTryOn", "url_of_image");

Switching Views​

  • While in Live or Image mode, calling:

    GlamAr.open("modelViewer");

    will open the model viewer. Calling GlamAr.open() again returns to the selected Try-On type.

  • To switch from Live to Image mode, call:

    GlamAr.back();

    This resets the Try-On session and then call GlamAr.open() with desired parameter

Note: The SKU must already be applied. If not, the SDK will display an error.

Eye PD Measurement Flow​

We provide an integrated supports for eye pupillary distance (PD) scanning. This is activated when viewing any eyeware categories. If user wants to show his own UI and use this service we have function GlamAR.eyePD() for that case.

GlamAr.eyePD("start"); // To launch or restart Eye PD flow
GlamAr.eyePD("close"); // To exit Eye PD and return to active Try-On

Events​

The sku-applied event includes the applied SKU configuration in data. See the platform-specific callback examples there to read the correct payload shape.

The GlamAR SDK emits various events throughout its lifecycle to help you monitor state, respond to user actions, and handle success or failure cases.

You can register for these events using the SDK's event listener system:

glamArView.addEventListener("loaded") {
// SDK has fully loaded
}

glamArView.addEventListener("photo-loaded") { data ->
// Handle screenshot data
}

Each event is triggered from within the GlamAR SDK and may optionally include a payload. Check Events Page for event details.