@capgo/capacitor-screen-orientation
Capacitor Screen Orientation Plugin interface.
Overview
Section titled “Overview”Capacitor Screen Orientation Plugin interface.
Core Capabilities
Section titled “Core Capabilities”orientation- Get the current screen orientation.lock- Lock the screen orientation to a specific type.unlock- Unlock the screen orientation.startOrientationTracking- Start tracking device orientation using motion sensors.
Public API
Section titled “Public API”| Method | Description |
|---|---|
orientation | Get the current screen orientation. |
lock | Lock the screen orientation to a specific type. |
unlock | Unlock the screen orientation. |
startOrientationTracking | Start tracking device orientation using motion sensors. |
stopOrientationTracking | Stop tracking device orientation using motion sensors. |
isOrientationLocked | Check if device orientation lock is currently enabled. |
addListener | Listen for screen orientation changes. |
removeAllListeners | Remove all listeners for this plugin. |
getPluginVersion | Get the native plugin version. |
Source Of Truth
Section titled “Source Of Truth”This reference is synced from src/definitions.ts in capacitor-screen-orientation.