Utility Functions

Overview

Clipboard

setClipboardText Set Clipboard

Set clipboard text. Note: enable Picture-in-Picture or call takeMeToFront to bring this app to the foreground
@param text Text content
@param type 1 = text, 2 = link
@return {boolean} true on success, false on failure

1
function main() {
2
    takeMeToFront()
3
    sleep(1000)
4
    var r = utils.setClipboardText("22222", 1);
5
    logd(r)
6
}
7

8
main();

getClipboardText Read Clipboard

Read clipboard text. Note: enable Picture-in-Picture or call takeMeToFront to bring this app to the foreground
@return {string} Clipboard data

1
function main() {
2
    takeMeToFront()
3
    sleep(1000)
4
    var r = utils.getClipboardText();
5
    logd(r)
6
}
7

8
main();

Open URL

openUrl Open URL

Open a URL. Note: bring the app to the foreground first with takeMeToFront
@param url URL address
@return {boolean} true on success, false on failure

1
function main() {
2
    takeMeToFront()
3
    sleep(1000)
4
    var r = utils.openUrl("http://baidu.com");
5
    logd(r)
6
}
7

8
main();

Photo Library

saveImageToAlbum Save Image to Album

Save an image to the photo library
@param img AutoImage object
@return {boolean} true on success, false on failure

1
function main() {
2
    // Request photo permission once at script start; grant manually or in Settings → EC app → Photos
3
    utils.requestPhotoAuthorization()
4
    sleep(1000)
5
    let img = image.captureFullScreen()
6
    logd("img getHeight " + image.getHeight(img))
7
    logd("img getWidth " + image.getWidth(img))
8
    var r = utils.saveImageToAlbum(img);
9
    logd(r)
10
}
11

12
main();

saveImageToAlbumPath Save Image Path to Album

Save an image file path to the photo library
@param path File path
@return {boolean} true on success, false on failure

1
function main() {
2
    // Request photo permission once at script start; grant manually or in Settings → EC app → Photos
3
    utils.requestPhotoAuthorization()
4
    sleep(1000)
5
    let url = "http://192.168.2.10:8199/resource/image/wx.png"
6
    let box = file.getInternalDir("documents")
7
    logd("sandbox " + box)
8
    let filex = box + "/bb.png"
9
    logd("file " + filex)
10
    let r = http.downloadFile(url, filex, 10000, null)
11
    logd("download " + r)
12
    let rx = utils.saveImageToAlbumPath(filex)
13
    logd("r " + rx)
14
}
15

16
main();

saveVideoToAlbumPath Save Video Path to Album

Save a video file path to the photo library
@param path Video file path
@return {boolean} true on success, false on failure

1
function main() {
2
    // Request photo permission once at script start; grant manually or in Settings → EC app → Photos
3
    utils.requestPhotoAuthorization()
4
    sleep(1000)
5
    let url = "http://192.168.2.10:8199/resource/image/wx.mp4"
6
    let box = file.getInternalDir("documents")
7
    logd("sandbox " + box)
8
    let filex = box + "/bb.mp4"
9
    logd("file " + filex)
10
    let r = http.downloadFile(url, filex, 10000, null)
11
    logd("download " + r)
12
    let rx = utils.saveVideoToAlbumPath(filex)
13
    logd("r " + rx)
14
}
15

16
main();

utils.requestPhotoAuthorization Request Photo Library Permission

Request photo library permission
First request shows a permission dialog — allow it, or go to Settings → scroll to the bottom → EC app → enable Photos
Note: These are async; ignore return values to avoid blocking simulated taps
Requires EC standalone 4.9.0+
@return {bool} true on success, false on failure

1
function main() {
2
    let rx = utils.requestPhotoAuthorization()
3
    logd("r " + rx)
4
    // Then call delete functions
5
    let a = utils.deleteAllPhotos()
6
    logd("a " + a)
7

8
}
9

10
main();

utils.deleteAllPhotos Delete All Photos

Delete all photos in the library
A confirmation dialog appears — simulate tapping Delete
Note: These are async; ignore return values to avoid blocking simulated taps
Requires EC standalone 4.9.0+
@return {bool} true on success, false on failure

1
function main() {
2
    let rx = utils.requestPhotoAuthorization()
3
    logd("r " + rx)
4
    // Then call delete functions
5
    let a = utils.deleteAllPhotos()
6
    logd("a " + a)
7
}
8

9
main();

utils.deleteAllVideos Delete All Videos

Delete all videos in the library
A confirmation dialog appears — simulate tapping Delete
Note: These are async; ignore return values to avoid blocking simulated taps
Requires EC standalone 4.9.0+
@return {bool} true on success, false on failure

1
function main() {
2
    let rx = utils.requestPhotoAuthorization()
3
    logd("r " + rx)
4
    // Then call delete functions
5
    let a = utils.deleteAllVideos()
6
    logd("a " + a)
7
}
8

9
main();

Other

utils.dataMd5 Data MD5

Compute MD5 of data
Requires EC 4.10.0+
@param data Data string
@return {string} MD5 string or null

1
function main() {
2
    let docs = file.getInternalDir("documents")
3
    var md5 = utils.fileMd5(docs + "/aaa.png");
4
    logd(md5)
5
}
6

7
main();

utils.fileMd5 File MD5

Compute MD5 of a file
@param file File path
@returns {string} File MD5 string or null

1
function main() {
2
    let docs = file.getInternalDir("documents")
3
    var md5 = utils.fileMd5(docs + "/aaa.png");
4
    logd(md5)
5
}
6

7
main();

Random

utils.getRangeInt Get Random Value in Range

Get a random integer within a range
@param min Minimum value
@param max Maximum value
@return Integer between min and max, inclusive of min, exclusive of max

