deuxhuithuit / craft-cloudflare-stream
Upload your videos assets to Cloudflare Stream from Craft CMS assets interface
Installs: 467
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 1
Open Issues: 2
Type:craft-plugin
Requires
- php: 8.2.*|8.3.*
- craftcms/cms: ^5.0.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.22
README
This plugin offers a easy way to upload your videos assets from Craft CMS to Cloudflare stream.
Installation
- Install with composer
composer require deuxhuithuit/craft-cloudflare-stream
- Install in craft
craft plugin/install cloudflare-stream
-
Add your account id and api token in the settings. You can (and should) use env vars. Make sure to also choose your upload mechanism. If your volume does not have public urls, turn on form data upload. This is the recommended value, but not the default since not all hosts allows it.
-
Create a video stream Field and add it to your Asset data model.
-
When editing an asset, you can now opt-in into sending videos in Cloudflare Stream.
-
If your are using twig, with a field named
stream
you can access the stream data like so:
{% set value = asset.stream %} <video controls style="width: 100%" poster="{{ value.thumbnail }}"> {% if value.mp4Url and value.completed %} <source src="{{ value.mp4Url }}" type="video/mp4"> {% endif %} {% if value.playback.hls %} <source src="{{ value.playback.hls }}" type="application/x-mpegURL"> {% endif %} {% if value.playback.dash %} <source src="{{ value.playback.dash }}" type="application/dash+xml"> {% endif %} </video>
- If you are using graphql, there is a type registered to make it easy to request the proper data.
query MyQuery { asset(site: ["en"], volume: "stream") { url kind extension filename ... on stream_Asset { videoStream { uid name size thumbnailTimestampPct thumbnail preview hls dash mp4 ready completed watermark { uid created downloadedFrom height name opacity padding position scale size width } input { width height } } } } }
- You can also mass re-upload everything via Craft's cli. Please note that this creates new streams videos and is useful mainly when changing accounts.
./craft cloudflare-stream/reupload
This extension uses Craft's Queue system, so make sure it works properly.
Dealing with large files
Videos can be quite large, which makes uploading them a little trickier. Please make sure that Craft's and php's max upload limit are properly set.
If you still want to deal with larger file than what your host allows,
you might want to try the Chunked Upload plugin
to bypass your host restrictions. The plugin will use TUS when appropriated. The chunk size can
be set by setting the CF_STREAM_TUS_CHUNK_SIZE
env var to a value in bytes, in the 5 to 200 Mb range.
Made with ❤️ in Montréal.
(c) Deux Huit Huit