The CE.SDK renderer can return and print a variety of errors that can happen due to invalid inputs, resource constraints, host device issues, etc.
Any error MUST be accompanied with a non-zero exit code from the process to indicate failure and SHOULD print diagnostic information to the standard error output.
The operating system may terminate the process in case of an out of memory scenario, illegal memory access due to a program bug or a number of other reasons, in that case diagnostic information cannot be reliably printed.
The error types with recommended handling strategy are summarized in the following table:
| Error | Process exit code | Handling strategy |
|---|---|---|
| No error | 0 | No handling needed |
| Invalid CLI arguments | 1 | Check invocation and fix the argument syntax |
| Unknown file extension, could not guess MIME type | 1 | Specify the desired output MIME type directly via the -T/—output-mime-type flag |
| Received an interrupt signal | 1 | The termination was requested by sending a SIGINT signal to the process, intended behavior |
| Could not create render context | 1 | Check GPU setup according to the Server Setup guide, most likely a GPU driver initialization failure due to misconfiguration |
| Engine creation error | 1 | Check the settings passed via CLI flags for validity |
| Assets base path is not a directory | 1 | Make sure to pass a valid path to a directory to the —base-path flag, or skip the flag to use the default |
| License-related errors | 1 | Check that your license is still valid, and that the concurrency limit is not exceeded in your infrastructure. |
| Could not open/read input file | -1 | System IO error, check the input file path for validity and disk device for issues |
| Input file did not contain a valid scene | 1 | The input provided needs to be a valid CE.SDK scene or archive, exported from the same or older CE.SDK version |
| Page X not available, loaded scene only has N pages | -2 | Pass a valid page number to the —page CLI argument |
| Export failed | 1 | The detailed error message should contain more information, retries can be a valid solution to some hardware/driver issues |
| Could not write to output file | 1 | Make sure the output directory is writable and has enough free space to hold the output file |
| Max concurrency reached | 1 | Limit the maximum deployment scaling in your orchestration system, or contact IMG.LY to acquire a higher limit |