Documentation

Support

Asset Transformer SDK


User Manual

Python API

C# API

Changelog

Discussions

Asset Transformer SDK

pxz

Python API functions
Read time 1 minuteLast updated 19 hours ago

initialization

initialize

Start a new Pixyz session. This step is mandatory before using any SDK features.
This function will acquire previously installed license (e.g using core.configureLicenseServer or core.installLicense).
pxz.initialize(productName=None, validationKey=None, optionalTokenList=None, license=None)
Parameters

Type

Name

Description

StringproductNameOptional name of the Pixyz product to initialize. Leave empty if using the 'PixyzSDK' product.
StringvalidationKeyOptional validation key linked to the specified product name. Leave empty if no product name was specified.
StringListoptionalTokenListOptional token list for some products using a limited list of features.
StringlicenseOptional license file path to configure the session with. If not specified the session will use a previously installed license using core.configureLicenseServer or core.installLicense.
See also:

release

Terminate the initialized Pixyz session, ensuring memory cleanup and license release. This call is optional, as these steps will automatically occur when the process terminates.
pxz.release()
See also: