README

1 Features

Twitch videos can be created as a file in the TYPO3 file list
Twitch videos can be used and output with the text with media element
Update metadata via command

2 Usage

2.1 Prerequisites

Twitch unfortunately does not provide us with an oEmbed interface, so we have to query the data via an API. The setup is done quite quickly, though.

First, you need a Twitch account with 2FA to be able to create an app with it via Twitch Console.

The application only needs a name and 2-3 settings. Interesting for us is the ClientId, which we also need for the communication. Client Secret must also be generated, because we need it for the generation of the token need.

After creating the application you still need a token. For this you can install the Twitch CLI. If everything is installed, you can generate a token with twitch token and the input of Client ID and Client Secret. Please save this token.

In the TYPO3 Install Tool you can now store the two settings "Token" and "Client Id". Without this data there will be errors in the backend, and we will not get any data from Twitch.

It may well be that the token needs to be updated regularly.

2.2 Installation

Installation using Composer

The recommended way to install the extension is using Composer.

Run the following command within your Composer based TYPO3 project:

composer require ayacoo/twitch

2.3 TypoScript settings

Privacy

With plugin.tx_twitch.settings.privacy = 1 you can ensure that the IFrame is built with data-src instead of src. If you need more options to influence the HTML, you can use a PSR-14 event.

2.4 Hints

Output

For the output, the HTML is used directly from Twitch.

SQL changes

In order not to have to access the oEmbed interface permanently, one thumbnail field are added to the sys_file_metadata table

TYPO3 v10

If you want to use the extension with TYPO3 v10, it should work in principle. The code is close to the v10. You can create a repository via a Github fork and modify / add the necessary lines there.

Videos vs Clips

Clips are excerpts from videos. If you want to enter them specifically, you can control the entry via the Time parameter. If you prefer to have the clips as data sets, you can also register a MediaViewHelper relatively easily. The structure is comparable to the Twitch videos.

3 Developer Corner

3.1 ModifyTwitchOutputEvent

If you want to modify the output of the Twitch HTML, you can use the ModifyTwitchOutputEvent.

EventListener registration

In your extension, extend Configuration/Services.yaml once:

Vendor\ExtName\EventListener\TwitchOutputEventListener:
    tags:
        -   name: event.listener
            identifier: 'twitch/output'
            event: Ayacoo\Twitch\Event\ModifyTwitchOutputEvent

<?php

namespace Vendor\ExtName\EventListener;

use Ayacoo\Twitch\Event\ModifyTwitchOutputEvent;

class TwitchOutputEventListener
{
    public function __invoke(ModifyTwitchOutputEvent $event): void
    {
        $output = $event->getOutput();
        $output = str_replace('src', 'data-src', $output);
        $event->setOutput($output);
    }
}

3.2 Backend Preview

In the backend, the preview is used by TextMediaRenderer. For online media, this only displays the provider's icon, in this case twitch. If you want to display the thumbnail, for example, you need your own renderer that overwrites Textmedia. An example renderer is available in the project. Caution: This overwrites all text media elements, so only use this renderer as a basis.

You register a renderer in the TCA Configuration/TCA/Overrides/tt_content.php with $GLOBALS['TCA']['tt_content']['types']['textmedia']['previewRenderer'] = \Ayacoo\Twitch\Rendering\TwitchPreviewRenderer::class;

Documentation: https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ApiOverview/ContentElements/CustomBackendPreview.html

3.3 Content security policy

If CSP is activated in the backend, policies will be automatically added. To do this, the file Configuration/ContentSecurityPolicies.php is used.

If CSP is to be extended for the frontend, the configuration can be added in a site package extension or in the global csp.yml

Take a look at the current documentation: https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ApiOverview/ContentSecurityPolicy/Index.html

4 Administration corner

4.1 Versions and support

4.2 Release Management

twitch uses semantic versioning, which means, that

bugfix updates (e.g. 1.0.0 => 1.0.1) just includes small bugfixes or security relevant stuff without breaking changes,
minor updates (e.g. 1.0.0 => 1.1.0) includes new features and smaller tasks without breaking changes,
and major updates (e.g. 1.0.0 => 2.0.0) breaking changes which can be refactorings, features or bugfixes.

4.3 Contribution

Pull Requests are gladly welcome! Nevertheless please don't forget to add an issue and connect it to your pull requests. This is very helpful to understand what kind of issue the PR is going to solve.

Bugfixes: Please describe what kind of bug your fix solve and give us feedback how to reproduce the issue. We're going to accept only bugfixes if we can reproduce the issue.

5 Thanks / Notices

Special thanks to Georg Ringer and his news extension. A good template to build a TYPO3 extension. Here, for example, the structure of README.md is used.
Thanks also to b13 for the online-media-updater extension. Parts of it were allowed to be included in this extension.

6 Support

If you are happy with the extension and would like to support it in any way, I would appreciate the support of social institutions.

ayacoo / twitch

Maintainers

Details