fixed a mistake in the documentation about the headers. (#1420)

This commit is contained in:
Rinon Beselica 2019-01-22 11:10:47 +01:00 committed by Laurin Quast
parent 35e26427ea
commit 59783f012f

View File

@ -420,15 +420,18 @@ Platforms: iOS
Platforms: iOS Platforms: iOS
#### headers #### headers
Pass headers to the HTTP client. Can be used for authorization. Pass headers to the HTTP client. Can be used for authorization. Headers must be a part of the source object.
To enable this on iOS, you will need to manually edit RCTVideo.m and uncomment the header code in the playerItemForSource function. This is because the code used a private API and may cause your app to be rejected by the App Store. Use at your own risk. To enable this on iOS, you will need to manually edit RCTVideo.m and uncomment the header code in the playerItemForSource function. This is because the code used a private API and may cause your app to be rejected by the App Store. Use at your own risk.
Example: Example:
``` ```
headers={{ source={{
Authorization: 'bearer some-token-value', uri: "https://www.example.com/video.mp4",
'X-Custom-Header': 'some value' headers: {
Authorization: 'bearer some-token-value',
'X-Custom-Header': 'some value'
}
}} }}
``` ```