harmony 鸿蒙@ohos.multimedia.systemSoundManager (系统声音管理)
@ohos.multimedia.systemSoundManager (系统声音管理)
系统声音管理提供管理系统声音的一些基础能力,包括对系统铃声的资源设置与读取、获取系统铃声播放器等。
说明:
本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
本模块接口为系统接口。
导入模块
import systemSoundManager from '@ohos.multimedia.systemSoundManager';
RingtoneType
枚举,铃声类型。
系统接口: 该接口为系统接口。
系统能力: SystemCapability.Multimedia.SystemSound.Core
名称 | 值 | 说明 |
---|---|---|
RINGTONE_TYPE_DEFAULT | 0 | 默认铃声类型。 |
RINGTONE_TYPE_MULTISIM | 1 | 多SIM卡铃声类型。 |
systemSoundManager.getSystemSoundManager
getSystemSoundManager(): SystemSoundManager
获取系统声音管理器。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
返回值:
类型 | 说明 |
---|---|
SystemSoundManager | 系统声音管理类。 |
示例:
let systemSoundManagerInstance: systemSoundManager.SystemSoundManager = systemSoundManager.getSystemSoundManager();
SystemSoundManager
管理系统声音。在调用SystemSoundManager的接口前,需要先通过getSystemSoundManager创建实例。
setSystemRingtoneUri
setSystemRingtoneUri(context: Context, uri: string, type: RingtoneType, callback: AsyncCallback<void>): void
设置系统铃声uri,使用callback方式异步返回结果。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
context | Context | 是 | 当前应用的上下文。 |
uri | string | 是 | 被设置的系统铃声的uri,资源支持可参考media.AVPlayer。 |
type | RingtoneType | 是 | 被设置的系统铃声的类型。 |
callback | AsyncCallback<void> | 是 | 回调返回设置成功或失败。 |
示例:
import { BusinessError } from '@ohos.base';
let context: Context = getContext(this);
let uri = 'file://data/test.wav'; // 需更改为目标铃声文件的uri
let type: systemSoundManager.RingtoneType = systemSoundManager.RingtoneType.RINGTONE_TYPE_DEFAULT;
systemSoundManagerInstance.setSystemRingtoneUri(context, uri, type, (err: BusinessError) => {
if (err) {
console.error(`Failed to set system ringtone uri. ${err}`);
return;
}
console.info(`Callback invoked to indicate a successful setting of the system ringtone uri.`);
});
setSystemRingtoneUri
setSystemRingtoneUri(context: Context, uri: string, type: RingtoneType): Promise<void>
设置系统铃声uri,使用Promise方式异步返回结果。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
context | Context | 是 | 当前应用的上下文。 |
uri | string | 是 | 被设置的系统铃声的uri,资源支持可参考media.AVPlayer。 |
type | RingtoneType | 是 | 被设置的系统铃声的类型。 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | Promise回调返回设置成功或失败。 |
示例:
import { BusinessError } from '@ohos.base';
let context: Context = getContext(this);
let uri = 'file://data/test.wav'; // 需更改为目标铃声文件的uri
let type: systemSoundManager.RingtoneType = systemSoundManager.RingtoneType.RINGTONE_TYPE_DEFAULT;
systemSoundManagerInstance.setSystemRingtoneUri(context, uri, type).then(() => {
console.info(`Promise returned to indicate a successful setting of the system ringtone uri.`);
}).catch ((err: BusinessError) => {
console.error(`Failed to set the system ringtone uri ${err}`);
});
getSystemRingtoneUri
getSystemRingtoneUri(context: Context, type: RingtoneType, callback: AsyncCallback<string>): void
获取系统铃声uri,使用callback方式异步返回结果。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
context | Context | 是 | 当前应用的上下文。 |
type | RingtoneType | 是 | 待获取的系统铃声的类型。 |
callback | AsyncCallback<string> | 是 | 回调返回获取的系统铃声uri。 |
示例:
import { BusinessError } from '@ohos.base';
let context: Context = getContext(this);
let type: systemSoundManager.RingtoneType = systemSoundManager.RingtoneType.RINGTONE_TYPE_DEFAULT;
systemSoundManagerInstance.getSystemRingtoneUri(context, type, (err: BusinessError, value: string) => {
if (err) {
console.error(`Failed to get system ringtone uri. ${err}`);
return;
}
console.info(`Callback invoked to indicate the value of the system ringtone uri is obtained ${value}.`);
});
getSystemRingtoneUri
getSystemRingtoneUri(context: Context, type: RingtoneType): Promise<string>
获取系统铃声uri,使用Promise方式异步返回结果。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
context | Context | 是 | 当前应用的上下文。 |
type | RingtoneType | 是 | 被设置的系统铃声的类型。 |
返回值:
类型 | 说明 |
---|---|
Promise<string> | Promise回调返回获取的系统铃声uri。 |
示例:
import { BusinessError } from '@ohos.base';
let context: Context = getContext(this);
let type: systemSoundManager.RingtoneType = systemSoundManager.RingtoneType.RINGTONE_TYPE_DEFAULT;
systemSoundManagerInstance.getSystemRingtoneUri(context, type).then((value: string) => {
console.info(`Promise returned to indicate that the value of the system ringtone uri is obtained ${value}.`);
}).catch ((err: BusinessError) => {
console.error(`Failed to get the system ringtone uri ${err}`);
});
getSystemRingtonePlayer
getSystemRingtonePlayer(context: Context, type: RingtoneType, callback: AsyncCallback<RingtonePlayer>): void
获取系统铃声播放器,使用callback方式异步返回结果。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
context | Context | 是 | 当前应用的上下文。 |
type | RingtoneType | 是 | 待获取播放器的系统铃声的类型。 |
callback | AsyncCallback<RingtonePlayer> | 是 | 回调返回获取的系统铃声播放器。 |
示例:
import { BusinessError } from '@ohos.base';
let context: Context = getContext(this);
let type: systemSoundManager.RingtoneType = systemSoundManager.RingtoneType.RINGTONE_TYPE_DEFAULT;
let systemRingtonePlayer: systemSoundManager.RingtonePlayer|undefined = undefined;
systemSoundManagerInstance.getSystemRingtonePlayer(context, type, (err: BusinessError, value: systemSoundManager.RingtonePlayer) => {
if (err) {
console.error(`Failed to get system ringtone player. ${err}`);
return;
}
console.info(`Callback invoked to indicate the value of the system ringtone player is obtained.`);
systemRingtonePlayer = value;
});
getSystemRingtonePlayer
getSystemRingtonePlayer(context: Context, type: RingtoneType): Promise<RingtonePlayer>
获取系统铃声播放器,使用Promise方式异步返回结果。
系统接口: 该接口为系统接口
系统能力: SystemCapability.Multimedia.SystemSound.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
context | Context | 是 | 当前应用的上下文。 |
type | RingtoneType | 是 | 待获取播放器的系统铃声的类型。 |
返回值:
类型 | 说明 |
---|---|
Promise<RingtonePlayer> | Promise回调返回获取的系统铃声播放器。 |
示例:
import { BusinessError } from '@ohos.base';
let context: Context = getContext(this);
let type: systemSoundManager.RingtoneType = systemSoundManager.RingtoneType.RINGTONE_TYPE_DEFAULT;
let systemRingtonePlayer: systemSoundManager.RingtonePlayer|undefined = undefined;
systemSoundManagerInstance.getSystemRingtonePlayer(context, type).then((value: systemSoundManager.RingtonePlayer) => {
console.info(`Promise returned to indicate that the value of the system ringtone player is obtained.`);
systemRingtonePlayer = value;
}).catch ((err: BusinessError) => {
console.error(`Failed to get the system ringtone player ${err}`);
});
你可能感兴趣的鸿蒙文章
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框自动聚焦