Constants
VRC buttons are used via suitest.VRC.*, * being a key code from below. For
example suitest.VRC.FAST_FWD.
Smart TVs and set-top-boxes
Main and navigation buttons
See main buttons on VRC and navigation buttons on VRC.
See media buttons on VRC.
See color buttons on VRC.
See numerical buttons on VRC.
See playback buttons on VRC.
| Code |
Key name |
Unicode value |
Android TV |
| BUTTON_10 |
Gamepad button 10 |
\uE530 |
✓ |
| BUTTON_11 |
Gamepad button 11 |
\uE531 |
✓ |
| BUTTON_12 |
Gamepad button 12 |
\uE532 |
✓ |
| D_PAD_CENTER |
D-pad center |
\uE540 |
✓ |
| Code |
Key name |
Unicode value |
Apple TV |
| SELECT |
Select |
\uE5B5 |
✓ |
| Code |
Key name |
Unicode value |
Roku |
| A |
A |
\uE620 |
✓ |
| B |
B |
\uE621 |
✓ |
| Code |
Key name |
Unicode value |
Vega |
| VIRTUAL_BACKSPACE |
Virtual backspace |
\uE |
✓ |
Gaming consoles
| Code |
Key name |
Unicode |
Xbox * |
PlayStation 4/5 |
| A |
A button |
\uE620 |
✓ (green) |
✓ |
| B |
B button |
\uE621 |
✓ (red) |
✓ |
| BACK |
Back |
\uE600 |
✓ |
✓ |
| CIRCLE |
Circle |
\uE510 |
- |
✓ |
| D_PAD_DOWN |
D-pad down |
\uE541 |
✓ |
✓ |
| D_PAD_LEFT |
D-pad left |
\uE542 |
✓ |
✓ |
| D_PAD_RIGHT |
D-pad right |
\uE543 |
✓ |
✓ |
| D_PAD_UP |
D-pad up |
\uE544 |
✓ |
✓ |
| DOWN |
Down |
\uE5E0 |
✓ |
✓ |
| ENTER |
Enter |
\uE601 |
✓ |
✓ |
| HOME |
Home |
\uE603 |
✓ |
✓ |
| L1 |
L1 |
\uE580 |
✓ |
✓ |
| L2 |
L2 |
\uE581 |
✓ |
✓ |
| LEFT |
Left |
\uE5E1 |
✓ |
✓ |
| LEFT_BUMPER |
Left bumper |
\uE550 |
✓ |
✓ |
| LEFT_THUMBSTICK_BUTTON |
Left thumbstick button |
\uE570 |
✓ |
✓ |
| LEFT_THUMBSTICK_DOWN |
Left thumbstick down |
\uE571 |
✓ |
✓ |
| LEFT_THUMBSTICK_LEFT |
Left thumbstick left |
\uE572 |
✓ |
✓ |
| LEFT_THUMBSTICK_RIGHT |
Left thumbstick right |
\uE573 |
✓ |
✓ |
| LEFT_THUMBSTICK_UP |
Left thumbstick up |
\uE574 |
✓ |
✓ |
| LEFT_TRIGGER |
Left trigger |
\uE560 |
✓ |
✓ |
| MENU |
Menu |
\uE5B1 |
✓ |
- |
| OK |
Ok |
\uE5B2 |
✓ |
✓ |
| OPTIONS |
Options |
\uE5B3 |
- |
✓ |
| POWER |
Power |
\uE5B4 |
✓ |
✓ |
| R1 |
R1 |
\uE590 |
✓ |
✓ |
| R2 |
R2 |
\uE591 |
✓ |
✓ |
| RIGHT |
Right |
\uE5E2 |
✓ |
✓ |
| RIGHT_BUMPER |
Right bumper |
\uE551 |
✓ |
✓ |
| RIGHT_THUMBSTICK_BUTTON |
Right thumbstick button |
\uE57A |
✓ |
✓ |
| RIGHT_THUMBSTICK_DOWN |
Right thumbstick down |
\uE57B |
✓ |
✓ |
| RIGHT_THUMBSTICK_LEFT |
Right thumbstick left |
\uE57C |
✓ |
✓ |
| RIGHT_THUMBSTICK_RIGHT |
Right thumbstick right |
\uE57D |
✓ |
✓ |
| RIGHT_THUMBSTICK_UP |
Right thumbstick up |
\uE57E |
✓ |
✓ |
| RIGHT_TRIGGER |
Right trigger |
\uE561 |
✓ |
✓ |
| SHARE |
Share |
\uE5A0 |
- |
✓ |
| SQUARE |
Square |
\uE511 |
✓ |
✓ |
| TRIANGLE |
Triangle |
\uE512 |
✓ |
✓ |
| UP |
Up |
\uE5E3 |
✓ |
✓ |
| VIEW |
View |
\uE5A1 |
✓ |
- |
| X |
X (Blue) button |
\uE637 |
✓ |
✓ |
| Y |
Y (Yellow) button |
\uE638 |
✓ |
✓ |
* Xbox (One, Series X/S)
Mobile devices
| Code |
Key name |
Unicode |
Android mobile |
Apple iOS |
| BACK |
Back |
\uE600 |
✓ |
✓ |
| HOME |
Home |
\uE603 |
✓ |
✓ |
| LOCK |
Lock |
\uE5C0 |
✓ |
✓ |
| RECENT_APPS |
Recent applications |
\uE5C1 |
✓ |
- |
| VOL_DOWN |
Volume down |
\uE5F2 |
✓ |
✓ |
| VOL_UP |
Volume up |
\uE5F3 |
✓ |
✓ |
Browsers
The following key codes are meant to be used only with Appium integration.
| Key |
Unicode |
| Add, Plus |
\uE025 |
| Alt |
\uE00A |
| Back space |
\uE003 |
| Cancel |
\uE001 |
| Clear |
\uE005 |
| Control |
\uE009 |
| Decimal |
\uE028 |
| Delete |
\uE05D |
| Divide |
\uE029 |
| Down arrow |
\uE05B |
| End |
\uE010 |
| Enter |
\uE007 |
| Equals |
\uE019 |
| Escape |
\uE00C |
| F1 |
\uE031 |
| F2 |
\uE032 |
| F3 |
\uE033 |
| F4 |
\uE034 |
| F5 |
\uE035 |
| F6 |
\uE036 |
| F7 |
\uE037 |
| F8 |
\uE038 |
| F9 |
\uE039 |
| F10 |
\uE03A |
| F11 |
\uE03B |
| F12 |
\uE03C |
| Help |
\uE002 |
| Home |
\uE057 |
| Insert |
\uE05C |
| Left arrow |
\uE058 |
| Meta |
\uE053 |
| Multiply |
\uE024 |
| NULL |
\uE029 |
| Numpad 0 |
\uE01A |
| Numpad 1 |
\uE01B |
| Numpad 2 |
\uE01C |
| Numpad 3 |
\uE01D |
| Numpad 4 |
\uE01E |
| Numpad 5 |
\uE01F |
| Numpad 6 |
\uE020 |
| Numpad 7 |
\uE021 |
| Numpad 8 |
\uE022 |
| Numpad 9 |
\uE023 |
| Pagedown |
\uE00F |
| Pageup |
\uE00E |
| Pause |
\uE00B |
| Return |
\uE006 |
| Right arrow |
\uE014 |
| Semicolon |
\uE018 |
| Comma |
\uE026 |
| Shift |
\uE008 |
| Space |
\uE00D |
| Subtract |
\uE027 |
| Tab |
\uE004 |
| Up arrow |
\uE013 |
Element properties
Element properties are used via suitest.PROP.*, * being a key code from
below. For example suitest.PROP.CLASS.
* Native apps on Xbox (One, Series X/S)
** Only if UseSystemFocusVisuals is enabled
Android Ottium element properties
| Code |
Property description |
| BOUNDS |
Bounds of the element - top-left and bottom-right corners coordinates |
| CONTENT_DESC |
Value for accessibility services |
| HINT |
Element hint |
| IS_CHECKED_ANDROID_OTTIUM |
If the element is in a checked state |
| IS_CLICKABLE_ANDROID_OTTIUM |
If the element is clickable (reacts to click events) |
| IS_ENABLED_ANDROID_OTTIUM |
If the element is in an enabled state |
| IS_FOCUSABLE_ANDROID_OTTIUM |
If the element is able to change to a focus state |
| IS_FOCUSED_ANDROID_OTTIUM |
Is the element currently focused |
| IS_LONG_CLICKABLE_ANDROID_OTTIUM |
If given element is long clickable |
| IS_SCROLLABLE_ANDROID_OTTIUM |
If given element is scrollable |
| IS_SELECTED_ANDROID_OTTIUM |
If the element is currently in the selected state |
| PACKAGE |
Package name |
| RESOURCE_ID |
Resource ID |
| TEXT_CONTENT |
Textual content of the element |
Apple TV Ottium element properties
These element properties are available on Apple TV (tvOS) when using the Ottium communication method. IS_ACCESSIBLE and LABEL need suitest-js-api 4.3.0 or later.
| Code |
Property description |
| ACCESSIBILITY_IDENTIFIER |
Accessibility identifier of the element, or its label when no identifier is set (the name attribute) |
| HEIGHT |
Height of the element |
| IS_ACCESSIBLE |
If the element is exposed to accessibility services |
| IS_ENABLED |
If the element is in an enabled state |
| IS_FOCUSED |
If the element is currently focused |
| LABEL |
Element label |
| LEFT |
Horizontal position of the element |
| TAG |
Element type (the type attribute) |
| TEXT_CONTENT |
Textual content of the element (the value attribute) |
| TOP |
Vertical position of the element |
| VISIBILITY |
If the element is visible on screen, see element visibility states |
| WIDTH |
Width of the element |
Cookie properties
Cookie properties can be found in suitest.COOKIE_PROP.
| Code |
| VALUE |
| DOMAIN |
| PATH |
| HTTP_ONLY |
| SECURE |
Property comparators
Property comparators can be found in suitest.COMP.
| Code |
Comparator description |
| APPROX |
Approximately |
| CONTAIN |
Contains |
| END |
Ends with |
| EQUAL |
= |
| EQUAL_GREATER |
>= |
| EQUAL_LESSER |
<= |
| GREATER |
> |
| LESSER |
< |
| NOT_CONTAIN |
Does not contain |
| NOT_END |
Does not end with |
| NOT_EQUAL |
!= |
| NOT_START |
Does not start with |
| START |
Starts with |
Element special values
| Code |
Special value description |
| REPO |
Value for element property is taken from Element repository |
Video states
Video states can be found in suitest.VIDEO_STATE.
| Code |
State description |
HTML-Based |
Android |
Xbox * |
Apple TV |
Roku |
| BUFFERING |
Player is downloading video source over network to create a buffer |
✓ |
✓ |
- |
✓ |
✓ |
| CONNECTING |
Player is trying to connect to video source |
✓ |
- |
✓ |
- |
- |
| ERROR |
Error occurred during video initialization or playback |
✓ |
✓ |
✓ |
✓ |
✓ |
| FINISHED |
Playback has finished, video source was played till the end |
✓ |
- |
✓ |
✓ |
✓ |
| IDLE |
Video is in pre-preparing phase |
- |
✓ |
- |
- |
- |
| NONE |
There is no state of the video |
- |
- |
- |
- |
✓ |
| PAUSED |
Paused |
✓ |
✓ |
✓ |
✓ |
✓ |
| PLAYBACK_COMPLETED |
Playback has finished, video source was played till the end |
- |
✓ |
- |
- |
- |
| PLAYING |
Playing |
✓ |
✓ |
✓ |
✓ |
✓ |
| PREPARED |
Video is prepared for playback |
- |
✓ |
- |
- |
- |
| PREPARING |
Video is being prepared for playback |
- |
✓ |
- |
- |
- |
| REVERSING |
Video is being played in reverse |
- |
- |
- |
✓ |
- |
| STOPPED |
Playback stopped |
✓ |
- |
✓ |
- |
✓ (IL**) |
| UNKNOWN |
State cannot be obtained |
- |
✓ |
- |
- |
- |
* Native apps on Xbox (One, Series X/S)
** IL = Instrumentation library only
Element visibility states
Element visibility states can be found in suitest.VISIBILITY_STATE.
| Code |
State description |
Android |
Xbox Native * |
Apple TV Ottium |
| COLLAPSED |
Element is not visible |
- |
✓ |
- |
| GONE |
Element is not visible |
✓ |
✓ |
- |
| INVISIBLE |
Element is not visible |
✓ |
✓ |
✓ |
| VISIBLE |
Element is visible |
✓ |
✓ |
✓ |
* Xbox (One, Series X/S)
Image accuracy levels
The accuracy levels for images taken using image capture can be found in suitest.ACCURACY
OCR colors
The color of the text read by OCR using image capture can be found in suitest.OCR_COLOR
OCR languages
The language of the text read by OCR using image capture can be found in suitest.LANG
| Code |
| ARABIC |
| BULGARIAN |
| DANISH |
| DUTCH |
| ENGLISH |
| FINNISH |
| FRENCH |
| GERMAN |
| HEBREW |
| HUNGARIAN |
| ITALIAN |
| NORWEGIAN |
| POLISH |
| PORTUGUESE |
| RUSSIAN |
| SPANISH |
| SWEDISH |
| UKRAINIAN |
If you are missing a language needed for testing, please contact our customer support.
OCR read as
The specification of what part of the text read by OCR using image capture should be considered can be found in suitest.OCR_READ_AS
If no value is used, the whole text read by OCR is evaluated.
Network properties
Network properties can be found in suitest.NETWORK_PROP.
Network methods
Network methods can be found in suitest.NETWORK_METHOD.
| Code |
| CONNECT |
| DELETE |
| GET |
| HEAD |
| OPTIONS |
| PATCH |
| POST |
| PUT |
| TRACE |
Border style
Border style properties can be found in suitest.BORDER_STYLE.
| Code |
HTML-Based |
Apple TV (IL) |
| BEZEL |
- |
✓ |
| DASHED |
✓ |
- |
| DOTTED |
✓ |
- |
| DOUBLE |
✓ |
- |
| GROOVE |
✓ |
- |
| HIDDEN |
✓ |
- |
| INHERIT |
✓ |
- |
| INITIAL |
✓ |
- |
| INSET |
✓ |
- |
| NONE |
✓ |
✓ |
| OUTSET |
✓ |
- |
| RECTANGLE |
- |
✓ |
| RIDGE |
✓ |
- |
| ROUNDED |
- |
✓ |
| SOLID |
✓ |
- |
Launch modes (Android/LG webOS applications)
Launch modes can be found in suitest.LAUNCH_MODE.
Screen orientations (Android mobile/iOS/iPadOS devices)
Screen orientations can be found in suitest.SCREEN_ORIENTATION.
| Code |
Analogue in Test editor |
| PORTRAIT |
Portrait |
| PORTRAIT_REVERSED |
Portrait (upside down / reversed) |
| LANDSCAPE |
Landscape (left) |
| LANDSCAPE_REVERSED |
Landscape (right / reversed) |
Content Mode (Apple TV IL)
Content modes can be found in suitest.CONTENT_MODE.
| Code |
| BOTTOM |
| BOTTOM_LEFT |
| BOTTOM_RIGHT |
| CENTER |
| LEFT |
| REDRAW |
| RIGHT |
| SCALE_ASPECT_FILL |
| SCALE_ASPECT_FIT |
| SCALE_TO_FILL |
| TOP |
| TOP_LEFT |
| TOP_RIGHT |
State (Apple TV IL)
States can be found in suitest.ELEMENT_STATE. Check the Apple Developer guide for Focus and Selection for some visual examples.
| Code |
| APPLICATION |
| DISABLED |
| FOCUSED |
| HIGHLIGHTED |
| NORMAL |
| RESERVED |
| SELECTED |
Text Alignment (Apple TV IL)
Text alignment states can be found in suitest.TEXT_ALIGNMENT.
| Code |
| CENTER |
| JUSTIFIED |
| LEFT |
| NATURAL |
| RIGHT |