Appearance
Data types
As every API message is received by Igloo Core Engine as a string, arguments are coerced to their target data type on being received.
string
Any string
number
Any number
boolean
Anything other than 0 is interpreted as true by Igloo Core Engine.
(e.g. 1, true, false, NO are all interpreted as true; 0 is interpreted as false).
AiContentType
ImageVideoText3D Model
AiJobId
AiJobStatus
UnknownIdlePendingInProgressCompletedDownloadedFailedCancelled
AiModelId
AnyUuid
intrinsicintrinsicintrinsicintrinsicintrinsicintrinsicintrinsicintrinsicintrinsicintrinsicintrinsicintrinsicintrinsic
AppViewCaptureMode
DefaultPowerPoint
ContentBankTileType
VIDEOIMAGESESSIONLAUNCHER
ContentFileType
videoimagepdfaudiomodelppt
ContentFileTypeUpload
imagevideopdfmodelviewerappview
ContentSessionListFilter
alldescriptionthumbnailsaveTimereadOnlytagscollections
EffectId
EffectType
InvertInputTranslationPerspectiveExtractionISFPlaneToEquirectangularFade
HeadPositionId
HeadPositionListFilter
allposition
IceErrorCode
notAuthorisedinvalidAddresssystemLockedinvalidEffectIdinvalidLayerIdinvalidSessionIdinvalidModelIdinvalidLaunchpadGridIdinvalidLaunchpadTileId
InputDeviceId
InputTranslationType
CubemapStereo Cubemap LeftStereo Cubemap RightGear VR LeftGear VR RightOculus VRYouTube VRFishEyeCross cubemapCross reversed cubemapSkyBox cubemapSkyBox reversed cubemap
IsfInputType
eventboollongfloatpoint2DcolorimageaudioaudioFFT
LaunchpadEventName
NoneShow Layer UIBack to Layer List
LaunchpadGridId
LaunchpadGridListFilter
allcolumnsrows
LaunchpadTileId
LaunchpadTileListFilter
allthumbnailtypecontentUUIDeventeventData
LaunchpadTileType
SessionTrigger
LayerId
LayerTemplateId
LayerType
All possible layer types.
IMAGEVIDEOSPOUTYOUTUBEWEBVIEWBLACKMAGICDATAPATHDIRECTSHOWMODELVIEWERNDIIGLOOWEBPDFLOOPBACKAPPVIEWCOMPOSITIONCONTENTBANKHOME
LayoutId
RegionId
SessionCollectionId
SessionDatabaseId
SessionId
SubLayerType
IMAGEVIDEOSPOUTYOUTUBEWEBVIEWBLACKMAGICDATAPATHDIRECTSHOWMODELVIEWERNDIIGLOOWEBPDFLOOPBACKAPPVIEW
TagDatabaseId
TATriggerId
TextureSharerId
RecordNDISpout
CursorType
Members
| Name | Value | Description |
|---|---|---|
| Arrow | 0 | |
| Forbidden | 11 | |
| Hand_Grab | 4 | |
| Hand_Point | 3 | |
| Highlight_Sphere | 9 | |
| Invisible | 13 | |
| Move | 2 | |
| Num_Types | 12 | |
| Plus | 10 | |
| Size_Horizontal | 5 | |
| Size_LeftDiagonal | 8 | |
| Size_RightDiagonal | 7 | |
| Size_Vertical | 6 | |
| TextPointer | 1 |
PlaybackState
Members
| Name | Value | Description |
|---|---|---|
| Buffering | Buffering | |
| Done | Done | |
| None | None | |
| Paused | Paused | |
| Playing | Playing | |
| Stopped | Stopped |
PositionMode
Constraints on content positioning
Members
| Name | Value | Description |
|---|---|---|
| Free | 2 | No restriction on content movement |
| LockToContainer | 0 | Don't allow content to move outside its container (which is the canvas, unless wrapped by another container) |
| LockToRegion | 1 | Don't allow content to move outside its defined canvas region |