@bytescale/sdk 3.3.0 → 3.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -63,7 +63,7 @@ npm install @bytescale/sdk node-fetch
|
|
|
63
63
|
npm install @bytescale/sdk
|
|
64
64
|
```
|
|
65
65
|
|
|
66
|
-
If you
|
|
66
|
+
If you'd prefer to use a script tag:
|
|
67
67
|
|
|
68
68
|
```html
|
|
69
69
|
<script src="https://js.bytescale.com/sdk/v3"></script>
|
|
@@ -71,7 +71,7 @@ If you want to use a script tag:
|
|
|
71
71
|
|
|
72
72
|
## Uploading Files
|
|
73
73
|
|
|
74
|
-
This library is isomorphic,
|
|
74
|
+
This library is isomorphic, meaning you can upload files from Node.js, or the browser, or both.
|
|
75
75
|
|
|
76
76
|
#### From Node.js:
|
|
77
77
|
|
|
@@ -261,7 +261,7 @@ fileApi
|
|
|
261
261
|
);
|
|
262
262
|
```
|
|
263
263
|
|
|
264
|
-
Use the [`UrlBuilder`](#urlbuilder) to get a URL
|
|
264
|
+
Use the [`UrlBuilder`](#urlbuilder) to get a URL instead (if you need a file URL instead of a binary stream).
|
|
265
265
|
|
|
266
266
|
## Processing Files
|
|
267
267
|
|
|
@@ -303,7 +303,7 @@ fileApi
|
|
|
303
303
|
);
|
|
304
304
|
```
|
|
305
305
|
|
|
306
|
-
Use the [`UrlBuilder`](#urlbuilder) to get a URL
|
|
306
|
+
Use the [`UrlBuilder`](#urlbuilder) to get a URL instead (if you need a file URL instead of a binary stream).
|
|
307
307
|
|
|
308
308
|
## Get File Details
|
|
309
309
|
|
|
@@ -395,7 +395,7 @@ import { UrlBuilder } from "@bytescale/sdk";
|
|
|
395
395
|
|
|
396
396
|
#### Raw Files
|
|
397
397
|
|
|
398
|
-
To get the URL for the uploaded image `/example.jpg` in its original form, use the following
|
|
398
|
+
To get the URL for the uploaded image `/example.jpg` in its original form, use the following:
|
|
399
399
|
|
|
400
400
|
```javascript
|
|
401
401
|
// Returns: "https://upcdn.io/1234abc/raw/example.jpg"
|
|
@@ -407,7 +407,7 @@ UrlBuilder.url({
|
|
|
407
407
|
|
|
408
408
|
#### Images
|
|
409
409
|
|
|
410
|
-
To resize the uploaded image `/example.jpg` to 800x600, use the following
|
|
410
|
+
To resize the uploaded image `/example.jpg` to 800x600, use the following:
|
|
411
411
|
|
|
412
412
|
```javascript
|
|
413
413
|
// Returns: "https://upcdn.io/1234abc/image/example.jpg?w=800&h=600"
|
|
@@ -428,7 +428,7 @@ UrlBuilder.url({
|
|
|
428
428
|
|
|
429
429
|
#### Videos
|
|
430
430
|
|
|
431
|
-
To transcode the uploaded video `/example.mov` to MP4/H.264 in HD, use the following
|
|
431
|
+
To transcode the uploaded video `/example.mov` to MP4/H.264 in HD, use the following:
|
|
432
432
|
|
|
433
433
|
```javascript
|
|
434
434
|
// Returns: "https://upcdn.io/1234abc/video/example.mov?f=mp4-h264&h=1080"
|
|
@@ -449,7 +449,7 @@ UrlBuilder.url({
|
|
|
449
449
|
|
|
450
450
|
#### Audio
|
|
451
451
|
|
|
452
|
-
To transcode the uploaded audio `/example.wav` to AAC in 192kbps, use the following
|
|
452
|
+
To transcode the uploaded audio `/example.wav` to AAC in 192kbps, use the following:
|
|
453
453
|
|
|
454
454
|
```javascript
|
|
455
455
|
// Returns: "https://upcdn.io/1234abc/audio/example.wav?f=aac&br=192"
|
|
@@ -470,7 +470,7 @@ UrlBuilder.url({
|
|
|
470
470
|
|
|
471
471
|
#### Archives
|
|
472
472
|
|
|
473
|
-
To extract the file `document.docx` from the uploaded ZIP file `/example.zip
|
|
473
|
+
To extract the file `document.docx` from the uploaded ZIP file `/example.zip`:
|
|
474
474
|
|
|
475
475
|
```javascript
|
|
476
476
|
// Returns: "https://upcdn.io/1234abc/archive/example.zip?m=extract&artifact=/document.docx"
|