Jellyfin::Loader::GetUserImageByIndexParams Class Reference

#include <requesttypes.h>

Public Member Functions
const qint32 &	imageIndex () const
	Image index.
void	setImageIndex (qint32 newImageIndex)
const ImageType &	imageType () const
	Image type.
void	setImageType (ImageType newImageType)
const QString &	userId () const
	User id.
void	setUserId (QString newUserId)
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 ImageFormat &	format () const
	Determines the output format of the image - original,gif,jpg,png.
void	setFormat (ImageFormat newFormat)
bool	formatNull () const
void	setFormatNull ()
const qint32 &	height () const
	The fixed image height to return.
void	setHeight (qint32 newHeight)
bool	heightNull () const
void	setHeightNull ()
const qint32 &	maxHeight () const
	The maximum image height to return.
void	setMaxHeight (qint32 newMaxHeight)
bool	maxHeightNull () const
void	setMaxHeightNull ()
const qint32 &	maxWidth () const
	The maximum image width to return.
void	setMaxWidth (qint32 newMaxWidth)
bool	maxWidthNull () const
void	setMaxWidthNull ()
const double &	percentPlayed () const
	Optional. Percent to render for the percent played overlay.
void	setPercentPlayed (double newPercentPlayed)
bool	percentPlayedNull () const
void	setPercentPlayedNull ()
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 QString &	tag () const
	Optional. Supply the cache tag from the item object to receive strong caching headers.
void	setTag (QString newTag)
bool	tagNull () const
void	setTagNull ()
const qint32 &	unplayedCount () const
	Optional. Unplayed count overlay to render.
void	setUnplayedCount (qint32 newUnplayedCount)
bool	unplayedCountNull () const
void	setUnplayedCountNull ()
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::GetUserImageByIndexParams::addPlayedIndicator

(

)

const

Optional. Add a played indicator.

addPlayedIndicatorNull()

bool Jellyfin::Loader::GetUserImageByIndexParams::addPlayedIndicatorNull

(

)

const

backgroundColor()

const QString & Jellyfin::Loader::GetUserImageByIndexParams::backgroundColor

(

)

const

Optional. Apply a background color for transparent images.

backgroundColorNull()

bool Jellyfin::Loader::GetUserImageByIndexParams::backgroundColorNull

(

)

const

blur()

const qint32 & Jellyfin::Loader::GetUserImageByIndexParams::blur

(

)

const

Optional. Blur image.

blurNull()

bool Jellyfin::Loader::GetUserImageByIndexParams::blurNull

(

)

const

cropWhitespace()

const bool & Jellyfin::Loader::GetUserImageByIndexParams::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::GetUserImageByIndexParams::cropWhitespaceNull

(

)

const

foregroundLayer()

const QString & Jellyfin::Loader::GetUserImageByIndexParams::foregroundLayer

(

)

const

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

foregroundLayerNull()

bool Jellyfin::Loader::GetUserImageByIndexParams::foregroundLayerNull

(

)

const

format()

const ImageFormat & Jellyfin::Loader::GetUserImageByIndexParams::format

(

)

const

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

formatNull()

bool Jellyfin::Loader::GetUserImageByIndexParams::formatNull

(

)

const

height()

const qint32 & Jellyfin::Loader::GetUserImageByIndexParams::height

(

)

const

The fixed image height to return.

heightNull()

bool Jellyfin::Loader::GetUserImageByIndexParams::heightNull

(

)

const

imageIndex()

const qint32 & Jellyfin::Loader::GetUserImageByIndexParams::imageIndex

(

)

const

Image index.

imageType()

const ImageType & Jellyfin::Loader::GetUserImageByIndexParams::imageType

(

)

const

Image type.

maxHeight()

const qint32 & Jellyfin::Loader::GetUserImageByIndexParams::maxHeight

(

)

const

The maximum image height to return.

maxHeightNull()

bool Jellyfin::Loader::GetUserImageByIndexParams::maxHeightNull

(

)

const

maxWidth()

const qint32 & Jellyfin::Loader::GetUserImageByIndexParams::maxWidth

(

)

const

The maximum image width to return.

maxWidthNull()

bool Jellyfin::Loader::GetUserImageByIndexParams::maxWidthNull

(

)

const

percentPlayed()

const double & Jellyfin::Loader::GetUserImageByIndexParams::percentPlayed

(

)

const

Optional. Percent to render for the percent played overlay.

percentPlayedNull()

bool Jellyfin::Loader::GetUserImageByIndexParams::percentPlayedNull

(

)

const

quality()

const qint32 & Jellyfin::Loader::GetUserImageByIndexParams::quality

(

)

const

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

qualityNull()

bool Jellyfin::Loader::GetUserImageByIndexParams::qualityNull

(

)

const

setAddPlayedIndicator()

void Jellyfin::Loader::GetUserImageByIndexParams::setAddPlayedIndicator

