Jellyfin Qt
QML Library for interacting with the Jellyfin multimedia server
Loading...
Searching...
No Matches
Jellyfin::DTO::TrickplayOptions Class Reference

#include <trickplayoptions.h>

Public Member Functions

 TrickplayOptions (bool enableHwAcceleration, bool enableHwEncoding, bool enableKeyFrameOnlyExtraction, TrickplayScanBehavior scanBehavior, ProcessPriorityClass processPriority, qint32 interval, QList< qint32 > widthResolutions, qint32 tileWidth, qint32 tileHeight, qint32 qscale, qint32 jpegQuality, qint32 processThreads)
 TrickplayOptions (const TrickplayOptions &other)
void replaceData (TrickplayOptions &other)
void setFromJson (QJsonObject source)
QJsonObject toJson () const
bool enableHwAcceleration () const
 Gets or sets a value indicating whether or not to use HW acceleration.
void setEnableHwAcceleration (bool newEnableHwAcceleration)
 Gets or sets a value indicating whether or not to use HW acceleration.
bool enableHwEncoding () const
 Gets or sets a value indicating whether or not to use HW accelerated MJPEG encoding.
void setEnableHwEncoding (bool newEnableHwEncoding)
 Gets or sets a value indicating whether or not to use HW accelerated MJPEG encoding.
bool enableKeyFrameOnlyExtraction () const
void setEnableKeyFrameOnlyExtraction (bool newEnableKeyFrameOnlyExtraction)
TrickplayScanBehavior scanBehavior () const
void setScanBehavior (TrickplayScanBehavior newScanBehavior)
ProcessPriorityClass processPriority () const
void setProcessPriority (ProcessPriorityClass newProcessPriority)
qint32 interval () const
 Gets or sets the interval, in ms, between each new trickplay image.
void setInterval (qint32 newInterval)
 Gets or sets the interval, in ms, between each new trickplay image.
QList< qint32 > widthResolutions () const
 Gets or sets the target width resolutions, in px, to generates preview images for.
void setWidthResolutions (QList< qint32 > newWidthResolutions)
 Gets or sets the target width resolutions, in px, to generates preview images for.
qint32 tileWidth () const
 Gets or sets number of tile images to allow in X dimension.
void setTileWidth (qint32 newTileWidth)
 Gets or sets number of tile images to allow in X dimension.
qint32 tileHeight () const
 Gets or sets number of tile images to allow in Y dimension.
void setTileHeight (qint32 newTileHeight)
 Gets or sets number of tile images to allow in Y dimension.
qint32 qscale () const
 Gets or sets the ffmpeg output quality level.
void setQscale (qint32 newQscale)
 Gets or sets the ffmpeg output quality level.
qint32 jpegQuality () const
 Gets or sets the jpeg quality to use for image tiles.
void setJpegQuality (qint32 newJpegQuality)
 Gets or sets the jpeg quality to use for image tiles.
qint32 processThreads () const
 Gets or sets the number of threads to be used by ffmpeg.
void setProcessThreads (qint32 newProcessThreads)
 Gets or sets the number of threads to be used by ffmpeg.

Static Public Member Functions

static TrickplayOptions fromJson (QJsonObject source)

Protected Attributes

bool m_enableHwAcceleration
bool m_enableHwEncoding
bool m_enableKeyFrameOnlyExtraction
TrickplayScanBehavior m_scanBehavior
ProcessPriorityClass m_processPriority
qint32 m_interval
QList< qint32 > m_widthResolutions
qint32 m_tileWidth
qint32 m_tileHeight
qint32 m_qscale
qint32 m_jpegQuality
qint32 m_processThreads

Constructor & Destructor Documentation

◆ TrickplayOptions() [1/2]

Jellyfin::DTO::TrickplayOptions::TrickplayOptions ( bool enableHwAcceleration,
bool enableHwEncoding,
bool enableKeyFrameOnlyExtraction,
TrickplayScanBehavior scanBehavior,
ProcessPriorityClass processPriority,
qint32 interval,
QList< qint32 > widthResolutions,
qint32 tileWidth,
qint32 tileHeight,
qint32 qscale,
qint32 jpegQuality,
qint32 processThreads )

◆ TrickplayOptions() [2/2]

Jellyfin::DTO::TrickplayOptions::TrickplayOptions ( const TrickplayOptions & other)

Member Function Documentation

◆ enableHwAcceleration()

bool Jellyfin::DTO::TrickplayOptions::enableHwAcceleration ( ) const

Gets or sets a value indicating whether or not to use HW acceleration.

◆ enableHwEncoding()

bool Jellyfin::DTO::TrickplayOptions::enableHwEncoding ( ) const

Gets or sets a value indicating whether or not to use HW accelerated MJPEG encoding.

◆ enableKeyFrameOnlyExtraction()

bool Jellyfin::DTO::TrickplayOptions::enableKeyFrameOnlyExtraction ( ) const
   @brief Gets or sets a value indicating whether to only extract key frames.

Significantly faster, but is not compatible with all decoders and/or video files.

◆ fromJson()

TrickplayOptions Jellyfin::DTO::TrickplayOptions::fromJson ( QJsonObject source)
static

◆ interval()

qint32 Jellyfin::DTO::TrickplayOptions::interval ( ) const

Gets or sets the interval, in ms, between each new trickplay image.

◆ jpegQuality()

qint32 Jellyfin::DTO::TrickplayOptions::jpegQuality ( ) const

Gets or sets the jpeg quality to use for image tiles.

