AfterVideoPreviewFetchedEvent¶
New in version 12.2.
The purpose of the PSR-14 event
\TYPO3\CMS\Core\Resource\OnlineMedia\Event\AfterVideoPreviewFetchedEvent
is to modify the preview file of online media previews (like YouTube and Vimeo).
If, for example, a processed file is bad (blank or outdated), this event can be
used to modify and/or update the preview file.
Example¶
Registration of the event listener in the extension's Services.yaml
:
EXT:my_extension/Configuration/Services.yaml¶
services:
# Place here the default dependency injection configuration
MyVendor\MyExtension\Resource\EventListener\MyEventListener:
tags:
- name: event.listener
identifier: 'my-extension/after-video-preview-fetched'
Read how to configure dependency injection in extensions.
The corresponding event listener class:
EXT:my_extension/Classes/Resource/EventListener/MyEventListener.php¶
<?php
declare(strict_types=1);
namespace MyVendor\MyExtension\Resource\EventListener;
use TYPO3\CMS\Core\Resource\OnlineMedia\Event\AfterVideoPreviewFetchedEvent;
final class MyEventListener
{
public function __invoke(AfterVideoPreviewFetchedEvent $event): void
{
$event->setPreviewImageFilename(
'/var/www/html/typo3temp/assets/online_media/new-preview-image.jpg'
);
}
}
API¶
- class TYPO3\CMS\Core\Resource\OnlineMedia\Event\AfterVideoPreviewFetchedEvent¶
Allows to modify a generated YouTube/Vimeo (or other Online Media) preview images
- getFile()¶
- Return type
TYPO3\CMS\Core\Resource\File
- getOnlineMediaId()¶
- Return type
string
- getPreviewImageFilename()¶
- Return type
string
- setPreviewImageFilename(string $previewImageFilename)¶
- Parameters
$previewImageFilename (
string
) -- the previewImageFilename