diff --git a/docs/ext/stream.rst b/docs/ext/stream.rst index 5669640c..bb30e924 100644 --- a/docs/ext/stream.rst +++ b/docs/ext/stream.rst @@ -40,3 +40,17 @@ Configuration values .. confval:: stream/protocols Whitelist of URI schemas to allow streaming from. + + +Usage +===== + +This backend does not provide a library or similar. It simply takes any URI +added to Mopidy's tracklist that matches any of the protocols in the +:confval:`stream/protocols` setting and tries to play back the URI using +GStreamer. E.g. if you're using an MPD client, you'll just have to find your +clients "add URI" interface, and provide it with the direct URI of the stream. + +Currently the stream backend can only work with URIs pointing direcly at +streams, and not intermediate playlists which is often used. See :issue:`303` +to track the development of playlist expansion support.