videoreferenceconfig.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_CORE
#include <promeki/datatype.h>
#include <promeki/enums.h>
#include <promeki/error.h>
#include <promeki/namespace.h>
#include <promeki/result.h>
#include <promeki/sharedptr.h>
#include <promeki/string.h>
#include <promeki/videoportref.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class DataStream;
 
class VideoReferenceConfig {
        public:
                PROMEKI_DATATYPE(VideoReferenceConfig, DataTypeVideoReferenceConfig, 1)
 
                
                VideoReferenceConfig();
 
                VideoReferenceConfig(VideoReferenceSource     source,
                                     VideoReferenceRateFamily family = VideoReferenceRateFamily::Auto);
 
                bool isValid() const;
 
                VideoReferenceSource source() const;
 
                VideoReferenceRateFamily family() const;
 
                VideoPortRef signalPort() const;
 
                void setSource(VideoReferenceSource source);
 
                void setFamily(VideoReferenceRateFamily family);
 
                void setSignalPort(VideoPortRef signalPort);
 
                String toString() const;
 
                static Result<VideoReferenceConfig> fromString(const String &s);
 
                bool operator==(const VideoReferenceConfig &other) const;
 
                bool operator!=(const VideoReferenceConfig &other) const { return !(*this == other); }
 
                Error writeToStream(DataStream &s) const;
 
                template <uint32_t V> static Result<VideoReferenceConfig> readFromStream(DataStream &s);
 
                struct Impl {
                                PROMEKI_SHARED_FINAL(Impl)
 
                                VideoReferenceSource     source = VideoReferenceSource::FreeRun;
                                VideoReferenceRateFamily family = VideoReferenceRateFamily::Auto;
                                VideoPortRef             signalPort;
                };
 
        private:
                SharedPtr<Impl> _d;
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_CORE