CINXE.COM
screen_brightness | Flutter package
<!DOCTYPE html> <html lang="en-us"><head><script src="https://www.googletagmanager.com/gtm.js?id=GTM-MX6DBN9" async="async"></script><script src="/static/hash-o6oemknr/js/gtm.js" async="async"></script><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="ie=edge"/><meta name="viewport" content="width=device-width, initial-scale=1"/><meta name="twitter:card" content="summary"/><meta name="twitter:site" content="@dart_lang"/><meta name="twitter:description" content="A Plugin for controlling screen brightness with application life cycle reset implemented"/><meta name="twitter:image" content="https://pub.dev/static/hash-o6oemknr/img/pub-dev-icon-cover-image.png"/><meta property="og:type" content="website"/><meta property="og:site_name" content="Dart packages"/><meta property="og:title" content="screen_brightness | Flutter package"/><meta property="og:description" content="A Plugin for controlling screen brightness with application life cycle reset implemented"/><meta property="og:image" content="https://pub.dev/static/hash-o6oemknr/img/pub-dev-icon-cover-image.png"/><meta property="og:url" content="https://pub.dev/packages/screen_brightness"/><title>screen_brightness | Flutter package</title><link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Google+Sans:wght@400;500;700&family=Google+Sans+Display:wght@400&family=Google+Sans+Text:wght@400;500;700&family=Google+Sans+Mono:wght@400;700&display=swap"/><link rel="shortcut icon" href="/static/hash-o6oemknr/img/flutter-logo-32x32.png"/><link rel="stylesheet" href="https://www.gstatic.com/glue/v25_0/ccb.min.css"/><link rel="search" type="application/opensearchdescription+xml" title="Dart packages" href="/osd.xml"/><link rel="canonical" href="https://pub.dev/packages/screen_brightness"/><meta name="description" content="A Plugin for controlling screen brightness with application life cycle reset implemented"/><link rel="alternate" type="application/atom+xml" title="Updated Packages Feed for Pub" href="/feed.atom"/><link rel="stylesheet" type="text/css" href="/static/hash-o6oemknr/material/bundle/styles.css"/><link rel="stylesheet" type="text/css" href="/static/hash-o6oemknr/css/style.css"/><script src="/static/hash-o6oemknr/material/bundle/script.min.js" defer="defer"></script><script src="/static/hash-o6oemknr/js/script.dart.js" defer="defer"></script><script src="https://www.gstatic.com/brandstudio/kato/cookie_choice_component/cookie_consent_bar.v3.js" defer="defer" data-autoload-cookie-consent-bar="true"></script><meta name="pub-page-data" content="eyJwa2dEYXRhIjp7InBhY2thZ2UiOiJzY3JlZW5fYnJpZ2h0bmVzcyIsInZlcnNpb24iOiIyLjAuMCsyIiwibGlrZXMiOjExNywiaXNEaXNjb250aW51ZWQiOmZhbHNlLCJpc0xhdGVzdCI6dHJ1ZX0sInNlc3Npb25Bd2FyZSI6ZmFsc2V9"/><link rel="preload" href="/static/hash-o6oemknr/highlight/highlight-with-init.js" as="script"/></head><body class="light-theme"><script src="/static/hash-o6oemknr/js/dark-init.js"></script><noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MX6DBN9" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript><div class="site-header"><button class="hamburger" aria-label="menu toggle"></button><a class="logo" href="/"><img class="site-logo" src="/static/hash-o6oemknr/img/pub-dev-logo.svg" alt="" width="140" height="30" role="presentation"/></a><div class="site-header-space"></div><div class="site-header-mask"></div><div class="site-header-search"><form action="/packages" method="GET"><input class="site-header-search-input" name="q" placeholder="New search..." autocomplete="on" title="Search"/></form></div><nav class="site-header-nav scroll-container"><div class="nav-login-container"><button id="-account-login" class="nav-main-button link">Sign in</button></div><div class="nav-container nav-help-container hoverable"><button class="nav-main-button">Help</button><div class="nav-hover-popup"><div class="nav-table-columns"><div class="nav-table-column"><h3>Pub.dev</h3><a class="nav-link" href="/help/search" rel="noopener" target="_blank">Searching for packages</a><a class="nav-link" href="/help/scoring" rel="noopener" target="_blank">Package scoring and pub points</a></div><div class="nav-table-column"><h3>Flutter</h3><a class="nav-link" href="https://flutter.dev/using-packages/" rel="noopener" target="_blank">Using packages</a><a class="nav-link" href="https://flutter.dev/developing-packages/" rel="noopener" target="_blank">Developing packages and plugins</a><a class="nav-link" href="https://dart.dev/tools/pub/publishing" rel="noopener" target="_blank">Publishing a package</a></div><div class="nav-table-column"><h3>Dart</h3><a class="nav-link" href="https://dart.dev/guides/packages" rel="noopener" target="_blank">Using packages</a><a class="nav-link" href="https://dart.dev/tools/pub/publishing" rel="noopener" target="_blank">Publishing a package</a></div></div></div></div><div class="nav-container nav-help-container-mobile foldable"><h3 class="foldable-button">Pub.dev <img class="foldable-icon" src="/static/hash-o6oemknr/img/nav-mobile-foldable-icon.svg" alt="toggle folding of the section" width="13" height="6"/></h3><div class="foldable-content"><a class="nav-link" href="/help/search" rel="noopener" target="_blank">Searching for packages</a><a class="nav-link" href="/help/scoring" rel="noopener" target="_blank">Package scoring and pub points</a></div></div><div class="nav-container nav-help-container-mobile foldable"><h3 class="foldable-button">Flutter <img class="foldable-icon" src="/static/hash-o6oemknr/img/nav-mobile-foldable-icon.svg" alt="toggle folding of the section" width="13" height="6"/></h3><div class="foldable-content"><a class="nav-link" href="https://flutter.dev/using-packages/" rel="noopener" target="_blank">Using packages</a><a class="nav-link" href="https://flutter.dev/developing-packages/" rel="noopener" target="_blank">Developing packages and plugins</a><a class="nav-link" href="https://dart.dev/tools/pub/publishing" rel="noopener" target="_blank">Publishing a package</a></div></div><div class="nav-container nav-help-container-mobile foldable"><h3 class="foldable-button">Dart <img class="foldable-icon" src="/static/hash-o6oemknr/img/nav-mobile-foldable-icon.svg" alt="toggle folding of the section" width="13" height="6"/></h3><div class="foldable-content"><a class="nav-link" href="https://dart.dev/guides/packages" rel="noopener" target="_blank">Using packages</a><a class="nav-link" href="https://dart.dev/tools/pub/publishing" rel="noopener" target="_blank">Publishing a package</a></div></div></nav></div><div id="banner-container"></div><main class="container"><div class="detail-wrapper -active -has-info-box"><div class="detail-header -is-loose"><div class="detail-container"><div class="detail-header-outer-block"><div class="detail-header-content-block"><h1 class="title">screen_brightness 2.0.0+2 <span class="pkg-page-title-copy"><img class="pkg-page-title-copy-icon filter-invert-on-dark" src="/static/hash-o6oemknr/img/content-copy-icon.svg" alt="copy "screen_brightness: ^2.0.0+2" to clipboard" width="18" height="18" title="Copy "screen_brightness: ^2.0.0+2" to clipboard" data-copy-content="screen_brightness: ^2.0.0+2" data-ga-click-event="copy-package-version"/><div class="pkg-page-title-copy-feedback"><span class="code">screen_brightness: ^2.0.0+2</span> copied to clipboard</div></span></h1><div class="metadata">Published <span><a class="-x-ago" href="" title="Oct 19, 2024" aria-label="40 days ago" aria-role="button" role="button" data-timestamp="1729311868016">40 days ago</a></span> <span class="package-badge" title="Package is compatible with Dart 3.">Dart 3 compatible</span></div><div class="detail-tags-and-like"><div class="detail-tags"><div class="-pub-tag-badge"><span class="tag-badge-main">SDK</span><a class="tag-badge-sub" href="/packages?q=sdk%3Aflutter" rel="nofollow" title="Packages compatible with Flutter SDK">Flutter</a></div><div class="-pub-tag-badge"><span class="tag-badge-main">Platform</span><a class="tag-badge-sub" href="/packages?q=platform%3Aandroid" rel="nofollow" title="Packages compatible with Android platform">Android</a><a class="tag-badge-sub" href="/packages?q=platform%3Aios" rel="nofollow" title="Packages compatible with iOS platform">iOS</a><a class="tag-badge-sub" href="/packages?q=platform%3Amacos" rel="nofollow" title="Packages compatible with macOS platform">macOS</a><a class="tag-badge-sub" href="/packages?q=platform%3Awindows" rel="nofollow" title="Packages compatible with Windows platform">Windows</a></div></div><div class="detail-like"><button id="-pub-like-icon-button" class="mdc-icon-button" data-ga-click-event="toggle-like" aria-pressed="false" title="Like this package"><img class="mdc-icon-button__icon" src="/static/hash-o6oemknr/img/like-inactive.svg" alt="liked status: inactive" width="18" height="18"/><img class="mdc-icon-button__icon mdc-icon-button__icon--on" src="/static/hash-o6oemknr/img/like-active.svg" alt="liked status: active" width="18" height="18"/></button><span class="likes-count"><span id="likes-count">117</span></span></div></div></div></div></div></div><div class="detail-container"><div class="detail-lead"><div class="detail-metadata-toggle"><div class="detail-metadata-toggle-icon">→</div><h3 class="detail-lead-title">Metadata</h3></div><p class="detail-lead-text">A Plugin for controlling screen brightness with application life cycle reset implemented</p><p class="detail-lead-more"><a class="detail-metadata-toggle">More...</a></p></div></div><div class="detail-body"><div class="detail-tabs"><div class="detail-tabs-wide-header"><div class="detail-container"><ul class="detail-tabs-header"><li class="detail-tab tab-button detail-tab-readme-title -active">Readme</li><li class="detail-tab tab-link detail-tab-changelog-title"><a href="/packages/screen_brightness/changelog" role="button">Changelog</a></li><li class="detail-tab tab-link detail-tab-example-title"><a href="/packages/screen_brightness/example" role="button">Example</a></li><li class="detail-tab tab-link detail-tab-installing-title"><a href="/packages/screen_brightness/install" role="button">Installing</a></li><li class="detail-tab tab-link detail-tab-versions-title"><a href="/packages/screen_brightness/versions" role="button">Versions</a></li><li class="detail-tab tab-link detail-tab-analysis-title"><a href="/packages/screen_brightness/score" role="button">Scores</a></li></ul></div></div><div class="detail-container detail-body-main"><div class="detail-tabs-content"><section class="tab-content detail-tab-readme-content -active markdown-body"><h1 class="hash-header" id="screen_brightness">screen_brightness <a href="#screen_brightness" class="hash-link">#</a></h1> <p>A Plugin for controlling screen brightness with application life cycle reset implemented.</p> <p>This plugin only changes application brightness not system brightness. So no permission is needed for this plugin.</p> <h2 class="hash-header" id="getting-started">Getting Started <a href="#getting-started" class="hash-link">#</a></h2> <h3 class="hash-header" id="install">Install <a href="#install" class="hash-link">#</a></h3> <p>Add the following lines in your pubspec.yaml file</p> <pre><code class="language-yaml"> screen_brightness: ^latest_version </code></pre> <p>latest_version:<br> <a href="https://pub.dartlang.org/packages/screen_brightness" rel="ugc"><img src="https://img.shields.io/pub/v/screen_brightness.svg" alt="pub package"></a></p> <p>To adjust the system brightness on Android, add the following permission in your <code>AndroidManifest.xml</code> file</p> <pre><code class="language-xml"><uses-permission android:name="android.permission.WRITE_SETTINGS" tools:ignore="ProtectedPermissions"/> </code></pre> <h3 class="hash-header" id="api">API <a href="#api" class="hash-link">#</a></h3> <h4 id="system-brightness">System brightness</h4> <pre><code class="language-dart">Future<double> get systemBrightness async { try { return await ScreenBrightness.instance.system; } catch (e) { print(e); throw 'Failed to get system brightness'; } } </code></pre> <h4 id="set-system-brightness">Set system brightness</h4> <pre><code class="language-dart"> Future<void> setSystemBrightness(double brightness) async { try { await ScreenBrightness.instance.setSystemScreenBrightness(brightness); } catch (e) { debugPrint(e.toString()); throw 'Failed to set system brightness'; } } </code></pre> <h4 id="application-brightness">Application brightness</h4> <pre><code class="language-dart">Future<double> get applicationBrightness async { try { return await ScreenBrightness.instance.application; } catch (e) { print(e); throw 'Failed to get application brightness'; } } </code></pre> <h4 id="set-application-brightness">Set application brightness</h4> <pre><code class="language-dart">Future<void> setApplicationBrightness(double brightness) async { try { await ScreenBrightness.instance .setApplicationScreenBrightness(brightness); } catch (e) { debugPrint(e.toString()); throw 'Failed to set application brightness'; } } </code></pre> <h4 id="reset-application-brightness">Reset application brightness</h4> <pre><code class="language-dart"> Future<void> resetApplicationBrightness() async { try { await ScreenBrightness.instance.resetApplicationScreenBrightness(); } catch (e) { debugPrint(e.toString()); throw 'Failed to reset application brightness'; } } </code></pre> <h4 id="system-brightness-changed-stream">System brightness changed stream</h4> <pre><code class="language-dart">@override Widget build(BuildContext context) { return StreamBuilder<double>( stream: ScreenBrightness.instance.onSystemScreenBrightnessChanged, builder: (context, snapshot) { double changedSystemBrightness = systemBrightness; if (snapshot.hasData) { changedSystemBrightness = snapshot.data!; } return Text('system brightness $changedSystemBrightness');; }, ); } </code></pre> <h4 id="application-brightness-changed-stream">Application brightness changed stream</h4> <pre><code class="language-dart">@override Widget build(BuildContext context) { return StreamBuilder<double>( stream: ScreenBrightness.instance.onApplicationScreenBrightnessChanged, builder: (context, snapshot) { double changedApplicationBrightness = applicationBrightness; if (snapshot.hasData) { changedApplicationBrightness = snapshot.data!; } return Text('application brightness $changedApplicationBrightness');; }, ); } </code></pre> <h4 id="has-application-brightness-changed">Has application brightness changed</h4> <pre><code class="language-dart">@override Widget build(BuildContext context) { return FutureBuilder<bool>( future: ScreenBrightness.instance.hasApplicationScreenBrightnessChanged, builder: (context, snapshot) { return Text( 'Application brightness has changed via plugin: ${snapshot.data}'); }, ); } </code></pre> <h4 id="auto-reset">Auto reset</h4> <pre><code class="language-dart">bool isAutoReset = true; Future<void> getIsAutoResetSetting() async { final isAutoReset = await ScreenBrightness.instance.isAutoReset; setState(() { this.isAutoReset = isAutoReset; }); } @override Widget build(BuildContext context) { return Switch( value: isAutoReset, onChanged: (value) async { await ScreenBrightness.instance.setAutoReset(value); await getIsAutoResetSetting(); }, ); } </code></pre> <h3 class="hash-header" id="usage">Usage <a href="#usage" class="hash-link">#</a></h3> <ul> <li>DON'T use didChangeAppLifecycleState to set or reset brightness because this plugin already implemented this function.</li> <li>You may also use this plugin with <a href="https://pub.dev/packages/wakelock">wakelock</a> to prevent screen sleep</li> </ul> <h2 class="hash-header" id="maintainer">Maintainer <a href="#maintainer" class="hash-link">#</a></h2> <p><a href="https://github.com/aaassseee" rel="ugc">Jack Liu</a></p> </section></div></div></div><aside class="detail-info-box"><a class="packages-scores" href="/packages/screen_brightness/score"><div class="packages-score packages-score-like"><div class="packages-score-value -has-value"><span class="packages-score-value-number">117</span><span class="packages-score-value-sign"></span></div><div class="packages-score-label">likes</div></div><div class="packages-score packages-score-health"><div class="packages-score-value -has-value"><span class="packages-score-value-number">160</span><span class="packages-score-value-sign"></span></div><div class="packages-score-label">pub points</div></div><div class="packages-score packages-score-popularity"><div class="packages-score-value -has-value"><span class="packages-score-value-number">98</span><span class="packages-score-value-sign">%</span></div><div class="packages-score-label">popularity</div></div></a><h3 class="title">Publisher</h3><p><span>unverified uploader</span></p><h3 class="title pkg-infobox-metadata">Metadata</h3><p>A Plugin for controlling screen brightness with application life cycle reset implemented</p><p><a class="link" href="https://github.com/aaassseee/screen_brightness" rel="ugc">Homepage</a><br/><a class="link" href="https://github.com/aaassseee/screen_brightness/tree/master/screen_brightness" rel="ugc">Repository (GitHub)</a><br/><a class="link" href="https://github.com/aaassseee/screen_brightness/issues" rel="ugc">View/report issues</a><br/></p><h3 class="title">Topics</h3><p><a href="/packages?q=topic%3Ascreen" rel="nofollow">#screen</a> <a href="/packages?q=topic%3Amonitor" rel="nofollow">#monitor</a> <a href="/packages?q=topic%3Abrightness" rel="nofollow">#brightness</a></p><h3 class="title">Documentation</h3><p><a class="link" href="/documentation/screen_brightness/latest/">API reference</a><br/></p><h3 class="title">License</h3><p><img class="inline-icon-img filter-invert-on-dark" src="/static/hash-o6oemknr/img/material-icon-balance.svg" alt="" width="14" height="14" role="presentation"/>MIT (<a href="/packages/screen_brightness/license">license</a>)</p><h3 class="title">Dependencies</h3><p><a href="https://api.flutter.dev/">flutter</a>, <a href="/packages/screen_brightness_android" title=">=2.0.0 <3.0.0">screen_brightness_android</a>, <a href="/packages/screen_brightness_ios" title=">=2.0.0 <3.0.0">screen_brightness_ios</a>, <a href="/packages/screen_brightness_macos" title=">=2.0.0 <3.0.0">screen_brightness_macos</a>, <a href="/packages/screen_brightness_platform_interface" title=">=2.0.0 <3.0.0">screen_brightness_platform_interface</a>, <a href="/packages/screen_brightness_windows" title=">=2.0.0 <3.0.0">screen_brightness_windows</a></p><h3 class="title">More</h3><p><a href="/packages?q=dependency%3Ascreen_brightness" rel="nofollow">Packages that depend on screen_brightness</a></p></aside></div><script type="application/ld+json">{"@context":"http\u003a\u002f\u002fschema.org","@type":"SoftwareSourceCode","name":"screen\u005fbrightness","version":"2.0.0\u002b2","description":"screen\u005fbrightness - A Plugin for controlling screen brightness with application life cycle reset implemented","url":"https\u003a\u002f\u002fpub.dev\u002fpackages\u002fscreen\u005fbrightness","dateCreated":"2021-05-13T04\u003a28\u003a33.971830Z","dateModified":"2024-10-19T04\u003a24\u003a28.016250Z","programmingLanguage":"Dart","image":"https\u003a\u002f\u002fpub.dev\u002fstatic\u002fimg\u002fpub-dev-icon-cover-image.png","license":"https\u003a\u002f\u002fpub.dev\u002fpackages\u002fscreen\u005fbrightness\u002flicense"}</script></div><div class="detail-metadata"><h3 class="detail-metadata-title"><span class="detail-metadata-toggle">←</span> Metadata</h3><div class="detail-info-box"><a class="packages-scores" href="/packages/screen_brightness/score"><div class="packages-score packages-score-like"><div class="packages-score-value -has-value"><span class="packages-score-value-number">117</span><span class="packages-score-value-sign"></span></div><div class="packages-score-label">likes</div></div><div class="packages-score packages-score-health"><div class="packages-score-value -has-value"><span class="packages-score-value-number">160</span><span class="packages-score-value-sign"></span></div><div class="packages-score-label">pub points</div></div><div class="packages-score packages-score-popularity"><div class="packages-score-value -has-value"><span class="packages-score-value-number">98</span><span class="packages-score-value-sign">%</span></div><div class="packages-score-label">popularity</div></div></a><h3 class="title">Publisher</h3><p><span>unverified uploader</span></p><h3 class="title pkg-infobox-metadata">Metadata</h3><p>A Plugin for controlling screen brightness with application life cycle reset implemented</p><p><a class="link" href="https://github.com/aaassseee/screen_brightness" rel="ugc">Homepage</a><br/><a class="link" href="https://github.com/aaassseee/screen_brightness/tree/master/screen_brightness" rel="ugc">Repository (GitHub)</a><br/><a class="link" href="https://github.com/aaassseee/screen_brightness/issues" rel="ugc">View/report issues</a><br/></p><h3 class="title">Topics</h3><p><a href="/packages?q=topic%3Ascreen" rel="nofollow">#screen</a> <a href="/packages?q=topic%3Amonitor" rel="nofollow">#monitor</a> <a href="/packages?q=topic%3Abrightness" rel="nofollow">#brightness</a></p><h3 class="title">Documentation</h3><p><a class="link" href="/documentation/screen_brightness/latest/">API reference</a><br/></p><h3 class="title">License</h3><p><img class="inline-icon-img filter-invert-on-dark" src="/static/hash-o6oemknr/img/material-icon-balance.svg" alt="" width="14" height="14" role="presentation"/>MIT (<a href="/packages/screen_brightness/license">license</a>)</p><h3 class="title">Dependencies</h3><p><a href="https://api.flutter.dev/">flutter</a>, <a href="/packages/screen_brightness_android" title=">=2.0.0 <3.0.0">screen_brightness_android</a>, <a href="/packages/screen_brightness_ios" title=">=2.0.0 <3.0.0">screen_brightness_ios</a>, <a href="/packages/screen_brightness_macos" title=">=2.0.0 <3.0.0">screen_brightness_macos</a>, <a href="/packages/screen_brightness_platform_interface" title=">=2.0.0 <3.0.0">screen_brightness_platform_interface</a>, <a href="/packages/screen_brightness_windows" title=">=2.0.0 <3.0.0">screen_brightness_windows</a></p><h3 class="title">More</h3><p><a href="/packages?q=dependency%3Ascreen_brightness" rel="nofollow">Packages that depend on screen_brightness</a></p></div><p class="detail-lead-back"><a class="detail-metadata-toggle">Back</a></p></div><div id="-screenshot-carousel" class="carousel"><fab id="-carousel-prev" class="mdc-fab carousel-prev carousel-nav" data-mdc-auto-init="MDCRipple" title="Previous" data-ga-click-event="screenshot-carousel-prev-click" tabindex="0"><div class="mdc-fab__ripple"></div><img class="mdc-fab__icon" src="/static/hash-o6oemknr/img/keyboard_arrow_left.svg" alt="previous" width="24" height="24" aria-hidden="true"/></fab><div id="-image-container" class="image-container"></div><fab id="-carousel-next" class="mdc-fab carousel-next carousel-nav" data-mdc-auto-init="MDCRipple" title="Next" data-ga-click-event="screenshot-carousel-next-click" tabindex="0"><div class="mdc-fab__ripple"></div><img class="mdc-fab__icon" src="/static/hash-o6oemknr/img/keyboard_arrow_right.svg" alt="next" width="24" height="24" aria-hidden="true"/></fab><p id="-screenshot-description" class="screenshot-description"></p></div></main><footer class="site-footer"><a class="link" href="https://dart.dev/">Dart language</a><a class="link sep" href="/report?subject=package%3Ascreen_brightness&url=https%3A%2F%2Fpub.dev%2Fpackages%2Fscreen_brightness">Report package</a><a class="link sep" href="/policy">Policy</a><a class="link sep" href="https://www.google.com/intl/en/policies/terms/">Terms</a><a class="link sep" href="https://developers.google.com/terms/">API Terms</a><a class="link sep" href="/security">Security</a><a class="link sep" href="https://www.google.com/intl/en/policies/privacy/">Privacy</a><a class="link sep" href="/help">Help</a><a class="link icon sep" href="/feed.atom"><img class="inline-icon" src="/static/hash-o6oemknr/img/rss-feed-icon.svg" alt="RSS" width="20" height="20" title="RSS/atom feed"/></a><a class="link icon github_issue" href="https://github.com/dart-lang/pub-dev/issues/new"><img class="inline-icon" src="/static/hash-o6oemknr/img/bug-report-white-96px.png" alt="bug report" width="20" height="20" title="Report an issue with this site"/></a></footer><script src="/static/hash-o6oemknr/highlight/highlight-with-init.js" defer="defer"></script></body></html>