3pp-mirror/snapcast
1
0
Fork 0
mirror of https://github.com/badaix/snapcast.git synced 2025-06-30 00:17:06 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add some documentation

Browse source
This commit is contained in:
badaix 2024-07-02 13:11:57 +02:00
parent 30a5ed7389
commit 2b6ad6b90b
1 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
server/streamreader/pcm_stream.hpp
View file

@ -124,15 +124,23 @@ public:
PcmStream(PcmStream::Listener* pcmListener, boost::asio::io_context& ioc, const ServerSettings& server_settings, const StreamUri& uri); PcmStream(PcmStream::Listener* pcmListener, boost::asio::io_context& ioc, const ServerSettings& server_settings, const StreamUri& uri);
virtual ~PcmStream(); virtual ~PcmStream();
/// Start the stream reader, init the encoder and optionally the stream control
virtual void start(); virtual void start();
/// Stop the stream reader
virtual void stop(); virtual void stop();
/// @return the codec header of the stream
virtual std::shared_ptr<msg::CodecHeader> getHeader(); virtual std::shared_ptr<msg::CodecHeader> getHeader();
/// @return the uri of the stream, as configured in snapserver.conf
virtual const StreamUri& getUri() const; virtual const StreamUri& getUri() const;
/// @return the name of the stream
virtual const std::string& getName() const; virtual const std::string& getName() const;
/// @return the id of the stream
virtual const std::string& getId() const; virtual const std::string& getId() const;
/// @return the sample format of the stream
virtual const SampleFormat& getSampleFormat() const; virtual const SampleFormat& getSampleFormat() const;
/// @return the codec of the stream
virtual std::string getCodec() const; virtual std::string getCodec() const;
const Properties& getProperties() const; const Properties& getProperties() const;