KIO
ThumbSequenceCreator Class Reference
#include <thumbsequencecreator.h>

Public Member Functions | |
float | sequenceIndex () const |
void | setSequenceIndex (float index) |
ThumbSequenceCreator () | |
virtual | ~ThumbSequenceCreator () |
Detailed Description
- See also:
- ThumbCreator
This is an extension of ThumbCreator that allows creating a thumbnail sequence for a file. If your thumbnail plugin can create a thumbnail sequence, you should base it on ThumbSequenceCreator instead of ThumbCreator, and should use sequenceIndex() to decide what thumbnail you generate.
- Since:
- 4.3
Definition at line 35 of file thumbsequencecreator.h.
Constructor & Destructor Documentation
ThumbSequenceCreator::ThumbSequenceCreator | ( | ) |
Definition at line 37 of file thumbsequencecreator.cpp.
ThumbSequenceCreator::~ThumbSequenceCreator | ( | ) | [virtual] |
Definition at line 41 of file thumbsequencecreator.cpp.
Member Function Documentation
float ThumbSequenceCreator::sequenceIndex | ( | ) | const |
If this thumb-creator can create a sequence of thumbnails, it should use this to decide what sequence item to use.
If the value is zero, the standard thumbnail should be created.
This can be used for example to create thumbnails for different timeframes in videos(For example 0m, 10m, 20m, ...).
If your thumb-creator supports a high granularity, like a video, you can respect the sub-integer precision coming from the float. Else, just round the index to an integer.
If the end of your sequence is reached, the sequence should start from the beginning, or continue in some other way.
Definition at line 29 of file thumbsequencecreator.cpp.
void ThumbSequenceCreator::setSequenceIndex | ( | float | index | ) |
Sets the sequence-index for this thumb creator.
- See also:
- sequenceIndex
Definition at line 33 of file thumbsequencecreator.cpp.
The documentation for this class was generated from the following files: