]> git.sesse.net Git - vlc/blobdiff - src/libvlc.h
Move python mediacontrol bindings
[vlc] / src / libvlc.h
index 32012270fe753f18b1b3582944beacb76aa66369..aa9208283e5e90a9f73ce0222c98d85dabec5f54 100644 (file)
@@ -1,7 +1,7 @@
 /*****************************************************************************
  * libvlc.h: main libvlc header
  *****************************************************************************
- * Copyright (C) 1998-2005 VideoLAN (Centrale Réseaux) and its contributors
+ * Copyright (C) 1998-2006 the VideoLAN team
  * $Id$
  *
  * Authors: Vincent Seguin <seguin@via.ecp.fr>
@@ -100,6 +100,11 @@ static char *ppsz_snap_formats[] =
     "show all the available options, including those that most users should " \
     "never touch.")
 
+#define SHOWINTF_TEXT N_("Show interface with mouse")
+#define SHOWINTF_LONGTEXT N_( \
+    "If this enabled, the interface will be shown when you move the mouse to "\
+    "the edge of the screen in fullscreen mode." )
+
 #define AOUT_CAT_LONGTEXT N_( \
     "These options allow you to modify the behavior of the audio " \
     "subsystem, and to add audio filters which can be used for " \
@@ -140,7 +145,7 @@ static char *ppsz_snap_formats[] =
     "You can force the audio output frequency here. Common values are " \
     "-1 (default), 48000, 44100, 32000, 22050, 16000, 11025, 8000.")
 
-#if !defined( SYS_DARWIN )
+#if !defined( __APPLE__ )
 #define AOUT_RESAMP_TEXT N_("High quality audio resampling")
 #define AOUT_RESAMP_LONGTEXT N_( \
     "This uses a high quality audio resampling algorithm. High quality "\
@@ -264,6 +269,13 @@ static char *ppsz_align_descriptions[] =
 #define SS_TEXT N_("Disable screensaver")
 #define SS_LONGTEXT N_("Disable the screensaver during video playback." )
 
+#define FILE_LOG_TEXT N_( "Log to file" )
+#define FILE_LOG_LONGTEXT N_( "Log all VLC messages to a text file. Use the "\
+    "logfile option to set the file name." )
+
+#define SYSLOG_TEXT N_( "Log to syslog" )
+#define SYSLOG_LONGTEXT N_( "Log all VLC messages to syslog." )
+
 #define VIDEO_DECO_TEXT N_("Window decorations")
 #define VIDEO_DECO_LONGTEXT N_( \
     "If this option is disabled, VLC will avoid creating window caption, " \
@@ -285,6 +297,11 @@ static char *ppsz_align_descriptions[] =
     "Allows you to specify the image format in which the video snapshots will " \
     "be stored.")
 
+#define SNAP_PREVIEW_TEXT N_("Display video snapshot preview")
+#define SNAP_PREVIEW_LONGTEXT N_( \
+    "Enable / disable displaying the snapshot preview in the screen's to " \
+    " left corner.")
+
 #define CROP_TEXT N_("Video cropping")
 #define CROP_LONGTEXT N_( \
     "This will force the cropping of the source video. " \
@@ -338,13 +355,18 @@ static char *ppsz_align_descriptions[] =
     "Allows you to enable/disable the input clock synchronisation for " \
     "real-time sources.")
 
+#define NETSYNC_TEXT N_("Network synchronisation" )
+#define NETSYNC_LONGTEXT N_( "This allows you to remotely " \
+        "synchronise clocks for server and client. The detailed settings " \
+        "are available in Advanced / Others / Network Sync" )
+
 static int pi_clock_values[] = { -1, 0, 1 };
 static char *ppsz_clock_descriptions[] =
 { N_("Default"), N_("Disable"), N_("Enable") };
 
 #define SERVER_PORT_TEXT N_("UDP port")
 #define SERVER_PORT_LONGTEXT N_( \
-    "This is the port used for UDP streams. By default, we chose 1234.")
+    "This is the port used for UDP streams. 1234 by default.")
 
 #define MTU_TEXT N_("MTU of the network interface")
 #define MTU_LONGTEXT N_( \
@@ -354,13 +376,18 @@ static char *ppsz_clock_descriptions[] =
 #define TTL_TEXT N_("Hop limit (TTL)")
 #define TTL_LONGTEXT N_( \
     "Specify the hop limit (TTL) of the multicast packets sent by " \
-    "the stream output.")
+    "the stream output (0 = use operating system built-in default).")
 
-#define MIFACE_TEXT N_("Multicast output interface")
+#define MIFACE_TEXT N_("IPv6 multicast output interface")
 #define MIFACE_LONGTEXT N_( \
     "Indicate here the multicast output interface. " \
     "This overrides the routing table.")
 
+#define MIFACE_ADDR_TEXT N_("IPv4 multicast output interface address")
+#define MIFACE_ADDR_LONGTEXT N_( \
+    "Specify the IPv4 address of the networking interface. " \
+    "This overrides the routing table.")
+
 #define INPUT_PROGRAM_TEXT N_("Program to select")
 #define INPUT_PROGRAM_LONGTEXT N_( \
     "Choose the program to select by giving its Service ID.\n" \
@@ -687,6 +714,11 @@ static char *ppsz_clock_descriptions[] =
      "These options define the behavior of the playlist. Some " \
      "of them can be overridden in the playlist dialog box." )
 
+#define PREPARSE_TEXT N_( "Automatically preparse files")
+#define PREPARSE_LONGTEXT N_( \
+    "This option enables automatic preparsing of files added to the playlist " \
+    "(to retrieve some metadata)." )
+
 #define SD_TEXT N_( "Services discovery modules")
 #define SD_LONGTEXT N_( \
      "Specifies the services discovery modules to load, separated by " \
@@ -767,12 +799,12 @@ static char *ppsz_clock_descriptions[] =
     "This option allows you to use a plugins cache which will greatly " \
     "improve the start time of VLC.")
 
-#define DAEMON_TEXT N_("Collect statistics")
-#define DAEMON_LONGTEXT N_( \
+#define STATS_TEXT N_("Collect statistics")
+#define STATS_LONGTEXT N_( \
      "This option allows you to collect miscellaneous statistics.")
 
-#define STATS_TEXT N_("Run as daemon process")
-#define STATS_LONGTEXT N_( \
+#define DAEMON_TEXT N_("Run as daemon process")
+#define DAEMON_LONGTEXT N_( \
      "Runs VLC as a background daemon process.")
 
 #define ONEINSTANCE_TEXT N_("Allow only one running instance")
@@ -1027,7 +1059,7 @@ vlc_module_begin();
                             VOLUME_STEP_LONGTEXT, VLC_TRUE );
     add_integer( "aout-rate", -1, NULL, AOUT_RATE_TEXT,
                  AOUT_RATE_LONGTEXT, VLC_TRUE );
-#if !defined( SYS_DARWIN )
+#if !defined( __APPLE__ )
     add_bool( "hq-resampling", 1, NULL, AOUT_RESAMP_TEXT,
               AOUT_RESAMP_LONGTEXT, VLC_TRUE );
 #endif
@@ -1063,7 +1095,7 @@ vlc_module_begin();
               SKIP_FRAMES_LONGTEXT, VLC_TRUE );
     add_bool( "quiet-synchro", 0, NULL, QUIET_SYNCHRO_TEXT,
               QUIET_SYNCHRO_LONGTEXT, VLC_TRUE );
-#ifndef SYS_DARWIN
+#ifndef __APPLE__
     add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT, VLC_TRUE );
 #endif
     add_bool( "video-on-top", 0, NULL, VIDEO_ON_TOP_TEXT,
@@ -1071,12 +1103,21 @@ vlc_module_begin();
     add_bool( "disable-screensaver", VLC_TRUE, NULL, SS_TEXT, SS_LONGTEXT,
               VLC_TRUE );
 
+    add_bool( "file-logging", VLC_FALSE, NULL, FILE_LOG_TEXT, FILE_LOG_LONGTEXT,
+              VLC_TRUE );
+#if HAVE_SYSLOG_H
+    add_bool ( "syslog", VLC_FALSE, NULL, SYSLOG_TEXT, SYSLOG_LONGTEXT,
+               VLC_TRUE );
+#endif
+
     set_section( N_("Snapshot") , NULL );
     add_directory( "snapshot-path", NULL, NULL, SNAP_PATH_TEXT,
                    SNAP_PATH_LONGTEXT, VLC_FALSE );
     add_string( "snapshot-format", "png", NULL, SNAP_FORMAT_TEXT,
                    SNAP_FORMAT_LONGTEXT, VLC_FALSE );
         change_string_list( ppsz_snap_formats, NULL, 0 );
+    add_bool( "snapshot-preview", VLC_TRUE, NULL, SNAP_PREVIEW_TEXT,
+              SNAP_PREVIEW_LONGTEXT, VLC_FALSE );
 
     set_section( N_("Window properties" ), NULL );
     add_integer( "width", -1, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, VLC_TRUE );
@@ -1237,6 +1278,9 @@ vlc_module_begin();
                  CLOCK_SYNCHRO_LONGTEXT, VLC_TRUE );
         change_integer_list( pi_clock_values, ppsz_clock_descriptions, 0 );
 
+    add_bool( "network-synchronisation", VLC_FALSE, NULL, NETSYNC_TEXT,
+              NETSYNC_LONGTEXT, VLC_TRUE );
+
 /* Decoder options */
     add_category_hint( N_("Decoders"), CODEC_CAT_LONGTEXT , VLC_TRUE );
     add_string( "codec", NULL, NULL, CODEC_TEXT,
@@ -1288,8 +1332,9 @@ vlc_module_begin();
     set_subcategory( SUBCAT_SOUT_ACO );
     add_module( "access_output", "sout access", NULL, NULL,
                 ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT, VLC_TRUE );
-    add_integer( "ttl", 1, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
-    add_string( "miface-addr", NULL, NULL, MIFACE_TEXT, MIFACE_LONGTEXT, VLC_TRUE );
+    add_integer( "ttl", 0, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
+    add_string( "miface", NULL, NULL, MIFACE_TEXT, MIFACE_LONGTEXT, VLC_TRUE );
+    add_string( "miface-addr", NULL, NULL, MIFACE_ADDR_TEXT, MIFACE_ADDR_LONGTEXT, VLC_TRUE );
 
     set_subcategory( SUBCAT_SOUT_PACKETIZER );
     add_module( "packetizer","packetizer", NULL, NULL,
@@ -1314,7 +1359,7 @@ vlc_module_begin();
     add_bool( "sse", 1, NULL, SSE_TEXT, SSE_LONGTEXT, VLC_TRUE );
     add_bool( "sse2", 1, NULL, SSE2_TEXT, SSE2_LONGTEXT, VLC_TRUE );
 #endif
-#if defined( __powerpc__ ) || defined( SYS_DARWIN )
+#if defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
     add_bool( "altivec", 1, NULL, ALTIVEC_TEXT, ALTIVEC_LONGTEXT, VLC_TRUE );
 #endif
 
@@ -1336,7 +1381,7 @@ vlc_module_begin();
     add_bool( "minimize-threads", 0, NULL, MINIMIZE_THREADS_TEXT,
               MINIMIZE_THREADS_LONGTEXT, VLC_TRUE );
 
-#if !defined(SYS_DARWIN) && !defined(SYS_BEOS) && defined(PTHREAD_COND_T_IN_PTHREAD_H)
+#if !defined(__APPLE__) && !defined(SYS_BEOS) && defined(PTHREAD_COND_T_IN_PTHREAD_H)
     add_bool( "rt-priority", VLC_FALSE, NULL, RT_PRIORITY_TEXT,
               RT_PRIORITY_LONGTEXT, VLC_TRUE );
 #endif
@@ -1384,6 +1429,8 @@ vlc_module_begin();
 
     add_string( "open", "", NULL, OPEN_TEXT, OPEN_LONGTEXT, VLC_FALSE );
 
+    add_bool( "auto-preparse", VLC_TRUE, NULL, PREPARSE_TEXT, PREPARSE_LONGTEXT, VLC_FALSE );
+
     set_subcategory( SUBCAT_PLAYLIST_SD );
     add_module_list_cat( "services-discovery", SUBCAT_PLAYLIST_SD, NULL,
                           NULL, SD_TEXT, SD_LONGTEXT, VLC_FALSE );
@@ -1393,12 +1440,11 @@ vlc_module_begin();
     set_category( CAT_INTERFACE );
     set_subcategory( SUBCAT_INTERFACE_GENERAL );
     add_category_hint( N_("Interface"), INTF_CAT_LONGTEXT , VLC_FALSE );
-    set_section ( N_("Interface module" ), NULL );
+    set_section ( N_("Interfaces" ), NULL );
     add_module_cat( "intf", SUBCAT_INTERFACE_GENERAL, NULL, NULL, INTF_TEXT,
                 INTF_LONGTEXT, VLC_FALSE );
         change_short('I');
 
-    set_section ( N_("Extra interface modules" ),  NULL );
     add_module_list_cat( "extraintf", SUBCAT_INTERFACE_GENERAL,
                          NULL, NULL, EXTRAINTF_TEXT,
                          EXTRAINTF_LONGTEXT, VLC_FALSE );
@@ -1416,6 +1462,9 @@ vlc_module_begin();
     add_bool( "advanced", 0, NULL, ADVANCED_TEXT, ADVANCED_LONGTEXT,
                     VLC_FALSE );
 
+    add_bool( "show-intf", VLC_FALSE, NULL, SHOWINTF_TEXT, SHOWINTF_LONGTEXT,
+              VLC_FALSE );
+
     set_subcategory( SUBCAT_INTERFACE_CONTROL );
     add_module_list_cat( "control", SUBCAT_INTERFACE_CONTROL, NULL, NULL,
                          CONTROL_TEXT, CONTROL_LONGTEXT, VLC_FALSE );
@@ -1424,7 +1473,7 @@ vlc_module_begin();
     set_subcategory( SUBCAT_INTERFACE_HOTKEYS );
     add_category_hint( N_("Hot keys"), HOTKEY_CAT_LONGTEXT , VLC_FALSE );
 
-#if defined(SYS_DARWIN)
+#if defined(__APPLE__)
 /* Don't use the following combo's */
 
 /*  copy                          KEY_MODIFIER_COMMAND|'c'