harmony 鸿蒙@ohos.screen (屏幕)

2022-08-09
浏览 (852)

@ohos.screen (屏幕)

本模块提供管理屏幕的一些基础能力，包括获取屏幕对象，监听屏幕变化，创建和销毁虚拟屏幕等。

说明：

本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本模块接口为系统接口。

导入模块

import screen from '@ohos.screen';

screen.getAllScreens

getAllScreens(callback: AsyncCallback<Array<Screen>>): void

获取所有的屏幕，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Array<Screen>>	是	回调函数。返回当前获取的屏幕对象集合。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400001	Invalid display or screen.

示例：

import { BusinessError } from '@ohos.base';

let screenClass: screen.Screen|null = null;
screen.getAllScreens((err: BusinessError, data: Array<screen.Screen>) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to get all screens. Cause:  ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in getting all screens. Data:' + JSON.stringify(data));
  screenClass = data[0];
});

screen.getAllScreens

getAllScreens(): Promise<Array<Screen>>

获取所有的屏幕，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

返回值：

类型	说明
Promise<Array<Screen>>	Promise对象。返回当前获取的屏幕对象集合。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400001	Invalid display or screen.

示例：

import { BusinessError } from '@ohos.base';

let screenClass: screen.Screen|null = null;
let promise: Promise<Array<screen.Screen>> = screen.getAllScreens();
promise.then((data: Array<screen.Screen>) => {
  screenClass = data[0];
  console.log('Succeeded in getting all screens. Data:' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.log('Failed to get all screens. Cause: ' + JSON.stringify(err));
});

screen.on(‘connect’|‘disconnect’|‘change’)

on(eventType: ‘connect’|‘disconnect’|‘change’, callback: Callback<number>): void

开启屏幕状态变化的监听。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

参数名	类型	必填	说明
eventType	string	是	监听事件。 -eventType为”connect”表示屏幕连接事件。 -eventType为”disconnect”表示断开屏幕连接事件。 -eventType为”change”表示屏幕状态改变事件。
callback	Callback<number>	是	回调函数。返回屏幕的id，该参数应为整数。

示例：

try {
  let callback: Callback<number> = (data: number) => {
    console.info('Succeeded in registering the callback for screen changes. Data: ' + JSON.stringify(data))
  };
  screen.on('connect', callback);
} catch (exception) {
  console.error('Failed to register the callback for screen changes. Code: ' + JSON.stringify(exception));
};

screen.off(‘connect’|‘disconnect’|‘change’)

off(eventType: ‘connect’|‘disconnect’|‘change’, callback?: Callback<number>): void

关闭屏幕状态变化的监听。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

参数名	类型	必填	说明
eventType	string	是	监听事件。 -eventType为”connect”表示屏幕连接事件。 -eventType为”disconnect”表示断开屏幕连接事件。 -eventType为”change”表示屏幕状态改变事件。
callback	Callback<number>	否	回调函数。返回屏幕的id，该参数应为整数。

示例：

try {
  let callback: Callback<number> = (data: number) => {
    console.info('Succeeded in unregistering the callback for screen changes. Data: ' + JSON.stringify(data))
  };
  screen.off('connect', callback);
} catch (exception) {
  console.error('Failed to register the callback for screen changes. Code: ' + JSON.stringify(exception));
};

screen.makeExpand

makeExpand(options:Array<ExpandOption>, callback: AsyncCallback<number>): void

将屏幕设置为扩展模式，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

参数名	类型	必填	说明
options	Array<ExpandOption>	是	设置扩展屏幕的参数集合。
callback	AsyncCallback<number>	是	回调函数。返回扩展屏幕的群组id，其中id应为整数。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400001	Invalid display or screen.

示例：

import { BusinessError } from '@ohos.base';

try {
  let groupId: number|null = null;
  class ExpandOption {
    screenId: number = 0;
    startX: number = 0;
    startY: number = 0;
  }
  let mainScreenOption: ExpandOption = { screenId: 0, startX: 0, startY: 0 };
  let otherScreenOption: ExpandOption = { screenId: 1, startX: 1080, startY: 0 };
  let expandOptionArray : ExpandOption[] = [ mainScreenOption, otherScreenOption ];
  screen.makeExpand(expandOptionArray, (err: BusinessError, data: number) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to expand the screen. Code:' + JSON.stringify(err));
      return;
    }
    groupId = data;
    console.info('Succeeded in expanding the screen. Data: ' + JSON.stringify(data));
  });
} catch (exception) {
  console.error('Failed to expand the screen. Code: ' + JSON.stringify(exception));
};

