屏幕

本模塊提供管理屏幕的一些基礎能力，包括獲取屏幕對象，監聽屏幕變化，創建和銷毀虛擬屏幕等。

說明：
開發前請熟悉鴻蒙開發指導文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md] > 本模塊首批接口從API version 9開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。

本模塊接口為系統接口。

導入模塊

import screen from '@ohos.screen';

screen.getAllScreens

getAllScreens(callback: AsyncCallback>): void

獲取所有的屏幕，使用callback異步回調。

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

參數：

示例：

var screenClass = null;
screen.getAllScreens((err, data) = > {
    if (err.code) {
        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>

獲取所有的屏幕，使用Promise異步回調。

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

返回值：

示例：

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

screen.on('connect' | 'disconnect' | 'change')

on(eventType: 'connect' | 'disconnect' | 'change', callback: Callback): void

開啟屏幕狀態變化的監聽。

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

參數：

示例：

var callback = (data) = > {
    console.info('Register the callback for screen changes. Data: ' + JSON.stringify(data))
};
screen.on("connect", callback);

screen.off('connect' | 'disconnect' | 'change')

off(eventType: 'connect' | 'disconnect' | 'change', callback?: Callback): void

關閉屏幕狀態變化的監聽。

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

參數：

示例：

var callback = (data) = > {
    console.info('Unegister the callback for screen changes. Data: ' + JSON.stringify(data))
};
screen.off("connect", callback);

screen.makeExpand

makeExpand(options:Array, callback: AsyncCallback): void

將屏幕設置為擴展模式，使用callback異步回調。

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

參數：

示例：

var groupId = null;
screen.makeExpand([{screenId: 0, startX: 0, startY: 0}, {screenId: 1, startX: 1080, startY: 0}], (err, data) = > {
  if (err.code) {
    console.error('Failed to make screens as expand-screen. Cause:' + JSON.stringify(err));
    return;
  }
  groupId = data;
  console.info('Succeeded in making screens as expand-screen.Data:' + JSON.stringify(data));
});

screen.makeExpand

makeExpand(options:Array): Promise

將屏幕設置為擴展模式，使用Promise異步回調。

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

參數：

返回值：

示例：

screen.makeExpand([{screenId: 0, startX: 0, startY: 0}, {screenId: 1, startX: 1080, startY: 0}]).then((data) = > {
  console.info('Succeeded in making screens as expand-screen.Data:' + JSON.stringify(data));
}).catch((err) = > {
  console.error('Failed to make screens as expand-screen. Cause:' + JSON.stringify(err));
});

screen.makeMirror

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

將屏幕設置為鏡像模式，使用callback異步回調。

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

參數：

示例：

var mainScreenId = 0;
var mirrorScreenIds = [1, 2, 3];
screen.makeMirror(mainScreenId, mirrorScreenIds, (err, data) = > {
  if (err.code) {
    console.error('Failed to make screens as mirror-screen.Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in making screens as mirror-screen.Data:' + JSON.stringify(data));
});

screen.makeMirror

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

將屏幕設置為鏡像模式，使用Promise異步回調。

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

參數：

返回值：

示例：

var mainScreenId = 0;
var mirrorScreenIds = [1, 2, 3];
screen.makeMirror(mainScreenId, mirrorScreenIds).then((data) = > {
  console.info('Succeeded in making screens as mirror-screen.Data:' + JSON.stringify(data));
}).catch((err) = > {
  console.error('Failed to make screens as mirror-screen.Cause:' + JSON.stringify(err));
});

ExpandOption

擴展屏幕的參數。

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

Screen

屏幕實例。

下列API示例中都需先使用[getAllScreens()]方法獲取到Screen實例，再通過此實例調用對應方法。

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

setOrientation

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

設置屏幕方向，使用callback異步回調。

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

示例：

screenClass.setOrientation(screen.Orientation.VERTICAL, (err, data) = > {
    if (err.code) {
        console.error('Failed to setOrientation VERTICAL. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Succeeded in setting Orientation VERTICAL. data: ' + JSON.stringify(data));
})

setOrientation

setOrientation(orientation: Orientation): Promise

設置屏幕方向，使用Promise異步回調。

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

返回值：

示例：

let promise = screenClass.setOrientation(screen.Orientation.VERTICAL);
promise.then((data) = > {
    console.info('Succeeded in setting Orientation VERTICAL. Data: ' + JSON.stringify(data));
}).catch((err) = > {
    console.error('Failed to set Orientation VERTICAL. Cause: ' + JSON.stringify(err));
})

setScreenActiveMode

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

設置屏幕當前顯示模式，使用callback異步回調。

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

示例：

var modeIndex = 0;
screenClass.setScreenActiveMode(modeIndex, (err, data) = > {
    if (err.code) {
        console.error('Failed to set ScreenActiveMode 0. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Succeeded in setting ScreenActiveMode 0. data: ' + JSON.stringify(data));
})

setScreenActiveMode

setScreenActiveMode(modeIndex: number): Promise

設置屏幕當前顯示模式，使用Promise異步回調。

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

返回值：

示例：

var modeIndex = 0;
let promise = screenClass.setScreenActiveMode(modeIndex);
promise.then((data) = > {
    console.info('Succeeded in setting ScreenActiveMode 0. Data: ' + JSON.stringify(data));
}).catch((err) = > {
    console.error('Failed to set ScreenActiveMode 0. Cause: ' + JSON.stringify(err));
})

Orientation

屏幕方向枚舉。

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

ScreenModeInfo

屏幕顯示模式信息。

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

審核編輯 黃宇