DateTime | InputEvent | dcAudio | dcDeviceInput | dcKeyEntry | dcRequest
AC | CCF | CLIPMODE | DATA | DCF | DEF | DEVICE | DRT | EVG | FD | FSO | JET | JTYPE | KQ | MEM | PERMIT | RIPL | SEEK | TT
Action identifiers.
| Name | Description |
|---|---|
| AC::Activate | |
| AC::Clear | |
| AC::Clipboard | |
| AC::CopyData | |
| AC::DataFeed | |
| AC::Deactivate | |
| AC::Disable | |
| AC::DragDrop | |
| AC::Draw | |
| AC::END | |
| AC::Enable | |
| AC::Flush | |
| AC::Focus | |
| AC::Free | |
| AC::FreePlacement | |
| AC::FreeWarning | |
| AC::GetKey | |
| AC::Hide | |
| AC::Init | |
| AC::Lock | |
| AC::LostFocus | |
| AC::Move | |
| AC::MoveToBack | |
| AC::MoveToFront | |
| AC::MoveToPoint | |
| AC::NewChild | |
| AC::NewObject | |
| AC::NewOwner | |
| AC::NewPlacement | |
| AC::Next | |
| AC::Prev | |
| AC::Query | |
| AC::Read | |
| AC::Redimension | |
| AC::Redo | |
| AC::Refresh | |
| AC::Rename | |
| AC::Reset | |
| AC::Resize | |
| AC::SaveImage | |
| AC::SaveSettings | |
| AC::SaveToObject | |
| AC::Seek | |
| AC::SetField | |
| AC::SetKey | |
| AC::Show | |
| AC::Signal | |
| AC::Undo | |
| AC::Unlock | |
| AC::Write |
Class categories
| Name | Description |
|---|---|
| CCF::AUDIO | Audio classes interface with audio hardware and drivers for audio playback and recording purposes. |
| CCF::COMMAND | Command classes perform specific procedures, like copying or moving a file, managing volumes or executing a program. |
| CCF::DATA | Data classes parse, query and manipulate data. |
| CCF::FILESYSTEM | FileSystem classes are based on file management and interaction with file based data. |
| CCF::GRAPHICS | Graphics classes provide graphics management and drawing services. |
| CCF::GUI | GUI classes are used in the development of graphical user interfaces. |
| CCF::IO | I/O classes manage hardware and software based input and output. |
| CCF::MISC | Miscellaneous classes do not fit into any of the other available categories. |
| CCF::MULTIMEDIA | Classes that represent more than one media type, e.g. video files. |
| CCF::NETWORK | Network classes interface with system drivers to simplify network communications. |
| CCF::SYSTEM | System classes are designed to provide low-level services related to system management. |
| CCF::TOOL | Tools provide interactive services for the user. |
Clipboard modes
| Name | Description |
|---|---|
| CLIPMODE::COPY | Copy from the clipboard. |
| CLIPMODE::CUT | Cut from the clipboard. |
| CLIPMODE::PASTE | Paste from the clipboard. |
Data codes
| Name | Description |
|---|---|
| DATA::AUDIO | Audio file data, recognised by the Sound class |
| DATA::CONTENT | Document content (between XML tags) - sent by document objects only |
| DATA::DEVICE_INPUT | Device activity |
| DATA::FILE | File location (the data will reflect the complete file path) |
| DATA::IMAGE | Image file data, recognised by the Image class |
| DATA::INPUT_READY | Device input that has been transformed into user input |
| DATA::RAW | Raw unprocessed data |
| DATA::RECEIPT | Receipt for item data, in response to an earlier request |
| DATA::RECORD | Database record |
| DATA::REQUEST | Make a request for item data |
| DATA::TEXT | Standard ASCII text |
| DATA::XML | Markup based text data. NOTE - For clipboard data, the top-level encapsulating tag must declare the type of XML, e.g. 'html', 'ripple'. For plain XML, use 'xml' |
Document flags
| Name | Description |
|---|---|
| DCF::DISABLED | This read-only flag is set if the UI has been disabled through the Disable action. |
| DCF::EDIT | Allow direct keyboard input and document editing. |
| DCF::NO_LAYOUT_MSG | Turn off debug output produced during document layout and processing - useful on refresh for example. |
| DCF::NO_SYS_KEYS | System-keys provide standard key support for Ctrl-C, Ctrl-X etc. Set this flag to turn them off. |
| DCF::OVERWRITE | This flag forces overwrite mode when the user enters information through the keyboard. If the flag is not set, then insert mode is used. |
| DCF::UNRESTRICTED | Turn off all security measures - may only be set prior to initialisation. |
Event flags for selectively receiving events from the Document object.
| Name | Description |
|---|---|
| DEF::LINK_ACTIVATED | The user has interacted with a hyperlink. This event can be cancelled by returning ERR::Skip. |
| DEF::ON_CLICK | The user has interacted with an element that has an on-click definition. |
| DEF::ON_CROSSING | Synonym for ON_CROSSING_IN | ON_CROSSING_OUT |
| DEF::ON_CROSSING_IN | The mouse pointer has crossed into an element. |
| DEF::ON_CROSSING_OUT | The mouse pointer has crossed out of an element. |
| DEF::ON_MOTION | The user has triggered a motion event in an element that supports motion monitoring. |
| DEF::PATH | The source file path has changed. Useful for detecting when the user has left the page. |
| DEF::WIDGET_STATE | The state value of a widget has changed (e.g. input, checkbox, text). name and value keys will be defined in the event parameters. |
| Name | Description |
|---|---|
| DEVICE::BOOKMARK | This marker indicates that the presented volume is a bookmark and not a device name. |
| DEVICE::COMPACT_DISC | Compact disc style device |
| DEVICE::FIXED | Catch-all for fixed media devices that are not directly identifiable. |
| DEVICE::FLOPPY_DISK | Floppy disk style device |
| DEVICE::HARD_DISK | Hard disk style device |
| DEVICE::MEMORY | Device is RAM, ROM, WORM, NVRAM, flashdisk or other form of memory. Does not guarantee a fast connection as it could be over a slow USB 1.1 connection for example |
| DEVICE::MODEM | Device is a modem. |
| DEVICE::NETWORK | Device represents a network link |
| DEVICE::PRINTER | Device is a paper-based printer. |
| DEVICE::PRINTER_3D | Device is a three dimensional printer. |
| DEVICE::READ | Device is readable |
| DEVICE::REMOVABLE | Device media is removable from the hardware |
| DEVICE::REMOVEABLE | Device media is removable from the hardware |
| DEVICE::SCANNER | Device is a two dimensional scanner. |
| DEVICE::SCANNER_3D | Device is a three dimensional scanner. |
| DEVICE::SOFTWARE | Device is virtual/software defined |
| DEVICE::TAPE | Tape/Stream style device |
| DEVICE::TEMPORARY | All storage is temporary |
| DEVICE::USB | Removable USB storage device. May be further qualified by HARD_DISK, FLOPPY_DISK etc |
| DEVICE::WRITE | Device is writeable |
Internal trigger codes
| Name | Description |
|---|---|
| DRT::AFTER_LAYOUT | |
| DRT::BEFORE_LAYOUT | |
| DRT::END | |
| DRT::GOT_FOCUS | |
| DRT::LEAVING_PAGE | |
| DRT::LOST_FOCUS | |
| DRT::PAGE_PROCESSED | |
| DRT::REFRESH | |
| DRT::USER_CLICK | |
| DRT::USER_CLICK_RELEASE | |
| DRT::USER_MOVEMENT |
Event categories.
| Name | Description |
|---|---|
| EVG::ANDROID | Android specific events that do not already fit existing categories. |
| EVG::APP | Custom event dispatched from an application |
| EVG::AUDIO | Audio system events. |
| EVG::CLASS | Custom event dispatched from a class that doesn't fit within the rest of the event framework |
| EVG::DISPLAY | Video display events. |
| EVG::FILESYSTEM | File system events. |
| EVG::GUI | Events generated by the Graphical User Interface. |
| EVG::HARDWARE | Hardware device events that are not covered by other types. |
| EVG::IO | Input/Output events. |
| EVG::NETWORK | Network events. |
| EVG::POWER | Power Management - can also include app-specific events relating to resource management. |
| EVG::SYSTEM | System-wide events |
| EVG::USER | User activity events (such as user login). |
Field descriptors.
| Name | Description |
|---|---|
| FD::ALLOC | Indicates the returned value is a dynamic allocation that needs to be manually freed (by default is a memory pointer, can be an object if combined with FD_OBJECT) |
| FD::ARRAY | Indicates an array of values. Function descriptors must combine this flag with CPP to represent a kt::vector; raw pointer arrays are unsupported for calls. |
| FD::BUFFER | FUNCDEF Overrides WRITE. Indicates a buffer that can be filled with data by the function if paired with RESULT; must be paired with BUFSIZE in second argument. |
| FD::BUFSIZE | FUNCDEF Overrides LOOKUP. Pair with BUFFER to indicate the byte size of the buffer memory. |
| FD::BYTE | 8 bit integer. |
| FD::CLASS_TYPES | All types that directly contribute to the core definition of a C/C++ type |
| FD::CPP | Use the C++ variant of the indicated type, e.g. ARRAY is a kt::vector. |
| FD::CUSTOM | |
| FD::DOUBLE | 64 bit float. |
| FD::DOUBLERESULT | For actions and methods |
| FD::ERROR | FUNCDEF |
| FD::FLAGS | CLASSDEF |
| FD::FLOAT | 32 bit float. Not valid for use in class definitions. |
| FD::FUNCTION | Intended for callbacks, uses the rkFunction structure. |
| FD::FUNCTIONPTR | Synonym for PTR | FUNCTION |
| FD::I | Synonym for INIT |
| FD::INIT | CLASSDEF |
| FD::INT | 32 bit integer. |
| FD::INT64 | 64 bit integer. |
| FD::INT64RESULT | For actions and methods |
| FD::INTRESULT | For actions and methods |
| FD::LOCAL | CLASSDEF Pointer to an object that is local to the class |
| FD::LOOKUP | CLASSDEF |
| FD::MUTABLE | FUNCDEF Overrides VIRTUAL. The function will overwrite incoming BUFFER or STRING content. If used in conjunction with the RESULT flag, an empty buffer is expected for output. |
| FD::NORMALISED | Supplementary, indicates a normalised float value for multiplicative scaling. |
| FD::OBJECT | Supplementary, can be used with ints (for IDs) or pointers |
| FD::OBJECTID | Synonym for INT | OBJECT |
| FD::OBJECTPTR | Synonym for PTR | OBJECT |
| FD::POINTER | Pointer (32 or 64 bit). |
| FD::PRIVATE | Synonym for SYSTEM |
| FD::PTR | Synonym for POINTER |
| FD::PTRBUFFER | The next argument should be INT|BUFSIZE |
| FD::PTRRESULT | Use for pointer-based value results only |
| FD::PTRSIZE | Synonym for BUFSIZE |
| FD::PTR_DOUBLERESULT | Use for pointer-based value results only. |
| FD::PTR_INT64RESULT | Use for pointer-based value results only. |
| FD::PTR_INTRESULT | Use for pointer-based value results only. |
| FD::PURE | Supplementary, indicates that the Getter function for a field is non-mutating and context free (inc. non-logging). |
| FD::R | Synonym for READ |
| FD::READ | CLASSDEF |
| FD::RESOURCE | The referenced struct or pointer is a special resource. Changes some behaviours, e.g. a resourced struct will use direct value references rather than being copied in Tiri. |
| FD::RESULT | FUNCDEF Overrides READ |
| FD::RI | Synonym for READ | INIT |
| FD::RW | Synonym for READ | WRITE |
| FD::SCALED | Synonym for NORMALISED |
| FD::STR | Synonym for STRING |
| FD::STRING | Pointer to a string. |
| FD::STRRESULT | Synonym for STR | RESULT |
| FD::STRUCT | Supplementary, defines the field as a structure reference. MUST be combined with FD_POINTER. If used in a class, it is possible to name the structure definition in field->Arg |
| FD::SYNONYM | CLASSDEF Use to declare fields that duplicate the functionality of another field. |
| FD::SYSTEM | CLASSDEF System, internal and private fields. |
| FD::TAGS | FUNCDEF Overrides INIT |
| FD::UNIT | A value that describes a display unit. |
| FD::UNSIGNED | Supplementary, integer value is unsigned. |
| FD::VARTAGS | FUNCDEF Overrides FLAGS. Use for 64-bit taglists that require value definitions, e.g. TDOUBLE, TINT etc. |
| FD::VIRTUAL | CLASSDEF Ensures that the field has no physical representation in the structure. |
| FD::VOID | |
| FD::W | Synonym for WRITE |
| FD::WORD | 16 bit integer. |
| FD::WRITE | CLASSDEF |
These are document style flags, as used in the DocStyle structure
| Name | Description |
|---|---|
| FSO::ALIGN_CENTER | Align to the centre. |
| FSO::ALIGN_RIGHT | Align to the right. |
| FSO::NO_WRAP | Do not wrap the text. |
| FSO::PREFORMAT | All white-space is taken into account. |
| FSO::STYLES | Synonym for UNDERLINE |
| FSO::UNDERLINE | Draw a line under the text. |
JET constants are documented in GetInputEvent()
| Name | Description |
|---|---|
| JET::ABS_XY | The X, Y values are defined as absolute coordinates, relative to the top-left of the display. |
| JET::BUTTON_1 | Left mouse button; XBox A button, PS square button. Value is pressure sensitive, ranging between 0 - 1.0 (0 is released, 1.0 is fully depressed). |
| JET::BUTTON_10 | Non-specific button assignment. |
| JET::BUTTON_2 | Right mouse button; XBox X button, PS cross button. |
| JET::BUTTON_3 | Middle mouse button; XBox Y button, PS triangle. |
| JET::BUTTON_4 | Alt. mouse button 1; XBox B button, PS circle. |
| JET::BUTTON_5 | Alt. mouse button 2. |
| JET::BUTTON_6 | Non-specific button assignment. |
| JET::BUTTON_7 | Non-specific button assignment. |
| JET::BUTTON_8 | Non-specific button assignment. |
| JET::BUTTON_9 | Non-specific button assignment. |
| JET::CROSSED_IN | This message is sent by the input system when the mouse pointer enters an area for the first time. The message value refers to the object ID of the container being monitored for movement. |
| JET::CROSSED_OUT | This message is sent by the input system when the mouse pointer leaves an area. The message value refers to the object ID of the container being monitored for movement. |
| JET::DEVICE_TILT_XY | Controller tilted on the X/Y axis. Value indicates angle, -ve = left, +ve = right |
| JET::DEVICE_TILT_Z | Controller is rising or falling. Value expressed as 'speed', |
| JET::DISPLAY_EDGE | Recently supplied input occurred at the edge of the display. |
| JET::PEN_TILT_XY | Pen tilt angle. 0 is pointing down directly with nib at bottom, 0.5 is 90 degrees, 1.0 is inversed (eraser at bottom) |
| JET::PRESSURE | Amount of pressure applied, ranges from 0 (none) to 1.0 (normal) and possibly higher if user presses hard enough |
| JET::WHEEL | Mouse wheel rotation - the value generally reflects the number of 'clicks' rotated on the wheel. |
| JET::WHEEL_TILT | Some mouse wheels can be tilted to the left or right. Ranges from -1.0 to +1.0 |
JTYPE flags are used to categorise input types.
| Name | Description |
|---|---|
| JTYPE::ANALOG | Analog movement (ranging from -1.0 to 1.0) |
| JTYPE::ANCHORED | Cursor has been anchored with LockCursor() |
| JTYPE::BUTTON | Input is a physical button or switch |
| JTYPE::CROSSING | Crossing events manage the entering and leaving of an area. |
| JTYPE::DBL_CLICK | Set by the input system if the Type is a button and the button has been clicked in quick succession so as to be classed as a double-click. |
| JTYPE::DIGITAL | D-Pad or digital joystick source (restricted to +/- 1) |
| JTYPE::DRAGGED | Set if sufficient movement occurred between the original click and its point of release (usually requires a 3 or more pixel difference). |
| JTYPE::DRAG_ITEM | This special flag is set by the input system if the pointer is click-dragging an object at the time of the event. |
| JTYPE::EXT_MOVEMENT | Extended or indirect movement information. This covers all types of movement that are unconnected to coordinate positioning - mouse wheel movement and pen tilt are two such examples. |
| JTYPE::MOVEMENT | X/Y coordinate movement only. Movement such as the wheel mouse spinning is not covered by this type as it does not influence the coordinate system. |
| JTYPE::REPEATED | Input is a repeated entry (i.e. user is holding down a button and a repetition timer is being triggered) |
| JTYPE::SECONDARY | Indicates to the receiver of this message that it is not the primary/original recipient |
Special qualifier flags
| Name | Description |
|---|---|
| KQ::ALT | Synonym for L_ALT | R_ALT |
| KQ::ALTGR | Synonym for R_ALT |
| KQ::CAPS_LOCK | Caps-Lock is on |
| KQ::COMMAND | Synonym for L_COMMAND | R_COMMAND |
| KQ::CONTROL | Synonym for L_CONTROL | R_CONTROL |
| KQ::CTRL | Synonym for L_CONTROL | R_CONTROL |
| KQ::DEAD_KEY | This key will be affected by a previously pressed dead-key |
| KQ::INFO | Synonym for REPEAT | RELEASED | PRESSED | NOT_PRINTABLE | CAPS_LOCK |
| KQ::INSTRUCTION_KEYS | Synonym for ALT | CONTROL |
| KQ::L_ALT | Left Alt is held |
| KQ::L_COMMAND | Left Logo/Special |
| KQ::L_CONTROL | Control Key is held |
| KQ::L_CTRL | Control Key is held |
| KQ::L_SHIFT | Left Shift is held |
| KQ::NOT_PRINTABLE | The represented key value is not printable |
| KQ::NUM_LOCK | NumLock is on |
| KQ::NUM_PAD | Identifies numeric keypad keys |
| KQ::PRESSED | Key is being held or tapped |
| KQ::QUALIFIERS | Synonym for SHIFT | COMMAND | ALT | CONTROL |
| KQ::RELEASED | The key is being released |
| KQ::REPEAT | This is a repeated key |
| KQ::R_ALT | Right Alt is held |
| KQ::R_COMMAND | Right Logo/Special |
| KQ::R_CONTROL | Control Key is held |
| KQ::R_CTRL | Control Key is held |
| KQ::R_SHIFT | Right Shift is held |
| KQ::SCR_LOCK | Scroll Lock is on |
| KQ::SHIFT | Synonym for L_SHIFT | R_SHIFT |
Memory types used by AllocMemory(). The lower 16 bits are stored with allocated blocks, the upper 16 bits are function-relative only.
| Name | Description |
|---|---|
| MEM::AUDIO | Identifies memory located on an audio device, such as a sound card. |
| MEM::CODE | Used for memory that can execute code. |
| MEM::DATA | The default type, DATA, is used to indicate a standard memory allocation from system RAM. |
| MEM::NO_CLEAR | Do not clear the memory on allocation (saves time). |
| MEM::READ | The memory is explicitly marked as readable. |
| MEM::READ_WRITE | Synonym for READ | WRITE |
| MEM::STRING | Identifies the memory content as a null terminated string, which aids diagnostics. |
| MEM::TEXTURE | Identifies non-displayable video memory, e.g. texture graphics. |
| MEM::UNTRACKED | Prevents the memory block from being tracked back to the current context. |
| MEM::VIDEO | Identifies video memory, such as the frame buffer. |
| MEM::WRITE | The memory is explicitly marked as writeable. |
Permission flags
| Name | Description |
|---|---|
| PERMIT::ALL_DELETE | Synonym for EVERYONE_DELETE |
| PERMIT::ALL_EXEC | Synonym for EVERYONE_EXEC |
| PERMIT::ALL_READ | Synonym for EVERYONE_READ |
| PERMIT::ALL_WRITE | Synonym for EVERYONE_WRITE |
| PERMIT::ARCHIVE | Marks the file for future backup. The flag should be cleared after the backup has succeeded. |
| PERMIT::DELETE | Owner can delete. If the file system does not support this, deletion is enabled via the WRITE flag. |
| PERMIT::EVERYONE_ACCESS | Synonym for EVERYONE_READ | EVERYONE_WRITE | EVERYONE_EXEC | EVERYONE_DELETE |
| PERMIT::EVERYONE_DELETE | Synonym for DELETE | GROUP_DELETE | OTHERS_DELETE |
| PERMIT::EVERYONE_EXEC | Synonym for EXEC | GROUP_EXEC | OTHERS_EXEC |
| PERMIT::EVERYONE_READ | Synonym for READ | GROUP_READ | OTHERS_READ |
| PERMIT::EVERYONE_READWRITE | Synonym for EVERYONE_READ | EVERYONE_WRITE |
| PERMIT::EVERYONE_WRITE | Synonym for WRITE | GROUP_WRITE | OTHERS_WRITE |
| PERMIT::EXEC | User/Owner can execute. |
| PERMIT::GROUP | Synonym for GROUP_READ | GROUP_WRITE | GROUP_EXEC | GROUP_DELETE |
| PERMIT::GROUPID | Allows executables to run with a set group id. |
| PERMIT::GROUP_DELETE | Group members can delete. |
| PERMIT::GROUP_EXEC | Group members can execute. |
| PERMIT::GROUP_READ | Group members can read. |
| PERMIT::GROUP_WRITE | Group members can write. |
| PERMIT::HIDDEN | Recommends that the file is hidden from view by default. |
| PERMIT::INHERIT | Inherit permissions from parent folder and logical OR them with preset permission flags. |
| PERMIT::META | Synonym for HIDDEN | PASSWORD | OFFLINE | NETWORK |
| PERMIT::NETWORK | File is hosted on another machine. |
| PERMIT::OFFLINE | File content for this networked file has not been cached on the local PC. |
| PERMIT::OTHERS | Synonym for OTHERS_READ | OTHERS_WRITE | OTHERS_EXEC | OTHERS_DELETE |
| PERMIT::OTHERS_DELETE | Others can delete. |
| PERMIT::OTHERS_EXEC | Others can execute. |
| PERMIT::OTHERS_READ | Others can read. |
| PERMIT::OTHERS_WRITE | Others can write. |
| PERMIT::PASSWORD | File is password protected. |
| PERMIT::READ | User/Owner has read access. This will not allow compiled code to be executed. |
| PERMIT::USER | Synonym for READ | WRITE | EXEC | DELETE |
| PERMIT::USERID | Allows executables to run with a set user id. |
| PERMIT::USER_EXEC | Synonym for EXEC |
| PERMIT::USER_READ | Synonym for READ |
| PERMIT::USER_WRITE | Synonym for WRITE |
| PERMIT::WRITE | User/Owner can write. |
Official version number (date format). Any changes to the handling of document content require that this number be updated.
| Name | Description |
|---|---|
| RIPL::VERSION |
Seek positions
| Name | Description |
|---|---|
| SEEK::CURRENT | Use an index at the end of the last read/write operation. |
| SEEK::END | Use an index at the end of the data buffer. |
| SEEK::RELATIVE | The index is between 0 and 1.0 and relative to the data size. |
| SEEK::START | Use an index at position zero. |
| Name | Description |
|---|---|
| TT::EDIT | |
| TT::LINK | |
| TT::VECTOR |
Generic structure for date-time management.
| Field | Type | Description |
|---|---|---|
| Year | INT16 | Year |
| Month | INT8 | Month 1 to 12 |
| Day | INT8 | Day 1 to 31 |
| Hour | INT8 | Hour 0 to 23 |
| Minute | INT8 | Minute 0 to 59 |
| Second | INT8 | Second 0 to 59 |
| TimeZone | INT8 | TimeZone -13 to +13 |
| Field | Type | Description |
|---|---|---|
| Next | const struct InputEvent * | Next event in the chain |
| Value | DOUBLE | The value associated with the Type |
| Timestamp | INT64 | PreciseTime() of the recorded input |
| RecipientID | OBJECTID | Surface that the input message is being conveyed to |
| OverID | OBJECTID | Surface that is directly under the mouse pointer at the time of the event |
| AbsX | DOUBLE | Absolute horizontal position of mouse cursor (relative to the top left of the display) |
| AbsY | DOUBLE | Absolute vertical position of mouse cursor (relative to the top left of the display) |
| X | DOUBLE | Horizontal position relative to the surface that the pointer is over - unless a mouse button is held or pointer is anchored - then the coordinates are relative to the click-held surface |
| Y | DOUBLE | Vertical position relative to the surface that the pointer is over - unless a mouse button is held or pointer is anchored - then the coordinates are relative to the click-held surface |
| DeviceID | OBJECTID | The hardware device that this event originated from |
| Type | JET | JET constant that describes the event |
| Flags | JTYPE | Broad descriptors for the given Type (see JTYPE flags). Automatically defined when delivered to the pointer object |
| Mask | JTYPE | Mask to use for checking against subscribers |
Data feed structure for Audio
| Field | Type | Description |
|---|---|---|
| Size | INT | Byte size of this structure |
| Format | INT | Format of the audio data |
| Field | Type | Description |
|---|---|---|
| Values | DOUBLE | The value(s) associated with the Type |
| Timestamp | INT64 | PreciseTime() of the recorded input |
| DeviceID | OBJECTID | The hardware device that this event originated from (note: This ID can be to a private/inaccessible object, the point is that the ID is unique) |
| Flags | JTYPE | Broad descriptors for the given Type. Automatically defined when delivered to the pointer object |
| Type | JET | JET constant |
Data feed structure for Keypress
| Field | Type | Description |
|---|---|---|
| Flags | INT | Shift/Control/CapsLock... |
| Value | INT | ASCII value of the key A/B/C/D... |
| Timestamp | INT64 | PreciseTime() at which the keypress was recorded |
| Unicode | INT | Unicode value for pre-calculated key translations |
Data feed item request
| Field | Type | Description |
|---|---|---|
| Item | INT | Identifier for retrieval from the source |
| Preference | INT8 | Data preferences for the returned item(s) |