[FFmpeg-devel] [PATCH 4/4] Document "srtp" protocol

Stefano Sabatini stefasab at gmail.com
Mon Jun 17 13:54:53 CEST 2013


On date Saturday 2013-06-15 23:03:41 +0300, Andrey Utkin encoded:
> ---
>  doc/protocols.texi | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
> 
> diff --git a/doc/protocols.texi b/doc/protocols.texi
> index 8e82ee2..035ba1b 100644
> --- a/doc/protocols.texi
> +++ b/doc/protocols.texi
> @@ -717,6 +717,21 @@ Listen for an incoming connection
>  Set the maximum number of streams
>  @end table
>  
> + at section srtp
> +

> +SRTP implementation.

You might specify the meaning of the acronym in parentheses.

Also you might omit "implementation" since it looks a bit redundant
and is not consistent with the remainder of the file.

> +
> +The accepted options are:
> + at table @option
> + at item srtp_out_suite
> + at item srtp_out_params
> + at item srtp_in_suite
> + at item srtp_in_params
> + at end table

Extending the descriptions would be nice (but feel free to omit it).

> +Options are passed not as URL parameters.
> +In case of command line usage, they are passed as command line arguments.
> +In case of avio_open2() usage, they are passed as last parameter, AVDictionary **options.

Same consideration as in the case of the crypto protocol.


More information about the ffmpeg-devel mailing list