[FFmpeg-devel] [PATCH 8/6] doc/protocols: Fill in missing HTTP options

[Derek Buitenhuis]

On 4/16/2024 6:13 PM, Stefano Sabatini wrote:
>> + at item metadata
>> +An exported dictionary containing Icecast metadata from the bitstream, if present.
>> +Only useful with the C API.
> 
> Probably best to use impersonal verbal mode:
> Set an exported ...

This is not quite right. This is not a user-settable option, but exported data from http.c
to be read by the user.

>> + at item location
>> +An exported dictionary containing the content location. Only useful with the C
>> +API.
> 
> Ditto

Same comment as above.


>> + at item reconnect_max_retries
>> +Sets the maximum number of times to retry a connection. Default unset.
> 
> Set the ...

Done.

>> + at item resource
>> +The resource requested by a client, when the experimental HTTP server is in use.
> 
> Set the ...

It is an export, as noted in a few of the above options, and not user-settable.

> also this might be more explicit (what is a resource in this context?)

Resource is a standard HTTP term: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web

>> + at item short_seek_size
>> +The threshold, in bytes, for when a readahead should be prefered over a seek and
>> +new HTTP request. This is useful, for example, to make sure the same connection
>> +is used for reading large video packets with small audio packets in between.
> 
> Set the ...
> for consistency reasons

Done.

v2 patch set sent: https://ffmpeg.org//pipermail/ffmpeg-devel/2024-April/326065.html

- Derek