macosx: expand the documentation for our single (known) private API use

[vlc] / src / libvlc-module.c

diff --git a/src/libvlc-module.c b/src/libvlc-module.c
index 5c90584244d0fb9f542f3c7467606cb5f9199d5a..65709a282cea03cb404b136d2eb4b85c42c652ac 100644 (file)
--- a/src/libvlc-module.c
+++ b/src/libvlc-module.c
@@ -157,7 +157,7 @@ static const char *const ppsz_language_text[] =
 #endif
 
 static const char *const ppsz_snap_formats[] =
-{ "png", "jpg" };
+{ "png", "jpg", "tiff" };
 
 /*****************************************************************************
  * Configuration options for the main program. Each module will also separatly
@@ -268,13 +268,11 @@ static const char *const ppsz_snap_formats[] =
 
 #define VOLUME_TEXT N_("Default audio volume")
 #define VOLUME_LONGTEXT N_( \
-    "You can set the default audio output volume here, in a range from 0 to " \
-    "1024.")
+    "You can set the default audio output volume here.")
 
 #define VOLUME_STEP_TEXT N_("Audio output volume step")
 #define VOLUME_STEP_LONGTEXT N_( \
-    "The step size of the volume is adjustable using this option, " \
-    "in a range from 0 to 1024." )
+    "The step size of the volume is adjustable using this option.")
 #define AOUT_VOLUME_STEP 32
 
 #define VOLUME_SAVE_TEXT N_( "Remember the audio volume" )
@@ -282,11 +280,6 @@ static const char *const ppsz_snap_formats[] =
     "The volume can be recorded and automatically restored next time " \
     "VLC is used." )
 
-#define AOUT_RATE_TEXT N_("Audio output frequency (Hz)")
-#define AOUT_RATE_LONGTEXT N_( \
-    "You can force the audio output frequency here. Common values are " \
-    "0 (undefined), 48000, 44100, 32000, 22050, 16000, 11025, 8000.")
-
 #if !defined( __APPLE__ )
 #define AOUT_RESAMP_TEXT N_("High quality audio resampling")
 #define AOUT_RESAMP_LONGTEXT N_( \
@@ -300,6 +293,10 @@ static const char *const ppsz_snap_formats[] =
     "This delays the audio output. The delay must be given in milliseconds. " \
     "This can be handy if you notice a lag between the video and the audio.")
 
+#define AUDIO_RESAMPLER_TEXT N_("Audio resampler")
+#define AUDIO_RESAMPLER_LONGTEXT N_( \
+    "This selects which plugin to use for audio resampling." )
+
 #define MULTICHA_TEXT N_("Audio output channels mode")
 #define MULTICHA_LONGTEXT N_( \
     "This sets the audio output channels mode that will " \
@@ -743,7 +740,7 @@ static const char *const ppsz_clock_descriptions[] =
     "When several video formats are available, select one whose " \
     "resolution is closest to (but not higher than) this setting, " \
     "in number of lines. Use this option if you don't have enough CPU " \
-    "power or network bandwith to play higher resolutions.")
+    "power or network bandwidth to play higher resolutions.")
 static const int pi_prefres[] = { -1, 1080, 720, 576, 360, 240 };
 static const char *const ppsz_prefres[] = {
     N_("Best available"), N_("Full HD (1080p)"), N_("HD (720p)"),
@@ -970,7 +967,7 @@ static const char *const ppsz_prefres[] = {
 
 #define HTTP_CRL_TEXT N_("HTTP/TLS Certificate Revocation List")
 #define CRL_LONGTEXT N_( \
-   "This file countains an optional CRL to prevent remove clients " \
+   "This file contains an optional CRL to prevent remove clients " \
    "from using revoked certificates in TLS sessions.")
 
 #define SOCKS_SERVER_TEXT N_("SOCKS server")
@@ -1610,6 +1607,9 @@ vlc_module_begin ()
                  DESYNC_LONGTEXT, true )
         change_safe ()
 
+    add_module( "audio-resampler", "audio resampler", NULL,
+                AUDIO_RESAMPLER_TEXT, AUDIO_RESAMPLER_LONGTEXT, true )
+
     /* FIXME TODO create a subcat replay gain ? */
     add_string( "audio-replay-gain-mode", ppsz_replay_gain_mode[0], AUDIO_REPLAY_GAIN_MODE_TEXT,
                 AUDIO_REPLAY_GAIN_MODE_LONGTEXT, false )