[FFmpeg-devel] [PATCH v4 3/3] avformat/whip: fix typos

[Marvin Scholz]

On 28 Jun 2025, at 4:17, Jack Lau via ffmpeg-devel wrote:

>          AV_OPT_TYPE_INT,    { .i64 = 1200 },                        -1, INT_MAX, ENC },
> -    { "authorization",      "The optional Bearer token for WHIP Authorization",         OFFSET(authorization),
> +    { "authorization",      "(Optional) Bearer token for WHIP Authorization",         OFFSET(authorization),
>          AV_OPT_TYPE_STRING, { .str = NULL },                        0,        0, ENC },
> -    { "cert_file",          "The optional certificate file path for DTLS",              OFFSET(cert_file),
> +    { "cert_file",          "(Optional) Certificate file path for DTLS",              OFFSET(cert_file),
>          AV_OPT_TYPE_STRING, { .str = NULL },                        0,        0, ENC },
> -    { "key_file",           "The optional private key file path for DTLS",              OFFSET(key_file),
> +    { "key_file",           "(Optional) Private key file path for DTLS",              OFFSET(key_file),
>          AV_OPT_TYPE_STRING, { .str = NULL },                        0,        0, ENC },

I dont think we mark any options as option like this so maybe just change those to:

Optional bearer token for WHIP Authorization

Optional certificate file path for DTLS

Optional private key file path for DTLS

> -    { "whip_flags",         "Set flags affecting WHIP connection behavior",             OFFSET(flags),
> +    { "whip_flags",         "(Optional) Set flags affecting WHIP connection behavior",             OFFSET(flags),

I dont think it makes sense here to mention this is optional, thats a given.

>          AV_OPT_TYPE_FLAGS,  { .i64 = 0 },                           0, UINT_MAX, ENC, .unit = "flags" },
>      { "ignore_ipv6",        "(Optional) Ignore any IPv6 ICE candidate",               0,
>          AV_OPT_TYPE_CONST,  { .i64 = WHIP_FLAG_IGNORE_IPV6 },       0, UINT_MAX, ENC, .unit = "flags" },

Same.

Otherwise the set looks good to me.

> _______________________________________________
> ffmpeg-devel mailing list
> ffmpeg-devel at ffmpeg.org
> https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
>
> To unsubscribe, visit link above, or email
> ffmpeg-devel-request at ffmpeg.org with subject "unsubscribe".