VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and...

46
CHAPTER 3-1 Cisco CDA Visual Quality Experience Client System Configuration Guide 3 VQE-C Configuration File Syntax and Parameters This chapter provides information on VQE-C system configuration file syntax and parameters. It also provides guidance on parameter usage and examples of VQE-C system configuration files. This chapter contains the following sections: VQE-C System Configuration File Syntax, page 3-1 VQE-C Configuration Parameters: Usage Guidance, page 3-3 VQE-C Configuration Parameters: Reference Information, page 3-6 VQE-C System Configuration File Examples, page 3-43 VQE-C System Configuration File Syntax In the VQE-C system configuration file, configuration parameters are assigned values using the following syntax: parameter_name = value; The value can be one of the basic types, a group, or a list. In the preceding syntax, the semicolon is required. An example of assigning a value to a parameter is as follows: max_tuners = 10; Throughout the system configuration file, whitespace is not significant, and C-style comments are supported. Basic Types Three basic types of values are used to define most parameter settings: String—Consists of arbitrary text delimited by double quotes. String value sizes are limited to 255 characters by VQE-C software. Integer—Can be represented as a sequence of the characters 0 to 9, or in hexadecimal form by prepending 0x to a sequence of hexadecimal characters. Boolean—May have one of the following values: TRUE, true, FALSE, or false.

Transcript of VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and...

Page 1: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Cisco CDA Visual Qu

C H A P T E R 3

VQE-C Configuration File Syntax and Parameters

This chapter provides information on VQE-C system configuration file syntax and parameters. It also provides guidance on parameter usage and examples of VQE-C system configuration files. This chapter contains the following sections:

• VQE-C System Configuration File Syntax, page 3-1

• VQE-C Configuration Parameters: Usage Guidance, page 3-3

• VQE-C Configuration Parameters: Reference Information, page 3-6

• VQE-C System Configuration File Examples, page 3-43

VQE-C System Configuration File Syntax In the VQE-C system configuration file, configuration parameters are assigned values using the following syntax:

parameter_name = value;

The value can be one of the basic types, a group, or a list. In the preceding syntax, the semicolon is required. An example of assigning a value to a parameter is as follows:

max_tuners = 10;

Throughout the system configuration file, whitespace is not significant, and C-style comments are supported.

Basic Types Three basic types of values are used to define most parameter settings:

• String—Consists of arbitrary text delimited by double quotes. String value sizes are limited to 255 characters by VQE-C software.

• Integer—Can be represented as a sequence of the characters 0 to 9, or in hexadecimal form by prepending 0x to a sequence of hexadecimal characters.

• Boolean—May have one of the following values: TRUE, true, FALSE, or false.

3-1ality Experience Client System Configuration Guide

Page 2: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C System Configuration File Syntax

GroupsFor some parameters, a group of assignments is allowed and has the following syntax:

parameter_name = {assignment1; assignment2; assignment3; ... };

In the preceding syntax, each assignment is an individual parameter specifying a subsetting of the group object. Each assignment in the group is followed by a semicolon. An example of a group is as follows:

error_repair_policer = { enable = false; rate = 5; burst = 10000; };

ListsFor some parameters, a list of groups is supported and has the following syntax:

parameter_name = (group1, group2, ... groupX);

The groups in a list are separated by commas. An example of a list is as follows:

tuner_list = ( { name = "tuner1"; url = "rtp://224.1.1.1:50000"; igmp_proxy_stb_if = "eth1"; igmp_proxy_stb_ip_address = "192.168.3.11";

},{

name = "tuner2"; url = "rtp://224.1.1.2:50000"; igmp_proxy_stb_if = "eth1"; igmp_proxy_stb_ip_address = "192.168.3.12";

});

Error Messages and WarningsError messages and warnings are not given for syntactically correct information that is not used. For example, if the following lines are in a configuration file, an error or warning is not be generated but the parameter assignment is ignored.

this_parameter_name_does_not_exist = TRUE;

errror_repair_trigger_point_abs = 30; /* Parameter name is misspelled */

3-2Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 3: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Usage Guidance

VQE-C Configuration Parameters: Usage Guidance Table 3-1 provides some guidance on the VQE-C parameters that are used by the system integrator and by the service provider. In the table, a large X means it is more likely the parameter will be of use. A small x means it is less likely the parameter will be of use.

In Table 3-1, the following two columns show who will use the parameter:

• Useful to System Integrator—If this column has an X or x, the configuration parameter has significance for the VQE-C system integrator. It is can be configured using the system configuration file.

• Useful to IPTV Service Provider—If this column has an X or x, the configuration parameter has significance for the IPTV service provider. It can be configured using the system configuration file or the network configuration file.

If neither column is marked with X or x, this configuration parameter has significance only for testers and demo creators.

In Table 3-1, the remaining columns (for example, the column Affects Error Repair Service) specify the VQE functionality area that is affected by the parameter. Error Repair is another term for Unicast Retransmission.

Table 3-1 Guidance on VQE-C Parameter Usage

VQE-C Parameter

Useful to System Integrator

Useful to IPTV Service Provider

AffectsCDI Behavior

Affects Error Repair Service

AffectsRCC Service

Affects FEC Service

app_delay X X

app_paks_per_rcc X X

cdi_enable X X

channel_lineup X

cli_ifname X X

deliver_paks_to_user X

domain_name_override x

error_repair_enable X X X

error_repair_policer.enable x X

error_repair_policer.rate x X

error_repair_policer.burst x X

error_repair_smart_request_enable

X X

error_repair_repeat_request_enable

X X

fastfill_enable X X X

fec_enable X X X

index_cfg_pathname X

input_ifname X

3-3Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 4: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Usage Guidance

integrated_rtp_fallback X x

jitter_buff_size X X X

libcli_telnet_port X x

log_level X

max_fastfill X X

max_paksize X X

max_receive_bandwidth_hd X X X

max_receive_bandwidth_hd_rcc X X X

max_receive_bandwidth_sd X X X

max_receive_bandwidth_sd_rcc X X X

max_tuners X

min_hd_stream_bitrate X X X

nat_binding_refresh_interval X

network_cfg_pathname X

output_pakq_limit X X

override_cfg_pathname X

pakpool_size X X X X X

pcr_restamp_enable X X X

qoe_enable X X X X X

rcc_enable X X X

rcc_extra_igmp_ip X X

rcc_max_concurrent X

rcc_pakpool_max_pct X X

rcc_start_timeout X X

reorder_delay_abs X X

repair_min_round_trip_time_abs X X

repair_trigger_point_abs X X X

rtcp_dscp_value X

so_rcvbuf X

src_ip_filter_enable X X

secured_vcds_port X X

secure_delivery_enable X X

ssl_certs_pathname X X

strip_rtp X

Table 3-1 Guidance on VQE-C Parameter Usage (continued)

VQE-C Parameter

Useful to System Integrator

Useful to IPTV Service Provider

AffectsCDI Behavior

Affects Error Repair Service

AffectsRCC Service

Affects FEC Service

3-4Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 5: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Usage Guidance

stun_optimization X

udp_passthru_support X X

update_interval_max X X

update_window X X

update_window X x

vcds_server_port X x

viewership_enable X X

Table 3-1 Guidance on VQE-C Parameter Usage (continued)

VQE-C Parameter

Useful to System Integrator

Useful to IPTV Service Provider

AffectsCDI Behavior

Affects Error Repair Service

AffectsRCC Service

Affects FEC Service

3-5Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 6: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

VQE-C Configuration Parameters: Reference Information This section provides reference information on each of the VQE-C configuration parameters. The information provided includes the following:

• Type—The data type of the parameter value.

• Default Value—The default value that is used for the parameter if no value is specified in the system or network configuration files.

• Range of Allowed Values—The range of values that are allowed for the parameter.

• Configurable with Network—TRUE indicates that the network configuration file can be used to set the value of this parameter.

• Configurable as Override—TRUE indicates that the override configuration file can be used to set the value of this parameter.

• Changes Effective Upon—The term "initialization" indicates that changes to the current configuration take effect when VQE-C is initialized. This is device specific, but it typically only occurs following reboot. The term "channel change" indicates that changes to the current configuration takes effect when the number of VQE-C tuners currently bound to a channel transitions from zero to one. The term “immediate” indicates that changes to the current configuration are applied instantly.

• Release Information—The VQE releases in which this parameter is supported.

app_delay Controls the time interval (in milliseconds) for the interpacket delay between replicated APP packets on output.

Type Integer

Default Value 0

Range of Allowed Values 0 to 60,000

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon Initialization

Release Information VQE Release 3.3.0 and later releases

3-6Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 7: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

