AudioScanner

java.lang.Object
- snow.player.util.AudioScanner<T>

类型参数:

T - 音频文件数据将被转换到的实体类型。
```
public class AudioScanner<T>
extends java.lang.Object
```
音频文件扫描器。用于帮助扫描本地设备中的音频文件。

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`AudioScanner.AudioItem` 默认的音频实体类。
`static class`	`AudioScanner.AudioItemConverter` 默认的转换器，用于将扫描到的音频数据转换成 `AudioScanner.AudioItem` 对象。
`static interface`	`AudioScanner.Converter<T>` 转换器，用于将扫描到的音频文件数据转换成一个实体对象。
`static interface`	`AudioScanner.OnProgressUpdateListener<T>` 用于接收扫描结果和监听扫描进度。

构造器概要

构造器
构造器和说明

AudioScanner(android.content.Context context, AudioScanner.Converter<T> converter)
创建一个 AudioScanner 对象。

构造器
构造器和说明
`AudioScanner(android.content.Context context, AudioScanner.Converter<T> converter)` 创建一个 `AudioScanner` 对象。

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`cancel()` 取消扫描。
`static java.lang.String`	`getAlbum(android.database.Cursor cursor)` 获取音频文件所属的专辑。
`static int`	`getAlbumId(android.database.Cursor cursor)` 获取音频文件所属的专辑的 ID。
`static java.lang.String`	`getArtist(android.database.Cursor cursor)` 获取音频文件的艺术家。
`static int`	`getArtistId(android.database.Cursor cursor)` 获取音频文件的艺术家的 ID。
`static int`	`getDateAdded(android.database.Cursor cursor)` 获取首次添加音频文件的时间。
`static int`	`getDateModified(android.database.Cursor cursor)` 获取音频文件的最后一次修改日期。
`static java.lang.String`	`getDisplayName(android.database.Cursor cursor)` 获取音频文件的显示名称。
`static int`	`getDuration(android.database.Cursor cursor)` 音频文件的持续时间。
`static int`	`getId(android.database.Cursor cursor)` 获取音频文件在 Android 系统本地媒体库中的 ID 值。
`static java.lang.String`	`getMimeType(android.database.Cursor cursor)` 获取音频文件的 MIME 类型。
`static int`	`getSize(android.database.Cursor cursor)` 获取音频文件的大小。
`static java.lang.String`	`getTitle(android.database.Cursor cursor)` 获取音频文件的标题。
`static int`	`getTrack(android.database.Cursor cursor)` 获取专辑中这首歌的曲目号，如果有的话。
`static android.net.Uri`	`getUri(android.database.Cursor cursor)` 获取音频文件的播放链接。
`static int`	`getYear(android.database.Cursor cursor)` 获取音频文件录制的年份，如果有的话。
`static boolean`	`isAlarm(android.database.Cursor cursor)` 音频文件是否是闹钟铃声文件。
`static boolean`	`isAudioBook(android.database.Cursor cursor)` 音频文件是否是有声读物。
`static boolean`	`isNotification(android.database.Cursor cursor)` 音频文件是否是通知铃声。
`static boolean`	`isPodcast(android.database.Cursor cursor)` 音频文件是否是 podcast。
`static boolean`	`isRingtone(android.database.Cursor cursor)` 音频文件是否是铃声文件。
`boolean`	`isScanning()` 扫描器当前是否正在运行。
`void`	`scan(AudioScanner.OnProgressUpdateListener<T> listener)` 开始扫描本地音频文件。
`void`	`setQueryParams(java.lang.String[] projection, java.lang.String selection, java.lang.String[] selectionArgs, java.lang.String sortOrder)` 设置查询参数。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - AudioScanner
```
public AudioScanner(@NonNull
                    android.content.Context context,
                    @NonNull
                    AudioScanner.Converter<T> converter)
```
    创建一个 AudioScanner 对象。
    
    参数:
    
    context - Context 对象，不能为 null
    
    converter - 转换器，不能为 null。用于将扫描到的音频数据转换为一个实体对象。
- 方法详细资料
  - setQueryParams
```
public void setQueryParams(java.lang.String[] projection,
                           java.lang.String selection,
                           java.lang.String[] selectionArgs,
                           java.lang.String sortOrder)
```
    设置查询参数。
    关于参数的具体功能，请参考 ContentResolver#query() 方法。
  - scan
```
public void scan(@NonNull
                 AudioScanner.OnProgressUpdateListener<T> listener)
```
    开始扫描本地音频文件。
    注意！如果当前扫描器运行，调用此方法时将被忽略，除非上次扫描过程已完成或者已被取消。可以使用 isScanning() 方法检查扫描器当前是否正在运行。
    
    参数:
    
    listener - 用于接收扫描结果和监听扫描进度，不能为 null。
    
    另请参阅:
    
    isScanning()
  - isScanning
