Classes

Classes

• namespace AclLog
  A namespace for logging utilities.
• struct AlignedFrame
  A frame of aligned data that is passed to the rendering engine from the MediaReceiver. A DataFrame contains a time stamped frame of media, which might be video, audio and auxiliary data such as subtitles. A single DataFrame can contain one or multiple types of media. Which media types are included can be probed by nullptr-checking/size checking the data members. The struct has ownership of all data pointers included. The struct includes all logic for freeing the resources held by this struct and the user should therefore just make sure the struct itself is deallocated to ensure all resources are freed.
• namespace ControlDataCommon
  • struct ConnectionStatus
    Connection status struct containing information about a connection event.
  • struct Response
    A response from a ControlDataReceiver to a request. The UUID tells which receiver the response is sent from.
  • struct StatusMessage
    A status message from a ControlDataReceiver. The UUID tells which receiver the message is sent from.
• class ControlDataReceiver
  A ControlDataReceiver can receive messages from a sender or another ControlDataReceiver using a network connection. It can also connect to and forward the incoming request messages to other receivers. The connections to the sender and the other receivers are controlled by an ISystemControllerInterface instance. The ControlDataReceiver has a receiving or listening side, as well as a sending side. The listening side can listen to one single network port and have multiple ControlDataSenders and ControlDataReceivers connected to that port to receive requests from them. On the sending side of the ControlDataReceiver, it can be connected to the listening side of other ControlDataReceivers, used to forward all incoming messages to that receiver, as well as sending its own requests.
  • struct IncomingRequest
    An incoming request to this ControlDataReceiver.
  • struct ReceiverResponse
    A response message to a request.
  • struct Settings
    Settings for a ControlDataReceiver.
• class ControlDataSender
  A ControlDataSender can send control signals to one or more receivers using a network connection. A single ControlDataSender can connect to multiple receivers, all identified by a UUID. The class is controlled using an ISystemControllerInterface; this interface is responsible for setting up connections to receivers. The ControlDataSender can send asynchronous requests to (all) the receivers and get a response back. Each response is identified with a request ID as well as the UUID of the responding receiver. The ControlDataSender can also receive status messages from the receivers.
  • struct Settings
    Settings for a ControlDataSender.
• class DeviceMemory
  RAII class for a CUDA memory buffer.
• class ISystemControllerInterface
  An ISystemControllerInterface is the interface between a component and the System controller controlling the component. The interface allows for two-way communication between the component and the system controller by means of sending requests and getting responses. Classes deriving from the ISystemControllerInterface should provide the component side implementation of the communication with the system controller. This interface can be inherited and implemented by developers to connect to custom system controllers, or to directly control a component programmatically, without the need for connecting to a remote server. An ISystemControllerInterface can have a parent-child relationship with other interfaces, where the children are aware of which their parent interface is. This is useful for components that provides extra features for another component, but where the components are still to be considered as two separate entities with separate connections to the System controller.
  • struct Callbacks
    A struct containing the callbacks that needs to be registered by the component using this interface.
  • struct Response
    A response to a request, consists of a status code and an (optional) parameters JSON object.
• class IngestApplication
  • struct Settings
• namespace IngestUtils
• class MediaReceiver
  A MediaReceiver contains the logic for receiving, decoding and aligning incoming media sources from the Ingests. The aligned data is then delivered to the Rendering Engine which is also responsible for setting up the MediaReceiver. The MediaReceiver has a builtin multi view generator, which can create output streams containing composited subsets of the incoming video sources. This class is controlled using an ISystemControllerInterface provided when starting it.
  • struct NewStreamParameters
    A struct containing information on the format of an incoming stream.
  • struct Settings
    Settings for a MediaReceiver.
• class MediaStreamer
  MediaStreamer is a class that can take a single stream of uncompressed video and/or audio frames and encode and output it in some way to some interface. This interface can either be a stream to a network or writing down the data to a file on the hard drive. This class is configured from two interfaces. The input configuration (input video resolution, frame rate, pixel format, number of audio channels…) is made through this C++ API. The output stream is then started from the System Controller. Any of these configurations can be made first. The actual stream to output will start once the first call to.
  • struct Configuration
    The input configuration of the frames that will be sent to this MediaStreamer. The output stream configuration is made from the System controller via the ISystemControllerInterface.
• class PipelineSystemControllerInterfaceFactory
• class SystemControllerConnection
  An implementation of the ISystemControllerInterface for a System controller residing in a remote server. The connection to the server uses a Websocket.
  • struct Settings
    Settings for a SystemControllerConnection.
• namespace TimeCommon
  • struct TAIStatus
  • struct TimeStructure
• namespace UUIDUtils
  A namespace for UUID utility functions.

Updated on 2022-11-17 at 15:40:06 +0100