app_paks_per_rccDetermines the number of MPEG packets containing stream startup information (Program Association Tables [PAT], Program MAP Table [PMT], and so on) to send out of the VQE-C at the start of a new stream.

bye_delay

Note This parameter should not be used except under the direction of Cisco support personnel.

Controls how long (in milliseconds) two RTP Control Protocol (RTCP) byes should be separated when unbinding a channel.

Type Integer

Default Value 1

Range of Allowed Values

1 to 20 in VQE Release 3.0 and later releases.1 to 1000 in VQE Release 2.1.

Configurable with Network FALSE

Configurable as Override FALSE

Release Information VQE Release 3.0.0 and later releases

Type Integer

Default Value 40

Range of Allowed Values 10 to 100

Configurable with Network FALSE

Configurable as Override FALSE

Release Information VQE Release 3.0.0 and later releases

3-7Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 8: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

cdi_enableIndicates whether or not to enable the use of the optional configuration delivery infrastructure (CDI).

• When cdi_enable is TRUE, the VQE Client Channel Configuration Delivery Server or an RTSP server sends the channel configuration file to the VQE-C on the STB.

• When cdi_enable is FALSE, VQE-C operates in a standalone mode and reads its configuration from a fixed file, specified by the channel_lineup parameter.

channel_lineupSpecifies the absolute path to the Session Description Protocol (SDP) configuration file containing the VQE-C channel lineup information. If this file does not exist, VQE-C channel lineups are not be cached in a file but stored in memory only.

While VQE-C is running, updates to this channel configuration file do not update the VQE-C internal channel configuration database. Instead, the VQE-C must reparse the channel configuration either by updating it with the CDI or by restarting the VQE-C so that it may reread the local channel lineup file (if not using CDI).

cli_ifnameSpecifies the interface on which the VQE-C CLI listens for connections. The VQE-C CLI ignores connection attempts from all other interfaces. If the specified interface is unknown or invalid, the loopback interface is used instead. In the event that the loopback interface is unavailable, the CLI is disabled and does not accept any connections.

A value of "*" (asterisk) can be specified for cli_ifname to allow the CLI to accept connections from any interface.

Type Boolean

Default Value FALSE

Range of Allowed Values TRUE or FALSE

Configurable with Network FALSE

Configurable as Override FALSE

Release Information VQE Release 3.0.0 and later releases

Type String

Default Value "" (null string)

Range of Allowed Values 0 to 255 characters

Configurable with Network FALSE

Configurable as Override FALSE

Release Information VQE Release 3.0.0 and later releases

3-8Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 9: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

deliver_paks_to_userThe VQE-C can be integrated so that packet reception and repair processing executes within the kernel space of the operating system. The deliver_paks_to_user parameter allows the repaired stream to be transported to user space for final consumption of the data.

The deliver_paks_to_user parameter does the following:

• If deliver_paks_to_user is set to TRUE, certain VQE-C APIs should be called from user space.

• If deliver_paks_to_user is set to FALSE, certain VQE-C APIs should be called from kernel space context.

Note The deliver_paks_to_user parameter should be set to FALSE when the VQE-C is executing in user space only.

For a more information on the use of this parameter, refer to the VQE-C System Integration Guide.

domain_name_overrideThis parameter is intended for use in lab environments where adding the desired service record to the DNS server is not possible. The domain name override can be used to override the default domain name used in SRV lookup requests. DNS SRV lookups are used to determine the location of the RTSP server (for example, VCDS).

When cdi_enable is TRUE, this parameter is used to override the STB's domain name in the SRV lookup.

For example, if domain_name_override is set to "iptv.myvqec.com", the SRV lookup request is for the following record:

_vqe-channel-cfg._tcp.iptv.myvqec.com

Type String

Default Value "lo"

Range of Allowed Values "*" or a valid interface name

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon Initialization

Release Information VQE Release 3.0.0 and later releases

Type Boolean

Default Value TRUE

Range of Allowed Values TRUE or FALSE

Configurable with Network FALSE

Configurable as Override FALSE

Release Information VQE Release 3.1.0 and later releases

3-9Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 10: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

error_repair_enableSpecifies whether or not Unicast Retransmission error repair is enabled by default when the VQE-C application is first run.

Type String

Default Value "" (null string)

Range of Allowed Values 0 to 255 characters

Configurable with Network FALSE

Configurable as Override FALSE

Release Information VQE Release 1.0.0 and later releases

Type Boolean

Default Value TRUE

Range of Allowed Values TRUE or FALSE

Configurable with Network TRUE

Configurable as Override

TRUE in VQE Release 3.4 and later releases.FALSE in VQE Release 3.3 and earlier releases.

Changes Effective Upon

Channel change in VQE Release 3.4 and later releases.Initialization in VQE Release 3.3 and earlier releases.

Release Information VQE Release 1.0.0 and later releases

3-10Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 11: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

error_repair_policer

This parameter is a group object that controls whether or not Unicast Retransmission error-repair policing is enabled when the VQE-C application is first run. It also allows the error-repair policer's token bucket rate and burst to be specified. When the error-repair policer is enabled, those error-repair requests that exceed the configured traffic profile for a given stream are not sent by the VQE-C.

Note The error_repair_policer group and all individual parameters are configurable by the network configuration file and changes take effect upon the next re-initialization of the VQE-C.

In the error_repair_policer group, the individual parameters are as follows:

enable

Specifies whether the error-repair policer is initially enabled (TRUE) or disabled (FALSE).

Type Boolean

Default Value TRUE

Range of Allowed Values TRUE or FALSE

Configurable with Network TRUE

Configurable as Override

TRUE in VQE Release 3.4 and later releases.FALSE in VQE Release 3.3 and earlier releases.

Changes Effective Upon

Channel change in VQE Release 3.4 and later releases.Initialization in VQE Release 3.3 and earlier releases.

Release Information VQE Release 1.0.0 and later releases

Type Boolean

Default Value TRUE

Range of Allowed Values TRUE or FALSE

Configurable with Network TRUE

Configurable as Override

TRUE in VQE Release 3.4 and later releases.FALSE in VQE Release 3.3 and earlier releases.

Changes Effective Upon

Channel change in VQE Release 3.4 and later releases.Initialization in VQE Release 3.3 and earlier releases.

Release Information VQE Release 1.0.0 and later releases

3-11Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 12: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

rate

Defines the allowed rate of error-repair requests, expressed as a percentage of the primary stream rate ("b=AS" rate). For example, a value of 5 percent means that error-repair requests are policed to an average of 5 percent of the primary stream rate over the long term.

burst

Defines the capacity of the token bucket for policing error-repair requests. A token is the equivalent of a packet. A larger capacity indicates that more repair requests may be sent over the short term without being policed. The token-bucket capacity is expressed as a duration of time (in milliseconds) at which the token bucket’s capacity would be reached if the bucket were empty and filled (with no tokens drained) at the rate specified in the rate parameter.

Type Boolean

Default Value FALSE

Range of Allowed Values TRUE or FALSE

Configurable as Override FALSE

Changes Effective Upon

Channel change in VQE Release 3.4 and later releases.Initialization in VQE Release 3.3 and earlier releases.

Release Information VQE Release 2.1.0 and later releases

Type Integer

Default Value 5

Range of Allowed Values 1 to 100

Configurable as Override FALSE

Changes Effective Upon

Channel change in VQE Release 3.4 and later releases.Initialization in VQE Release 3.3 and earlier releases.

Release Information VQE Release 2.1.0 and later releases

Type Integer

Default Value 10,000 milliseconds

Range of Allowed Values 1 to 60,000 milliseconds

Configurable as Override FALSE

Changes Effective Upon

Channel change in VQE Release 3.4 and later releases.Initialization in VQE Release 3.3 and earlier releases.

Release Information VQE Release 2.1.0 and later releases

3-12Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 13: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

The actual (absolute) rate and burst parameters used for policing error-repair packets are computed from the relative values configured above, the primary stream rate, and an assumed packet size of 1356 bytes per packet, derived as follows:

default packet size = 7 (MPEG TS pkts) * 188 (bytes/MPEG TS pkt) + 12 (bytes/RTP header) + 12 (bytes/UDP header) + 20 (bytes/IP header)

= 1356

As an example, for a 6 Mbps primary stream, if rate equals 5 percent and burst equals 10,000 milliseconds, the absolute error repair rate (rate') expressed in repair packets/s and absolute burst (burst') expressed in repair packets is:

rate' (packets/s) = <rate>/100 * <stream-rate (bps)> / (8 bits/byte * 1356 bytes/packet)= 28 packets/s

burst' (packets) = <rate' (packets/s)> * <burst (ms)> / (1000 ms per second)= 277 packets

In the preceding example, the error-repair policer limits repair requests to 28 repair packets per second over the long term, with a single RTCP Generic NACK packet requesting no more than 277 repair packet retransmissions.

