ProcessFileAndSaveParams

Parameter object passed to the ProcessFileAndSave method in the Bytescale SDKs.

Structure

{
  "accountId": String,
  "filePath": String,
  "processFileAndSaveRequest": ProcessFileAndSaveRequest,
  "transformation": String,
  "transformationParams": TransformationParams
}

Example

{
  "accountId": "YOUR_ACCOUNT_ID",
  "filePath": "/source/image.jpg",
  "processFileAndSaveRequest": {
    "destination": "/destination/image.jpg"
  },
  "transformation": "image",
  "transformationParams": [
    {
      "w": 800,
      "h": 600,
      "fit": "crop"
    }
  ]
}

Properties

accountId Required

Your account ID.

This is visible on the settings page:

https://www.bytescale.com/dashboard/settings

Example: "A623uY2"

Type: String

Length: 7

filePath Required

Absolute path to a file. Begins with a /.

Example: "/source/image.jpg"

Type: String

Min Length: 1

Max Length: 512

processFileAndSaveRequest Required

Request body for ProcessFileAndSave.

Type: ProcessFileAndSaveRequest

transformation Required

The name of the File Processing API (e.g. image, video, audio) or transformation preset (created in the Bytescale Dashboard) to use when processing the file.

Example: "image"

Type: String

Min Length: 1

Max Length: 100

transformationParams Optional

Parameters to submit to the File Processing API (e.g. the Image Processing API).

Please see the documentation for each File Processing API to determine which values can appear here:

•https://www.bytescale.com/docs/image-processing-api

•https://www.bytescale.com/docs/video-processing-api

•https://www.bytescale.com/docs/audio-processing-api

•https://www.bytescale.com/docs/archive-processing-api

Type: TransformationParams

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported:

UI Widgets

SDKs

Processing APIs

Core APIs

Data Types

More Resources

ProcessFileAndSaveParams

Structure

Example

Properties

accountId Required

filePath Required

processFileAndSaveRequest Required

transformation Required

transformationParams Optional

You are using an outdated browser.