Difference between revisions of "Documentation:Modules/http"

From VideoLAN Wiki
Jump to navigation Jump to search
m (→‎Source code: New section)
(Update/expand from source code/changelog, add wikilinks and notes)
Line 1: Line 1:
{{Module|name=http|type=Access|description=HTTP input}}
+
The <code>--http-caching</code> option was removed prior to VLC 2.0.0 with this commitdiff: {{Commitdiff|31ac20b22fc37bcf78991159bf8a0f138db05b44|l=Unify (ACCESS{{!}}DEMUX)_GET_PTS_DELAY}}
 +
 
 +
The option <code>--http-proxy</code> was removed from the 3.0.x and 4.0.0-dev branches with this commitdiff: {{Commitdiff|6514ed051d579972f21949be3900a48d8d62c647|l=HTTP win32: use http-proxy options to setup the proxy}} with summary ''Because win32/netconf is not ready''.
 +
 
 +
The option <code>--http-user-agent</code> changed in VLC 1.1.1 (changelog):
 +
[[libvlc]]_set_user_agent() configures the "[[wikipedia:User agent|user agent]]" strings used for some
 +
protocols (HTTP, PulseAudio...). This replaces the --http-user-agent and
 +
the former --user-agent libvlc_new() parameters.
 +
 
 +
== HTTP ==
 +
{{Module|name=http|type=Access|description=[[HTTP]] input}}
  
 
As of VLC 0.9.0 this module accepts gzip compressed data and Digest Access Authentication.
 
As of VLC 0.9.0 this module accepts gzip compressed data and Digest Access Authentication.
  
== Options ==
+
=== Options ===
 
{{Option
 
{{Option
|name=http-proxy
+
|name=http-reconnect
|value=string
+
|default=disabled
|default=""
+
|description=Automatically try to reconnect in case of a sudden disconnect
|description=HTTP proxy. http://[user[:password]@]proxy.example.com:port/
 
 
}}
 
}}
 +
 +
{{Clear}}
 +
== HTTPS ==
 +
{{Module|name=https|type=Access|description=[[HTTPS]] input}}
 +
 +
=== Options ===
 
{{Option
 
{{Option
|name=http-caching
+
|name=http-forward-cookies
|value=integer
+
|value=boolean
|description=Caching in ms
+
|default=enabled
 +
|description=Forward cookies across HTTP redirections
 
}}
 
}}
 
{{Option
 
{{Option
|name=http-user-agent
+
|name=http-referrer
 
|value=string
 
|value=string
|description=User agent
+
|default=NULL
 +
|description=Provide the referral URL, i.e. HTTP "[[wikipedia:HTTP referer|Referer]]" &#x5B;''[[wiktionary:sic#Usage_notes|sic]]''&#x5D;
 
}}
 
}}
 
{{Option
 
{{Option
|name=http-reconnect
+
|name=http-user-agent
|default=disabled
+
|value=string
|description=Automatically try to reconnect in case of a sudden disconnect
+
|default=NULL
 +
|description=Override the name and version of the application as provided to the HTTP server, i.e. the HTTP "[[wikipedia:User agent|User-Agent]]". Name and version must be separated by a forward slash, e.g. "FooBar/1.2.3"
 
}}
 
}}
 
{{Option
 
{{Option
 
|name=http-continuous
 
|name=http-continuous
 +
|value=boolean
 
|default=disabled
 
|default=disabled
|description=Read a file that is being constantly updated (for example a JPEG file)
+
|description=Keep reading a resource that keeps being updated (for example a JPEG file)
 
}}
 
}}
  
 
== Source code ==
 
== Source code ==
* {{VLCSourceFile|modules/access/http.c}} (main file)
+
* {{VLCSourceFile|modules/access/http.c}} (file - HTTP module)
 +
* {{VLCSourceFile|modules/access/http/access.c}} (file - HTTPS sub-module)
 
* {{VLCSourceFolder|modules/access/http}} (folder)
 
* {{VLCSourceFolder|modules/access/http}} (folder)
  

Revision as of 04:14, 3 April 2019

The --http-caching option was removed prior to VLC 2.0.0 with this commitdiff: Unify (ACCESS|DEMUX)_GET_PTS_DELAY

The option --http-proxy was removed from the 3.0.x and 4.0.0-dev branches with this commitdiff: HTTP win32: use http-proxy options to setup the proxy with summary Because win32/netconf is not ready.

The option --http-user-agent changed in VLC 1.1.1 (changelog):

libvlc_set_user_agent() configures the "user agent" strings used for some
protocols (HTTP, PulseAudio...). This replaces the --http-user-agent and
the former --user-agent libvlc_new() parameters.

HTTP

Module: http
Type Access
First VLC version -
Last VLC version -
Operating system(s) all
Description HTTP input
Shortcut(s) -

As of VLC 0.9.0 this module accepts gzip compressed data and Digest Access Authentication.

Options

  • http-reconnect : Automatically try to reconnect in case of a sudden disconnect default value: disabled

HTTPS

Module: https
Type Access
First VLC version -
Last VLC version -
Operating system(s) all
Description HTTPS input
Shortcut(s) -

Options

  • http-forward-cookies <boolean> : Forward cookies across HTTP redirections default value: enabled
  • http-referrer <string> : Provide the referral URL, i.e. HTTP "Referer" [sic] default value: NULL
  • http-user-agent <string> : Override the name and version of the application as provided to the HTTP server, i.e. the HTTP "User-Agent". Name and version must be separated by a forward slash, e.g. "FooBar/1.2.3" default value: NULL
  • http-continuous <boolean> : Keep reading a resource that keeps being updated (for example a JPEG file) default value: disabled

Source code

Help VideoLAN by adding to this page!
Create an account to start editing, and then click here to add to this article.
This page is part of official VLC media player Documentation (User GuideStreaming HowToHacker GuideModules)
Please read the Documentation Editing Guidelines before you edit the documentation
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.