Upload Parameters
General
ASSET_SAVE_ORIGINAL
Default Value: "true"
If set to 'true', the original uploaded file will be retained without any modification, even if a transcoded proxy file was generated. This flag can be helpful if you wish to allow users to be able to download the original asset rather than a proxy format it was converted to in order to be displayed in-browser. This comes at the cost of additional storage, as each asset can potentially result in two files in the system (the original and the proxy).
Images
IMAGE_ENSURE_SRGB
Default Value: "false"
Setting this flag to 'true' will convert the image to sRGB which is a standard monitor colour space. The benefit is that it ensures the colour is the same regardless of which browser is being used to view the asset. Expect a small colourshift during conversion, and note that for some use cases, there is value to ensuring that if the original is in a CMYK colour space; that it is maintained.
IMAGE_OPTIMIZE_FOR_WEB
Default Value: "true"
Will optimize the files for improved display speed in web browsers by keeping the size reasonable. This is often adjusted when speed is the main consideration. It specifically: drops DPI/Density to 72dpi, converts to sRGB (if not already), resizes to under 4050x4050. For instance if you upload a 10000x100000px image, it will scale the image to under 4Kx4K, and convert the colour model from CMYK to sRGB, while also stripping the image metadata.
PDF
PDF_RASTERIZE
Default Value: "false"
Renders the document as an image (raster graphic) rather than PDF. Images are viewed more consistently by older browsers. NOTE: The user will not be able to use text search or copy review annotation tools for an the document if this flag is enabled.
Websites
WEBSITE_URL
Default Value: ""
The URL which you wish to capture
WEBSITE_HEIGHT
Default Value: ""
This property defines the height of the viewport that captures the website, and therefore the height of the final captured file.
WEBSITE_WIDTH
Default Value: ""
This property defines the width of the viewport that captures the website, and therefore the width of the final captured file.
WEBSITE_USERNAME
Default Value: ""
This parameter allows you to enter the username information required to log in to the website for access before capturing.
WEBSITE_PASSWORD
Default Value: ""
This parameter allows you to enter the password information required to log in to the website for access before capturing.
WEBSITE_CAPTURE_DELAY
Default Value: "0"
This parameter allows you to specify a delay prior to the capture of the website; allowing dynamic content to load before capturing.
WEBSITE_MAXIMUM_DELAY
Default Value: "60"
This value sets the upper limit for WEBSITE_CAPTURE_DELAY. This can be useful as the WEBSITE_CAPTURE_DELAY parameter can be set by users in non-OEM integrations where the user has full access to accounts and Concpetshare UI.
HTML5 Video
HTML5_PROCESS_AS_VIDEO
Default Value: "false"
If set to 'true', the uploaded zip file is processed as an HTML5 video.
HTML5_CAPTURE_DELAY
Default Value: "5"
This parameter allows you to specify a delay prior to the capture of the video; allowing dynamic content to load before capturing.
HTML5_HEIGHT
Default Value: ""
This property defines the height of the viewport that captures the video, and therefore the height of the final captured file.
HTML5_WIDTH
Default Value: ""
This property defines the width of the viewport that captures the video, and therefore the width of the final captured file.
HTML5_CAPTURE_DURATION
Default Value: "20"
This property defines the duration of the video recording.