harbour-sailfin/core/include/JellyfinQt/dto/deviceprofile.h

/*
 * Sailfin: a Jellyfin client written using Qt
 * Copyright (C) 2021 Chris Josten and the Sailfin Contributors.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
/*
 * WARNING: THIS IS AN AUTOMATICALLY GENERATED FILE! PLEASE DO NOT EDIT THIS, AS YOUR EDITS WILL GET
 * OVERWRITTEN AT SOME POINT! 
 *
 * If there is a bug in this file, please fix the code generator used to generate this file found in
 * core/openapigenerator.d. 
 *
 * This file is generated based on Jellyfin's OpenAPI description, "openapi.json". Please update that
 * file with a newer file if needed instead of manually updating the files.
 */

#ifndef JELLYFIN_DTO_DEVICEPROFILE_H
#define JELLYFIN_DTO_DEVICEPROFILE_H

#include <QJsonObject>
#include <QJsonValue>
#include <QList>
#include <QSharedPointer>
#include <QString>
#include <QStringList>
#include <optional>

#include "JellyfinQt/dto/codecprofile.h"
#include "JellyfinQt/dto/containerprofile.h"
#include "JellyfinQt/dto/deviceidentification.h"
#include "JellyfinQt/dto/directplayprofile.h"
#include "JellyfinQt/dto/responseprofile.h"
#include "JellyfinQt/dto/subtitleprofile.h"
#include "JellyfinQt/dto/transcodingprofile.h"
#include "JellyfinQt/dto/xmlattribute.h"
#include "JellyfinQt/support/jsonconv.h"

namespace Jellyfin {
// Forward declaration
class ApiClient;
}
namespace Jellyfin {
namespace DTO {


class DeviceProfile {
public:
	DeviceProfile(					
		QSharedPointer<DeviceIdentification> identification,																			
		bool enableAlbumArtInDidl,			
		bool enableSingleAlbumArtLimit,			
		bool enableSingleSubtitleLimit,									
		qint32 maxAlbumArtWidth,			
		qint32 maxAlbumArtHeight,																			
		qint32 timelineOffsetSeconds,			
		bool requiresPlainVideoItems,			
		bool requiresPlainFolders,			
		bool enableMSMediaReceiverRegistrar,			
		bool ignoreTranscodeByteRangeRequests																
	);

	DeviceProfile(const DeviceProfile &other);
	
	/**
	 * Replaces the data being hold by this class with that of the other.
	 */
	void replaceData(DeviceProfile &other);
	
	static DeviceProfile fromJson(QJsonObject source);
	void setFromJson(QJsonObject source);
	QJsonObject toJson() const;
	
	// Properties
	/**
	 * @brief Gets or sets the Name.
	 */
	QString name() const;
	/**
	* @brief Gets or sets the Name.
	*/
	void setName(QString newName);
	bool nameNull() const;
	void setNameNull();

	/**
	 * @brief Gets or sets the Id.
	 */
	QString jellyfinId() const;
	/**
	* @brief Gets or sets the Id.
	*/
	void setJellyfinId(QString newJellyfinId);
	bool jellyfinIdNull() const;
	void setJellyfinIdNull();


	QSharedPointer<DeviceIdentification> identification() const;

	void setIdentification(QSharedPointer<DeviceIdentification> newIdentification);

	/**
	 * @brief Gets or sets the FriendlyName.
	 */
	QString friendlyName() const;
	/**
	* @brief Gets or sets the FriendlyName.
	*/
	void setFriendlyName(QString newFriendlyName);
	bool friendlyNameNull() const;
	void setFriendlyNameNull();

	/**
	 * @brief Gets or sets the Manufacturer.
	 */
	QString manufacturer() const;
	/**
	* @brief Gets or sets the Manufacturer.
	*/
	void setManufacturer(QString newManufacturer);
	bool manufacturerNull() const;
	void setManufacturerNull();

	/**
	 * @brief Gets or sets the ManufacturerUrl.
	 */
	QString manufacturerUrl() const;
	/**
	* @brief Gets or sets the ManufacturerUrl.
	*/
	void setManufacturerUrl(QString newManufacturerUrl);
	bool manufacturerUrlNull() const;
	void setManufacturerUrlNull();

	/**
	 * @brief Gets or sets the ModelName.
	 */
	QString modelName() const;
	/**
	* @brief Gets or sets the ModelName.
	*/
	void setModelName(QString newModelName);
	bool modelNameNull() const;
	void setModelNameNull();

	/**
	 * @brief Gets or sets the ModelDescription.
	 */
	QString modelDescription() const;
	/**
	* @brief Gets or sets the ModelDescription.
	*/
	void setModelDescription(QString newModelDescription);
	bool modelDescriptionNull() const;
	void setModelDescriptionNull();