```
public boolean isScanning()
```
    扫描器当前是否正在运行。
    
    返回:
    
    如果扫描器当前正在运行，则返回 true，否则返回 false。
  - cancel
```
public void cancel()
```
    取消扫描。
  - getDateAdded
```
public static int getDateAdded(android.database.Cursor cursor)
```
    获取首次添加音频文件的时间。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    首次添加音频文件的时间。
  - getDateModified
```
public static int getDateModified(android.database.Cursor cursor)
```
    获取音频文件的最后一次修改日期。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    音频文件的最后一次修改日期。
  - getDisplayName
```
public static java.lang.String getDisplayName(android.database.Cursor cursor)
```
    获取音频文件的显示名称。
    例如，路径为 /storage/0000-0000/Audio/audio1024.mp3 的音频文件的显示名为 audio1024.mp3。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    音频文件的显示名称。
  - getMimeType
```
public static java.lang.String getMimeType(android.database.Cursor cursor)
```
    获取音频文件的 MIME 类型。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    音频文件的 MIME 类型。
  - getSize
```
public static int getSize(android.database.Cursor cursor)
```
    获取音频文件的大小。
    此值是系统的媒体扫描器通过 File#length() 方法获取的。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    音频文件的大小。
  - getDuration
```
public static int getDuration(android.database.Cursor cursor)
```
    音频文件的持续时间。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    文件的持续时间。
  - getTitle
```
public static java.lang.String getTitle(android.database.Cursor cursor)
```
    获取音频文件的标题。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    音频文件的标题。
  - getId
```
public static int getId(android.database.Cursor cursor)
```
    获取音频文件在 Android 系统本地媒体库中的 ID 值。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    音频文件在 Android 系统本地媒体库中的 ID 值。
  - getArtist
```
public static java.lang.String getArtist(android.database.Cursor cursor)
```
    获取音频文件的艺术家。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    音频文件的艺术家。
  - getArtistId
```
public static int getArtistId(android.database.Cursor cursor)
```
    获取音频文件的艺术家的 ID。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    音频文件的艺术家的 ID。
  - getAlbum
```
public static java.lang.String getAlbum(android.database.Cursor cursor)
```
    获取音频文件所属的专辑。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    音频文件所属的专辑。
  - getAlbumId
```
public static int getAlbumId(android.database.Cursor cursor)
```
    获取音频文件所属的专辑的 ID。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    音频文件所属的专辑的 ID。
  - isAlarm
```
public static boolean isAlarm(android.database.Cursor cursor)
```
    音频文件是否是闹钟铃声文件。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    如果音频文件是闹钟铃声文件，则返回 true，否则返回 false。
  - isAudioBook
```
public static boolean isAudioBook(android.database.Cursor cursor)
```
    音频文件是否是有声读物。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    如果音频文件是有声读物，则返回 true，否则返回 false。
  - isNotification
```
public static boolean isNotification(android.database.Cursor cursor)
```
    音频文件是否是通知铃声。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    如果音频文件是通知铃声，则返回 true，否则返回 false。
  - isPodcast
```
public static boolean isPodcast(android.database.Cursor cursor)
```
    音频文件是否是 podcast。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    如果音频文件是 podcast，则返回 true，否则返回 false。
  - isRingtone
```
public static boolean isRingtone(android.database.Cursor cursor)
```
    音频文件是否是铃声文件。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    如果音频文件是铃声文件，则返回 true，否则返回 false。
  - getTrack
```
public static int getTrack(android.database.Cursor cursor)
```
    获取专辑中这首歌的曲目号，如果有的话。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    专辑中这首歌的曲目号，如果有的话。
  - getYear
```
public static int getYear(android.database.Cursor cursor)
```
    获取音频文件录制的年份，如果有的话。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    音频文件录制的年份，如果有的话。
  - getUri
```
public static android.net.Uri getUri(android.database.Cursor cursor)
```
    获取音频文件的播放链接。
    
    参数:
    
    cursor - Cursor 对象。
    
    返回:
    
    音频文件的播放链接。

类 AudioScanner<T>

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

AudioScanner

方法详细资料

setQueryParams

scan

isScanning

cancel

getDateAdded

getDateModified

getDisplayName

getMimeType

getSize

getDuration

getTitle

getId

getArtist

getArtistId

getAlbum

getAlbumId

isAlarm

isAudioBook

isNotification

isPodcast

isRingtone

getTrack

getYear

getUri