-
Notifications
You must be signed in to change notification settings - Fork 8
OSC API
Kards v1.2 and newer listens on port 25518 (beer) and largely speaking follows the same format as the Kards config object. Currently there are no OSC replies although if it's popular then we can look to add this.
All variables get converted to the correct type, so for example to set a Boolean value to true, you can pass a "1" as an integer. False would be 0. Strings should be passed in double quotes (") and numbers as integer or decimal numbers without quotes.
We have also implemented a few shortcuts for ease, along with multiple ways to do the same thing. For details just look at osc.js.
/visible 1 - Turn on card output
/enabled 1 - as above
/enable - Turn on output
/disable - Turn off output
/animated or /motion with a 1 or 0 will control motion.
/showInfo controls the information overlay.
/cardType followed by a string will set the card type. The options are:
"alteka", "bars", "grid", "led", "ramp", "placeholder", "audioSync", "deghost"
/name "PPT Main" will set the name that is displayed on the card (or read out by audio).
/screen 123456 - Sets the active screen by the screen's ID number. Getting this ID number for your setup is a little complicated but the easiest way at the moment is select the screen, export the settings and see what screen is set to. Or you can look at the log file that Kards creates.
/windowed 1 or 0 - Controls windowed or fullscreen output mode
/window/width 1280 - Controls the width of the window
/window/height 720 - Controls the height of the window
/fullsize 1 or 0 - controls if the test card fills the entire screen, or a region of it.
If /fullsize is set to 0, then the card has more controls which are as follows:
/notFilledCard/width 1280 - sets the width of the card
/notFilledCard/height 720 - sets the height of the card
/notFilledCard/top 100 - sets the gap from the top of the screen to the top edge of the card
/notFilledCard/left 100 - sets the gap from the left of the screen to the left edge of the card
/notFilledCard/bounds 1 or 0 - Shows/Hides the bounds of the screen, underneath the card
Then each card has it's own endpoints for the configuration variables.
/alteka/logo "base64" - You can pass a base64 encoded image (jpg, png, gif)
/alteka/showLogo 1 or 0 - Enable to disable the custom logo
/alteka/bg or /alteka/background "6ab42f" - Sets the background colour
/alteka/fg or /alteka/foreground "6ab42f" - Sets the foreground colour
/alteka/text "6ab42f"` - Sets the text colour
/alteka/gradient 1 or 0 - Enabled the gradient on the background layer
/bars/type "arib" - Accepts "arib", "simple", "smpte" or "hdr"
/bars/level 75 - Sets the IRE percentage of the simple bars.
/bars/overlay 1 or 0 - Shows or hides the detail overlay
/grid/bg or /grid/background "6ab42f" sets the background colour
/grid/crosshair "6ab42f" sets the crosshair colour
/grid/lines "6ab42f" sets the colour of the lines
/grid/circles 1 or 0 - Show or hide the circles
/grid/size 50 - Sets pixel size of the grid
/led/width 128 - sets the width of an individual panel
/led/height 128 - sets the height of an individual panel
/led/rows 6 - sets the number of rows for your LED wall
/led/columns 4 - sets the number of columns for your led wall
/ramp/direction "Horizontal" - Sets the direction of the ramp. Also accepts "Vertical", "Horizontal", "Diagonal", "Radial"
/ramp/reverse 1 or 0 - Sets the direction reverse setting
/ramp/stepped 1 or 0 - Sets the stepped setting
/ramp/double 1 or 0 - Sets the double setting
The original name of this card layout was 'Placeholder' as it was intended for E2 operators and the like. However it grew popular so it was renamed to 'name'. All the OSC endpoints are duplicated with both names.
/placeholder/bg or /placeholder/background or /name/bg or /name/background "6ab42f" will set the background colour
/placeholder/fg or /placeholder/foreground or /name/fg or /name/foreground "6ab42f" will set the foreground colour
/placeholder/gradient or /name/gradient 1 or 0 - Will set the gradient effect on the background
/placeholder/icon or /name/icon "fa-book" will set the icon based on fontawesome
/placeholder/custom or /name/custom "fa-book" will set the custom icon type based on fontawesome
/audioSync/device "deviceId" - Sets the audio device used by it's Chromium Device ID. This can be found by exporting the settings to a file.
/audioSync/rate 60 - Sets the frame rate, options as per the app, as a number.
/deghost/density 50 - Sets the density of the dots
/deghost/speed 5 - Sets the speed
All colour pickers have a few predefined colour swatches to pick from. You can configure these using:
/predefinedColors/5 "6ab42f" for example.
/audio/device or /audio/deviceId "1234" - Sets the audio device used by it's Chromium device ID. This can be found by exporting the settings to a file.
/audio/enabled 1 or 0 - Enable the test audio output.
/audio/options/add "voice" to add audio output modes to the list
/audio/options/remove "voice" to remove output modes. The possible options are: "stereo", "phase", "pink", "white", "tone", "voice", "text" and "file"
/audio/prependText "This is" - sets the text used in "voice" before the /name setting.
/audio/text "Custom text" - sets the text used for the "text" option.
/audio/file "Path/to/file" - sets the custom file