error_repair_smart_request_enableThis parameter controls whether or not Unicast Retransmission error-repair Smart request is enabled.

When Smart request feature is enabled, it optimizes error-repair retransmission bandwidth by qualifying outgoing error-repair requests from VQE-C to VQE-S, preventing excessive error-repair requests for missing packets that cannot make in time before being scheduled out due to buffer capacity issues.

If error_repair_smart_request_enable is set to TRUE, Smart request is enabled. If error_repair_smart_request_enable is set to FALSE, Smart request is disabled

As an example, for a 2Mbps primary stream with default settings such as jitter buffer size of 200ms, packet re-ordering delay of 20ms, repair trigger interval of 20ms and a minimum round trip time of 0ms. With an assumed packet size of 1356 bytes per packet, derived as follows:

default packet size = 7 (MPEG TS pkts) * 188 (bytes/MPEG TS pkt) + 12 (bytes/RTP header) + 12 (bytes/UDP header) + 20 (bytes/IP header) = 1356 bytes

The average packet time of a primary packet will be around 5.4ms. With an e-factor of 20% (for guidance on setting this value, see max_receive_bandwidth_hd, max_receive_bandwidth_sd and min_hd_stream_bitrate configuration information), the average packet time of an error-repair packet will be around 27ms

Type Boolean

Default Value FALSE

Range of Allowed Values TRUE or FALSE

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon Channel change

Release Information VQE Release 3.7.1 and later releases.

3-13Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 14: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

Assume there is a continuous drop out of around 100ms of primary data i.e. close to 19 packets

Ideally when this burst loss is reported to VQE-S, we have a maximum of 200(total jitter buffer size) - 20 (reorder delay) - 0 (default round trip delay) = 180ms of buffer left with which we can receive a maximum of 7 repair packets since the time to receive one repair packet is around 27ms with 20% e-factor for this case. A default round trip delay (time that elapses between sending a RET request for a packet loss and the time of reception of the requested repair packet) of 0ms is considered in this example but in real deployment this may not be true and VQE-C internally calculates the round trip time and uses that for its calculation. In the preceding example, the error-repair Smart request limits repair requests to 7 packets.

error_repair_repeat_request_enableThis parameter controls whether or not Unicast Retransmission error-repair Repeat request is enabled.

When Repeat request feature is enabled, VQE-C will enable a second attempt to retry for the lost packets, if all the missing packets requested in the first attempt don't arrive in time. The Repeat request feature calculates the arrival time of the repair packets based on the parameters like extra bandwidth fraction also known as e-factor (for guidance on setting this value, see max_receive_bandwidth_hd, max_receive_bandwidth_sd and min_hd_stream_bitrate configuration information), round trip time between VQE-C and VQE-S(time that elapses between sending a RET request for a packet loss and the time of reception of the requested repair packet), primary stream rate and an assumed packet size of 1356 bytes per packet.

If error_repair_repeat_request_enable is set to TRUE, Repeat request is enabled.If error_repair_repeat_request_enable is set to FALSE, Repeat request is disabled

fastfill_enable Controls whether or not Fast Decoder Buffer Fill (FDBF) is enabled for Rapid Channel Change to reduce decoder buffering time and shorten channel change time. If fastfill_enable is set to TRUE, FDBF is enabled. If fastfill_enable is set to FALSE, FDBF is disabled.

Type Boolean

Default Value FALSE

Range of Allowed Values TRUE or FALSE

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon Channel change

Release Information VQE Release 3.7.1 and later releases

Type Boolean

Default Value TRUE

Range of Allowed Values TRUE or FALSE

Configurable with Network TRUE

Configurable as Override FALSE

3-14Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 15: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

fec_enableControls whether or not equipment level FEC is enabled. If fec_enable is set to FALSE, the FEC module is deactivated even though the FEC streams may still exist for some channels.

index_cfg_pathnameSpecifies the pathname used by the VQE-C to store its index file. If configured, the VQE-C computes the MD5 checksum of received configuration files (Channel Configuration, Network Configuration, and Override Configuration) upon persisting them, and stores their checksums in the index file. Upon reading a persisted configuration file from the file system, the VQE-C verifies that the MD5 checksum of a configuration file matches that contained in the index file. If the checksums do not match, the VQE-C logs an error and does not use the configuration file. This can be used in a production environment to prevent modified or corrupted configuration files (e.g. files incompletely written due to lack of storage space or other file system issue) from being used.

Changes Effective Upon

Channel change in VQE Release 3.4 and later releases.Initialization in VQE Release 3.3 and earlier releases.

Release Information VQE Release 3.2.1 and later releases

Type Boolean

Default Value TRUE

Range of Allowed Values TRUE or FALSE

Configurable with Network TRUE

Configurable as Override

TRUE in VQE Release 3.4 and later releases.FALSE in VQE Release 3.3 and earlier releases.

Changes Effective Upon

Channel Change in VQE Release 3.4 and later releases.Initialization in VQE Release 3.3 and earlier releases.

Release Information VQE Release 2.1.0 and later releases

Type String

Default Value "" (null string)

Range of Allowed Values 0 to 255 characters

Configurable with Network FALSE

Configurable as Override FALSE

Release Information VQE Release 3.4 and later releases

3-15Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 16: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

input_ifnameThe name of the only interface to be used for input. Specifies the input interface on which the VQE-C receives its packets. If input_ifname is the null string (""), the VQE-C receives its packets on INADDR_ANY. (The system listens on all interfaces for incoming packets.)

integrated_rtp_fallbackThis parameter enables support for RTPv2 streams on the VQE-C that are not configured in the VQE-C channel lineup. If integrated_rtp_fallback is set to TRUE, the VQE-C provides a data path for non-VQE RTP streams. The VQE-C provides a reordering service for non-VQE RTP streams, but provides no VQE services (that is, Error Repair and RCC). For the VQE-C to handle non-VQE RTP streams, the VQE-C configuration parameter qoe_enable must be set to TRUE to initialize the VQE-C when it starts. If integrated_rtp_fallack is set to FALSE, the VQE-C drops packets from non-VQE RTP streams.

jitter_buff_sizeThe size of the Real-Time Transport Protocol (RTP) jitter buffer in milliseconds. Packets received by VQE-C are scheduled to be sent out based on a clock that is synchronized to the MPEG data stream. A minimum delay of jitter_buff_size milliseconds is inserted by VQE-C for dejittering, packet re-ordering, and to allow error repair round-trip times to complete. It is important to note that the jitter buffer size must be set larger than the expected network jitter.

In addition to network jitter, a number of factors (for example, the target operating system’s process scheduling algorithm) must be considered when sizing the jitter buffer. Long delays in scheduling the process that reads the packets means that a larger jitter buffer is required.

Type String

Default Value ""(null string)

Range of Allowed Values null string or an interface name

Configurable with Network FALSE

Configurable as Override FALSE

Release Information VQE Release 1.0.0 and later releases

Type Boolean

Default Value TRUE

Range of Allowed Values TRUE or FALSE

Configurable with Network FALSE

Configurable as Override FALSE

Release Information VQE Release 3.5.5 and later releases

3-16Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 17: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

libcli_telnet_portThe TCP port on which the VQE-C should listen for incoming Telnet connections for CLI access. This parameter should be set to the default value of 0 when the product ships in order to prevent external access to the STB.

log_levelControls the verbosity of debug messages to the console. Setting log_level to 7 is the most verbose, and setting it to 1 is the least verbose.

Type Integer

Default Value 200

Range of Allowed Values 0 to 20,000

Configurable with Network TRUE

Configurable as Override

TRUE in VQE Release 3.4 and later releases.FALSE in VQE Release 3.3 and earlier releases.

Changes Effective Upon

Channel change in VQE Release 3.4 and later releases.Initialization in VQE Release 3.3 and earlier releases.

Release Information VQE Release 1.0.0 and later releases

Type Integer

Default Value 0

Range of Allowed Values 8000 to 65,535

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon Initialization

Release Information VQE Release 1.0.0 and later releases

Type Integer

Default Value 4

Range of Allowed Values 0 to 7

Configurable with Network

TRUE in VQE Release 3.5.6 and later releases. FALSE in VQE Release 3.5.5 and earlier releases.

3-17Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 18: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

max_fastfill The size (in bytes) of the decoder hardware buffer. This parameter is used for Rapid Channel Change (RCC) and allows a STB with limited memory to perform RCC by the VQE-S’s modifying the shape of the RCC burst and by taking advantage of fast decoder fill capabilities. The amount of STB memory required for RCC is less when the STB fast fills the hardware decoder buffer.