1
function main() {
2
    var r = utils.getRangeInt(2, 10);
3
}
4

5
main();

Base64

utils.base64Encode Base64 Encode

Base64 encode
@param data String to encode
@returns {string} Encoded result

1
function main() {
2
    var r = utils.base64Encode("111");
3
    logd(r)
4
}
5

6
main();

utils.base64Decode Base64 Decode

Base64 decode
@param data String to decode
@returns {string} Decoded result

1
function main() {
2
    var r = utils.base64Decode("MjIy");
3
    logd(r)
4
}
5

6
main();

Audio Playback

utils.playMp3 Play MP3

Play MP3 asynchronously
Requires EC standalone 4.5.0+
@param path File path
@param loop Loop playback; true to loop
@return {bool} true on success, false on failure

1
function main() {
2
    let path = file.getSandBoxFilePath("test.mp3");
3
    // Copy test.mp3 from script res directory to device path
4
    saveResToFile("test.mp3", path)
5
    let d = utils.playMp3(path, false)
6
    logd("dd " + d)
7
    // Wait for playback to start
8
    sleep(30 * 1000)
9
    utils.stopMp3()
10
    logd("stop play ")
11
}
12

13
main();

utils.playMp3WaitEnd Play MP3 Synchronously

Play MP3 and wait until finished
Requires EC standalone 4.5.0+
@param path File path
@param loop Loop playback; true to loop
@return {bool} true on success, false on failure

1
function main() {
2
    let path = file.getSandBoxFilePath("test.mp3");
3
    // Copy test.mp3 from script res directory to device path
4
    saveResToFile("test.mp3", path)
5
    let d = utils.playMp3WaitEnd(path, false)
6
    logd("dd " + d)
7
}
8

9
main();

utils.stopMp3 Stop MP3 Playback

Stop MP3 playback
Requires EC standalone 4.5.0+
@return {bool} true on success, false on failure

1
function main() {
2

3
    let path = file.getSandBoxFilePath("test.mp3");
4
    // Copy test.mp3 from script res directory to device path
5
    saveResToFile("test.mp3", path)
6
    let d = utils.playMp3(path, false)
7
    logd("dd " + d)
8
    // Wait for playback to start
9
    sleep(30 * 1000)
10
    utils.stopMp3()
11
    logd("stop play ")
12
}
13

14
main();

Notifications

utils.requestNotificationAuthorization Request Notification Permission

Request notification permission
A permission dialog appears — simulate tapping Allow
Note: These are async; ignore return values to avoid blocking simulated taps
Requires EC standalone 4.10.0+
@return {bool} true on success, false on failure

1
function main() {
2
    let rx = utils.requestNotificationAuthorization()
3
    logd("r " + rx)
4
    // Then show notification
5
    let a = utils.showNotification("Title", "Content", 1)
6
    logd("a " + a)
7

8
}
9

10
main();

utils.showNotification Show Notification

Show a notification
Requires EC standalone 4.10.0+
@param title Title
@param content Content
@param delay Delay before showing, in seconds (integer)
@return {string} Notification ID for later cancel operations

1
function main() {
2
    let rx = utils.requestNotificationAuthorization()
3
    logd("r " + rx)
4
    // Then show notification
5
    let a = utils.showNotification("Title", "Content", 1)
6
    logd("a " + a)
7

8
}
9

10
main();

utils.removeNotification Remove Notification

Remove a notification
Requires EC standalone 4.10.0+
Async function; ignore return value
@param id Notification ID
@return {bool} true on success, false on failure

1
function main() {
2
    let rx = utils.requestNotificationAuthorization()
3
    logd("r " + rx)
4
    // Then show notification
5
    let a = utils.showNotification("Title", "Content", 1)
6
    logd("a " + a)
7

8
    sleep(5000)
9
    utils.removeNotification(a)
10

11
}
12

13
main();

utils.removeAllNotification Remove All Notifications

Remove all displayed notifications
Note: These are async; ignore return values to avoid blocking simulated taps
Requires EC standalone 4.10.0+
@return {bool} true on success, false on failure

1
function main() {
2
    let rx = utils.requestNotificationAuthorization()
3
    logd("r " + rx)
4
    // Then show notification
5
    let a = utils.showNotification("Title", "Content", 1)
6
    logd("a " + a)
7

8
    sleep(5000)
9
    utils.removeAllNotification()
10

11
}
12

13
main();

QR Code

utils.createQRCode Generate QR Code

Generate a QR code
Requires EC standalone 4.12.0+
@param content QR code string content
@param width Image width
@param height Image height
@param logoImage Optional center logo AutoImage object; see image module
@return {AutoImage} To save to file, see image module

1
function main() {
2

3
  let da = "test qrcode content"
4
  let logo = readResAutoImage("logo.png")
5
  let img = utils.createQRCode(da,200,100,logo)
6
  logd(img)
7

8
  // Decode result
9
  logd(utils.decodeQRCode(img));
10
  // Save to file
11
  image.saveTo(img,file.getSandBoxFilePath("/qr.code.jpg"))
12
  image.recycle(img)
13

14
}
15

16
main();

utils.decodeQRCode Decode QR Code

Decode a QR code
Requires EC standalone 4.12.0+
@param img AutoImage object; see image module
@return {string} Decoded string

1
function main() {
2

3
  let da = "test qrcode content"
4
  let logo = readResAutoImage("logo.png")
5
  // Generate
6
  let img = utils.createQRCode(da,200,100,logo)
7
  logd(img)
8

9
  // Decode result
10
  logd(utils.decodeQRCode(img));
11
  // Save to file
12
  image.saveTo(img,file.getSandBoxFilePath("/qr.code.jpg"))
13
  image.recycle(img)
14

15
}
16

17
main();