浏览代码

VLCMediaPlayer: clarify the documentation for the audio and spu getters/setters

Felix Paul Kühne 12 年之前
父节点
当前提交
328204c635
共有 1 个文件被更改,包括 4 次插入0 次删除
  1. 4 0
      Headers/Public/VLCMediaPlayer.h

+ 4 - 0
Headers/Public/VLCMediaPlayer.h

@@ -168,6 +168,8 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
 
 /**
  * Return the current video subtitle index
+ * Note that the handled values do not match the videoSubTitles array indexes
+ * but refer to VLCMedia's VLCMediaTracksInformationId.
  * \return 0 if none is set.
  *
  * Pass 0 to disable.
@@ -215,6 +217,8 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
 
 /**
  * Return the current audio track index
+ * Note that the handled values do not match the audioTracks array indexes
+ * but refer to VLCMedia's VLCMediaTracksInformationId.
  * \return 0 if none is set.
  *
  * Pass 0 to disable.