From 1a8ecbbbec3a99dc3495b5eaf0ef029a3ef1bea2 Mon Sep 17 00:00:00 2001 From: Helge Norberg Date: Tue, 1 Mar 2016 16:28:03 +0100 Subject: [PATCH] Improved help for ADD command, mentioning the possibility of specifying a custom consumer index. --- protocol/amcp/AMCPCommandsImpl.cpp | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/protocol/amcp/AMCPCommandsImpl.cpp b/protocol/amcp/AMCPCommandsImpl.cpp index 0512c563b..7022a7bf9 100644 --- a/protocol/amcp/AMCPCommandsImpl.cpp +++ b/protocol/amcp/AMCPCommandsImpl.cpp @@ -598,7 +598,7 @@ std::wstring swap_command(command_context& ctx) void add_describer(core::help_sink& sink, const core::help_repository& repo) { sink.short_description(L"Add a consumer to a video channel."); - sink.syntax(L"ADD [video_channel:int] [consumer:string] [parameters:string]"); + sink.syntax(L"ADD [video_channel:int]{-[consumer_index:int]} [consumer:string] [parameters:string]"); sink.para() ->text(L"Adds a consumer to the specified video channel. The string ") ->code(L"consumer")->text(L" will be parsed by the available consumer factories. ") @@ -606,6 +606,10 @@ void add_describer(core::help_sink& sink, const core::help_repository& repo) ->code(L"video_channel")->text(L". Different consumers require different parameters, ") ->text(L"some examples are below. Consumers can alternatively be specified by adding them to ") ->see(L"the CasparCG config file")->text(L"."); + sink.para() + ->text(L"Specifying ")->code(L"consumer_index") + ->text(L" overrides the index that the consumer itself decides and can later be used with the ") + ->see(L"REMOVE")->text(L" command to remove the consumer."); sink.para()->text(L"Examples:"); sink.example(L">> ADD 1 DECKLINK 1"); sink.example(L">> ADD 1 BLUEFISH 2"); @@ -614,6 +618,9 @@ void add_describer(core::help_sink& sink, const core::help_repository& repo) sink.example(L">> ADD 1 IMAGE filename"); sink.example(L">> ADD 1 FILE filename.mov"); sink.example(L">> ADD 1 FILE filename.mov SEPARATE_KEY"); + sink.example( + L">> ADD 1-700 FILE filename.mov SEPARATE_KEY\n" + L">> REMOVE 1-700", L"overriding the consumer index to easier remove later."); sink.para()->text(L"The streaming consumer is an implementation of the ffmpeg_consumer and supports many of the same arguments:"); sink.example(L">> ADD 1 STREAM udp://localhost:5004 -vcodec libx264 -tune zerolatency -preset ultrafast -crf 25 -format mpegts -vf scale=240:180"); } -- 2.39.2