• A non-zero value for max_fastfill indicates that the STB is capable of and wants to receive data for fast fill. The max_fastfill value specifies the amount of data that can be pushed into the decoder hardware buffer.

• A zero value for max_fastfill indicates that the STB is not capable of or does not want to receive data for fast fill.

VQE-C uses the max_fastfill value and the rate of the current stream to calculate a maximum fastfill time (in milliseconds). VQE-C sends this maximum fast fill time to the VQE-S.

max_paksizeThe maximum size (in bytes) of the data packet that is received by the VQE-C after IP reassembly. Packets larger than the maximum allowed size are dropped or truncated.

Note When using the VQE-C with FEC, the max_paksize parameter should not be specified as less than 1344 bytes. With FEC, if the size is less than 1344 bytes, FEC-repaired packets may be truncated, omitting packet data.

Configurable as Override

TRUE in VQE Release 3.5.6 and later releases. FALSE in VQE Release 3.5.5 and earlier releases.

Changes Effective Upon Initialization

Release Information VQE Release 1.0.0 and later releases

Type Integer

Default Value 0

Range of Allowed Values 0 to 1,000,000,000

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon

Channel change in VQE Release 3.4 and later releases.Initialization in VQE Release 3.3 and earlier releases.

Release Information VQE Release 3.3.0 and later releases

Type Integer

Default Value 1508

3-18Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 19: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

max_receive_bandwidth_hd For high definition (HD) channels, specifies the maximum receive bandwidth (bits per second) of each of the tuners on this VQE-C. The maximum receive bandwidth includes the primary stream bandwidth, FEC stream bandwidth (if applicable), and VQE bandwidth. Upon requesting VQE services, the VQE-C subtracts bandwidth used by the channel's FEC streams (if applicable) from this value and signals the result to the VQE-S. The VQE-S receiving this available bandwidth subtracts the primary stream bandwidth and uses the resulting absolute value to determine the excess bandwidth fraction. The excess bandwidth fraction defines how much excess bandwidth is available on the access link to the home. The excess bandwidth fraction determines the rate at which packets are sent to this VQE-C during Unicast Retransmission and Rapid Channel Change.

Note The value of the VQE-C parameter min_hd_stream_bitrate determines whether a given stream is SD or HD. If the stream's bitrate is less than min_hd_stream_bitrate, the max_receive_bandwidth_sd parameter is used. If the stream's bitrate is greater than or equal to min_hd_stream_bitrate, the max_receive_bandwidth_hd parameter is used.

• If max_receive_bandwidth_sd and max_receive_bandwidth_hd are set to 0 (the default), the VQE-S configuration parameter vqe.vqes.max_client_bw is used in the excess bandwidth fraction calculation for this VQE-C.

• If max_receive_bandwidth_sd or max_receive_bandwidth_hd is set to a non-zero value, the VQE-S does the following:

– If a non-zero value is specified for the parameter, uses that value in the excess bandwidth fraction calculation for this VQE-C.

– If a value of zero is specified for the parameter, uses the VQE-S configuration parameter vqe.vqes.max_client_bw in the excess bandwidth fraction calculation for this VQE-C.

Note If max_receive_bandwidth_sd or max_receive_bandwidth_hd is equal to the primary stream bit rate plus the FEC bitrate, the e-factor calculated by the VQE-S is zero. An e-factor of zero results in an RCC failure. If max_receive_bandwidth_sd or max_receive_bandwidth_hd is less than the primary stream bit rate plus the FEC bit rate, the e-factor calculated by the VQE-S is invalid. An invalid e-factor results in an RCC failure.

The VQE-S defines a maximum e-factor threshold for VQE-S services using the vqe.vqes.max_client_excess_bw_fraction parameter. If this parameter is configured and a Unicast Retransmission or RCC request arrives from a VQE-C containing a bandwidth that results in an e-factor above this threshold, the request is rejected. If the vqe.vqes.max_client_excess_bw_fraction parameter is not configured (or is the default), the VQE-S caps incoming requests from the VQE-C to use an e-factor of 500%.

Range of Allowed Values 1330 to 10,000

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon Initialization

Release Information VQE Release 1.0.0 and later releases

3-19Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 20: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

The VQE-S defines a minimum e-factor threshold for VQE-S services using the vqe.vqes.min_client_excess_bw_fraction parameter. If this parameter is configured and a Unicast Retransmission or RCC request arrives from a VQE-C containing a bandwidth that results in an e-factor below this value, the request is rejected. If the vqe.vqes.min_client_excess_bw_fraction parameter is not configured, a minimum value of 3% is assumed and requests for e-factors less than 3% are rejected.

For HD channels, the max_receive_bandwidth_hd parameter allows the VQE-C to communicate the device's bandwidth to the VQE-S when it establishes the VQE session. In this way, service providers are able to more precisely set the excess bandwidth to match the actual VQE-C's bandwidth rather than using VQE-S parameter vqe.vqes.max_client_bw to provision globally for the worst case in the network. This more granular control results in lower aggregate bandwidth usage by the VQE-S.

For information on the VQE-S configuration parameters, see the Cisco CDA Visual Quality Experience Application User Guide.

max_receive_bandwidth_hd_rcc The total maximum receive bandwidth value for a HD channel during an RCC scenario only. Includes the primary stream and the FEC stream (if applicable). A value of 0 results in the VQE-C to reverting to using the value of max_receive_bandwidth_hd for the RCC scenario, unless otherwise specified in the bind() API.

Type Integer

Default Value 0

Range of Allowed Values

0 to 1,000,000,000 in VQE Release 3.3 and later releases.0 to 4,294,967,295 in VQE Release 3.2 and earlier releases.

Configurable with Network TRUE

Configurable as Override

TRUE in VQE Release 3.4 and later releases.FALSE in VQE Release 3.3 and earlier releases.

Changes Effective Upon

Channel change in VQE Release 3.4 and later releases.Initialization in VQE Release 3.3 and earlier releases.

Release Information VQE Release 3.3.0 and later releases

Type Integer

Default Value 0

Range of Allowed Values 0 to 1,000,000,000

Configurable with Network TRUE

Configurable as Override TRUE

Changes Effective Upon Channel change

Release Information VQE Release 3.4 and later releases

3-20Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 21: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

max_receive_bandwidth_sd For standard definition (SD) channels, specifies the maximum receive bandwidth (bits per second) of each of the tuners on this VQE-C. The maximum receive bandwidth includes the primary stream bandwidth, FEC stream bandwidth (if applicable), and VQE bandwidth. Upon requesting VQE services, the VQE-C subtracts bandwidth used by the channel's FEC streams (if applicable) from this value and signals the result to the VQE-S. The VQE-S receiving this available bandwidth subtracts the primary stream bandwidth and uses the resulting absolute value to determine the excess bandwidth fraction. The excess bandwidth fraction defines how much excess bandwidth is available on the access link to the home. The excess bandwidth fraction determines the rate at which packets are sent to this VQE-C during Unicast Retransmission and Rapid Channel Change.

Note The value of the VQE-C parameter min_hd_stream_bitrate determines whether a given stream is SD or HD. If the stream's bitrate is less than min_hd_stream_bitrate, the max_receive_bandwidth_sd parameter is used. If the stream's bitrate is greater than or equal to min_hd_stream_bitrate, the max_receive_bandwidth_hd parameter is used.

• If max_receive_bandwidth_sd and max_receive_bandwidth_hd are set to 0 (the default), the VQE-S configuration parameter vqe.vqes.max_client_bw is used in the excess bandwidth fraction calculation for this VQE-C.

• If max_receive_bandwidth_sd or max_receive_bandwidth_hd is set to a non-zero value, the VQE-S does the following:

– If a non-zero value is specified for the parameter, uses that value in the excess bandwidth fraction calculation for this VQE-C.

– If a value of zero is specified for the parameter, uses the VQE-S configuration parameter vqe.vqes.max_client_bw in the excess bandwidth fraction calculation for this VQE-C.

Note If max_receive_bandwidth_sd or max_receive_bandwidth_hd is equal to the primary stream bit rate plus the FEC bit rate, the e-factor calculated by the VQE-S is zero. An e-factor of zero results in an RCC failure. If max_receive_bandwidth_sd or max_receive_bandwidth_hd is less than the primary stream bit rate plus the FEC bit rate, the e-factor calculated by the VQE-S is invalid. An invalid e-factor results in an RCC failure.

The VQE-S defines a maximum e-factor threshold for VQE-S services using the vqe.vqes.max_client_excess_bw_fraction parameter. If this parameter is configured and a Unicast Retransmission or RCC request arrives from a VQE-C containing a bandwidth that results in an e-factor above this threshold, the request is rejected. If the vqe.vqes.max_client_excess_bw_fraction parameter is not configured (or is the default), the VQE-S caps incoming requests from the VQE-C to use an e-factor of 500%.

