介紹
使用ArkTS語言實現了一個簡易的音樂播放器應用,主要包含以下功能:
- 播放應用中的音頻資源文件,并可進行上一曲、下一曲、播放、暫停、切換播放模式(順序播放、單曲循環、隨機播放)等操作。
- 結合后臺任務管理模塊,實現熄屏后繼續播放音頻。
相關概念
- [AVPlayer]:AVPlayer主要工作是將Audio/Video媒體資源轉碼為可供渲染的圖像和可聽見的音頻模擬信號,并通過輸出設備進行播放,同時對播放任務進行管理,包括開始播放、暫停播放、停止播放、釋放資源、設置音量、跳轉播放位置、獲取軌道信息等功能控制。
- [后臺任務管理]:針對應用或業務模塊處于后臺(無可見界面)時,有需要繼續執行或者后續執行的業務,可基于業務類型,申請短時任務延遲掛起或者長時任務避免進入掛起狀態;如后臺播放音樂可使用長時任務避免進入掛起狀態。
- 鴻蒙開發指導文檔:[
gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md
]
約束與限制
- 本篇Codelab部分能力依賴于系統API,需下載full-SDK并替換DevEco Studio自動下載的public-SDK。具體操作可參考指南[《如何替換full-SDK》]。
- 本篇Codelab使用的部分API僅系統應用可用,需要提升應用等級。
環境搭建
軟件要求
- [DevEco Studio]版本:DevEco Studio 3.1 Release。
- OpenHarmony SDK版本:API version 9。
硬件要求
- 開發板類型:[潤和RK3568開發板]。
- OpenHarmony系統:3.2 Release。
環境搭建
完成本篇Codelab我們首先要完成開發環境的搭建,本示例以RK3568開發板為例,參照以下步驟進行:
- [獲取OpenHarmony系統版本]:標準系統解決方案(二進制)。以3.2 Release版本為例:
- 搭建燒錄環境。
- [完成DevEco Device Tool的安裝]
- [完成RK3568開發板的燒錄]
- 搭建開發環境。
- 開始前請參考[工具準備],完成DevEco Studio的安裝和開發環境配置。
- 開發環境配置完成后,請參考[使用工程向導]創建工程(模板選擇“Empty Ability”)。
- 工程創建完成后,選擇使用[真機進行調測]。
HarmonyOS與OpenHarmony鴻蒙文檔籽料:mau123789是v直接拿
代碼結構解讀
本篇Codelab只對核心代碼進行講解,對于完整代碼,我們會在gitee中提供。
├──entry/src/main/ets // 代碼區
│ ├──common
│ │ ├──constants
│ │ │ └──CommonConstants.ets // 公共常量
│ │ ├──model
│ │ │ └──PlayBarModel // 播放欄數據模型
│ │ └──utils
│ │ ├──AvSessionUtil.ets // 媒體會話工具類
│ │ ├──BackgroundTaskUtil.ets // 后臺任務工具類
│ │ ├──CommonUtil.ets // 公共工具類
│ │ ├──GlobalContext.ets // 公共工具類
│ │ ├──Logger.ets // 日志類
│ │ └──ResourceManagerUtil.ets // 資源管理工具類
│ ├──controller
│ │ ├──AudioPlayerController.ets // 音樂播放器控制器
│ │ └──PlayBarController.ets // 播放欄控制器
│ ├──entryability
│ │ └──EntryAbility.ets // 程序入口類
│ ├──pages
│ │ ├──AudioStartUp.ets // 啟動頁
│ │ ├──MusicList.ets // 歌單頁
│ │ └──Play.ets // 播放頁
│ ├──view
│ │ ├──MusicCardView.ets // 播放卡片模塊
│ │ ├──MusicView.ets // 歌單音樂模塊
│ │ ├──PlayBarView.ets // 播放控制模塊
│ │ ├──PlayListDialogView.ets // 彈窗模塊
│ │ ├──PlayListMusicView.ets // 彈窗音樂模塊
│ │ └──ProgressView.ets // 播放頁
│ └──viewmodel
│ ├──MusicItem.ets // 音樂類
│ └──MusicViewModel.ets // 歌單音樂模型
└──entry/src/main/resources // 應用資源目錄
實現音頻播放
本案例使用播放管理類AVPlayer,實現應用內音頻資源的播放,并可進行上一曲、下一曲、播放、暫停、切換播放模式(順序播放、單曲循環、隨機播放)等操作。
使用AVPlayer播放器,需要先創建一個AVPlayer實例。在AudioPlayerController中使用createAVPlayer方法完成音頻播放實例的創建。
// AudioPlayerController.ets
initAudioPlayer() {
media.createAVPlayer((error, video) = > {
if (video === undefined) {
this.avPlayer = video;
Logger.error(TAG, `createAVPlayer fail, error: ${error}`);
} else {
this.avPlayer = video;
Logger.info(TAG, 'createAVPlayer success');
}
});
}
根據業務需要設置監聽事件,搭配播放場景使用。
// AudioPlayerController.ets
// 注冊AVPlayer回調函數
setEventCallBack() {
...
// 狀態變更回調函數。
this.avPlayer.on('stateChange', async (state) = > {
...
switch (state) {
case StateEvent.IDLE: // 調用reset成功后觸發此狀態。
...
case StateEvent.INITIALIZED: // 設置播放源觸發此狀態。
...
case StateEvent.PREPARED:
...
case StateEvent.PLAYING:
...
case StateEvent.COMPLETED:
...
default:
Logger.error('unknown state: ' + state);
break;
}
})
}
設置音頻資源,AVPlayer進入initialized狀態。在initialized狀態回調中,調用prepare方法,準備播放,AVPlayer進入prepared狀態。
// AudioPlayerController.ets
async play(src: media.AVFileDescriptor, seekTo: number) {
Logger.info(TAG, 'audioPlayer play');
...
// 設置播放源
this.avPlayer.fdSrc = src;
}
setEventCallBack() {
...
this.avPlayer.on('stateChange', async (state) = > {
...
switch (state) {
...
case StateEvent.INITIALIZED:// 設置播放源后進入initialized狀態
Logger.info(TAG, 'state initialized called');
this.avPlayerState = PlayerState.INITIALIZED;
this.avPlayer.prepare().then(() = > {
Logger.info(TAG, 'prepare success');
}, (err) = > {
Logger.error(TAG, `prepare failed,error message is: ${err.message}`);
})
break;
...
}
})
}
AVPlayer進入prepared狀態,可進行音頻播控操作。包括播放play()、跳轉至指定位置播放seek()、暫停pause()、停止stop()等操作。
// AudioPlayerController.ets
setEventCallBack() {
...
this.avPlayer.on('stateChange', async (state) = > {
...
switch (state) {
...
case StateEvent.PREPARED:
Logger.info(TAG, 'state prepared called');
this.avPlayer.play();
break;
...
}
})
}
切換歌曲播放時,需調用reset()重置資源。此時AVPlayer重新進入idle狀態,允許更換資源。
// AudioPlayerController.ets
async play(src: media.AVFileDescriptor, seekTo: number) {
...
if (this.avPlayerState === PlayerState.INITIALIZED) {
await this.avPlayer.reset();
Logger.info(TAG, 'play reset success');
}
...
}
說明: 只能在initialized/prepared/playing/paused/complete/stopped/error狀態調用reset()。
調用release()銷毀實例,AVPlayer進入released狀態,退出播放。
// AudioPlayerController.ets
async release() {
Logger.info(TAG, 'audioPlayer release');
if (typeof (this.avPlayer) !== 'undefined') {
if (this.timeId === CommonConstants.DEFAULT_TIME_ID) {
clearInterval(this.timeId);
}
await this.avPlayer.release();
this.avPlayer = undefined;
}
}
實現熄屏后播放
通過后臺任務管理模塊申請長時任務,可避免設備熄屏后,應用進入掛起狀態。
首先在module.json5文件中配置長時任務權限和后臺模式類型。
"module": {
...
"abilities": [
{
...
"backgroundModes": [
"audioPlayback"
],
...
}
],
"requestPermissions": [
{
"name": "ohos.permission.KEEP_BACKGROUND_RUNNING"
}
],
}
在播放音樂時,申請長時任務。這樣在應用切換至后臺或設備熄屏后,仍可以繼續播放音樂。
// BackgroundTaskUtil.ets
import wantAgent from '@ohos.app.ability.wantAgent';
import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';
...
export class BackgroundTaskUtil {
...
public static startContinuousTask(context: Context) {
if (context === undefined) {
Logger.info(TAG, 'startContinuousTask fail,context is empty.');
return;
}
let wantAgentInfo = {
// 點擊通知后需要執行的動作
wants: [
{
bundleName: CommonConstants.BUNDLE_NAME,
abilityName: CommonConstants.ABILITY_NAME
}
],
// 單擊通知后的動作類型
operationType: wantAgent.OperationType.START_ABILITY,
// 用戶定義的私有屬性
requestCode: CommonConstants.BACKGROUND_REQUEST_CODE
} as wantAgent.WantAgentInfo;
// 通過WanAgent模塊的方法獲取WanAgent對象
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) = > {
try {
backgroundTaskManager.startBackgroundRunning(context, backgroundTaskManager.BackgroundMode.AUDIO_PLAYBACK,
wantAgentObj).then(() = > {
Logger.info(TAG, 'startBackgroundRunning succeeded');
}).catch((err: Error) = > {
Logger.error(TAG, 'startBackgroundRunning failed, Cause: ' + JSON.stringify(err));
});
} catch (error) {
Logger.error(TAG, `startBackgroundRunning failed. code is ${error.code} message is ${error.message}`);
}
});
}
...
}
暫停音樂播放,結束長時任務。
// BackgroundTaskUtil.ets
import wantAgent from '@ohos.app.ability.wantAgent';
import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';
...
export class BackgroundTaskUtil {
...
public static stopContinuousTask(context: Context) {
if (context === undefined) {
Logger.info(TAG, 'stopContinuousTask fail,context is empty.');
return;
}
try {
backgroundTaskManager.stopBackgroundRunning(context).then(() = > {
Logger.info(TAG, 'stopBackgroundRunning succeeded');
}).catch((err: Error) = > {
Logger.error(TAG, 'stopBackgroundRunning failed Cause: ' + JSON.stringify(err));
});
} catch (error) {
Logger.error(TAG, `stopBackgroundRunning failed. code is ${error.code} message is ${error.message}`);
}
}
}
審核編輯 黃宇
-
鴻蒙
+關注
關注
57文章
2339瀏覽量
42805 -
HarmonyOS
+關注
關注
79文章
1973瀏覽量
30143 -
OpenHarmony
+關注
關注
25文章
3713瀏覽量
16255
發布評論請先 登錄
相關推薦
評論