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

#include <requesttypes.h>

Public Member Functions

const ImageFormatformat () const
 Determines the output format of the image - original,gif,jpg,png.

 
void setFormat (ImageFormat newFormat)
 
const qint32 & imageIndex () const
 Image index.
 
void setImageIndex (qint32 newImageIndex)
 
const ImageTypeimageType () const
 Image type.

 
void setImageType (ImageType newImageType)
 
const QString & itemId () const
 Item id.
 
void setItemId (QString newItemId)
 
const qint32 & maxHeight () const
 The maximum image height to return.

 
void setMaxHeight (qint32 newMaxHeight)
 
const qint32 & maxWidth () const
 The maximum image width to return.

 
void setMaxWidth (qint32 newMaxWidth)
 
const double & percentPlayed () const
 Optional. Percent to render for the percent played overlay.

 
void setPercentPlayed (double newPercentPlayed)
 
const QString & tag () const
 Optional. Supply the cache tag from the item object to receive strong caching headers.

 
void setTag (QString newTag)
 
const qint32 & unplayedCount () const
 Optional. Unplayed count overlay to render.

 
void setUnplayedCount (qint32 newUnplayedCount)
 
const bool & addPlayedIndicator () const
 Optional. Add a played indicator.

 
void setAddPlayedIndicator (bool newAddPlayedIndicator)
 
bool addPlayedIndicatorNull () const
 
void setAddPlayedIndicatorNull ()
 
const QString & backgroundColor () const
 Optional. Apply a background color for transparent images.

 
void setBackgroundColor (QString newBackgroundColor)
 
bool backgroundColorNull () const
 
void setBackgroundColorNull ()
 
const qint32 & blur () const
 Optional. Blur image.

 
void setBlur (qint32 newBlur)
 
bool blurNull () const
 
void setBlurNull ()
 
const bool & cropWhitespace () const
 Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
 
void setCropWhitespace (bool newCropWhitespace)
 
bool cropWhitespaceNull () const
 
void setCropWhitespaceNull ()
 
const QString & foregroundLayer () const
 Optional. Apply a foreground layer on top of the image.

 
void setForegroundLayer (QString newForegroundLayer)
 
bool foregroundLayerNull () const
 
void setForegroundLayerNull ()
 
const qint32 & height () const
 The fixed image height to return.

 
void setHeight (qint32 newHeight)
 
bool heightNull () const
 
void setHeightNull ()
 
const qint32 & quality () const
 Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

 
void setQuality (qint32 newQuality)
 
bool qualityNull () const
 
void setQualityNull ()
 
const qint32 & width () const
 The fixed image width to return.
 
void setWidth (qint32 newWidth)
 
bool widthNull () const
 
void setWidthNull ()
 

Member Function Documentation

◆ addPlayedIndicator()

const bool & Jellyfin::Loader::GetItemImage2Params::addPlayedIndicator ( ) const

Optional. Add a played indicator.

◆ addPlayedIndicatorNull()

bool Jellyfin::Loader::GetItemImage2Params::addPlayedIndicatorNull ( ) const

◆ backgroundColor()

const QString & Jellyfin::Loader::GetItemImage2Params::backgroundColor ( ) const

Optional. Apply a background color for transparent images.

◆ backgroundColorNull()

bool Jellyfin::Loader::GetItemImage2Params::backgroundColorNull ( ) const

◆ blur()

const qint32 & Jellyfin::Loader::GetItemImage2Params::blur ( ) const

Optional. Blur image.

◆ blurNull()

bool Jellyfin::Loader::GetItemImage2Params::blurNull ( ) const

◆ cropWhitespace()

const bool & Jellyfin::Loader::GetItemImage2Params::cropWhitespace ( ) const

Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.

◆ cropWhitespaceNull()

bool Jellyfin::Loader::GetItemImage2Params::cropWhitespaceNull ( ) const

◆ foregroundLayer()

const QString & Jellyfin::Loader::GetItemImage2Params::foregroundLayer ( ) const

Optional. Apply a foreground layer on top of the image.

◆ foregroundLayerNull()

bool Jellyfin::Loader::GetItemImage2Params::foregroundLayerNull ( ) const

◆ format()

const ImageFormat & Jellyfin::Loader::GetItemImage2Params::format ( ) const

Determines the output format of the image - original,gif,jpg,png.

◆ height()

const qint32 & Jellyfin::Loader::GetItemImage2Params::height ( ) const

The fixed image height to return.

◆ heightNull()

bool Jellyfin::Loader::GetItemImage2Params::heightNull ( ) const

◆ imageIndex()

const qint32 & Jellyfin::Loader::GetItemImage2Params::imageIndex ( ) const

Image index.

