Media browsing and searching

[zehnm]

Enhance the media-player entity documentation and the Core-APIs, Integration-API with
media browsing and searching.

New media-player entity features:

Name	Description
play_media	The player supports playing a specific media item.
play_media_action	The player supports the play_media action parameter to either play or enqueue.
clear_playlist	The player allows clearing the active playlist.
browse_media	The player supports browsing media containers.
search_media	The player supports searching for media items.
search_media_classes	The player provides a list of media classes as filter for searches.

New media-player entity attributes:

Attribute	Features	Type	Values	Description
media_id	media_type	string		The content ID of media being played.
media_playlist	play_pause	string		Title of Playlist currently playing.
	next, previous
play_media_action	play_media_action	list	Media Play Action	Supported media play actions.
search_media_classes	search_media_classes	list	Media Classes	List of media classes to use as a filter for search_media. Custom classes should be avoided.

New media-player entity commands

cmd_id	Parameters	Description
play_media	media_id, media_type	Play or enqueue a media item.
	action	Optional MediaPlayAction enum if feature play_media_action is supported. Play now, next or enqueue.
clear_playlist	-	Removes all items from the playback queue. Current playback behaviour is integration-dependent (keep playing the current item or clearing everything).

Media Browsing

Media browsing uses a dedicated WebSocket message and is not part of the standard media-player entity commands.

msg	Parameters	Description
browse_media	entity_id	Browse media from a media-player entity.
	media_id	Optional media content ID to restrict browsing.
	media_type	Optional media content type to restrict browsing.
	stable_ids	Optional hint that the client requires stable media identifiers.
	paging	Optional paging object to limit returned items.

Media Searching

🚧 This is a development feature and subject to change. There is no UI support yet.

Media searching uses a dedicated WebSocket message and is not part of the standard media-player entity commands.

msg	Parameters	Description
search_media	entity_id	Search for media items in a media-player entity.
	query	Free-text search query.
	media_id	Optional media content ID to limit the search scope.
	media_type	Optional media content type to limit the search scope.
	stable_ids	Optional hint that the client requires stable media identifiers.
	filter.media_classes	Optional list of media classes to filter the results.
	paging	Optional paging object to limit returned items.

See "Media Player Entity" documentation for a full description of the new features.

Relates to unfoldedcircle/feature-and-bug-tracker#70