Api session event editor cinematic: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Endpoint: api/session/event/editorcinematic/
<noinclude lang="text" copy>API Endpoint: api/session/event/editorcinematic/
 
</noinclude><noinclude lang="text" copy>
API Endpoints for [[Cinematic]] editing.
API Endpoints for [[Cinematic]] editing.
{|class=wikitable
</noinclude>{|class=wikitable
!Name
!Name
!Description
!Description
Line 18: Line 18:
| Set the name of a [[Cinematic]]
| Set the name of a [[Cinematic]]
|}
|}
 
<noinclude lang="text" copy>
Additional API Endpoints:
Additional API Endpoints:
{|class=wikitable
</noinclude>{|class=wikitable
!Name
!Name
!Description
!Description
Line 31: Line 31:
|-
|-
| [[Api session event editor cinematic add keypoint with parameters|add_keypoint_with_parameters]]
| [[Api session event editor cinematic add keypoint with parameters|add_keypoint_with_parameters]]
| Add a [[Key Point]] with the provided camera location, orientation and lookat in [[3D Visualization]] coordinates (X is east, Y is up, Z is south).
| Add a [[Key Point]] with the provided camera location, orientation and lookat in [[3D Visualization]] coordinates (X is east, Y is up, Z is south)
|-
|-
| [[Api session event editor cinematic duplicate keypoint|duplicate_keypoint]]
| [[Api session event editor cinematic duplicate keypoint|duplicate_keypoint]]
Line 49: Line 49:
|-
|-
| [[Api session event editor cinematic set keypoint orientation|set_keypoint_orientation]]
| [[Api session event editor cinematic set keypoint orientation|set_keypoint_orientation]]
| Set the camera location, orientation and lookat of a [[Key Point]] in [[3D Visualization]] coordinates (X is east, Y is up, Z is south).
| Set the camera location, orientation and lookat of a [[Key Point]] in [[3D Visualization]] coordinates (X is east, Y is up, Z is south)
|-
|-
| [[Api session event editor cinematic set keypoint paused|set_keypoint_paused]]
| [[Api session event editor cinematic set keypoint paused|set_keypoint_paused]]
Line 60: Line 60:
| Set the voice used for text-to-speech of Keypoint descriptions of a [[Cinematic]]
| Set the voice used for text-to-speech of Keypoint descriptions of a [[Cinematic]]
|}
|}
{{article end|seealso=*[[Api Session Endpoints]]
<noinclude lang="text" copy>{{article end|seealso=*[[Api Session Endpoints]]
*[[Api session items cinematicdatas]]
*[[Api session items cinematicdatas]]
}}
}}
 
</noinclude>
[[Category:API]]
[[Category:API]]

Latest revision as of 10:26, 13 November 2026

API Endpoint: api/session/event/editorcinematic/

API Endpoints for Cinematic editing.

Name Description
add Add a Cinematic for a Stakeholder
duplicate Duplicate existing Cinematic
remove Remove existing Cinematic
set_name Set the name of a Cinematic

Additional API Endpoints:

Name Description
add_keypoint Add a Key Point to a Cinematic
add_keypoint_event_bundle Add an Event Bundle to a Key Point of a Cinematic
add_keypoint_with_parameters Add a Key Point with the provided camera location, orientation and lookat in 3D Visualization coordinates (X is east, Y is up, Z is south)
duplicate_keypoint Duplicate a Key Point of a Cinematic
move_keypoint Move a Key Point to an index of the array of Key Points of a Cinematic
remove_keypoint Remove Key Points from Cinematics
remove_keypoint_event_bundle Remove an Event Bundle from a Key Point of a Cinematic
set_keypoint_description Set the description of a Key Point of a Cinematic
set_keypoint_orientation Set the camera location, orientation and lookat of a Key Point in 3D Visualization coordinates (X is east, Y is up, Z is south)
set_keypoint_paused Let the Key Point of a Cinematic pause the Cinematic once it is reached
set_keypoint_time Set the time it takes to move from the specified Key Point of a Cinematic to the next
set_voice Set the voice used for text-to-speech of Keypoint descriptions of a Cinematic