ConversionSettings

Settings for Conversion. Values fall back through three levels: document → SDK → built-in default. Writes target the document only when set on a document’s settings, otherwise the SDK globally when set on SdkSettings.

Tags: Document

from nutrient_sdk import ConversionSettings

Construction

# Per-document override
with Document.open("input.pdf") as doc:
    settings = doc.settings.conversion_settings
    settings.some_field = new_value          # mutate fields directly

# SDK-wide default (applies to all documents)
SdkSettings.conversion_settings.some_field = new_value

Settings are configured by writing to fields on the returned object. The settings property itself cannot be reassigned — doc.settings.conversion_settings = other_settings is rejected.

Properties

html_media_load_timeout_milliseconds

@property
def html_media_load_timeout_milliseconds(self) -> Optional[int]

@html_media_load_timeout_milliseconds.setter
def html_media_load_timeout_milliseconds(self, value: Optional[int]) -> None

The maximum time, in milliseconds, to wait for page media (images and other sub-resources) to finish loading when rendering HTML, MHTML, or email input, before the page is captured. When set to a positive value, the renderer waits for the load event but no longer than this many milliseconds, so a slow or unreachable external resource cannot stall the conversion.

Type: Optional[int]

Default: null

timeout_milliseconds

@property
def timeout_milliseconds(self) -> int

@timeout_milliseconds.setter
def timeout_milliseconds(self, value: int) -> None

The conversion timeout in milliseconds. After this time, the conversion will be aborted and return a TimeoutException.

Type: int

Default: The default value is -1, which means no timeout.