screen.makeExpand

makeExpand(options:Array<ExpandOption>): Promise<number>

将屏幕设置为扩展模式，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

参数名	类型	必填	说明
options	Array<ExpandOption>	是	设置扩展屏幕的参数集合。

返回值：

类型	说明
Promise<number>	Promise对象。返回扩展屏幕的群组id，其中id应为整数。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400001	Invalid display or screen.

示例：

import { BusinessError } from '@ohos.base';

try {
  class ExpandOption {
    screenId: number = 0;
    startX: number = 0;
    startY: number = 0;
  }
  let mainScreenOption: ExpandOption = { screenId: 0, startX: 0, startY: 0 };
  let otherScreenOption: ExpandOption = { screenId: 1, startX: 1080, startY: 0 };
  let expandOptionArray : ExpandOption[] = [ mainScreenOption, otherScreenOption ];
  screen.makeExpand(expandOptionArray).then((
    data: number) => {
    console.info('Succeeded in expanding the screen. Data: ' + JSON.stringify(data));
  }).catch((err: BusinessError) => {
    console.error('Failed to expand the screen. Code:' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to expand the screen. Code: ' + JSON.stringify(exception));
};

screen.stopExpand¹⁰⁺

stopExpand(expandScreen:Array<number>, callback: AsyncCallback<void>): void

停止屏幕的扩展模式，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

参数名	类型	必填	说明
expandScreen	Array<number>	是	扩展屏幕id集合，其中id应为整数。
callback	AsyncCallback<void>	是	回调函数。当停止屏幕扩展模式成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400001	Invalid display or screen.

示例：

import { BusinessError } from '@ohos.base';

try {
  let expandScreenIds: Array<number> = [1, 2, 3];
  screen.stopExpand(expandScreenIds, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to stop expand screens. Code:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in stopping expand screens.');
  });
} catch (exception) {
  console.error('Failed to stop expand screens. Code: ' + JSON.stringify(exception));
};

screen.stopExpand¹⁰⁺

stopExpand(expandScreen:Array<number>): Promise<void>

停止屏幕的扩展模式，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

参数名	类型	必填	说明
expandScreen	Array<number>	是	扩展屏幕id集合，其中id应为整数。

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400001	Invalid display or screen.

示例：

import { BusinessError } from '@ohos.base';

try {
  let expandScreenIds: Array<number> = [1, 2, 3];
  screen.stopExpand(expandScreenIds).then(() => {
    console.info('Succeeded in stopping expand screens.');
  }).catch((err: BusinessError) => {
    console.error('Failed to stop expand screens. Code:' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to stop expand screens. Code:' + JSON.stringify(exception));
};

screen.makeMirror

makeMirror(mainScreen:number, mirrorScreen:Array<number>, callback: AsyncCallback<number>): void

将屏幕设置为镜像模式，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

参数名	类型	必填	说明
mainScreen	number	是	主屏幕id，该参数仅支持整数输入。
mirrorScreen	Array<number>	是	镜像屏幕id集合，其中id应为整数。
callback	AsyncCallback<number>	是	回调函数。返回镜像屏幕的群组id，其中id应为整数。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400001	Invalid display or screen.

示例：

import { BusinessError } from '@ohos.base';

let mainScreenId: number = 0;
let mirrorScreenIds: Array<number> = [1, 2, 3];
try {
  screen.makeMirror(mainScreenId, mirrorScreenIds, (err: BusinessError, data: number) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set screen mirroring. Code: ' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting screen mirroring. Data: ' + JSON.stringify(data));
  });
} catch (exception) {
  console.error('Failed to set screen mirroring. Code: ' + JSON.stringify(exception));
};

screen.makeMirror

makeMirror(mainScreen:number, mirrorScreen:Array<number>): Promise<number>

将屏幕设置为镜像模式，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

参数名	类型	必填	说明
mainScreen	number	是	主屏幕id，该参数仅支持整数输入。
mirrorScreen	Array<number>	是	镜像屏幕id集合。其中id应为整数。

返回值：

类型	说明
Promise<number>	Promise对象。返回镜像屏幕的群组id，其中id应为整数。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400001	Invalid display or screen.

示例：

import { BusinessError } from '@ohos.base';

let mainScreenId: number = 0;
let mirrorScreenIds: Array<number> = [1, 2, 3];
try {
  screen.makeMirror(mainScreenId, mirrorScreenIds).then((data: number) => {
    console.info('Succeeded in setting screen mirroring. Data: ' + JSON.stringify(data));
  }).catch((err: BusinessError) => {
    console.error('Failed to set screen mirroring. Code: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set screen mirroring. Code: ' + JSON.stringify(exception));
};

screen.stopMirror¹⁰⁺

stopMirror(mirrorScreen:Array<number>, callback: AsyncCallback<void>): void

停止屏幕的镜像模式，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

参数名	类型	必填	说明
mirrorScreen	Array<number>	是	镜像屏幕id集合，其中id应为整数。
callback	AsyncCallback<void>	是	回调函数。当停止屏幕镜像模式成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400001	Invalid display or screen.

示例：

import { BusinessError } from '@ohos.base';

try {
  let mirrorScreenIds: Array<number> = [1, 2, 3];
  screen.stopMirror(mirrorScreenIds, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to stop mirror screens. Code:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in stopping mirror screens.');
  });
} catch (exception) {
  console.error('Failed to stop mirror screens. Code: ' + JSON.stringify(exception));
};

screen.stopMirror¹⁰⁺

stopMirror(mirrorScreen:Array<number>): Promise<void>

停止屏幕的镜像模式，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

参数名	类型	必填	说明
mirrorScreen	Array<number>	是	镜像屏幕id集合，其中id应为整数。

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400001	Invalid display or screen.

示例：

import { BusinessError } from '@ohos.base';

try {
  let mirrorScreenIds: Array<number> = [1, 2, 3];
  screen.stopMirror(mirrorScreenIds).then(() => {
    console.info('Succeeded in stopping mirror screens.');
  }).catch((err: BusinessError) => {
    console.error('Failed to stop mirror screens. Code:' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to stop mirror screens. Code:' + JSON.stringify(exception));
};

screen.createVirtualScreen

createVirtualScreen(options:VirtualScreenOption, callback: AsyncCallback<Screen>): void

创建虚拟屏幕，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

需要权限：ohos.permission.CAPTURE_SCREEN，如果VirtualScreenOption.surfaceId有效，此权限是必需的。仅系统应用可用。

参数：

参数名	类型	必填	说明
options	VirtualScreenOption	是	用于创建虚拟屏幕的参数。
callback	AsyncCallback<Screen>	是	回调函数，返回创建的虚拟屏幕对象。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400001	Invalid display or screen.

示例：

import { BusinessError } from '@ohos.base';

let screenClass: screen.Screen|null = null;
try {
  class VirtualScreenOption {
    name : string = '';
    width : number =  0;
    height : number = 0;
    density : number = 0;
    surfaceId : string = '';
  }

  let option : VirtualScreenOption = { 
    name: 'screen01',
    width: 1080,
    height: 2340,
    density: 2,
    surfaceId: ''
  };
  screen.createVirtualScreen(option, (err: BusinessError, data: screen.Screen) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to create the virtual screen. Code: ' + JSON.stringify(err));
      return;
    }
    screenClass = data;
    console.info('Succeeded in creating the virtual screen. Data: ' + JSON.stringify(data));
  });
} catch (exception) {
  console.error('Failed to create the virtual screen. Code: ' + JSON.stringify(exception));
};

screen.createVirtualScreen

createVirtualScreen(options:VirtualScreenOption): Promise<Screen>

创建虚拟屏幕，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

需要权限：ohos.permission.CAPTURE_SCREEN，如果VirtualScreenOption.surfaceId有效，此权限是必需的。仅系统应用可用。

参数：

参数名	类型	必填	说明
options	VirtualScreenOption	是	用于创建虚拟屏幕的参数。

返回值：

类型	说明
Promise<Screen>	Promise对象。返回创建的虚拟屏幕对象。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400001	Invalid display or screen.

示例：

import { BusinessError } from '@ohos.base';

let screenClass: screen.Screen|null = null;
try {
  class VirtualScreenOption {
    name : string = '';
    width : number =  0;
    height : number = 0;
    density : number = 0;
    surfaceId : string = '';
  }

  let option : VirtualScreenOption = { 
    name: 'screen01',
    width: 1080,
    height: 2340,
    density: 2,
    surfaceId: ''
  };

  screen.createVirtualScreen(option).then((data: screen.Screen) => {
    screenClass = data;
    console.info('Succeeded in creating the virtual screen. Data: ' + JSON.stringify(data));
  }).catch((err: BusinessError) => {
    console.error('Failed to create the virtual screen. Code: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to create the virtual screen. Code: ' + JSON.stringify(exception));
};

screen.destroyVirtualScreen

destroyVirtualScreen(screenId:number, callback: AsyncCallback<void>): void

销毁虚拟屏幕，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

参数名	类型	必填	说明
screenId	number	是	屏幕的id，该参数仅支持整数输入。
callback	AsyncCallback<void>	是	回调函数。当销毁虚拟屏幕成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400002	Unauthorized operation.

示例：

import { BusinessError } from '@ohos.base';

let screenId: number = 1;
try {
  screen.destroyVirtualScreen(screenId, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to destroy the virtual screen. Code: ' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in destroying the virtual screen.');
  });
} catch (exception) {
  console.error('Failed to destroy the virtual screen. Code: ' + JSON.stringify(exception));
};

screen.destroyVirtualScreen

destroyVirtualScreen(screenId:number): Promise<void>

销毁虚拟屏幕，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

参数名	类型	必填	说明
screenId	number	是	屏幕的id，该参数仅支持整数输入。

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400002	Unauthorized operation.

示例：

import { BusinessError } from '@ohos.base';

let screenId: number = 1;
try {
  screen.destroyVirtualScreen(screenId).then(() => {
    console.info('Succeeded in destroying the virtual screen.');
  }).catch((err: BusinessError) => {
    console.error('Failed to destroy the virtual screen. Code: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to destroy the virtual screen. Code: ' + JSON.stringify(exception));
};

screen.setVirtualScreenSurface

setVirtualScreenSurface(screenId:number, surfaceId: string, callback: AsyncCallback<void>): void

设置虚拟屏幕的surface，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

需要权限：ohos.permission.CAPTURE_SCREEN，仅系统应用可用。

参数：

参数名	类型	必填	说明
screenId	number	是	屏幕的id，该参数仅支持整数输入。
surfaceId	string	是	surface的id。
callback	AsyncCallback<void>	是	回调函数。当设置虚拟屏幕surface成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400001	Invalid display or screen.

示例：

import { BusinessError } from '@ohos.base';

let screenId: number = 1;
let surfaceId: string = '2048';
try {
  screen.setVirtualScreenSurface(screenId, surfaceId, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the surface for the virtual screen. Code: ' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the surface for the virtual screen.');
  });
} catch (exception) {
  console.error('Failed to set the surface for the virtual screen. Code: ' + JSON.stringify(exception));
};

screen.setVirtualScreenSurface

setVirtualScreenSurface(screenId:number, surfaceId: string): Promise<void>

设置虚拟屏幕的surface，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

需要权限：ohos.permission.CAPTURE_SCREEN，仅系统应用可用。

参数：

参数名	类型	必填	说明
screenId	number	是	屏幕的id，该参数仅支持整数输入。
surfaceId	string	是	surface的id。

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400001	Invalid display or screen.

示例：

import { BusinessError } from '@ohos.base';

let screenId: number = 1;
let surfaceId: string = '2048';
try {
  screen.setVirtualScreenSurface(screenId, surfaceId).then(() => {
    console.info('Succeeded in setting the surface for the virtual screen.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the surface for the virtual screen. Code: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the surface for the virtual screen. Code: ' + JSON.stringify(exception));
};

screen.isScreenRotationLocked

isScreenRotationLocked(): Promise<boolean>

查询当前自动转屏是否锁定，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示当前自动转屏处于锁定状态；返回false表示当前自动转屏不处于锁定状态。

示例：

import { BusinessError } from '@ohos.base';

screen.isScreenRotationLocked().then((isLocked: boolean) => {
  console.info('Succeeded in getting the screen rotation lock status. isLocked:' + JSON.stringify(isLocked));
}).catch((err: BusinessError) => {
  console.error('Failed to get the screen rotation lock status. Cause:' + JSON.stringify(err));
});

screen.isScreenRotationLocked

isScreenRotationLocked(callback: AsyncCallback<boolean>): void

查询当前自动转屏是否锁定，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

参数名	类型	必填	说明
callback	AsyncCallback<boolean>	是	回调函数。返回true表示当前自动转屏处于锁定状态；返回false表示当前自动转屏不处于锁定状态。

示例：

import { BusinessError } from '@ohos.base';

screen.isScreenRotationLocked((err: BusinessError, isLocked: boolean) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to get the screen rotation lock status. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in getting the screen rotation lock status. isLocked:' + JSON.stringify(isLocked));
});

screen.setScreenRotationLocked

setScreenRotationLocked(isLocked: boolean): Promise<void>

设置自动转屏开关是否锁定，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

参数名	类型	必填	说明
isLocked	boolean	是	自动转屏开关是否锁定。true为锁定，false为未锁定.

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

let isLocked: boolean = false;
try {
  screen.setScreenRotationLocked(isLocked).then(() => {
    console.info('Succeeded in unlocking auto rotate');
  }).catch((err: BusinessError) => {
    console.error('Failed to unlock auto rotate. Code: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to unlock auto rotate. Code: ' + JSON.stringify(exception));
};

screen.setScreenRotationLocked

setScreenRotationLocked(isLocked: boolean, callback: AsyncCallback<void>): void

设置自动转屏开关是否锁定，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

参数名	类型	必填	说明
isLocked	boolean	是	自动转屏开关是否锁定。true为锁定，false为未锁定.
callback	AsyncCallback<void>	是	回调函数。当设置自动转屏是否锁定成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

let isLocked: boolean = false;
try {
  screen.setScreenRotationLocked(isLocked, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to unlock auto rotate. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in unlocking auto rotate.');
  });
} catch (exception) {
  console.error('Failed to unlock auto rotate. Code: ' + JSON.stringify(exception));
};

ExpandOption

扩展屏幕的参数。

系统能力： SystemCapability.WindowManager.WindowManager.Core

名称	类型	可读	可写	说明
screenId	number	是	是	屏幕的id，该参数应为整数。
startX	number	是	是	屏幕的起始X轴坐标，该参数应为整数。
startY	number	是	是	屏幕的起始Y轴坐标，该参数应为整数。

VirtualScreenOption

创建虚拟屏幕的参数。

系统能力： SystemCapability.WindowManager.WindowManager.Core

名称	类型	可读	可写	说明
name	string	是	是	指定虚拟屏幕的名称。
width	number	是	是	指定虚拟屏幕的宽度，单位为像素，该参数应为整数。
height	number	是	是	指定虚拟屏幕的高度，单位为像素，该参数应为整数。
density	number	是	是	指定虚拟屏幕的密度，该参数为浮点数。
surfaceId	string	是	是	指定虚拟屏幕的surfaceId。

Screen

屏幕实例。

下列API示例中都需先使用getAllScreens()、createVirtualScreen()中的任一方法获取到Screen实例，再通过此实例调用对应方法。

属性

系统能力： SystemCapability.WindowManager.WindowManager.Core

名称	类型	可读	可写	说明
id	number	是	否	屏幕的id，该参数应为整数。
parent	number	是	否	屏幕所属群组的id，该参数应为整数。
supportedModeInfo	Array<ScreenModeInfo>	是	否	屏幕支持的模式集合。
activeModeIndex	number	是	否	当前屏幕所处模式索引。模式索引的当前值和值的范围，会根据屏幕当前分辨率、刷新率和设备硬件差异产生变化。该参数应为整数。
orientation	Orientation	是	否	屏幕方向。
sourceMode¹⁰⁺	ScreenSourceMode	是	否	屏幕来源模式。

setOrientation

setOrientation(orientation: Orientation, callback: AsyncCallback<void>): void

设置屏幕方向，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数名	类型	必填	说明
orientation	Orientation	是	屏幕方向。
callback	AsyncCallback<void>	是	回调函数。当设置屏幕方向成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400003	This display manager service works abnormally.

示例：

import { BusinessError } from '@ohos.base';

  try {
    class VirtualScreenOption {
      name : string = '';
      width : number =  0;
      height : number = 0;
      density : number = 0;
      surfaceId : string = '';
    }

    let option : VirtualScreenOption = {
      name: 'screen01',
      width: 1080,
      height: 2340,
      density: 2,
      surfaceId: ''
    };

    screen.createVirtualScreen(option).then((data: screen.Screen) => {
      let screenClass: screen.Screen = data;
      console.info('Succeeded in creating the virtual screen. Data: ' + JSON.stringify(data));
      screenClass.setOrientation(screen.Orientation.VERTICAL, (err: BusinessError) => {
        const errCode: number = err.code;
        if (errCode) {
          console.error('Failed to set the vertical orientation. Code: ' + JSON.stringify(err));
          return;
        }
        console.info('Succeeded in setting the vertical orientation.');
      });
    }).catch((err: BusinessError) => {
      console.error('Failed to create the virtual screen. Code: ' + JSON.stringify(err));
    });
  } catch (exception) {
    console.error('Failed to set the vertical orientation. Code: ' + JSON.stringify(exception));
  };

setOrientation

setOrientation(orientation: Orientation): Promise<void>

设置屏幕方向，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数名	类型	必填	说明
orientation	Orientation	是	屏幕方向。

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400003	This display manager service works abnormally.

示例：

import { BusinessError } from '@ohos.base';

  try {
    class VirtualScreenOption {
      name : string = '';
      width : number =  0;
      height : number = 0;
      density : number = 0;
      surfaceId : string = '';
    }

    let option : VirtualScreenOption = {
      name: 'screen01',
      width: 1080,
      height: 2340,
      density: 2,
      surfaceId: ''
    };

    screen.createVirtualScreen(option).then((data: screen.Screen) => {
      let screenClass: screen.Screen = data;
      console.info('Succeeded in creating the virtual screen. Data: ' + JSON.stringify(data));
      let promise: Promise<void> = screenClass.setOrientation(screen.Orientation.VERTICAL);
      promise.then(() => {
        console.info('Succeeded in setting the vertical orientation.');
      }).catch((err: BusinessError) => {
        console.error('Failed to set the vertical orientation. Cause: ' + JSON.stringify(err));
      });
    }).catch((err: BusinessError) => {
      console.error('Failed to create the virtual screen. Code: ' + JSON.stringify(err));
    });
  } catch (exception) {
    console.error('Failed to set the vertical orientation. Code: ' + JSON.stringify(exception));
  };

setScreenActiveMode

setScreenActiveMode(modeIndex: number, callback: AsyncCallback<void>): void

设置屏幕当前显示模式，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数名	类型	必填	说明
modeIndex	number	是	模式索引。模式索引的当前值和值的范围，会根据屏幕当前分辨率、刷新率和设备硬件差异产生变化，该参数仅支持整数输入。
callback	AsyncCallback<void>	是	回调函数。当设置屏幕当前显示模式成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400003	This display manager service works abnormally.

示例：

import { BusinessError } from '@ohos.base';

try {
  class VirtualScreenOption {
    name : string = '';
    width : number =  0;
    height : number = 0;
    density : number = 0;
    surfaceId : string = '';
  }

  let option : VirtualScreenOption = {
    name: 'screen01',
    width: 1080,
    height: 2340,
    density: 2,
    surfaceId: ''
  };

  screen.createVirtualScreen(option).then((data: screen.Screen) => {
    let screenClass: screen.Screen = data;
    console.info('Succeeded in creating the virtual screen. Data: ' + JSON.stringify(data));
    let modeIndex: number = 0;
    screenClass.setScreenActiveMode(modeIndex, (err: BusinessError) => {
      const errCode: number = err.code;
      if (errCode) {
        console.error('Failed to set screen active mode 0. Code: ' + JSON.stringify(err));
        return;
      }
      console.info('Succeeded in setting the vertical orientation.');
    });
  }).catch((err: BusinessError) => {
    console.error('Failed to create the virtual screen. Code: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the vertical orientation. Code: ' + JSON.stringify(exception));
};

setScreenActiveMode

setScreenActiveMode(modeIndex: number): Promise<void>

设置屏幕当前显示模式，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数名	类型	必填	说明
modeIndex	number	是	模式索引。模式索引的当前值和值的范围，会根据屏幕当前分辨率、刷新率和设备硬件差异产生变化，该参数仅支持整数输入。

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400003	This display manager service works abnormally.

示例：

import { BusinessError } from '@ohos.base';

try {
  class VirtualScreenOption {
    name : string = '';
    width : number =  0;
    height : number = 0;
    density : number = 0;
    surfaceId : string = '';
  }

  let option : VirtualScreenOption = {
    name: 'screen01',
    width: 1080,
    height: 2340,
    density: 2,
    surfaceId: ''
  };

  screen.createVirtualScreen(option).then((data: screen.Screen) => {
    let screenClass: screen.Screen = data;
    console.info('Succeeded in creating the virtual screen. Data: ' + JSON.stringify(data));
    let modeIndex: number = 0;
    let promise: Promise<void> = screenClass.setScreenActiveMode(modeIndex);
    promise.then(() => {
      console.info('Succeeded in setting screen active mode 0.');
    }).catch((err: BusinessError) => {
      console.error('Failed to set screen active mode 0. Code: ' + JSON.stringify(err));
    });
  }).catch((err: BusinessError) => {
    console.error('Failed to create the virtual screen. Code: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the vertical orientation. Code: ' + JSON.stringify(exception));
};

setDensityDpi

setDensityDpi(densityDpi: number, callback: AsyncCallback<void>): void;

设置屏幕的像素密度，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数名	类型	必填	说明
densityDpi	number	是	像素密度。支持的输入范围为[80, 640]，该参数仅支持整数输入。
callback	AsyncCallback<void>	是	回调函数。当设置屏幕的像素密度成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400003	This display manager service works abnormally.

示例：

import { BusinessError } from '@ohos.base';

let densityDpi: number = 320;
try {
  class VirtualScreenOption {
    name : string = '';
    width : number =  0;
    height : number = 0;
    density : number = 0;
    surfaceId : string = '';
  }

  let option : VirtualScreenOption = {
    name: 'screen01',
    width: 1080,
    height: 2340,
    density: 2,
    surfaceId: ''
  };

  screen.createVirtualScreen(option).then((data: screen.Screen) => {
    let screenClass: screen.Screen = data;
    console.info('Succeeded in creating the virtual screen. Data: ' + JSON.stringify(data));
    screenClass.setDensityDpi(densityDpi, (err: BusinessError) => {
      const errCode: number = err.code;
      if (errCode) {
        console.error('Failed to set the pixel density of the screen to 320. Code: ' + JSON.stringify(err));
        return;
      }
      console.info('Succeeded in setting the vertical orientation.');
    });
  }).catch((err: BusinessError) => {
    console.error('Failed to create the virtual screen. Code: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the vertical orientation. Code: ' + JSON.stringify(exception));
};

setDensityDpi

setDensityDpi(densityDpi: number): Promise<void>

设置屏幕的像素密度，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数名	类型	必填	说明
densityDpi	number	是	像素密度。支持的输入范围为[80, 640]，该参数仅支持整数输入。

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见屏幕错误码。

错误码ID	错误信息
1400003	This display manager service works abnormally.

示例：

import { BusinessError } from '@ohos.base';

let densityDpi: number = 320;
try {
  class VirtualScreenOption {
    name : string = '';
    width : number =  0;
    height : number = 0;
    density : number = 0;
    surfaceId : string = '';
  }

  let option : VirtualScreenOption = {
    name: 'screen01',
    width: 1080,
    height: 2340,
    density: 2,
    surfaceId: ''
  };

  screen.createVirtualScreen(option).then((data: screen.Screen) => {
    let screenClass: screen.Screen = data;
    let promise: Promise<void> = screenClass.setDensityDpi(densityDpi);
    promise.then(() => {
      console.info('Succeeded in setting the pixel density of the screen to 320.');
    }).catch((err: BusinessError) => {
      console.error('Failed to set the pixel density of the screen to 320. Code: ' + JSON.stringify(err));
    });
  }).catch((err: BusinessError) => {
    console.error('Failed to create the virtual screen. Code: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the vertical orientation. Code: ' + JSON.stringify(exception));
};

Orientation

屏幕方向枚举。

系统能力： SystemCapability.WindowManager.WindowManager.Core

名称	值	说明
UNSPECIFIED	0	表示未指定屏幕方向，由系统指定。
VERTICAL	1	表示指定屏幕为垂直方向。
HORIZONTAL	2	表示指定屏幕为水平方向。
REVERSE_VERTICAL	3	表示指定屏幕为反向垂直方向。
REVERSE_HORIZONTAL	4	表示指定屏幕为反向水平方向。

ScreenSourceMode¹⁰⁺

屏幕显示内容来源模式枚举。

系统能力： SystemCapability.WindowManager.WindowManager.Core

名称	值	说明
SCREEN_MAIN	0	表示屏幕为默认主屏。
SCREEN_MIRROR	1	表示屏幕内容来自镜像。
SCREEN_EXTEND	2	表示屏幕内容来自扩展。
SCREEN_ALONE	3	表示屏幕为未指定来源。

ScreenModeInfo

屏幕显示模式信息。

系统能力： SystemCapability.WindowManager.WindowManager.Core

名称	类型	可读	可写	说明
id	number	是	是	模式id，所支持的模式由具体设备分辨率和刷新率决定，该参数应为整数。
width	number	是	是	屏幕的宽度，单位为像素，该参数应为整数。
height	number	是	是	屏幕的高度，单位为像素，该参数应为整数。
refreshRate	number	是	是	屏幕的刷新率，该参数应为整数，该参数应为整数。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述（仅对系统应用开放）

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

0 赞

所属分类： 后端技术
本文标签： 软件鸿蒙
版权声明： 原创文章如转载，请注明本文链接: https://m.seaxiang.com/blog/f411a0cb6fdd4a82ae9331c00d4876a2

harmony 鸿蒙@ohos.screen (屏幕)

@ohos.screen (屏幕)

导入模块

screen.getAllScreens

screen.getAllScreens

screen.on(‘connect’|‘disconnect’|‘change’)

screen.off(‘connect’|‘disconnect’|‘change’)

screen.makeExpand

screen.makeExpand

screen.stopExpand10+

screen.stopExpand10+

screen.makeMirror

screen.makeMirror

screen.stopMirror10+

screen.stopMirror10+

screen.createVirtualScreen

screen.createVirtualScreen

screen.destroyVirtualScreen

screen.destroyVirtualScreen

screen.setVirtualScreenSurface

screen.setVirtualScreenSurface

screen.isScreenRotationLocked

screen.isScreenRotationLocked

screen.setScreenRotationLocked

screen.setScreenRotationLocked

ExpandOption

VirtualScreenOption

Screen

属性

setOrientation

setOrientation

setScreenActiveMode

setScreenActiveMode

setDensityDpi

setDensityDpi

Orientation

ScreenSourceMode10+

ScreenModeInfo

你可能感兴趣的鸿蒙文章

热门推荐

标签云

最新文章

本文目录

screen.stopExpand¹⁰⁺

screen.stopExpand¹⁰⁺

screen.stopMirror¹⁰⁺

screen.stopMirror¹⁰⁺

ScreenSourceMode¹⁰⁺