The VQE-S defines a minimum e-factor threshold for VQE-S services using the vqe.vqes.min_client_excess_bw_fraction parameter. If this parameter is configured and a Unicast Retransmission or RCC request arrives from a VQE-C containing a bandwidth that results in an e-factor below this value, the request is rejected. If the vqe.vqes.min_client_excess_bw_fraction parameter is not configured, a minimum value of 3% is assumed and requests for e-factors less than 3% are rejected.

3-21Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 22: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

For SD channels, the max_receive_bandwidth_sd parameter allows the VQE-C to communicate the device's bandwidth to the VQE-S when it establishes the VQE session. In this way, service providers are able to more precisely set the excess bandwidth to match the actual VQE-C's bandwidth rather than using VQE-S parameter vqe.vqes.max_client_bw to provision globally for the worst case in the network. This more granular control results in lower aggregate bandwidth usage by the VQE-S.

For information on the VQE-S configuration parameters, see the Cisco CDA Visual Quality Experience Application User Guide.

Type Integer

Default Value 0

Range of Allowed Values 0 to 1,000,000,000

Configurable with Network TRUE

Configurable as Override

TRUE in VQE Release 3.4 and later releases.FALSE in VQE Release 3.3 and earlier releases.

Changes Effective Upon

Channel change in VQE 3.4 and later releases.Initialization in VQE 3.3 and earlier releases.

Release Information VQE Release 3.3.0 and later releases

3-22Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 23: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

max_receive_bandwidth_sd_rcc The total maximum receive bandwidth value for a SD channel during an RCC scenario only. Includes primary stream and FEC stream (if applicable). A value of 0 results in the VQE-C to reverting to using the value of max_receive_bandwidth_sd for the RCC scenario, unless otherwise specified in the bind() API.

max_tunersThe maximum number of tuners that can be created in VQE-C. This translates to the maximum number of simultaneous streams of video data that the system is expected to receive.

min_hd_stream_bitrateSpecifies the stream bitrate (bits per second) that is used to determine whether a channel is SD or HD for this specific VQE-C. The min_hd_stream_rate parameter is used in conjunction with the parameters max_receive_bandwidth_sd and max_receive_bandwidth_hd. The VQE-C uses the value of min_hd_stream_bitrate to determine whether a given stream is SD or HD:

• If the stream’s bitrate is less than min_hd_stream_bitrate, the parameter max_receive_bandwidth_sd is used.

• If the stream’s bitrate is greater than or equal to min_hd_stream_bitrate, the parameter max_receive_bandwidth_hd is used.

Note If min_hd_stream_bitrate is not configured to a value other than zero (the default), all channels are considered to be HD channels.

Type Integer

Default Value 0

Range of Allowed Values 0 to 1,000,000,000

Configurable with Network TRUE

Configurable as Override TRUE

Changes Effective Upon Channel change

Release Information VQE Release 3.4 and later releases

Type Integer

Default Value 1

Range of Allowed Values 1 to 32

Configurable with Network FALSE

Configurable as Override FALSE

Release Information VQE Release 1.0.0 and later releases

3-23Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 24: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

nat_binding_refresh_intervalThe interval (in seconds) to wait each time before refreshing NAT bindings. This parameter only has meaning when the system is operating in NAT signaling mode (sig_mode set to NAT). The default setting for this parameter is conservative and may be adjusted higher when the NAT binding timeout for a given deployment is known. Setting nat_binding_refresh_interval to 0 means that the VQE-C will not try to locate any STUN servers using the Domain Name System (DNS).

network_cfg_pathnameThe absolute path to the network configuration file containing updates to the VQE-C system configuration.

• If a pathname is supplied, the VQE-C stores any updates received from a VCDS in this file, and also apply them during VQE-C initialization.

• If no pathname is provided, the VQE-C does not request or use updates to its system configuration.

The path supplied should specify a location in nonvolatile, writeable memory (for example, flash memory) so that updates can persist and be used following a set-top box reboot.

Type Integer

Default Value 0

Range of Allowed Values 0 to 1,000,000,000

Configurable with Network TRUE

Configurable as Override

TRUE in VQE Release 3.4 and later releases.FALSE in VQE Release 3.3 and earlier releases.

Changes Effective Upon

Channel change in VQE Release 3.4 and later releases.Initialization in VQE Release 3.3 and earlier releases.

Release Information VQE Release 3.3.0 and later releases

Type Integer

Default Value 30

Range of Allowed Values 0 to 100,000

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon Initialization

Release Information VQE Release 1.0.0 and later releases

3-24Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 25: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

num_byes

Note This parameter should not be used except under the direction of Cisco support personnel.

Controls how many RTP Control Protocol (RTCP) byes are sent when unbinding a channel.

output_pakq_limitThe limit on the size (in packets) of the output packet queue.

Type String

Default Value "" (null string)

Range of Allowed Values 0 to 255 characters

Configurable with Network FALSE

Configurable as Override FALSE

Release Information VQE Release 3.3.0 and later releases

Type Integer

Default Value 2

Range of Allowed Values 2 to 5

Configurable with Network FALSE

Configurable as Override FALSE

Release Information VQE Release 3.0.0 and later releases

Type Integer

Default Value 200

Range of Allowed Values 100 to 20,000

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon Initialization

Release Information VQE Release 1.0.0 and later releases

3-25Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 26: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

override_cfg_pathnameSpecifies a pathname used by the VQE-C to store its Override Configuration file. The path supplied should be located in non-volatile, writable memory (e.g. flash) so that updates may persist and be used following a reboot. Override Configuration files are not delivered within a CDI environment, but may be delivered by non-CDI configuration delivery mechanisms.

Note This parameter should only be used in deployments that support override configurations through delivery of override configuration files from the STB to the VQE-C.

pakpool_sizeThe size (in packets) of the packet pool to create. The VQE-C uses a fixed memory buffer pool for storing packet data. The number of packets stored in this packet pool is determined by the setting of pakpool_size. If an insufficient pakpool_size is allocated, the quality of the video stream will be poor. If the video quality is poor, increasing the number of pakpool_size may fix the problem. Diagnostics counters, and error messages available in the CLI can be used to resolve issues with setting this parameter.

For guidance on setting the value of this parameter, see the “Memory Resource (pakpool_size) Considerations” section in the VQE-C System Configuration Guide.

pcr_restamp_enableThis parameter controls whether or not VQE-C performs the Programme Clock Reference (PCR) re-stamping during Fastfill enabled Rapid Channel Change (RCC). To enable support for PCR re-stamping VQE-C parameter fastfill_enable must be set to TRUE.

Type String

Default Value "" (null string)

Range of Allowed Values 1 to 255 characters

Configurable with Network FALSE

Configurable as Override FALSE

Release Information VQE Release 3.4 and later releases

Type Integer

Default Value 1000

Range of Allowed Values 100 to 200,000

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon Initialization

Release Information VQE Release 1.0.0 and later releases

3-26Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 27: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

If pcr_restamp_enable is set to TRUE, VQE-C re-stamps the PCR value in the received APP and MPEG TS packets during the fastFill enabled RCC. If pcr_restamp_enable is set to FALSE, VQE-C does not re-stamp the PCR value during fastfill enabled RCC.

qoe_enableIndicates whether or not VQE-C services should be enabled.

• When TRUE, VQE-C services are enabled.

• When FALSE, VQE-C is disabled following initialization and does not consume any resources.

Configuration of this parameter to FALSE does not prevent the VQE-C from retrieving an updated network configuration during its next initialization if CDI is enabled.

Note This parameter replaces the obsolete vqec_enable parameter in VQE Release 3.4.

rcc_enableControls whether or not equipment-level Rapid Channel Change (RCC) is enabled. Usually the rcc_enable parameter is enabled or disabled on a per-channel basis in the SDP channel configuration.

Note This parameter overrides the per-channel setting in the SDP channel configuration.

• If rcc_enable is set to FALSE, Rapid Channel Change is not performed when tuning to a new channel even though RCC is enabled for the channel in the SDP channel configuration.

Type Boolean

Default Value FALSE

Range of Allowed Values TRUE or FALSE

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon Channel change

Release Information VQE Release 3.9 and later releases

Type Boolean

Default Value TRUE

Range of Allowed Values TRUE or FALSE

Configurable with Network TRUE

Configurable as Override TRUE

Changes Effective Upon Initialization

Release Information VQE Release 1.0.0 and later releases.

3-27Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 28: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

• If rcc_enable is set to TRUE, Rapid Channel Change is performed when RCC is enabled for the channel in the SDP channel configuration.

3-28Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 29: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

