#include <privmx/endpoint/stream/Types.hpp>
Public Attributes | |
| std::string | contextId |
| std::string | streamRoomId |
| int64_t | createDate |
| std::string | creator |
| int64_t | lastModificationDate |
| std::string | lastModifier |
| std::vector< std::string > | users |
| std::vector< std::string > | managers |
| int64_t | version |
| core::Buffer | publicMeta |
| core::Buffer | privateMeta |
| core::ContainerPolicyWithoutItem | policy |
| int64_t | statusCode |
| int64_t | schemaVersion |
| std::string | state |
| int64_t | emptyRoomTtl |
Detailed Description
Holds all available information about a Stream Room.
Member Data Documentation
◆ contextId
| std::string privmx::endpoint::stream::StreamRoom::contextId |
ID of the Context the Stream Room was created in
◆ createDate
| int64_t privmx::endpoint::stream::StreamRoom::createDate |
Stream Room creation timestamp
◆ creator
| std::string privmx::endpoint::stream::StreamRoom::creator |
ID of the user who created the Stream Room
◆ emptyRoomTtl
| int64_t privmx::endpoint::stream::StreamRoom::emptyRoomTtl |
grace period (ms) the Stream Room stays open after the last participant leaves
◆ lastModificationDate
| int64_t privmx::endpoint::stream::StreamRoom::lastModificationDate |
Stream Room last modification timestamp
◆ lastModifier
| std::string privmx::endpoint::stream::StreamRoom::lastModifier |
ID of the user who last modified the Stream Room
◆ managers
| std::vector<std::string> privmx::endpoint::stream::StreamRoom::managers |
list of users (their IDs) with management rights
◆ policy
| core::ContainerPolicyWithoutItem privmx::endpoint::stream::StreamRoom::policy |
Stream Room's policies
◆ privateMeta
| core::Buffer privmx::endpoint::stream::StreamRoom::privateMeta |
Stream Room's private metadata
◆ publicMeta
| core::Buffer privmx::endpoint::stream::StreamRoom::publicMeta |
Stream Room's public metadata
◆ schemaVersion
| int64_t privmx::endpoint::stream::StreamRoom::schemaVersion |
Version of the Stream Room data structure and how it is encoded/encrypted
◆ state
| std::string privmx::endpoint::stream::StreamRoom::state |
current state of the Stream Room: "created" | "open" | "closed".
- "created" means that the Stream Room has been created for a future meeting and has not been used yet
- "open" means that the meeting in the Stream Room has started, that is the first user has joined it
- "closed" means that the meeting has ended - the Stream Room closes itself once all its users have left and the emptyRoomTtl grace period has passed. If a user joins before that period elapses, it starts over.
◆ statusCode
| int64_t privmx::endpoint::stream::StreamRoom::statusCode |
status code of retrieval and decryption of the Stream Room
◆ streamRoomId
| std::string privmx::endpoint::stream::StreamRoom::streamRoomId |
ID of the Stream Room
◆ users
| std::vector<std::string> privmx::endpoint::stream::StreamRoom::users |
list of users (their IDs) with access to the Stream Room
◆ version
| int64_t privmx::endpoint::stream::StreamRoom::version |
version number (changes on updates)
The documentation for this struct was generated from the following file:
- privmx/endpoint/stream/Types.hpp