Skip to content

Commit 3607ef3

Browse files
committed
add content overview for NewPlayer docu
1 parent d2d9cfd commit 3607ef3

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,16 @@
1515
### So what is NewPlayer then?
1616
NewPlayer is a media framework, which is independent of NewPipe itself. I decided to make it independent, because one of the big issues we have with the current player is that it is deeply integrated into NewPipe. Therefore, I wanted to make NewPlayer a separate module in order to enforce that the interface between NewPipe and the player is only as big as necessary. This also has the advantage that NewPlayer can be used independently of NewPipe itself, which means it can be used in other apps too.
1717

18+
## Content
19+
20+
1. [Quick overview](#let-me-give-you-a-profile-about-newplayer)
21+
2. [Preview](#how-does-newplayer-look-like)
22+
3. [Documentation](#documentation)
23+
- [Getting started](#getting-started)
24+
- [How NewPlayer works](#how-does-newplayer-work)
25+
4. [Code Documentation](https://teamnewpipe.github.io/NewPlayer/)
26+
27+
1828
### Let me give you a Profile about NewPlayer:
1929
- It is a module, separate from NewPipe and can be used as an independent player framework
2030
- It is based on the [Media3](https://developer.android.com/media/media3) library
@@ -134,16 +144,12 @@ Main menu
134144
135145
6. **Give NewPlayer access to your media**
136146
137-
You can do this by implementing your own [`MediaRepository`](https://teamnewpipe.github.io/NewPlayer/new-player/net.newpipe.newplayer.repository/-media-repository/index.html). You can find more information about the [`MediaRepository`](https://teamnewpipe.github.io/NewPlayer/new-player/net.newpipe.newplayer.repository/-media-repository/index.html) inside its [`code documentation`](https://github.com/TeamNewPipe/NewPlayer/blob/dev/new-player/src/main/java/net/newpipe/newplayer/repository/MediaRepository.kt#L32-71). You can also find a [test implementation](https://github.com/TeamNewPipe/NewPlayer/blob/dev/test-app/src/main/java/net/newpipe/newplayer/testapp/TestMediaRepository.kt) of it in the test-app.
147+
You can do this by implementing your own [`MediaRepository`](https://teamnewpipe.github.io/NewPlayer/new-player/net.newpipe.newplayer.repository/-media-repository/index.html). More information can be found about thins in the [`MediaRepository code documentation`](https://teamnewpipe.github.io/NewPlayer/new-player/net.newpipe.newplayer.repository/-media-repository/index.html). There is also an [example implementation](https://github.com/TeamNewPipe/NewPlayer/blob/dev/test-app/src/main/java/net/newpipe/newplayer/testapp/TestMediaRepository.kt) of it in the test-app.
138148
139149
7. **Do advanced things**
140150
Like applying caching and prefetching to your media repository using the meta `MediaRepository` implementations, or perform error handling and error recovering. *TOOD: Write the documentation for this*
141151
142152
143-
## Documentation
144-
145-
You can find the code documentation for NewPlayer [here](https://teamnewpipe.github.io/NewPlayer/).
146-
147153
## How does NewPlayer work
148154
149155
![Immage showing NewPlayer's architecture](/misc/newplayer_architecture.svg)

0 commit comments

Comments
 (0)