ProcessFileAndSaveParams

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

Structure

{
  "<transformation-params>": TransformationParams,
  "accountId": String,
  "filePath": String,
  "processFileAndSaveRequest": ProcessFileAndSaveRequest,
  "transformation": String
}

Example

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

Properties

<transformation-params> Optional

Each File Processing API requires additional query string parameters to specify the desired transformation behavior.

For details, refer to the relevant documentation:

•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

•https://www.bytescale.com/docs/antivirus-api

Type: TransformationParams

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

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

<transformation-params> Optional

accountId Required

filePath Required

processFileAndSaveRequest Required

transformation Required

You are using an outdated browser.