Skip to content

Commit

Permalink
chore:update documentaation
Browse files Browse the repository at this point in the history
  • Loading branch information
bushvin committed Oct 17, 2023
1 parent 1e62239 commit 52dd4a8
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Search media based on keywords and add them to the queue. This service does not

|Service data attribute|Optional|Description|Example|
|-|-|-|-|
|`entity_id`|no|String or list of `entity_id`s ito take a snapshot of.| |
|`entity_id`|no|String or list of `entity_id`s to take a snapshot of.| |
|`exact`|yes|String. Should the search be an exact match|false|
|`keyword`|yes|String. The keywords to search for. Will search all track fields.|Everlong|
|`keyword_album`|yes|String. The keywords to search for in album titles.|From Mars to Sirius|
Expand All @@ -88,19 +88,27 @@ Search media based on keywords and add them to the queue. This service does not
|`keyword_track_name`|yes|String. The keywords to search for in track names.|Lazarus|
|`source`|yes|String. URI sources to search. `local`, `spotify` and `tunein` are the only supported options. Make sure to have these extensions enabled on your Mopidy Server! Separate multiple sources with a comma (,).|local,spotify|

#### Service mopidy.set_consume_mode
Set or unset the mopidy player in consume mode. When in consume mode, played tracks will be removed from the queue ([TracklistController.set_consume](https://docs.mopidy.com/en/latest/api/core/#mopidy.core.TracklistController.set_consume))

|Service data attribute|Optional|Description|Example|
|-|-|-|-|
|`entity_id`|no|String or list of `entity_id`s to take a snapshot of.||
|`consume_mode`|no|Boolean to control consume mode|`true`|

#### Service mopidy.snapshot
Take a snapshot of what is currently playing on one or more Mopidy Servers. This service, and the following one, are useful if you want to play a doorbell or notification sound and resume playback afterwards.

**Warning:** *This service is controlled by the platform, this is not a built-in function of Mopidy Server! Restarting Home Assistant will cause the snapshot to be lost.*

|Service data attribute|Optional|Description|
|-|-|-|
|`entity_id`|no|String or list of `entity_id`s ito take a snapshot of.|
|`entity_id`|no|String or list of `entity_id`s to take a snapshot of.|


### Notes
Due to the nature of the way Mopidy provides thumbnails of the media,
proxying them through Home Assistant is very resource intensive,
proxying them through Home Assistant is very resource intensive,
causing delays. Therefore, I have decided to not proxy the art when
using the Media Library for the time being.

Expand Down
12 changes: 12 additions & 0 deletions mopidy-CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.5.0] - 2023-08-04

### Added

- Support for Consume mode

### Fixed:

- varname typo
- stacktrace logging of connection failure to debug instead of error
- snapshot restore issue

## [1.4.8] - 2023-05-31

### Changed
Expand Down

0 comments on commit 52dd4a8

Please sign in to comment.