◆ processPriority()

ProcessPriorityClass Jellyfin::DTO::TrickplayOptions::processPriority ( ) const

◆ processThreads()

qint32 Jellyfin::DTO::TrickplayOptions::processThreads ( ) const

Gets or sets the number of threads to be used by ffmpeg.

◆ qscale()

qint32 Jellyfin::DTO::TrickplayOptions::qscale ( ) const

Gets or sets the ffmpeg output quality level.

◆ replaceData()

void Jellyfin::DTO::TrickplayOptions::replaceData ( TrickplayOptions & other)

Replaces the data being hold by this class with that of the other.

◆ scanBehavior()

TrickplayScanBehavior Jellyfin::DTO::TrickplayOptions::scanBehavior ( ) const

◆ setEnableHwAcceleration()

void Jellyfin::DTO::TrickplayOptions::setEnableHwAcceleration ( bool newEnableHwAcceleration)

Gets or sets a value indicating whether or not to use HW acceleration.

◆ setEnableHwEncoding()

void Jellyfin::DTO::TrickplayOptions::setEnableHwEncoding ( bool newEnableHwEncoding)

Gets or sets a value indicating whether or not to use HW accelerated MJPEG encoding.

◆ setEnableKeyFrameOnlyExtraction()

void Jellyfin::DTO::TrickplayOptions::setEnableKeyFrameOnlyExtraction ( bool newEnableKeyFrameOnlyExtraction)
  @brief Gets or sets a value indicating whether to only extract key frames.

Significantly faster, but is not compatible with all decoders and/or video files.

◆ setFromJson()

void Jellyfin::DTO::TrickplayOptions::setFromJson ( QJsonObject source)

◆ setInterval()

void Jellyfin::DTO::TrickplayOptions::setInterval ( qint32 newInterval)

Gets or sets the interval, in ms, between each new trickplay image.

◆ setJpegQuality()

void Jellyfin::DTO::TrickplayOptions::setJpegQuality ( qint32 newJpegQuality)

Gets or sets the jpeg quality to use for image tiles.

◆ setProcessPriority()

void Jellyfin::DTO::TrickplayOptions::setProcessPriority ( ProcessPriorityClass newProcessPriority)

◆ setProcessThreads()

void Jellyfin::DTO::TrickplayOptions::setProcessThreads ( qint32 newProcessThreads)

Gets or sets the number of threads to be used by ffmpeg.

◆ setQscale()

void Jellyfin::DTO::TrickplayOptions::setQscale ( qint32 newQscale)

Gets or sets the ffmpeg output quality level.

◆ setScanBehavior()

void Jellyfin::DTO::TrickplayOptions::setScanBehavior ( TrickplayScanBehavior newScanBehavior)

◆ setTileHeight()

void Jellyfin::DTO::TrickplayOptions::setTileHeight ( qint32 newTileHeight)

Gets or sets number of tile images to allow in Y dimension.

◆ setTileWidth()

void Jellyfin::DTO::TrickplayOptions::setTileWidth ( qint32 newTileWidth)

Gets or sets number of tile images to allow in X dimension.

◆ setWidthResolutions()

void Jellyfin::DTO::TrickplayOptions::setWidthResolutions ( QList< qint32 > newWidthResolutions)

Gets or sets the target width resolutions, in px, to generates preview images for.

◆ tileHeight()

qint32 Jellyfin::DTO::TrickplayOptions::tileHeight ( ) const

Gets or sets number of tile images to allow in Y dimension.

◆ tileWidth()

qint32 Jellyfin::DTO::TrickplayOptions::tileWidth ( ) const

Gets or sets number of tile images to allow in X dimension.

◆ toJson()

QJsonObject Jellyfin::DTO::TrickplayOptions::toJson ( ) const

◆ widthResolutions()

QList< qint32 > Jellyfin::DTO::TrickplayOptions::widthResolutions ( ) const

Gets or sets the target width resolutions, in px, to generates preview images for.

Member Data Documentation

◆ m_enableHwAcceleration

bool Jellyfin::DTO::TrickplayOptions::m_enableHwAcceleration
protected

◆ m_enableHwEncoding

bool Jellyfin::DTO::TrickplayOptions::m_enableHwEncoding
protected

◆ m_enableKeyFrameOnlyExtraction

bool Jellyfin::DTO::TrickplayOptions::m_enableKeyFrameOnlyExtraction
protected

◆ m_interval

qint32 Jellyfin::DTO::TrickplayOptions::m_interval
protected

◆ m_jpegQuality

qint32 Jellyfin::DTO::TrickplayOptions::m_jpegQuality
protected

◆ m_processPriority

ProcessPriorityClass Jellyfin::DTO::TrickplayOptions::m_processPriority
protected

◆ m_processThreads

qint32 Jellyfin::DTO::TrickplayOptions::m_processThreads
protected

◆ m_qscale

qint32 Jellyfin::DTO::TrickplayOptions::m_qscale
protected

◆ m_scanBehavior

TrickplayScanBehavior Jellyfin::DTO::TrickplayOptions::m_scanBehavior
protected

◆ m_tileHeight

qint32 Jellyfin::DTO::TrickplayOptions::m_tileHeight
protected

◆ m_tileWidth

qint32 Jellyfin::DTO::TrickplayOptions::m_tileWidth
protected

◆ m_widthResolutions

QList<qint32> Jellyfin::DTO::TrickplayOptions::m_widthResolutions
protected

The documentation for this class was generated from the following files: