Skip to content

Commit 7650933

Browse files
author
Clement Champetier
committed
Transcoder: update doc
1 parent 9d296c7 commit 7650933

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/AvTranscoder/Transcoder/Transcoder.hpp

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,22 +43,26 @@ class Transcoder
4343

4444
/**
4545
* @brief Add a stream and set a profile
46-
* @note If subStreamIndex is negative, no substream a selected it's the stream.
4746
* @note If profileName is empty, rewrap.
47+
* @note If subStreamIndex is negative, no substream is selected it's the stream.
4848
*/
4949
void add( const std::string& filename, const size_t streamIndex, const int subStreamIndex, const std::string& profileName = "" );
5050

5151
/**
5252
* @brief Add a stream and set a custom profile
5353
* @note Profile will be updated, be sure to pass unique profile name.
54-
* @note If subStreamIndex is negative, no substream a selected it's the stream.
54+
* @note If subStreamIndex is negative, no substream is selected it's the stream.
5555
*/
5656
void add( const std::string& filename, const size_t streamIndex, const int subStreamIndex, Profile::ProfileDesc& profileDesc );
5757
/**
5858
* @note If filename is empty, add a dummy stream.
5959
*/
6060
void add( const std::string& filename, const size_t streamIndex, const int subStreamIndex, Profile::ProfileDesc& profileDesc, EssenceDesc& essenceDesc );
6161

62+
/**
63+
* @brief Add the stream
64+
* @note The stream will be deleted in Transcoder's destructor.
65+
*/
6266
void add( StreamTranscoder& stream );
6367

6468
bool processFrame();

0 commit comments

Comments
 (0)