upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-07-15 13:01:34 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 55

docs(preview): clarify IProviderV2 thumbnail and preview terminology

Browse source 
Signed-off-by: Josh <josh.t.richards@gmail.com>
This commit is contained in:
Josh 2026-06-27 12:33:51 -04:00 committed by GitHub
parent 1eb5f1331b
commit effd4a96e0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 13 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
lib/public/Preview/IProviderV2.php
View file

@ -13,31 +13,37 @@ use OCP\Files\FileInfo;
use OCP\IImage;
/**
* Public interface for preview providers.
*
* A preview provider generates a thumbnail image for supported files. That image
* may be stored and reused by the preview system.
*
* @since 17.0.0
*/
interface IProviderV2 {
/**
* @return string Regex with the mimetypes that are supported by this provider
* Returns the mime-type regex supported by this provider.
*
* @return string Regex matching the mime types supported by this provider
* @since 17.0.0
*/
public function getMimeType(): string;
/**
* Check if a preview can be generated for $path
* Returns whether this provider can currently generate a thumbnail for the given file.
*
* @param FileInfo $file
* @return bool
* @since 17.0.0
*/
public function isAvailable(FileInfo $file): bool;
/**
* get thumbnail for file at path $path
* Generates a thumbnail image for the given file.
*
* @param File $file
* @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image
* @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image
* @return null|\OCP\IImage null if no preview was generated
* @param int $maxX Maximum thumbnail width; the returned image may be smaller depending on its aspect ratio
* @param int $maxY Maximum thumbnail height; the returned image may be smaller depending on its aspect ratio
* @return IImage|null Null if no thumbnail could be generated
* @since 17.0.0
*/
public function getThumbnail(File $file, int $maxX, int $maxY): ?IImage;