summaryrefslogtreecommitdiff
path: root/include/FLAC/stream_encoder.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/FLAC/stream_encoder.h')
-rw-r--r--include/FLAC/stream_encoder.h8
1 files changed, 8 insertions, 0 deletions
diff --git a/include/FLAC/stream_encoder.h b/include/FLAC/stream_encoder.h
index e57a6839..407b6ac8 100644
--- a/include/FLAC/stream_encoder.h
+++ b/include/FLAC/stream_encoder.h
@@ -1318,6 +1318,10 @@ FLAC_API void FLAC__stream_encoder_finish(FLAC__StreamEncoder *encoder);
* representing one channel. The samples need not be block-aligned,
* but each channel should have the same number of samples.
*
+ * For applications where channel order is important, channels must
+ * follow the order as described in the
+ * <A HREF="../format.html#frame_header">frame header</A>.
+ *
* \param encoder An initialized encoder instance in the OK state.
* \param buffer An array of pointers to each channel's signal.
* \param samples The number of samples in one channel.
@@ -1339,6 +1343,10 @@ FLAC_API FLAC__bool FLAC__stream_encoder_process(FLAC__StreamEncoder *encoder, c
* sample-aligned, i.e. the first value should be channel0_sample0
* and the last value channelN_sampleM.
*
+ * For applications where channel order is important, channels must
+ * follow the order as described in the
+ * <A HREF="../format.html#frame_header">frame header</A>.
+ *
* \param encoder An initialized encoder instance in the OK state.
* \param buffer An array of channel-interleaved data (see above).
* \param samples The number of samples in one channel, the same as for