Skip to content

Commit 997ddcd

Browse files
author
Illia Romanenko
committed
update documentation, fix broken image links
1 parent 2b019c8 commit 997ddcd

File tree

1 file changed

+45
-43
lines changed

1 file changed

+45
-43
lines changed

README.md

Lines changed: 45 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -2,55 +2,14 @@
22
A VLC-powered alternative to Flutter's video_player that supports iOS and Android.
33

44
<p float="left">
5-
<img src="img_example_v4.jpg" height="400">
6-
<img src="imgpsh_mobile_save.jfif?raw=true" height="400">
5+
<img src="https://github.com/solid-software/flutter_vlc_player/blob/master/img_example_v4.jpg?raw=true" height="400">
6+
<img src="https://github.com/solid-software/flutter_vlc_player/blob/master/imgpsh_mobile_save.jfif?raw=true" height="400">
77
</p>
88

99

1010

1111
## Installation
1212

13-
### Version 4.0 Upgrade For Existing Apps
14-
To upgrade to version 4.0 (or v3.0), first you need to migrate the existing project to swift.
15-
16-
Delete existing ios folder from root of flutter project.
17-
Run this command flutter create -i swift .
18-
19-
This command will create only ios directory with swift support. See https://stackoverflow.com/questions/52244346/how-to-enable-swift-support-for-existing-project-in-flutter
20-
21-
<hr>
22-
23-
## Breaking Changes (from V3 to V4)
24-
1) Player Stop/Pause status is seperated
25-
26-
previously (v3 and lower): Stop/Pause -> STOPPED,
27-
<br>
28-
now (v4): Stop -> STOPPED and Pause -> PAUSED.
29-
30-
2) Refactored belowing attributes & methods
31-
32-
// attributes
33-
<br>
34-
audioCount -> audioTracksCount
35-
<br>
36-
activeAudioNum -> activeAudioTrack
37-
<br>
38-
subtitleCount -> spuTracksCount
39-
<br>
40-
activeSubtitleNum -> activeSpuTrack
41-
<br>
42-
<br>
43-
// methods
44-
<br>
45-
changeSound(int audioNumber) -> setAudioTrack(int audioTrackNumber)
46-
<br>
47-
changeSubtitle(int subtitleNumber) -> setSpuTrack(int spuTrackNumber)
48-
<br>
49-
addSubtitle(String filePath) -> addSubtitleTrack(String subtitlePath, ...)
50-
51-
52-
<hr>
53-
5413
### iOS
5514
For iOS, you need to opt into the Flutter embedded views preview.
5615
This is done by adding the following to your project's `<project root>/ios/Runner/Info.plist` file (see example for details):
@@ -438,6 +397,49 @@ VlcPlayerController({
438397
}
439398
```
440399

400+
## Upgrade instructions
401+
402+
### Version 4.0 Upgrade For Existing Apps
403+
To upgrade to version 4.0 (or v3.0), first you need to migrate the existing project to swift.
404+
405+
Delete existing ios folder from root of flutter project.
406+
Run this command flutter create -i swift .
407+
408+
This command will create only ios directory with swift support. See https://stackoverflow.com/questions/52244346/how-to-enable-swift-support-for-existing-project-in-flutter
409+
410+
<hr>
411+
412+
### Breaking Changes (from V3 to V4)
413+
1) Player Stop/Pause status is seperated
414+
415+
previously (v3 and lower): Stop/Pause -> STOPPED,
416+
<br>
417+
now (v4): Stop -> STOPPED and Pause -> PAUSED.
418+
419+
2) Refactored belowing attributes & methods
420+
421+
// attributes
422+
<br>
423+
audioCount -> audioTracksCount
424+
<br>
425+
activeAudioNum -> activeAudioTrack
426+
<br>
427+
subtitleCount -> spuTracksCount
428+
<br>
429+
activeSubtitleNum -> activeSpuTrack
430+
<br>
431+
<br>
432+
// methods
433+
<br>
434+
changeSound(int audioNumber) -> setAudioTrack(int audioTrackNumber)
435+
<br>
436+
changeSubtitle(int subtitleNumber) -> setSpuTrack(int spuTrackNumber)
437+
<br>
438+
addSubtitle(String filePath) -> addSubtitleTrack(String subtitlePath, ...)
439+
440+
441+
<hr>
442+
441443
## Current issues
442444
Current issues list [is here](https://github.com/solid-software/flutter_vlc_player/issues).
443445
Found a bug? [Open the issue](https://github.com/solid-software/flutter_vlc_player/issues/new).

0 commit comments

Comments
 (0)