openMediaPicker
Bắt đầu hỗ trợ ở phiên bản:
- SDK: 2.18.11
- Android: 2.23.2: hỗ trợ các type `zcamera`, `zcamera_photo`, `zcamera_video`, `zcamera_scan`.
Cần xin cấp quyền tại trang Quản lý ứng dụng
import { openMediaPicker } from "zmp-sdk/apis";
Mở cửa sổ chọn media (camera, ảnh, file, video) từ thiết bị.
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",
});
Tham số
Truyền tham số vào API dưới dạng object chứa các thuộc tính:
| Name | Type | Default | Description |
|---|---|---|---|
| compressLevel | number | 2 | Mức nén ảnh khi chọn type là
|
| editView | Object | Hiển thị view chỉnh sửa ảnh. | |
| maxItemSize | number | Giới hạn kích thước (byte) tối đa của media được phép chọn. | |
| maxSelectItem | number | 1 | Giới hạn số lượng tối đa media được chọn. |
| serverUploadUrl | string | Đường dẫn upload media. Server phải hỗ trợ upload media qua POST và trả về kết quả dạng JSON. Xem ví dụ về server tại đây. | |
| silentRequest | boolean | false | Hiển thị hoặc ẩn dialog xử lý các tác vụ ngầm: |
| type | "photo" | "file" | "video" | "zcamera" | "zcamera_photo" | "zcamera_video" | "zcamera_scan" | Loại media cần chọn. Các giá trị: |
Kết quả trả về
API trả về Promise<OpenMediaPickerReturns> chứa kết quả trả về.
OpenMediaPickerReturns
| Name | Type | Default | Description |
|---|---|---|---|
| data | string[] | string | Mặc định trả về mảng đường dẫn file tạm trên thiết bị. |
Upload lên server
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 mediaGET/files/:name - Dùng để lấy media theoname
Tham khảo code mẫu dưới đây:
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);
}
};
