Skip to content
On this page

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

  • Image
  • Video
  • Text
  • 3D Model

AiJobId

AiJobStatus

  • Unknown
  • Idle
  • Pending
  • InProgress
  • Completed
  • Downloaded
  • Failed
  • Cancelled

AiModelId

AnyUuid

  • intrinsic
  • intrinsic
  • intrinsic
  • intrinsic
  • intrinsic
  • intrinsic
  • intrinsic
  • intrinsic
  • intrinsic
  • intrinsic
  • intrinsic
  • intrinsic
  • intrinsic

AppViewCaptureMode

  • Default
  • PowerPoint

ContentBankTileType

  • VIDEO
  • IMAGE
  • SESSIONLAUNCHER

ContentFileType

  • video
  • image
  • pdf
  • audio
  • model
  • ppt

ContentFileTypeUpload

  • image
  • video
  • pdf
  • modelviewer
  • appview

ContentSessionListFilter

  • all
  • description
  • thumbnail
  • saveTime
  • readOnly
  • tags
  • collections

EffectId

EffectType

  • Invert
  • InputTranslation
  • PerspectiveExtraction
  • ISF
  • PlaneToEquirectangular
  • Fade

HeadPositionId

HeadPositionListFilter

  • all
  • position

IceErrorCode

  • notAuthorised
  • invalidAddress
  • systemLocked
  • invalidEffectId
  • invalidLayerId
  • invalidSessionId
  • invalidModelId
  • invalidLaunchpadGridId
  • invalidLaunchpadTileId

InputDeviceId

InputTranslationType

  • Cubemap
  • Stereo Cubemap Left
  • Stereo Cubemap Right
  • Gear VR Left
  • Gear VR Right
  • Oculus VR
  • YouTube VR
  • FishEye
  • Cross cubemap
  • Cross reversed cubemap
  • SkyBox cubemap
  • SkyBox reversed cubemap

InvertEffectAxis

axis to apply inversion effect on

  • X
  • Y

IsfInputType

  • event
  • bool
  • long
  • float
  • point2D
  • color
  • image
  • audio
  • audioFFT

LaunchpadEventName

  • None
  • Show Layer UI
  • Back to Layer List

LaunchpadGridId

LaunchpadGridListFilter

  • all
  • columns
  • rows

LaunchpadTileId

LaunchpadTileListFilter

  • all
  • thumbnail
  • type
  • contentUUID
  • event
  • eventData

LaunchpadTileType

  • Session
  • Trigger

LayerId

LayerTemplateId

LayerType

All possible layer types.

  • IMAGE
  • VIDEO
  • SPOUT
  • YOUTUBE
  • WEBVIEW
  • BLACKMAGIC
  • DATAPATH
  • DIRECTSHOW
  • MODELVIEWER
  • NDI
  • IGLOOWEB
  • PDF
  • LOOPBACK
  • APPVIEW
  • COMPOSITION
  • CONTENTBANK
  • HOME

LayoutId

RegionId

SessionCollectionId

SessionDatabaseId

SessionId

SubLayerType

  • IMAGE
  • VIDEO
  • SPOUT
  • YOUTUBE
  • WEBVIEW
  • BLACKMAGIC
  • DATAPATH
  • DIRECTSHOW
  • MODELVIEWER
  • NDI
  • IGLOOWEB
  • PDF
  • LOOPBACK
  • APPVIEW

TagDatabaseId

TATriggerId

TextureSharerId

  • Record
  • NDI
  • Spout

ApiVersion

Members

NameValueDescription
latestlatest
VERSION_11.3.0
VERSION_21.4.0

AspectRatio

Members

NameValueDescription
Container1
Custom2
Source0

CursorType

Members

NameValueDescription
Arrow0
Forbidden11
Hand_Grab4
Hand_Point3
Highlight_Sphere9
Invisible13
Move2
Num_Types12
Plus10
Size_Horizontal5
Size_LeftDiagonal8
Size_RightDiagonal7
Size_Vertical6
TextPointer1

IsfOutputSize

Members

NameValueDescription
Canvas1
Custom2
Input0

PlaybackState

Members

NameValueDescription
BufferingBuffering
DoneDone
NoneNone
PausedPaused
PlayingPlaying
StoppedStopped

PositionMode

Constraints on content positioning

Members

NameValueDescription
Free2No restriction on content movement
LockToContainer0Don't allow content to move outside its container (which is the canvas, unless wrapped by another container)
LockToRegion1Don't allow content to move outside its defined canvas region

ResizeMode

Members

NameValueDescription
Auto0
FitHeight1
FitWidth2

StereoFormat

Members

NameValueDescription
Mono0
SideBySide2
TopBottom1