Getting Started

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten Ihrem AI-Tool mit der folgenden Befehlszeile hinzu:

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

Verwenden Sie dann die folgende Anfrage:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die darunter angegebenen Plattform-spezifischen Anweisungen befolgen:

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

Importieren

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

API-Übersicht

orientation

Rufen Sie die aktuelle Bildschirmorientierung ab.

Gibt die aktuelle Orientierung des Gerätebildschirms zurück.

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

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

lock

Blockieren Sie die Bildschirmorientierung auf eine bestimmte Art.

Blockiert den Bildschirm auf der angegebenen Orientierung. Bei iOS wird, wenn bypassOrientationLock wahr ist, auch die physische Geräteorientierung mithilfe von Bewegungssensoren abgetrackt.

Hinweis: Die Benutzeroberfläche respektiert den Orientierungssperreinstellung des Benutzers weiterhin. Die Bewegungserkennung ermöglicht es Ihnen, zu erkennen, wie das Gerät physisch gehalten wird, ebenbei, wenn die Benutzeroberfläche nicht rotiert.

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

Freigeben Sie die Bildschirmorientierung.

Erstellt die Bildschirmrotation frei basierend auf der Geräteposition. Stoppt auch jede Bewegungsorientierungserkennung, wenn sie aktiviert war.

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

await ScreenOrientation.unlock();

startOrientationTracking

Startet die Orientierungserkennung des Geräts mithilfe von Bewegungssensoren.

Dieser Methoden ist nützlich, wenn Sie die physische Orientierung des Geräts unabhängig von der Bildschirmorientierung sperren möchten. Es verwendet Core Motion auf iOS, um Orientierungsänderungen zu erkennen.

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

Stoppt die Orientierungserkennung mithilfe von Bewegungssensoren.

Stoppt die Bewegungsorientierungserkennung, wenn sie gestartet wurde.

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

await ScreenOrientation.stopOrientationTracking();

isOrientationLocked

Überprüft, ob die Geräteorientierungssperre derzeit aktiviert ist.

Diese Methode vergleicht die physische Geräteorientierung (aus Bewegungssensoren) mit der Benutzeroberflächenoientierung. Wenn sie sich unterscheiden, ist die Orientierungssperre aktiviert.

Anmerkung: Dies erfordert die Aktivierung der Bewegungsverfolgung über startOrientationTracking() oder lock() mit bypassOrientationLock: true. Funktioniert auf beiden iOS (Core Motion) und 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);
}

Typenreferenz

ScreenOrientationResult

Resultat, das von der Methode orientation() zurückgegeben wird.

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

OrientationLockOptions

Optionen für die Sperre der Bildschirmorientierung.

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

Optionen für die Startorientierung mit Bewegungssensoren.

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

Erfolgsmeldung, die von der Methode isOrientationLocked() zurückgegeben wird.

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

Der Orientierungstyp, der den Orientierungszustand des Geräts beschreibt.

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

OrientationLockType

Der Orientierungssperre-Typ, der zum Sperren der Geräteorientierung verwendet werden kann.

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

Quelle der Wahrheit

Diese Seite wurde aus dem Plugin generiert. src/definitions.tsWiederholen Sie die Synchronisierung, wenn sich die öffentliche API im Hintergrund ändert.

Weitermachen von Getting Started

Wenn Sie native Medien und Schnittstellenverhalten planen, verbinden Sie es mit Getting Started Verwenden Sie @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-screen-orientation für die native Fähigkeit in Verwenden Sie @capgo/capacitor-screen-orientation Verwenden Sie @capgo/capacitor-live-activities für die native Fähigkeit in Verwenden Sie @capgo/capacitor-live-activities for the native capability in Using @capgo/capacitor-live-activities, @capgo/capacitor-live-aktivitäten für die Implementierungsdetails in @capgo/capacitor-live-aktivitäten Mit @capgo/capacitor-video-player für die native Fähigkeit in Mit @capgo/capacitor-video-player und @capgo/capacitor-video-player für die Implementierungsdetails in @capgo/capacitor-video-player.