Getting Started

インストール

AIアシストされたセットアップを使用してプラグインをインストールできます。AIツールに次のコマンドを使用して、Capgoスキルを追加します。

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次に、以下のプロンプトを使用してください。

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-screen-orientation` plugin in my project.

プラグインを手動でセットアップする場合は、以下のコマンドを実行して、下記のプラットフォーム固有の指示に従ってください。

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の場合、motionセンサを使用して物理デバイスの向きを追跡します。

注意: UIはユーザーの向きロック設定を尊重します。 motion追跡により、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

画面の向きを解除します。

デバイスの位置に応じて画面を自由に回転させることができます。 また、motionベースの向き追跡も停止します。

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) で機能します。

Copy to clipboard

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

画面向きの結果を返します。

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';

Source Of Truth

このページはプラグインのソースコードから生成されています src/definitions.ts. APIがアップストリームで変更された場合に、パブリックを再度同步する

Getting Startedから続けて

Capgoを使用している場合 Getting Started Capgoを使用してネイティブメディアとインターフェイスの動作を計画するには、Capgoを Using @capgo/capacitor-screen-orientation for the native capability in Using @capgo/capacitor-screen-orientation, Using @capgo/capacitor-live-activities for the native capability in Using @capgo/capacitor-live-activities, @capgo/capacitor-live-activities for the implementation detail in @capgo/capacitor-live-activities, Using @capgo/capacitor-video-player native機能のために@capgo/capacitor-video-playerを使用します。 for the native capability in Using @capgo/capacitor-video-player, and @capgo/capacitor-video-playerを使用してnative機能を実装します。