VR-Engage  2.2
Loading...
Searching...
No Matches
selectVideoSource.h
Go to the documentation of this file.
1/*********************************************************************************
2** Copyright (c) 2025 MAK Technologies, Inc.
3** All rights reserved.
4*********************************************************************************/
5
6/*!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
7!!!!!!!!!This is an auto-generated file. Any changes will be destroyed!!!!!!!!!!!
8!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
9Generated from: /data/exports/DEV-CAM-BML-043/nightly/3085/libsrc/framework/vreMessages/videoStream.lua
10*/
11/*-----------------COMMENT----------------------
12Send to set the window source for streaming video.
13-------------------COMMENT----------------------*/
14#pragma once
15
18#include <vreMessages/export.h>
19#include <string>
20
21
22namespace makVre
23{
24
25
26constexpr const char* SelectVideoSourceMessageType = "stream.selectVideoSource";
27
29{
30public:
31
32
33 // Struct for defining data
35 {
37
38 std::string myGuiLabel;
39 std::string myWindowName;
40 std::string myChannelName;
41
42 bool operator==(const SelectVideoSourceData& rhs) const;
43 };
44
45 // Default static creators to promote the usage of not using new.
49
50 //! \brief static message identity functions
51 static const std::string& theType();
54
55 //! \brief Get the name of the message type
56 virtual const std::string& type() const override;
57 virtual const makVre::DtVreMessageId& messageId() const override;
58
59 // default destructor
60 virtual ~SelectVideoSourceMessage() override;
61
62 virtual const std::string& getGuiLabel() const;
63 virtual void setGuiLabel(const std::string& val);
64
65 virtual const std::string& getWindowName() const;
66 virtual void setWindowName(const std::string& val);
67
68 virtual const std::string& getChannelName() const;
69 virtual void setChannelName(const std::string& val);
70
71
72 // Accessors
73 virtual int messageSize() const override;
74 static makVre::DtVreMessage* decode(char* buffer, int length);
77
78 // Operators
79 bool operator==(const SelectVideoSourceMessage& rhs) const;
80
81protected:
82 // Inaccessible default constructor to promote the usage of the static creator functions
84
85 virtual void serialize(DtStreamWriter& writer) const override;
86 virtual void deserialize(DtStreamReader& reader) override;
87
88protected:
91
92 // Store the data for future use
94};
95
96} // ::makVre
97
98
99
Reader class for decoding values from a byte array.
Definition byteStream.h:42
Writer class for encoding values into a byte array.
Definition byteStream.h:161
Abstract base class for all VREngage messages.
Definition vreMessage.h:50
Message identifier class for the VREngage messaging system.
Definition vreMessageId.h:35
static SelectVideoSourceMessage * create()
virtual void setChannelName(const std::string &val)
SelectVideoSourceData getData() const
static const std::string & theType()
static message identity functions
static SelectVideoSourceMessage * createFromData(const SelectVideoSourceData)
static makVre::DtVreMessageId theMessageId
Definition selectVideoSource.h:89
SelectVideoSourceData myData
Definition selectVideoSource.h:93
virtual ~SelectVideoSourceMessage() override
virtual void deserialize(DtStreamReader &reader) override
Deserializes the message from a stream reader.
virtual void setGuiLabel(const std::string &val)
virtual void setWindowName(const std::string &val)
static UInt64 theVersion
Definition selectVideoSource.h:90
virtual int messageSize() const override
Static decode function pattern for derived classes.
virtual const makVre::DtVreMessageId & messageId() const override
Gets the message ID object.
virtual const std::string & getWindowName() const
bool operator==(const SelectVideoSourceMessage &rhs) const
virtual const std::string & getGuiLabel() const
SelectVideoSourceData getData()
virtual void serialize(DtStreamWriter &writer) const override
Serializes the message to a stream writer.
static makVre::DtVreMessage * decode(char *buffer, int length)
virtual const std::string & type() const override
Get the name of the message type.
static const makVre::DtVreMessageId & theId()
static SelectVideoSourceMessage * createFrom(SelectVideoSourceMessage *)
virtual const std::string & getChannelName() const
Defines export macros for the VREngage Messages library.
#define VREMESSAGES_DLL
Export/import macro for non-Windows platforms.
Definition export.h:39
Include export definitions for this library.
Definition glsVreMessageUtil.h:49
unsigned long long UInt64
Unsigned 64-bit integer type.
Definition utilFunctions.h:42
constexpr const char * SelectVideoSourceMessageType
Definition selectVideoSource.h:26
std::string myWindowName
Definition selectVideoSource.h:39
bool operator==(const SelectVideoSourceData &rhs) const
std::string myGuiLabel
Definition selectVideoSource.h:38
std::string myChannelName
Definition selectVideoSource.h:40
Defines the base class for all VREngage messages.
Defines message identifier class for the VREngage messaging system.