Api session event editor cinematic: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(18 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session event editor cinematic Events.
<noinclude lang="text" copy>API Endpoint: api/session/event/editorcinematic/
 
</noinclude><noinclude lang="text" copy>
[[Cinematic]] editing.
API Endpoints for [[Cinematic]] editing.
{|class=wikitable
</noinclude>{|class=wikitable
!Name
!Name
!Description
!Description
|-
|-
|[[Api session event editor cinematic add|ADD]]
| [[Api session event editor cinematic add|add]]
|Add new [[Cinematic]]
| Add a [[Cinematic]] for a [[Stakeholder]]
|-
|-
|[[Api session event editor cinematic duplicate|DUPLICATE]]
| [[Api session event editor cinematic duplicate|duplicate]]
|Duplicate existing [[Cinematic]]
| Duplicate existing [[Cinematic]]
|-
|-
|[[Api session event editor cinematic remove|REMOVE]]
| [[Api session event editor cinematic remove|remove]]
|Remove existing [[Cinematic]]
| Remove existing [[Cinematic]]
|-
|-
|[[Api session event editor cinematic set name|SET_NAME]]
| [[Api session event editor cinematic set name|set_name]]
|Set new name of existing [[Cinematic]]
| Set the name of a [[Cinematic]]
|}
|}
 
<noinclude lang="text" copy>
Specific Events:
Additional API Endpoints:
{|class=wikitable
</noinclude>{|class=wikitable
!Name
!Name
!Description
!Description
|-
|-
|[[Api session event editor cinematic add keypoint|ADD_KEYPOINT]]
| [[Api session event editor cinematic add keypoint|add_keypoint]]
|Add Keypoint
| Add a [[Key Point]] to a [[Cinematic]]
|-
|-
|[[Api session event editor cinematic add keypoint event bundle|ADD_KEYPOINT_EVENT_BUNDLE]]
| [[Api session event editor cinematic add keypoint event bundle|add_keypoint_event_bundle]]
|Add Keypoint [[Event Bundle]]
| Add an [[Event Bundle]] to a [[Key Point]] of a [[Cinematic]]
|-
|-
|[[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 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)
|-
|-
|[[Api session event editor cinematic duplicate keypoint|DUPLICATE_KEYPOINT]]
| [[Api session event editor cinematic duplicate keypoint|duplicate_keypoint]]
|Duplicate Keypoint
| Duplicate a [[Key Point]] of a [[Cinematic]]
|-
|-
|[[Api session event editor cinematic move keypoint|MOVE_KEYPOINT]]
| [[Api session event editor cinematic move keypoint|move_keypoint]]
|Move Keypoint
| Move a [[Key Point]] to an index of the array of [[Key Point]]s of a [[Cinematic]]
|-
|-
|[[Api session event editor cinematic remove keypoint|REMOVE_KEYPOINT]]
| [[Api session event editor cinematic remove keypoint|remove_keypoint]]
|Remove Keypoint
| Remove [[Key Point]]s from [[Cinematic]]s
|-
|-
|[[Api session event editor cinematic remove keypoint event bundle|REMOVE_KEYPOINT_EVENT_BUNDLE]]
| [[Api session event editor cinematic remove keypoint event bundle|remove_keypoint_event_bundle]]
|Remove Keypoint [[Event Bundle]]
| Remove an [[Event Bundle]] from a [[Key Point]] of a [[Cinematic]]
|-
|-
|[[Api session event editor cinematic set keypoint description|SET_KEYPOINT_DESCRIPTION]]
| [[Api session event editor cinematic set keypoint description|set_keypoint_description]]
|Set Keypoint Description
| Set the description of a [[Key Point]] of a [[Cinematic]]
|-
|-
|[[Api session event editor cinematic set keypoint orientation|SET_KEYPOINT_ORIENTATION]]
| [[Api session event editor cinematic set keypoint orientation|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)
|-
|-
|[[Api session event editor cinematic set keypoint paused|SET_KEYPOINT_PAUSED]]
| [[Api session event editor cinematic set keypoint paused|set_keypoint_paused]]
|Set Keypoint Paused
| Let the [[Key Point]] of a [[Cinematic]] pause the [[Cinematic]] once it is reached
|-
|-
|[[Api session event editor cinematic set keypoint time|SET_KEYPOINT_TIME]]
| [[Api session event editor cinematic set keypoint time|set_keypoint_time]]
|Set Keypoint [[Time]]
| Set the time it takes to move from the specified [[Key Point]] of a [[Cinematic]] to the next
|-
|-
|[[Api session event editor cinematic set voice|SET_VOICE]]
| [[Api session event editor cinematic set voice|set_voice]]
|Set Voice
| Set the voice used for text-to-speech of Keypoint descriptions of a [[Cinematic]]
|}
|}
{{article end|seealso=*[[Api Events]]
<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