Fix grammar errors in documentation
[libav.git] / libavformat / http.h
1 /*
2 * HTTP definitions
3 * Copyright (c) 2010 Josh Allmann
4 *
5 * This file is part of FFmpeg.
6 *
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22 #ifndef AVFORMAT_HTTP_H
23 #define AVFORMAT_HTTP_H
24
25 #include "avio.h"
26
27 /**
28 * Set custom HTTP headers.
29 * A trailing CRLF ("\r\n") is required for custom headers.
30 * Passing in an empty header string ("\0") will reset to defaults.
31 *
32 * The following headers can be overriden by custom values,
33 * otherwise they will be set to their defaults.
34 * -User-Agent
35 * -Accept
36 * -Range
37 * -Host
38 * -Connection
39 *
40 * @param h URL context for this HTTP connection
41 * @param headers the custom headers to set
42 */
43 void ff_http_set_headers(URLContext *h, const char *headers);
44
45 /**
46 * Enable or disable chunked transfer encoding. (default is enabled)
47 *
48 * @param h URL context for this HTTP connection
49 * @param is_chunked 0 to disable chunking, nonzero otherwise.
50 */
51 void ff_http_set_chunked_transfer_encoding(URLContext *h, int is_chunked);
52
53 /**
54 * Initialize the authentication state based on another HTTP URLContext.
55 * This can be used to pre-initialize the authentication parameters if
56 * they are known beforehand, to avoid having to do an initial failing
57 * request just to get the parameters.
58 *
59 * @param dest URL context whose authentication state gets updated
60 * @param src URL context whose authentication state gets copied
61 */
62 void ff_http_init_auth_state(URLContext *dest, const URLContext *src);
63
64 #endif /* AVFORMAT_HTTP_H */