Chuyển tới nội dung chính

openMediaPicker

import { openMediaPicker } from "zmp-sdk";

Mở cửa sổ chọn media (camera, ảnh, file, video) từ thiết bị.

Thay đổi:

Với môi trường hỗ trợ LFS, có những thay đổi đáng chú ý sau:

  • Không còn bắt buộc upload file lên server. Mặc định nếu không truyền tham số serverUploadUrl, SDK sẽ trả về đường dẫn tạm thời (local cache) của media mà không tự động upload lên server. Lưu ý: Các file này được lưu tạm thời và sẽ được xóa khi app khởi động lại, nếu cần lưu bền app có thể gọi saveFile để chuyển file thành local data
  • Nén ảnh với các chất lượng đầu ra qua tham số compressLevel. Nếu không truyền, SDK sẽ mặc định trả về ảnh không nén (compressLevel=0). App có thể tối ưu việc lưu trữ ảnh với kích thước nhỏ gọn hơn với mức nén cao dần (1 đến 3) tùy vào nhu cầu sử dụng.

Để kiểm tra LFS có được hỗ trợ hay không, vui lòng sử dụng API isSupportLFS.

Ví dụ

Mở cửa sổ chọn ảnh, nén ảnh với mức nén vừa, nhận kết quả trả về đường dẫn đến file tạm

const { data } = await openMediaPicker({
type: "photo",
compressLevel: 2,
});

console.log(data);

Mở cửa sổ chọn video, nhận kết quả trả về đường dẫn đến file tạm

const { data } = await openMediaPicker({
type: "video",
});
console.log(data);

Chọn nhiều ảnh:

const { data } = await openMediaPicker({
type: "photo",
maxSelectItem: 5,
});

Chọn ảnh từ camera Zalo:

const { data } = await openMediaPicker({
type: "zcamera_photo",
});

Xem hướng dẫn xử lý lỗi và bảng mô tả chi tiết mã lỗi tại đây.

Tham số

Truyền tham số vào API dưới dạng object chứa các thuộc tính:

PropertyTypeRequiredDescription
serverUploadUrl-No
type-No
maxItemSize-No
maxSelectItem-No
silentRequest-No
editView-No
compressLevel-No

Kết quả trả về

API trả về Promise chứa kết quả trả về.

OpenMediaPickerReturns

PropertyTypeRequiredDescription
data-No

Upload lên server

Lưu ý:

Với các phiên bản SDK và Zalo không hỗ trợ tính năng LFS, cần upload media lên server qua tham số serverUploadUrl.

Media sau khi chọn sẽ được tải lên server của bạn dưới dạng dữ liệu multipart/form-data, fieldname=file.

Server

Server phải cung cấp một api dùng để upload media với method POST và trả về kết quả dạng JSON. Kết quả trả về phải chứa trường error với các giá trị:

  • 0: Tải lên thành công
  • Khác 0: Tải lên thất bại

Một ví dụ về kết quả trả về của API dùng để upload media:

  • Tải lên thành công:
{
"error": 0,
"message": "Success",
"data": {
"urls": [...]
}
}
  • Tải lên thất bại:
{
"error": -1,
"message": "Fail"
}

Tạo một server để upload media với 2 api:

  • POST /upload/media - Dùng để upload media
  • GET /files/:name - Dùng để lấy media theo name

Tham khảo code mẫu dưới đây:

// Call all the required packages
var express = require("express");
var bodyParser = require("body-parser");
var multer = require("multer");
var app = express();
var path = require("path");

var host = "localhost";
var port = 8080;

// Create express app
app.use(bodyParser.urlencoded({ extended: true }));

// Create storage
var storage = multer.diskStorage({
destination: function (req, file, cb) {
cb(null, "uploads");
},
filename: function (req, file, cb) {
cb(null, file.originalname);
},
});

var upload = multer({ storage: storage });

// Routes will go here

/**
* Uploading multiple files with field 'file'
* @api /upload/media
* @method POST
*
*/
app.post("/upload/media", upload.array("file"), (req, res, next) => {
const files = req.files;
res.status(200).send({
data: {
urls: files.map(
(item) => `http://${host}:${port}/files/${item.filename}`
),
},
error: 0,
message: "Success",
});
});

/**
* Getting file with name
* @api /files/:name
* @method GET
*
*/
app.get("/files/:name", (req, res) => {
const fileName = req.params.name;
const directoryPath = path.join(__dirname, "uploads/");

res.sendFile(`${directoryPath}${fileName}`, fileName, (err) => {
if (err) {
try {
res.status(500).send({
message: "Could not get the file. " + err,
});
} catch (e) {}
}
});
});

// Server started on port 8080
app.listen(port, () => console.log(`Server started on port ${port}`));

Client

import { openMediaPicker } from "zmp-sdk/apis";

openMediaPicker({
type: "photo",
serverUploadUrl: "https://<your-domain-api>/upload/media",
compressLevel: 2, //Tùy chọn nếu cần nén ảnh
success: (res) => {
// xử lý khi gọi api thành công
const { data } = res;
const result = JSON.parse(data);
console.log(result);
},
fail: (error) => {
// xử lý khi gọi api thất bại
console.log(error);
},
});

Hoặc

import { openMediaPicker } from "zmp-sdk/apis";

const pickMedia = async () => {
try {
const { data } = await openMediaPicker({
type: "photo",
serverUploadUrl: "https://<your-domain-api>/upload/media",
compressLevel: 2, //Tùy chọn nếu cần nén ảnh
});
const result = JSON.parse(data);
console.log(result);
} catch (error) {
// xử lý khi gọi api thất bại
console.log(error);
}
};