rcc_extra_igmp_ipSpecifies a multicast IP address for the VQE-C to join briefly to stop the flow of the multicast stream of old channel during an RCC. In some DSLAMS, the old stream may not stop flowing when the IGMP leave message is received. Instead, the old multicast stream stops when an IGMP join message for a new stream is received. If the old stream is still flowing, there may not be enough excess bandwidth on the access link for the unicast burst required for the RCC.

By specifying a multicast IP address using the parameter rcc_extra_igmp_ip, upon leaving an old channel and joining a new RCC channel, IGMP join and leave requests are sent for the multicast address specified by this parameter. Regardless of the status or utilization of this multicast address, the DSLAM stops the flow of the old channel, leaving enough excess bandwidth on the access link for the RCC to take place.

The multicast address specified in parameter rcc_extra_igmp_ip should not be used by any other channels on the VQE-S.

Type Boolean

Default Value TRUE

Range of Allowed Values TRUE or FALSE

Configurable with Network TRUE

Configurable as Override

TRUE in VQE Release 3.4 and later releases.FALSE in VQE Release 3.3 and earlier releases.

Changes Effective Upon

Initialization in VQE Release 3.3 and earlier releases.Channel change in VQE Release 3.4 and later releases.

Release Information VQE Release 3.0.0 and later releases

Type String

Default Value "" (null string)

Range of Allowed Values 0 to 255 characters

Configurable with Network TRUE

Configurable as Override TRUE

Changes Effective Upon Channel change.

Release Information VQE Release 3.5.4 and later releases

3-29Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 30: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

rcc_max_concurrentThe maximum number of channels that may be simultaneously bound using RCC. This parameter limits the number of simultaneous RCCs on the VQE-C. If rcc_max_concurrent is set to 0, there is no restriction on the number of simultaneous RCCs.

rcc_pakpool_max_pctSpecifies the maximum pakpool percentage allocated to RCC.

rcc_start_timeoutControls the timeout (in milliseconds) of a Rapid Channel Change (RCC). When the tuner begins a channel change, after the amount of time specified in rcc_start_timeout, the VQE-C aborts the RCC if it has not successfully started the RCC (received APP, received first repair packet, and received the STUN response).

Type Integer

Default Value 1

Range of Allowed Values 0 to 32

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon Initialization

Release Information VQE Release 3.5.5 and later releases

Type Integer

Default Value 80

Range of Allowed Values 0 to 100

Configurable with Network FALSE

Configurable as Override FALSE

Release Information VQE Release 3.3 and later releases

Type Integer

Default Value 120

Range of Allowed Values 0 to 1000

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon Initialization

Release Information VQE Release 3.0.0 and later releases.

3-30Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 31: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

reorder_delaySpecifies the delay (in milliseconds) to hold gaps that may have been caused by primary packets arriving out of order. For the duration of this delay, new gaps are not available for Unicast Retransmission error repair. Increasing this parameter makes this delay longer and allows less total time for Unicast Retransmission to operate.

For Unicast Retransmission, the sum of reorder delay and repair trigger point must be less than the jitter buffer size. However, the sum of these two should also be small enough to allow the rest of the jitter buffer size to accommodate the round-trip time to VQE-S. For more information on these VQE-C parameters, see the “Buffer Size Constraint” section on page 2-4.

Note This parameter has been deprecated and is replaced by the reorder_delays_abs parameter.

reorder_delay_absSpecifies the delay (in milliseconds) to hold gaps that may have been caused by primary packets arriving out of order. For the duration of this delay, new gaps are not be available for Unicast Retransmission error repair. Increasing this parameter makes this delay longer and allows less total time for Unicast Retransmission to operate.

For Unicast Retransmission, the sum of reorder delay and repair trigger point must be less than the jitter buffer size. However, the sum of these two should also be small enough to allow the rest of the jitter buffer size to accommodate the round-trip time to the VQE-S. For more information on these VQE-C parameters, see the “Buffer Size Constraint” section on page 2-4.

Note This parameter replaces the obsolete reorder_delay parameter in VQE Release 3.0.

Type Integer

Default Value 20

Range of Allowed Values 0 to 100

Configurable with Network FALSE

Configurable as Override FALSE

Release Information VQE Release 2.1.2 and later releases.

Type Integer

Default Value 20

Range of Allowed Values 0 to 200

Configurable with Network TRUE

Configurable as Override FALSE

3-31Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 32: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

repair_min_round_trip_time_absSpecifies the round trip time (in milliseconds) between VQE-C and VQE-S. This parameter is used by Smart request and Repeat request features. This is an optional parameter. VQE-C in turn calculates the round trip time internally. When configured, VQE-C uses the configured value till the software calculation is done. The default value for this parameter is 0.

Note This parameter affects the error_repair_repeat_request and error_repair_smart_request features. The unit of allowed values (time) is milliseconds.

repair trigger pointThe Real-Time Transport Protocol (RTP) repair trigger point in milliseconds. The repair trigger point is the time interval at which the VQE-C reports currently known errors to the VQE-S. Smaller values make error reporting more frequent, while larger values make it less frequent.

For Unicast Retransmission, the sum of reorder delay and repair trigger point must be less than the jitter buffer size. However, the sum of these two should also be small enough to allow the rest of the jitter buffer size to accommodate the round-trip time to VQE-S. This parameter is not expected to need adjusting by the VQE-C integrator.

Note This parameter has been deprecated and is replaced by the repair_trigger_point_abs parameter.

Changes Effective Upon

Channel change in VQE Release 3.4 and later releases.Initialization in VQE Release 3.3 and earlier releases.

Release Information VQE Release 2.1.0 and later releases

Type Integer

Default Value 0

Range of Allowed Values 0 to 3000

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon Channel change

Release Information VQE Release 3.7.1 and later releases.

Type Integer

Default Value 30

Range of Allowed Values 0 to 100

Configurable with Network FALSE

3-32Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 33: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

repair_trigger_point_absThe Real-Time Transport Protocol (RTP) repair trigger point in milliseconds. The repair trigger point is the time interval at which the VQE-C reports currently known errors to the VQE-S. Smaller values make error reporting more frequent, while larger values make it less frequent.

For Unicast Retransmission, the sum of reorder delay and repair trigger point must be less than the jitter buffer size. However, the sum of these two should also be small enough to allow the rest of the jitter buffer size to accommodate the round-trip time to VQE-S. This parameter is not expected to need adjusting by the VQE-C integrator.

Note This parameter replaces the obsolete repair_trigger_point parameter in VQE Release 3.0

rtcp_dscp_valueSpecifies the value to be used for the Differentiated Services Code Point (DSCP) field in all RTCP packets.

Note To use a DSCP value of 40 or higher, root privileges must be held by the process containing VQE-C.

Configurable as Override FALSE

Release Information VQE Release 1.0.0 and later releases

Type Integer

Default Value 20

Range of Allowed Values 0 to 200

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon

Initialization in VQE Release 3.3 and earlier releases.Channel change in VQE Release 3.4 and later releases.

Release Information VQE Release 1.0.0 and later releases

Type Integer

Default Value 24

Range of Allowed Values 0 to 63

Configurable with Network TRUE

Configurable as Override FALSE

3-33Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 34: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

sig_mode

Note This parameter should not be used except under the direction of Cisco support personnel.

The Network Address Translation (NAT) signaling mode in which to operate the VQE-C. This parameter can be set to either NAT or STD.

• When sig_mode is set to NAT, the VQE-C always uses NAT signaling mode. NAT signaling mode may be used when the VQE-C is not behind a NAT device. Service providers may prefer NAT signaling mode as it does not use SDP configured repair ports. Instead, only a single pair of repair ports (which are dynamically allocated) are used. In NAT mode, many instances of the VQE-C can be used with the same host IP address.

Note NAT signaling mode is not currently standardized. Otherwise, service providers might always be expected to choose NAT mode.

• When sig_mode is set to STD, the VQE-C always selects standard (non-NAT) signaling mode. In STD signaling mode, the SDP file repair RTCP and RTP ports are all opened by the STB. The configuration must assure that all ports are free from conflict with other applications on the STB.

so_rcvbufThe size (in bytes) of the receive buffer to use when opening the VQE-C receive socket.

Changes Effective Upon

Channel change in VQE Release 3.4 and later releases.Initialization in VQE Release 3.3 and earlier releases.

Release Information VQE Release 3.0.0 and later releases

Type String

Default Value NAT

Range of Allowed Values NAT or STD

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon Initialization

Release Information VQE Release 1.0.0 and later releases

Type Integer

Default Value 128,000

Range of Allowed Values 0 to 1,000,000

Configurable with Network TRUE

3-34Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 35: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

