Skip to content

Commit 7856a4b

Browse files
docs-2288-docs-refactor (#3)
* Updated README and supporting docs --------- Co-authored-by: Joe Milham <[email protected]>
1 parent ddbdf64 commit 7856a4b

File tree

6 files changed

+1247
-989
lines changed

6 files changed

+1247
-989
lines changed

Pre.0.2.0_README.md

-475
This file was deleted.

README.md

+314-512
Large diffs are not rendered by default.

docs/legacy_readme.md

+634
Large diffs are not rendered by default.

docs/props.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Props
2+
3+
This wrapper implements the native methods exposed by the [Android](https://sdk.jwplayer.com/android/v4/reference/com/jwplayer/pub/api/JsonHelper.html) and [iOS](https://sdk.jwplayer.com/ios/v4/reference/Classes/JWJSONParser.html) SDK for parsing JSON objects into player configs.
4+
5+
| Prop | Type | Platform | Description | Default |
6+
| --- | --- | --- | --- | --- |
7+
| `config` | object | A, I | **(REQUIRED)** `JWConfig` object<br />See: [Config](#config) | `undefined` |
8+
| `controls` | boolean | A, I | Determines if player controls are displayed | `true` |
9+
10+
<br /><br />
11+
12+
## Config
13+
With the exception of `license` and `playlist`, all other fields are optional.
14+
15+
See [`types`](./types.md) for a definition of config types defined below
16+
17+
| Field | Type | Platform | Additional Notes |
18+
| --- | --- | --- | --- |
19+
| `license` | string |A, I | **(REQUIRED)** Platform-specific license key<br />([Android](https://docs.jwplayer.com/players/docs/android-overview#requirements) \| [iOS](https://docs.jwplayer.com/players/docs/ios-overview#requirements))|
20+
| [`playlist`](https://docs.jwplayer.com/players/reference/setup-options#playlist) | JwPlaylistItem[ ] &#124; string | A, I | **(REQUIRED)** |
21+
| [`advertising`](https://docs.jwplayer.com/players/reference/advertising-config-ref) |JwAdvertisingConfig | A, I | |
22+
| `allowCrossProtocolRedirectsSupport` | boolean | A | |
23+
| [`autostart`](https://docs.jwplayer.com/players/reference/setup-options#autostart) | boolean | A, I | |
24+
| [`displaydescription`](https://docs.jwplayer.com/players/reference/setup-options#displaydescription) | boolean| A, I | |
25+
| [`displaytitle`](https://docs.jwplayer.com/players/reference/setup-options#displaytitle) | boolean | A | |
26+
| [`file`](https://docs.jwplayer.com/players/reference/playlists#file) | string | A, I | |
27+
| `forceLegacyConfig` | boolean | A, I | Determines whether to use the legacy configuration settings |
28+
| `logoView` | JwLogoView | A, I | |
29+
| [`mute`](https://docs.jwplayer.com/players/reference/setup-options#mute) | boolean | A, I | |
30+
| [`nextupoffset`](https://docs.jwplayer.com/players/reference/setup-options#nextupoffset) | string &#124; number | A, I | |
31+
| `pid` | string | A, I | Unique identifier of the player |
32+
| [`playbackRateControls`](https://docs.jwplayer.com/players/reference/setup-options#playbackratecontrols) | boolean | A, I | |
33+
| [`playbackRates`](https://docs.jwplayer.com/players/reference/setup-options#playbackrates)|number[ ] | A, I | |
34+
| [`playlistIndex`](https://docs.jwplayer.com/players/reference/setup-options#playlistIndex) | number | A, I | |
35+
| [`preload`](https://docs.jwplayer.com/players/reference/setup-options#preload) | boolean | A, I | |
36+
| [`related`](https://docs.jwplayer.com/players/reference/related-config-ref) | JwRelatedConfig | A, I | |
37+
| [`repeat`](https://docs.jwplayer.com/players/reference/setup-options#repeat) | boolean | A, I | |
38+
| [`sources`](https://docs.jwplayer.com/players/reference/playlists#playlistsources) | JwSource[ ] | A, I | |
39+
| [`stretching`](https://docs.jwplayer.com/players/reference/setup-options#stretching) | JwStretching | A, I | |
40+
| `thumbnailPreview` | JwThumbnailPreview| A, I | |
41+
| `uiConfig` | JwUiConfig | A, I | |
42+
| `useTextureView` | boolean | A | |
43+

0 commit comments

Comments
 (0)