harmony 鸿蒙ringtonePlayer (铃声播放器)
ringtonePlayer (铃声播放器)
铃声播放器提供了系统铃声的播放、配置、获取信息等功能。
ringtonePlayer需要和@ohos.multimedia.systemSoundManager配合使用,才能完成管理系统铃声的功能。
说明:
本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
本模块接口为系统接口。
导入模块
import systemSoundManager from '@ohos.multimedia.systemSoundManager';
RingtoneOptions
铃声参数选项。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
volume | number | 是 | 指定的相对音量大小,取值范围为[0.00, 1.00],1表示最大音量,即100%。 |
loop | boolean | 是 | 是否开启循环播放,true表示开启循环播放,false表示不开启循环播放。 |
RingtonePlayer
系统铃声播放器,提供系统铃声的参数设置、参数获取、播放、停止等功能。在调用RingtonePlayer的接口前,需要先通过getSystemRingtonePlayer创建实例。
属性
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
state | media.AVPlayerState | 是 | 否 | 音频渲染器的状态。 |
示例:
import media from '@ohos.multimedia.media';
let state: media.AVPlayerState = systemRingtonePlayer.state;
getTitle
getTitle(callback: AsyncCallback<string>): void
获取铃声标题,使用callback方式异步返回结果。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<string> | 是 | 回调返回获取的铃声标题。 |
示例:
import { BusinessError } from '@ohos.base';
systemRingtonePlayer.getTitle((err: BusinessError, value: string) => {
if (err) {
console.error(`Failed to get system ringtone title. ${err}`);
return;
}
console.info(`Callback invoked to indicate the value of the system ringtone title is obtained ${value}.`);
});
getTitle
getTitle(): Promise<string>
获取铃声标题,使用Promise方式异步返回结果。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
返回值:
类型 | 说明 |
---|---|
Promise<string> | Promise回调返回获取的系统铃声标题。 |
示例:
import { BusinessError } from '@ohos.base';
systemRingtonePlayer.getTitle().then((value: string) => {
console.info(`Promise returned to indicate that the value of the system ringtone title is obtained ${value}.`);
}).catch ((err: BusinessError) => {
console.error(`Failed to get the system ringtone title ${err}`);
});
getAudioRendererInfo
getAudioRendererInfo(callback: AsyncCallback<audio.AudioRendererInfo>): void
获取铃声使用的AudioRendererInfo,使用callback方式异步返回结果。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<audio.AudioRendererInfo> | 是 | 回调返回获取的AudioRendererInfo。 |
示例:
import audio from '@ohos.multimedia.audio';
import { BusinessError } from '@ohos.base';
let audioRendererInfo: audio.AudioRendererInfo|undefined = undefined;
systemRingtonePlayer.getAudioRendererInfo((err: BusinessError, value: audio.AudioRendererInfo) => {
if (err) {
console.error(`Failed to get ringtone AudioRendererInfo. ${err}`);
return;
}
console.info(`Callback invoked to indicate the value of the ringtone AudioRendererInfo is obtained.`);
audioRendererInfo = value;
});
getAudioRendererInfo
getAudioRendererInfo(): Promise<audio.AudioRendererInfo>
获取铃声使用的AudioRendererInfo,使用Promise方式异步返回结果。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
返回值:
类型 | 说明 |
---|---|
Promise<audio.AudioRendererInfo> | Promise回调返回获取的AudioRendererInfo。 |
示例:
import audio from '@ohos.multimedia.audio';
import { BusinessError } from '@ohos.base';
let audioRendererInfo: audio.AudioRendererInfo|undefined = undefined;
systemRingtonePlayer.getAudioRendererInfo().then((value: audio.AudioRendererInfo) => {
console.info(`Promise returned to indicate that the value of the ringtone AudioRendererInfo is obtained ${value}.`);
audioRendererInfo = value;
}).catch ((err: BusinessError) => {
console.error(`Failed to get the ringtone AudioRendererInfo ${err}`);
});
configure
configure(options: RingtoneOptions, callback: AsyncCallback<void>): void
配置铃声播放参数,使用callback方式异步返回结果。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
options | RingtoneOptions | 是 | 指定铃声参数。 |
callback | AsyncCallback<void> | 是 | 回调返回配置参数成功或失败。 |
示例:
import { BusinessError } from '@ohos.base';
class RingtoneOptions {
volume: number = 0;
loop: boolean = false;
}
let ringtoneOptions: RingtoneOptions = {volume: 0.5, loop: true};
systemRingtonePlayer.configure(ringtoneOptions, (err: BusinessError) => {
if (err) {
console.error(`Failed to configure ringtone options. ${err}`);
return;
}
console.info(`Callback invoked to indicate a successful setting of ringtone options.`);
});
configure
configure(options: RingtoneOptions): Promise<void>
配置铃声播放参数,使用Promise方式异步返回结果。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
options | RingtoneOptions | 是 | 指定铃声参数。 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | Promise回调返回配置参数成功或失败。 |
示例:
import { BusinessError } from '@ohos.base';
class RingtoneOptions {
volume: number = 0;
loop: boolean = false;
}
let ringtoneOptions: RingtoneOptions = {volume: 0.5, loop: true};
systemRingtonePlayer.configure(ringtoneOptions).then(() => {
console.info(`Promise returned to indicate a successful setting of ringtone options.`);
}).catch ((err: BusinessError) => {
console.error(`Failed to configure ringtone options. ${err}`);
});
start
start(callback: AsyncCallback<void>): void
开始播放铃声,使用callback方式异步返回结果。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 回调返回开始播放成功或失败。 |
示例:
import { BusinessError } from '@ohos.base';
systemRingtonePlayer.start((err: BusinessError) => {
if (err) {
console.error(`Failed to start playing ringtone. ${err}`);
return;
}
console.info(`Callback invoked to indicate a successful starting of ringtone.`);
});
start
start(): Promise<void>
开始播放铃声,使用Promise方式异步返回结果。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
返回值:
类型 | 说明 |
---|---|
Promise<void> | Promise回调返回开始播放成功或失败。 |
示例:
import { BusinessError } from '@ohos.base';
systemRingtonePlayer.start().then(() => {
console.info(`Promise returned to indicate a successful starting of ringtone.`);
}).catch ((err: BusinessError) => {
console.error(`Failed to start playing ringtone. ${err}`);
});
stop
stop(callback: AsyncCallback<void>): void
停止播放铃声,使用callback方式异步返回结果。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 回调返回停止播放成功或失败。 |
示例:
import { BusinessError } from '@ohos.base';
systemRingtonePlayer.stop((err: BusinessError) => {
if (err) {
console.error(`Failed to stop playing ringtone. ${err}`);
return;
}
console.info(`Callback invoked to indicate a successful stopping of ringtone.`);
});
stop
stop(): Promise<void>
停止播放铃声,使用Promise方式异步返回结果。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
返回值:
类型 | 说明 |
---|---|
Promise<void> | Promise回调返回停止播放成功或失败。 |
示例:
import { BusinessError } from '@ohos.base';
systemRingtonePlayer.stop().then(() => {
console.info(`Promise returned to indicate a successful stopping of ringtone.`);
}).catch ((err: BusinessError) => {
console.error(`Failed to stop playing ringtone. ${err}`);
});
release
release(callback: AsyncCallback<void>): void
释放铃声播放器,使用callback方式异步返回结果。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 回调返回释放成功或失败。 |
示例:
import { BusinessError } from '@ohos.base';
systemRingtonePlayer.release((err: BusinessError) => {
if (err) {
console.error(`Failed to release ringtone player. ${err}`);
return;
}
console.info(`Callback invoked to indicate a successful releasing of ringtone player.`);
});
release
release(): Promise<void>
释放铃声播放器,使用Promise方式异步返回结果。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
返回值:
类型 | 说明 |
---|---|
Promise<void> | Promise回调返回释放成功或失败。 |
示例:
import { BusinessError } from '@ohos.base';
systemRingtonePlayer.release().then(() => {
console.info(`Promise returned to indicate a successful releasing of ringtone player.`);
}).catch ((err: BusinessError) => {
console.error(`Failed to release ringtone player. ${err}`);
});
on(‘audioInterrupt’)
on(type: ‘audioInterrupt’, callback: Callback<audio.InterruptEvent>): void
监听音频中断事件。使用callback获取中断事件。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 事件回调类型,支持的事件为:’audioInterrupt’(中断事件被触发,音频渲染被中断)。 |
callback | Callback<audio.InterruptEvent> | 是 | 被监听的中断事件的回调。 |
错误码:
以下错误码的详细介绍请参见音频错误码。
错误码ID | 错误信息 |
---|---|
401 | if input parameter type or number mismatch |
6800101 | if input parameter value error |
示例:
import audio from '@ohos.multimedia.audio';
let isPlaying: boolean; // 标识符,表示是否正在渲染
let isDucked: boolean; // 标识符,表示是否被降低音量
systemRingtonePlayer.on('audioInterrupt', async(interruptEvent: audio.InterruptEvent) => {
if (interruptEvent.forceType == audio.InterruptForceType.INTERRUPT_FORCE) {
// 由系统进行操作,强制打断音频渲染,应用需更新自身状态及显示内容等
switch (interruptEvent.hintType) {
case audio.InterruptHint.INTERRUPT_HINT_PAUSE:
// 音频流已被暂停,临时失去焦点,待可重获焦点时会收到resume对应的interruptEvent
console.info('Force paused. Update playing status and stop writing');
isPlaying = false; // 简化处理,代表应用切换至暂停状态的若干操作
break;
case audio.InterruptHint.INTERRUPT_HINT_STOP:
// 音频流已被停止,永久失去焦点,若想恢复渲染,需用户主动触发
console.info('Force stopped. Update playing status and stop writing');
isPlaying = false; // 简化处理,代表应用切换至暂停状态的若干操作
break;
case audio.InterruptHint.INTERRUPT_HINT_DUCK:
// 音频流已被降低音量渲染
console.info('Force ducked. Update volume status');
isDucked = true; // 简化处理,代表应用更新音量状态的若干操作
break;
case audio.InterruptHint.INTERRUPT_HINT_UNDUCK:
// 音频流已被恢复正常音量渲染
console.info('Force ducked. Update volume status');
isDucked = false; // 简化处理,代表应用更新音量状态的若干操作
break;
default:
break;
}
} else if (interruptEvent.forceType == audio.InterruptForceType.INTERRUPT_SHARE) {
// 由应用进行操作,应用可以自主选择响应操作或忽略该事件
switch (interruptEvent.hintType) {
case audio.InterruptHint.INTERRUPT_HINT_RESUME:
// 建议应用继续渲染(说明音频流此前被强制暂停,临时失去焦点,现在可以恢复渲染)
console.info('Resume force paused renderer or ignore');
// 若选择继续渲染,需在此处主动执行开始渲染的若干操作
break;
default:
break;
}
}
});
off(‘audioInterrupt’) 10+
off(type: ‘audioInterrupt’): void
取消订阅音频中断事件。
系统能力: SystemCapability.Multimedia.SystemSound.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 要取消订阅事件的类型。支持的事件为:’audioInterrupt’。 |
错误码:
以下错误码的详细介绍请参见音频错误码。
错误码ID | 错误信息 |
---|---|
401 | if input parameter type or number mismatch |
6800101 | if input parameter value error |
示例:
systemRingtonePlayer.off('audioInterrupt');
你可能感兴趣的鸿蒙文章
harmony 鸿蒙BundleStatusCallback
harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)
harmony 鸿蒙@ohos.distributedBundle (分布式包管理)
harmony 鸿蒙@ohos.bundle (Bundle模块)
harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)
- 所属分类: 后端技术
- 本文标签:
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