Example Project - Docs, HLS, & Livestream (#1536)

* docs(example): add documentation to the example project on debugging native iOS code * chore(example): add a HLS and live stream to the example project
doublesymmetry · May 17, 2022 · c25eedf · c25eedf
1 parent 8d159e1
commit c25eedf
Show file tree

Hide file tree

Showing 32 changed files with 84 additions and 0 deletions.
diff --git a/docs/static/example/hls/whip/file0.m4a b/docs/static/example/hls/whip/file0.m4a
diff --git a/docs/static/example/hls/whip/file1.m4a b/docs/static/example/hls/whip/file1.m4a
diff --git a/docs/static/example/hls/whip/file10.m4a b/docs/static/example/hls/whip/file10.m4a
diff --git a/docs/static/example/hls/whip/file11.m4a b/docs/static/example/hls/whip/file11.m4a
diff --git a/docs/static/example/hls/whip/file12.m4a b/docs/static/example/hls/whip/file12.m4a
diff --git a/docs/static/example/hls/whip/file13.m4a b/docs/static/example/hls/whip/file13.m4a
diff --git a/docs/static/example/hls/whip/file14.m4a b/docs/static/example/hls/whip/file14.m4a
diff --git a/docs/static/example/hls/whip/file15.m4a b/docs/static/example/hls/whip/file15.m4a
diff --git a/docs/static/example/hls/whip/file16.m4a b/docs/static/example/hls/whip/file16.m4a
diff --git a/docs/static/example/hls/whip/file17.m4a b/docs/static/example/hls/whip/file17.m4a
diff --git a/docs/static/example/hls/whip/file18.m4a b/docs/static/example/hls/whip/file18.m4a
diff --git a/docs/static/example/hls/whip/file19.m4a b/docs/static/example/hls/whip/file19.m4a
diff --git a/docs/static/example/hls/whip/file2.m4a b/docs/static/example/hls/whip/file2.m4a
diff --git a/docs/static/example/hls/whip/file20.m4a b/docs/static/example/hls/whip/file20.m4a
diff --git a/docs/static/example/hls/whip/file21.m4a b/docs/static/example/hls/whip/file21.m4a
diff --git a/docs/static/example/hls/whip/file22.m4a b/docs/static/example/hls/whip/file22.m4a
diff --git a/docs/static/example/hls/whip/file23.m4a b/docs/static/example/hls/whip/file23.m4a
diff --git a/docs/static/example/hls/whip/file3.m4a b/docs/static/example/hls/whip/file3.m4a
diff --git a/docs/static/example/hls/whip/file4.m4a b/docs/static/example/hls/whip/file4.m4a
diff --git a/docs/static/example/hls/whip/file5.m4a b/docs/static/example/hls/whip/file5.m4a
diff --git a/docs/static/example/hls/whip/file6.m4a b/docs/static/example/hls/whip/file6.m4a
diff --git a/docs/static/example/hls/whip/file7.m4a b/docs/static/example/hls/whip/file7.m4a
diff --git a/docs/static/example/hls/whip/file8.m4a b/docs/static/example/hls/whip/file8.m4a
diff --git a/docs/static/example/hls/whip/file9.m4a b/docs/static/example/hls/whip/file9.m4a
diff --git a/docs/static/example/hls/whip/playlist.m3u8 b/docs/static/example/hls/whip/playlist.m3u8
@@ -0,0 +1,54 @@
+#EXTM3U
+#EXT-X-VERSION:3
+#EXT-X-MEDIA-SEQUENCE:0
+#EXT-X-ALLOW-CACHE:YES
+#EXT-X-TARGETDURATION:8
+#EXTINF:7.012433,
+file0.m4a
+#EXTINF:6.989200,
+file1.m4a
+#EXTINF:7.012433,
+file2.m4a
+#EXTINF:6.989200,
+file3.m4a
+#EXTINF:7.012433,
+file4.m4a
+#EXTINF:6.989211,
+file5.m4a
+#EXTINF:7.012433,
+file6.m4a
+#EXTINF:6.989211,
+file7.m4a
+#EXTINF:7.012433,
+file8.m4a
+#EXTINF:6.989211,
+file9.m4a
+#EXTINF:7.012422,
+file10.m4a
+#EXTINF:6.989211,
+file11.m4a
+#EXTINF:7.012422,
+file12.m4a
+#EXTINF:6.989211,
+file13.m4a
+#EXTINF:6.989211,
+file14.m4a
+#EXTINF:7.012433,
+file15.m4a
+#EXTINF:6.989200,
+file16.m4a
+#EXTINF:7.012433,
+file17.m4a
+#EXTINF:6.989200,
+file18.m4a
+#EXTINF:7.012433,
+file19.m4a
+#EXTINF:6.989200,
+file20.m4a
+#EXTINF:7.012433,
+file21.m4a
+#EXTINF:6.989200,
+file22.m4a
+#EXTINF:3.300133,
+file23.m4a
+#EXT-X-ENDLIST
diff --git a/docs/static/example/hls/whip/whip.jpeg b/docs/static/example/hls/whip/whip.jpeg
diff --git a/docs/static/example/hls/whip/whip.mp3 b/docs/static/example/hls/whip/whip.mp3
diff --git a/docs/static/example/smooth-jazz-24-7.jpeg b/docs/static/example/smooth-jazz-24-7.jpeg
diff --git a/docs/static/img/debugging/debug-ios-rntp.png b/docs/static/img/debugging/debug-ios-rntp.png
diff --git a/docs/static/img/debugging/debug-ios-swift-audio-ex.png b/docs/static/img/debugging/debug-ios-swift-audio-ex.png
diff --git a/example/README.md b/example/README.md
@@ -46,3 +46,21 @@ the files from the `example/node_modules/react-native-track-player` directory
 up to the top level project. You would want to use this approach if you're
 making your changes directly to the code in the `example/node_modules/react-native-track-player`
 folder.
+
+## Debugging/Updating Native Code
+
+
+#### iOS
+
+First opening the Xcode Project (`open ios/example.xcworkspace`). Then you can
+simply navigate to the native dependencies, open their source files, modify
+them, or add breakpoints. See the screenshots below for specifically how to
+navigate to react-native-track-player and SwiftAudioEx dependencies (see
+screenshots below).
+
+![Xcode RNTP](https://react-native-track-player.js.org/img/debugging/debug-ios-rntp.png)
+![Xcode SwiftAudioEx](https://react-native-track-player.js.org/img/debugging/debug-ios-swift-audio-ex.png)
+
+#### Android
+
+TODO
diff --git a/example/src/assets/data/playlist.json b/example/src/assets/data/playlist.json
@@ -26,5 +26,17 @@
     "artist": "David Chavez",
     "artwork": "https://react-native-track-player.js.org/example/Rhythm%20City%20(Demo).jpeg",
     "duration": 106
+  },
+  {
+    "url": "https://react-native-track-player.js.org/example/hls/whip/playlist.m3u8",
+    "title": "Whip",
+    "artist": "prazkhanal",
+    "artwork": "https://react-native-track-player.js.org/example/hls/whip/whip.jpeg"
+  },
+  {
+    "url": "https://ais-sa5.cdnstream1.com/b75154_128mp3",
+    "title": "Smooth Jazz 24/7 (Live Radio)",
+    "artist": "New York, NY",
+    "artwork": "https://react-native-track-player.js.org/example/smooth-jazz-24-7.jpeg"
   }
 ]