From 81ecd32e833035d89538a5a5c78b4ad61ecdceb5 Mon Sep 17 00:00:00 2001
From: Cameron Gutman <aicommander@gmail.com>
Date: Sun, 25 Oct 2015 18:53:49 -0700
Subject: [PATCH] Add a comment about the mapping array order

---
 limelight-common/Limelight.h | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/limelight-common/Limelight.h b/limelight-common/Limelight.h
index f740270..55de617 100644
--- a/limelight-common/Limelight.h
+++ b/limelight-common/Limelight.h
@@ -110,6 +110,17 @@ void LiInitializeVideoCallbacks(PDECODER_RENDERER_CALLBACKS drCallbacks);
 // This structure provides the Opus multistream decoder parameters required to successfully
 // decode the audio stream being sent from the computer. See opus_multistream_decoder_init docs
 // for details about these fields.
+//
+// The supplied mapping array is indexed according to the following output channel order:
+// 0 - Front Left
+// 1 - Front Right
+// 2 - Center
+// 3 - LFE
+// 4 - Surround Left
+// 5 - Surround Right
+//
+// If the mapping order does not match the channel order of the audio renderer, you may swap
+// the values in the mismatched indices until the mapping array matches the desired channel order.
 typedef struct _OPUS_MULTISTREAM_CONFIGURATION {
     int sampleRate;
     int channelCount;