CRI ADX  Last Updated: 2024-07-17 10:47 p
Preview Module

The "preview" module is a module that manages the functions for performing preview.

Module name

cri.atomcraft.preview

The following functions are defined as:

Function Description Operation object
start_playback_cue Plays the specified Cue Cue
stop_all Stops all playing Cues -
start_ingame_preview Start the in-game connection -
stop_ingame_preview Stop the in-game connection -



start_playback_cue

Plays the specified Cue.

Format

result = start_playback_cue(cue)

Input parameter

Name Value
cue Cue object

Return value

Name Value
result [ "succeed" ] True if succeed, False if failed



stop_all

Stops all playing Cues.

Format

result = stop_all()

Input parameter

None

Return value

Name Value
result [ "succeed" ] True if succeed, False if failed

start_ingame_preview

Starts an in-game connection.
The following strings can be specified for target. Case is not significant.

"pc", "public", "android", "iphone", "xboxone", "xbox360", "ps4", "ps5", "switch"

Please specify a string for ip_address.

Note
When using start_profiler_logging , processing may be blocked for a while after returning from start_ingame_preview.
Please insert a sleep using the time.sleep() function before calling start_profiler_logging.

Format

result = start_ingame_preview(target, ip_address)

Input parameters

name value
target Target to connect to
ip_address IP address to connect to

Return values ??

name value
result [ "succeed" ] True if successful, False if unsuccessful

stop_ingame_preview

Stops the in-game connection.

Format

result = stop_ingame_preview()

Input parameters

None

Return value

name value
result [ "succeed" ] True if successful, False if unsuccessful