jonnitto/prettyembedvideostreaming
composer require jonnitto/prettyembedvideostreaming
Prettier embeds for your native streaming videos in Neos CMS - with nice options like high-res preview images, lightbox feature, captions and advanced customization of embed options.
6.2.0
- Requires
Jonnitto.PrettyEmbedVideoStreaming
Prettier embeds for your native streaming videos in Neos CMS - with excellent options like high-res preview images, lightbox feature, captions, and advanced customization of embed options.
Installation
Most of the time, you have to make small adjustments to a package (e.g., a configuration in Settings.yaml
). Thus, it is essential to add the corresponding package to the composer from your theme package. Mostly this is the site package located under Packages/Sites/
. To install it correctly, go to your theme package (e.g.Packages/Sites/Foo.Bar
) and run the following command:
composer require jonnitto/prettyembedvideostreamingstreaming --no-update
The --no-update
command prevent the automatic update of the dependencies. After the package was added to your theme composer.json
, go back to the Neos installation's root and run composer update
. Et voilà! Your desired package is now installed correctly.
Customization
Configuration
If you want to customize the default settings, take a look at the Settings.Jonnitto.yaml file. If no node property is giving, these default values will be taken. If you, for example, don't want to let the editor choose if the video should open in a lightbox, you can deactivate the mixin in your Configuration folder like this:
'Jonnitto.PrettyEmbedVideoStreaming:Content.Video':
superTypes:
'Jonnitto.PrettyEmbedHelper:Mixin.Lightbox': false
These are the available mixins (Prefixed with Jonnitto.PrettyEmbedHelper:Mixin.
) used for the video stream:
Mixin name | Description | Default value | Enabled per default |
---|---|---|---|
Groups |
Enables the inspector groups | ✓ | |
IncludeAssets |
Include the frontend resources | ✓ | |
Image |
Add the preview image property | ✓ | |
Lightbox |
Open the video in a lightbox | false |
✓ |
Title |
Set the title to identify the video in the content tree easily, and pass the title as aria-label to the video. |
✓ | |
Loop |
Loop the video | false |
|
Controls |
Show the controls | true |
|
Autoplay |
Autoplays the video | false |
|
Muted |
Mutes the video | false |
Fusion
If you want to use the player as a pure component, you can use the Jonnitto.PrettyEmbedVideoStreaming:Component.Video
fusion prototype.
If you want to read the node properties and let the package handle all for you, you should use the Jonnitto.PrettyEmbedVideoStreaming:Content.Video
prototype. For easier including in your node types, you can disable the content element wrapping with contentElement = false
. This is useful if you want to create, for example, a text with a video node type.