mediastream.h

Go to the documentation of this file.

/*
 * 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_MEDIASTREAM_H
#define JELLYFIN_DTO_MEDIASTREAM_H
 
#include <QJsonObject>
#include <QJsonValue>
#include <QString>
#include <optional>
 
#include "JellyfinQt/dto/audiospatialformat.h"
#include "JellyfinQt/dto/mediastreamtype.h"
#include "JellyfinQt/dto/subtitledeliverymethod.h"
#include "JellyfinQt/dto/videorange.h"
#include "JellyfinQt/dto/videorangetype.h"
#include "JellyfinQt/support/jsonconv.h"
 
namespace Jellyfin {
// Forward declaration
class ApiClient;
}
namespace Jellyfin {
namespace DTO {
 
 
class MediaStream {
public:
    MediaStream(                                                                                                                                                                    
        VideoRange videoRange,          
        VideoRangeType videoRangeType,                  
        AudioSpatialFormat audioSpatialFormat,                                                                  
        bool isInterlaced,                                                                          
        bool isDefault,         
        bool isForced,          
        bool isHearingImpaired,                                                         
        MediaStreamType type,                   
        qint32 index,                   
        bool isExternal,            
        SubtitleDeliveryMethod deliveryMethod,                          
        bool isTextSubtitleStream,          
        bool supportsExternalStream                                     
    );
 
    MediaStream(const MediaStream &other);
    
    void replaceData(MediaStream &other);
    
    static MediaStream fromJson(QJsonObject source);
    void setFromJson(QJsonObject source);
    QJsonObject toJson() const;
    
    // Properties
    QString codec() const;
    void setCodec(QString newCodec);
    bool codecNull() const;
    void setCodecNull();

    QString codecTag() const;
    void setCodecTag(QString newCodecTag);
    bool codecTagNull() const;
    void setCodecTagNull();

    QString language() const;
    void setLanguage(QString newLanguage);
    bool languageNull() const;
    void setLanguageNull();

    QString colorRange() const;
    void setColorRange(QString newColorRange);
    bool colorRangeNull() const;
    void setColorRangeNull();

    QString colorSpace() const;
    void setColorSpace(QString newColorSpace);
    bool colorSpaceNull() const;
    void setColorSpaceNull();

    QString colorTransfer() const;
    void setColorTransfer(QString newColorTransfer);
    bool colorTransferNull() const;
    void setColorTransferNull();

    QString colorPrimaries() const;
    void setColorPrimaries(QString newColorPrimaries);
    bool colorPrimariesNull() const;
    void setColorPrimariesNull();

    std::optional<qint32> dvVersionMajor() const;
    void setDvVersionMajor(std::optional<qint32> newDvVersionMajor);
    bool dvVersionMajorNull() const;
    void setDvVersionMajorNull();

    std::optional<qint32> dvVersionMinor() const;
    void setDvVersionMinor(std::optional<qint32> newDvVersionMinor);
    bool dvVersionMinorNull() const;
    void setDvVersionMinorNull();

    std::optional<qint32> dvProfile() const;
    void setDvProfile(std::optional<qint32> newDvProfile);
    bool dvProfileNull() const;
    void setDvProfileNull();

    std::optional<qint32> dvLevel() const;
    void setDvLevel(std::optional<qint32> newDvLevel);
    bool dvLevelNull() const;
    void setDvLevelNull();

    std::optional<qint32> rpuPresentFlag() const;
    void setRpuPresentFlag(std::optional<qint32> newRpuPresentFlag);
    bool rpuPresentFlagNull() const;
    void setRpuPresentFlagNull();

    std::optional<qint32> elPresentFlag() const;
    void setElPresentFlag(std::optional<qint32> newElPresentFlag);
    bool elPresentFlagNull() const;
    void setElPresentFlagNull();

    std::optional<qint32> blPresentFlag() const;
    void setBlPresentFlag(std::optional<qint32> newBlPresentFlag);
    bool blPresentFlagNull() const;
    void setBlPresentFlagNull();

    std::optional<qint32> dvBlSignalCompatibilityId() const;
    void setDvBlSignalCompatibilityId(std::optional<qint32> newDvBlSignalCompatibilityId);
    bool dvBlSignalCompatibilityIdNull() const;
    void setDvBlSignalCompatibilityIdNull();

    std::optional<qint32> rotation() const;
    void setRotation(std::optional<qint32> newRotation);
    bool rotationNull() const;
    void setRotationNull();

    QString comment() const;
    void setComment(QString newComment);
    bool commentNull() const;
    void setCommentNull();

    QString timeBase() const;
    void setTimeBase(QString newTimeBase);
    bool timeBaseNull() const;
    void setTimeBaseNull();

    QString codecTimeBase() const;
    void setCodecTimeBase(QString newCodecTimeBase);
    bool codecTimeBaseNull() const;
    void setCodecTimeBaseNull();

    QString title() const;
    void setTitle(QString newTitle);
    bool titleNull() const;
    void setTitleNull();
 
 
    VideoRange videoRange() const;
 
    void setVideoRange(VideoRange newVideoRange);
 
 
    VideoRangeType videoRangeType() const;
 
    void setVideoRangeType(VideoRangeType newVideoRangeType);

    QString videoDoViTitle() const;
    void setVideoDoViTitle(QString newVideoDoViTitle);
    bool videoDoViTitleNull() const;
    void setVideoDoViTitleNull();
 
 
    AudioSpatialFormat audioSpatialFormat() const;
 
    void setAudioSpatialFormat(AudioSpatialFormat newAudioSpatialFormat);
 
 
    QString localizedUndefined() const;
 
    void setLocalizedUndefined(QString newLocalizedUndefined);
    bool localizedUndefinedNull() const;
    void setLocalizedUndefinedNull();
 
 
    QString localizedDefault() const;
 
    void setLocalizedDefault(QString newLocalizedDefault);
    bool localizedDefaultNull() const;
    void setLocalizedDefaultNull();
 
 
    QString localizedForced() const;
 
    void setLocalizedForced(QString newLocalizedForced);
    bool localizedForcedNull() const;
    void setLocalizedForcedNull();
 
 
    QString localizedExternal() const;
 
    void setLocalizedExternal(QString newLocalizedExternal);
    bool localizedExternalNull() const;
    void setLocalizedExternalNull();
 
 
    QString localizedHearingImpaired() const;
 
    void setLocalizedHearingImpaired(QString newLocalizedHearingImpaired);
    bool localizedHearingImpairedNull() const;
    void setLocalizedHearingImpairedNull();
 
 
    QString displayTitle() const;
 
    void setDisplayTitle(QString newDisplayTitle);
    bool displayTitleNull() const;
    void setDisplayTitleNull();
 
 
    QString nalLengthSize() const;
 
    void setNalLengthSize(QString newNalLengthSize);
    bool nalLengthSizeNull() const;
    void setNalLengthSizeNull();

    bool isInterlaced() const;
    void setIsInterlaced(bool newIsInterlaced);
 
 
    std::optional<bool> isAVC() const;
 
    void setIsAVC(std::optional<bool> newIsAVC);
    bool isAVCNull() const;
    void setIsAVCNull();

    QString channelLayout() const;
    void setChannelLayout(QString newChannelLayout);
    bool channelLayoutNull() const;
    void setChannelLayoutNull();

    std::optional<qint32> bitRate() const;
    void setBitRate(std::optional<qint32> newBitRate);
    bool bitRateNull() const;
    void setBitRateNull();

    std::optional<qint32> bitDepth() const;
    void setBitDepth(std::optional<qint32> newBitDepth);
    bool bitDepthNull() const;
    void setBitDepthNull();

    std::optional<qint32> refFrames() const;
    void setRefFrames(std::optional<qint32> newRefFrames);
    bool refFramesNull() const;
    void setRefFramesNull();

    std::optional<qint32> packetLength() const;
    void setPacketLength(std::optional<qint32> newPacketLength);
    bool packetLengthNull() const;
    void setPacketLengthNull();

    std::optional<qint32> channels() const;
    void setChannels(std::optional<qint32> newChannels);
    bool channelsNull() const;
    void setChannelsNull();

    std::optional<qint32> sampleRate() const;
    void setSampleRate(std::optional<qint32> newSampleRate);
    bool sampleRateNull() const;
    void setSampleRateNull();

    bool isDefault() const;
    void setIsDefault(bool newIsDefault);

    bool isForced() const;
    void setIsForced(bool newIsForced);

    bool isHearingImpaired() const;
    void setIsHearingImpaired(bool newIsHearingImpaired);

    std::optional<qint32> height() const;
    void setHeight(std::optional<qint32> newHeight);
    bool heightNull() const;
    void setHeightNull();

    std::optional<qint32> width() const;
    void setWidth(std::optional<qint32> newWidth);
    bool widthNull() const;
    void setWidthNull();

    std::optional<float> averageFrameRate() const;
    void setAverageFrameRate(std::optional<float> newAverageFrameRate);
    bool averageFrameRateNull() const;
    void setAverageFrameRateNull();

    std::optional<float> realFrameRate() const;
    void setRealFrameRate(std::optional<float> newRealFrameRate);
    bool realFrameRateNull() const;
    void setRealFrameRateNull();

    std::optional<float> referenceFrameRate() const;
    void setReferenceFrameRate(std::optional<float> newReferenceFrameRate);
    bool referenceFrameRateNull() const;
    void setReferenceFrameRateNull();

    QString profile() const;
    void setProfile(QString newProfile);
    bool profileNull() const;
    void setProfileNull();
 
 
    MediaStreamType type() const;
 
    void setType(MediaStreamType newType);

    QString aspectRatio() const;
    void setAspectRatio(QString newAspectRatio);
    bool aspectRatioNull() const;
    void setAspectRatioNull();

    qint32 index() const;
    void setIndex(qint32 newIndex);

    std::optional<qint32> score() const;
    void setScore(std::optional<qint32> newScore);
    bool scoreNull() const;
    void setScoreNull();

    bool isExternal() const;
    void setIsExternal(bool newIsExternal);
 
 
    SubtitleDeliveryMethod deliveryMethod() const;
 
    void setDeliveryMethod(SubtitleDeliveryMethod newDeliveryMethod);

    QString deliveryUrl() const;
    void setDeliveryUrl(QString newDeliveryUrl);
    bool deliveryUrlNull() const;
    void setDeliveryUrlNull();

    std::optional<bool> isExternalUrl() const;
    void setIsExternalUrl(std::optional<bool> newIsExternalUrl);
    bool isExternalUrlNull() const;
    void setIsExternalUrlNull();
 
 
    bool isTextSubtitleStream() const;
 
    void setIsTextSubtitleStream(bool newIsTextSubtitleStream);

    bool supportsExternalStream() const;
    void setSupportsExternalStream(bool newSupportsExternalStream);

    QString path() const;
    void setPath(QString newPath);
    bool pathNull() const;
    void setPathNull();

    QString pixelFormat() const;
    void setPixelFormat(QString newPixelFormat);
    bool pixelFormatNull() const;
    void setPixelFormatNull();

    std::optional<double> level() const;
    void setLevel(std::optional<double> newLevel);
    bool levelNull() const;
    void setLevelNull();

    std::optional<bool> isAnamorphic() const;
    void setIsAnamorphic(std::optional<bool> newIsAnamorphic);
    bool isAnamorphicNull() const;
    void setIsAnamorphicNull();
 
 
protected:
    QString m_codec;
    QString m_codecTag;
    QString m_language;
    QString m_colorRange;
    QString m_colorSpace;
    QString m_colorTransfer;
    QString m_colorPrimaries;
    std::optional<qint32> m_dvVersionMajor = std::nullopt;
    std::optional<qint32> m_dvVersionMinor = std::nullopt;
    std::optional<qint32> m_dvProfile = std::nullopt;
    std::optional<qint32> m_dvLevel = std::nullopt;
    std::optional<qint32> m_rpuPresentFlag = std::nullopt;
    std::optional<qint32> m_elPresentFlag = std::nullopt;
    std::optional<qint32> m_blPresentFlag = std::nullopt;
    std::optional<qint32> m_dvBlSignalCompatibilityId = std::nullopt;
    std::optional<qint32> m_rotation = std::nullopt;
    QString m_comment;
    QString m_timeBase;
    QString m_codecTimeBase;
    QString m_title;
    VideoRange m_videoRange;
    VideoRangeType m_videoRangeType;
    QString m_videoDoViTitle;
    AudioSpatialFormat m_audioSpatialFormat;
    QString m_localizedUndefined;
    QString m_localizedDefault;
    QString m_localizedForced;
    QString m_localizedExternal;
    QString m_localizedHearingImpaired;
    QString m_displayTitle;
    QString m_nalLengthSize;
    bool m_isInterlaced;
    std::optional<bool> m_isAVC = std::nullopt;
    QString m_channelLayout;
    std::optional<qint32> m_bitRate = std::nullopt;
    std::optional<qint32> m_bitDepth = std::nullopt;
    std::optional<qint32> m_refFrames = std::nullopt;
    std::optional<qint32> m_packetLength = std::nullopt;
    std::optional<qint32> m_channels = std::nullopt;
    std::optional<qint32> m_sampleRate = std::nullopt;
    bool m_isDefault;
    bool m_isForced;
    bool m_isHearingImpaired;
    std::optional<qint32> m_height = std::nullopt;
    std::optional<qint32> m_width = std::nullopt;
    std::optional<float> m_averageFrameRate = std::nullopt;
    std::optional<float> m_realFrameRate = std::nullopt;
    std::optional<float> m_referenceFrameRate = std::nullopt;
    QString m_profile;
    MediaStreamType m_type;
    QString m_aspectRatio;
    qint32 m_index;
    std::optional<qint32> m_score = std::nullopt;
    bool m_isExternal;
    SubtitleDeliveryMethod m_deliveryMethod;
    QString m_deliveryUrl;
    std::optional<bool> m_isExternalUrl = std::nullopt;
    bool m_isTextSubtitleStream;
    bool m_supportsExternalStream;
    QString m_path;
    QString m_pixelFormat;
    std::optional<double> m_level = std::nullopt;
    std::optional<bool> m_isAnamorphic = std::nullopt;
 
private:
    // Private constructor which generates an invalid object, for use withing MediaStream::fromJson();
    MediaStream();
};
 
 
} // NS DTO
 
namespace Support {
 
using MediaStream = Jellyfin::DTO::MediaStream;
 
template <>
MediaStream fromJsonValue(const QJsonValue &source, convertType<MediaStream>);
 
template<>
QJsonValue toJsonValue(const MediaStream &source, convertType<MediaStream>);
 
} // NS DTO
} // NS Jellyfin
 
#endif // JELLYFIN_DTO_MEDIASTREAM_H