From 2b6ad6b90bba3c62ea64ea0d55f24f896e46f657 Mon Sep 17 00:00:00 2001 From: badaix Date: Tue, 2 Jul 2024 13:11:57 +0200 Subject: [PATCH] Add some documentation --- server/streamreader/pcm_stream.hpp | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/server/streamreader/pcm_stream.hpp b/server/streamreader/pcm_stream.hpp index 0f0802fd..c9a4b403 100644 --- a/server/streamreader/pcm_stream.hpp +++ b/server/streamreader/pcm_stream.hpp @@ -124,15 +124,23 @@ public: PcmStream(PcmStream::Listener* pcmListener, boost::asio::io_context& ioc, const ServerSettings& server_settings, const StreamUri& uri); virtual ~PcmStream(); + /// Start the stream reader, init the encoder and optionally the stream control virtual void start(); + /// Stop the stream reader virtual void stop(); + /// @return the codec header of the stream virtual std::shared_ptr getHeader(); + /// @return the uri of the stream, as configured in snapserver.conf virtual const StreamUri& getUri() const; + /// @return the name of the stream virtual const std::string& getName() const; + /// @return the id of the stream virtual const std::string& getId() const; + /// @return the sample format of the stream virtual const SampleFormat& getSampleFormat() const; + /// @return the codec of the stream virtual std::string getCodec() const; const Properties& getProperties() const;