previous blog<\/a>) to select the bit depth, number of channels, and duration arguments.<\/p>\nThe duration will only be used if the GameSynth patch is infinite, which is determined by calling the \u201cis_infinite\u201d command of the GameSynth API.
\nThen, \u00a0if the patch is not infinite or a duration has been set, the rendering command can be sent to GameSynth.<\/p>\n
\r\n#Check if the patch is infinite\r\ns.send(\"is_infinite\".encode('utf-8'))\r\nis_infinite_result = s.recv(28542).decode('utf-8')\r\nis_infinite_result = int(str(is_infinite_result).replace(\"\\r\", \"\"))\r\n\r\nif ((is_infinite_result == 0) or (is_infinite_result == 1 and DURATION > 0)):\r\n gsapi_render_patch = f\"render_patch \\\"{gs_wav_path}\\\" {BITDEPTH} {CHANNELS} {DURATION}\"\r\n s.send(gsapi_render_patch.encode('utf-8'))\r\n \r\nelse:\r\n acdebug.warning(\"The patch is infinite, please set a duration higher than 0.\")\r\n s.close()\r\n acdebug.log(\"*** Disconnected from the GameSynth Tool API ***\")\r\n sys.exit()\r\n<\/code><\/pre>\nCreating Objects in AtomCraft<\/h2>\n
We can now start creating the required objects in Atom Craft. First the rendered files must be registered as Materials.<\/p>\n
\n- The Material Root folder is determined by calling the \u201cget_material_rootfolder\u201d function.<\/li>\n
- Then, the \u201cregister_unregistered_materials\u201d function can be used on the root folder to automatically register the new wave files.<\/li>\n
- From the root folder, \u201cget_child_object\u201d is used to create a list containing the names of all the Materials we just registered (it will be used later to create our Waveform Regions).<\/li>\n
- Finally, the \u201csync_local_files\u201d function is used on the GameSynth folder to update the Materials in case they already existed.<\/li>\n<\/ul>\n
\r\n#Build the lists of Materials and Material folders\r\nmaterial_folder = acproject.get_child_object(material_root_folder, \"MaterialSubFolder\", \"GameSynth\")[\"data\"]\r\n\r\nbase_name = gs_patch_name + \"_\" + str(file_index) #Get the name of the rendered patch\r\nmaterial = acproject.get_child_object(material_folder, \"Material\", base_name + \".wav\")[\"data\"]\r\nmaterial_list.append(material)\r\n\r\nmaterials_folders_list.append(material_folder)\r\n#Sync with local files to refresh the Materials\r\nacproject.sync_local_files(materials_folders_list)\r\n<\/code><\/pre>\nOnce the Materials registered, higher level objects can be created as needed, depending on what was initially selected in the WorkUnit tree. For instance, if the user selected a WorkUnit before running the script, a whole object hierarchy will need to be created: CueSheet Folder, CueSheet, Cue, Track and Waveform Region. But if the selected object was a Cue, only the Track and Waveform Region will have to be created.<\/p>\n
\n- First, the type of the selected object is retrieved by using the \u201cget_type_name\u201d function.<\/li>\n
- From there, at each level of the hierarchy, we check which objects aren\u2019t selected.<\/li>\n
- With the \u201cget_child_object\u201d function we also check beforehand that the object we want to create doesn\u2019t already exist, to avoid a conflict.<\/li>\n
- If the object doesn\u2019t exist, the \u201ccreate_object\u201d function is called.<\/li>\n<\/ul>\n
Here is the code for the two first levels of the hierarchy (WorkUnit and CueSheet):<\/p>\n
\r\n#Create AtomCraft objects based on the selected object\r\nselected_object_type = acproject.get_type_name(selected_objects[0]) [\"data\"]\r\n\r\n#If a WorkUnit is selected\r\nif selected_object_type not in [\"CueSheet\", \"Cue\", \"Track\"]:\r\n # ----- Creating Cue Sheet\/Cue -----\r\n # Get the Cue Sheet Root folder\r\n cuesheet_rootfolder = acproject.get_cuesheet_rootfolder(selected_workunits[0])[\"data\"]\r\n\r\n # Create a Cue Sheet Root folder named \"GameSynth\" if it does not exist yet\r\n cuesheet_folder = acproject.get_child_object(cuesheet_rootfolder, \"CueSheetFolder\", \"GameSynth\")[\"data\"]\r\n if not cuesheet_folder:\r\n cuesheet_folder = acproject.create_object(cuesheet_rootfolder, \"CueSheetFolder\", \"GameSynth\")[\"data\"]\r\n\r\n # Create a Cue Sheet in the Cue Sheet folder if it does not exist yet\r\n cuesheet = acproject.get_child_object(cuesheet_folder, \"CueSheet\", \"GameSynth\")[\"data\"]\r\n if not cuesheet:\r\n cuesheet = acproject.create_object(cuesheet_folder, \"CueSheet\", \"GameSynth\")[\"data\"]\r\n\r\n#If a CueSheet is selected\r\nif selected_object_type not in [\"Cue\", \"Track\"]:\r\n # ----- Creating Cue -----\r\n if selected_object_type == \"CueSheet\":\r\n cuesheet = selected_objects[0]\r\n\r\n # Create a Cue unless it already exists\r\n cue = acproject.get_child_object(cuesheet, \"Cue\", gs_patch_name)[\"data\"]\r\n if not cue:\r\n cue = acproject.create_object(cuesheet, \"Cue\", gs_patch_name)[\"data\"]\r\n<\/code><\/pre>\nThe code continues in a similar fashion for the Cue and Track levels.<\/p>\n
Note that in the final script, we also added a \u201cVariations\u201d User Variable to render several sound variations at once, which is why the code rendering the sounds differs a bit. Indeed, when rendering variations, a Random No Repeat Cue is created instead of a Polyphonic Cue. And when a Track is selected, a Random No Repeat SubSequence is added instead of a WaveForm Region.<\/p>\n
Download the script below to check everything by yourself, and expand it as you need!<\/p>\n
![\"zip\"](\"https:\/\/blog.criware.com\/wp-content\/uploads\/2018\/06\/zip.png\")
AtomCraft_Robot_PythonScript_GSAPI.zip<\/a><\/div>\n","protected":false},"excerpt":{"rendered":"We conclude our introduction to the CRI Robot API with a script that will not only create new assets in<\/p>\n","protected":false},"author":2,"featured_media":4524,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"colormag_page_container_layout":"default_layout","colormag_page_sidebar_layout":"default_layout","footnotes":""},"categories":[5,7],"tags":[],"class_list":["post-4511","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-adx","category-tutorials"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/blog.criware.com\/index.php\/wp-json\/wp\/v2\/posts\/4511","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.criware.com\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.criware.com\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.criware.com\/index.php\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.criware.com\/index.php\/wp-json\/wp\/v2\/comments?post=4511"}],"version-history":[{"count":8,"href":"https:\/\/blog.criware.com\/index.php\/wp-json\/wp\/v2\/posts\/4511\/revisions"}],"predecessor-version":[{"id":5406,"href":"https:\/\/blog.criware.com\/index.php\/wp-json\/wp\/v2\/posts\/4511\/revisions\/5406"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/blog.criware.com\/index.php\/wp-json\/wp\/v2\/media\/4524"}],"wp:attachment":[{"href":"https:\/\/blog.criware.com\/index.php\/wp-json\/wp\/v2\/media?parent=4511"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.criware.com\/index.php\/wp-json\/wp\/v2\/categories?post=4511"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.criware.com\/index.php\/wp-json\/wp\/v2\/tags?post=4511"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}