1 /* 2 * Copyright (C) 2019 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package com.android.providers.media.scan; 18 19 import static com.android.providers.media.MediaProviderStatsLog.MEDIA_PROVIDER_SCAN_OCCURRED__REASON__DEMAND; 20 import static com.android.providers.media.MediaProviderStatsLog.MEDIA_PROVIDER_SCAN_OCCURRED__REASON__IDLE; 21 import static com.android.providers.media.MediaProviderStatsLog.MEDIA_PROVIDER_SCAN_OCCURRED__REASON__MOUNTED; 22 import static com.android.providers.media.MediaProviderStatsLog.MEDIA_PROVIDER_SCAN_OCCURRED__REASON__UNKNOWN; 23 24 import android.content.Context; 25 import android.net.Uri; 26 27 import androidx.annotation.IntDef; 28 import androidx.annotation.NonNull; 29 import androidx.annotation.Nullable; 30 31 import com.android.providers.media.MediaVolume; 32 33 import java.io.File; 34 import java.lang.annotation.Retention; 35 import java.lang.annotation.RetentionPolicy; 36 import java.util.Set; 37 38 public interface MediaScanner { 39 int REASON_UNKNOWN = MEDIA_PROVIDER_SCAN_OCCURRED__REASON__UNKNOWN; 40 int REASON_MOUNTED = MEDIA_PROVIDER_SCAN_OCCURRED__REASON__MOUNTED; 41 int REASON_DEMAND = MEDIA_PROVIDER_SCAN_OCCURRED__REASON__DEMAND; 42 int REASON_IDLE = MEDIA_PROVIDER_SCAN_OCCURRED__REASON__IDLE; 43 44 @Retention(RetentionPolicy.SOURCE) 45 @IntDef(value = { 46 REASON_UNKNOWN, 47 REASON_MOUNTED, 48 REASON_DEMAND, 49 REASON_IDLE 50 }) 51 @interface ScanReason {} 52 53 @NonNull getContext()54 Context getContext(); 55 scanDirectory(@onNull File dir, @ScanReason int reason)56 void scanDirectory(@NonNull File dir, @ScanReason int reason); 57 58 @Nullable scanFile(@onNull File file, @ScanReason int reason)59 Uri scanFile(@NonNull File file, @ScanReason int reason); 60 onDetachVolume(@onNull MediaVolume volume)61 void onDetachVolume(@NonNull MediaVolume volume); 62 onIdleScanStopped()63 void onIdleScanStopped(); 64 onDirectoryDirty(@onNull File file)65 void onDirectoryDirty(@NonNull File file); 66 67 /** 68 * Returns OEM supported mime types for OEM metadata. 69 */ getOemSupportedMimeTypes()70 Set<String> getOemSupportedMimeTypes(); 71 } 72