Skip to content

Commit 90d4e12

Browse files
committed
Merge branch 'develop' into v1
2 parents b69a204 + 8e21321 commit 90d4e12

17 files changed

+10655
-489
lines changed

README.md

Lines changed: 12 additions & 489 deletions
Large diffs are not rendered by default.

docs/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/vendor
2+
/node_modules

docs/docs/.vuepress/config.js

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
module.exports = {
2+
title: 'Transcoder Documentation',
3+
description: 'Documentation for the Transcoder plugin',
4+
base: '/docs/transcoder/',
5+
dest: '../../../../sites/nystudio107/web/docs/transcoder',
6+
themeConfig: {
7+
displayAllHeaders: true,
8+
sidebar: [
9+
['/', 'Transcoder plugin for Craft CMS 3.x'],
10+
['/Overview', 'Transcoder Overview'],
11+
['/Configuring', 'Configuring Transcoder'],
12+
['/Using', 'Using Transcoder'],
13+
]
14+
}
15+
};

docs/docs/Configuring.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Configuring Transcoder
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.
4+
5+
You will also need [ffmpeg](https://ffmpeg.org/) installed for Transcoder to work. On Ubuntu 16.04, you can do just:
6+
7+
sudo apt-get update
8+
sudo apt-get install ffmpeg
9+
10+
To install `ffmpeg` on Centos 6/7, you can follow the guide [How to Install FFmpeg on CentOS](https://www.vultr.com/docs/how-to-install-ffmpeg-on-centos)
11+
12+
If you have managed hosting, contact your sysadmin to get `ffmpeg` installed.
13+
14+
Brought to you by [nystudio107](https://nystudio107.com)

docs/docs/Overview.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Transcoder Overview
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.
4+
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.
6+
7+
Transcoder also allows you to get a thumbnail of a video in any size and at any timecode, and can extract information about audio/video files such. It also automatically adds video thumbnails in the Assets index in the Control Panel.
8+
9+
Finally, it lets you download an arbitrary file (such as the transcoded video) via a special download link.
10+
11+
If the source file has changed since the last time the video/audio was transcoded, it will re-encode the file and replace it.
12+
13+
Brought to you by [nystudio107](https://nystudio107.com)

docs/docs/README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/quality-score.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/?branch=v1) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/coverage.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/?branch=v1) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/build.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/build-status/v1) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/code-intelligence.svg?b=v1)](https://scrutinizer-ci.com/code-intelligence)
2+
3+
# Transcoder plugin for Craft CMS 3.x
4+
5+
Transcode video & audio files to various formats, and provide video thumbnails
6+
7+
![Screenshot](./resources/img/plugin-banner.jpg)
8+
9+
Related: [Transcoder for Craft 2.x](https://github.com/nystudio107/transcoder)
10+
11+
**Note**: _The license fee for this plugin is $59.00 via the Craft Plugin Store._
12+
13+
## Requirements
14+
15+
This plugin requires Craft CMS 3.0.0 or later.
16+
17+
## Installation
18+
19+
To install Transcoder, follow these steps:
20+
21+
1. Open your terminal and go to your Craft project:
22+
23+
cd /path/to/project
24+
25+
2. Then tell Composer to load the plugin:
26+
27+
composer require nystudio107/craft-transcoder
28+
29+
3. Install the plugin via `./craft install/plugin transcoder` via the CLI, or in the Control Panel, go to Settings → Plugins and click the “Install” button for Transcoder.
30+
31+
You can also install Transcoder via the **Plugin Store** in the Craft Control Panel.
32+
33+
Transcoder works on Craft 3.x.
34+
35+
You will also need [ffmpeg](https://ffmpeg.org/) installed for Transcoder to work. On Ubuntu 16.04, you can do just:
36+
37+
sudo apt-get update
38+
sudo apt-get install ffmpeg
39+
40+
To install `ffmpeg` on Centos 6/7, you can follow the guide [How to Install FFmpeg on CentOS](https://www.vultr.com/docs/how-to-install-ffmpeg-on-centos)
41+
42+
If you have managed hosting, contact your sysadmin to get `ffmpeg` installed.
43+
44+
Brought to you by [nystudio107](https://nystudio107.com)

0 commit comments

Comments
 (0)