@roitium/expo-orpheus 0.4.5 → 0.4.7

package/README.md

@@ -9,3 +9,18 @@
 通过 `Orpheus.setBilibiliCookie()` 设置 cookie，稍后会自动用于音频流请求。（不设置也行，只是无法获取高码率的音频）
 
 Orpheus 通过特殊的 uri 识别来自 bilibili 的资源，格式为 `orpheus://bilibili?bvid=xxx&cid=111&quality=30280&dolby=0&hires=0`，若不提供 cid 则默认请求第一个分 p。quality 参考 b 站 api。
+
+## 缓存
+
+Orpheus 内部有两层缓存：
+
+1. 用户手动下载的缓存
+2. 边下边播：LRU 缓存，256mb
+
+## 下载系统
+
+Orpheus 集成了 Media3 的 DownloadManager，抛弃了原先 BBPlayer 中繁琐的下载实现。
+
+## 使用
+
+虽然该包是公开的，但仍然主要供 BBPlayer 内部使用。可能不会有完整的文档覆盖。我们欢迎你 fork 后自行修改使用。

package/android/src/main/java/expo/modules/orpheus/ExpoOrpheusModule.kt

@@ -229,7 +229,7 @@ class ExpoOrpheusModule : Module() {
             if (index >= 0 && index < (controller?.mediaItemCount ?: 0)) {
                 controller?.removeMediaItem(index)
             }
-        }
+        }.runOnQueue(Queues.MAIN)
 
         AsyncFunction("getQueue") {
             checkController()
@@ -314,7 +314,7 @@ class ExpoOrpheusModule : Module() {
             if (player.playbackState == Player.STATE_IDLE) {
                 player.prepare()
             }
-        }
+        }.runOnQueue(Queues.MAIN)
 
         AsyncFunction("downloadTrack") { track: TrackRecord ->
             val context = appContext.reactContext ?: return@AsyncFunction

package/build/ExpoOrpheusModule.d.ts

@@ -143,7 +143,7 @@ declare class OrpheusModule extends NativeModule<OrpheusEvents> {
      */
     multiDownload(tracks: Track[]): Promise<void>;
     /**
-     * 移除所有下载任务
+     * 移除所有下载任务(包括已完成的及源文件)
      */
     removeAllDownloads(): Promise<void>;
     /**

package/build/ExpoOrpheusModule.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExpoOrpheusModule.js","sourceRoot":"","sources":["../src/ExpoOrpheusModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAgB,MAAM,mBAAmB,CAAC;AAEtE,MAAM,CAAN,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,iDAAQ,CAAA;IACR,2DAAa,CAAA;IACb,mDAAS,CAAA;IACT,mDAAS,CAAA;AACX,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB;AAED,MAAM,CAAN,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,yCAAO,CAAA;IACP,6CAAS,CAAA;IACT,6CAAS,CAAA;AACX,CAAC,EAJW,UAAU,KAAV,UAAU,QAIrB;AAED,MAAM,CAAN,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,2DAAU,CAAA;IACV,uDAAQ,CAAA;IACR,uDAAQ,CAAA;IACR,+EAAoB,CAAA;AACtB,CAAC,EALW,gBAAgB,KAAhB,gBAAgB,QAK3B;AAsLD,MAAM,CAAN,IAAY,aAQX;AARD,WAAY,aAAa;IACvB,qDAAU,CAAA;IACV,uDAAW,CAAA;IACX,+DAAe,CAAA;IACf,2DAAa,CAAA;IACb,qDAAU,CAAA;IACV,yDAAY,CAAA;IACZ,6DAAc,CAAA;AAChB,CAAC,EARW,aAAa,KAAb,aAAa,QAQxB;AAWD,MAAM,CAAC,MAAM,OAAO,GAAG,mBAAmB,CAAgB,SAAS,CAAC,CAAC","sourcesContent":["import { requireNativeModule, NativeModule } from \"expo-modules-core\";\n\nexport enum PlaybackState {\n  IDLE = 1,\n  BUFFERING = 2,\n  READY = 3,\n  ENDED = 4,\n}\n\nexport enum RepeatMode {\n  OFF = 0,\n  TRACK = 1,\n  QUEUE = 2,\n}\n\nexport enum TransitionReason {\n  REPEAT = 0,\n  AUTO = 1,\n  SEEK = 2,\n  PLAYLIST_CHANGED = 3,\n}\n\nexport interface Track {\n  id: string;\n  url: string;\n  title?: string;\n  artist?: string;\n  artwork?: string;\n  duration?: number;\n  loudness?: {\n    measured_i: number;\n    target_i: number;\n  }\n}\n\nexport type OrpheusEvents = {\n  onPlaybackStateChanged(event: { state: PlaybackState }): void;\n  onTrackStarted(event: { trackId: string; reason: TransitionReason }): void;\n  onTrackFinished(event: {\n    trackId: string;\n    finalPosition: number;\n    duration: number;\n  }): void;\n  onPlayerError(event: { code: string; message: string }): void;\n  onPositionUpdate(event: {\n    position: number;\n    duration: number;\n    buffered: number;\n  }): void;\n  onIsPlayingChanged(event: { status: boolean }): void;\n  onDownloadUpdated(event: DownloadTask): void;\n};\n\ndeclare class OrpheusModule extends NativeModule<OrpheusEvents> {\n  \n  restorePlaybackPositionEnabled: boolean;\n\n  /**\n   * 获取当前进度（秒）\n   */\n  getPosition(): Promise<number>;\n\n  /**\n   * 获取总时长（秒）\n   */\n  getDuration(): Promise<number>;\n\n  /**\n   * 获取缓冲进度（秒）\n   */\n  getBuffered(): Promise<number>;\n\n  /**\n   * 获取是否正在播放\n   */\n  getIsPlaying(): Promise<boolean>;\n\n  /**\n   * 获取当前播放索引\n   */\n  getCurrentIndex(): Promise<number>;\n\n  /**\n   * 获取当前播放的 Track 对象\n   */\n  getCurrentTrack(): Promise<Track | null>;\n\n  /**\n   * 获取随机模式状态\n   */\n  getShuffleMode(): Promise<boolean>;\n\n  /**\n   * 获取指定索引的 Track\n   */\n  getIndexTrack(index: number): Promise<Track | null>;\n\n  getRepeatMode(): Promise<RepeatMode>;\n\n  setBilibiliCookie(cookie: string): void;\n  \n  setRestorePlaybackPositionEnabled(enabled: boolean): void;\n\n  play(): Promise<void>;\n\n  pause(): Promise<void>;\n\n  clear(): Promise<void>;\n\n  skipTo(index: number): Promise<void>;\n\n  skipToNext(): Promise<void>;\n\n  skipToPrevious(): Promise<void>;\n\n  /**\n   * 跳转进度\n   * @param seconds 秒数\n   */\n  seekTo(seconds: number): Promise<void>;\n\n  setRepeatMode(mode: RepeatMode): Promise<void>;\n\n  setShuffleMode(enabled: boolean): Promise<void>;\n\n  getQueue(): Promise<Track[]>;\n\n  /**\n   * 添加到队列末尾，且不去重。\n   * @param tracks\n   * @param startFromId 可选，添加后立即播放该 ID 的曲目\n   * @param clearQueue 可选，是否清空当前队列\n   */\n  addToEnd(\n    tracks: Track[],\n    startFromId?: string,\n    clearQueue?: boolean\n  ): Promise<void>;\n\n  /**\n   * 播放下一首\n   * @param track\n   */\n  playNext(track: Track): Promise<void>;\n\n  removeTrack(index: number): Promise<void>;\n\n  /**\n   * 设置睡眠定时器\n   * @param durationMs 单位毫秒\n   */\n  setSleepTimer(durationMs: number): Promise<void>;\n\n  /**\n   * 获取睡眠定时器结束时间\n   * @returns 单位毫秒，如果没有设置则返回 null\n   */\n  getSleepTimerEndTime(): Promise<number | null>;\n\n  cancelSleepTimer(): Promise<void>;\n\n  /**\n   * 下载单首歌曲\n   */\n  downloadTrack(track: Track): Promise<void>;\n\n  /**\n   * 移除下载任务\n   */\n  removeDownload(id: string): Promise<void>;\n\n  /**\n   * 批量下载歌曲\n   */\n  multiDownload(tracks: Track[]): Promise<void>;\n\n  /**\n   * 移除所有下载任务\n   */\n  removeAllDownloads(): Promise<void>;\n\n  /**\n   * 获取所有下载任务\n   */\n  getDownloads(): Promise<DownloadTask[]>;\n\n  /**\n   * 批量返回指定 ID 的下载状态\n   */\n  getDownloadStatusByIds(ids: string[]): Promise<Record<string, DownloadState>>;\n\n  /**\n   * 清除未完成的下载任务\n   */\n  clearUncompletedDownloadTasks(): Promise<void>;\n\n  /**\n   * 获取所有未完成的下载任务\n   */\n  getUncompletedDownloadTasks(): Promise<DownloadTask[]>;\n}\n\nexport enum DownloadState {\n  QUEUED = 0,\n  STOPPED = 1,\n  DOWNLOADING = 2,\n  COMPLETED = 3,\n  FAILED = 4,\n  REMOVING = 5,\n  RESTARTING = 7,\n}\n\nexport interface DownloadTask {\n  id: string;\n  state: DownloadState;\n  percentDownloaded: number;\n  bytesDownloaded: number;\n  contentLength: number;\n  track?: Track;\n}\n\nexport const Orpheus = requireNativeModule<OrpheusModule>(\"Orpheus\");\n"]}
+{"version":3,"file":"ExpoOrpheusModule.js","sourceRoot":"","sources":["../src/ExpoOrpheusModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAgB,MAAM,mBAAmB,CAAC;AAEtE,MAAM,CAAN,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,iDAAQ,CAAA;IACR,2DAAa,CAAA;IACb,mDAAS,CAAA;IACT,mDAAS,CAAA;AACX,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB;AAED,MAAM,CAAN,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,yCAAO,CAAA;IACP,6CAAS,CAAA;IACT,6CAAS,CAAA;AACX,CAAC,EAJW,UAAU,KAAV,UAAU,QAIrB;AAED,MAAM,CAAN,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,2DAAU,CAAA;IACV,uDAAQ,CAAA;IACR,uDAAQ,CAAA;IACR,+EAAoB,CAAA;AACtB,CAAC,EALW,gBAAgB,KAAhB,gBAAgB,QAK3B;AAsLD,MAAM,CAAN,IAAY,aAQX;AARD,WAAY,aAAa;IACvB,qDAAU,CAAA;IACV,uDAAW,CAAA;IACX,+DAAe,CAAA;IACf,2DAAa,CAAA;IACb,qDAAU,CAAA;IACV,yDAAY,CAAA;IACZ,6DAAc,CAAA;AAChB,CAAC,EARW,aAAa,KAAb,aAAa,QAQxB;AAWD,MAAM,CAAC,MAAM,OAAO,GAAG,mBAAmB,CAAgB,SAAS,CAAC,CAAC","sourcesContent":["import { requireNativeModule, NativeModule } from \"expo-modules-core\";\n\nexport enum PlaybackState {\n  IDLE = 1,\n  BUFFERING = 2,\n  READY = 3,\n  ENDED = 4,\n}\n\nexport enum RepeatMode {\n  OFF = 0,\n  TRACK = 1,\n  QUEUE = 2,\n}\n\nexport enum TransitionReason {\n  REPEAT = 0,\n  AUTO = 1,\n  SEEK = 2,\n  PLAYLIST_CHANGED = 3,\n}\n\nexport interface Track {\n  id: string;\n  url: string;\n  title?: string;\n  artist?: string;\n  artwork?: string;\n  duration?: number;\n  loudness?: {\n    measured_i: number;\n    target_i: number;\n  }\n}\n\nexport type OrpheusEvents = {\n  onPlaybackStateChanged(event: { state: PlaybackState }): void;\n  onTrackStarted(event: { trackId: string; reason: TransitionReason }): void;\n  onTrackFinished(event: {\n    trackId: string;\n    finalPosition: number;\n    duration: number;\n  }): void;\n  onPlayerError(event: { code: string; message: string }): void;\n  onPositionUpdate(event: {\n    position: number;\n    duration: number;\n    buffered: number;\n  }): void;\n  onIsPlayingChanged(event: { status: boolean }): void;\n  onDownloadUpdated(event: DownloadTask): void;\n};\n\ndeclare class OrpheusModule extends NativeModule<OrpheusEvents> {\n  \n  restorePlaybackPositionEnabled: boolean;\n\n  /**\n   * 获取当前进度（秒）\n   */\n  getPosition(): Promise<number>;\n\n  /**\n   * 获取总时长（秒）\n   */\n  getDuration(): Promise<number>;\n\n  /**\n   * 获取缓冲进度（秒）\n   */\n  getBuffered(): Promise<number>;\n\n  /**\n   * 获取是否正在播放\n   */\n  getIsPlaying(): Promise<boolean>;\n\n  /**\n   * 获取当前播放索引\n   */\n  getCurrentIndex(): Promise<number>;\n\n  /**\n   * 获取当前播放的 Track 对象\n   */\n  getCurrentTrack(): Promise<Track | null>;\n\n  /**\n   * 获取随机模式状态\n   */\n  getShuffleMode(): Promise<boolean>;\n\n  /**\n   * 获取指定索引的 Track\n   */\n  getIndexTrack(index: number): Promise<Track | null>;\n\n  getRepeatMode(): Promise<RepeatMode>;\n\n  setBilibiliCookie(cookie: string): void;\n  \n  setRestorePlaybackPositionEnabled(enabled: boolean): void;\n\n  play(): Promise<void>;\n\n  pause(): Promise<void>;\n\n  clear(): Promise<void>;\n\n  skipTo(index: number): Promise<void>;\n\n  skipToNext(): Promise<void>;\n\n  skipToPrevious(): Promise<void>;\n\n  /**\n   * 跳转进度\n   * @param seconds 秒数\n   */\n  seekTo(seconds: number): Promise<void>;\n\n  setRepeatMode(mode: RepeatMode): Promise<void>;\n\n  setShuffleMode(enabled: boolean): Promise<void>;\n\n  getQueue(): Promise<Track[]>;\n\n  /**\n   * 添加到队列末尾，且不去重。\n   * @param tracks\n   * @param startFromId 可选，添加后立即播放该 ID 的曲目\n   * @param clearQueue 可选，是否清空当前队列\n   */\n  addToEnd(\n    tracks: Track[],\n    startFromId?: string,\n    clearQueue?: boolean\n  ): Promise<void>;\n\n  /**\n   * 播放下一首\n   * @param track\n   */\n  playNext(track: Track): Promise<void>;\n\n  removeTrack(index: number): Promise<void>;\n\n  /**\n   * 设置睡眠定时器\n   * @param durationMs 单位毫秒\n   */\n  setSleepTimer(durationMs: number): Promise<void>;\n\n  /**\n   * 获取睡眠定时器结束时间\n   * @returns 单位毫秒，如果没有设置则返回 null\n   */\n  getSleepTimerEndTime(): Promise<number | null>;\n\n  cancelSleepTimer(): Promise<void>;\n\n  /**\n   * 下载单首歌曲\n   */\n  downloadTrack(track: Track): Promise<void>;\n\n  /**\n   * 移除下载任务\n   */\n  removeDownload(id: string): Promise<void>;\n\n  /**\n   * 批量下载歌曲\n   */\n  multiDownload(tracks: Track[]): Promise<void>;\n\n  /**\n   * 移除所有下载任务(包括已完成的及源文件)\n   */\n  removeAllDownloads(): Promise<void>;\n\n  /**\n   * 获取所有下载任务\n   */\n  getDownloads(): Promise<DownloadTask[]>;\n\n  /**\n   * 批量返回指定 ID 的下载状态\n   */\n  getDownloadStatusByIds(ids: string[]): Promise<Record<string, DownloadState>>;\n\n  /**\n   * 清除未完成的下载任务\n   */\n  clearUncompletedDownloadTasks(): Promise<void>;\n\n  /**\n   * 获取所有未完成的下载任务\n   */\n  getUncompletedDownloadTasks(): Promise<DownloadTask[]>;\n}\n\nexport enum DownloadState {\n  QUEUED = 0,\n  STOPPED = 1,\n  DOWNLOADING = 2,\n  COMPLETED = 3,\n  FAILED = 4,\n  REMOVING = 5,\n  RESTARTING = 7,\n}\n\nexport interface DownloadTask {\n  id: string;\n  state: DownloadState;\n  percentDownloaded: number;\n  bytesDownloaded: number;\n  contentLength: number;\n  track?: Track;\n}\n\nexport const Orpheus = requireNativeModule<OrpheusModule>(\"Orpheus\");\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roitium/expo-orpheus",
-  "version": "0.4.5",
+  "version": "0.4.7",
   "description": "A player for bbplayer",
   "main": "build/index.js",
   "types": "build/index.d.ts",

package/src/ExpoOrpheusModule.ts

@@ -175,7 +175,7 @@ declare class OrpheusModule extends NativeModule<OrpheusEvents> {
   multiDownload(tracks: Track[]): Promise<void>;
 
   /**
-   * 移除所有下载任务
+   * 移除所有下载任务(包括已完成的及源文件)
    */
   removeAllDownloads(): Promise<void>;