管理中心
我的
您当前正在浏览新版开发者文档中心,目录分类和层级有所调整。点击左侧当前文档分类名称前的“☰”图标,可切换文档分类。 了解新版目录

窗口旋转实践案例

窗口旋转提供了丰富的旋转策略,可以支持应用在各种场景下适配方向。

开发者在开发应用时,要兼顾应用的旋转策略在多种设备类型上的体验,为了帮助开发者快速上手,针对如下几个典型场景提供适配示例。

旋转策略配置适配差异化设备

当前设备形态多种多样,包括直板机、折叠机、三折叠、阔折叠等多类设备。如果应用的旋转策略仅按照其中一类设备适配,可能导致在其他设备上的体验下降。为了消除新增设备类型带来的额外适配工作,所以需要采用与设备类型无关的方式来配置旋转策略。

开发者可根据自身业务梳理不同设备形态下对旋转的诉求,如果单一策略(如:FOLLOW_DESKTOP、AUTO_ROTATION_UNSPECIFIED)能满足需求,推荐使用单一策略。若单一策略不能满足,可参考断点机制,实现差异化适配。

比如,在三折叠设备上,期望折叠态时竖屏显示,M态时竖屏显示,G态时横屏显示;在平板设备上,期望横屏显示;在直板机设备上,期望竖屏显示;在此场景下,可采用WidthBreakpoint断点机制实现差异化适配。

示例代码如下:

收起
自动换行
深色代码主题
复制
  1. import { window } from '@kit.ArkUI';
  2. import { common } from '@kit.AbilityKit';
  3. import { Callback } from '@kit.BasicServicesKit';
  4. import { display } from '@kit.ArkUI';
  5. @Entry
  6. @Component
  7. struct Index {
  8. @State currentOrientation: string = 'UNSPECIFIED';
  9. private stage: window.WindowStage = (this.getUIContext().getHostContext() as common.UIAbilityContext).windowStage;
  10. private foldDisplayModeCallback: Callback<display.FoldDisplayMode> = (data: display.FoldDisplayMode) => {
  11. console.info(`Listening enabled. Data: ${data}`);
  12. this.getBreakPointAndSetOrientation();
  13. };
  14. aboutToAppear() {
  15. const ret = display.isFoldable();
  16. if (ret) {
  17. display.on('foldDisplayModeChange', this.foldDisplayModeCallback);
  18. } else {
  19. this.getBreakPointAndSetOrientation();
  20. }
  21. }
  22. aboutToDisappear() {
  23. display.off('foldDisplayModeChange', this.foldDisplayModeCallback);
  24. }
  25. private getBreakPointAndSetOrientation(): void {
  26. let displayInfo = display.getDefaultDisplaySync();
  27. let displayWidth = displayInfo.width;
  28. let displayHeight = displayInfo.height;
  29. let heightBp = displayHeight / displayWidth;
  30. if (displayWidth > displayHeight) {
  31. let temp = displayWidth;
  32. displayWidth = displayHeight;
  33. displayHeight = temp;
  34. }
  35. // 建议使用单一策略如"FOLLOW_DESKTOP"来应对设备的差异化,如单一策略无法满足需求,可参考断点机制,屏蔽设备差异
  36. // 此处是举的特殊示例,原则上支持横屏的应用,旋转策略应该是支持4个方向可旋转,此处是为了说明断点的使用方式,才举此例
  37. // 600为宽度断点枚举值其中的边界值, 0.8为高宽比断点枚举值其中的边界值
  38. if (displayWidth >= 600 && heightBp < 0.8) {
  39. this.stage.getMainWindowSync().setPreferredOrientation(window.Orientation.LANDSCAPE);
  40. this.currentOrientation = 'LANDSCAPE';
  41. } else {
  42. this.stage.getMainWindowSync().setPreferredOrientation(window.Orientation.PORTRAIT);
  43. this.currentOrientation = 'PORTRAIT';
  44. }
  45. }
  46. build() {
  47. RelativeContainer() {
  48. Text(this.currentOrientation)
  49. .fontWeight(600)
  50. .fontSize(30)
  51. .textAlign(TextAlign.Center)
  52. .position({ y: 300 })
  53. .width('100%')
  54. }
  55. .height('100%')
  56. .width('100%')
  57. }
  58. }

视频类应用横竖屏切换

视频类应用横竖屏切换是指在视频类应用中,播放界面的详情页采用竖屏方式显示,用户可通过全屏按钮将页面切换至横屏方式显示,从而提供更佳的观看体验。

开发者可通过以下两种方式实现视频播放界面的横竖屏切换:

实现屏幕方向和窗口的orientation的相互转换

目前存在屏幕orientation、屏幕rotation和窗口orientation概念,它们之间存在关联,但并不相同,可以参考display.Orientation与display.rotation的关系。