src_ip_filter_enable Controls whether or not the VQE-C places a Single Source Multicast (SSM) source IP filter on the primary-stream, repair stream, and the FEC sockets. If the underlying network is configured to use IGMPv3, the source filter is propagated on the network.

• When src_ip_filter_enable is TRUE, the VQE-C places a source IP filter on a channel based on the bind or channel update API settings for the channel.

• When src_ip_filter_enable is FALSE, the VQE-C does not place a source IP filter on any channels. This includes the primary-stream, repair stream, and the FEC sockets of any channel.

secured_vcds_portThis parameter allows for manual configuration of the port to reach the secured VCDS server. When a port number is specified in secured_vcds_port and a valid IP address is specified in vcds_server_ip, this port number and IP address are always used instead of using DNS SRV lookups.

Configurable as Override FALSE

Changes Effective Upon

Channel change in VQE Release 3.4 and later releases.Initialization in VQE Release 3.3 and earlier releases.

Release Information VQE Release 1.0.0 and later releases

Type Boolean

Default Value FALSE

Range of Allowed Values TRUE or FALSE

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon Initialization

Release Information VQE Release 3.3.0 and later releases

Type Integer

Default Value 8443

Range of Allowed Values 1024 to 65,535

Configurable with Network FALSE

Configurable as Override FALSE

Changes Effective upon Initialization

Release Information VQE Release 3.10 and later releases

3-35Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 36: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

secure_delivery_enableIndicates whether or not VCDS should support secure delivery of channel configuration files and per-client network configuration files to the VQE-Cs

• If secure_delivery_enable is set to FALSE, VQE-C will use the RTSP DESCRIBE request to retrieve the configuration files from VCDS.

• If secure_delivery_enable is set to TRUE, VQE-C will use the HTTPS GET request to retrieve the configuration files from VCDS.

ssl_certs_pathnameThe absolute path to the SSL certificate file. If no pathname is provided, VQE-C will use the system-default ssl certificate file. If a pathname is supplied, VQE-C will use this file for SSL authentication.

strip_rtpIndicates whether or not to strip the RTP header from the packets and just send UDP packets. Determines whether or not the VQE-C strips the incoming RTP header off the packet before providing the video data to the client’s receive message interface. By default, strip_rtp is enabled as it is assumed that the application above the VQE-C does not need or want to see the RTP header information.

Type Boolean

Default Value FALSE

Range of Allowed Values TRUE or FALSE

Configurable with Network FALSE

Configurable as Override FALSE

Changes Effective Upon Initialization

Release Information VQE Release 3.10 and later releases

Type String

Default Value “” (null string)

Range of Allowed Values 0 to 255 characters

Configurable with Network FALSE

Configurable as Override FALSE

Release Information VQE Release 3.10 and later releases

Type Boolean

Default Value TRUE

Range of Allowed Values TRUE or FALSE

3-36Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 37: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

stun_optimizationThis parameter controls whether or not VQE-C sends STUN binding requests for every channel change. If stun_optimization is set to TRUE, VQE-C sends STUN binding requests, only if the STB is behind a NAT. If stun_optimzation is set to FALSE, VQE-C sends STUN binding requests for every channel change irrespective of whether the STB is behind a NAT or not.

tuner_list

Note This parameter may be useful to testers and demo creators. It is not used for actual VQE-C system integration or deployment.

This is a list object that provides a list of tuners and their configuration settings that the VQE-C should automatically create on startup. Each tuner in the list is a group object that contains at least a name parameter and optionally one or more of the other parameters. A tuner_list can have at most max_tuners elements in it.

At a minimum, each tuner must have values specified for the name and url parameters.

Note The tuner_list group and all individual parameters are not configurable by the network configuration file.

In a tuner_list group, the individual parameters for each tuner in the list are as follows:

name

The name of the tuner to which the current group refers. This is the name that is used when referencing this tuner in the CLI.

Configurable with Network FALSE

Configurable as Override FALSE

Release Information VQE Release 1.0.0 and later releases

Type Boolean

Type Boolean

Default Value TRUE

Range of Allowed Values TRUE or FALSE

Configurable with Network FALSE

Configurable as Override FALSE

Changes Effective Upon Initialization

Release Information VQE Release 3.6.3 and later releases

Type String

Default Value None

3-37Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 38: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

url

The channel URL that this tuner is bound ("tuned") to upon startup.

stream_output_if

The interface to be used when sending an output video stream as a multicast stream. For this parameter to take effect, the stream_output_url must contain a multicast IP address.

stream_output_url

The destination URL to send an output video stream.

* If no value is specified for stream_output_url, the tuner is created without an output stream. Later if desired, an output stream can be added to the tuner with the stream-output CLI command.

max_receive_bandwidth_rcc

For tuner creation at VQE-C startup, specifies the maximum receive bandwidth (bits per second) of this specific tuner for Rapid Channel Change. If a nonzero value is not specified for max_receive_bandwidth_rcc, the value of the VQE-S configuration parameter vqe.vqes.max_client_bw is used.

Range of Allowed Values 0 to 255 characters

Release Information VQE Release 1.0.0 and later releases

Type String

Default Value None

Range of Allowed Values 0 to 255 characters

Release Information VQE Release 1.0.0 and later releases

Type String

Default Value "" (null string)

Range of Allowed Values Any interface, or the null string

Release Information VQE Release 1.0.0 and later releases

Type String

Default Value None *

Range of Allowed Values 0 to 255 characters

Release Information VQE Release 1.0.0 and later releases

Type Integer

Default Value 0

Range of Allowed Values 0 to 1,000,000,000

Release Information VQE Release 3.3.0 and later releases

3-38Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 39: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

Note The max_receive_bandwidth_rcc value is used only for the initial binding of the tuners created at VQE-C startup and is not used for any bind thereafter.

For information on the maximum receive bandwidth value that is used after tuner creation, see the descriptions of these parameters: min_hd_stream_bitrate, max_receive_bandwidth_hd, and max_receive_bandwidth_sd.

max_receive_bandwidth_er

During tuner creation at VQE-C startup, specifies the maximum receive bandwidth (bits per second) of this specific tuner for Unicast Retransmission error repair. If a nonzero value is not specified for max_receive_bandwidth_er, the value of the VQE-S configuration parameter vqe.vqes.max_client_bw is used.

Note The max_receive_bandwidth_er value is used only for the initial binding of the tuners created at the VQE-C startup and is not used for any bind thereafter.

For information on the maximum receive bandwidth value that is used after tuner creation, see the descriptions of these parameters: min_hd_stream_bitrate, max_receive_bandwidth_hd, and max_receive_bandwidth_sd.

igmp_proxy_stb_if

The Ethernet interface on the VQE-C (reference mode) box to which the STB is connected.

igmp_proxy_stb_ip_address

IP address of the STB. An address of "0.0.0.0" disables IGMP Proxy for the tuner.

Type Integer

Default Value 0

Range of Allowed Values 0 to 1,000,000,000

Release Information VQE Release 3.3.0 and later releases

Type String

Default Value None

Range of Allowed Values 0 to 255

Release Information VQE Release 3.1.0 and later releases

Type String

Default Value none

Range of Allowed Values 0 to 255 characters

Release Information VQE Release 3.1.0 and later releases

3-39Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 40: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

When the VQE-C IGMP-Proxy mode is enabled for a tuner, that tuner listens on the stb-if-name interface for IGMP join requests coming from a STB with address stb-ip-addr. When the tuner receives an IGMP leave and join report from the STB, the tuner tunes to the new channel being joined by the STB. It then begins to send a repaired output multicast stream on the stb-if interface for the STB to display the stream.

In case of missing or incorrect IGMP-Proxy settings in the configuration file, IGMP Proxy for a tuner is disabled by default.

The following restrictions apply to the IGMP-Proxy parameters:

• The process containing VQE-C needs superuser privileges to successfully enable igmp_proxy parameters.

• IGMP Proxy works only for IEEE 802.3 encapsulation, and shows unexpected behavior for Ethernet II and 802.1Q (VLAN) encapsulations.

• IGMP Proxy works only for a single STB behind the VQE-C device, and supports UDP-only stream output and has only host device support, and does not support operation on a router or bridge.

• A user cannot configure more than one IGMP proxy for the same STB (IP address).

udp_passthru_supportThis parameter enables support for UDP MPEG2-TS streams on the VQE-C. If udp_passthru_support is set to to TRUE, the VQE-C provides a data path for UDP streams. The VQE-C acts only as a pass-through device for UDP streams and provides no VQE services (that is, Error Repair and RCC). For the VQE-C to handle UDP a streams, the VQE-C configuration parameter qoe_enable must be set to true to initialize the VQE-C when it starts. If udp_passthru_support is set to False, the VQE-C drops packets from UDP streams

