Flutter API References
Initialization Method
To get started, call the GlamAR.init method. This adds the GlamAR SDK into the target container and configures it with the provided Access key and optional configuration.
final overrides = GlamAROverrides(
category: 'sunglasses',
meta: {
'preloadMLModels': ['face', 'hair', 'hand', 'light'],
},
);
await GlamAr.init(
accessKey: 'YOUR_ACCESS_KEY', // Replace with your actual key
overrides: overrides
);
Initialization Config
| Parameters | Type | Description | Options |
|---|---|---|---|
| accessKey | string | Pass your unique Access Key | |
| category | string | Pass any compatible subcategory |
|
| overrides.meta.preloadMLModels | List<String> | Downloads the listed ML models during SDK initialization. | ['face', 'hair', 'hand', 'light'] |
Example
final overrides = GlamAROverrides(
category: "sunglasses",
meta: {
"preloadMLModels": ["face", "hair", "hand", "light"],
},
);
GlamAr.init(
accessKey: "YOUR_ACCESS_KEY", // Requried - Replace with your actual key
debug: true,
overrides: overrides,
);
Sku config
Our SDK currently processes sku's in two formats:
- Id : This is an unique id we give to every SKU created with GlamAR console < Product Inventory. You can check the sku-id in the inventory under column
SKU ID - Config : This is an object that can be created using the exsisting SKU in your inventory.
Any SKU config must contain 4 key item
{
category: "desired-category", // `eyeware`,`jewellery`,`accessories` etc.
subCategory: "desired-subCategory", // `sunglasses`, `necklace`, `earring`
status: "PUBLISHED",
arEffect:{
// Copy this entire object as it contains all the necessary rendering data we need to show the desired SKU as custimized in the console
}
}
You can also add in 'productName' and 'productImage' properties in the object. These will be used in displaying SKU in our SKU selection area at the bottom.
We provide a Model Viewer for viewing your model in 3D. It supports displaying the dimensions of model, if provided to it. These dimensions are shown in 'cm' measurment. To use this feature, you can add a meta tag inside your object. Example:
{
category: "eyeware",
subCategory: "sunglasses",
status: "PUBLISHED",
arEffect:{
// Details
}
meta:{
dimensions: {
length: "length-of-model",
width: "width-of-model",
height: "height-of-model",
},
}
}
| Parameters | Type | Description |
|---|---|---|
| category | string | eyeware, makeup, jewellery etc. |
| subCategory | string | sunglasses, necklace, earrings etc. |
| productName | string | Name for the product |
| productImage | string | Image URL for the product |
| arEffect | ArEffectOptions | Object contains data that is used to render model accurately |
| meta | MetaOptions | Object contains miscellaneous data |
ArEffectOptions
| Parameters | Type | Description |
|---|---|---|
| transform | object | Contains position and rotation settings |
| envSettings | object | Contains lighting and environment settings |
| effectAssets2D | string[] | Contains urls of images for SKU rendering |
| effectAssets3D | EffectAssets3DOptions | Contains url of 3D file for rendering |
EffectAssets3DOptions
| Parameters | Type | Description |
|---|---|---|
| id | string | Always send "full" |
| url | string | Valid url to the desired asset. Supported extension is |
MetaOptions
| Parameters | Type | Description |
|---|---|---|
| dimensions | object | Contains length, width and height properties |
Post-Initialization Methods
applyBySku
GlamAr.applyBySku(skuId, callback);
Load a virtual try-on using applyBySku method and passing the relevant SKU Id.
Return Value: None
| Parameters | Type | Description |
|---|---|---|
| SKU Id | string | A SKU ID. |
| callback | function | function, fires after the Sku is applied |
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.
GlamAr.applyByCategory("makeup", {"storeFront": "store_a"});
| Parameters | Type | Description | Options |
|---|---|---|---|
| category | string | Pass any compatible category |
|
| options (optional) | Map | Optional catalog filter map. Currently supports storeFront. | {"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.
GlamAr.applyBySubCategory("lipstick", {"storeFront": "store_a"});
| Parameters | Type | Description | Options |
|---|---|---|---|
| subCategory | string | Pass any compatible subcategory |
|
| options (optional) | Map | Optional catalog filter map. Currently supports storeFront. | {"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
| Parameters | Type | Description |
|---|---|---|
| skuConfigArray | object | An Array of SKU Configs |
Following is an example of above skuConfigArray for applyMultipleConfigData.
const data = [
{
category: "eyewear",
subCategory: "eyeglasses",
status: "PUBLISHED",
arEffect: {
envSettings: {
useDefaultEnvironment: true,
},
effectAssets3D: [
{
id: "full",
url: "VALID-ASSET-URL", // We support .glb files
},
],
},
},
{
category: "accessories",
subCategory: "caps",
status: "PUBLISHED",
productName: "Test cap",
productImage:
"https://cdn.pixelbin.io/v2/dummy-cloudname/original/05-DP1YgvlO2.png",
arEffect: {
envSettings: {
useDefaultEnvironment: true,
},
effectAssets3D: [
{
id: "full",
url: "VALID-ASSET-URL", // We support .glb files
},
],
},
},
{
category: "jewellery",
subCategory: "earring",
status: "PUBLISHED",
productName: "Test earring",
arEffect: {
envSettings: {
useDefaultEnvironment: true,
},
effectAssets3D: [
{
id: "full",
url: "VALID-ASSET-URL", // We support .glb files
},
],
},
meta: {
size: "",
},
},
];
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
| Parameters | Type | Description |
|---|---|---|
| eventName | string | A Name of specific event or "*" To listen to the all the events. |
| handlerFunction | function | Your handler function that will listen to callback. |
removeEventListener
GlamAr.removeEventListener(eventName, handlerFunction);
Removes the given listener for the event name.
Return Value: None
| Parameters | Type | Description |
|---|---|---|
| eventName | string | A Name of specific event or "*" To remove all the events. |
| handlerFunction | function | Your handler function that will listen to callback. |
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({'subCategory': 'blush'});
GlamAr.reset({'skuIds': ['sku-1', 'sku-2']});
| Parameter | Type | Description |
|---|---|---|
value | String or Map<String, dynamic> | Optional. A subcategory string is shorthand for the subCategory option. |
subCategory | String | Subcategory to clear, such as blush. |
skuIds | List<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 positional; value, skuId, and subCategory are optional named arguments.
GlamAr.configChange('opacity', value: 0.5);
GlamAr.configChange('fingers', value: 2);
GlamAr.configChange('horizontal', value: 0);
GlamAr.configChange('vertical', value: 0);
// Target makeup opacity during multi-try-on.
GlamAr.configChange('opacity', value: 0.5, skuId: 'sku-1');
GlamAr.configChange('opacity', value: 0.5, subCategory: 'lipstick');
// Select the makeup opacity target without changing its value.
GlamAr.configChange('opacity', subCategory: 'lipstick');
| Parameter | Type | Description |
|---|---|---|
type | String | Required. opacity (also accepted as intensity), fingers, horizontal, vertical, or scale. |
value | num? | Numeric adjustment. Supply a value when changing an adjustment. For opacity/intensity, omitting the value selects the target without changing its opacity. |
skuId | String | Optional applied makeup SKU ID to target. |
subCategory | String | Optional 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
| Parameters | Type | Description | Options |
|---|---|---|---|
| state | bool | Controls whether the AR viewport should render in mirrored mode. |
|
close
GlamAr.close();
Closes canvas and returns to the main widget page.
Return Value: None
| Parameters | Description |
|---|---|
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
base64formate.
Return Value: none
| Parameters | Description |
|---|---|
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.
| Parameters | Type | Description | Options |
|---|---|---|---|
| state | string | State to show or hide the UI respectively | open close |
| skus | string[] | object[] | Provide 2 SKU Ids or 2 SKU json in an array | ["skudID1", "skudID2"] |
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
Switches between AR Try-On and Skin Analysis in the initialized SDK without reloading the full SDK. Wait for the loaded event before calling it.
import 'package:glam_ar_sdk/glam_ar_sdk.dart';
GlamAr.setExperience('vto', const VtoExperienceOptions(category: 'eyewear'));
GlamAr.setExperience('vto', const VtoExperienceOptions(subCategory: 'lipstick'));
GlamAr.setExperience('vto', const VtoExperienceOptions(skuId: 'sku-1'));
GlamAr.setExperience(
'skinAnalysis',
const SkinAnalysisExperienceOptions(appId: 'your-app-id'),
);
| Parameter | Description |
|---|---|
experience | Required. Exactly vto or skinAnalysis (case-sensitive). |
options | Required. VtoExperienceOptions for vto, or SkinAnalysisExperienceOptions for skinAnalysis. |
category, subCategory, skuId | VTO selectors. Provide one nonblank string in the options. skuId is the exact merchant SKU from variants[].skuId, not a product ID or variant UUID. |
appId | Required nonblank Skin Analysis app ID in the options. |
Selector values are trimmed. If multiple VTO selectors are supplied, the first nonblank value wins in this order: category, subCategory, skuId. Invalid experience/options emit experience-change-failed without switching.
This method returns no value. Listen for experience-changing, experience-changed, and experience-change-failed to track completion or failure.
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
| Parameters | Type | Description | Options |
|---|---|---|---|
| mode | string | Opens Live-Tryon, Model/Image-tryon and Model Viewer | modelViewer imgTryOn |
| imgURL | string | Valid image URL | Any 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");
- Opens the image/model selection screen:
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.
Refer to Setup Page to understand how we can register to events listed Check Events Page for event details.