?媒體庫管理
? 說明:??該組件從API Version 6開始支持。后續版本如有新增內容,則采用上角標單獨標記該內容的起始版本。 發前請熟悉鴻蒙開發指導文檔: gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md點擊或者復制轉到。
導入模塊
import mediaLibrary from '@ohos.multimedia.mediaLibrary';
mediaLibrary.getMediaLibrary8+
getMediaLibrary(context: Context): MediaLibrary
獲取媒體庫的實例,用于訪問和修改用戶等個人媒體數據信息(如音頻、視頻、圖片、文檔等)。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
context | Context | 是 | 傳入Ability實例的Context。 |
返回值:
類型 | 說明 |
---|---|
[MediaLibrary] | 媒體庫實例 |
示例:(從API Version 9開始)
var media = mediaLibrary.getMediaLibrary(this.context);
示例:(API Version 8)
import featureAbility from '@ohos.ability.featureAbility';var context = featureAbility.getContext()
var media = mediaLibrary.getMediaLibrary(context);
mediaLibrary.getMediaLibrary
getMediaLibrary(): MediaLibrary
獲取媒體庫的實例,用于訪問和修改用戶等個人媒體數據信息(如音頻、視頻、圖片、文檔等)。
說明: 從API Version 8開始,該接口不再維護,推薦使用新接口[mediaLibrary.getMediaLibrary8+]。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
返回值:
類型 | 說明 |
---|---|
[MediaLibrary] | 媒體庫實例 |
示例:
var media = mediaLibrary.getMediaLibrary();
MediaLibrary
getFileAssets7+
getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileResult>): void
獲取文件資源,使用callback方式返回異步結果。
需要權限:ohos.permission.READ_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
options | [MediaFetchOptions] | 是 | 文件獲取選項 |
callback | AsyncCallback<[FetchFileResult]> | 是 | 異步獲取FetchFileResult之后的回調 |
示例:
let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE
let imagesfetchOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],
};
mediaLibrary.getFileAssets(imagesfetchOp, (error, fetchFileResult) => {if (fetchFileResult != undefined) {console.info('mediaLibraryTest : ASSET_CALLBACK fetchFileResult success');fetchFileResult.getAllObject((err, fileAssetList) => {if (fileAssetList != undefined) {fileAssetList.forEach(getAllObjectInfo);}});}
});
getFileAssets7+
getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult>
獲取文件資源,使用Promise方式返回結果。
需要權限:ohos.permission.READ_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
options | [MediaFetchOptions] | 是 | 文件檢索選項 |
返回值
類型 | 說明 |
---|---|
[FetchFileResult] | 文件數據結果集 |
示例:
let fileKeyObj = mediaLibrary.FileKey
let imageType = mediaLibrary.MediaType.IMAGE
let imagesfetchOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],
};
mediaLibrary.getFileAssets(imagesfetchOp).then(function(fetchFileResult){console.info("getFileAssets successfully:"+ JSON.stringify(dir));
}).catch(function(err){console.info("getFileAssets failed with error:"+ err);
});
on8+
on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback: Callback<void>): void
打開媒體媒體庫變更通知,使用callback方式返回異步結果。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
type | string | 是 | 媒體類型 'deviceChange':?注冊設備變更 'albumChange':?相冊變更 'imageChange':?圖片文件變更 'audioChange': ?音頻文件變更 'videoChange': ?視頻文件變更 'fileChange': ?文件變更 'remoteFileChange':?注冊設備上文件變更 |
callback | callback<void> | 是 | 回調返回空 |
示例:
mediaLibrary.on('imageChange', () => {// image file had changed, do something
})
off8+
off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback?: Callback<void>): void
關閉媒體媒體庫變更通知,使用callback方式返回異步結果。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
type | string | 是 | 媒體類型 'deviceChange':?注冊設備變更 'albumChange':?相冊變更 'imageChange':?圖片文件變更 'audioChange': ?音頻文件變更 'videoChange': ?視頻文件變更 'fileChange': ?文件變更 'remoteFileChange':?注冊設備上文件變更 |
callback | callback<void> | 否 | 回調返回空 |
示例:
mediaLibrary.off('imageChange', () => {// stop listening success
})
createAsset?8+
createAsset(mediaType: MediaType, displayName: string, relativePath: string, callback: AsyncCallback<FileAsset>): void
創建媒體資源,使用callback方式返回結果。
需要權限:ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
mediaType | [MediaType] | 是 | 媒體類型 |
displayName | string | 是 | 展示文件名 |
relativePath | string | 是 | 文件保存路徑,可以通過[getPublicDirectory]獲取不同類型文件的保存路徑 |
callback | AsyncCallback<[FileAsset]> | 是 | 異步獲取媒體數據FileAsset之后的回調 |
示例:
async function example() {// 使用Callback方式創建Image類型文件let mediaType = mediaLibrary.MediaType.IMAGE;let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE;const path = await media.getPublicDirectory(DIR_IMAGE);media.createAsset(mediaType, 'imageCallBack.jpg', path + 'myPicture/', (err, fileAsset) => {if (fileAsset != undefined) {console.info('createAsset successfully, message = ' + err);} else {console.info('createAsset failed, message = ' + err);}});
}
createAsset8+
createAsset(mediaType: MediaType, displayName: string, relativePath: string): Promise<FileAsset>
創建媒體資源,使用Promise方式返回結果。
需要權限:ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
mediaType | [MediaType] | 是 | 媒體類型 |
displayName | string | 是 | 展示文件名 |
relativePath | string | 是 | 相對路徑,可以通過getPublicDirectory獲取不同類型媒體文件的一層目錄的relative path |
返回值
類型 | 說明 |
---|---|
[FileAsset] | 媒體數據FileAsset |
示例:
async function example() {// 使用Promise方式創建Image類型文件let mediaType = mediaLibrary.MediaType.IMAGE;let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE;const path = await media.getPublicDirectory(DIR_IMAGE);media.createAsset(mediaType, "image01.jpg", path + 'myPicture/').then (function (asset) {console.info("createAsset successfully:"+ JSON.stringify(asset));}).catch(function(err){console.info("createAsset failed with error:"+ err);});
}
getPublicDirectory8+
getPublicDirectory(type: DirectoryType, callback: AsyncCallback<string>): void
獲取公共目錄路徑,使用callback方式返回結果。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
type | [DirectoryType] | 是 | 公共目錄類型 |
callback | AsyncCallback<string> | 是 | callback 返回公共目錄路徑 |
示例:
let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA;
media.getPublicDirectory(DIR_CAMERA, (err, dicResult) => {if (dicResult == 'Camera/') {console.info('mediaLibraryTest : getPublicDirectory passed');} else {console.info('mediaLibraryTest : getPublicDirectory failed');}
});
getPublicDirectory8+
getPublicDirectory(type: DirectoryType): Promise<string>
獲取公共目錄路徑,使用Promise方式返回結果。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
type | [DirectoryType] | 是 | 公共目錄類型 |
返回值:
類型 | 說明 |
---|---|
Promise<string> | 返回公共目錄路徑 |
示例:
async function example() {let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA;const dicResult = await media.getPublicDirectory(DIR_CAMERA);if (dicResult == 'Camera/') {console.info('MediaLibraryTest : getPublicDirectory');} else {console.info('MediaLibraryTest : getPublicDirectory failed');}
}
getAlbums7+
getAlbums(options: MediaFetchOptions, callback: AsyncCallback<Array<Album>>): void
獲取相冊列表,使用callback 方式返回結果。
需要權限:ohos.permission.READ_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
options | [MediaFetchOptions] | 是 | 相冊獲取條件 |
callback | AsyncCallback<Array<[Album]>> | 是 | 異步獲取Album列表之后的回調 |
示例:
let AlbumNoArgsfetchOp = {selections: '',selectionArgs: [],
};
mediaLibrary.getAlbums(AlbumNoArgsfetchOp, (err, albumList) => {if (albumList != undefined) {const album = albumList[0];console.info('album.albumName = ' + album.albumName);console.info('album.count = ' + album.count);} else {console.info('getAlbum fail, message = ' + err);}
})
getAlbums7+
getAlbums(options: MediaFetchOptions): Promise<Array<Album>>
獲取相冊列表,使用 promise 方式返回結果。
需要權限:ohos.permission.READ_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
options | [MediaFetchOptions] | 是 | 相冊獲取條件 |
返回值:
類型 | 說明 |
---|---|
Promise<Array<[Album]>> | 返回Album列表 |
示例:
let AlbumNoArgsfetchOp = {selections: '',selectionArgs: [],
};
mediaLibrary.getAlbums(AlbumNoArgsfetchOp).then(function(albumList){console.info("getAlbums successfully:"+ JSON.stringify(albumList));
}).catch(function(err){console.info("getAlbums failed with error:"+ err);
});
release8+
release(callback: AsyncCallback<void>): void
釋放MediaLibrary實例。 當后續不需要使用MediaLibrary實例中的方法時調用。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 回調表示成功還是失敗 |
示例:
var media = mediaLibrary.getMediaLibrary(context);
media.release((err) => {// do something
});
release8+
release(): Promise<void>
釋放MediaLibrary實例。 當后續不需要使用MediaLibrary實例中的方法時調用。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
返回值:
類型 | 說明 |
---|---|
Promise<void> | Promise實例,用于獲取異步返回結果 |
示例:
var media = mediaLibrary.getMediaLibrary(context);
media.release()
storeMediaAsset(deprecated)
storeMediaAsset(option: MediaAssetOption, callback: AsyncCallback<string>): void
保存媒體資源,以異步方法獲取保存成功的URI,使用callback形式返回結果。
說明: 從API Version 9開始廢棄。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
option | [MediaAssetOption] | 是 | 媒體資源選項。 |
callback | AsyncCallback<string> | 是 | 媒體資源保存回調,返回保存成功后得到的URI。 |
示例:
let option = {src : "/data/storage/el2/base/haps/entry/image.png",mimeType : "image/*",relativePath : "Pictures/"
};
mediaLibrary.getMediaLibrary().storeMediaAsset(option, (err, value) => {if (err) {console.log("An error occurred when storing media resources.");return;}console.log("Media resources stored. ");// Obtain the URI that stores media resources.
});
storeMediaAsset(deprecated)
storeMediaAsset(option: MediaAssetOption): Promise<string>
保存媒體資源,以異步方法獲取保存成功的URI,使用Promise形式返回結果。
說明: 從API Version 9開始廢棄。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
option | [MediaAssetOption] | 是 | 媒體資源選項。 |
返回值:
類型 | 說明 |
---|---|
Promise<string> | Promise實例,用于異步獲取保存成功后得到的URI。 |
示例:
let option = {src : "/data/storage/el2/base/haps/entry/image.png",mimeType : "image/*",relativePath : "Pictures/"
};
mediaLibrary.getMediaLibrary().storeMediaAsset(option).then((value) => {console.log("Media resources stored.");// Obtain the URI that stores media resources.
}).catch((err) => {console.log("An error occurred when storing media resources.");
});
startImagePreview(deprecated)
startImagePreview(images: Array<string>, index: number, callback: AsyncCallback<void>): void
啟動圖片預覽界面并限定預覽開始顯示的圖片。可以預覽指定序號的單張本地圖片(dataability://),也可以預覽列表中的所有網絡圖片(https://)。使用callback方式進行異步回調。
說明: 從API Version 9開始廢棄。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
images | Array<string> | 是 | 預覽的圖片URI("https://","dataability://")列表。 |
index | number | 是 | 開始顯示的圖片序號。 |
callback | AsyncCallback<void> | 是 | 圖片預覽回調,失敗時返回錯誤信息。 |
示例:
let images = ["dataability:///media/xxxx/2","dataability:///media/xxxx/3"
];
/* 網絡圖片使用方式
let images = ["https://media.xxxx.com/image1.jpg","https://media.xxxx.com/image2.jpg"
];
*/
let index = 1;
mediaLibrary.getMediaLibrary().startImagePreview(images, index, (err) => {if (err) {console.log("An error occurred when previewing the images.");return;}console.log("Succeeded in previewing the images.");
});
startImagePreview(deprecated)
startImagePreview(images: Array<string>, callback: AsyncCallback<void>): void
啟動圖片預覽界面,可以預覽列表中首張本地圖片(dataability://),也可以預覽列表中的所有網絡圖片(https://)。使用callback方式進行異步回調。
說明: 從API Version 9開始廢棄。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
images | Array<string> | 是 | 預覽的圖片URI("https://","dataability://")列表。 |
callback | AsyncCallback<void> | 是 | 圖片預覽回調,失敗時返回錯誤信息。 |
示例:
let images = ["dataability:///media/xxxx/2","dataability:///media/xxxx/3"
];
/* 網絡圖片使用方式
let images = ["https://media.xxxx.com/image1.jpg","https://media.xxxx.com/image2.jpg"
];
*/
mediaLibrary.getMediaLibrary().startImagePreview(images, (err) => {if (err) {console.log("An error occurred when previewing the images.");return;}console.log("Succeeded in previewing the images.");
});
startImagePreview(deprecated)
startImagePreview(images: Array<string>, index?: number): Promise<void>
啟動圖片預覽界面并限定預覽開始顯示的圖片。可以預覽指定序號的單張本地圖片(dataability://),也可以預覽列表中的所有網絡圖片(https://)。使用Promise方式進行異步回調。
說明: 從API Version 9開始廢棄。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
images | Array<string> | 是 | 預覽的圖片URI("https://","dataability://")列表。 |
index | number | 否 | 開始顯示的圖片序號,不選擇時默認為0。 |
返回值:
類型 | 說明 |
---|---|
Promise<void> | Promise實例,用于異步獲取預覽結果,失敗時返回錯誤信息。 |
示例:
let images = ["dataability:///media/xxxx/2","dataability:///media/xxxx/3"
];
/* 網絡圖片使用方式
let images = ["https://media.xxxx.com/image1.jpg","https://media.xxxx.com/image2.jpg"
];
*/
let index = 1;
mediaLibrary.getMediaLibrary().startImagePreview(images, index).then(() => {console.log("Succeeded in previewing the images.");
}).catch((err) => {console.log("An error occurred when previewing the images.");
});
startMediaSelect(deprecated)
startMediaSelect(option: MediaSelectOption, callback: AsyncCallback<Array<string>>): void
啟動媒體選擇界面,以異步方法獲取選擇的媒體URI列表,使用callback形式返回結果。
說明: 從API Version 9開始廢棄。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
option | [MediaSelectOption] | 是 | 媒體選擇選項。 |
callback | AsyncCallback<Array<string>> | 是 | 媒體選擇回調,返回選擇的媒體URI(dataability://)列表。 |
示例:
let option = {type : "image",count : 2
};
mediaLibrary.getMediaLibrary().startMediaSelect(option, (err, value) => {if (err) {console.log("An error occurred when selecting media resources.");return;}console.log("Media resources selected.");// Obtain the media selection value.
});
startMediaSelect(deprecated)
startMediaSelect(option: MediaSelectOption): Promise<Array<string>>
啟動媒體選擇界面,以異步方法獲取選擇的媒體URI列表,使用Promise形式返回結果。
說明: 從API Version 9開始廢棄。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
option | [MediaSelectOption] | 是 | 媒體選擇選項。 |
返回值:
類型 | 說明 |
---|---|
Promise<Array<string>> | Promise實例,用于異步獲取選擇的媒體URI(dataability://)列表。 |
示例:
let option = {type : "image",count : 2
};
mediaLibrary.getMediaLibrary().startMediaSelect(option).then((value) => {console.log("Media resources selected.");// Obtain the media selection value.
}).catch((err) => {console.log("An error occurred when selecting media resources.");
});
FileAsset7+
提供封裝文件屬性的方法。
屬性
系統能力:??以下各項對應的系統能力均為SystemCapability.Multimedia.MediaLibrary.Core
名稱 | 類型 | 可讀 | 可寫 | 說明 |
---|---|---|---|---|
id | number | 是 | 否 | 文件資源編號 |
uri | string | 是 | 否 | 文件資源uri(如:dataability:///media/image/2) |
mimeType | string | 是 | 否 | 文件擴展屬性 |
mediaType8+ | [MediaType] | 是 | 否 | 媒體類型 |
displayName | string | 是 | 是 | 顯示文件名,包含后綴名 |
title | string | 是 | 是 | 文件標題 |
relativePath8+ | string | 是 | 是 | 相對公共目錄路徑 |
parent8+ | number | 是 | 否 | 父目錄id |
size | number | 是 | 否 | 文件大小(單位:字節) |
dateAdded | number | 是 | 否 | 添加日期(添加文件時間到1970年1月1日的秒數值) |
dateModified | number | 是 | 否 | 修改日期(修改文件時間到1970年1月1日的秒數值) |
dateTaken | number | 是 | 否 | 拍攝日期(文件拍照時間到1970年1月1日的秒數值) |
artist8+ | string | 是 | 否 | 作者 |
audioAlbum8+ | string | 是 | 否 | 專輯 |
width | number | 是 | 否 | 圖片寬度(單位:像素) |
height | number | 是 | 否 | 圖片高度(單位:像素) |
orientation | number | 是 | 是 | 圖片顯示方向(順時針旋轉角度,如0,90,180 單位:度) |
duration8+ | number | 是 | 否 | 持續時間(單位:毫秒) |
albumId | number | 是 | 否 | 文件所歸屬的相冊編號 |
albumUri8+ | string | 是 | 否 | 文件所歸屬相冊uri |
albumName | string | 是 | 否 | 文件所歸屬相冊名稱 |
isDirectory8+
isDirectory(callback: AsyncCallback<boolean>): void
判斷fileAsset是否為目錄,使用callback方式返回異步結果。
需要權限:ohos.permission.READ_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
callback | AsyncCallback<boolean> | 是 | 當前FileAsset是否是目錄的回調 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};const fetchFileResult = await media.getFileAssets(getImageOp);const asset = await fetchFileResult.getFirstObject();asset.isDirectory((err, isDirectory) => {// do something});
}
isDirectory8+
isDirectory():Promise<boolean>
判斷fileAsset是否為目錄,使用Promise方式返回異步結果。
需要權限:ohos.permission.READ_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
返回值:
類型 | 說明 |
---|---|
Promise<boolean> | Promise實例,返回當前FileAsset是否是目錄 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};const fetchFileResult = await media.getFileAssets(getImageOp);const asset = await fetchFileResult.getFirstObject();asset.isDirectory().then(function(isDirectory){console.info("isDirectory result:"+ isDirectory);}).catch(function(err){console.info("isDirectory failed with error:"+ err);});
}
commitModify8+
commitModify(callback: AsyncCallback<void>): void
修改文件的元數據,使用callback方式返回異步結果。
需要權限:ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 回調返回空 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};const fetchFileResult = await media.getFileAssets(getImageOp);const asset = await fetchFileResult.getFirstObject();asset.title = 'newtitle';asset.commitModify(() => {console.info('commitModify success'); });
}
commitModify8+
commitModify(): Promise<void>
修改文件的元數據,使用promise方式返回異步結果。
需要權限:ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
返回值:
類型 | 說明 |
---|---|
Promise<void> | Promise返回空 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};const fetchFileResult = await media.getFileAssets(getImageOp);const asset = await fetchFileResult.getFirstObject();asset.title = 'newtitle';asset.commitModify();
}
open8+
open(mode: string, callback: AsyncCallback<number>): void
打開當前文件,使用callback方式返回異步結果。
注意:當前寫操作是互斥的操作,寫操作完成后需要調用close進行釋放
需要權限:ohos.permission.READ_MEDIA('r'模式打開),ohos.permission.WRITE_MEDIA('w'模式打開)
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
mode | string | 是 | 打開文件方式,如:'r'(只讀), 'w'(只寫), 'rw'(讀寫) |
callback | AsyncCallback<number> | 是 | 回調返回文件句柄 |
示例:
async function example() {let mediaType = mediaLibrary.MediaType.IMAGE;let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE;const path = await media.getPublicDirectory(DIR_IMAGE);asset = await media.createAsset(mediaType, "image00003.jpg", path);asset.open('rw', (openError, fd) => {if(fd > 0){asset.close(fd);}else{console.info('File Open Failed!' + openError);}});
}
open8+
open(mode: string): Promise<number>
打開當前文件,使用promise方式返回異步結果。
注意:當前寫操作是互斥的操作,寫操作完成后需要調用close進行釋放
需要權限:ohos.permission.READ_MEDIA('r'模式打開),ohos.permission.WRITE_MEDIA('w'模式打開)
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
mode | string | 是 | 打開文件方式,如:'r'(只讀), 'w'(只寫), 'rw'(讀寫) |
返回值:
類型 | 說明 |
---|---|
Promise<number> | Promise返回文件句柄 |
示例:
async function example() {let mediaType = mediaLibrary.MediaType.IMAGE;let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE;const path = await media.getPublicDirectory(DIR_IMAGE);asset = await media.createAsset(mediaType, "image00003.jpg", path);asset.open('rw').then((fd) => {console.info('File fd!' + fd);}).catch((err) => {console.info('File err!' + err);});
}
close8+
close(fd: number, callback: AsyncCallback<void>): void
關閉當前文件,使用callback方式返回異步結果。
需要權限:ohos.permission.READ_MEDIA('r'模式打開),ohos.permission.WRITE_MEDIA('w'模式打開)
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
fd | number | 是 | 文件描述符 |
callback | AsyncCallback<void> | 是 | 回調返回空 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};const fetchFileResult = await media.getFileAssets(getImageOp);const asset = await fetchFileResult.getFirstObject();asset.close(fd, (closeErr) => {if (closeErr != undefined) {console.info('mediaLibraryTest : close : FAIL ' + closeErr.message);console.info('mediaLibraryTest : ASSET_CALLBACK : FAIL');} else {console.info("=======asset.close success====>");}});
}
close8+
close(fd: number): Promise<void>
關閉當前文件,使用promise方式返回異步結果。
需要權限:ohos.permission.READ_MEDIA('r'模式打開),ohos.permission.WRITE_MEDIA('w'模式打開)
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
fd | number | 是 | 文件描述符 |
返回值:
類型 | 說明 |
---|---|
Promise<void> | Promise返回空 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};const fetchFileResult = await media.getFileAssets(getImageOp);const asset = await fetchFileResult.getFirstObject();asset.close(fd).then((closeErr) => {if (closeErr != undefined) {console.info('mediaLibraryTest : close : FAIL ' + closeErr.message);console.info('mediaLibraryTest : ASSET_CALLBACK : FAIL');} else {console.info("=======asset.close success====>");}});
}
getThumbnail8+
getThumbnail(callback: AsyncCallback<image.PixelMap>): void
獲取文件的縮略圖,使用callback方式返回異步結果。
需要權限:ohos.permission.READ_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
callback | AsyncCallback<image.PixelMap> | 是 | 回調返回縮略圖的PixelMap |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};const fetchFileResult = await media.getFileAssets(getImageOp);const asset = await fetchFileResult.getFirstObject();asset.getThumbnail((err, pixelmap) => {console.info('mediaLibraryTest : getThumbnail Successfull '+ pixelmap);});
}
getThumbnail8+
getThumbnail(size: Size, callback: AsyncCallback<image.PixelMap>): void
獲取文件的縮略圖,傳入縮略圖尺寸,使用callback方式返回異步結果。
需要權限:ohos.permission.READ_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
size | [Size] | 是 | 縮略圖尺寸 |
callback | AsyncCallback<image.PixelMap> | 是 | 回調返回縮略圖的PixelMap |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};const fetchFileResult = await media.getFileAssets(getImageOp);const asset = await fetchFileResult.getFirstObject();asset.getThumbnail(size, (err, pixelmap) => {console.info('mediaLibraryTest : getThumbnail Successfull '+ pixelmap);});
}
getThumbnail8+
getThumbnail(size?: Size): Promise<image.PixelMap>
獲取文件的縮略圖,傳入縮略圖尺寸,使用promise方式返回異步結果。
需要權限:ohos.permission.READ_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
size | [Size] | 否 | 縮略圖尺寸 |
返回值:
類型 | 說明 |
---|---|
Promise<image.PixelMap> | Promise返回縮略圖的PixelMap |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};const fetchFileResult = await media.getFileAssets(getImageOp);const asset = await fetchFileResult.getFirstObject();asset.getThumbnail(size).then((pixelmap) => {console.info('mediaLibraryTest : getThumbnail Successfull '+ pixelmap);}).catch((err) => {console.info('mediaLibraryTest : getThumbnail fail'+ err);});
}
favorite8+
favorite(isFavorite: boolean, callback: AsyncCallback<void>): void
將文件設置為收藏文件,使用callback方式返回異步結果。
需要權限:ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
isFavorite | boolean | 是 | 是否設置為收藏文件, true:設置為收藏文件,false:取消收藏 |
callback | AsyncCallback<void> | 是 | 回調返回空 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};const fetchFileResult = await media.getFileAssets(getImageOp);const asset = await fetchFileResult.getFirstObject();asset.favorite(true,function(err){// do something});
}
favorite8+
favorite(isFavorite: boolean): Promise<void>
將文件設置為收藏文件,使用promise方式返回異步結果。
需要權限:ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
isFavorite | boolean | 是 | 是否設置為收藏文件, true:設置為收藏文件,false:取消收藏 |
返回值:
類型 | 說明 |
---|---|
Promise<void> | Promise返回空 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};const fetchFileResult = await media.getFileAssets(getImageOp);const asset = await fetchFileResult.getFirstObject();asset.favorite(true).then(function() {console.info("favorite successfully");}).catch(function(err){console.info("favorite failed with error:"+ err);});
}
isFavorite8+
isFavorite(callback: AsyncCallback<boolean>): void
判斷該文件是否為收藏文件,使用callback方式返回異步結果。
需要權限:ohos.permission.READ_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
callback | AsyncCallback<boolean> | 是 | 回調表示是否為收藏文件 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};const fetchFileResult = await media.getFileAssets(getImageOp);const asset = await fetchFileResult.getFirstObject();asset.isFavorite((err, isFavorite) => {if (isFavorite) {console.info('FileAsset is favorite');}else{console.info('FileAsset is not favorite');}});
}
isFavorite8+
isFavorite():Promise<boolean>
判斷該文件是否為收藏文件,使用promise方式返回異步結果。
需要權限:ohos.permission.READ_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
返回值:
類型 | 說明 |
---|---|
Promise<boolean> | Promise回調表示是否是收藏文件 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};const fetchFileResult = await media.getFileAssets(getImageOp);const asset = await fetchFileResult.getFirstObject();asset.isFavorite().then(function(isFavorite){console.info("isFavorite result:"+ isFavorite);}).catch(function(err){console.info("isFavorite failed with error:"+ err);});
}
trash8+
trash(isTrash: boolean, callback: AsyncCallback<void>): void
當文件被定位時,將文件放到垃圾文件夾,使用callback方式返回異步結果。
放入垃圾文件夾的文件不會被真正刪除,可以通過isTrash = false參數恢復成正常文件。
需要權限:ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
isTrash | boolean | 是 | 是否設置為垃圾文件 |
callback | AsyncCallback<void> | 是 | 回調返回空 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};const fetchFileResult = await media.getFileAssets(getImageOp);const asset = await fetchFileResult.getFirstObject();asset.trash(true, trashCallBack);function trashCallBack(err, trash) {console.info('mediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK trash');}
}
trash8+
trash(isTrash: boolean): Promise<void>
當文件被定位時,將文件放到垃圾文件夾,使用promise方式返回異步結果。
放入垃圾文件夾的文件不會被真正刪除,可以通過isTrash = false參數恢復成正常文件。
需要權限:ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
isTrash | boolean | 是 | 是否設置為垃圾文件 |
返回值:
類型 | 說明 |
---|---|
Promise<void> | Promise返回空 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};const fetchFileResult = await media.getFileAssets(getImageOp);const asset = await fetchFileResult.getFirstObject();asset.trash(true).then(function() {console.info("trash successfully");}).catch(function(err){console.info("trash failed with error:"+ err);});
}
isTrash8+
isTrash(callback: AsyncCallback<boolean>): void
當文件被定位,判斷文件是否為垃圾文件,使用callback方式返回異步結果。
需要權限:ohos.permission.READ_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
callback | AsyncCallback<boolean> | 是 | 回調返回表示文件是否為垃圾文件 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};const fetchFileResult = await media.getFileAssets(getImageOp);const asset = await fetchFileResult.getFirstObject();asset.isTrash(isTrashCallBack);function isTrashCallBack(err, isTrash) {if (isTrash == true) {console.info('mediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK isTrash = ' + isTrash);asset.trash(true, trashCallBack);} else {console.info('mediaLibraryTest : ASSET_CALLBACK isTrash Unsuccessfull = ' + err);console.info('mediaLibraryTest : ASSET_CALLBACK isTrash : FAIL');}}
}
isTrash8+
isTrash():Promise<boolean>
當文件被定位,判斷文件是否為垃圾文件,使用promise方式返回異步結果。
需要權限:ohos.permission.READ_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
返回值:
類型 | 說明 |
---|---|
Promise<void> | Promise回調表示文件是否為垃圾文件 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};const fetchFileResult = await media.getFileAssets(getImageOp);const asset = await fetchFileResult.getFirstObject();asset.isTrash().then(function(isTrash){console.info("isTrash result:"+ isTrash);}).catch(function(err){console.info("isTrash failed with error:"+ err);});
}
FetchFileResult7+
文件檢索結果集。
getCount7+
getCount(): number
獲取文件檢索結果中的文件總數。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
返回值:
類型 | 說明 |
---|---|
number | 檢索到的文件總數 |
示例:
async function example() {let getFileCountOneOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [fileType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};let fetchFileResult = await media.getFileAssets(getFileCountOneOp);const fetchCount = fetchFileResult.getCount();
}
isAfterLast7+
isAfterLast(): boolean
檢查結果集是否指向最后一行。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
返回值:
類型 | 說明 |
---|---|
boolean | 當讀到最后一條記錄后,后續沒有記錄返回true,否則返回false。 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};let fetchFileResult = await media.getFileAssets(getImageOp);const fetchCount = fetchFileResult.getCount();console.info('mediaLibraryTest : count:' + fetchCount);let fileAsset = await fetchFileResult.getFirstObject();for (var i = 1; i < fetchCount; i++) {fileAsset = await fetchFileResult.getNextObject();if(i == fetchCount - 1) {console.info('mediaLibraryTest : isLast');var result = fetchFileResult.isAfterLast();console.info('mediaLibraryTest : isAfterLast:' + result);console.info('mediaLibraryTest : isAfterLast end');fetchFileResult.close();}}
}
close7+
close(): void
釋放 FetchFileResult 實例并使其失效。無法調用其他方法。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};let fetchFileResult = await media.getFileAssets(getImageOp);fetchFileResult.close();
}
getFirstObject7+
getFirstObject(callback: AsyncCallback<FileAsset>): void
獲取文件檢索結果中的第一個文件資產。此方法使用回調返回FileAsset。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
callback | AsyncCallback<[FileAsset]> | 是 | 異步獲取結果集中第一個FileAsset完成后的回調 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};let fetchFileResult = await media.getFileAssets(getImageOp);fetchFileResult.getFirstObject((err, value) => {if (err) {console.error('Failed ');return;}console.log(value);})
}
getFirstObject7+
getFirstObject(): Promise<FileAsset>
獲取文件檢索結果中的第一個文件資產。此方法使用Promise方式返回FileAsset。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
返回值:
類型 | 說明 |
---|---|
Promise<[FileAsset]> | Promise方式返回FileAsset。 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};let fetchFileResult = await media.getFileAssets(getImageOp);fetchFileResult.getFirstObject().then(function(fileAsset){console.info("getFirstObject successfully:"+ JSON.stringify(fileAsset));}).catch(function(err){console.info("getFirstObject failed with error:"+ err);});
}
getNextObject7+
getNextObject(callback: AsyncCallback<FileAsset>): void
獲取文件檢索結果中的下一個文件資產。此方法使用callback形式返回結果。
需要權限:ohos.permission.READ_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
callbacke | AsyncCallback<[FileAsset]> | 是 | 異步返回結果集中下一個FileAsset之后的回調 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};let fetchFileResult = await media.getFileAssets(getImageOp);fetchFileResult.getNextObject((err, value) => {if (err) {console.error('Failed ');return;}console.log(value);})
}
getNextObject7+
getNextObject(): Promise<FileAsset>
獲取文件檢索結果中的下一個文件資產。此方法使用promise方式來異步返回FileAsset。
需要權限:ohos.permission.READ_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
返回值:
類型 | 說明 |
---|---|
Promise<[FileAsset]> | 返回FileAsset對象 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};let fetchFileResult = await media.getFileAssets(getImageOp);const fetchCount = fetchFileResult.getCount();console.info('mediaLibraryTest : count:' + fetchCount);fileAsset = await fetchFileResult.getNextObject();
}
getLastObject7+
getLastObject(callback: AsyncCallback<FileAsset>): void
獲取文件檢索結果中的最后一個文件資產。此方法使用callback回調來返回FileAsset。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
callback | AsyncCallback<[FileAsset]> | 是 | 異步返回FileAsset之后的回調 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};let fetchFileResult = await media.getFileAssets(getImageOp);fetchFileResult.getLastObject((err, value) => {if (err) {console.error('Failed ');return;}console.log(value);})
}
getLastObject7+
getLastObject(): Promise<FileAsset>
獲取文件檢索結果中的最后一個文件資產。此方法使用Promise方式來返回FileAsset。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
返回值:
類型 | 說明 |
---|---|
Promise<[FileAsset]> | 返回FileAsset對象 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};let fetchFileResult = await media.getFileAssets(getImageOp);let lastObject = await fetchFileResult.getLastObject();
}
getPositionObject7+
getPositionObject(index: number, callback: AsyncCallback<FileAsset>): void
獲取文件檢索結果中具有指定索引的文件資產。此方法使用回調來返回FileAsset。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
index | number | 是 | 要獲取的文件的索引,從0開始 |
callback | AsyncCallback<[FileAsset]> | 是 | 異步返回FileAsset之后的回調 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};let fetchFileResult = await media.getFileAssets(getImageOp);fetchFileResult.getPositionObject(0, (err, value) => {if (err) {console.error('Failed ');return;}console.log(value);})
}
getPositionObject7+
getPositionObject(index: number): Promise<FileAsset>
獲取文件檢索結果中具有指定索引的文件資產。此方法使用Promise形式返回文件Asset。
需要權限:ohos.permission.READ_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
index | number | 是 | 要獲取的文件的索引,從0開始 |
返回值:
類型 | 說明 |
---|---|
Promise<[FileAsset]> | 返回FileAsset對象 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};let fetchFileResult = await media.getFileAssets(getImageOp);fetchFileResult.getPositionObject(1, (err, value) => {if (err) {console.error('Failed ');return;}console.log(value);})
}
getAllObject7+
getAllObject(callback: AsyncCallback<Array<FileAsset>>): void
獲取文件檢索結果中的所有文件資產。此方法使用Callback回調來返回FileAsset結果集。
需要權限:ohos.permission.READ_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
callback | AsyncCallback<Array<[FileAsset]>> | 是 | 異步返回FileAsset列表之后的回調 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};let fetchFileResult = await media.getFileAssets(getImageOp);fetchFileResult.getAllObject((err, value) => {if (err) {console.error('Failed ');return;}console.log(value);})
}
getAllObject7+
getAllObject(): Promise<Array<FileAsset>>
獲取文件檢索結果中的所有文件資產。此方法使用Promise來返回FileAsset結果集。
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
返回值:
類型 | 說明 |
---|---|
Promise<Array<[FileAsset]>> | 返回FileAsset對象列表 |
示例:
async function example() {let imageType = mediaLibrary.MediaType.IMAGE;let getImageOp = {selections: fileKeyObj.MEDIA_TYPE + '= ?',selectionArgs: [imageType.toString()],order: fileKeyObj.DATE_ADDED + " DESC",extendArgs: "",};let fetchFileResult = await media.getFileAssets(getImageOp);var data = fetchFileResult.getAllObject();
}
Album7+
實體相冊
屬性
系統能力:??以下各項對應的系統能力均為SystemCapability.Multimedia.MediaLibrary.Core
名稱 | 類型 | 可讀 | 可寫 | 說明 |
---|---|---|---|---|
albumId | number | 是 | 否 | 相冊編號 |
albumName | string | 是 | 是 | 相冊名稱 |
albumUri8+ | string | 是 | 否 | 相冊Uri |
dateModified | number | 是 | 否 | 修改日期 |
count8+ | number | 是 | 否 | 相冊中文件數量 |
relativePath8+ | string | 是 | 否 | 相對路徑 |
coverUri8+ | string | 是 | 否 | 封面文件Uri |
commitModify8+
commitModify(callback: AsyncCallback<void>): void
更新相冊屬性修改到數據庫中。
需要權限:ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 回調返回空 |
示例:
async function example() {let AlbumNoArgsfetchOp = {selections: '',selectionArgs: [],};const albumList = await media.getAlbums(AlbumNoArgsfetchOp);const album = albumList[0];album.albumName = 'hello';album.commitModify((err) => {if (err) {console.error('Failed ');return;}console.log('Modify successful.');})
}
commitModify8+
commitModify(): Promise<void>
更新相冊屬性修改到數據庫中。
需要權限:ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
返回值:
類型 | 說明 |
---|---|
Promise<void> | Promise調用返回空 |
示例:
async function example() {let AlbumNoArgsfetchOp = {selections: '',selectionArgs: [],};const albumList = await media.getAlbums(AlbumNoArgsfetchOp);const album = albumList[0];album.albumName = 'hello';album.commitModify().then(function() {console.info("commitModify successfully");}).catch(function(err){console.info("commitModify failed with error:"+ err);});
}
getFileAssets7+
getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileResult>): void
按照檢索條件獲取相冊中的文件。此方法使用Callback回調來返回文件結果集。
需要權限:ohos.permission.READ_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
options | [MediaFetchOptions] | 是 | 媒體檢索選項。 |
callback | AsyncCallback<[FetchFileResult]> | 是 | 異步返回FetchFileResult之后的回調。 |
示例:
async function example() {let AlbumNoArgsfetchOp = {selections: '',selectionArgs: [],};const albumList = await media.getAlbums(AlbumNoArgsfetchOp);const album = albumList[0];album.getFileAssets(fileNoArgsfetchOp, getFileAssetsCallBack);function getFileAssetsCallBack(err, fetchFileResult) {// do something}
}
getFileAssets7+
getFileAssets(options?: MediaFetchOptions): Promise<FetchFileResult>
按照檢索條件獲取相冊中的文件。此方法使用異步Promise來返回文件結果集。
需要權限:ohos.permission.READ_MEDIA
系統能力:SystemCapability.Multimedia.MediaLibrary.Core
參數:
參數名 | 類型 | 必填 | 說明 |
---|---|---|---|
options | [MediaFetchOptions] | 否 | 媒體檢索選項。 |
返回值:
類型 | 說明 |
---|---|
Promise<[FetchFileResult]> | 返回FetchFileResult對象。 |
示例:
async function example() {let AlbumNoArgsfetchOp = {selections: '',selectionArgs: [],};const albumList = await media.getAlbums(AlbumNoArgsfetchOp);const album = albumList[0];album.getFileAssets(fileNoArgsfetchOp).then(function(albumFetchFileResult){console.info("getFileAssets successfully:"+ JSON.stringify(albumFetchFileResult));}).catch(function(err){console.info("getFileAssets failed with error:"+ err);});
}
PeerInfo8+
注冊設備的信息。
系統能力:??以下各項對應的系統能力均為SystemCapability.Multimedia.MediaLibrary.Core
名稱 | 類型 | 可讀 | 可寫 | 說明 |
---|---|---|---|---|
deviceName | string | 是 | 否 | 注冊設備的名稱 |
networkId | string | 是 | 否 | 注冊設備的網絡ID |
deviceType | [DeviceType] | 是 | 否 | 設備類型 |
isOnline | boolean | 是 | 否 | 是否在線 |
MediaType8+
枚舉,媒體類型。
系統能力:??以下各項對應的系統能力均為SystemCapability.Multimedia.MediaLibrary.Core
名稱 | 默認值 | 說明 |
---|---|---|
FILE | 1 | 文件 |
IMAGE | 3 | 圖片 |
VIDEO | 4 | 視頻 |
AUDIO | 5 | 音頻 |
FileKey8+
枚舉,文件關鍵信息。
系統能力:??以下各項對應的系統能力均為SystemCapability.Multimedia.MediaLibrary.Core
名稱 | 默認值 | 說明 |
---|---|---|
ID | file_id | 文件編號 |
RELATIVE_PATH | relative_path | 相對公共目錄路徑 |
DISPLAY_NAME | display_name | 顯示名字 |
PARENT | parent | 父目錄id |
MIME_TYPE | mime_type | 文件擴展屬性 |
MEDIA_TYPE | media_type | 媒體類型 |
SIZE | size | 文件大小(單位:字節) |
DATE_ADDED | date_added | 添加日期(添加文件時間到1970年1月1日的秒數值) |
DATE_MODIFIED | date_modified | 修改日期(修改文件時間到1970年1月1日的秒數值) |
DATE_TAKEN | date_taken | 拍攝日期(文件拍照時間到1970年1月1日的秒數值) |
TITLE | title | 文件標題 |
ARTIST | artist | 作者 |
AUDIOALBUM | audio_album | 專輯 |
DURATION | duration | 持續時間(單位:秒) |
WIDTH | width | 圖片寬度(單位:像素) |
HEIGHT | height | 圖片高度(單位:像素) |
ORIENTATION | orientation | 圖片顯示方向,即順時針旋轉角度,如0,90,180。(單位:度) |
ALBUM_ID | bucket_id | 文件所歸屬的相冊編號 |
ALBUM_NAME | bucket_display_name | 文件所歸屬相冊名稱 |
DirectoryType8+
枚舉,目錄類型。
系統能力:??以下各項對應的系統能力均為SystemCapability.Multimedia.MediaLibrary.Core
名稱 | 默認值 | 說明 |
---|---|---|
DIR_CAMERA | 0 | 表示Camera文件路徑 |
DIR_VIDEO | 1 | 表示視頻路徑 |
DIR_IMAGE | 2 | 表示圖片路徑 |
DIR_AUDIO | 3 | 表示音頻路徑 |
DIR_DOCUMENTS | 4 | 表示文檔路徑 |
DIR_DOWNLOAD | 5 | 表示下載路徑 |
DeviceType8+
枚舉,設備類型。
系統能力:??以下各項對應的系統能力均為SystemCapability.Multimedia.MediaLibrary.Core
名稱 | 默認值 | 說明 |
---|---|---|
TYPE_UNKNOWN | 0 | 未識別設備 |
TYPE_LAPTOP | 1 | 筆記本電腦 |
TYPE_PHONE | 2 | 手機 |
TYPE_TABLET | 3 | 平板電腦 |
TYPE_WATCH | 4 | 智能手表 |
TYPE_CAR | 5 | 車載設備 |
TYPE_TV | 6 | 電視設備 |
MediaFetchOptions7+
檢索條件。
系統能力:??以下各項對應的系統能力均為SystemCapability.Multimedia.MediaLibrary.Core
名稱 | 類型 | 可讀 | 可寫 | 必填 | 說明 |
---|---|---|---|---|---|
selections | string | 是 | 是 | 是 | 檢索條件,使用[FileKey]中的枚舉值作為檢索條件的列名。示例: selections: mediaLibrary.FileKey.MEDIA_TYPE + '= ? OR' +mediaLibrary.FileKey.MEDIA_TYPE + '= ?‘, |
selectionArgs | Array<string> | 是 | 是 | 是 | 檢索條件的值,對應selections中檢索條件列的值。 示例: selectionArgs: [mediaLibrary.MediaType.IMAGE.toString(), mediaLibrary.MediaType.VIDEO.toString()], |
order | string | 是 | 是 | 否 | 檢索結果排序方式,使用[FileKey]中的枚舉值作為檢索結果排序的列,可以用升序或降序排列。示例: 升序排列:order: mediaLibrary.FileKey.DATE_ADDED + " AESC" 降序排列:order: mediaLibrary.FileKey.DATE_ADDED + " DESC" |
uri8+ | string | 是 | 是 | 否 | 文件URI |
networkId8+ | string | 是 | 是 | 否 | 注冊設備網絡ID |
extendArgs8+ | string | 是 | 是 | 否 | 擴展的檢索參數,目前沒有擴展檢索參數 |
Size8+
圖片尺寸。
名稱 | 類型 | 可讀 | 可寫 | 說明 |
---|---|---|---|---|
width | number | 是 | 是 | 寬(單位:像素) |
height | number | 是 | 是 | 高(單位:像素) |
MediaAssetOption(deprecated)
媒體資源選項。
說明: 從API Version 9開始廢棄。
系統能力:??以下各項對應的系統能力均為SystemCapability.Multimedia.MediaLibrary.Core
名稱 | 類型 | 必填 | 描述 |
---|---|---|---|
src | string | 是 | 本地文件應用沙箱路徑。 |
mimeType | string | 是 | 媒體MIME(Multipurpose?Internet?Mail?Extensions)類型。 包括:'image/'、'video/'、'audio/'、 'file'。 |
relativePath | string | 否 | 自定義媒體資源保存位置,例:Pictures/ 不填則保存到默認路徑。 image類型默認路徑Pictures/ video類型默認路徑Videos/ audio類型默認路徑Audios/ file類型默認路徑Documents/ 。 |
MediaSelectOption(deprecated)
媒體資源類型選項。
說明: 從API Version 9開始廢棄。
系統能力:??以下各項對應的系統能力均為SystemCapability.Multimedia.MediaLibrary.Core
名稱 | 類型 | 必填 | 描述?HarmonyOS與OpenHarmony鴻蒙文檔籽料:mau123789是v直接拿 |
---|---|---|---|
type | string | 是 | 媒體類型,包括:image, video, media,當前僅支持media類型 |
count | number | 是 | 媒體選擇,count = 1表示單選,count大于1表示多選。 |
到這里我們就基本上學完了這個知識點,當然如果說要真正參與到鴻蒙的開發當中,要學的還有很多。大家可以看看下面這個鴻蒙入門到實戰的學習技術路線圖:
?而隨著鴻蒙的火熱,現階段已有許多Android、前端等開發者看中其未來趨勢;想從網上查閱學習,但搜索到的鴻蒙資料都是七零八碎的,對此為了避免大家在學習過程中浪費過多時間,特地根據鴻蒙官方發布文檔結合華為內部人員的分享,經過反復修改整理得出:
整套鴻蒙(HarmonyOS NEXT)學習手冊(共計1236頁)與鴻蒙(HarmonyOS NEXT)開發入門&實戰教學視頻(200集+)發放給大家。
內容包含了:(ArkTS、ArkUI、Stage模型、多端部署、分布式應用開發、音頻、視頻、WebGL、OpenHarmony多媒體技術、Napi組件、OpenHarmony內核、鴻蒙南向開發、鴻蒙項目實戰)等技術知識點。幫助大家在學習鴻蒙路上少走彎路!下面點擊↓↓↓拿
廢話不多說,接下來好好看下這份資料。
《鴻蒙 (HarmonyOS NEXT)開發基礎到實戰手冊》
OpenHarmony北向、南向開發環境搭建
《鴻蒙開發基礎》
-
ArkTS語言
-
安裝DevEco Studio
-
運用你的第一個ArkTS應用
-
ArkUI聲明式UI開發
-
.……
《鴻蒙開發進階》
-
Stage模型入門
-
網絡管理
-
數據管理
-
電話服務
-
分布式應用開發
-
通知與窗口管理
-
多媒體技術
-
安全技能
-
任務管理
-
WebGL
-
國際化開發
-
應用測試
-
DFX面向未來設計
-
鴻蒙系統移植和裁剪定制
-
……
《鴻蒙開發實戰》
-
ArkTS實踐
-
UIAbility應用
-
網絡案例
-
……
《鴻蒙?(HarmonyOS NEXT)開發入門&實戰教學視頻》??
↑↑↑點擊即可