Api session items cinematicdatas: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Interface administrators, Administrators
34,718 edits
No edit summary
No edit summary
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session items [[Cinematic]]datas Endpoints.
Api session items [[Cinematic]]datas Endpoints.


Manipulate items with event: [[Api session event editor |Api session event editor ]].
Edit items with event: [[Api session event editor cinematic|editorcinematic]].


Default Query:
Default Query:
Line 219: Line 219:
==Limit Queries==
==Limit Queries==
version=100:  
version=100:  
<pre>https://engine.tygron.com/api/session/items/cinematicdatas/?version=100&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/cinematicdatas/?version=100&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Show Queries==
max version:  
max version:  
<pre>https://engine.tygron.com/api/session/items/cinematicdatas/version/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/cinematicdatas/version/?token=API_TOKEN</syntaxhighlight>
size:  
size:  
<pre>https://engine.tygron.com/api/session/items/cinematicdatas/size/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/cinematicdatas/size/?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
<pre>https://engine.tygron.com/api/session/items/cinematicdatas/?f=HTML&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/cinematicdatas/?f=HTML&token=API_TOKEN</syntaxhighlight>
JSON:  
JSON:  
<pre>https://engine.tygron.com/api/session/items/cinematicdatas/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/cinematicdatas/?f=JSON&token=API_TOKEN</syntaxhighlight>
CSV:  
CSV:  
<pre>https://engine.tygron.com/api/session/items/cinematicdatas/?f=CSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/cinematicdatas/?f=CSV&token=API_TOKEN</syntaxhighlight>
SSV:  
SSV:  
<pre>https://engine.tygron.com/api/session/items/cinematicdatas/?f=SSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/cinematicdatas/?f=SSV&token=API_TOKEN</syntaxhighlight>
SMILE:  
SMILE:  
<pre>https://engine.tygron.com/api/session/items/cinematicdatas/?f=SMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/cinematicdatas/?f=SMILE&token=API_TOKEN</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<pre>https://engine.tygron.com/api/session/items/cinematicdatas/?f=ZIPJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/cinematicdatas/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/cinematicdatas/?f=ZIPSMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/cinematicdatas/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
==Api Model CinematicData==
API Model description of CinematicData
 
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|animateToStart
|boolean
|
|-
|animateToStartPoint
|boolean
|
|-
|endType
|EndType
|
|-
|id
|int
|
|-
|keyIndex
|int
|
|-
|keyPoints
|KeyPoint<nowiki>[]</nowiki>
|
|-
|localClientOnly
|boolean
|
|-
|name
|String
|
|-
|stakeholderID
|int
|
|-
|version
|int
|
|-
|voice
|String
|
|}
 
==Api Model EndType==
API Enumeration description of EndType
 
{|class=wikitable
!Name
!Description
|-
|SIMPLE
|
|-
|LOOP
|
|-
|WAIT_AT_END
|
|}
 
==Api Model KeyPoint==
API Model description of KeyPoint
 
{|class=wikitable
!Name
!Type
!Description
|-
|description
|String
|
|-
|direction
|Vector3d
|
|-
|eventBundlesIDs
|int<nowiki>[]</nowiki>
|[[Event Bundle]] ID
|-
|id
|int
|
|-
|location
|Vector3d
|
|-
|pause
|boolean
|
|-
|soundID
|int
|[[Sound]] ID
|-
|time
|double
|
|-
|up
|Vector3d
|
|}
 
==Api Model Vector3d==
API Model description of Vector3d
 
{|class=wikitable
!Name
!Type
!Description
|-
|x
|double
|
|-
|y
|double
|
|-
|z
|double
|
|}
 
{{article end|seealso=*[[Api Content Items]]
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor ]]
*[[Api session event editor cinematic]]
}}
}}


[[Category:API]]
[[Category:API]]
[[Category:Items]]

Latest revision as of 14:14, 24 April 2026

Api session items Cinematicdatas Endpoints.

Edit items with event: editorcinematic.

Default Query: 

https://engine.tygron.com/api/session/items/cinematicdatas/?f=JSON&token=API_TOKEN

Example Response: 

