CameraModule.CameraRequest
ClassAn object that is used to request the desired camera ID.
- Snapchat: not supported
- SPECS: fully supported
- Camera Kit Web: not supported
- Camera Kit Mobile: not supported
- SnapchatNot supported — Available on SPECS only
- SPECSFully supported
- Restricted when the Lens uses internet-connected APIs (see Privacy Restrictions).
- Camera Kit WebNot supported — Available on SPECS only
- Camera Kit MobileNot supported — Available on SPECS only
Exposes user data
An object that is used to request the desired camera ID. It should be passed to the CameraModule to get back a camera texture.
Index
Properties
Methods
Extends
Properties
cameraId
cameraId:
CameraId
Exposes user dataSPECS
The id of the camera to be accessed.
Default Value
CameraModule.CameraId.Default_Color
@exposesUserData
@snapOS
imageSmallerDimension
imageSmallerDimension:
number
Exposes user dataSPECS
The desired resolution of the received camera frame. If not specified, will use the system default resolution. It is recommended to use lowest resolution required for your use case to save on power and not overheat the device.
Default Value
null
@exposesUserData
@snapOS
Methods
getTypeName()
staticgetTypeName():TypeName<CameraRequest>
Exposes user dataSPECS
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<CameraRequest>
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