◆ imageType()

const ImageType & Jellyfin::Loader::GetItemImage2Params::imageType ( ) const

Image type.

◆ itemId()

const QString & Jellyfin::Loader::GetItemImage2Params::itemId ( ) const

Item id.

◆ maxHeight()

const qint32 & Jellyfin::Loader::GetItemImage2Params::maxHeight ( ) const

The maximum image height to return.

◆ maxWidth()

const qint32 & Jellyfin::Loader::GetItemImage2Params::maxWidth ( ) const

The maximum image width to return.

◆ percentPlayed()

const double & Jellyfin::Loader::GetItemImage2Params::percentPlayed ( ) const

Optional. Percent to render for the percent played overlay.

◆ quality()

const qint32 & Jellyfin::Loader::GetItemImage2Params::quality ( ) const

Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

◆ qualityNull()

bool Jellyfin::Loader::GetItemImage2Params::qualityNull ( ) const

◆ setAddPlayedIndicator()

void Jellyfin::Loader::GetItemImage2Params::setAddPlayedIndicator ( bool newAddPlayedIndicator)

◆ setAddPlayedIndicatorNull()

void Jellyfin::Loader::GetItemImage2Params::setAddPlayedIndicatorNull ( )

◆ setBackgroundColor()

void Jellyfin::Loader::GetItemImage2Params::setBackgroundColor ( QString newBackgroundColor)

◆ setBackgroundColorNull()

void Jellyfin::Loader::GetItemImage2Params::setBackgroundColorNull ( )

◆ setBlur()

void Jellyfin::Loader::GetItemImage2Params::setBlur ( qint32 newBlur)

◆ setBlurNull()

void Jellyfin::Loader::GetItemImage2Params::setBlurNull ( )

◆ setCropWhitespace()

void Jellyfin::Loader::GetItemImage2Params::setCropWhitespace ( bool newCropWhitespace)

◆ setCropWhitespaceNull()

void Jellyfin::Loader::GetItemImage2Params::setCropWhitespaceNull ( )

◆ setForegroundLayer()

void Jellyfin::Loader::GetItemImage2Params::setForegroundLayer ( QString newForegroundLayer)

◆ setForegroundLayerNull()

void Jellyfin::Loader::GetItemImage2Params::setForegroundLayerNull ( )

◆ setFormat()

void Jellyfin::Loader::GetItemImage2Params::setFormat ( ImageFormat newFormat)

◆ setHeight()

void Jellyfin::Loader::GetItemImage2Params::setHeight ( qint32 newHeight)

◆ setHeightNull()

void Jellyfin::Loader::GetItemImage2Params::setHeightNull ( )

◆ setImageIndex()

void Jellyfin::Loader::GetItemImage2Params::setImageIndex ( qint32 newImageIndex)

◆ setImageType()

void Jellyfin::Loader::GetItemImage2Params::setImageType ( ImageType newImageType)

◆ setItemId()

void Jellyfin::Loader::GetItemImage2Params::setItemId ( QString newItemId)

◆ setMaxHeight()

void Jellyfin::Loader::GetItemImage2Params::setMaxHeight ( qint32 newMaxHeight)

◆ setMaxWidth()

void Jellyfin::Loader::GetItemImage2Params::setMaxWidth ( qint32 newMaxWidth)

◆ setPercentPlayed()

void Jellyfin::Loader::GetItemImage2Params::setPercentPlayed ( double newPercentPlayed)

◆ setQuality()

void Jellyfin::Loader::GetItemImage2Params::setQuality ( qint32 newQuality)

◆ setQualityNull()

void Jellyfin::Loader::GetItemImage2Params::setQualityNull ( )

◆ setTag()

void Jellyfin::Loader::GetItemImage2Params::setTag ( QString newTag)

◆ setUnplayedCount()

void Jellyfin::Loader::GetItemImage2Params::setUnplayedCount ( qint32 newUnplayedCount)

◆ setWidth()

void Jellyfin::Loader::GetItemImage2Params::setWidth ( qint32 newWidth)

◆ setWidthNull()

void Jellyfin::Loader::GetItemImage2Params::setWidthNull ( )

◆ tag()

const QString & Jellyfin::Loader::GetItemImage2Params::tag ( ) const

Optional. Supply the cache tag from the item object to receive strong caching headers.

◆ unplayedCount()

const qint32 & Jellyfin::Loader::GetItemImage2Params::unplayedCount ( ) const

Optional. Unplayed count overlay to render.

◆ width()

const qint32 & Jellyfin::Loader::GetItemImage2Params::width ( ) const

The fixed image width to return.

◆ widthNull()

bool Jellyfin::Loader::GetItemImage2Params::widthNull ( ) const

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