ProcessFileParams

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

Structure

{
  "accountId": String,
  "artifact": String,
  "cache": Boolean,
  "cache_perm": String,
  "cache_ttl": Number,
  "filePath": String,
  "large": Boolean,
  "transformation": String,
  "transformationParams": Object,
  "version": String
}

Example

{
  "accountId": "YOUR_ACCOUNT_ID",
  "artifact": "/example/video/part-a.ts",
  "cache": true,
  "cache_perm": "auto",
  "cache_ttl": 31536000,
  "filePath": "/uploads/image.jpg",
  "large": false,
  "transformation": "thumbnail",
  "transformationParams": {},
  "version": "1"
}

Properties

accountId

Your account ID.

This is visible on the settings page:

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

Example: "A623uY2"

Type: String

Length: 7

Required: No

artifact

Path to an artifact generated by the transformation.

All image transformations output the transformed image to the "/" artifact. Video transformations may output multiple artifacts.

Default: "/"

Type: String

Required: No

cache

Example: true

Type: Boolean

Required: No

cache_perm

Example: "auto"

Type: String

Allowed Values: "auto", "false", "true"

Required: No

cache_ttl

Example: 31536000

Type: Number

Required: No

filePath

Absolute path to a file. Begins with a /.

Example: "/uploads/image.jpg"

Type: String

Min Length: 1

Max Length: 512

Required: No

large

Example: false

Type: Boolean

Required: No

transformation

Transformation URL slug.

These are created in the Bytescale Dashboard:

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

Example: "thumbnail"

Type: String

Min Length: 1

Max Length: 100

Required: No

transformationParams

Type: Object

Required: No

version

Example: "1"

Type: String

Required: No

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:

Chrome

Download

Firefox

Download

Opera

Download

Safari

Download
(macOS only)

Internet Explorer

Download
(Windows only)

Microsoft Edge

Download
(Windows only)