在多设备、多形态的场景下(例如折叠屏手机、平板、外接显示器),屏幕的rotation(物理角度)和屏幕的orientation(逻辑横竖状态)并不总是一一对应。

直板机屏幕角度、屏幕方向、窗口方向对应关系:

展开
屏幕角度 屏幕方向 窗口方向
0 PORTRAIT PORTRAIT
90 LANDSCAPE LANDSCAPE_INVERTED
180 PORTRAIT_INVERTED PORTRAIT_INVERTED
270 LANDSCAPE_INVERTED LANDSCAPE

三折叠全展开态屏幕角度、屏幕方向、窗口方向对应关系(在某些特性下,可能会与表中所述不一致,以实际表现为准):

展开
屏幕角度 屏幕方向 窗口方向
90 PORTRAIT PORTRAIT
180 LANDSCAPE LANDSCAPE_INVERTED
270 PORTRAIT_INVERTED PORTRAIT_INVERTED
0 LANDSCAPE_INVERTED LANDSCAPE

屏幕方向与窗口方向在横屏方向上的定义并不一致。比如在直板机上,窗口方向的横屏对应屏幕方向的反向横屏;窗口方向的反向横屏则对应屏幕方向的横屏。屏幕角度和屏幕方向也不总是一一对应。比如在三折叠全展开态上,屏幕角度为0时,屏幕方向并不是竖屏,而是反向横屏。如果开发者直接用display.rotation或display.orientation来判断窗口实际显示的方向,可能会出现应用显示方向错位的问题。因此,不能简单通过屏幕的orientation或rotation来判断窗口的orientation。

若开发者想准确知道当前窗口方向从而选择旋转策略(比如视频播放页面锁定当前方向),推荐获取到display.rotation或display.orientation后,再使用convertOrientationAndRotation()将屏幕方向转化为窗口方向,具体示例如下:

  1. 获取目标屏幕方向。调用getDefaultDisplaySync()获取目标屏幕的Display对象,再通过其display.orientation属性获取屏幕方向。

  2. 将屏幕方向转换为窗口方向。调用convertOrientationAndRotation()可以把屏幕方向display.orientation转换为窗口方向orientation。

  3. 将窗口方向转换为旋转策略。窗口方向还需要进一步转换为系统可识别的旋转策略窗口Orientation,才能传给setPreferredOrientation()。

  4. 调用setPreferredOrientation()接口设置旋转策略锁定显示方向。

收起
自动换行
深色代码主题
复制
  1. import { display, window } from '@kit.ArkUI';
  2. @Entry
  3. @Component
  4. struct SpecificSceneSetOrientationIndex {
  5. mainWindow: window.Window = AppStorage.get('mainWindow_SetOrientation') as window.Window;
  6. setOrientationByDisplay() {
  7. try {
  8. // 1.获取当前默认Display
  9. const disp = display.getDefaultDisplaySync();
  10. const displayOrientation = disp.orientation; // 当前屏幕方向(0/1/2/3)
  11. console.info('Current display orientation = ' + displayOrientation);
  12. // 2.将displayOrientation转换为windowOrientation
  13. let windowOrientation: number =
  14. this.mainWindow.convertOrientationAndRotation(
  15. window.RotationInfoType.DISPLAY_ORIENTATION,
  16. window.RotationInfoType.WINDOW_ORIENTATION,
  17. displayOrientation
  18. );
  19. // 3.根据windowOrientation映射到window.Orientation
  20. let orientation: window.Orientation = window.Orientation.UNSPECIFIED;
  21. switch (windowOrientation) {
  22. case 0:
  23. orientation = window.Orientation.PORTRAIT;
  24. break;
  25. case 1:
  26. orientation = window.Orientation.LANDSCAPE_INVERTED;
  27. break;
  28. case 2:
  29. orientation = window.Orientation.PORTRAIT_INVERTED;
  30. break;
  31. case 3:
  32. orientation = window.Orientation.LANDSCAPE;
  33. break;
  34. default:
  35. throw new Error('Invalid orientation value');
  36. }
  37. // 4.设置旋转策略锁定窗口方向
  38. this.mainWindow.setPreferredOrientation(orientation, (err) => {
  39. if (err && err.code) {
  40. console.error('setPreferredOrientation failed: ' + JSON.stringify(err));
  41. }
  42. });
  43. } catch (exception) {
  44. console.error('Exception in setOrientationByDisplay: ' + JSON.stringify(exception));
  45. }
  46. }
  47. build() {
  48. Column() {
  49. Text('Lock the display orientation')
  50. .fontSize(17)
  51. Button('Set orientation from display')
  52. .onClick(() => {
  53. console.info('Click: Set orientation from display');
  54. this.setOrientationByDisplay();
  55. })
  56. .margin({ top: 20 })
  57. }
  58. .justifyContent(FlexAlign.Center)
  59. .alignItems(HorizontalAlign.Center)
  60. .height('100%')
  61. .width('100%')
  62. }
  63. }