sjs/media
1
0
Fork 0
mirror of https://github.com/samsonjs/media.git synced 2026-03-27 09:45:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clarify DataSpec.httpRequestHeaders documentation

Browse source 
Issue: #7069
PiperOrigin-RevId: 300738492
This commit is contained in:
olly 2020-03-13 12:36:19 +00:00 committed by Oliver Woodman
parent 3acc85c2df
commit c294e0cb89
1 changed files with 25 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
library/common/src/main/java/com/google/android/exoplayer2/upstream/DataSpec.java
View file

@ -133,6 +133,10 @@ public final class DataSpec {
/**
* Sets the {@link DataSpec#httpRequestHeaders}. The default value is an empty map.
*
* <p>Note: {@code Range}, {@code Accept-Encoding} and {@code User-Agent} should not be set with
* this method, since they are set directly by {@link HttpDataSource} implementations. See
* {@link DataSpec#httpRequestHeaders} for more details.
*
* @param httpRequestHeaders The {@link DataSpec#httpRequestHeaders}.
* @return The builder.
*/
@ -325,7 +329,27 @@ public final class DataSpec {
*/
@Nullable public final byte[] httpBody;
/** Immutable map containing the headers to use in HTTP requests. */
/**
* Additional HTTP headers to use when requesting the data.
*
* <p>Note: This map is for additional headers specific to the data being requested. It does not
* include headers that are set directly by {@link HttpDataSource} implementations. In particular,
* this means the following headers are not included:
*
* <ul>
* <li>{@code Range}: {@link HttpDataSource} implementations derive the {@code Range} header
* from {@link #position} and {@link #length}.
* <li>{@code Accept-Encoding}: {@link HttpDataSource} implementations derive the {@code
* Accept-Encoding} header based on whether {@link #flags} includes {@link
* #FLAG_ALLOW_GZIP}.
* <li>{@code User-Agent}: {@link HttpDataSource} implementations set the {@code User-Agent}
* header directly.
* <li>Other headers set at the {@link HttpDataSource} layer. I.e., headers set using {@link
* HttpDataSource#setRequestProperty(String, String)}, and using {@link
* HttpDataSource.RequestProperties#set(String, String)} on the default properties obtained
* from {@link HttpDataSource.Factory#getDefaultRequestProperties()}.
* </ul>
*/
public final Map<String, String> httpRequestHeaders;
/**