winlin

add comments for the FLV/RTMP enums

@@ -37,11 +37,14 @@ class SrsStream; @@ -37,11 +37,14 @@ class SrsStream;
37 #define SRS_MAX_CODEC_SAMPLE 128 37 #define SRS_MAX_CODEC_SAMPLE 128
38 #define _SRS_AAC_SAMPLE_RATE_UNSET 15 38 #define _SRS_AAC_SAMPLE_RATE_UNSET 15
39 39
40 -// Sampling rate. The following values are defined:  
41 -// 0 = 5.5 kHz = 5512 Hz  
42 -// 1 = 11 kHz = 11025 Hz  
43 -// 2 = 22 kHz = 22050 Hz  
44 -// 3 = 44 kHz = 44100 Hz 40 +/**
  41 +* the FLV/RTMP supported audio sample rate.
  42 +* Sampling rate. The following values are defined:
  43 +* 0 = 5.5 kHz = 5512 Hz
  44 +* 1 = 11 kHz = 11025 Hz
  45 +* 2 = 22 kHz = 22050 Hz
  46 +* 3 = 44 kHz = 44100 Hz
  47 +*/
45 enum SrsCodecAudioSampleRate 48 enum SrsCodecAudioSampleRate
46 { 49 {
47 // set to the max value to reserved, for array map. 50 // set to the max value to reserved, for array map.
@@ -53,11 +56,14 @@ enum SrsCodecAudioSampleRate @@ -53,11 +56,14 @@ enum SrsCodecAudioSampleRate
53 SrsCodecAudioSampleRate44100 = 3, 56 SrsCodecAudioSampleRate44100 = 3,
54 }; 57 };
55 58
56 -// Size of each audio sample. This parameter only pertains to  
57 -// uncompressed formats. Compressed formats always decode  
58 -// to 16 bits internally.  
59 -// 0 = 8-bit samples  
60 -// 1 = 16-bit samples 59 +/**
  60 +* the FLV/RTMP supported audio sample size.
  61 +* Size of each audio sample. This parameter only pertains to
  62 +* uncompressed formats. Compressed formats always decode
  63 +* to 16 bits internally.
  64 +* 0 = 8-bit samples
  65 +* 1 = 16-bit samples
  66 +*/
61 enum SrsCodecAudioSampleSize 67 enum SrsCodecAudioSampleSize
62 { 68 {
63 // set to the max value to reserved, for array map. 69 // set to the max value to reserved, for array map.
@@ -67,9 +73,12 @@ enum SrsCodecAudioSampleSize @@ -67,9 +73,12 @@ enum SrsCodecAudioSampleSize
67 SrsCodecAudioSampleSize16bit = 1, 73 SrsCodecAudioSampleSize16bit = 1,
68 }; 74 };
69 75
70 -// Mono or stereo sound  
71 -// 0 = Mono sound  
72 -// 1 = Stereo sound 76 +/**
  77 +* the FLV/RTMP supported audio sound type/channel.
  78 +* Mono or stereo sound
  79 +* 0 = Mono sound
  80 +* 1 = Stereo sound
  81 +*/
73 enum SrsCodecAudioSoundType 82 enum SrsCodecAudioSoundType
74 { 83 {
75 // set to the max value to reserved, for array map. 84 // set to the max value to reserved, for array map.