开始入门

安装

bun add @capgo/capacitor-screen-orientation
bunx cap sync

导入

import { ScreenOrientation } from '@capgo/capacitor-screen-orientation';

API 概述

orientation

获取当前屏幕方向

获取设备屏幕的当前方向

import { ScreenOrientation } from '@capgo/capacitor-screen-orientation';

const result = await ScreenOrientation.orientation();
console.log('Current orientation:', result.type);

lock

锁定屏幕方向到特定类型

锁定屏幕到指定方向 在 iOS 上，如果 bypassOrientationLock 为 true，则也会使用运动传感器开始跟踪物理设备方向

注意：UI 还会尊重用户的方向锁定设置。 运动跟踪允许您检测设备如何物理上被握持，即使 UI 没有旋转

import { ScreenOrientation } from '@capgo/capacitor-screen-orientation';

// Standard lock
await ScreenOrientation.lock({ orientation: 'landscape' });

// Lock with motion tracking on iOS
await ScreenOrientation.lock({
  orientation: 'portrait',
  bypassOrientationLock: true
});

unlock

解锁屏幕方向

允许屏幕根据设备位置自由旋转。 此外，停止任何基于运动的方向跟踪，如果它启用了。

import { ScreenOrientation } from '@capgo/capacitor-screen-orientation';

await ScreenOrientation.unlock();

startOrientationTracking

使用运动传感器开始跟踪设备方向。

当您想要独立于屏幕方向锁定跟踪设备物理方向时，这个方法很有用。 它使用 iOS 的 Core Motion 来检测方向变化。

import { ScreenOrientation } from '@capgo/capacitor-screen-orientation';

await ScreenOrientation.startOrientationTracking({
  bypassOrientationLock: true
});

// Listen for changes
ScreenOrientation.addListener('screenOrientationChange', (result) => {
  console.log('Orientation changed:', result.type);
});

stopOrientationTracking

停止使用运动传感器跟踪设备方向。

如果之前已经开始跟踪，停止运动传感器的方向跟踪。

import { ScreenOrientation } from '@capgo/capacitor-screen-orientation';

await ScreenOrientation.stopOrientationTracking();

isOrientationLocked

检查设备方向锁定是否当前启用。

这个方法将物理设备方向（来自运动传感器）与 UI 方向进行比较。 如果它们不同，方向锁定是启用的。

注意：此功能需要通过startOrientationTracking()或lock()（bypassOrientationLock：true）激活运动跟踪。 适用于iOS（Core Motion）和Android（Accelerometer）。

import { ScreenOrientation } from '@capgo/capacitor-screen-orientation';

// Start motion tracking first
await ScreenOrientation.startOrientationTracking({
  bypassOrientationLock: true
});

// Check lock status
const status = await ScreenOrientation.isOrientationLocked();
if (status.locked) {
  console.log('Orientation lock is ON');
  console.log('Physical:', status.physicalOrientation);
  console.log('UI:', status.uiOrientation);
}

类型参考

ScreenOrientationResult

屏幕方向方法orientation()的返回结果。

export interface ScreenOrientationResult {
  /**
   * The current orientation type.
   *
   * @since 1.0.0
   */
  type: OrientationType;
}

OrientationLockOptions

屏幕方向锁定的选项。

export interface OrientationLockOptions {
  /**
   * The orientation type to lock to.
   *
   * @since 1.0.0
   */
  orientation: OrientationLockType;

  /**
   * Whether to track physical device orientation using motion sensors.
   * When true, uses device motion sensors to detect the true physical
   * orientation of the device, even when the device orientation lock is enabled.
   *
   * **Important:** This does NOT bypass the UI orientation lock.
   * The screen will still respect the user's orientation lock setting.
   * This option only affects orientation detection/tracking - you'll receive
   * orientation change events based on how the device is physically held,
   * but the UI will not rotate if orientation lock is enabled.
   *
   * Supported on iOS (Core Motion) and Android (Accelerometer).
   *
   * @default false
   * @since 1.0.0
   */
  bypassOrientationLock?: boolean;
}

StartOrientationTrackingOptions

开始运动跟踪使用运动传感器的选项。

export interface StartOrientationTrackingOptions {
  /**
   * Whether to track physical device orientation using motion sensors.
   * When true, uses device motion sensors to detect the true physical
   * orientation of the device, even when the device orientation lock is enabled.
   *
   * **Important:** This does NOT bypass the UI orientation lock.
   * This only enables detection of the physical orientation.
   *
   * Supported on iOS (Core Motion) and Android (Accelerometer).
   *
   * @default false
   * @since 1.0.0
   */
  bypassOrientationLock?: boolean;
}

OrientationLockStatusResult

isOrientationLocked()方法返回的方向锁定状态结果

export interface OrientationLockStatusResult {
  /**
   * Whether the device orientation lock is currently enabled.
   *
   * This is determined by comparing the physical device orientation
   * (from motion sensors) with the UI orientation. If they differ,
   * orientation lock is enabled.
   *
   * Available on iOS (Core Motion) and Android (Accelerometer) when motion tracking is active.
   *
   * @since 1.0.0
   */
  locked: boolean;

  /**
   * The physical orientation of the device from motion sensors.
   * Available when motion tracking is active (iOS and Android).
   *
   * @since 1.0.0
   */
  physicalOrientation?: OrientationType;

  /**
   * The current UI orientation reported by the system.
   *
   * @since 1.0.0
   */
  uiOrientation: OrientationType;
}

OrientationType

描述设备方向状态的方向类型

export type OrientationType = 'portrait-primary' | 'portrait-secondary' | 'landscape-primary' | 'landscape-secondary';

OrientationLockType

用于锁定设备方向的方向锁定类型

export type OrientationLockType =
  | 'any'
  | 'natural'
  | 'landscape'
  | 'portrait'
  | 'portrait-primary'
  | 'portrait-secondary'
  | 'landscape-primary'
  | 'landscape-secondary';

真实数据来源

This page is generated from the plugin’s src/definitions.ts请重新同步当公共 API 上游发生变化时。

从 Getting Started 继续

如果您正在使用 Getting Started 来规划原生媒体和界面行为，连接它到 使用 @capgo/capacitor-screen-orientation 为原生功能在使用 @capgo/capacitor-screen-orientation 中 使用 @capgo/capacitor-live-activities 为原生功能在使用 @capgo/capacitor-live-activities 中 capgo/capacitor-live-activities 关于@capgo/capacitor-live-activities的实现细节 使用@capgo/capacitor-video-player 关于在使用@capgo/capacitor-video-player时的原生能力 @capgo/capacitor-video-player 关于@capgo/capacitor-video-player的实现细节