You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/configuring.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Configuring Transcoder
2
2
3
-
The only configuration for Transcoder is in the `config.php` file, which is a multi-environment friendly way to store the default settings. Don't edit this file, instead copy it to `craft/config` as `transcoder.php` and make your changes there.
3
+
The only configuration for Transcoder is in the `config.php` file, which is a multi-environment friendly way to store the default settings. Don’t edit this file, instead copy it to `craft/config` as `transcoder.php` and make your changes there.
4
4
5
5
You will also need [ffmpeg](https://ffmpeg.org/) installed for Transcoder to work. On Ubuntu 16.04, you can do just:
Copy file name to clipboardExpand all lines: docs/docs/overview.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Transcoder Overview
2
2
3
-
The Transcoder plugin allows you to transcode any video or animated gif (local or remote) to any size, bitrate, framerate, and save it out as a web-ready video in a variety of file formats.
3
+
The Transcoder plugin allows you to transcode any video or animated GIF (local or remote) to any size, bitrate, framerate, and save it out as a web-ready video in a variety of file formats.
4
4
5
5
It can also transcode audio files to any bitrate & sample rate, to a variety of file formats. It can even extract audio tracks from video files.
Copy file name to clipboardExpand all lines: docs/docs/using.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,9 +36,9 @@ You can also pass in an `Asset`:
36
36
}) %}
37
37
```
38
38
39
-
It will return to you a URL to the transcoded video if it already exists, or if it doesn't exist, it will return `""` and kick off the transcoding process (which can be quite lengthy for long videos).
39
+
It will return to you a URL to the transcoded video if it already exists, or if it doesn’t exist, it will return `""` and kick off the transcoding process (which can be quite lengthy for long videos).
40
40
41
-
In the array you pass in, the default values are used if the key/value pair does not exist:
41
+
In the array you pass in, the default values are used if the key-value pair does not exist:
42
42
43
43
```
44
44
{
@@ -52,7 +52,7 @@ In the array you pass in, the default values are used if the key/value pair does
52
52
53
53
These default values come from the `config.php` file.
54
54
55
-
If you want to have the Transcoder not change a parameter, pass in an empty value in the key/value pair, e.g.:
55
+
To have the Transcoder not change a parameter, pass in an empty value in the key-value pair, for example:
56
56
57
57
```twig
58
58
{% set transVideoUrl = craft.transcoder.getVideoUrl('/home/vagrant/sites/nystudio107/public/oceans.mp4', {
@@ -69,19 +69,19 @@ The `aspectRatio` parameter lets you control how the video aspect ratio is maint
You can control the color of the letterboxed area (it's `black` by default) via the `letterboxColor` option. It can be either a semantic color name, or a hexcode color, e.g.: `0xC0C0C0`
80
+
You can control the color of the letterboxed area (it’s `black` by default) via the `letterboxColor` option. It can be either a semantic color name, or a hexcode color, for example: `0xC0C0C0`
81
81
82
82
The `sharpen` option determines whether an unsharp mask filter should be applied to the scaled video.
83
83
84
-
The file format setting `videoEncoder` is preset to what you'll need to generate `h264` videos, but it can also generate `webm` videos, or any other format that `ffmpeg` supports. See the `config.php` file for details
84
+
The file format setting `videoEncoder` is preset to what you’ll need to generate `h264` videos, but it can also generate `webm` videos, or any other format that `ffmpeg` supports. See the `config.php` file for details
@@ -120,9 +120,9 @@ You can also pass in an `Asset`:
120
120
}) %}
121
121
```
122
122
123
-
It will return to you a URL to the transcoded audio file if it already exists, or if it doesn't exist, it will return `""` and kick off the transcoding process (which can be somewhat lengthy for long audio files).
123
+
It will return to you a URL to the transcoded audio file if it already exists, or if it doesn’t exist, it will return `""` and kick off the transcoding process (which can be somewhat lengthy for long audio files).
124
124
125
-
In the array you pass in, the default values are used if the key/value pair does not exist:
125
+
In the array you pass in, the default values are used if the key-value pair does not exist:
126
126
127
127
```
128
128
{
@@ -137,7 +137,7 @@ In the array you pass in, the default values are used if the key/value pair does
137
137
138
138
These default values come from the `config.php` file.
139
139
140
-
If you want to have the Transcoder not change a parameter, pass in an empty value in the key/value pair, e.g.:
140
+
To have the Transcoder not change a parameter, pass in an empty value in the key-value pair, for example:
141
141
142
142
```twig
143
143
{% set transVideoUrl = craft.transcoder.getVideoUrl('/home/vagrant/sites/nystudio107/public/trimurti.mp4', {
@@ -149,7 +149,7 @@ If you want to have the Transcoder not change a parameter, pass in an empty valu
149
149
150
150
The above example would cause it to not change the audio of the source audio file at all (not recommended for client-proofing purposes).
151
151
152
-
The file format setting `audioEncoder` is preset to what you'll need to generate `mp3` audio files, but it can also generate `aac`, `ogg`, or any other format that `ffmpeg` supports. See the `config.php` file for details
152
+
The file format setting `audioEncoder` is preset to what you’ll need to generate `mp3` audio files, but it can also generate `aac`, `ogg`, or any other format that `ffmpeg` supports. See the `config.php` file for details
153
153
154
154
## Getting Transcoding Progress
155
155
@@ -219,9 +219,9 @@ You can also pass in an `Asset`:
219
219
}) %}
220
220
```
221
221
222
-
It will return to you a URL to the thumbnail of the video, in the size you specify, from the timecode `timeInSecs` in the video. It creates this thumbnail immediately if it doesn't already exist.
222
+
It will return to you a URL to the thumbnail of the video, in the size you specify, from the timecode `timeInSecs` in the video. It creates this thumbnail immediately if it doesn’t already exist.
223
223
224
-
In the array you pass in, the default values are used if the key/value pair does not exist:
224
+
In the array you pass in, the default values are used if the key-value pair does not exist:
225
225
226
226
```
227
227
{
@@ -233,7 +233,7 @@ In the array you pass in, the default values are used if the key/value pair does
233
233
}
234
234
```
235
235
236
-
If you want to have the Transcoder not change a parameter, pass in an empty value in the key/value pair, e.g.:
236
+
To have the Transcoder not change a parameter, pass in an empty value in the key-value pair, for example:
237
237
238
238
```twig
239
239
{% set transVideoThumbUrl = craft.transcoder.getVideoThumbnailUrl('/home/vagrant/sites/nystudio107/public/oceans.mp4', {
@@ -259,7 +259,7 @@ The `aspectRatio` parameter lets you control how the video aspect ratio is maint
You can control the color of the letterboxed area (it's `black` by default) via the `letterboxColor` option. It can be either a semantic color name, or a hexcode color, e.g.: `0xC0C0C0`
262
+
You can control the color of the letterboxed area (it’s `black` by default) via the `letterboxColor` option. It can be either a semantic color name, or a hexcode color, for example: `0xC0C0C0`
263
263
264
264
The `sharpen` option determines whether an unsharp mask filter should be applied to the scaled thumbnail image.
265
265
@@ -308,7 +308,7 @@ If you instead pass in `false` as the second parameter (or omit it), then `craft
308
308
*`format` - information about the container file format
309
309
*`streams` - information about each stream in the container; many videos have multiple streams, for instance, one for the video streams, and another for the audio stream. There can even be multiple video or audio streams in a container.
310
310
311
-
Here's example output from `craft.transcoder.getFileInfo()`:
311
+
Here’s example output from `craft.transcoder.getFileInfo()`:
312
312
313
313
```
314
314
[
@@ -437,7 +437,7 @@ To generate a download URL for a file, do the following:
437
437
{% set downloadUrl = craft.transcoder.getDownloadUrl('/some/url') %}
438
438
```
439
439
440
-
When the user clicks on the URL, it will download the file to their local computer. If the file doesn't exist, `""` is returned.
440
+
When the user clicks on the URL, it will download the file to their local computer. If the file doesn’t exist, `""` is returned.
441
441
442
442
The file must reside in the webroot (thus a URL or URI must be passed in as a parameter, not a path), for security reasons.
0 commit comments