	/**
	 * @brief Gets or sets the ModelNumber.
	 */
	QString modelNumber() const;
	/**
	* @brief Gets or sets the ModelNumber.
	*/
	void setModelNumber(QString newModelNumber);
	bool modelNumberNull() const;
	void setModelNumberNull();

	/**
	 * @brief Gets or sets the ModelUrl.
	 */
	QString modelUrl() const;
	/**
	* @brief Gets or sets the ModelUrl.
	*/
	void setModelUrl(QString newModelUrl);
	bool modelUrlNull() const;
	void setModelUrlNull();

	/**
	 * @brief Gets or sets the SerialNumber.
	 */
	QString serialNumber() const;
	/**
	* @brief Gets or sets the SerialNumber.
	*/
	void setSerialNumber(QString newSerialNumber);
	bool serialNumberNull() const;
	void setSerialNumberNull();

	/**
	 * @brief Gets or sets a value indicating whether EnableAlbumArtInDidl.
	 */
	bool enableAlbumArtInDidl() const;
	/**
	* @brief Gets or sets a value indicating whether EnableAlbumArtInDidl.
	*/
	void setEnableAlbumArtInDidl(bool newEnableAlbumArtInDidl);

	/**
	 * @brief Gets or sets a value indicating whether EnableSingleAlbumArtLimit.
	 */
	bool enableSingleAlbumArtLimit() const;
	/**
	* @brief Gets or sets a value indicating whether EnableSingleAlbumArtLimit.
	*/
	void setEnableSingleAlbumArtLimit(bool newEnableSingleAlbumArtLimit);

	/**
	 * @brief Gets or sets a value indicating whether EnableSingleSubtitleLimit.
	 */
	bool enableSingleSubtitleLimit() const;
	/**
	* @brief Gets or sets a value indicating whether EnableSingleSubtitleLimit.
	*/
	void setEnableSingleSubtitleLimit(bool newEnableSingleSubtitleLimit);

	/**
	 * @brief Gets or sets the SupportedMediaTypes.
	 */
	QString supportedMediaTypes() const;
	/**
	* @brief Gets or sets the SupportedMediaTypes.
	*/
	void setSupportedMediaTypes(QString newSupportedMediaTypes);
	bool supportedMediaTypesNull() const;
	void setSupportedMediaTypesNull();

	/**
	 * @brief Gets or sets the UserId.
	 */
	QString userId() const;
	/**
	* @brief Gets or sets the UserId.
	*/
	void setUserId(QString newUserId);
	bool userIdNull() const;
	void setUserIdNull();

	/**
	 * @brief Gets or sets the AlbumArtPn.
	 */
	QString albumArtPn() const;
	/**
	* @brief Gets or sets the AlbumArtPn.
	*/
	void setAlbumArtPn(QString newAlbumArtPn);
	bool albumArtPnNull() const;
	void setAlbumArtPnNull();

	/**
	 * @brief Gets or sets the MaxAlbumArtWidth.
	 */
	qint32 maxAlbumArtWidth() const;
	/**
	* @brief Gets or sets the MaxAlbumArtWidth.
	*/
	void setMaxAlbumArtWidth(qint32 newMaxAlbumArtWidth);

	/**
	 * @brief Gets or sets the MaxAlbumArtHeight.
	 */
	qint32 maxAlbumArtHeight() const;
	/**
	* @brief Gets or sets the MaxAlbumArtHeight.
	*/
	void setMaxAlbumArtHeight(qint32 newMaxAlbumArtHeight);

	/**
	 * @brief Gets or sets the MaxIconWidth.
	 */
	std::optional<qint32> maxIconWidth() const;
	/**
	* @brief Gets or sets the MaxIconWidth.
	*/
	void setMaxIconWidth(std::optional<qint32> newMaxIconWidth);
	bool maxIconWidthNull() const;
	void setMaxIconWidthNull();

	/**
	 * @brief Gets or sets the MaxIconHeight.
	 */
	std::optional<qint32> maxIconHeight() const;
	/**
	* @brief Gets or sets the MaxIconHeight.
	*/
	void setMaxIconHeight(std::optional<qint32> newMaxIconHeight);
	bool maxIconHeightNull() const;
	void setMaxIconHeightNull();

	/**
	 * @brief Gets or sets the MaxStreamingBitrate.
	 */
	std::optional<qint32> maxStreamingBitrate() const;
	/**
	* @brief Gets or sets the MaxStreamingBitrate.
	*/
	void setMaxStreamingBitrate(std::optional<qint32> newMaxStreamingBitrate);
	bool maxStreamingBitrateNull() const;
	void setMaxStreamingBitrateNull();

