Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

ImagePicker.SetOverlayImage

Installs an overlay image to the picker.

Component Version macOS Windows Linux Server iOS SDK
ImagePicker 8.3 ❌ No ❌ No ❌ No ❌ No ✅ Yes
MBS( "ImagePicker.SetOverlayImage"; Image )   More

Parameters

Parameter Description Example
Image The new overlay image.
Proportional stretched to screen size.
But you can use different images for different devices for best results.

Result

Returns OK or error.

Description

Installs an overlay image to the picker.
This can be used to show additional framing rectangle or instructions to the user.
The overlay is scaled and cropped to the screen maintaining the aspect ratio, so you best use a square picture to work in landscape and portrait.

Examples

Show image picker with overlay:

Set Variable [ $r ; Value: MBS( "ImagePicker.New" ) ]
Set Variable [ $r ; Value: MBS( "ImagePicker.SetCameraCaptureMode"; "Photo" ) ]
Set Variable [ $r ; Value: MBS( "ImagePicker.SetShowsCameraControls"; 1 ) ]
Set Variable [ $r ; Value: MBS( "ImagePicker.SetSourceType"; "Camera") ]
Set Variable [ $r ; Value: MBS( "ImagePicker.SetOverlayImage"; PlaceHolder::Container ) ]
Set Variable [ $r ; Value: MBS( "ImagePicker.Present" ) ]

See also

Release notes

Blog Entries

This function checks for a license.

Created 25th May 2018, last changed 7th May 2020


ImagePicker.SetMediaTypes - ImagePicker.SetScript