/* * Copyright (C) 2022 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @file * @kit MediaLibraryKit */ import { AsyncCallback, Callback } from './@ohos.base'; import Context from './application/Context'; import image from './@ohos.multimedia.image'; /** * @name mediaLibrary * @since 6 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ declare namespace mediaLibrary { /** * Obtains a MediaLibrary instance. * @since 6 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @FAModelOnly * @returns Returns a MediaLibrary instance if the operation is successful; returns null otherwise. * @deprecated since 9 * @useinstead ohos.file.picker */ function getMediaLibrary(): MediaLibrary; /** * Returns an instance of MediaLibrary * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @StageModelOnly * @param context hap context information * @returns Instance of MediaLibrary * @deprecated since 9 * @useinstead ohos.file.picker */ function getMediaLibrary(context: Context): MediaLibrary; /** * Enumeration types for different kind of Media Files * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ enum MediaType { /** * File media type * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ FILE = 0, /** * Image media type * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ IMAGE, /** * Video media type * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ VIDEO, /** * Audio media type * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ AUDIO } /** * Describes media resource options. * @since 6 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 */ interface MediaAssetOption { /** * URI of the media source. * @since 6 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 */ src: string; /** * Multipurpose Internet Mail Extensions (MIME) type of the media. * @since 6 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 */ mimeType: string; /** * Relative path for storing media resources. * @since 6 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 */ relativePath?: string; } /** * Describes media selection options. * @since 6 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 */ interface MediaSelectOption { /** * Media type, which can be image, video, or media (indicating both image and video). * @since 6 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 */ type: 'image' | 'video' | 'media'; /** * Maximum number of media items that can be selected * @since 6 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 */ count: number; } /** * Provides methods to encapsulate file attributes. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ interface FileAsset { /** * File ID. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly id: number; /** * URI of the file. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly uri: string; /** * MIME type, for example, video/mp4, audio/mp4, or audio/amr-wb. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly mimeType: string; /** * Media type, for example, IMAGE, VIDEO, FILE, AUDIO * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly mediaType: MediaType; /** * Display name (with a file name extension) of the file. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ displayName: string; /** * File name title (without the file name extension). * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ title: string; /** * Relative Path of the file. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ relativePath: string; /** * Parent folder's file_id of the file. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly parent: number; /** * Data size of the file. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly size: number; /** * Date (timestamp) when the file was added. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly dateAdded: number; /** * Date (timestamp) when the file was modified. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly dateModified: number; /** * Date (timestamp) when the file was taken. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly dateTaken: number; /** * Artist of the audio file. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly artist: string; /** * audioAlbum of the audio file. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly audioAlbum: string; /** * Display width of the file. This is valid only for videos and images. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly width: number; /** * Display height of the file. This is valid only for videos and images. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly height: number; /** * Rotation angle of the file, in degrees. * The rotation angle can be 0, 90, 180, or 270 degrees. This is valid only for videos. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ orientation: number; /** * duration of the audio and video file. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly duration: number; /** * ID of the album where the file is located. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly albumId: number; /** * URI of the album where the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly albumUri: string; /** * Name of the album where the file is located. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly albumName: string; /** * If it is a directory where the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @param callback Callback return the result of isDirectory. * @deprecated since 9 * @useinstead ohos.file.picker */ isDirectory(callback: AsyncCallback): void; /** * If it is a directory where the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @deprecated since 9 * @useinstead ohos.file.picker */ isDirectory(): Promise; /** * Modify meta data where the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA * @param callback no value will be returned. * @deprecated since 9 * @useinstead ohos.file.picker */ commitModify(callback: AsyncCallback): void; /** * Modify meta data where the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA * @deprecated since 9 * @useinstead ohos.file.picker */ commitModify(): Promise; /** * Open the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA or ohos.permission.WRITE_MEDIA * @param mode mode for open, for example: rw, r, w. * @param callback Callback return the fd of the file. * @deprecated since 9 * @useinstead ohos.file.picker */ open(mode: string, callback: AsyncCallback): void; /** * Open the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA or ohos.permission.WRITE_MEDIA * @param mode mode for open, for example: rw, r, w. * @deprecated since 9 * @useinstead ohos.file.picker */ open(mode: string): Promise; /** * Close the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA or ohos.permission.WRITE_MEDIA * @param fd fd of the file which had been opened * @param callback no value will be returned. * @deprecated since 9 * @useinstead ohos.file.picker */ close(fd: number, callback: AsyncCallback): void; /** * Close the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA or ohos.permission.WRITE_MEDIA * @param fd fd of the file which had been opened * @deprecated since 9 * @useinstead ohos.file.picker */ close(fd: number): Promise; /** * Get thumbnail of the file when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @param callback Callback used to return the thumbnail's pixelmap. * @deprecated since 9 * @useinstead ohos.file.picker */ getThumbnail(callback: AsyncCallback): void; /** * Get thumbnail of the file when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @param size thumbnail's size * @param callback Callback used to return the thumbnail's pixelmap. * @deprecated since 9 * @useinstead ohos.file.picker */ getThumbnail(size: Size, callback: AsyncCallback): void; /** * Get thumbnail of the file when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @param size thumbnail's size * @deprecated since 9 * @useinstead ohos.file.picker */ getThumbnail(size?: Size): Promise; /** * Set favorite for the file when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA * @param isFavorite true is favorite file, false is not favorite file * @param callback Callback used to return, No value is returned. * @deprecated since 9 * @useinstead ohos.file.picker */ favorite(isFavorite: boolean, callback: AsyncCallback): void; /** * Set favorite for the file when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA * @param isFavorite true is favorite file, false is not favorite file * @deprecated since 9 * @useinstead ohos.file.picker */ favorite(isFavorite: boolean): Promise; /** * If the file is favorite when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @param callback Callback used to return true or false. * @deprecated since 9 * @useinstead ohos.file.picker */ isFavorite(callback: AsyncCallback): void; /** * If the file is favorite when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @deprecated since 9 * @useinstead ohos.file.picker */ isFavorite(): Promise; /** * Set trash for the file when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA * @param isTrash true is trashed file, false is not trashed file * @param callback Callback used to return, No value is returned. * @deprecated since 9 * @useinstead ohos.file.picker */ trash(isTrash: boolean, callback: AsyncCallback): void; /** * Set trash for the file when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA * @param isTrash true is trashed file, false is not trashed file * @deprecated since 9 * @useinstead ohos.file.picker */ trash(isTrash: boolean): Promise; /** * If the file is in trash when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @param callback Callback used to return true or false. * @deprecated since 9 * @useinstead ohos.file.picker */ isTrash(callback: AsyncCallback): void; /** * If the file is in trash when the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @deprecated since 9 * @useinstead ohos.file.picker */ isTrash(): Promise; } /** * Describes MediaFetchOptions's selection * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ enum FileKey { /** * File ID * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ ID = "file_id", /** * Relative Path * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ RELATIVE_PATH = "relative_path", /** * File name * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ DISPLAY_NAME = "display_name", /** * Parent folder file id * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ PARENT = "parent", /** * Mime type of the file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ MIME_TYPE = "mime_type", /** * Media type of the file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ MEDIA_TYPE = "media_type", /** * Size of the file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ SIZE = "size", /** * Date of the file creation * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ DATE_ADDED = "date_added", /** * Modify date of the file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ DATE_MODIFIED = "date_modified", /** * Date taken of the file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ DATE_TAKEN = "date_taken", /** * Title of the file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ TITLE = "title", /** * Artist of the audio file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ ARTIST = "artist", /** * Audio album of the audio file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ AUDIOALBUM = "audio_album", /** * Duration of the audio and video file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ DURATION = "duration", /** * Width of the image file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ WIDTH = "width", /** * Height of the image file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ HEIGHT = "height", /** * Orientation of the image file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ ORIENTATION = "orientation", /** * Album id of the file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ ALBUM_ID = "bucket_id", /** * Album name of the file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ ALBUM_NAME = "bucket_display_name", } /** * Fetch parameters applicable on images, videos, audios, albums and other media * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ interface MediaFetchOptions { /** * Fields to retrieve, for example, selections: "media_type =? OR media_type =?". * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ selections: string; /** * Conditions for retrieval, for example, selectionArgs: [IMAGE, VIDEO]. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ selectionArgs: Array; /** * Sorting criterion of the retrieval results, for example, order: "dateTaken DESC,display_name DESC, file_id DESC". * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ order?: string; /** * uri for retrieval * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ uri?: string; /** * networkId for retrieval * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ networkId?: string; /** * extendArgs for retrieval * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ extendArgs?: string; } /** * Implements file retrieval. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ interface FetchFileResult { /** * Obtains the total number of files in the file retrieval result. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @returns Total number of files. * @deprecated since 9 * @useinstead ohos.file.picker */ getCount(): number; /** * Checks whether the result set points to the last row. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @returns Whether the file is the last one. * @deprecated since 9 * @useinstead ohos.file.picker * You need to check whether the file is the last one before calling getNextObject, * which returns the next file only when False is returned for this method. */ isAfterLast(): boolean; /** * Releases the FetchFileResult instance and invalidates it. Other methods cannot be called. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ close(): void; /** * Obtains the first FileAsset in the file retrieval result. This method uses a callback to return the file. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param callback Callback used to return the file in the format of a FileAsset instance. * @deprecated since 9 * @useinstead ohos.file.picker */ getFirstObject(callback: AsyncCallback): void; /** * Obtains the first FileAsset in the file retrieval result. This method uses a promise to return the file. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @returns A Promise instance used to return the file in the format of a FileAsset instance. * @deprecated since 9 * @useinstead ohos.file.picker */ getFirstObject(): Promise; /** * Obtains the next FileAsset in the file retrieval result. * This method uses a callback to return the file. * Before calling this method, you must use isAfterLast() to check whether the result set points to the last row. * This method returns the next file only when False is returned for isAfterLast(). * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param callback Callback used to return the file in the format of a FileAsset instance. * @deprecated since 9 * @useinstead ohos.file.picker */ getNextObject(callback: AsyncCallback): void; /** * Obtains the next FileAsset in the file retrieval result. * This method uses a promise to return the file. * Before calling this method, you must use isAfterLast() to check whether the result set points to the last row. * This method returns the next file only when False is returned for isAfterLast(). * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @returns A Promise instance used to return the file in the format of a FileAsset instance. * @deprecated since 9 * @useinstead ohos.file.picker */ getNextObject(): Promise; /** * Obtains the last FileAsset in the file retrieval result. This method uses a callback to return the file. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param callback Callback used to return the file in the format of a FileAsset instance. * @deprecated since 9 * @useinstead ohos.file.picker */ getLastObject(callback: AsyncCallback): void; /** * Obtains the last FileAsset in the file retrieval result. This method uses a promise to return the file. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @returns A Promise instance used to return the file in the format of a FileAsset instance. * @deprecated since 9 * @useinstead ohos.file.picker */ getLastObject(): Promise; /** * Obtains the FileAsset with the specified index in the file retrieval result. * This method uses a callback to return the file. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param index Index of the file to obtain. * @param callback Callback used to return the file in the format of a FileAsset instance. * @deprecated since 9 * @useinstead ohos.file.picker */ getPositionObject(index: number, callback: AsyncCallback): void; /** * Obtains the FileAsset with the specified index in the file retrieval result. * This method uses a promise to return the file. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param index Index of the file to obtain. * @returns A Promise instance used to return the file in the format of a FileAsset instance. * @deprecated since 9 * @useinstead ohos.file.picker */ getPositionObject(index: number): Promise; /** * Obtains all FileAssets in the file retrieval result. * This method uses a callback to return the result. After this method is called, * close() is automatically called to release the FetchFileResult instance and invalidate it. * In this case, other methods cannot be called. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param callback Callback used to return a FileAsset array. * @deprecated since 9 * @useinstead ohos.file.picker */ getAllObject(callback: AsyncCallback>): void; /** * Obtains all FileAssets in the file retrieval result. * This method uses a promise to return the result. that store the selected media resources. * close() is automatically called to release the FetchFileResult instance and invalidate it. * In this case, other methods cannot be called. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @returns A Promise instance used to return a FileAsset array. * @deprecated since 9 * @useinstead ohos.file.picker */ getAllObject(): Promise>; } /** * Defines the album. * * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @since 7 * @deprecated since 9 * @useinstead ohos.file.picker */ interface Album { /** * Album ID. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly albumId: number; /** * Album name. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ albumName: string; /** * Album uri. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly albumUri: string; /** * Date (timestamp) when the album was last modified. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly dateModified: number; /** * File count for the album * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly count: number; /** * Relative path for the album * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly relativePath: string; /** * coverUri for the album * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ readonly coverUri: string; /** * Modify the meta data for the album * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA * @param callback, no value will be returned. * @deprecated since 9 * @useinstead ohos.file.picker */ commitModify(callback: AsyncCallback): void; /** * Modify the meta data for the album * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA * @deprecated since 9 * @useinstead ohos.file.picker */ commitModify(): Promise; /** * SObtains files in an album. This method uses an asynchronous callback to return the files. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @param callback Callback used to return the files in the format of a FetchFileResult instance. * @deprecated since 9 * @useinstead ohos.file.picker */ getFileAssets(callback: AsyncCallback): void; /** * SObtains files in an album. This method uses an asynchronous callback to return the files. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @param option Media retrieval options. * @param callback Callback used to return the files in the format of a FetchFileResult instance. * @deprecated since 9 * @useinstead ohos.file.picker */ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback): void; /** * Obtains files in an album. This method uses a promise to return the files. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @param option Media retrieval options. * @returns A Promise instance used to return the files in the format of a FetchFileResult instance. * @deprecated since 9 * @useinstead ohos.file.picker */ getFileAssets(options?: MediaFetchOptions): Promise; } /** * Enumeration public directory that predefined * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ enum DirectoryType { /** * predefined public directory for files token by Camera. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ DIR_CAMERA = 0, /** * predefined public directory for VIDEO files. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ DIR_VIDEO, /** * predefined public directory for IMAGE files. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ DIR_IMAGE, /** * predefined public directory for AUDIO files. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ DIR_AUDIO, /** * predefined public directory for DOCUMENTS files. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ DIR_DOCUMENTS, /** * predefined public directory for DOWNLOAD files. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ DIR_DOWNLOAD } /** * Defines the MediaLibrary class and provides functions to access the data in media storage. * * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @since 6 * @deprecated since 9 * @useinstead ohos.file.picker */ interface MediaLibrary { /** * get system predefined root dir, use to create file asset by relative path * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param type, public directory predefined in DirectoryType. * @param callback Callback return the FetchFileResult. * @deprecated since 9 * @useinstead ohos.file.picker */ getPublicDirectory(type: DirectoryType, callback: AsyncCallback): void; /** * get system predefined root dir, use to create file asset by relative path * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param type public directory predefined in DirectoryType. * @returns A promise instance used to return the public directory in the format of string * @deprecated since 9 * @useinstead ohos.file.picker */ getPublicDirectory(type: DirectoryType): Promise; /** * query all assets just for count & first cover * if need all data, getAllObject from FetchFileResult * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @param options, Media retrieval options. * @param callback, Callback return the FetchFileResult. * @deprecated since 9 * @useinstead ohos.file.picker */ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback): void; /** * query all assets just for count & first cover * if need all data, getAllObject from FetchFileResult * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @param options Media retrieval options. * @returns A promise instance used to return the files in the format of a FetchFileResult instance * @deprecated since 9 * @useinstead ohos.file.picker */ getFileAssets(options: MediaFetchOptions): Promise; /** * Turn on monitor the data changes by media type * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param type one of 'deviceChange','albumChange','imageChange','audioChange','videoChange','fileChange','remoteFileChange' * @param callback no value returned * @deprecated since 9 * @useinstead ohos.file.picker */ on(type: 'deviceChange' | 'albumChange' | 'imageChange' | 'audioChange' | 'videoChange' | 'fileChange' | 'remoteFileChange', callback: Callback): void; /** * Turn off monitor the data changes by media type * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param type one of 'deviceChange','albumChange','imageChange','audioChange','videoChange','fileChange','remoteFileChange' * @param callback no value returned * @deprecated since 9 * @useinstead ohos.file.picker */ off(type: 'deviceChange' | 'albumChange' | 'imageChange' | 'audioChange' | 'videoChange' | 'fileChange' | 'remoteFileChange', callback?: Callback): void; /** * Create File Asset * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA * @param mediaType mediaType for example:IMAGE, VIDEO, AUDIO, FILE * @param displayName file name * @param relativePath relative path * @param callback Callback used to return the FileAsset * @deprecated since 9 * @useinstead ohos.file.picker */ createAsset(mediaType: MediaType, displayName: string, relativePath: string, callback: AsyncCallback): void; /** * Create File Asset * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA * @param mediaType mediaType for example:IMAGE, VIDEO, AUDIO, FILE * @param displayName file name * @param relativePath relative path * @returns A Promise instance used to return the FileAsset * @deprecated since 9 * @useinstead ohos.file.picker */ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Promise; /** * Delete File Asset * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA * @param uri FileAsset's URI * @param callback no value returned * @systemapi * @deprecated since 9 * @useinstead ohos.file.picker */ deleteAsset(uri: string, callback: AsyncCallback): void; /** * Delete File Asset * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA * @param uri, FileAsset's URI * @returns A Promise instance, no value returned * @systemapi * @deprecated since 9 * @useinstead ohos.file.picker */ deleteAsset(uri: string): Promise; /** * Obtains albums based on the media retrieval options. This method uses an asynchronous callback to return. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @param option Media retrieval options. * @param callback Callback used to return an album array. * @deprecated since 9 * @useinstead ohos.file.picker */ getAlbums(options: MediaFetchOptions, callback: AsyncCallback>): void; /** * Obtains albums based on the media retrieval options. This method uses a promise to return the albums. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @param option Media retrieval options. * @returns A Promise instance used to return an album array. * @deprecated since 9 * @useinstead ohos.file.picker */ getAlbums(options: MediaFetchOptions): Promise>; /** * Stores media resources. This method uses an asynchronous callback to return the URI that stores * the media resources. * @since 6 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param option Media resource option. * @param callback Callback used to return the URI that stores the media resources. * @deprecated since 9 */ storeMediaAsset(option: MediaAssetOption, callback: AsyncCallback): void; /** * Stores media resources. This method uses a promise to return the URI that stores the media resources. * @since 6 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param option Media resource option. * @returns Promise used to return the URI that stores the media resources. * @deprecated since 9 */ storeMediaAsset(option: MediaAssetOption): Promise; /** * Starts image preview, with the first image to preview specified. This method uses an asynchronous callback * to receive the execution result. * @since 6 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param images List of images to preview. * @param index Sequence number of the first image to preview. * @param callback Callback used for image preview. No value is returned. * @deprecated since 9 */ startImagePreview(images: Array, index: number, callback: AsyncCallback): void; /** * Starts image preview. This method uses an asynchronous callback to receive the execution result. * @since 6 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param images List of images to preview. * @param callback Callback used for image preview. No value is returned. * @deprecated since 9 */ startImagePreview(images: Array, callback: AsyncCallback): void; /** * Starts image preview, with the first image to preview specified. * This method uses a promise to return the execution result. * @since 6 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param images List of images to preview. * @param index Sequence number of the first image to preview. * @returns Promise used to return whether the operation is successful. * @deprecated since 9 */ startImagePreview(images: Array, index?: number): Promise; /** * Starts media selection. This method uses an asynchronous callback to * return the list of URIs that store the selected media resources. * @since 6 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param option Media selection option. * @param callback Callback used to return the list of URIs that store the selected media resources. * @deprecated since 9 */ startMediaSelect(option: MediaSelectOption, callback: AsyncCallback>): void; /** * Starts media selection. This method uses a promise to return the list of URIs * that store the selected media resources. * @since 6 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param option Media selection option. * @returns Promise used to return the list of URIs that store the selected media resources. * @deprecated since 9 */ startMediaSelect(option: MediaSelectOption): Promise>; /** * Get Active Peer device information * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @permission ohos.permission.READ_MEDIA * @systemapi * @param callback, Callback return the list of the active peer devices' information * @deprecated since 9 * @useinstead ohos.file.picker */ getActivePeers(callback: AsyncCallback>): void; /** * Get Active Peer device information * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @permission ohos.permission.READ_MEDIA * @systemapi * @returns Promise used to return the list of the active peer devices' information * @deprecated since 9 * @useinstead ohos.file.picker */ getActivePeers(): Promise>; /** * Get all the peer devices' information * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @permission ohos.permission.READ_MEDIA * @systemapi * @param callback Callback return the list of the all the peer devices' information * @deprecated since 9 * @useinstead ohos.file.picker */ getAllPeers(callback: AsyncCallback>): void; /** * Get all the peer devices' information * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @permission ohos.permission.READ_MEDIA * @systemapi * @returns Promise used to return the list of the all the peer devices' information * @deprecated since 9 * @useinstead ohos.file.picker */ getAllPeers(): Promise>; /** * Release MediaLibrary instance * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param callback no value returned * @deprecated since 9 * @useinstead ohos.file.picker */ release(callback: AsyncCallback): void; /** * Release MediaLibrary instance * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ release(): Promise; } /** * thumbnail's size which have width and height * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @since 8 * @deprecated since 9 * @useinstead ohos.file.picker */ interface Size { /** * Width of image file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ width: number; /** * Height of image file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @deprecated since 9 * @useinstead ohos.file.picker */ height: number; } /** * peer devices' information * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi * @since 8 * @deprecated since 9 * @useinstead ohos.file.picker */ interface PeerInfo { /** * Peer device name * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi * @deprecated since 9 * @useinstead ohos.file.picker */ readonly deviceName: string; /** * Peer device network id * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi * @deprecated since 9 * @useinstead ohos.file.picker */ readonly networkId: string; /** * Peer device type * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi * @deprecated since 9 * @useinstead ohos.file.picker */ readonly deviceType: DeviceType; /** * Peer device online status * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi * @deprecated since 9 * @useinstead ohos.file.picker */ readonly isOnline: boolean; } /** * peer device type * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi * @since 8 * @deprecated since 9 * @useinstead ohos.file.picker */ enum DeviceType { /** * Unknown device type * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi * @deprecated since 9 * @useinstead ohos.file.picker */ TYPE_UNKNOWN = 0, /** * Laptop device * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi * @deprecated since 9 * @useinstead ohos.file.picker */ TYPE_LAPTOP, /** * Phone device * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi * @deprecated since 9 * @useinstead ohos.file.picker */ TYPE_PHONE, /** * Tablet device * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi * @deprecated since 9 * @useinstead ohos.file.picker */ TYPE_TABLET, /** * Watch device * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi * @deprecated since 9 * @useinstead ohos.file.picker */ TYPE_WATCH, /** * Car device * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi * @deprecated since 9 * @useinstead ohos.file.picker */ TYPE_CAR, /** * TV device * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi * @deprecated since 9 * @useinstead ohos.file.picker */ TYPE_TV } } export default mediaLibrary;