harmony 鸿蒙@ohos.accessibility.config (系统辅助功能配置)
@ohos.accessibility.config (系统辅助功能配置)
本模块提供系统辅助功能的配置,包括辅助扩展的启用与关闭、高对比度文字显示、鼠标键、无障碍字幕配置等。
说明:
- 本模块首批接口从 API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
- 本模块接口为系统接口。
导入模块
import config from '@ohos.accessibility.config';
属性
系统能力:以下各项对应的系统能力均为SystemCapability.BarrierFree.Accessibility.Core
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
highContrastText | Config<boolean> | 是 | 是 | 表示高对比度文字功能启用状态。 |
invertColor | Config<boolean> | 是 | 是 | 表示颜色反转功能启用状态。 |
daltonizationState11+ | Config<boolean> | 是 | 是 | 表示颜色滤镜功能启动状态。 |
daltonizationColorFilter | Config<DaltonizationColorFilter> | 是 | 是 | 表示颜色滤镜功能配置。 |
contentTimeout | Config<number> | 是 | 是 | 表示内容显示建议时长配置。取值 0~5000,单位为毫秒。 |
animationOff | Config<boolean> | 是 | 是 | 表示关闭动画功能启用状态。 |
brightnessDiscount | Config<number> | 是 | 是 | 表示亮度折扣系统配置。取值 0~1.0。 |
mouseKey | Config<boolean> | 是 | 是 | 表示鼠标键功能启用状态。 |
mouseAutoClick | Config<number> | 是 | 是 | 表示鼠标自动点击功能启用状态。取值 0~5000,单位为毫秒。 |
shortkey | Config<boolean> | 是 | 是 | 表示辅助扩展快捷键功能启用状态。 |
shortkeyTarget | Config<string> | 是 | 是 | 表示辅助扩展快捷键的目标配置。取值为辅助应用的名称,格式为:’bundleName/abilityName’。 |
captions | Config<boolean> | 是 | 是 | 表示辅助字幕功能启用状态。 |
captionsStyle | Config<accessibility.CaptionsStyle> | 是 | 是 | 表示辅助字幕的配置。 |
audioMono10+ | Config<boolean> | 是 | 是 | 表示音频单声道的配置。True表示打开单声道,False表示关闭单声道。 |
audioBalance10+ | Config<number> | 是 | 是 | 表示左右声道音量平衡的配置。取值 -1.0~1.0。 |
enableAbility
enableAbility(name: string, capability: Array<accessibility.Capability>): Promise<void>;
启用辅助扩展,使用Promise异步回调。
系统能力:SystemCapability.BarrierFree.Accessibility.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 辅助应用的名称,格式为:’bundleName/abilityName’。 |
capability | Array<accessibility.Capability> | 是 | 辅助应用的能力属性。 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | 无返回结果的Promise对象。 |
错误码:
以下错误码的详细介绍请参见无障碍子系统错误码。
错误码ID | 错误信息 |
---|---|
9300001 | Invalid bundle name or ability name. |
9300002 | Target ability already enabled. |
示例:
import accessibility from '@ohos.accessibility';
import config from '@ohos.accessibility.config';
let name: string = 'com.ohos.example/axExtension';
let capability : accessibility.Capability[] = ['retrieve'];
try {
config.enableAbility(name, capability).then(() => {
console.info('enable ability succeed');
}).catch((err: object) => {
console.error('failed to enable ability, because ' + JSON.stringify(err));
});
} catch (exception) {
console.error('failed to enable ability, because ' + JSON.stringify(exception));
};
enableAbility
enableAbility(name: string, capability: Array<accessibility.Capability>, callback: AsyncCallback<void>): void;
启用辅助扩展,使用callback异步回调。
系统能力:SystemCapability.BarrierFree.Accessibility.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 辅助应用的名称,格式为:’bundleName/abilityName’。 |
capability | Array<accessibility.Capability> | 是 | 辅助应用的能力属性。 |
callback | AsyncCallback<void> | 是 | 回调函数。 |
错误码:
以下错误码的详细介绍请参见无障碍子系统错误码。
错误码ID | 错误信息 |
---|---|
9300001 | Invalid bundle name or ability name. |
9300002 | Target ability already enabled. |
示例:
import accessibility from '@ohos.accessibility';
import config from '@ohos.accessibility.config';
import { BusinessError } from '@ohos.base';
let name: string = 'com.ohos.example/axExtension';
let capability: accessibility.Capability[] = ['retrieve'];
try {
config.enableAbility(name, capability, (err: BusinessError<void>) => {
if (err) {
console.error('failed to enable ability, because ' + JSON.stringify(err));
return;
}
console.info('enable ability succeed');
});
} catch (exception) {
console.error('failed to enable ability, because ' + JSON.stringify(exception));
};
disableAbility
disableAbility(name: string): Promise<void>;
关闭辅助扩展,使用Promise异步回调。
系统能力:SystemCapability.BarrierFree.Accessibility.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 辅助应用的名称,格式为:’bundleName/abilityName’。 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | 无返回结果的Promise对象。 |
错误码:
以下错误码的详细介绍请参见无障碍子系统错误码。
错误码ID | 错误信息 |
---|---|
9300001 | Invalid bundle name or ability name. |
示例:
import accessibility from '@ohos.accessibility';
import config from '@ohos.accessibility.config';
let name: string = 'com.ohos.example/axExtension';
try {
config.disableAbility(name).then(() => {
console.info('disable ability succeed');
}).catch((err: object) => {
console.error('failed to disable ability, because ' + JSON.stringify(err));
});
} catch (exception) {
console.error('failed to disable ability, because ' + JSON.stringify(exception));
};
disableAbility
disableAbility(name: string, callback: AsyncCallback<void>): void;
关闭辅助扩展,使用callback异步回调。
系统能力:SystemCapability.BarrierFree.Accessibility.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 辅助应用的名称,格式为:’bundleName/abilityName’。 |
callback | AsyncCallback<void> | 是 | 回调函数。 |
错误码:
以下错误码的详细介绍请参见无障碍子系统错误码。
错误码ID | 错误信息 |
---|---|
9300001 | Invalid bundle name or ability name. |
示例:
import accessibility from '@ohos.accessibility';
import config from '@ohos.accessibility.config';
import { BusinessError } from '@ohos.base';
let name: string = 'com.ohos.example/axExtension';
try {
config.disableAbility(name, (err: BusinessError<void>) => {
if (err) {
console.error('failed to enable ability, because ' + JSON.stringify(err));
return;
}
console.info('disable succeed');
});
} catch (exception) {
console.error('failed to enable ability, because ' + JSON.stringify(exception));
};
on(‘enabledAccessibilityExtensionListChange’)
on(type: ‘enabledAccessibilityExtensionListChange’, callback: Callback<void>): void;
添加启用的辅助扩展的列表变化监听,使用callback异步回调。
系统能力:SystemCapability.BarrierFree.Accessibility.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 参数固定为enabledAccessibilityExtensionListChange,监听启用的辅助扩展的列表变化。 |
callback | Callback<void> | 是 | 回调函数,在启用的辅助扩展的列表变化时通过此函数进行通知。 |
示例:
import config from '@ohos.accessibility.config';
try {
config.on('enabledAccessibilityExtensionListChange', () => {
console.info('subscribe enabled accessibility extension list change state success');
});
} catch (exception) {
console.error('failed to subscribe enabled accessibility extension list change state, because ' +
JSON.stringify(exception));
};
off(‘enabledAccessibilityExtensionListChange’)
off(type: ‘enabledAccessibilityExtensionListChange’, callback?: Callback<void>): void;
取消启用的辅助扩展的列表变化监听,使用callback异步回调。
系统能力:SystemCapability.BarrierFree.Accessibility.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 参数固定为enabledAccessibilityExtensionListChange,监听启用的辅助扩展的列表变化。 |
callback | Callback<void> | 否 | 取消指定callback对象的事件响应。需与on(‘enabledAccessibilityExtensionListChange’)的callback一致。缺省时,表示注销所有已注册事件。 |
示例:
import config from '@ohos.accessibility.config';
try {
config.off('enabledAccessibilityExtensionListChange', () => {
console.info('Unsubscribe enabled accessibility extension list change state success');
});
} catch (exception) {
console.error('failed to Unsubscribe enabled accessibility extension list change state, because ' +
JSON.stringify(exception));
};
Config
用于属性的设置、获取与监听。
set
set(value: T): Promise<void>;
设置属性,使用Promise异步回调。
系统能力:SystemCapability.BarrierFree.Accessibility.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
value | T | 是 | 设置的属性值。 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | 无返回结果的Promise对象。 |
示例:
import config from '@ohos.accessibility.config';
let value: boolean = true;
try {
config.highContrastText.set(value).then(() => {
console.info('set highContrastText succeed');
}).catch((err: object) => {
console.error('failed to set highContrastText, because ' + JSON.stringify(err));
});
} catch (exception) {
console.error('failed to set config, because ' + JSON.stringify(exception));
};
set
set(value: T, callback: AsyncCallback<void>): void;
设置属性,使用callback异步回调。
系统能力:SystemCapability.BarrierFree.Accessibility.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
value | T | 是 | 设置的属性值。 |
callback | AsyncCallback<void> | 是 | 回调函数。 |
示例:
import config from '@ohos.accessibility.config';
import { BusinessError } from '@ohos.base';
let value: boolean = true;
try {
config.highContrastText.set(value, (err: BusinessError<void>) => {
if (err) {
console.error('failed to set highContrastText, because ' + JSON.stringify(err));
return;
}
console.info('set highContrastText succeed');
});
} catch (exception) {
console.error('failed to set config, because ' + JSON.stringify(exception));
};
get
get(): Promise<T>;
获取属性,使用Promise异步回调。
系统能力:SystemCapability.BarrierFree.Accessibility.Core
返回值:
类型 | 说明 |
---|---|
Promise<T> | Promise对象,返回对应属性值。 |
示例:
import config from '@ohos.accessibility.config';
import { BusinessError } from '@ohos.base';
let value: boolean;
config.highContrastText.get().then((data: boolean) => {
value = data;
console.info('get highContrastText success');
}).catch((err: object) => {
console.error('failed to get highContrastText, because ' + JSON.stringify(err));
});
get
get(callback: AsyncCallback<T>): void;
获取属性,使用callback异步回调。
系统能力:SystemCapability.BarrierFree.Accessibility.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<T> | 是 | 回调函数,返回属性值。 |
示例:
import config from '@ohos.accessibility.config';
import { BusinessError } from '@ohos.base';
let value: boolean;
config.highContrastText.get((err: BusinessError<void>, data: boolean) => {
if (err) {
console.error('failed to get highContrastText, because ' + JSON.stringify(err));
return;
}
value = data;
console.info('get highContrastText success');
});
on
on(callback: Callback<T>): void;
添加属性变化监听,使用callback异步回调。
系统能力:SystemCapability.BarrierFree.Accessibility.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | Callback<T> | 是 | 回调函数,在属性变化时通过此函数进行通知。 |
示例:
import config from '@ohos.accessibility.config';
try {
config.highContrastText.on((data: boolean) => {
console.info('subscribe highContrastText success, result: ' + JSON.stringify(data));
});
} catch (exception) {
console.error('failed subscribe highContrastText, because ' + JSON.stringify(exception));
}
off
off(callback?: Callback<T>): void;
取消属性变化监听,使用callback异步回调。
系统能力:SystemCapability.BarrierFree.Accessibility.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | Callback<T> | 否 | 取消指定callback对象的事件响应。需与on()的callback一致。缺省时,表示注销所有已注册事件。 |
示例:
import config from '@ohos.accessibility.config';
config.highContrastText.off((data: boolean) => {
console.info('Unsubscribe highContrastText success, result: ' + JSON.stringify(data));
});
DaltonizationColorFilter
用于不同弱视类型的校正颜色滤镜。
颜色滤镜功能开启时(daltonizationState设置为true),选择的校正颜色滤镜生效;颜色滤镜功能关闭时(daltonizationState设置为false),显示为正常类型11+。
系统能力:以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
名称 | 说明 |
---|---|
Normal | 表示正常类型。 |
Protanomaly | 表示红色弱视类型。 |
Deuteranomaly | 表示绿色弱视类型。 |
Tritanomaly | 表示蓝色弱视类型。 |
你可能感兴趣的鸿蒙文章
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框自动聚焦