	/**
	 * @brief Gets or sets the MaxStaticBitrate.
	 */
	std::optional<qint32> maxStaticBitrate() const;
	/**
	* @brief Gets or sets the MaxStaticBitrate.
	*/
	void setMaxStaticBitrate(std::optional<qint32> newMaxStaticBitrate);
	bool maxStaticBitrateNull() const;
	void setMaxStaticBitrateNull();

	/**
	 * @brief Gets or sets the MusicStreamingTranscodingBitrate.
	 */
	std::optional<qint32> musicStreamingTranscodingBitrate() const;
	/**
	* @brief Gets or sets the MusicStreamingTranscodingBitrate.
	*/
	void setMusicStreamingTranscodingBitrate(std::optional<qint32> newMusicStreamingTranscodingBitrate);
	bool musicStreamingTranscodingBitrateNull() const;
	void setMusicStreamingTranscodingBitrateNull();

	/**
	 * @brief Gets or sets the MaxStaticMusicBitrate.
	 */
	std::optional<qint32> maxStaticMusicBitrate() const;
	/**
	* @brief Gets or sets the MaxStaticMusicBitrate.
	*/
	void setMaxStaticMusicBitrate(std::optional<qint32> newMaxStaticMusicBitrate);
	bool maxStaticMusicBitrateNull() const;
	void setMaxStaticMusicBitrateNull();

	/**
	 * @brief Gets or sets the content of the aggregationFlags element in the urn:schemas-sonycom:av namespace.
	 */
	QString sonyAggregationFlags() const;
	/**
	* @brief Gets or sets the content of the aggregationFlags element in the urn:schemas-sonycom:av namespace.
	*/
	void setSonyAggregationFlags(QString newSonyAggregationFlags);
	bool sonyAggregationFlagsNull() const;
	void setSonyAggregationFlagsNull();

	/**
	 * @brief Gets or sets the ProtocolInfo.
	 */
	QString protocolInfo() const;
	/**
	* @brief Gets or sets the ProtocolInfo.
	*/
	void setProtocolInfo(QString newProtocolInfo);
	bool protocolInfoNull() const;
	void setProtocolInfoNull();

	/**
	 * @brief Gets or sets the TimelineOffsetSeconds.
	 */
	qint32 timelineOffsetSeconds() const;
	/**
	* @brief Gets or sets the TimelineOffsetSeconds.
	*/
	void setTimelineOffsetSeconds(qint32 newTimelineOffsetSeconds);

	/**
	 * @brief Gets or sets a value indicating whether RequiresPlainVideoItems.
	 */
	bool requiresPlainVideoItems() const;
	/**
	* @brief Gets or sets a value indicating whether RequiresPlainVideoItems.
	*/
	void setRequiresPlainVideoItems(bool newRequiresPlainVideoItems);

	/**
	 * @brief Gets or sets a value indicating whether RequiresPlainFolders.
	 */
	bool requiresPlainFolders() const;
	/**
	* @brief Gets or sets a value indicating whether RequiresPlainFolders.
	*/
	void setRequiresPlainFolders(bool newRequiresPlainFolders);

	/**
	 * @brief Gets or sets a value indicating whether EnableMSMediaReceiverRegistrar.
	 */
	bool enableMSMediaReceiverRegistrar() const;
	/**
	* @brief Gets or sets a value indicating whether EnableMSMediaReceiverRegistrar.
	*/
	void setEnableMSMediaReceiverRegistrar(bool newEnableMSMediaReceiverRegistrar);

	/**
	 * @brief Gets or sets a value indicating whether IgnoreTranscodeByteRangeRequests.
	 */
	bool ignoreTranscodeByteRangeRequests() const;
	/**
	* @brief Gets or sets a value indicating whether IgnoreTranscodeByteRangeRequests.
	*/
	void setIgnoreTranscodeByteRangeRequests(bool newIgnoreTranscodeByteRangeRequests);

	/**
	 * @brief Gets or sets the XmlRootAttributes.
	 */
	QList<XmlAttribute> xmlRootAttributes() const;
	/**
	* @brief Gets or sets the XmlRootAttributes.
	*/
	void setXmlRootAttributes(QList<XmlAttribute> newXmlRootAttributes);
	bool xmlRootAttributesNull() const;
	void setXmlRootAttributesNull();

