Message reference ​

All recognised messages.

Arguments tables on these pages show all arguments that can be either sent or received.

At the moment, some common sense is required to infer from here what arguments are required. e.g., when sending a get message, you do not need to include a value property - this is only required when setting.

Messages ​

• app/ai/cancelJob
• app/ai/availableModels
• app/ai/generate
• app/ai/jobList
• app/ai/jobStatus
• app/ai/modelSettings
• app/ai/preferredModels
• app/audio/mute
• app/audio/volume
• app/authorised
• app/ping
• app/pong
• app/systemMonitor
• app/truePerspectiveHeadPosition
• app/version
• app/truePerspective/headPosition/applied
• app/truePerspective/headPositionList
• content/file/added
• content/file/updated
• content/file/removed
• content/layerTemplate/quickAddList
• content/fileList
• content/layerTemplateList
• content/sessionCollectionList
• content/sessionList
• content/tagList
• content/session/description
• content/session/layers
• content/session/name
• content/session/readOnly
• content/session/saveTime
• content/session/tags
• content/session/thumbnailPath
• content/session/userGroupIds
• content/session/remove
• database/content/add
• error
• inputDevice/general/isEnabled
• inputDevice/general/isReady
• inputDevice/general/regionConstraints
• inputDevice/button
• inputDevice/buttons
• inputDevice/canvasPosition/absolute
• inputDevice/canvasPosition/normalised
• inputDevice/characters
• inputDevice/key
• inputDevice/move
• inputDevice/position
• inputDevice/remove
• inputDevice/rotation
• inputDevice/scroll
• inputDevice/transform
• inputDevice/style/colour
• inputDevice/style/size
• inputDevice/style/type
• inputDeviceList
• launchpad/grid/columns
• launchpad/grid/name
• launchpad/grid/rows
• launchpad/grid/tileList
• launchpad/activeGrid
• launchpad/gridList
• launchpad/newGrid
• launchpad/onTileLaunched
• launchpad/reorderGrids
• launchpad/tile/appendSession
• launchpad/tile/contentID
• launchpad/tile/event
• launchpad/tile/eventData
• launchpad/tile/index
• launchpad/tile/launch
• launchpad/tile/name
• launchpad/tile/thumbnail
• launchpad/tile/type
• layer/contextual/activeTile
• layer/contextual/add
• layer/contextual/allowPopups
• layer/contextual/audioChannels
• layer/contextual/autoMaxResolution
• layer/contextual/back
• layer/contextual/backgroundColour
• layer/contextual/buffers
• layer/contextual/captureCandidateList
• layer/contextual/captureMode
• layer/contextual/captureTitle
• layer/contextual/customFPS
• layer/contextual/dynamicRes
• layer/contextual/exactTitleMatch
• layer/contextual/filepath
• layer/contextual/format
• layer/contextual/forward
• layer/contextual/fpsIndex
• layer/contextual/fpsList
• layer/contextual/gridCount
• layer/contextual/gridSize
• layer/contextual/inputList
• layer/contextual/listPlayer
• layer/contextual/listPlayerLoop
• layer/contextual/load
• layer/contextual/loopbackLayerId
• layer/contextual/modelFilepath
• layer/contextual/modelScale
• layer/contextual/name
• layer/contextual/numPages
• layer/contextual/numSlides
• layer/contextual/orbitCameraDistance
• layer/contextual/orbitCameraPitch
• layer/contextual/orbitCameraYaw
• layer/contextual/page
• layer/contextual/preset
• layer/contextual/refresh
• layer/contextual/resampling
• layer/contextual/resolution
• layer/contextual/resolutionIndex
• layer/contextual/resolutionList
• layer/contextual/selectPage
• layer/contextual/sender
• layer/contextual/senderList
• layer/contextual/showCursor
• layer/contextual/size
• layer/contextual/slide
• layer/contextual/startPage
• layer/contextual/startSlide
• layer/contextual/subLayerList
• layer/contextual/supported
• layer/contextual/tileList
• layer/contextual/toStartPage
• layer/contextual/toStartSlide
• layer/contextual/type
• layer/contextual/url
• layer/contextual/useAlpha
• layer/contextual/useCustomFPS
• layer/contextual/zoom
• layer/contextual/zoomIn
• layer/contextual/zoomOut
• layer/effect/fade/duration
• layer/effect/fade/mode
• layer/effect/fade/restart
• layer/effect/fade
• layer/effect/invert/axis
• layer/effect/invert
• layer/effect/isf/customOutputSize
• layer/effect/isf/filename
• layer/effect/isf/input
• layer/effect/isf/outputSizeType
• layer/effect/isf/refresh
• layer/effect/isf
• layer/effect/planeToEquirectangular/pitch
• layer/effect/planeToEquirectangular
• layer/effect/planeToEquirectangular/scale
• layer/effect/planeToEquirectangular/yaw
• layer/effect/add
• layer/effect/fishEye
• layer/effect/inputTranslation
• layer/effect/moveDown
• layer/effect/moveUp
• layer/effect/remove
• layer/effect/truePerspective/heading
• layer/effect/truePerspective/headPosition
• layer/effect/truePerspective/headPositionEnabled
• layer/effect/truePerspective/pitch
• layer/effect/truePerspective/pitchDirection
• layer/effect/truePerspective/quality
• layer/effect/truePerspective
• layer/effect/truePerspective/showRotationGuide
• layer/effect/truePerspective/verticalStretchEnabled
• layer/effect/truePerspective/verticalStretchOffset
• layer/effect/truePerspective/verticalStretchScale
• layer/effectList/clear
• layer/effectList
• layer/general/alwaysOnTop
• layer/general/background
• layer/general/enabled
• layer/general/enableHomeLayer
• layer/general/name
• layer/general/pin
• layer/general/type
• layer/general/uiEnabled
• layer/general/isReady
• layer/general/stereo3D
• layer/geometry/aspectRatio
• layer/geometry/cropSize
• layer/geometry/customRatio
• layer/geometry/layout
• layer/geometry/maximise
• layer/geometry/moveToRegion
• layer/geometry/position
• layer/geometry/positionMode
• layer/geometry/region
• layer/geometry/reset
• layer/geometry/resizeMode
• layer/geometry/scale
• layer/geometry/size
• layer/geometry/startCrop
• layer/geometry/stretch
• layer/geometry/wrap
• layer/misc/addMetadata
• layer/misc/clearColour
• layer/misc/metadata
• layer/misc/removeMetadata
• layer/playback/autoPlay
• layer/playback/back
• layer/playback/diagnostics
• layer/playback/duration
• layer/playback/endTime
• layer/playback/forward
• layer/playback/frameProcessingTime
• layer/playback/loop
• layer/playback/mute
• layer/playback/pause
• layer/playback/play
• layer/playback/playhead
• layer/playback/seeking
• layer/playback/skipBackward
• layer/playback/skipForward
• layer/playback/speed
• layer/playback/startDiagnostics
• layer/playback/startTime
• layer/playback/state
• layer/playback/stop
• layer/playback/stopDiagnostics
• layer/playback/volume
• layer/add
• layer/clone
• layer/export
• layer/import
• layer/moveAbove
• layer/moveBelow
• layer/moveDown
• layer/moveUp
• layer/remove
• layer/reset
• layer/select
• layer/selectNext
• layer/toBack
• layer/toFront
• layerList/clear
• layerList/removeUnpinned
• layerList
• layout/regionList
• layoutList
• session/general/description
• session/general/homeGridTileIds
• session/general/layerIds
• session/general/name
• session/general/readOnly
• session/general/tagIds
• session/general/thumbnailPath
• session/general/userGroupIds
• session/layer/add
• session/layer/remove
• session/layerList/clear
• session/layerList
• session/misc/deleteSessionFromHomeGrid
• session/misc/submitSessionToLayer
• session/add
• session/clear
• session/export
• session/import
• session/load
• session/new
• session/remove
• session/save
• session/saveAs
• sessionList
• ta/trigger
• textureShare/contextual/screenshotStereo3D
• textureShare/contextual/onScreenshotTaken
• textureShare/contextual/screenshotPath
• textureShare/contextual/takeScreenshot
• workspace/stereo3D
• workspace/loadTemplate
• workspace/muteHiddenLayers
• workspace/immersiveMode