Difference between revisions of "Action: Read Screen Contents"

m
 
(4 intermediate revisions by 2 users not shown)
Line 27: Line 27:
 
</pre><br>
 
</pre><br>
  
* ''''' Define manualmente '''''
+
* ''''' Define manually '''''
 
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
 
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
 
Define one or more dictionary keys manually using the full syntax. For example to address a dictionary storing data by years and months you could write [2022][May]
 
Define one or more dictionary keys manually using the full syntax. For example to address a dictionary storing data by years and months you could write [2022][May]
Line 37: Line 37:
 
* ''''' Exclude view ids without text '''''
 
* ''''' Exclude view ids without text '''''
 
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
 
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
All the obtained will be saved including empty values.
+
All the obtained will be saved excluding values without any text content.
 
</pre><br>
 
</pre><br>
  
Line 43: Line 43:
  
 
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
 
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
Only an ID containing a defined value is obtained.
+
All views will be obtained regardless of containing any text or not.
  
 
e.g.
 
e.g.
  
An ID that will not be included:
+
An ID for a view that has no text:
  
Key = android: id/content
+
Key = android:id/content
 
Value =
 
Value =
  
A valid ID that will be included:
+
An ID for a view with text content:
  
 
Key = com.arlosoft.macrodroid:id/title
 
Key = com.arlosoft.macrodroid:id/title
 
Value = Add macro
 
Value = Add macro
 
</pre><br>
 
</pre><br>
 
  
 
=== Overlay ===
 
=== Overlay ===
Line 63: Line 62:
 
* ''''' Exclude Overlay '''''
 
* ''''' Exclude Overlay '''''
 
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
 
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
All the obtained will be saved including empty values.
+
Only views from the main foreground application will be acquired, any app showing an overlay will be ignored.
 
</pre><br>
 
</pre><br>
  
Line 69: Line 68:
  
 
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
 
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
Only an ID containing a defined value is obtained.
+
Attempts to obtain all views that are visible on screen including the foreground app and any overlays.
 
 
Examples of an overlay.
 
 
 
* A pop-up menu that appears when a button is tapped.
 
* A floating window displayed above the main screen.
 
* A dialog box that appears on the screen.
 
</pre><br>
 
 
 
==<p><b>Example</b></p>==
 
 
 
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
 
Floating button gets elements from the screen, you can later check it (in the variable) to find the ID to use in a UI interaction or simply get the associated text of the ID.
 
</pre><br>
 
<pre style="background-color: #AC2424; color: white; border-radius: 10px; padding: 10px;">
 
Triggers
 
 
 
Floating button | Screen content
 
</pre><br>
 
<pre style="background-color: #1665B0; color: white; border-radius: 10px; padding: 10px;">
 
Actions
 
 
 
Read Screen Content -> my_dict
 
</pre><br>
 
<pre style="background-color: green; color: white; border-radius: 10px; padding: 10px;">
 
Constraints
 
 
 
 
 
</pre><br>
 
<pre style="background-color: teal; color: white; border-radius: 10px; padding: 10px;">
 
Local variables
 
 
 
my_dict | 5 entries (This is a short example, but in practice the dictionary can have many more entries).
 
  
com.android.systemui:id/mobile_type | 5G
+
An overlay is typically a floating window displayed above the main screen. For example MacroDroid uses overkays to display floating text items.
com.spotify.music:id/civerart | Cover and open spotify
 
com.microsoft.emmx:id/title | Search
 
 
</pre><br>
 
</pre><br>

Latest revision as of 06:31, 25 January 2025

About

This action can be used to capture the contents of the current screen into a dictionary variable.
The variable will consist of a number of key-value pairs where the key is the Ul view id and the value is the textual content.
Note | that any existing entries in the dictionary will be cleared.


Configuration available

Select variable

You need to select or create a dictionary type variable to store the obtained screen content.

Variables | Dictionary

Select key

  • This Dictionary
If you already have an existing dictionary, this function will write to the root of the dictionary.


  • Add key
You can choose to add a Key manually.


  • Define manually
Define one or more dictionary keys manually using the full syntax. For example to address a dictionary storing data by years and months you could write [2022][May]
To force an array type (rather than dictionary) prefix the index with_A_. For example to output a value in a 2d array you could write [A_3][A_10]


View ID

  • Exclude view ids without text
All the obtained will be saved excluding values without any text content.


  • Include view ids without text
All views will be obtained regardless of containing any text or not.

e.g.

An ID for a view that has no text:

Key = android:id/content
Value =

An ID for a view with text content:

Key = com.arlosoft.macrodroid:id/title
Value = Add macro


Overlay

  • Exclude Overlay
Only views from the main foreground application will be acquired, any app showing an overlay will be ignored.


  • Include Overlay (Pro version required)
Attempts to obtain all views that are visible on screen including the foreground app and any overlays.

An overlay is typically a floating window displayed above the main screen. For example MacroDroid uses overkays to display floating text items.