update_interval_maxMaximum amount of time (in seconds) allowed to pass between update requests from the VQE-C to the VCDS, excluding the update_window value. For example, a value of 3600 indicates that the VQE-C waits for the following interval between its polls for configuration updates:

3600 seconds + (delay specified by the update_window parameter)

A value of 0 implies that polling for updates is disabled.

Note The update_interval_max parameter also controls whether updates are triggered upon an attempt to bind a VQE-C tuner to a non-existent channel within the channel lineup. A triggered update only results if polling is disabled (update_interval_max set to 0).

Type Boolean

Default Value FALSE

Range of Allowed Values TRUE or FALSE

Configurable with Network FALSE

Configurable as Override FALSE

Release Information VQE Release 3.5.5 and later releases

3-40Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 41: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

update_windowThe window of time constant (in seconds) for the background configuration updates. For more information on this parameter, see the “Background/Polled Updates” section on page 2-6.

update_windowThe window of time constant (in seconds) for the background configuration updates. For more information on this parameter, see the “Background/Polled Updates” section on page 2-6.

Type Integer

Default Value 3600

Range of Allowed Values The value 0, or a value in the range 30 to 604,800

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon

Immediate in VQE Release 3.4 and later releases.Initialization in VQE Release 3.3 and earlier releases.

Release Information VQE Release 3.0.0 and later releases

Type Integer

Default Value 60

Range of Allowed Values 1 to 100,000

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon

Immediate in VQE Release 3.4 and later releases.Initialization in VQE Release 3.3 and earlier releases.

Release Information VQE Release 1.0.0 and later releases

Type Integer

Default Value 60

Range of Allowed Values 1 to 100,000

3-41Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 42: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C Configuration Parameters: Reference Information

vcds_server_portThis parameter allows for manual configuration of the port to reach the VCDS server. When a port number is specified in vcds_server_port and a valid IP address is specified in vcds_server_ip, the port and address are always used instead of using DNS SRV lookups.

vqec_enableIndicates whether or not the VQE-C services should be enabled.

• When TRUE, the VQE-C services are enabled.

• When FALSE, the VQE-C is disabled following initialization and does not consume any resources.

Configuration of this parameter to FALSE does not prevent the VQE-C from retrieving an updated network configuration during its next initialization if CDI is enabled.

Note This parameter has been deprecated and is replaced by qoe_enable in VQE Release 3.4

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon

Immediate in VQE Release 3.4 and later releases.Initialization in VQE Release 3.3 and earlier releases.

Release Information VQE Release 1.0.0 and later releases

Type Integer

Type Integer

Default Value 8554

Range of Allowed Values 1054 to 65,535

Configurable with Network FALSE

Configurable as Override FALSE

Release Information VQE Release 2.1.2 and later releases

Type Boolean

Default Value TRUE

Range of Allowed Values TRUE or FALSE

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon Initialization

Release Information VQE Release 1.0.0 and later releases.

3-42Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 43: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C System Configuration File Examples

viewership_enableIndicates whether or not the background polling thread for VQE-C viewership report should be created.

• When TRUE, the background polling thread which is used to get the viewership status will be created in VQE-C.

• When FALSE, the background polling thread which is used to get the viewership status will not be created in VQE-C

VQE-C System Configuration File Examples

Example 1: File with All Default Values In this configuration file, the default values for all parameters are used.

/* * Copyright (c) 2007-2009 by Cisco Systems, Inc. * All rights reserved. */app_delay = 0;app_paks_per_rcc = 1;bye_delay = 40;cdi_enable = false;channel_lineup = "";cli_ifname = "lo";deliver_paks_to_user = false; domain_name_override = ""; error_repair_enable = true;error_repair_policer = { enable = false; rate = 5; burst = 10000; };max_tuners = 1;channel_lineup = "";network_cfg_pathname = "";override_cfg_pathname = "";index_cfg_pathname = "";jitter_buff_size = 200;repair_trigger_point_abs = 20;pakpool_size = 1000;so_rcvbuf = 128000;strip_rtp = true;

Type Boolean

Default Value FALSE

Range of Allowed Values TRUE or FALSE

Configurable with Network TRUE

Configurable as Override FALSE

Changes Effective Upon Initialization

Release Information VQE Release 3.8 and later releases.

3-43Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 44: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C System Configuration File Examples

input_ifname = "";sig_mode = "nat";nat_binding_refresh_interval = 30;max_paksize = 1508;cdi_enable = false;domain_name_override = "";libcli_telnet_port = 0;output_pakq_limit = 200;update_window = 60;update_interval_max = 3600;app_paks_per_rcc = 1;error_repair_enable = true;error_repair_policer.enable = falseerror_repair_policer.rate = 5;error_repair_policer.burst = 10000;fec_enable = true;rcc_enable = true;rcc_start_timeout = 120;num_byes = 2;bye_delay = 40;reorder_delay_abs = 20;vcds_server_ip = "0.0.0.0";vcds_server_port = 8554;cli_ifname = "lo";rtcp_dscp_value = 24;deliver_paks_to_user = true;fastfill_enable = true;max_receive_bandwidth_sd = 0;max_receive_bandwidth_sd_rcc = 0;max_receive_bandwidth_hd = 0;max_receive_bandwidth_hd_rcc = 0;min_hd_stream_bitrate = 0;max_fastfill = 0;app_delay = 0;src_ip_filter_enable = false;qoe_enable = true;rcc_extra_igmp_ip = "0.0.0.0";rcc_max_concurrent = 1;integrated_rtp_fallback = true;udp_passthru_support = false;vod_cmd_timeout = 2000;vod_max_sessions = 1;vod_mode = "iptv";log_level = 4;stun_optimization = true;error_repair_smart_request_enable = false;error_repair_repeat_request_enable = false;repair_min_round_trip_time_abs = 0;viewership_enable = false;pcr_restamp_enable = false;

Example 2: Common Normal Configuration In this configuration file, the CLI is enabled and listening for connections on port 8182, and there is a tuner named "tuner1" that is created, bound to a channel, and streaming an output video stream. Also, the channel configuration is coming from a file named "my_sdp_channel_config.cfg".

/* * Copyright (c) 2007 by Cisco Systems, Inc. * All rights reserved. */

3-44Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 45: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C System Configuration File Examples

channel_lineup = "my_sdp_channel_config.cfg";sig_mode = "NAT";input_ifname = "eth1";max_tuners = 10;libcli_telnet_port = 8182;tuner_list = ( { name = "tuner1"; url = "rtp://224.1.1.1:50000"; stream_output_if = "eth1"; stream_output_url = "udp://192.168.1.100:1234"; });

Example 3: Another Common Normal ConfigurationIn this configuration file, the parameters have been changed so that the output stream is RTP instead of UDP, and the configuration delivery infrastructure is being used to download the channel configuration data.

/* * Copyright (c) 2007 by Cisco Systems, Inc. * All rights reserved. */channel_lineup = "LINEUP";strip_rtp = false;sig_mode = "NAT";input_ifname = "eth1";max_tuners = 10;cdi_enable = true;libcli_telnet_port = 8182;tuner_list = (

{ name = "tuner1"; url = "rtp://224.1.1.1:50000";

});

Example 4: Configuration for IGMP-Proxy In this configuration file, the channel configuration is coming from a file named my_sdp_channel_config.cfg. NAT mode is enabled. The CLI is enabled and listening for connections on port 8182, and there is a tuner named "tuner1" that is created and bound to a channel.

In this example, VQE-C is in reference mode. IGMP Proxy is enabled from the configuration parameters. IGMP Proxy for tuner1 is enabled for a STB with IP address 192.168.3.11 and connected to the Ethernet interface eth1. In the case of missing or incorrect IGMP-Proxy settings in the configuration file, IGMP Proxy for a tuner is disabled by default.

/* * Copyright (c) 2007 by Cisco Systems, Inc. * All rights reserved. */channel_lineup = "my_sdp_channel_config.cfg";sig_mode = "NAT";input_ifname = "eth1";max_tuners = 10;

3-45Cisco CDA Visual Quality Experience Client System Configuration Guide

Page 46: VQE-C Configuration File Syntax and Parameters · Chapter 3 VQE-C Configuration File Syntax and Parameters VQE-C Configuration Parameters: Reference Information app_paks_per_rcc Determines

Chapter 3 VQE-C Configuration File Syntax and ParametersVQE-C System Configuration File Examples

libcli_telnet_port = 8182;tuner_list = ( { name = "tuner1"; url = "rtp://224.1.1.1:50000"; igmp_proxy_stb_if = "eth1"; igmp_proxy_stb_ip_address = "192.168.3.11";

});

3-46Cisco CDA Visual Quality Experience Client System Configuration Guide