(

bool

newAddPlayedIndicator

)

setAddPlayedIndicatorNull()

void Jellyfin::Loader::GetUserImageByIndexParams::setAddPlayedIndicatorNull

(

)

setBackgroundColor()

void Jellyfin::Loader::GetUserImageByIndexParams::setBackgroundColor

(

QString

newBackgroundColor

)

setBackgroundColorNull()

void Jellyfin::Loader::GetUserImageByIndexParams::setBackgroundColorNull

(

)

setBlur()

void Jellyfin::Loader::GetUserImageByIndexParams::setBlur

(

qint32

newBlur

)

setBlurNull()

void Jellyfin::Loader::GetUserImageByIndexParams::setBlurNull

(

)

setCropWhitespace()

void Jellyfin::Loader::GetUserImageByIndexParams::setCropWhitespace

(

bool

newCropWhitespace

)

setCropWhitespaceNull()

void Jellyfin::Loader::GetUserImageByIndexParams::setCropWhitespaceNull

(

)

setForegroundLayer()

void Jellyfin::Loader::GetUserImageByIndexParams::setForegroundLayer

(

QString

newForegroundLayer

)

setForegroundLayerNull()

void Jellyfin::Loader::GetUserImageByIndexParams::setForegroundLayerNull

(

)

setFormat()

void Jellyfin::Loader::GetUserImageByIndexParams::setFormat

(

ImageFormat

newFormat

)

setFormatNull()

void Jellyfin::Loader::GetUserImageByIndexParams::setFormatNull

(

)

setHeight()

void Jellyfin::Loader::GetUserImageByIndexParams::setHeight

(

qint32

newHeight

)

setHeightNull()

void Jellyfin::Loader::GetUserImageByIndexParams::setHeightNull

(

)

setImageIndex()

void Jellyfin::Loader::GetUserImageByIndexParams::setImageIndex

(

qint32

newImageIndex

)

setImageType()

void Jellyfin::Loader::GetUserImageByIndexParams::setImageType

(

ImageType

newImageType

)

setMaxHeight()

void Jellyfin::Loader::GetUserImageByIndexParams::setMaxHeight

(

qint32

newMaxHeight

)

setMaxHeightNull()

void Jellyfin::Loader::GetUserImageByIndexParams::setMaxHeightNull

(

)

setMaxWidth()

void Jellyfin::Loader::GetUserImageByIndexParams::setMaxWidth

(

qint32

newMaxWidth

)

setMaxWidthNull()

void Jellyfin::Loader::GetUserImageByIndexParams::setMaxWidthNull

(

)

setPercentPlayed()

void Jellyfin::Loader::GetUserImageByIndexParams::setPercentPlayed

(

double

newPercentPlayed

)

setPercentPlayedNull()

void Jellyfin::Loader::GetUserImageByIndexParams::setPercentPlayedNull

(

)

setQuality()

void Jellyfin::Loader::GetUserImageByIndexParams::setQuality

(

qint32

newQuality

)

setQualityNull()

void Jellyfin::Loader::GetUserImageByIndexParams::setQualityNull

(

)

setTag()

void Jellyfin::Loader::GetUserImageByIndexParams::setTag

(

QString

newTag

)

setTagNull()

void Jellyfin::Loader::GetUserImageByIndexParams::setTagNull

(

)

setUnplayedCount()

void Jellyfin::Loader::GetUserImageByIndexParams::setUnplayedCount

(

qint32

newUnplayedCount

)

setUnplayedCountNull()

void Jellyfin::Loader::GetUserImageByIndexParams::setUnplayedCountNull

(

)

setUserId()

void Jellyfin::Loader::GetUserImageByIndexParams::setUserId

(

QString

newUserId

)

setWidth()

void Jellyfin::Loader::GetUserImageByIndexParams::setWidth

(

qint32

newWidth

)

setWidthNull()

void Jellyfin::Loader::GetUserImageByIndexParams::setWidthNull

(

)

tag()

const QString & Jellyfin::Loader::GetUserImageByIndexParams::tag

(

)

const

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

tagNull()

bool Jellyfin::Loader::GetUserImageByIndexParams::tagNull

(

)

const

unplayedCount()

const qint32 & Jellyfin::Loader::GetUserImageByIndexParams::unplayedCount

(

)

const

Optional. Unplayed count overlay to render.

unplayedCountNull()

bool Jellyfin::Loader::GetUserImageByIndexParams::unplayedCountNull

(

)

const

userId()

const QString & Jellyfin::Loader::GetUserImageByIndexParams::userId

(

)

const

User id.

width()

const qint32 & Jellyfin::Loader::GetUserImageByIndexParams::width

(

)

const

The fixed image width to return.

widthNull()

bool Jellyfin::Loader::GetUserImageByIndexParams::widthNull

(

)

const

---

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

• core/include/JellyfinQt/loader/requesttypes.h
• core/src/loader/requesttypes.cpp