[ {
  "active" : false,
  "animateToStart" : false,
  "animateToStartPoint" : false,
  "endType" : "SIMPLE",
  "id" : 0,
  "keyIndex" : 0,
  "keyPoints" : [ {
    "description" : "Welcome to Api-test, first a flytrough to make you familiar with the area.",
    "direction" : {
      "x" : 285.356,
      "y" : 51.329113786870785,
      "z" : 285.356
    },
    "eventBundlesIDs" : [ ],
    "id" : 7,
    "location" : {
      "x" : 426.777,
      "y" : 148.56966681707473,
      "z" : 426.777
    },
    "pause" : true,
    "soundID" : -1,
    "time" : 4.0,
    "up" : {
      "x" : 0.0,
      "y" : 1.0,
      "z" : 0.0
    }
  }, {
    "description" : "",
    "direction" : {
      "x" : 300.0,
      "y" : 55.20368105299929,
      "z" : 250.0
    },
    "eventBundlesIDs" : [ ],
    "id" : 6,
    "location" : {
      "x" : 500.0,
      "y" : 144.91636178848591,
      "z" : 250.0
    },
    "pause" : false,
    "soundID" : -1,
    "time" : 4.0,
    "up" : {
      "x" : 0.0,
      "y" : 1.0,
      "z" : 0.0
    }
  }, {
    "description" : "",
    "direction" : {
      "x" : 285.356,
      "y" : 56.87688383945199,
      "z" : 214.644
    },
    "eventBundlesIDs" : [ ],
    "id" : 5,
    "location" : {
      "x" : 426.777,
      "y" : 151.54411246559837,
      "z" : 73.223
    },
    "pause" : false,
    "soundID" : -1,
    "time" : 4.0,
    "up" : {
      "x" : 0.0,
      "y" : 1.0,
      "z" : 0.0
    }
  }, {
    "description" : "You are now entering the neighborhood Klarenbeek.",
    "direction" : {
      "x" : 250.0,
      "y" : 49.06819152832031,
      "z" : 200.0
    },
    "eventBundlesIDs" : [ ],
    "id" : 4,
    "location" : {
      "x" : 250.0,
      "y" : 157.1198216847011,
      "z" : 0.0
    },
    "pause" : false,
    "soundID" : -1,
    "time" : 4.0,
    "up" : {
      "x" : 0.0,
      "y" : 1.0,
      "z" : 0.0
    }
  }, {
    "description" : "You are now entering the neighborhood Sonsbeek-Noord.",
    "direction" : {
      "x" : 214.644,
      "y" : 43.67911892845517,
      "z" : 214.644
    },
    "eventBundlesIDs" : [ ],
    "id" : 3,
    "location" : {
      "x" : 73.223,
      "y" : 146.51884792162025,
      "z" : 73.223
    },
    "pause" : false,
    "soundID" : -1,
    "time" : 4.0,
    "up" : {
      "x" : 0.0,
      "y" : 1.0,
      "z" : 0.0
    }
  }, {
    "description" : "You are now entering the neighborhood Hazegrietje.",
    "direction" : {
      "x" : 200.0,
      "y" : 42.794297238613694,
      "z" : 250.0
    },
    "eventBundlesIDs" : [ ],
    "id" : 2,
    "location" : {
      "x" : 0.0,
      "y" : 151.31980790483192,
      "z" : 250.0
    },
    "pause" : false,
    "soundID" : -1,
    "time" : 4.0,
    "up" : {
      "x" : 0.0,
      "y" : 1.0,
      "z" : 0.0
    }
  }, {
    "description" : "You are now entering the neighborhood Sonsbeek-Noord.",
    "direction" : {
      "x" : 214.644,
      "y" : 44.550744256307915,
      "z" : 285.356
    },
    "eventBundlesIDs" : [ ],
    "id" : 1,
    "location" : {
      "x" : 73.223,
      "y" : 136.94186375357887,
      "z" : 426.777
    },
    "pause" : false,
    "soundID" : -1,
    "time" : 4.0,
    "up" : {
      "x" : 0.0,
      "y" : 1.0,
      "z" : 0.0
    }
  }, {
    "description" : "You are now entering the neighborhood Onder de Linden.",
    "direction" : {
      "x" : 250.0,
      "y" : 51.85581020598716,
      "z" : 300.0
    },
    "eventBundlesIDs" : [ ],
    "id" : 0,
    "location" : {
      "x" : 250.0,
      "y" : 146.50577267733487,
      "z" : 500.0
    },
    "pause" : false,
    "soundID" : -1,
    "time" : 4.0,
    "up" : {
      "x" : 0.0,
      "y" : 1.0,
      "z" : 0.0
    }
  }, {
    "description" : "",
    "direction" : {
      "x" : 250.0,
      "y" : 50.98006374277967,
      "z" : 250.0
    },
    "eventBundlesIDs" : [ ],
    "id" : 8,
    "location" : {
      "x" : 250.0,
      "y" : 603.5534057617188,
      "z" : 251.0
    },
    "pause" : false,
    "soundID" : -1,
    "time" : 4.0,
    "up" : {
      "x" : 0.0,
      "y" : 1.0,
      "z" : 0.0
    }
  } ],
  "name" : "Welcome Cinematic",
  "stakeholderID" : -1,
  "version" : 1,
  "voice" : ""
} ]

Limit Queries

version=100: 

https://engine.tygron.com/api/session/items/cinematicdatas/?version=100&token=API_TOKEN

Show Queries

max version: 

https://engine.tygron.com/api/session/items/cinematicdatas/version/?token=API_TOKEN

size: 

https://engine.tygron.com/api/session/items/cinematicdatas/size/?token=API_TOKEN

Formats

HTML: 

https://engine.tygron.com/api/session/items/cinematicdatas/?f=HTML&token=API_TOKEN

JSON: 

https://engine.tygron.com/api/session/items/cinematicdatas/?f=JSON&token=API_TOKEN

CSV: 

https://engine.tygron.com/api/session/items/cinematicdatas/?f=CSV&token=API_TOKEN

SSV: 

https://engine.tygron.com/api/session/items/cinematicdatas/?f=SSV&token=API_TOKEN

SMILE: 

https://engine.tygron.com/api/session/items/cinematicdatas/?f=SMILE&token=API_TOKEN

ZIPJSON: 

https://engine.tygron.com/api/session/items/cinematicdatas/?f=ZIPJSON&token=API_TOKEN

ZIPSMILE: 

https://engine.tygron.com/api/session/items/cinematicdatas/?f=ZIPSMILE&token=API_TOKEN

Api Model CinematicData

API Model description of CinematicData

Name Type Description
active boolean
animateToStart boolean
animateToStartPoint boolean
endType EndType
id int
keyIndex int
keyPoints KeyPoint[]
localClientOnly boolean
name String
stakeholderID int
version int
voice String

Api Model EndType

API Enumeration description of EndType

Name Description
SIMPLE
LOOP
WAIT_AT_END

Api Model KeyPoint

API Model description of KeyPoint

Name Type Description
description String
direction Vector3d
eventBundlesIDs int[] Event Bundle ID
id int
location Vector3d
pause boolean
soundID int Sound ID
time double
up Vector3d

Api Model Vector3d

API Model description of Vector3d

Name Type Description
x double
y double
z double

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_items_cinematicdatas&oldid=78840"