Update readme and documentation for latest native SDKs

Navideck · Oct 15, 2023 · 35e788e · 35e788e
1 parent a4f8abb
commit 35e788e
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -61,7 +61,6 @@ var gesturedeckMedia = GesturedeckMedia.initialize(
     swipeRightAction: () {},
     panAction: () {},
     gesturedeckMediaOverlay: GesturedeckMediaOverlay(
-        tintColor: Colors.green,
         topIcon: icon,
         iconSwipeLeft: ...,
         iconSwipeRight: ...,

diff --git a/lib/src/gesturedeck_media.dart b/lib/src/gesturedeck_media.dart
@@ -6,7 +6,11 @@ import 'generated/gesturedeck_generated.g.dart';
 
 /// A subclass of [Gesturedeck] that provides media-specific functionality such as volume control and media playback actions.
 ///
-/// Gesturedeck also includes support for media overlays, which can be used to display additional information or controls on top of the app's content.
+/// GesturedeckMedia also includes support for media overlays, which can be used to display additional information or controls on top of the app's content.
+/// 
+/// You can set any action to null to disable it.
+/// 
+/// You can set the overlay to null to disable it.
 class GesturedeckMedia {
   static final _gesturedeckMediaChannel = GesturedeckMediaChannel();
   static bool _isInitialized = false;

diff --git a/lib/src/models/gesturedeck_media_overlay.dart b/lib/src/models/gesturedeck_media_overlay.dart
@@ -3,7 +3,7 @@ import 'dart:ui';
 
 /// A model representing a media overlay in the Gesturedeck SDK.
 class GesturedeckMediaOverlay {
-  /// The color used to tint the overlay elements.
+  /// The color used to tint the overlay elements. Has effect only when an activation key is set.
   Color? tintColor;
 
   /// The background color of the overlay.