	/**
	 * @brief Gets or sets the direct play profiles.
	 */
	QList<DirectPlayProfile> directPlayProfiles() const;
	/**
	* @brief Gets or sets the direct play profiles.
	*/
	void setDirectPlayProfiles(QList<DirectPlayProfile> newDirectPlayProfiles);
	bool directPlayProfilesNull() const;
	void setDirectPlayProfilesNull();

	/**
	 * @brief Gets or sets the transcoding profiles.
	 */
	QList<TranscodingProfile> transcodingProfiles() const;
	/**
	* @brief Gets or sets the transcoding profiles.
	*/
	void setTranscodingProfiles(QList<TranscodingProfile> newTranscodingProfiles);
	bool transcodingProfilesNull() const;
	void setTranscodingProfilesNull();

	/**
	 * @brief Gets or sets the ContainerProfiles.
	 */
	QList<ContainerProfile> containerProfiles() const;
	/**
	* @brief Gets or sets the ContainerProfiles.
	*/
	void setContainerProfiles(QList<ContainerProfile> newContainerProfiles);
	bool containerProfilesNull() const;
	void setContainerProfilesNull();

	/**
	 * @brief Gets or sets the CodecProfiles.
	 */
	QList<CodecProfile> codecProfiles() const;
	/**
	* @brief Gets or sets the CodecProfiles.
	*/
	void setCodecProfiles(QList<CodecProfile> newCodecProfiles);
	bool codecProfilesNull() const;
	void setCodecProfilesNull();

	/**
	 * @brief Gets or sets the ResponseProfiles.
	 */
	QList<ResponseProfile> responseProfiles() const;
	/**
	* @brief Gets or sets the ResponseProfiles.
	*/
	void setResponseProfiles(QList<ResponseProfile> newResponseProfiles);
	bool responseProfilesNull() const;
	void setResponseProfilesNull();

	/**
	 * @brief Gets or sets the SubtitleProfiles.
	 */
	QList<SubtitleProfile> subtitleProfiles() const;
	/**
	* @brief Gets or sets the SubtitleProfiles.
	*/
	void setSubtitleProfiles(QList<SubtitleProfile> newSubtitleProfiles);
	bool subtitleProfilesNull() const;
	void setSubtitleProfilesNull();


protected:
	QString m_name;
	QString m_jellyfinId;
	QSharedPointer<DeviceIdentification> m_identification = QSharedPointer<DeviceIdentification>();
	QString m_friendlyName;
	QString m_manufacturer;
	QString m_manufacturerUrl;
	QString m_modelName;
	QString m_modelDescription;
	QString m_modelNumber;
	QString m_modelUrl;
	QString m_serialNumber;
	bool m_enableAlbumArtInDidl;
	bool m_enableSingleAlbumArtLimit;
	bool m_enableSingleSubtitleLimit;
	QString m_supportedMediaTypes;
	QString m_userId;
	QString m_albumArtPn;
	qint32 m_maxAlbumArtWidth;
	qint32 m_maxAlbumArtHeight;
	std::optional<qint32> m_maxIconWidth = std::nullopt;
	std::optional<qint32> m_maxIconHeight = std::nullopt;
	std::optional<qint32> m_maxStreamingBitrate = std::nullopt;
	std::optional<qint32> m_maxStaticBitrate = std::nullopt;
	std::optional<qint32> m_musicStreamingTranscodingBitrate = std::nullopt;
	std::optional<qint32> m_maxStaticMusicBitrate = std::nullopt;
	QString m_sonyAggregationFlags;
	QString m_protocolInfo;
	qint32 m_timelineOffsetSeconds;
	bool m_requiresPlainVideoItems;
	bool m_requiresPlainFolders;
	bool m_enableMSMediaReceiverRegistrar;
	bool m_ignoreTranscodeByteRangeRequests;
	QList<XmlAttribute> m_xmlRootAttributes;
	QList<DirectPlayProfile> m_directPlayProfiles;
	QList<TranscodingProfile> m_transcodingProfiles;
	QList<ContainerProfile> m_containerProfiles;
	QList<CodecProfile> m_codecProfiles;
	QList<ResponseProfile> m_responseProfiles;
	QList<SubtitleProfile> m_subtitleProfiles;

private:
	// Private constructor which generates an invalid object, for use withing DeviceProfile::fromJson();
	DeviceProfile();
};


} // NS DTO

namespace Support {

using DeviceProfile = Jellyfin::DTO::DeviceProfile;

template <>
DeviceProfile fromJsonValue(const QJsonValue &source, convertType<DeviceProfile>);

template<>
QJsonValue toJsonValue(const DeviceProfile &source, convertType<DeviceProfile>);

} // NS DTO
} // NS Jellyfin

#endif // JELLYFIN_DTO_DEVICEPROFILE_H