BatteryStateArgs
ClassStores the battery level and charging state of the device.
- Snapchat: not supported
- SPECS: fully supported
- Camera Kit Web: not supported
- Camera Kit Mobile: not supported
- SnapchatNot supported — Available on SPECS only
- SPECSFully supported
- Camera Kit WebNot supported — Available on SPECS only
- Camera Kit MobileNot supported — Available on SPECS only
Since Lens Scripting v364
Stores the battery level and charging state of the device. Used as argument with the onBatteryStateChanged event.
Index
Properties
Methods
Extends
Properties
batteryLevel
readonlybatteryLevel:number
SPECS
The current battery level of the device, represented as a percentage (0-100).
Since
Lens Scripting Version 364
isCharging
readonlyisCharging:boolean
SPECS
Indicates whether the device is currently charging.
Since
Lens Scripting Version 364
Methods
getTypeName()
staticgetTypeName():TypeName<BatteryStateArgs>
SPECS
Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().
Returns
TypeName<BatteryStateArgs>
Since
Lens Scripting Version 364
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean