@ohos.display (屏幕属性)(系统接口)

屏幕属性提供管理显示设备的一些基础能力，包括获取默认显示设备的信息，获取所有显示设备的信息以及监听显示设备的插拔行为。

说明：

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

• 当前页面仅包含本模块的系统接口，其他公开接口参见@ohos.display (屏幕属性)。

导入模块

import { display } from '@kit.ArkUI';

display.hasPrivateWindow⁹⁺

hasPrivateWindow(displayId: number): boolean

查询指定display对象上是否有可见的隐私窗口。可通过setWindowPrivacyMode()接口设置隐私窗口。隐私窗口内容将无法被截屏或录屏。

系统接口： 此接口为系统接口。

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

参数：

返回值：

错误码：

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

示例：

import { display } from '@kit.ArkUI';

let displayClass: display.Display|null = null;
try {
  displayClass = display.getDefaultDisplaySync();

  let ret: boolean = true;
  try {
    ret = display.hasPrivateWindow(displayClass.id);
  } catch (exception) {
    console.error('Failed to check has privateWindow or not. Code: ' + JSON.stringify(exception));
  }
  if (ret == undefined) {
    console.log("Failed to check has privateWindow or not.");
  }
  if (ret) {
    console.log("There has privateWindow.");
  } else if (!ret) {
    console.log("There has no privateWindow.");
  }
} catch (exception) {
  console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(exception));
}

display.on(‘privateModeChange’)¹⁰⁺

on(type: ‘privateModeChange’, callback: Callback<boolean>): void

开启屏幕隐私模式变化的监听。当屏幕前台有隐私窗口，则屏幕处于隐私模式，屏幕中的隐私窗口内容无法被截屏或录屏。

系统接口： 此接口为系统接口。

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

参数：

错误码：

以下错误码的详细介绍请参见通用错误码。

示例：

import { Callback } from '@kit.BasicServicesKit';

let callback: Callback<boolean> = (data: boolean) => {
  console.info('Listening enabled. Data: ' + JSON.stringify(data));
};
try {
  display.on("privateModeChange", callback);
} catch (exception) {
  console.error('Failed to register callback. Code: ' + JSON.stringify(exception));
}

display.off(‘privateModeChange’)¹⁰⁺

off(type: ‘privateModeChange’, callback?: Callback<boolean>): void

关闭屏幕隐私模式变化的监听。当屏幕前台有隐私窗口，则屏幕处于隐私模式，屏幕中的隐私窗口内容无法被截屏或录屏。

系统接口： 此接口为系统接口。

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

参数：

错误码：

以下错误码的详细介绍请参见通用错误码。

示例：

try {
  display.off("privateModeChange");
} catch (exception) {
  console.error('Failed to unregister callback. Code: ' + JSON.stringify(exception));
}

display.setFoldDisplayMode¹⁰⁺

setFoldDisplayMode(mode: FoldDisplayMode): void

更改可折叠设备的显示模式，不适用于2in1设备。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Window.SessionManager

参数：

错误码：

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

示例：

import { display } from '@kit.ArkUI';

try {
  let mode: display.FoldDisplayMode = display.FoldDisplayMode.FOLD_DISPLAY_MODE_FULL;
  display.setFoldDisplayMode(mode);
} catch (exception) {
  console.error('Failed to change the fold display mode. Code: ' + JSON.stringify(exception));
}

display.setFoldDisplayMode¹⁹⁺

setFoldDisplayMode(mode: FoldDisplayMode, reason: string): void

更改可折叠设备的显示模式，并指明更改原因，不适用于2in1设备。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Window.SessionManager

参数：

错误码：

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

示例：

import { display } from '@kit.ArkUI';

try {
  let mode: display.FoldDisplayMode = display.FoldDisplayMode.FOLD_DISPLAY_MODE_MAIN;
  display.setFoldDisplayMode(mode, 'backSelfie');
} catch (exception) {
  console.error(`Failed to change the fold display mode. Code: ${exception}`);
}

display.setFoldStatusLocked¹¹⁺

setFoldStatusLocked(locked: boolean): void

设置可折叠设备当前折叠状态的锁定状态。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Window.SessionManager

参数：

错误码：

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

示例：

import { display } from '@kit.ArkUI';

