Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
mdhelp: update stream profiles + screenies
  • Loading branch information
Mark Clarkstone authored and perexg committed May 11, 2016
1 parent 6867738 commit 731ad0b
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 27 deletions.
78 changes: 53 additions & 25 deletions docs/class/profile.md
@@ -1,46 +1,74 @@
##Configuration - Stream - Stream Profiles

Stream Profiles are the settings for output formats. These are used for Live TV
streaming and recordings. The profiles are assigned through the Access Entries,
streaming and recordings. The profiles are assigned through
the [Access Entries](class/access_entry),
DVR Profiles or as parameter for HTTP Streaming.

!['Stream Profiles'](static/img/doc/configstreamprofiles.png)

* Types
- [HTSP Profile](class/profile-htsp)
- [MPEG-TS Pass-thru Profile](class/profile-mpegts)
- [Matroska Profile](class/profile-matroska)
- [MPEG-TS/libav Profile](class/profile-libav-mpegts)
- [Matroska/libav Profile](class/profile-libav-matroska)
- [MP4/libav Profile](class/profile-libav-mp4)
- [Transcode Profile](class/profile-transcode)
* Built-in
- [HTSP Profile](class/profile-htsp)
- [MPEG-TS Pass-thru Profile](class/profile-mpegts)
- [Matroska Profile](class/profile-matroska)

!['Stream Profiles'](static/img/doc/configstreamprofiles.png)
* Requires Tvheadend to be built with transcoding/ffmpeg enabled.
- [MPEG-TS/libav Profile](class/profile-libav-mpegts)
- [Matroska/libav Profile](class/profile-libav-matroska)
- [MP4/libav Profile](class/profile-libav-mp4)
- [Transcode Profile](class/profile-transcode)

If you do not have a build of Tvheadend with transcoding enabled
some of the above profiles (and their associated Help pages) will not
be available.

---

###Menu Bar/Buttons

The following functions are available:

Button | Function
-----------|---------
**Save** | Save any changes made to the stream profile configuration.
**Undo** | Undo any changes made to the stream profile configuration since the last save.
**Add** | Add a new stream profile.
**Delete** | Delete an existing stream profile.
**View Level**| Change the interface view level to show/hide more advanced options.
**Help** | Display this help page.
Button | Function
--------------------|---------
**Save** | Save any changes made to the selected configuration
**Undo** | Undo any changes made to the selected configuration since the last save.
**Add** | Add a new profile.
**Delete** | Delete the selected entry
**Clone** | Clone the currently selected profile.

<tvh_include>inc/common_button_table_end</tvh_include>

---

###Add a Profile

To create a new profile press the *[Add]* button from the
menu bar, you will then be asked to select a profile type.

!['Type select'](static/img/doc/streamprofiletypeselect.png)

Once you've selected a type you can then enter/select the desired options from the
resultant *Add* dialog.

!['Add Profile Dialog'](static/img/doc/addprofiledialog.png)

---

####Add/Edit Dialog Example
###Edit a Profile

To edit an existing profile, click on it from within the grid, the
*Parameters* panel should then appear on the right hand side.

A common set of fields is used for the _Add_ or _Edit_ functions, most
of which can be seen in the grid view:
**Tips**:
* Remember to *[Save]* your changes before selecting another config
from within the grid.
* You can clone an existing config by clicking the *[Clone]*
button.

!['Add/Edit Stream Profiles' Dialog - mkv](static/img/doc/configstreamprofiles1.png)
---

!['Add/Edit Stream Profiles' Dialog - ts](static/img/doc/configstreamprofiles2.png)
###Deleting a Profile

!['Add/Edit Stream Profiles' Dialog - transcode](static/img/doc/configstreamprofiles3.png)
Highlight (select) the desired entry from the grid, then press the
*[Delete]* button from the menu bar.

---
4 changes: 2 additions & 2 deletions src/profile.c
Expand Up @@ -275,7 +275,7 @@ CLASS_DOC(profile)
const idclass_t profile_class =
{
.ic_class = "profile",
.ic_caption = N_("Stream profile"),
.ic_caption = N_("Stream Profile"),
.ic_event = "profile",
.ic_doc = tvh_doc_profile_class,
.ic_perm_def = ACCESS_ADMIN,
Expand Down Expand Up @@ -975,7 +975,7 @@ const idclass_t profile_htsp_class =
{
.ic_super = &profile_class,
.ic_class = "profile-htsp",
.ic_caption = N_("HTSP stream profile"),
.ic_caption = N_("HTSP Stream Profile"),
.ic_properties = (const property_t[]){
/* Ready for future extensions */
{ }
Expand Down
Binary file added src/webui/static/img/doc/addprofiledialog.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 731ad0b

Please sign in to comment.