Apply review suggestions

Author: FelonEkonom

README.md

@@ -15,7 +15,7 @@ The package can be installed by adding `ex_hls` to your list of dependencies in
 ```elixir
 def deps do
   [
-    {:ex_hls, "~> 0.0.1"}
+    {:ex_hls, "~> 0.1.0"}
   ]
 end
 ```
@@ -53,7 +53,7 @@ where `<id>` is the `id` field of the entry returned by `ExHLS.Client.get_varian
 
 Now you can get the Elixir stream containing media chunks:
 ```elixir
-stream = ExHLS.Clinet.generate_stream(client)
+stream = ExHLS.Client.generate_stream(client)
 Enum.take(stream, 5)
 # Returns: 
 # [
@@ -105,7 +105,7 @@ Enum.take(stream, 5)
 # ]
 ```
 
-To pop only single elements from the stream containing ExHLS Chunks, you can use [`StreamSplit.pop/1](https://hexdocs.pm/stream_split/StreamSplit.html#pop/1).
+To pop only single elements from the stream containing ExHLS Chunks, you can use [`StreamSplit.pop/1`](https://hexdocs.pm/stream_split/StreamSplit.html#pop/1).
 
 Note: If the HLS playlist type is Live (not VoD), you can generate stream from single `ExHLS.Client` instance only once and only from the process, that created that `ExHLS.Client`. If you want to genereate more streams with Live HLS, you have to create a new `ExHLS.Client` each time.
 

lib/ex_hls/client.ex

@@ -17,7 +17,7 @@ defmodule ExHLS.Client do
     :media_playlist_url,
     :multivariant_playlist,
     :root_playlist_url,
-    :root_playlist_string,
+    :root_playlist_raw_content,
     :base_url,
     :vod_client,
     :live_reader,
@@ -62,8 +62,10 @@ defmodule ExHLS.Client do
       |> Keyword.validate!(parent_process: self(), how_much_to_skip_ms: 0)
       |> Map.new()
 
-    root_playlist_string = Utils.download_or_read_file!(url)
-    multivariant_playlist = root_playlist_string |> ExM3U8.deserialize_multivariant_playlist!([])
+    root_playlist_raw_content = Utils.download_or_read_file!(url)
+
+    multivariant_playlist =
+      root_playlist_raw_content |> ExM3U8.deserialize_multivariant_playlist!([])
 
     %__MODULE__{
       parent_process: parent_process,
@@ -72,7 +74,7 @@ defmodule ExHLS.Client do
       media_playlist_url: nil,
       multivariant_playlist: multivariant_playlist,
       root_playlist_url: url,
-      root_playlist_string: root_playlist_string,
+      root_playlist_raw_content: root_playlist_raw_content,
       base_url: Path.dirname(url),
       vod_client: nil,
       live_reader: nil,
@@ -147,7 +149,7 @@ defmodule ExHLS.Client do
 
   defp treat_root_playlist_as_media_playlist(%__MODULE__{media_playlist: nil} = client) do
     media_playlist =
-      client.root_playlist_string
+      client.root_playlist_raw_content
       |> ExM3U8.deserialize_media_playlist!([])
 
     %{

lib/ex_hls/client/live/reader.ex

@@ -190,6 +190,10 @@ defmodule ExHLS.Client.Live.Reader do
   end
 
   defp schedule_next_playlist_check(%{playlist_check_scheduled?: false} = state) do
+    # Playlist check interval is 1/4 of target duration, while the RFC says to set it
+    # to 1/2 of target duration. We do it this way to reduce the chance of race condition
+    # occuring when we check the playlist just before the server updates it.
+
     playlist_check_timeout_ms =
       (state.media_playlist.info.target_duration * 250) |> round()
 

lib/ex_hls/client/vod.ex

@@ -3,6 +3,8 @@ defmodule ExHLS.Client.VOD do
   # Module providing functionality to read and demux HLS VOD streams.
   # It allows reading chunks from the stream, choosing variants, and managing media playlists.
 
+  # TODO: It would be nice to refactor this module a little, maybe to make it similar to Reader
+
   use Bunch.Access
 
   require Logger

mix.exs

@@ -1,7 +1,7 @@
 defmodule ExHLS.Mixfile do
   use Mix.Project
 
-  @version "0.0.1"
+  @version "0.1.0"
   @github_url "https://github.com/membraneframework/ex_hls"
 
   def project do