Skip to content

Commit 21214eb

Browse files
authored
Line spacing and small edits
1 parent 882ceca commit 21214eb

File tree

1 file changed

+58
-83
lines changed
  • src/content/docs/stream/transform-videos

1 file changed

+58
-83
lines changed

src/content/docs/stream/transform-videos/index.mdx

Lines changed: 58 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -6,151 +6,126 @@ sidebar:
66

77
---
88

9-
Media Transformations let you optimize and manipulate videos stored _outside_ of
10-
the Cloudflare Stream product. Transformed videos and images are served from one
11-
of your zones on Cloudflare.
9+
Media Transformations let you optimize and manipulate videos stored _outside_ of the Cloudflare Stream. Transformed videos and images are served from one of your zones on Cloudflare.
1210

13-
To transform a video or image, you must
14-
[enable transformations](/stream/transform-videos/#getting-started)
15-
for your zone. If your zone already has Image Transformations enabled, then it
16-
is ready to optimize videos with Media Transformations, too.
11+
To transform a video or image, you must [enable transformations](/stream/transform-videos/#getting-started) for your zone. If your zone already has Image Transformations enabled, you can also optimize videos with Media Transformations.
1712

1813
## Getting started
1914

20-
You can dynamically optimize and generate still images from videos that
21-
are stored _outside_ of Cloudflare Stream with Media Transforamtions.
15+
You can dynamically optimize and generate still images from videos that are stored _outside_ of Cloudflare Stream with Media Transformations.
2216

23-
Cloudflare will automatically cache every transformed video or image on our
24-
global network so that you store only the original image at your origin.
17+
Cloudflare will automatically cache every transformed video or image on our global network so that you store only the original image at your origin.
2518

2619
To enable transformations on your zone:
2720

28-
- Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account.
29-
- Go to **Stream** > **Transformations**.
30-
- Locate the specific zone where you want to enable transformations.
31-
- Select **Enable** for zone.
21+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account.
22+
2. Go to **Stream** > **Transformations**.
23+
3. Locate the specific zone where you want to enable transformations.
24+
4. Select **Enable** for zone.
3225

3326
## Transform a video by URL
3427

35-
You can convert and resize videos by requesting them via a specially-formatted URL,
36-
without writing any code. The URL format is:
28+
You can convert and resize videos by requesting them via a specially-formatted URL, without writing any code. The URL format is:
3729

3830
```
3931
https://example.com/media/<OPTIONS>/<SOURCE-VIDEO>
4032
```
4133

42-
- `example.com`
43-
- Your website or zone on Cloudflare, with Transformations enabled
44-
- `/cdn-cgi/media/`
45-
- A prefix that identifies that this is a special path handled by Cloudflare's
46-
built-in media transformation service.
47-
- `<OPTIONS>`
48-
- A comma-separated list of options. See available options below.
49-
- `<SOURCE-VIDEO>`
50-
- An absolute path on the origin server or a full URL (starting with `https://`
51-
or `http://`) of the original asset to resize.
34+
- `example.com`: Your website or zone on Cloudflare, with Transformations enabled.
35+
- `/cdn-cgi/media/`: A prefix that identifies a special path handled by Cloudflare's built-in media transformation service.
36+
- `<OPTIONS>`: A comma-separated list of options. Refer to the available options below.
37+
- `<SOURCE-VIDEO>`: An absolute path on the origin server or a full URL (starting with `https://` or `http://`) of the original asset to resize.
5238

53-
For example, this URL will source an HD video from an R2 bucket, shorten it, crop
54-
and resize it as a square, and remove the audio.
39+
For example, this URL will source an HD video from an R2 bucket, shorten it, crop and resize it as a square, and remove the audio.
5540

5641
```
5742
https://example.com/media/mode=video,time=5s,duration=5s,width=500,height=500,fit=crop,audio=false/https://pub-8613b7f94d6146408add8fefb52c52e8.r2.dev/aus-mobile-demo.mp4
5843
```
5944

6045
The result is an MP4 that can be used in an HTML video element without a player library.
6146

62-
### Options
47+
## Options
6348

64-
#### `mode`
49+
### `mode`
6550

66-
Specify the kind of output to generate.
51+
Specifies the kind of output to generate.
6752

68-
- `video` — output an (H.264/AAC) optimized MP4 file
69-
- `frame` — output a still image
70-
- `spritesheet` — output a JPEG with multiple frames
53+
- `video`: Outputs an H.264/AAC optimized MP4 file.
54+
- `frame`: Outputs a still image.
55+
- `spritesheet`: Outputs a JPEG with multiple frames.
7156

72-
#### `time`
57+
### `time`
7358

74-
When, in the input file, to start extracting the output. Depends on `mode`:
59+
Specifies when to start extracting the output in the input file. Depends on `mode`:
7560

76-
- When `mode` is `spritesheet` or `video`, the timestamp where the output will start
77-
- When `mode` is `frame`, the timestamp from which to extract the still image
78-
- Format as a time string, for example: 5s, 2m
61+
- When `mode` is `spritesheet` or `video`, specifies the timestamp where the output will start.
62+
- When `mode` is `frame`, specifies the timestamp from which to extract the still image.
63+
- Formats as a time string, for example: 5s, 2m
7964
- Acceptable range: 0 – 30s
8065
- Default: 0
8166

82-
#### `duration`
67+
### `duration`
8368

8469
The duration of the output video or spritesheet. Depends on `mode`:
8570

86-
- When `mode` is `video`, the duration of the output.
87-
- When `mode` is `spritesheet`, the time range from which to select frames.
71+
- When `mode` is `video`, specifies the duration of the output.
72+
- When `mode` is `spritesheet`, specifies the time range from which to select frames.
8873

89-
#### `fit`
74+
### `fit`
9075

91-
In combination with `width` and `height`, how to resize and crop the output. In
92-
the event the output is resized, it will always resize proportionally so content
93-
is not stretched.
76+
In combination with `width` and `height`, specifies how to resize and crop the output. If the output is resized, it will always resize proportionally so content is not stretched.
9477

95-
- `contain` — Respecting aspect ratio, scale a video up or down to be entirely
96-
contained within output dimensions.
97-
- `scale-down` — Same as contain, but downscale to fit only. Do not upscale.
98-
- `cover` — Respecting aspect ratio, scale a video up or down to entirely cover
99-
the output dimensions, with a center-weighted crop of the remainder.
78+
- `contain`: Respecting aspect ratio, scales a video up or down to be entirely contained within output dimensions.
79+
- `scale-down`: Same as contain, but downscales to fit only. Do not upscale.
80+
- `cover`: Respecting aspect ratio, scales a video up or down to entirely cover the output dimensions, with a center-weighted crop of the remainder.
10081

101-
#### `height`
82+
### `height`
10283

10384
Specifies maximum height of the output in pixels. Exact behavior depends on `fit`.
10485

105-
- Acceptable range: 10 - 2000 pixels
86+
- Acceptable range: 10-2000 pixels
10687

107-
#### `width`
88+
### `width`
10889

109-
Specifies maximum width of the image in pixels. Exact behavior depends on `fit`.
90+
Specifies the maximum width of the image in pixels. Exact behavior depends on `fit`.
11091

111-
- Acceptable range: 10 - 2000 pixels
92+
- Acceptable range: 10-2000 pixels
11293

113-
#### `audio`
94+
### `audio`
11495

115-
When `mode` is `video`, specifies whether or not to include the source audio in
116-
the output.
96+
When `mode` is `video`, specifies whether or not to include the source audio in the output.
11797

118-
- true — include source audio
119-
- false — output will be silent
120-
- Default: true
98+
- `true`: Includes source audio.
99+
- `false`: Output will be silent.
100+
- Default: `true`
121101

122-
#### `format`
102+
### `format`
123103

124-
If `mode` is `frame`, specifies image output format.
104+
If `mode` is `frame`, specifies the image output format.
125105

126-
- Acceptable options: jpg, png
106+
- Acceptable options: `jpg`, `png`
127107

128-
### Source video requirements
108+
## Source video requirements
129109

130-
Input video must be less than 40MB. Please contact Stream if this input
131-
limitation is not acceptable.
110+
Input video must be less than 40MB. Contact Stream if the input limitation is unacceptable.
132111

133-
Input video should be an MP4 with H.264 encoded video and AAC or MP3 encoded
134-
audio. Other formats may work but are untested.
112+
Input video should be an MP4 with H.264 encoded video and AAC or MP3 encoded audio. Other formats may work but are untested.
135113

136114
## Limitations
137115

138-
Media Transformations is currently in beta. During this period:
116+
Media Transformations are currently in beta. During this period:
139117

140118
- Transformations are available for all enabled zones free-of-charge.
141-
- Restricting allowed origins for transformations is coming soon.
142-
- Outputs from Media Transformations will be cached, but in the event they must
143-
be regenerated, the origin fetch is not cached and may result in subsequent
144-
requests to the origin asset.
119+
- Restricting allowed origins for transformations are coming soon.
120+
- Outputs from Media Transformations will be cached, but if they must be regenerated, the origin fetch is not cached and may result in subsequent requests to the origin asset.
145121

146122
## Pricing
147123

148124
Media Transformations will be free for all customers while in beta.
149125

150-
After that, Media Transforamtions and Image Transformations will use the same
151-
subscriptions and usage metrics. Generating a still frame (single image) from a
152-
video counts as 1 transformation. Generating an optimized video counts as 1
153-
transformation _per second of the output_ video. Each unique transformation is
154-
only billed once per month. All Media and Image Transformations cost $0.50 per
155-
1,000 monthly unique transformation operations, with a free monthly allocation
156-
of 5,000.
126+
After that, Media Transforamtions and Image Transformations will use the same subscriptions and usage metrics.
127+
128+
- Generating a still frame (single image) from a video counts as 1 transformation.
129+
- Generating an optimized video counts as 1 transformation _per second of the output_ video.
130+
- Each unique transformation is only billed once per month.
131+
- All Media and Image Transformations cost $0.50 per 1,000 monthly unique transformation operations, with a free monthly allocation of 5,000.

0 commit comments

Comments
 (0)