Skip to content

tool options

Werner Robitza edited this page Sep 15, 2020 · 1 revision

Tool Options

The processing chain offers possibilites to set several options only for several tools. In the following it will be presented how this can be done and which tool options exist at the current implementation state:

Tool Option Notation Rules

In general tool options can be set with a @to@-flag or @tool_options@-option. After these key words a double-point (:) follows with a code identifying the tool of the chain which should receive the options. The next code snippet shows which codes can be used here:

  • encode_videos:

-to:enc


> or

> ``` bash
--tool_options:encode_videos
  • stream_videos:

-to:stm


> or

> ``` bash
--tool_options:stream_videos
  • insert_loss:

-to:los


> or 

> ``` bash
--tool_options:insert_loss
  • extract_payload:

-to:xtc


> or

> ``` bash
--tool_options:extract_payload
  • decode_loss:

-to:dec

> or

> ``` bash
--tool_options:decode_loss

After this flag/option is set all options can be set, without leading dashes (- resp. --). If a tool options needs to be configured with some parameters, the following input scheme applies:

key=value1,value2,value3,...

If no value has to be set in the option definition (mostly for binary options), than it is sufficient to write only the option key.

Options for encode_videos

At the current state of the implementation, no further tool options are available in this step.

Options for stream_videos

At the current state of the implementation, no further tool options are available in this step.

Options for insert_loss

Store loss traces

The tc traffic manipulation tool is not able to generate loss traces. If you want nevertheless get a loss trace, use the following option:

-to:los store_loss_traces

Options for extract_payload

At the current state of the implementation, no further tool options are available in this step.

Options for ````decode_loss```

At the current state of the implementation, no further tool options are available in this step.