From 017c9dbb654654dd4958a2ea4370a7285680bd15 Mon Sep 17 00:00:00 2001 From: Thulinma Date: Tue, 13 Feb 2018 12:59:09 +0100 Subject: [PATCH] Improved input descriptions --- src/input/input_av.cpp | 2 +- src/input/input_balancer.cpp | 2 +- src/input/input_buffer.cpp | 4 ++-- src/input/input_dtsc.cpp | 2 +- src/input/input_ebml.cpp | 2 +- src/input/input_flv.cpp | 2 +- src/input/input_folder.cpp | 2 +- src/input/input_h264.cpp | 2 +- src/input/input_hls.cpp | 2 +- src/input/input_ismv.cpp | 2 +- src/input/input_mp3.cpp | 2 +- src/input/input_mp4.cpp | 2 +- src/input/input_ogg.cpp | 2 +- src/input/input_rtsp.cpp | 2 +- src/input/input_srt.cpp | 2 +- src/input/input_ts.cpp | 2 +- 16 files changed, 17 insertions(+), 17 deletions(-) diff --git a/src/input/input_av.cpp b/src/input/input_av.cpp index c4d8337f..72ebb882 100644 --- a/src/input/input_av.cpp +++ b/src/input/input_av.cpp @@ -14,7 +14,7 @@ namespace Mist { inputAV::inputAV(Util::Config * cfg) : Input(cfg) { pFormatCtx = 0; capa["name"] = "AV"; - capa["decs"] = "Enables generic avformat/avcodec based input"; + capa["desc"] = "This input uses libavformat to read any type of file. Unfortunately this input cannot be redistributed, but it is a great tool for testing the other file-based inputs against."; capa["source_match"] = "/*"; capa["priority"] = 1ll; capa["codecs"][0u][0u].null(); diff --git a/src/input/input_balancer.cpp b/src/input/input_balancer.cpp index 710bb477..e2ef81e1 100644 --- a/src/input/input_balancer.cpp +++ b/src/input/input_balancer.cpp @@ -7,7 +7,7 @@ namespace Mist { inputBalancer::inputBalancer(Util::Config * cfg) : Input(cfg) { capa["name"] = "Balancer"; - capa["desc"] = "Load balancer input, re-starts itself as the input a load balancer tells it it should be."; + capa["desc"] = "The load balancer input restarts itself as the input a load balancer tells it it should be. The syntax is in the form 'balance:http://HOST:PORT[?fallback=FALLBACK]', where HOST and PORT are the host and port of the load balancer and the FALLBACK is the full source URL that should be used if the load balancer cannot be reached."; capa["source_match"] = "balance:*"; capa["priority"] = 9ll; capa["morphic"] = 1ll; diff --git a/src/input/input_buffer.cpp b/src/input/input_buffer.cpp index 777b3e22..343d2c9d 100644 --- a/src/input/input_buffer.cpp +++ b/src/input/input_buffer.cpp @@ -73,7 +73,7 @@ namespace Mist { option["arg"] = "integer"; option["long"] = "segment-size"; - option["short"] = "S"; + option["short"] = "S" option["help"] = "Target time duration in milliseconds for segments"; option["value"].append(5000LL); config->addOption("segmentsize", option); @@ -88,7 +88,7 @@ namespace Mist { capa["source_match"] = "push://*"; capa["non-provider"] = true;//Indicates we don't provide data, only collect it capa["priority"] = 9ll; - capa["desc"] = "Provides buffered live input"; + capa["desc"] = "This input type is both used for push- and pull-based streams. It provides a buffer for live media data. The push://[host][@password] style source allows all enabled protocols that support push input to accept a push into MistServer, where you can accept incoming streams from everyone, based on a set password, and/or use hostname/IP whitelisting."; capa["codecs"][0u][0u].append("*"); capa["codecs"][0u][1u].append("*"); capa["codecs"][0u][2u].append("*"); diff --git a/src/input/input_dtsc.cpp b/src/input/input_dtsc.cpp index 12cb9185..2d008435 100644 --- a/src/input/input_dtsc.cpp +++ b/src/input/input_dtsc.cpp @@ -15,7 +15,7 @@ namespace Mist { inputDTSC::inputDTSC(Util::Config * cfg) : Input(cfg) { capa["name"] = "DTSC"; - capa["desc"] = "Enables DTSC Input"; + capa["desc"] = "Load DTSC files as Video on Demand sources, or dtsc:// URLs from other MistServer instances for live sources. This is the optimal method to pull live sources from other MistServer (or compatible) instances."; capa["priority"] = 9ll; capa["source_match"].append("/*.dtsc"); capa["source_match"].append("dtsc://*"); diff --git a/src/input/input_ebml.cpp b/src/input/input_ebml.cpp index 5b54a226..85c3ba2e 100644 --- a/src/input/input_ebml.cpp +++ b/src/input/input_ebml.cpp @@ -6,7 +6,7 @@ namespace Mist{ InputEBML::InputEBML(Util::Config *cfg) : Input(cfg){ capa["name"] = "EBML"; - capa["desc"] = "Enables MKV and WebM input"; + capa["desc"] = "Allows loading MKV, MKA, MK3D, MKS and WebM files for Video on Demand."; capa["source_match"].append("/*.mkv"); capa["source_match"].append("/*.mka"); capa["source_match"].append("/*.mk3d"); diff --git a/src/input/input_flv.cpp b/src/input/input_flv.cpp index bebb880f..d9a2264f 100644 --- a/src/input/input_flv.cpp +++ b/src/input/input_flv.cpp @@ -17,7 +17,7 @@ namespace Mist { inputFLV::inputFLV(Util::Config * cfg) : Input(cfg) { capa["name"] = "FLV"; - capa["desc"] = "Enables FLV Input"; + capa["desc"] = "Allows loading FLV files for Video on Demand."; capa["source_match"] = "/*.flv"; capa["priority"] = 9ll; capa["codecs"][0u][0u].append("H264"); diff --git a/src/input/input_folder.cpp b/src/input/input_folder.cpp index 0a9cce10..1cff0fb9 100644 --- a/src/input/input_folder.cpp +++ b/src/input/input_folder.cpp @@ -9,7 +9,7 @@ namespace Mist { inputFolder::inputFolder(Util::Config * cfg) : Input(cfg) { capa["name"] = "Folder"; - capa["desc"] = "Folder input, re-starts itself as the appropriate input."; + capa["desc"] = "The folder input will make available all supported files in the given folder as streams under this stream name, in the format STREAMNAME+FILENAME. For example, if your stream is called 'files' and you have a file called 'movie.flv', you could access this file streamed as 'files+movie.flv'. This input does not support subdirectories. To support more complex libraries, look into the documentation for the STREAM_SOURCE trigger."; capa["source_match"] = "/*/"; capa["priority"] = 9ll; capa["morphic"] = 1ll; diff --git a/src/input/input_h264.cpp b/src/input/input_h264.cpp index 6e2486b0..87f149be 100644 --- a/src/input/input_h264.cpp +++ b/src/input/input_h264.cpp @@ -5,7 +5,7 @@ namespace Mist{ InputH264::InputH264(Util::Config *cfg) : Input(cfg){ capa["name"] = "H264"; - capa["desc"] = "H264 Annex B input"; + capa["desc"] = "This input allows you to take raw H264 Annex B data over a standard input pipe, and turn it into a live stream."; capa["source_match"] = "h264-exec:*"; //May be set to always-on mode capa["always_match"].append("h264-exec:*"); diff --git a/src/input/input_hls.cpp b/src/input/input_hls.cpp index 438a1908..7cfd17ae 100644 --- a/src/input/input_hls.cpp +++ b/src/input/input_hls.cpp @@ -333,7 +333,7 @@ namespace Mist{ currentPlaylist = 0; capa["name"] = "HLS"; - capa["decs"] = "Enables HLS Input"; + capa["desc"] = "This input allows you to both play Video on Demand and live HLS streams stored on the filesystem, as well as pull live HLS streams over HTTP and HTTPS."; capa["source_match"].append("/*.m3u8"); capa["source_match"].append("/*.m3u"); capa["source_match"].append("http://*.m3u8"); diff --git a/src/input/input_ismv.cpp b/src/input/input_ismv.cpp index e85f5111..8cf6636d 100644 --- a/src/input/input_ismv.cpp +++ b/src/input/input_ismv.cpp @@ -13,7 +13,7 @@ namespace Mist { inputISMV::inputISMV(Util::Config * cfg) : Input(cfg) { capa["name"] = "ISMV"; - capa["decs"] = "Enables ISMV Input"; + capa["desc"] = "This input allows you to stream ISMV Video on Demand files."; capa["source_match"] = "/*.ismv"; capa["priority"] = 9ll; capa["codecs"][0u][0u].append("H264"); diff --git a/src/input/input_mp3.cpp b/src/input/input_mp3.cpp index e128f8f0..43fc4f21 100644 --- a/src/input/input_mp3.cpp +++ b/src/input/input_mp3.cpp @@ -15,7 +15,7 @@ namespace Mist { inputMP3::inputMP3(Util::Config * cfg) : Input(cfg) { capa["name"] = "MP3"; - capa["desc"] = "Enables MP3 Input"; + capa["desc"] = "This input allows you to stream MP3 Video on Demand files."; capa["source_match"] = "/*.mp3"; capa["priority"] = 9ll; capa["codecs"][0u][0u].append("MP3"); diff --git a/src/input/input_mp4.cpp b/src/input/input_mp4.cpp index 69a49706..2fe7d846 100644 --- a/src/input/input_mp4.cpp +++ b/src/input/input_mp4.cpp @@ -158,7 +158,7 @@ namespace Mist{ malSize = 4;//initialise data read buffer to 0; data = (char*)malloc(malSize); capa["name"] = "MP4"; - capa["decs"] = "Enables MP4 Input"; + capa["desc"] = "This input allows streaming of MP4 files as Video on Demand."; capa["source_match"] = "/*.mp4"; capa["priority"] = 9ll; capa["codecs"][0u][0u].append("HEVC"); diff --git a/src/input/input_ogg.cpp b/src/input/input_ogg.cpp index 9725cccf..27158c25 100644 --- a/src/input/input_ogg.cpp +++ b/src/input/input_ogg.cpp @@ -46,7 +46,7 @@ namespace Mist { */ inputOGG::inputOGG(Util::Config * cfg) : Input(cfg){ capa["name"] = "OGG"; - capa["desc"] = "Enables OGG input"; + capa["desc"] = "This input allows streaming of OGG files as Video on Demand."; capa["source_match"] = "/*.ogg"; capa["codecs"][0u][0u].append("theora"); capa["codecs"][0u][1u].append("vorbis"); diff --git a/src/input/input_rtsp.cpp b/src/input/input_rtsp.cpp index 1a1396b5..daab2eb5 100755 --- a/src/input/input_rtsp.cpp +++ b/src/input/input_rtsp.cpp @@ -27,7 +27,7 @@ namespace Mist{ seenSDP = false; cSeq = 0; capa["name"] = "RTSP"; - capa["decs"] = "Allows pulling from live RTSP sources"; + capa["desc"] = "This input allows pulling of live RTSP sources over either UDP or TCP."; capa["source_match"].append("rtsp://*"); // These can/may be set to always-on mode capa["always_match"].append("rtsp://*"); diff --git a/src/input/input_srt.cpp b/src/input/input_srt.cpp index e9176dbb..bfefbef0 100644 --- a/src/input/input_srt.cpp +++ b/src/input/input_srt.cpp @@ -5,7 +5,7 @@ namespace Mist{ InputSrt::InputSrt(Util::Config *cfg) : Input(cfg){ vtt = false; capa["name"] = "SRT"; - capa["decs"] = "Enables SRT Input"; + capa["decs"] = "This input allows streaming of SRT and WebVTT subtitle files as Video on Demand."; capa["source_match"].append("/*.srt"); capa["source_match"].append("/*.vtt"); capa["priority"] = 9ll; diff --git a/src/input/input_ts.cpp b/src/input/input_ts.cpp index 4d854f10..d74f0f3c 100755 --- a/src/input/input_ts.cpp +++ b/src/input/input_ts.cpp @@ -110,7 +110,7 @@ namespace Mist { /// \arg cfg Util::Config that contains all current configurations. inputTS::inputTS(Util::Config * cfg) : Input(cfg) { capa["name"] = "TS"; - capa["decs"] = "MPEG2-TS input from static files, streamed files, or multicast/unicast UDP socket"; + capa["desc"] = "This input allows you to stream MPEG2-TS data from static files (/*.ts), streamed files or named pipes (stream://*.ts), streamed over HTTP (http://*.ts, http-ts://*), standard input (ts-exec:*), or multicast/unicast UDP sockets (tsudp://*)."; capa["source_match"].append("/*.ts"); capa["source_match"].append("stream://*.ts"); capa["source_match"].append("tsudp://*");