MediaPickerTextureProvider
ClassBase class for Texture Providers based on selectable media.
- Snapchat: not supported
- SPECS: not supported
- Camera Kit Web: fully supported
- Camera Kit Mobile: fully supported
- SnapchatNot supported — Available on Camera Kit only
- SPECSNot supported — Available on Camera Kit only
- Camera Kit WebFully supported
- Camera Kit MobileFully supported
Base class for Texture Providers based on selectable media.
Index
Properties
Methods
Extends
Extended by
ImagePickerTextureProvider
Properties
autoShowMediaPicker
autoShowMediaPicker:
boolean
Camera Kit
If set to true, MediaPickerTextureProvider will request media picker UI automatically during loading.
Since
Lens Scripting Version 160
Default Value
false
@cameraKit
cropFace
cropFace:
boolean
Camera Kit
If set to true, MediaPickerTextureProvider will provide a proper texture transform for image with face(s), that will "zoom" UVs to the first found face on the image.
Since
Lens Scripting Version 160
Default Value
false
@cameraKit
faceImageControl
faceImageControl:
FaceTextureProvider
Camera Kit
Returns underlying TextureProvider for the last selected media file. If the last media file was not image with at least one face, null is returned.
Since
Lens Scripting Version 160
Default Value
null
@cameraKit
imageControl
readonlyimageControl:TextureProvider
Camera Kit
Returns underlying TextureProvider for the last selected media file. If the last media file was not image, null is returned.
Since
Lens Scripting Version 160
isContentReady
readonlyisContentReady:boolean
Camera Kit
Returns true if an image is selected, or a video file has been loaded and is ready for decoding, false otherwise.
isFaceImagePickingEnabled
isFaceImagePickingEnabled:
boolean
Camera Kit
MediaPickerTextureProvider will allow users to select only images with detected faces through media picker UI. See also "cropFace" option.
Default Value
false
@cameraKit
isImagePickingEnabled
isImagePickingEnabled:
boolean
Camera Kit
MediaPickerTextureProvider will allow users to select all images files through media picker UI.
Default Value
true
@cameraKit
isVideoPickingEnabled
isVideoPickingEnabled:
boolean
Camera Kit
MediaPickerTextureProvider will allow users to select video files through media picker UI.
Default Value
true
@cameraKit
videoControl
readonlyvideoControl:VideoTextureProvider
Camera Kit
Returns underlying VideoTextureProvider for the last selected media file. If the last media file was not video, null is returned.
Methods
ensureLoaded()
ensureLoaded():
Promise<void>
Returns a Promise that resolves once this Provider has finished loading its resource.
Returns
Promise<void>
Remarks
If the Provider is already loaded when ensureLoaded() is called, the returned Promise
resolves immediately. Otherwise it resolves once loading completes.
Completion is determined by the Provider's load status (see Provider.getLoadStatus). Some Providers only become loaded once supporting runtime data is available — for example, a Provider whose resource depends on tracking will not report loaded until the relevant tracking data has arrived — so the returned Promise stays pending until that data is produced.
This method is useful when Lens script needs to await a Provider before reading its data — for example, waiting for a remote-asset Provider to finish downloading before sampling it.
Since
Lens Scripting Version 370
Example
Fetch a Texture at runtime via RemoteMediaModule and wait for its Provider to finish loading before using it:
const internetModule = require("LensStudio:InternetModule");
const remoteMediaModule = require("LensStudio:RemoteMediaModule");
function loadImageTexture(url) {
const resource = internetModule.makeResourceFromUrl(url);
return new Promise((resolve, reject) => {
remoteMediaModule.loadResourceAsImageTexture(resource, resolve, reject);
});
}
const texture = await loadImageTexture("https://example.com/image.png");
// Wait until the fetched Texture's Provider has finished loading before using it.
await texture.control.ensureLoaded();
print("Texture ready, loadStatus: " + texture.control.getLoadStatus());
Inherited from
getAspect()
getAspect():
number
Returns the texture's aspect ratio, which is calculated as width / height.
Returns
number
Inherited from
getHeight()
getHeight():
number
Returns the height of the texture in pixels.
Returns
number
Inherited from
getLoadStatus()
getLoadStatus():
LoadStatus
Returns
Inherited from
getTypeName()
staticgetTypeName():TypeName<MediaPickerTextureProvider>
Camera Kit
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<MediaPickerTextureProvider>
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
getWidth()
getWidth():
number
Returns the width of the texture in pixels.
Returns
number
Inherited from
hideMediaPicker()
hideMediaPicker():
void
Camera Kit
Requests SDK to hide media picking UI.
Returns
void
Since
Lens Scripting Version 160
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
Inherited from
setFaceMeshReadyCallback()
setFaceMeshReadyCallback(
callback):void
Camera Kit
Requests face mesh and sets a callback to fire when it's ready.
Parameters
| Parameter | Type |
|---|---|
callback | () => void |
Returns
void
Since
Lens Scripting Version 160
setFilePickedCallback()
setFilePickedCallback(
callback):void
Camera Kit
Sets a callback to fire when a file is picked through media picking UI.
Parameters
| Parameter | Type |
|---|---|
callback | () => void |
Returns
void
Since
Lens Scripting Version 160
showMediaPicker()
showMediaPicker():
void
Camera Kit
Requests SDK to show media picking UI.
Returns
void
Since
Lens Scripting Version 160