paracusia v0.2.8 Paracusia.PlayerState
Provides access to the current state of MPD, without having to send messages over the socket.
All functions in this module have a counterpart in a submodule of Paracusia.MpdClient
(but not vice
versa). The difference is that functions from this module fetch their information from a local cache, while
functions inside Paracusia.MpdClient
communicate with the MPD server to fetch the required
information.
Link to this section Summary
Functions
Similar to Paracusia.MpdClient.AudioOutputs.all/0
, but always returns the outputs (instead of
:error)
Returns a specification to start this module under a supervisor
Similar to Paracusia.MpdClient.Status.current_song/0
, but returns nil
if no song is available
Invoked when the server is started. start_link/3
or start/3
will
block until it returns
Similar to Paracusia.MpdClient.Queue.songs_info/0
, but always returns the queue (instead of
:error)
Similar to Paracusia.MpdClient.Status.status/0
, but always returns the status (instead of
:error)
Link to this section Types
t() :: %Paracusia.PlayerState{ current_song: nil | map(), outputs: list(), queue: list(), status: %Paracusia.PlayerState.Status{ audio: term(), bitrate: term(), consume: term(), elapsed: term(), error: term(), mixrampdb: term(), mixrampdelay: term(), next_song_id: term(), next_song_pos: term(), playlist: term(), playlist_length: term(), random: term(), repeat: term(), single: term(), song_id: term(), song_pos: term(), state: term(), time: term(), timestamp: term(), updating_db: term(), volume: term(), xfade: term() } }
Link to this section Functions
Similar to Paracusia.MpdClient.AudioOutputs.all/0
, but always returns the outputs (instead of
:error).
Returns a specification to start this module under a supervisor.
See Supervisor
.
Similar to Paracusia.MpdClient.Status.current_song/0
, but returns nil
if no song is available.
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
args
is the argument term (second argument) passed to start_link/3
.
Returning {:ok, state}
will cause start_link/3
to return
{:ok, pid}
and the process to enter its loop.
Returning {:ok, state, timeout}
is similar to {:ok, state}
except handle_info(:timeout, state)
will be called after timeout
milliseconds if no messages are received within the timeout.
Returning {:ok, state, :hibernate}
is similar to {:ok, state}
except the process is hibernated before entering the loop. See
c:handle_call/3
for more information on hibernation.
Returning {:ok, state, {:continue, continue}}
is similar to
{:ok, state}
except that immediately after entering the loop
the c:handle_continue/2
callback will be invoked with the value
continue
as first argument.
Returning :ignore
will cause start_link/3
to return :ignore
and
the process will exit normally without entering the loop or calling
c:terminate/2
. If used when part of a supervision tree the parent
supervisor will not fail to start nor immediately try to restart the
GenServer
. The remainder of the supervision tree will be started
and so the GenServer
should not be required by other processes.
It can be started later with Supervisor.restart_child/2
as the child
specification is saved in the parent supervisor. The main use cases for
this are:
- The
GenServer
is disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor
. Likely this approach involves callingSupervisor.restart_child/2
after a delay to attempt a restart.
Returning {:stop, reason}
will cause start_link/3
to return
{:error, reason}
and the process to exit with reason reason
without
entering the loop or calling c:terminate/2
.
Callback implementation for GenServer.init/1
.
Similar to Paracusia.MpdClient.Queue.songs_info/0
, but always returns the queue (instead of
:error).
status() :: %Paracusia.PlayerState.Status{ audio: term(), bitrate: term(), consume: term(), elapsed: term(), error: term(), mixrampdb: term(), mixrampdelay: term(), next_song_id: term(), next_song_pos: term(), playlist: term(), playlist_length: term(), random: term(), repeat: term(), single: term(), song_id: term(), song_pos: term(), state: term(), time: term(), timestamp: term(), updating_db: term(), volume: term(), xfade: term() }
Similar to Paracusia.MpdClient.Status.status/0
, but always returns the status (instead of
:error).