[FFmpeg-devel] [PATCH] doc/protocols: document http protocol options

[Alexander Strasser]

Hi Stefano,

Stefano Sabatini wrote:
> ---
>  doc/protocols.texi |   36 ++++++++++++++++++++++++++++++++++++
>  1 file changed, 36 insertions(+)
> 
> diff --git a/doc/protocols.texi b/doc/protocols.texi
> index a36d2a3..e983341 100644
> --- a/doc/protocols.texi
> +++ b/doc/protocols.texi
> @@ -128,6 +128,42 @@ m3u8 files.
>  
>  HTTP (Hyper Text Transfer Protocol).
>  
> +This protocol accepts the following options.
> +
> + at table @option
> + at item seekable
> +Control seekability of connection. If set to 1 the resource is
> +supposed to be seekable, if set to 0 it is assumed not to be seekable,
> +if set to -1 it will autodetect the seekability. Default value is 1.

  I think the default is -1.

  Maybe using "if set to -1 it will try to autodetect if it is seekable".
IIRC autodetection fails for some servers, so using a more vague statement
might encourage readers to try setting it to 1.

  Despite that I find it a bit over the top to use the verb control this
way. If I am not mistaken it just controls the treatment of the connection.
Anyway, this is separate issue and should not be considered for this patch.

> +
> + at item chunked_post
> +If set to 1 use chunked transfer-encoding for posts, default is 1.
> +
> + at item headers
> +Set custom HTTP headers, can override built in default headers. The
> +value must be a string encoding the headers.
> +
> + at item content_type
> +Force a content type.
> +
> + at item user-agent
> +Override User-Agent header.
> +
> + at item multiple_requests
> +Use persistent connections if set to 1. By default it is 0.
> +
> + at item post_data
> +Set custom HTTP post data.
> +
> + at item timeout
> +Set timeout of socket I/O operations used by the underlying low level
> +operation. By default it is set to -1, which means that the timeout is
> +not specified.
> +
> + at item mime_type
> +Set MIME type.
> + at end table
> +
>  @section mmst
>  
>  MMS (Microsoft Media Server) protocol over TCP.
> -- 
> 1.7.9.5

  Looks ready to me if you looked at the rendered output.


  Alexander