Q:音视频播放开发中如何使用长时任务?有哪些注意事项?
import { backgroundTaskManager } from '@kit.BackgroundTasksKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { wantAgent, WantAgent } from '@kit.AbilityKit';
import { media } from '@kit.MediaKit';
import { avSession } from '@kit.AVSessionKit'; @Entry
@Component
struct Index {
@State message: string = 'ContinuousTask';
// getHostContext方法需通过类型断言将结果强制转换为Context,否则编译报错
private context: Context = this.getUIContext().getHostContext() as Context;
avPlayer?: media.AVPlayer;
session?: avSession.AVSession;
// 开启长时任务
startContinuousTask() {
let wantAgentInfo: wantAgent.WantAgentInfo = {
// 点击通知后,将要执行的动作列表
// 添加需要被拉起应用的bundleName和abilityName
wants: [
{
bundleName: 'com.example.backgroundmusic',
abilityName: 'MainAbility'
}
],
// 指定点击通知栏消息后的动作是拉起ability
actionType: wantAgent.OperationType.START_ABILITY,
// 使用者自定义的一个私有值
requestCode: 0,
// 点击通知后,动作执行属性
actionFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG],
};
try {
// 通过wantAgent模块下getWantAgent方法获取WantAgent对象
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj: WantAgent) => {
try {
let list: Array<string> = ['audioPlayback'];
backgroundTaskManager.startBackgroundRunning(this.context, list, wantAgentObj)
.then(() => {
console.info('Operation startBackgroundRunning succeeded');
})
.catch((error: BusinessError) => {
console.error(`Failed to Operation startBackgroundRunning. code is ${error.code} message is ${error.message}`);
});
} catch (error) {
console.error(`Failed to Operation startBackgroundRunning. code is ${(error as BusinessError).code} message is ${(error as BusinessError).message}`);
}
;
});
} catch (error) {
console.error(`Failed to Operation getWantAgent. code is ${(error as BusinessError).code} message is ${(error as BusinessError).message}`);
}
}
// 取消长时任务
stopContinuousTask() {
backgroundTaskManager.stopBackgroundRunning(this.context).then(() => {
console.info(`Succeeded in operationing stopBackgroundRunning.`);
}).catch((err: BusinessError) => {
console.error(`Failed to operation stopBackgroundRunning. Code is ${err.code}, message is ${err.message}`);
});
}
// 播放音乐
async playMusic() {
await this.initAudioPlayer();
let rawfileFd =
this.context.resourceManager.getRawFdSync('world.wav'); // 'world.wav'仅作示例,请开发者自行替换,否则资源加载失败会导致后续无法正常执行
let url = rawfileFd;
if (this.avPlayer && url) {
let avFileDescriptor: media.AVFileDescriptor = { fd: url.fd, offset: url.offset, length: url.length };
this.avPlayer.fdSrc = avFileDescriptor;
}
}
// 初始化播放器
async initAudioPlayer() {
if (!this.avPlayer) {
this.avPlayer = await media.createAVPlayer();
this.createSession();
this.avPlayer.on('stateChange', (state: string) => {
switch (state) {
case 'idle':
let rawfileFd =
this.context.resourceManager.getRawFdSync('world.wav'); // 'world.wav'仅作示例,请开发者自行替换,否则资源加载失败会导致后续无法正常执行
let url = rawfileFd;
if (this.avPlayer && url) {
let avFileDescriptor: media.AVFileDescriptor = { fd: url.fd, offset: url.offset, length: url.length };
this.avPlayer.fdSrc = avFileDescriptor;
}
break;
case 'initialized':
if (this.avPlayer) {
this.avPlayer.prepare().then(() => {
console.info('AVPlayer prepare succeeded.');
}, (err: BusinessError) => {
console.error(`Invoke prepare failed, code is ${err.code}, message is ${err.message}`);
});
}
break;
case 'prepared':
console.info('AVPlayer state prepared called.');
if (this.avPlayer) {
this.avPlayer.play();
}
console.info('AVPlayer prepared succeeded.');
break;
default:
console.info('AVPlayer state unknown called.');
}
});
}
}
// 创建session
async createSession() {
if (!this.context) {
return;
}
this.session = await avSession.createAVSession(this.context, 'SESSION_NAME', 'audio');
this.session.activate();
this.setAVMetadata();
console.info(`session create done : sessionId : ${this.session.sessionId}`);
this.session.on('play', () => {
});
}
// 设置音频元数据
async setAVMetadata() {
try {
if (this.context) {
let metadata: avSession.AVMetadata = {
assetId: '100',
title: 'world',
artist: 'artor',
duration: 61
};
if (this.session) {
this.session.setAVMetadata(metadata).then(() => {
console.info('SetAVMetadata successfully');
}).catch((err: BusinessError) => {
console.error(`SetAVMetadata BusinessError: code: ${err.code}, message: ${err.message}`);
});
}
}
} catch (error) {
console.error(`SetAVMetadata try: code: ${(error as BusinessError).code},
message: ${(error as BusinessError).message}`);
}
}
build() {
Row() {
Column() {
Button() {
Text('申请长时任务并播放音乐').fontSize(25).fontWeight(FontWeight.Bold)
}
.type(ButtonType.Capsule)
.margin({ top: 10 })
.backgroundColor('#0D9FFB')
.width(300)
.height(40)
.onClick(() => {
// 通过按钮申请长时任务
this.startContinuousTask();
// 播放音乐
this.playMusic();
})
}.width('100%')
}.height('100%')
}
}
Q:avPlayer接入长时任务以及AVSession,切到后台无法播放音乐。
A:经代码排查,在aboutToDisappear中调用了取消长时任务,导致应用切后台后无法播放音乐,可以在音乐播放时申请长时任务,达到默认支持后台播放的效果,在音频渲染器释放的时候取消长时任务。
Q:音视频播放创建实例是否有规格限制。
A:推荐单个应用创建的音视频播放实例(即音频、视频、音视频三类相加)不超过16个。
Q:开发后台任务播放音视频时,使用AVSession设置元数据,出现报错401,错误信息是get metadata failed。
Q:长时任务是否必须在onForeground或onCreate阶段申请?在用户点击播放按钮时申请是否太晚?
A:不要求只能在onCreate或onForeground中申请。用户点击播放按钮时申请是合适的时机,先调用并等待startBackgroundRunning()成功,再启动实际播放业务即可。申请成功后要尽快产生与audioPlayback对应的真实播放行为,系统会校验业务真实性,只有长时任务却没有有效音频播放时,任务可能被取消、应用可能被挂起。停止播放且不再继续时,及时调用stopBackgroundRunning()。
Q:后台播放无声音频时,系统是否会因无声音频而杀掉应用?
A:当申请audioPlayback类型的长时任务后,系统会持续检测音频流的状态。如果系统发现应用实际上并未播放有效音频(例如音频流被静音、数据为空,或者播放器处于暂停状态),它会认为长时任务与真实业务不符,进而取消长时任务并冻结应用进程。
Q:应用未播放音乐时,申请的音频播放长时任务为什么不会被系统自动停止?
A:系统对长时任务的管控以应用退至后台为前提,应用在前台时即使未播放音乐,系统也不会停止其长时任务。系统检测为延时/周期性兜底管控,非实时取消,通知栏取消存在滞后。系统自动停止长时任务的场景仅限特定情形(如音频在后台播放时被焦点打断后系统冻结或取消长时任务)。日常场景下,长时任务生命周期管理由应用控制,应将长时任务与播放业务生命周期绑定:播放开始时调用startBackgroundRunning申请长时任务,暂停或停止播放时主动调用stopBackgroundRunning取消长时任务,避免在前台未实际播放时提前持有长时任务,防止退后台后被系统判定为未使用而挂起。