Constants¶
Virtual Remote Control (VRC) button key codes¶
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.
| Code | Key name | Unicode value | IR-controlled | Android TV | Apple TV | LG webOS | Roku | Samsung Tizen | Sky | Vega | VIDAA | Vizio | Xfinity | Xumo |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| BACK | Back | \uE600 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| DOWN | Down | \uE5E0 |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| ENTER | Enter | \uE601 |
✓ | ✓ | - | ✓ | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| EXIT | Exit | \uE602 |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | ✓ | ✓ | ✓ | - |
| LEFT | Left | \uE5E1 |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| MENU | Menu | \uE5B1 |
✓ | ✓ | ✓ | ✓ | - | ✓ | - | - | ✓ | ✓ | ✓ | ✓ |
| OK | Ok | \uE5B2 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| POWER | Power | \uE5B4 |
✓ | - | - | ✓ | - | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| RIGHT | Right | \uE5E2 |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| SETTINGS | Settings | \uE5B6 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| UP | Up | \uE5E3 |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
Media buttons¶
See media buttons on VRC.
| Code | Key name | Unicode value | IR-controlled | Android TV | Apple TV | LG webOS | Roku | Samsung Tizen | Sky | Vega | *VIDAA | Vizio | Xfinity | Xumo |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| CH_DOWN | Channel down | \uE5F0 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| CH_UP | Channel up | \uE5F1 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| HOME | Home | \uE603 |
- | - | ✓ | ✓ | ✓ | ✓ | - | - | - | - | - | - |
| INFO | Info | \uE |
✓ | - | - | ✓ | - | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| MUTE | Mute | \uE521 |
✓ | ✓ | - | ✓ | ✓ | ✓ | - | - | ✓ | ✓ | ✓ | - |
| SMART | Smart | \uE5B7 |
✓ | ✓ | - | ✓ | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| SOURCE | Source / Input | \uE5B8 |
✓ | ✓ | - | ✓ | - | ✓ | - | - | ✓ | ✓ | ✓ | - |
| SPECIAL_NETFLIX | Netflix | \uE5D0 |
✓ | - | - | ✓ | - | ✓ | - | - | ✓ | ✓ | ✓ | - |
| SPECIAL_YOUTUBE | YouTube | \uE5D1 |
✓ | - | - | ✓ | - | ✓ | - | - | ✓ | ✓ | ✓ | - |
| VOL_DOWN | Volume down | \uE5F2 |
✓ | ✓ | - | ✓ | - | ✓ | - | - | ✓ | ✓ | ✓ | - |
| VOL_UP | Volume up | \uE5F3 |
✓ | ✓ | - | ✓ | - | ✓ | - | - | ✓ | ✓ | ✓ | - |
Color buttons¶
See color buttons on VRC.
| Code | Key name | Unicode value | IR-controlled | Android TV | Apple TV | LG webOS | Roku | Samsung Tizen | Sky | Vega | *VIDAA | Vizio | Xfinity | Xumo |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| BLUE | Blue | \uE500 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| GREEN | Green | \uE501 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| RED | Red | \uE502 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| YELLOW | Yellow | \uE503 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
Numerical buttons¶
| Code | Key name | Unicode value | IR-controlled | Android TV | Apple TV | LG webOS | Roku | Samsung Tizen | Sky | Vega | *VIDAA | Vizio | Xfinity | Xumo |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GUIDE | Guide | \uE5B0 |
✓ | ✓ | - | ✓ | ✓ | ✓ | - | - | ✓ | ✓ | ✓ | - |
| NUM_0 | Numpad 0 | \uE610 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| NUM_1 | Numpad 1 | \uE611 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| NUM_2 | Numpad 2 | \uE612 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| NUM_3 | Numpad 3 | \uE613 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| NUM_4 | Numpad 4 | \uE614 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| NUM_5 | Numpad 5 | \uE615 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| NUM_6 | Numpad 6 | \uE616 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| NUM_7 | Numpad 7 | \uE617 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| NUM_8 | Numpad 8 | \uE618 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| NUM_9 | Numpad 9 | \uE619 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| TELETEXT | Teletext | \uE528 |
✓ | ✓ | - | ✓ | ✓ | ✓ | - | - | ✓ | ✓ | ✓ | - |
Playback buttons¶
| Code | Key name | Unicode value | IR-controlled | Android TV | Apple TV | LG webOS | Roku | Samsung Tizen | Sky | Vega | *VIDAA | Vizio | Xfinity | Xumo |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| FAST_FWD | Fast forward | \uE520 |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| NEXT | Next | \uE52C |
✓ | - | - | ✓ | - | ✓ | - | - | ✓ | ✓ | ✓ | - |
| PAUSE | Pause | \uE522 |
✓ | ✓ | - | ✓ | - | ✓ | - | - | ✓ | ✓ | ✓ | - |
| PLAY | Play | \uE523 |
✓ | ✓ | - | ✓ | - | ✓ | - | - | ✓ | ✓ | ✓ | - |
| PLAY_PAUSE | Play/pause one button | \uE524 |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| PREVIOUS | Previous | \uE52B |
✓ | - | - | ✓ | - | ✓ | - | - | ✓ | ✓ | ✓ | - |
| RECORD | Record | \uE525 |
✓ | ✓ | - | ✓ | - | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| REWIND | Rewind | \uE52A |
✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| STOP | Stop | \uE527 |
✓ | ✓ | - | ✓ | - | ✓ | - | - | ✓ | ✓ | ✓ | - |
| TV | TV (switch to live TV) | \uE529 |
✓ | ✓ | - | ✓ | - | ✓ | - | - | ✓ | ✓ | ✓ | - |
Android specific buttons¶
| 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 |
✓ |
Apple TV specific buttons¶
| Code | Key name | Unicode value | Apple TV |
|---|---|---|---|
| SELECT | Select | \uE5B5 |
✓ |
Roku specific buttons¶
| Code | Key name | Unicode value | Android TV |
|---|---|---|---|
| A | A | \uE620 |
✓ |
| B | B | \uE621 |
✓ |
| REPLAY | Replay | \uE526 |
✓ |
Vega specific buttons¶
| 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.
| Code | Property description | HTML-based | Android IL | Vega (Ottium - All apps) | Xbox * | Apple TV | Roku (IL) | Roku (Ottium) |
|---|---|---|---|---|---|---|---|---|
| ACCESSIBILITY_IDENTIFIER | unique identifier for element in scripts using UI Automation interface | - | - | - | - | ✓ | - | - |
| ALPHA | Transparency level from 0 to 1 | - | ✓ | - | - | ✓ | - | - |
| AUTOMATION_ID | Uniquely identifies the element in UI automation tools | - | - | - | ✓ | - | - | - |
| AUTOMATION_NAME | Name of an element used in UI automation tools | - | - | - | ✓ | - | - | - |
| BAR_TINT_COLOR | Color applied to the bar's background | - | - | - | - | ✓ | - | - |
| BG_COLOR | Color applied to the element background | ✓ | ✓ | - | ✓ | ✓ | ✓ | - |
| BORDER_COLOR | Color applied to the border line of the element | ✓ | - | - | ✓ | - | - | - |
| BORDER_STYLE | Variant of the border line | ✓ | - | - | - | ✓ | - | - |
| BORDER_WIDTH | Width of the border line | ✓ | - | - | ✓ | - | - | - |
| CHILDREN | Element children count | - | - | - | - | - | - | ✓ |
| CLASS | Class attribute | ✓ | - | - | - | - | - | - |
| CONTENT_DESCRIPTION | Value for accessibility services | - | ✓ | - | - | - | - | - |
| DESCRIPTION | escription of the element | - | - | ✓ | - | - | - | - |
| CONTENT_MODE | States how element's content layout changes when bounds change | - | - | - | - | ✓ | - | - |
| EXTENDS | Extends element | - | - | - | - | - | - | ✓ |
| FOCUS_MARGIN | ✓** | - | - | - | ✓ | - | - | - |
| FOCUS_PRIMARY_COLOR | ✓** | - | - | - | ✓ | - | - | - |
| FOCUS_PRIMARY_WIDTH | ✓** | - | - | - | ✓ | - | - | - |
| FOCUS_SECONDARY_COLOR | ✓** | - | - | - | ✓ | - | - | - |
| FOCUS_SECONDARY_WIDTH | O✓** | - | - | - | ✓ | - | - | - |
| FONT_FAMILY | Font of text | - | - | - | ✓ | ✓ | - | - |
| FONT_NAME | name of the font name | - | - | - | - | ✓ | - | - |
| FONT_SIZE | Size of text | - | - | - | ✓ | ✓ | ✓ | - |
| FONT_URI | URI of font | - | - | - | - | - | ✓ | - |
| FONT_WEIGHT | Font weight of text | - | - | - | ✓ | - | - | - |
| HAS_FOCUS | Does the element have focus | - | ✓ | - | - | - | - | - |
| HAS_META_DATA | Video property has metadata | - | - | - | - | ✓ | - | - |
| HAS_NAV_MARKERS | Video property has navigation markers groups | - | - | - | - | ✓ | - | - |
| HEIGHT | Height of an element | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| HINT | Default text for editable text fields | - | ✓ | - | - | - | - | - |
| HREF | If the element is a link the href attribute will hold the URL | ✓ | - | - | - | - | - | - |
| ID | Id attribute of the element | ✓ | ✓ | - | - | - | ✓ | ✓ |
| IMAGE | URL of an image | ✓ | - | - | ✓ | - | ✓ | ✓ |
| IMAGE_HASH | Base64 string of the image converted to MD5 hash | - | ✓ | - | ✓ | ✓ | - | - |
| IMAGE_LOAD_STATE | Current status of the image state | ✓ | - | - | - | - | - | ✓ |
| INDEX | Value of index property | - | - | - | - | - | - | ✓ |
| IS_CHECKED | If the element is in a checked state | ✓ | ✓ | ✓ | ✓ | - | - | - |
| IS_CLICKABLE | If the element is clickable (reacts to click events) | - | ✓ | - | - | - | - | - |
| IS_COMPLETELY_DISPLAYED | If the complete view width and height is visible | - | ✓ | - | - | - | - | - |
| IS_ENABLED | If the element is in an enabled state | ✓ | ✓ | ✓ | ✓ | ✓ | - | - |
| IS_FOCUSABLE | If the element is able to change to a focus state | - | ✓ | ✓ | - | - | - | ✓ |
| IS_FOCUSED | Is the element currently focused | - | - | ✓ | ✓ | ✓ | ✓ | ✓ |
| IS_OPAQUE | Is the element currently opaque | - | - | - | - | ✓ | - | - |
| IS_SELECTED | If the element is currently in the selected state | ✓ | ✓ | - | ✓ | - | - | - |
| IS_TOUCHABLE | If the element has a touchable area | - | ✓ | - | - | - | - | - |
| ITEMS_FOCUSED | Element focused in list | - | - | - | - | - | ✓ | ✓ |
| LEFT | Relative horizontal position to the parent element (in pixels) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| LEFT_ABSOLUTE | Element's left coordinate according to window origin | - | - | - | ✓ | ✓ | - | - |
| MARGIN | Value of the margin space around the element | - | - | - | ✓ | - | - | - |
| NAME | Name given to the element | - | - | - | ✓ | ✓ | - | - |
| NUMBER_OF_SEGMENTS | The number of segments in Segmented Control | - | - | - | - | ✓ | - | - |
| OPACITY | Opacity of the element | ✓ | - | ✓ | ✓ | - | ✓ | ✓ |
| OFFSET_LEFT | Absolute horizontal position to the page (in pixels) | ✓ | - | - | - | - | - | - |
| OFFSET_TOP | Absolute vertical position to the page (in pixels) | ✓ | - | - | - | - | - | - |
| ORIENTATION_TEXT | Orientation of the textual content | - | - | ✓ | - | - | - | - |
| PACKAGE_NAME | Name-space of the view | - | ✓ | - | - | - | - | - |
| PADDING | Value of the element's padding in all directions | - | - | - | ✓ | - | - | - |
| PIVOT_X | The X coordinate around which the element is rotated | - | ✓ | - | - | - | - | - |
| PIVOT_Y | The Y coordinate around which the element is rotated | - | ✓ | - | - | - | - | - |
| PLACEHOLDER | String that is displayed when no text is in the input field | - | - | - | - | ✓ | - | - |
| PROPOSAL_URL | Video element that is proposed to be played next | - | - | - | - | ✓ | - | - |
| ROLE | Role of the element | - | - | ✓ | - | - | - | - |
| SCALE_X | The X coordinate around which the element is scaled | - | ✓ | - | - | - | - | - |
| SCALE_Y | The Y coordinate around which the element is scaled | - | ✓ | - | - | - | - | - |
| SELECTED_IMAGE_TINT_COLOR | Color applied to selected tab bar item | - | - | - | - | ✓ | - | - |
| STATE | Constant describing the state of the element | - | - | - | - | ✓ | - | - |
| TAG | String representation of the elements tag | - | ✓ | - | - | - | - | - |
| TAG_INT | Non-unique identifier for view objects | - | - | - | - | ✓ | - | - |
| TEST_ID | ID of the element for testing | - | - | ✓ | - | - | - | - |
| TEXT_ALIGNMENT | Alignment of text inside the element | - | - | - | - | ✓ | - | - |
| TEXT_COLOR | Color of the text | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| TEXT_CONTENT | Plain text of an element | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| TEXT_SIZE | Size of the elements text in pixels | - | ✓ | - | - | - | - | - |
| TINT_COLOR | Color tint of the element | - | - | - | - | ✓ | - | - |
| TOP | Relative vertical position to the parent element (in pixels) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| TOP_ABSOLUTE | Element's top coordinate according to the window origin | - | - | - | ✓ | ✓ | - | - |
| TRANSLATION_X | The horizontal location of the element relative to its left position | - | ✓ | - | - | - | - | - |
| TRANSLATION_Y | The vertical location of the element relative to its top position | - | ✓ | - | - | - | - | - |
| UI_ELEMENT_ID | Identifier for the element dialog-title | - | - | - | - | - | - | ✓ |
| URL | URL of WebView component | - | - | - | ✓ | - | - | - |
| VALUE | value of an input field | ✓ | - | - | - | - | - | - |
| VIDEO_LENGTH | Total length of a video | ✓ | ✓ | - | ✓ | ✓ | ✓ | - |
| VIDEO_POSITION | Current position of a video | ✓ | ✓ | - | ✓ | ✓ | ✓ | - |
| VIDEO_STATE | Current state of a video | ✓ | ✓ | - | ✓ | ✓ | ✓ | - |
| VIDEO_URL | URL of a video | ✓ | ✓ | - | ✓ | ✓ | ✓ | - |
| VISIBILITY | If the element is visible on screen | - | ✓ | - | ✓ | - | ✓ | ✓ |
| WIDTH | Width of the element | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Z_INDEX | Value of the CSS z-index property | ✓ | - | - | - | - | - | - |
* 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 |
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 * |
|---|---|---|---|
| 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
| Code |
|---|
| HIGH |
| MEDIUM |
| LOW |
OCR colors¶
The color of the text ready by OCR using image capture can be found in suitest.OCR_COLOR
| Code |
|---|
| DARK |
| LIGHT |
OCR languages¶
The language of the text read by OCR using image capture can be found in suitest.LANG
| Code |
|---|
| ARABIC |
| BULGARIAN |
| DUTCH |
| ENGLISH |
| FRENCH |
| GERMAN |
| HEBREW |
| ITALIAN |
| POLISH |
| PORTUGUESE |
| RUSSIAN |
| SPANISH |
| 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
| Code |
|---|
| LINE |
| WORD |
| BLOCK |
If no value is used, the whole text read by OCR is evaluated.
Network properties¶
Network properties can be found in suitest.NETWORK_PROP.
| Code |
|---|
| BODY |
| METHOD |
| STATUS |
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 |
|---|---|---|
| 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.
| Code |
|---|
| RESUME |
| RESTART |
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)¶
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)¶
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)¶
Text alignment states can be found in suitest.TEXT_ALIGNMENT.
| Code |
|---|
| CENTER |
| JUSTIFIED |
| LEFT |
| NATURAL |
| RIGHT |