try {
  let locked: boolean = false;
  display.setFoldStatusLocked(locked);
} catch (exception) {
  console.error('Failed to change the fold status locked mode. Code: ' + JSON.stringify(exception));
}

display.addVirtualScreenBlocklist¹⁸⁺

addVirtualScreenBlocklist(windowIds: Array<number>): Promise<void>

将窗口添加到禁止投屏显示的名单中，被添加的窗口无法在投屏时显示。仅对应用主窗或系统窗口生效。使用Promise异步回调。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Window.SessionManager

参数：

返回值：

错误码：

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { display, window } from '@kit.ArkUI';

export default class EntryAbility extends UIAbility {
  // ...
  onWindowStageCreate(windowStage: window.WindowStage) {
    // ...
    let windowId = windowStage.getMainWindowSync().getWindowProperties().id;
    let windowIds = [windowId];

    let promise = display.addVirtualScreenBlocklist(windowIds);
    promise.then(() => {
      console.info('Succeeded in adding virtual screen blocklist.');
    }).catch((err: BusinessError) => {
      console.error('Failed to add virtual screen blocklist. Code: ' + JSON.stringify(err));
    })
  }
}

display.removeVirtualScreenBlocklist¹⁸⁺

removeVirtualScreenBlocklist(windowIds: Array<number>): Promise<void>

将窗口从禁止投屏显示的名单中移除，被移除的窗口可以在投屏时显示。仅对应用主窗或系统窗口生效。使用Promise异步回调。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Window.SessionManager

参数：

返回值：

错误码：

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { display, window } from '@kit.ArkUI';

export default class EntryAbility extends UIAbility {
  // ...
  onWindowStageCreate(windowStage: window.WindowStage) {
    // ...
    let windowId = windowStage.getMainWindowSync().getWindowProperties().id;
    let windowIds = [windowId];

    let promise = display.addVirtualScreenBlocklist(windowIds);
    promise.then(() => {
      console.info('Succeeded in adding virtual screen blocklist.');
    }).catch((err: BusinessError) => {
      console.error('Failed to add virtual screen blocklist. Code: ' + JSON.stringify(err));
    })

    promise = display.removeVirtualScreenBlocklist(windowIds);
    promise.then(() => {
      console.info('Succeeded in removing virtual screen blocklist.');
    }).catch((err: BusinessError) => {
      console.error('Failed to remove virtual screen blocklist. Code: ' + JSON.stringify(err));
    })
  }
}

Display

屏幕实例。描述display对象的属性和方法。

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

hasImmersiveWindow¹¹⁺

hasImmersiveWindow(callback: AsyncCallback&lt;boolean&gt;): void

判断当前屏幕是否包含沉浸式窗口，使用callback异步回调。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Window.SessionManager

参数：

错误码：

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { display } from '@kit.ArkUI';

let displayClass: display.Display|null = null;
displayClass = display.getDefaultDisplaySync();
displayClass.hasImmersiveWindow((err: BusinessError, data) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to check whether there is immersive window. Code: ' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in checking whether there is immersive window. data: ' + JSON.stringify(data));
});

hasImmersiveWindow¹¹⁺

hasImmersiveWindow(): Promise&lt;boolean&gt;

判断当前屏幕是否包含沉浸式窗口，使用Promise异步回调。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Window.SessionManager

返回值：

错误码：

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { display } from '@kit.ArkUI';

let displayClass: display.Display|null = null;
displayClass = display.getDefaultDisplaySync();
let promise = displayClass.hasImmersiveWindow();
promise.then((data) => {
  console.info('Succeeded in checking whether there is immersive window. data: ' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error('Failed to check whether there is immersive window. Code: ' + JSON.stringify(err));
})

你可能感兴趣的鸿蒙文章

harmony 鸿蒙ArkUI（方舟UI框架）

harmony 鸿蒙ARKUI_TextPickerCascadeRangeContent

harmony 鸿蒙ARKUI_TextPickerRangeContent

harmony 鸿蒙ArkUI_AnimateCompleteCallback

harmony 鸿蒙ArkUI_AttributeItem

harmony 鸿蒙ArkUI_ColorStop

harmony 鸿蒙ArkUI_ContextCallback

harmony 鸿蒙ArkUI_EventModule

harmony 鸿蒙ArkUI_ExpectedFrameRateRange

harmony 鸿蒙ArkUI_IntOffset