Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
mdhelp: add another appendix with export URLs description
  • Loading branch information
perexg committed May 6, 2016
1 parent 496bc26 commit fca7bed
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/markdown/toc.md
Expand Up @@ -105,10 +105,11 @@ Web Status Tab

Appendices

- [Appendix 1 - FAQ](faqs)
- [Appendix 2 - Command-line Options](cmdline_options)
- [Appendix 3 - Debugging Options](debugging)
- [Appendix 4 - Updating this documentation](doc_update)
- [Appendix 5 - Markdown Cribsheet](markdown_cribsheet)
- [Appendix 1 - URL syntax (Exports)](url)
- [Appendix 2 - FAQ](faqs)
- [Appendix 3 - Command-line Options](cmdline_options)
- [Appendix 4 - Debugging Options](debugging)
- [Appendix 5 - Updating this documentation](doc_update)
- [Appendix 6 - Markdown Cribsheet](markdown_cribsheet)

[About](about)
84 changes: 84 additions & 0 deletions docs/markdown/url.md
@@ -0,0 +1,84 @@
## URL syntax

Please, add `http://IP:Port` to complete the URL.

### /play/REMAIN

Return the playlist in *xspf* or *m3u* format. If the agent is in the list
of direct agents (like wget/curl/vlc), the stream is returned instead.

The remain part can be any URL starting with /stream .

Option | Explanation
---------|------------------------------------------
playlist | Playlist type, can be *xspf* or *m3u*

**Example:** `http://127.0.0.1:9981/play/stream/channelname/Life?playlist=xspf`

### /playlist[/TYPE][/WHAT][/IDENTIFIER]

Return the m3u playlist in Enigma2 format. By default (if the rest of path
is ommitted), an redirection answer will be sent where /channels remainder
is used.

TYPE | Playlist type
--------------|----------------------------------------
*empty* | M3U
e2 | Enigma2
satip | M3U using SAT>IP extensions

WHAT | Playlist contents
--------------|------------------------------------------------------------
channels | All channels
tags | All tags, for Enigma2 - tags are converted to labels
recordings | All recordings
channelnumber | One channel specified by channel number
channelname | One channel specified by channel name
channelid | One channel specified by short channel ID
tag | Tagged channels specified by UUID or tag name
tagname | Tagged channels specified by tag name
tagid | Tagged channels specified by short tag ID
dvrid | One DVR record specified by short DVR ID

Option | Explanation
---------|------------------------------------------------------------------------------
profile | Override streaming profile, otherwise the default profile for the user is used.

### /stream/WHAT/IDENTIFIER

This URL scheme is used for streaming. The stream contents depends on the
streaming profile. It might be MPEG-TS, Matroska or MP4.

WHAT | Stream for
--------------|------------------------------------------------------------
channelnumber | Channel specified by channel number
channelname | Channel specified by channel name
channel | Channel specified by channel UUID
channelid | Channel specified by short channel ID
service | Service specified by service UUID
mux | Mux specified by mux UUID

Option | Explanation
-----------|------------------------------------------------------------------------------
profile | (except /mux) Override streaming profile
weight | Override subscription weight
qsize | Override queue size in bytes (default value is 1500000 for channel/service, 10000000 for mux)
descramble | (/service only) do not descramble (if set to 0)
emm | (/service only) pass EMM to the stream (if set to 1)
pids | (/mux only) list of subscribed PIDs (comma separated)

### /xmltv[/WHAT][/IDENTIFIER]

Return the XMLTV EPG export. By default (if the rest of path
is ommitted), an redirection answer will be sent where /channels remainder
is used.

WHAT | Playlist contents
--------------|------------------------------------------------------------
channels | All channels
channelnumber | One channel specified by channel number
channelname | One channel specified by channel name
channelid | One channel specified by short channel ID
tag | Tagged channels specified by UUID or tag name
tagname | Tagged channels specified by tag name
tagid | Tagged channels specified by short tag ID

0 comments on commit fca7bed

Please sign in to comment.