Cisco Visual Quality Experience Application Configuration Guide
Advertisement
Advertisement
Cisco CDA Visual Quality Experience
Client System Configuration Guide
March 2015
Cisco Systems, Inc.
www.cisco.com
Cisco has more than 200 offices worldwide.
Addresses, phone numbers, and fax numbers are listed on the Cisco website at www.cisco.com/go/offices.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this
URL: www.cisco.com/go/trademarks . Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)
Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.
Cisco CDA Visual Quality Experience Client System Configuration Guide, Release 3.10
©2007–2015 Cisco Systems, Inc. All rights reserved.
Preface
Objectives
Document Revision History
Document Organization
Related Documentation
Document Conventions
Obtaining Documentation and Submitting a Service Request
VQE-C Configuration Overview
System Configuration File
Network Configuration File
VQE-C Deployment Guidance
Buffer Sizes and Delays
Reordering Only
Unicast Retransmission Error Repair Only
Forward Error Correction Only
FEC and Unicast Retransmission Error Repair
Buffer Size Constraint
Configuration Delivery Infrastructure
VQE-C Channel Configuration Delivery Server
Network Infrastructure
VQE-C
Initialization Updates
Background/Polled Updates
Triggered Updates
Remote Configuration Delivery Server
NAT Traversal
VQE-C Configuration File Syntax and Parameters
VQE-C System Configuration File Syntax
Basic Types
Cisco CDA Visual Quality Experience Client System Configuration Guide iii
Contents iv
Groups
3-2
Lists
3-2
Error Messages and Warnings
3-2
VQE-C Configuration Parameters: Usage Guidance
3-3
VQE-C Configuration Parameters: Reference Information
3-6
app_delay
3-6
app_paks_per_rcc
3-7
bye_delay
3-7
cdi_enable
3-8
channel_lineup
3-8
cli_ifname
3-8
deliver_paks_to_user
3-9
domain_name_override
3-9
error_repair_enable
3-10
error_repair_policer
3-11
error_repair_smart_request_enable
3-13
error_repair_repeat_request_enable
3-14
fastfill_enable
3-14
fec_enable
3-15
index_cfg_pathname
3-15
input_ifname
3-16
integrated_rtp_fallback
3-16
jitter_buff_size
3-16
libcli_telnet_port
3-17
log_level
3-17
max_fastfill
3-18
max_paksize
3-18
max_receive_bandwidth_hd
3-19
max_receive_bandwidth_hd_rcc
3-20
max_receive_bandwidth_sd
3-21
max_receive_bandwidth_sd_rcc
3-23
max_tuners
3-23
min_hd_stream_bitrate
3-23
nat_binding_refresh_interval
3-24
network_cfg_pathname
3-24
num_byes
3-25
output_pakq_limit
3-25
override_cfg_pathname
3-26
pakpool_size
3-26
pcr_restamp_enable
3-26
Cisco CDA Visual Quality Experience Client System Configuration Guide
Contents
qoe_enable
3-27
rcc_enable
3-27
rcc_extra_igmp_ip
3-29
rcc_max_concurrent
3-30
rcc_pakpool_max_pct
3-30
rcc_start_timeout
3-30
reorder_delay
3-31
reorder_delay_abs
3-31
repair_min_round_trip_time_abs
3-32
repair trigger point
3-32
repair_trigger_point_abs
3-33
rtcp_dscp_value
3-33
sig_mode
3-34
so_rcvbuf
3-34
src_ip_filter_enable
3-35
secured_vcds_port
3-35
secure_delivery_enable
3-36
ssl_certs_pathname
3-36
strip_rtp
3-36
stun_optimization
3-37
tuner_list
3-37
udp_passthru_support
3-40
update_interval_max
3-40
update_window
3-41
update_window
3-41
vcds_server_port
3-42
vqec_enable
3-42
viewership_enable
3-43
VQE-C System Configuration File Examples
3-43
Example 1: File with All Default Values
3-43
Example 2: Common Normal Configuration
3-44
Example 3: Another Common Normal Configuration
3-45
Example 4: Configuration for IGMP-Proxy
3-45
Cisco CDA Visual Quality Experience Client System Configuration Guide v
Contents vi
Cisco CDA Visual Quality Experience Client System Configuration Guide
Preface
This preface describes the objectives and organization of this document and explains how to find additional information on related products and services. This preface contains the following sections:
•
•
•
•
•
•
Document Revision History, page vii
Document Organization, page viii
Related Documentation, page ix
Obtaining Documentation and Submitting a Service Request, page x
Objectives
This document describes how to use the VQE Client (VQE-C) configuration parameters, which can be specified in a system configuration file and in a network configuration file.
Document Revision History
The Document Revision Table below records technical changes to this document. The table shows the document revision number for the change, the date of the change, and a brief summary of the change.
March 2015
August 2014
Introduction of a new system configuration parameter: ssl_certs_pathname, secured_vcds_port secure_delivery_enable in release
3.10
Introduction of a new system configuration parameter: pcr_restamp_enable, stun_optimization in release 3.9
Cisco CDA Visual Quality Experience Client System Configuration Guide
-vii
Preface
February 2014
July 2013
January 2011
October 2010
June 2010
February 2010
August 2009
April 2009
Introduction of a new system configuration parameter: viewership_enable
Introduction of three new system configuration parameters: error_repair_smart_request_enable, error_repair_repeat_request_enable and repair_min_round_trip_time_abs in
VQE Release 3.7.1
Support for modifying the parameter, log_level, by means of network or override configuration updates.
Support for UDP
1
RTP
and non-VQE
2
3
streams on the VQE-C. Support for multiple concurrent Rapid
Channel Changes.
Introduction of an new system configuration parameter, rcc_extra_igmp_ip, in VQE Release
3.5.4
Document for VQE Release 3.5
Document for VQE Release 3.4
Document for VQE Release 3.3
1.
UDP = user datagram protocol.
2.
VQE = visual quality experience.
3.
RTP = real-time transport protocol.
For information on the content and enhancements of each VQE release, see the relevant VQE release notes.
Document Organization
This publication is organized as follows:
Chapter
Chapter 1
Chapter 2
Chapter 3
Title Description
Provides overview information on VQE-C configuration.
Discusses some issues to consider when configuring and deploying
VQE-C.
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.
-viii
Cisco CDA Visual Quality Experience Client System Configuration Guide
Preface
Related Documentation
This section provides a list of documents and Cisco.com URLs for Cisco CDA Visual Quality
Experience, Release 3.10, and for the Cisco CDE110:
• Cisco CDA Visual Quality Experience Client System Command Reference Guide
•
•
•
•
•
Release Notes for Cisco CDA Visual Quality Experience Application, Release 3.10
Cisco CDA Visual Quality Experience Application User Guide, Release 3.10
Cisco Content Delivery Engine 205/220/250/420/470 Hardware Installation Guide
Regulatory Compliance and Safety Information for the Cisco Content Delivery Engines
•
•
•
Regulatory Compliance and Safety Information for the Cisco Content Delivery Engine 110
Open Source Used in Visual Quality Experience 3.10
Cisco CDA Visual Quality Experience Virtualization Guide
Cisco Content Delivery Engine 110 Hardware Installation Guide
In addition to Cisco CDA Visual Quality Experience Client System Configuration Guide (this document), other VQE Client (VQE-C) documents are included in the VQE-C software TAR file. If you are a registered Cisco.com user, the file can be downloaded from the following location: http://www.cisco.com/cisco/software/navigator.html
The following table lists the VQE-C documentation that is provided in the VQE-C software TAR file:
VQE-C Document Description
VQE-C Release Notes Provides
VQE-C System Integration Guide Provides on VQE-C components, architecture, integration, and APIs. Also includes a
VQE-C quick-start guide.
VQE-C CLI Command Reference Provides reference information on the VQE-C command-line interface.
Document Conventions
This guide uses the following conventions for command syntax descriptions and textual emphasis:
Convention boldface font italic font
[ ]
{ x | y | z }
[ x | y string
| z ]
Description
Commands and keywords are in boldface
Elements in square brackets are optional.
.
Arguments for which you supply values are in italics .
Alternative, mutually exclusive, keywords are grouped in braces and separated by vertical bars.
Optional alternative keywords are grouped in brackets and separated by vertical bars.
Nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks.
Cisco CDA Visual Quality Experience Client System Configuration Guide
-ix
Preface
Convention screen
font
Description
Terminal sessions and information the system displays are in screen
font.
boldface screen
font Information you must enter is in boldface screen
font.
italic screen font Arguments for which you supply values are in italic screen
font.
^
< >
The symbol ^ represents the key labeled Control—for example, the key combination ^D in a screen display means hold down the Control key while you press the D key.
Nonprinting characters, such as passwords, are in angle brackets in contexts where italics are not available.
[ ]
!, #
Default responses to system prompts are in square brackets.
An exclamation point ( ! ) or a pound sign ( # ) at the beginning of a line of code indicates a comment line.
Note Means reader take note . Notes contain helpful suggestions or references to materials not contained in this publication.
Tip Means the following information might help you solve a problem.
Caution Means reader be careful . In this situation, you might do something that could result in equipment damage or loss of data.
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, submitting a service request, and gathering additional information, see What’s New in Cisco Product Documentation at: http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
.
Subscribe to What’s New in Cisco Product Documentation , which lists all new and revised Cisco technical documentation, as an RSS feed and deliver content directly to your desktop using a reader application. The
RSS feeds are a free service.
-x
Cisco CDA Visual Quality Experience Client System Configuration Guide
C H A P T E R
1
VQE-C Configuration Overview
This chapter provides overview information on the VQE Client (VQE-C) configuration and contains the following topics:
•
System Configuration File, page 1-1
•
Network Configuration File, page 1-2
System Configuration File
The VQE-C system configuration file defines the start-up or “factory default” settings for VQE-C parameters as integrated into a particular platform. The file is text-based and may be edited by the
VQE-C integrator using a text editor. Some aspects of the contents of this configuration file and its processing are as follows:
• All parameters are optional. If a value is not given, the VQE-C assumes a default value for the parameter as defined in the software. The VQE-C parameter default values are documented in the
“VQE-C Configuration Parameters: Reference Information” section on page 3-6
. The parameters can also be displayed with the show system-config defaults CLI command.
•
•
If a parameter is assigned an invalid value within the file, an error message is logged upon its processing, the invalid value is ignored, and the VQE-C assumes its software default value for the parameter.
If a parameter is not recognized (for example, the parameter name is misspelled), it is ignored without an error or warning being generated.
• If the system configuration file is not syntactically valid, the file is not loaded. The VQE-C uses the software default values for all parameters in this scenario. For information about the configuration file syntax, see the
“VQE-C System Configuration File Syntax” section on page 3-1
.
The VQE-C must be supplied with the pathname of the system configuration file when the VQE-C is initialized (vqec_ifclient_init() API). This path may refer to read-only memory, as the VQE-C does not write to this file. If the file is writeable and any changes are made to the system configuration file after initialization, they do not affect the VQE-C until the VQE-C is reinitialized. For information on the vqec_ifclient_init() API, see VQE-C System Integration Guide .
The show system-config start-up CLI command may be used to display the contents of the system configuration file.
Cisco CDA Visual Quality Experience Client System Configuration Guide
1-1
Chapter 1 VQE-C Configuration Overview
Network Configuration File
Network Configuration File
The VQE-C can also read configuration from a second file called the network configuration file .
Parameter values within this network-supplied configuration file override any settings to matching parameters within the system configuration file. If a parameter is not specified in the network configuration file, the VQE-C uses one of the following:
• If a value for this parameter is present in the system configuration file, the VQE-C uses this value.
• If no value for this parameter is present in the system configuration file, VQE-C uses the VQE-C software default value.
To enable the VQE-C to use a network configuration file, the system configuration file must include a pathname for the network_cfg_pathname system configuration parameter. This pathname should refer to a location in writeable, nonvolatile storage (for example, flash memory) so that the file contents can be updated over the network and so that updates persist across a reboot.
Not all of the VQE-C configuration parameters are supported within a network configuration file. As examples, the channel_lineup and network_cfg_pathname parameters, which specify the location at which channel lineups and network configuration updates are stored, may not be updated.
Tip To find out whether assignments to a VQE-C parameter are supported within a network configuration file, see the Configurable with Network field for each parameter description in the
Configuration Parameters: Reference Information” section on page 3-6
.
Starting with VQE Release 3.4, the VQE-C is also capable of reading configuration from a third file called the override configuration file. Parameter values within this configuration file override any settings to matching parameters within either the system configuration or the network configuration files. If a parameter is not specified in the override configuration file, the VQE-C uses either the value from its network configuration, system configuration, or its software default value (in that order).
Note Override configurations are applicable to only those deployments where the necessary extensions have been made to STBs and the configuration deployment servers to support the delivery of override configuration files to a STB. For a more information on the deployment of override configurations, see
VQE-C System Integration Guide .
To enable the VQE-C to use an override configuration file, the system configuration file must include a pathname for the override_cfg_pathname system configuration parameter. This pathname should refer to a location in writeable, non-volatile storage (for example, flash memory) so that the file contents can be updated and so that updates persist across a reboot.
Not all VQE-C configuration parameters are supported within a network or override configuration file.
Tip To find out whether assignments to a VQE-C parameter are supported within a network or override configuration file, see the "Configurable with Network" and "Configurable as Override" fields for each parameter description in the
“VQE-C Configuration Parameters: Reference Information” section on page 3-6 .
1-2
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 1 VQE-C Configuration Overview
Network Configuration File
On initialization the VQE-C derives a "running configuration" by reading the system configuration file and merging those parameter values with the contents of the network configuration file (if one is present) and override configuration file (if one is present). The VQE-C services are initialized using this merged running configuration. After the initial STB initialization, any changes to the network configuration file or override configuration file are applied dynamically to the extent defined for each parameter.
For platforms that provide access to the VQE-C CLI, the show system-config network and the show system-config override CLI commands can be used to display the network configuration file and override configuration file contents, respectively. Only parameters present in the file and assigned valid values are displayed.
The show system-config command can be used to display the configuration currently running on the
VQE-C. This represents the configuration that is actually in use, as derived from merging the override configuration file, network configuration file, start-up configuration file, and the VQE-C software defaults (with highest-to-lowest precedence).
The network configuration file can be delivered in the following ways:
• By a platform specific delivery mechanism
• By the VQE-C itself if the configuration delivery infrastructure (CDI) is used
The override configuration can not be delivered via CDI. Therefore, a platform specific implementation is required.
For information about delivery of the network configuration file using the CDI, see the
Delivery Infrastructure” section on page 2-4 .
Cisco CDA Visual Quality Experience Client System Configuration Guide
1-3
Network Configuration File
Chapter 1 VQE-C Configuration Overview
1-4
Cisco CDA Visual Quality Experience Client System Configuration Guide
C H A P T E R
2
VQE-C Deployment Guidance
VQE Client is intended to be deployed on end-user equipment, such as set-top boxes. This chapter discusses some issues to consider when configuring and deploying VQE-C on such devices. It has the following sections:
•
Buffer Sizes and Delays, page 2-1
•
•
Configuration Delivery Infrastructure, page 2-4
Buffer Sizes and Delays
VQE-C default settings for buffer sizing and delays are designed to work out of the box for typical deployment scenarios. The information provided in this section explains the current operation of the jitter buffer. Some or all of these parameters may not be supported in future releases of the VQE-C. The buffering and timing used by the VQE-C for repairing and reordering packets can be configured based on the requirements of the deployment scenario. Some important factors to consider are the memory available to the VQE-C, CPU speed of the platform running the VQE-C, and round-trip latency between the VQE-C and the VQE Server (VQE-S).
Because the VQE-C offers two different active error repair strategies (Forward Error Correction [FEC] and Unicast Retransmission) and also provides packet reordering services for out-of-order packets, there are several different cases that should be considered when determining buffer sizes and delays. This section explains methods for configuring the VQE-C for each of these cases.
Be aware that these features are only operational when they are enabled on both the VQE-C and the
VQE-S, as specified by the Session Description Protocol (SDP) channel configurations being used. Also, regardless of other features that may or may not be enabled, reordering services are always provided by
VQE-C.
Note The following conventions apply to the diagrams in the succeeding sections:
– Grayed out blocks are shown for context and the sake of comparison between diagrams, but in function, these grayed out blocks do not exist for that particular case.
– Units for the quantities and horizontal axes are all in units of time (specified as milliseconds in the configuration of VQE-C).
Cisco CDA Visual Quality Experience Client System Configuration Guide
2-1
Chapter 2 VQE-C Deployment Guidance
Buffer Sizes and Delays
Reordering Only
Reordering only is the simplest case of buffer timing and delays because there are no error repair services. When error repair is not used on channels in the channel lineup, reordering of out-of-order packets is still available. If the VQE-C parameter integrated_rtp_fallback is set to TRUE, the VQE-C also provides reordering for Real-time Transport Protocol (RTP) streams not configured within the channel lineup.
illustrates buffer timing and delays when only reordering is used.
Figure 2-1
Incoming packets from source
VQE-C Buffer Timing and Delays: Reordering Only
A
FEC delay
B
Reorder delay
C
Jitter buffer size
Total delay
D
Packets going out to decoder
The VQE-C holds all received in-order packets for a duration of the length of the reorder delay. The reorder delay is specified with the VQE-C parameter reorder_delay_abs (a time period in milliseconds).
Any packets that arrive out-of-order within this time period are put into the correct order when they are played out to the decoder.
Unicast Retransmission Error Repair Only
When only Unicast Retransmission error repair is used on streams in the channel lineup, missing packets are fixed using retransmission-based error repair once per every repair interval.
illustrates buffer timing and delays when only Unicast Retransmission is used.
Figure 2-2
Incoming packets from source
VQE-C Buffer Timing and Delays: Unicast Retransmission Only
A
FEC delay
Jitter buffer size
B
Reorder delay
C Repair trigger point
Total delay
D
Packets going out to decoder
The error repair interval is specified with the VQE-C parameter repair_trigger_point_abs (a time period in milliseconds). The packets that the VQE attempts to fix during each error repair interval are those that have been known about for a time period greater than the reorder delay. In other words, the packets eligible to be fixed by Unicast Retransmission are those between points C and D in
that have not already been eligible during a previous repair interval. VQE does not attempt to fix the same missing packets more than once.
The jitter buffer must be sized large enough to allow the longest desired burst rate to be received. The calculation of the jitter buffer size must allow for all sources of error including scheduling delays on the processor. Precisely tuning the size of the jitter buffer is not recommended, but the size of the jitter buffer must be made large enough to allow time for repair packets to arrive at the oversubscription rate.
2-2
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 2 VQE-C Deployment Guidance
Buffer Sizes and Delays
For more information on the repair_trigger_point_abs and jitter_buff_size parameters, see the
“repair_trigger_point_abs” section on page 3-33 and the
“jitter_buff_size” section on page 3-16 .
Forward Error Correction Only
When only FEC is used, the effective length of the internal jitter buffer is equal to the duration of the reorder delay. The value of the jitter_buff_size parameter is ignored in this case.
illustrates buffer timing and delays when only FEC is used.
Figure 2-3
Incoming packets from source
VQE-C Buffer Timing and Delays: FEC Only
A
FEC delay
Total delay
B
Reorder delay
C
Jitter buffer size
D
Packets going out to decoder
FEC attempts to repair any missing packets, and if it fails, these packets cannot be sent to the decoder and are effectively played out as packet loss. It is determined that FEC has failed to fix a particular packet if the place for the missing packet has passed through the FEC delay (goes beyond point B in
without having been fixed.
The VQE-C calculates the FEC delay using the L and D values of the FEC scheme, and the average packet time of the stream. The average packet time is the average time that elapses between the reception of consecutive packets. FEC delay is calculated as follows:
FEC delay = (2 x L x D) x (average packet time)
In the preceding calculation, (2 x L x D) is the maximum range (in packets) in which FEC can recover missing packets.
FEC and Unicast Retransmission Error Repair
When Unicast Retransmission and FEC are used on streams in the channel lineup, FEC attempts to fix any missing packets in the primary stream. If FEC is not able to repair the packets, Unicast
Retransmission error repair attempts to fix them.
illustrates buffer timing and delays when
FEC and Unicast Retransmission are used.
Figure 2-4
Incoming packets from source
VQE-C Buffer Timing and Delays: FEC and Unicast Retransmission Error Repair
A
FEC delay
Jitter buffer size
Reorder delay
B C Repair trigger point
Total delay
D
Packets going out to decoder
Unicast Retransmission error repair is attempted once per error repair interval. It attempts to fix all missing packets that meet the following two conditions:
• FEC has failed to repair the missing packets.
Cisco CDA Visual Quality Experience Client System Configuration Guide
2-3
Chapter 2 VQE-C Deployment Guidance
Configuration Delivery Infrastructure
• Missing packets have been known about for a time period greater than the reorder delay.
Therefore, the packets eligible for Unicast Retransmission error repair are those that are still missing
between points C and D in Figure 2-4
.
Buffer Size Constraint
The sum of the time values of reorder delay, repair trigger time, and the round-trip time between the
VQE-C and the VQE-S must be less than the jitter buffer size. If the sum is not less, some gaps may not be fixed before being played out to the decoder. This constraint can be modeled by the equation:
(reorder delay) + (repair trigger time) + (round-trip time) < jitter buffer size
This equation represents the minimum requirement for successful error repair; however, the optimal configuration values are dependent on the given deployment. If the sum of the reorder delay, repair trigger time, and round-trip time are greater than the jitter buffer size for a particular deployment (that is, the minimum requirement is not met), this failure is observable as follows:
•
•
In this situation, the repair packets are not getting back to the VQE-C in time to be played out in the correct order.
To resolve this, you should make one or more of the following modifications to the configuration parameters:
•
•
Missing packets on the output of the VQE-C
“Late packet” counter in VQE-C is likely to increase over time
Reduce the value of reorder_delay_abs.
Reduce the value of repair_trigger_point_abs.
• Increase the value of jitter_buff_size.
When making modifications to these parameters, keep in mind how they affect timing and VQE-C memory use as explained in the preceding sections.
Configuration Delivery Infrastructure
The configuration delivery infrastructure (CDI) is used to deliver network and channel configuration information to the VQE Clients in a VQE system. Deploying the CDI requires the setup and configuration of one or more VQE-C Configuration Delivery Servers (VCDSs), network infrastructure
(for example, Domain Name System servers), and VQE-C devices.
The following sections describe the CDI setup and configuration.
Note In place of a VCDS server, an RTSP server that is compatible with the VQE CDI can be used. For simplicity, this discussion makes references only to VCDS.
VQE-C Channel Configuration Delivery Server
The VQE-C Channel Configuration Delivery Server (VCDS) is responsible for storing and delivering channel configuration files and network configuration files to the VQE-C devices. The network configuration files support group-based customization. Each device executing the VQE-C has a unique
2-4
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 2 VQE-C Deployment Guidance
Configuration Delivery Infrastructure identifier (for example, MAC address) that is included in the request to the VCDS. On the VCDS, a client database file associates each VQE-C unique identifier with a group identifier that specifies the set of attributes that should be applied to the VQE-C system configuration.
For example, the ability to provision VQE-C on a per-device basis could allow a service provider to partition devices into groups and provision the groups of devices as follows:
• One group with no VQE services enabled
•
•
One group with only Unicast Retransmission enabled
One group with only Rapid Channel Change enabled
• One group with both Unicast Retransmission and Rapid Channel Change enabled
For more information about the VCDS role in delivering network configuration files to VQE Clients, see the Cisco CDA Visual Quality Experience Application User Guide .
Network Infrastructure
Dynamic Host Configuration Protocol (DHCP) and DNS servers must be configured so that they work correctly with VCDS. For example, to learn the identities of the VCDS devices that supply configuration files to a VQE-C, a DNS server must be configured to return the VCDS server name to the VQE-C.
For details on the setup and configuration of a DNS server for VQE-C to use, see the Cisco CDA Visual
Quality Experience Application User Guide .
VQE-C
The VQE-C can be configured to use the configuration delivery infrastructure by setting the VQE-C parameter cdi_enable to TRUE. With cdi_enable set to TRUE, configuration updates are enabled and are configured further as follows:
• network_cfg_pathname—When this parameter is configured, the VQE-C attempts to retrieve network configuration updates from a VCDS, apply them during initialization, and cache them to the filesystem. When this parameter is not configured, the VQE-C does not retrieve or apply network configuration updates, relying on its system configuration file instead.
• channel_lineup—When this parameter is configured, the VQE-C attempts to cache channel updates to the filesystem. When this parameter is not configured, channel lineup updates are attempted, but are not cached to a file.
Initialization Updates
If configured to do so, the VQE-C attempts to retrieve updated network and channel configuration files during initialization. If an updated configuration is available, the VQE-C downloads the update from the
VCDS, writes it to a file (if applicable), and applies it before initializing. If the VCDS cannot be reached, or if the VQE-C already has the most up-to-date configuration in its cache, the cached network configuration and channel configuration is used during initialization.
Cisco CDA Visual Quality Experience Client System Configuration Guide
2-5
Chapter 2 VQE-C Deployment Guidance
NAT Traversal
Background/Polled Updates
Following initialization, the VQE-C can be configured to periodically poll a VCDS for configuration updates with the VQE-C parameter update_interval_max. The value of update_interval_max controls the frequency of the update attempts for both the network configuration file and channel configuration file.
The update_window parameter adds a small randomized component to the total interval between updates to prevent synchronization of updates within a network.
As with updates made during initialization, these background update requests are sent and any updates from VCDS cached for a particular configuration file (network or channel) depending on the values of the VQE-C parameters network_cfg_pathname and channel_lineup, respectively. Background network configuration and channel updates typically take effect for a channel the next time it is tuned by the STB.
For network configuration updates, see the "Changes Effective Upon" field of each parameter in the
“VQE-C Configuration Parameters: Usage Guidance” section on page 3-3 .
Triggered Updates
Update requests can be explicitly triggered when the VQE-C is asked to bind a tuner to a channel which is not present in its channel lineup. Updates can only be triggered in this situation if the update_interval_max parameter is set to 0.
Update requests may also be triggered if the VQE-C detects that an unexpected mismatch in the configuration file's checksum and original checksum provided during download. This triggered update only occurs if the index_cfg_pathname parameter has been configured.
In the case which a download configuration file's checksum does not match the checksum in the index file specified by the index_cfg_pathname, then the VQE-C does not use that configuration file.
Remote Configuration Delivery Server
Cisco’s VQE solution supports alternative mechanisms to the VCDS and the CDI for deploying channel and network configuration files that integrate with customized middleware of third-party vendors. From
Cisco’s VQE Channel Provisioning Tool (VCPT), it is possible to send channel configuration files to a remote server. Through integration with a middleware solution, a remote server can be used to distribute network and channel configuration files to the VQE-C. The remote server can also be extended to deploy override configuration file, containing per-subscriber configuration changes, to an external application on the STB that, in turn, delivers the override configuration file to the VQE-C.
NAT Traversal
VQE offers a NAT traversal solution that uses the STUN protocol. The use of this feature requires that the STUN server is enabled on the VQE-S host. To configure this feature, the VQE-C system configuration has two parameters (sig_mode and nat_binding_refresh_interval) that can be adjusted. By default, the NAT traversal feature is enabled and automatically deactivates itself if it discovers that it is not necessary—that there is not actually any NAT device between the VQE-C and VQE-S.
Note We highly recommend that the VQE-C be configured to run in NAT mode, whether or not there are plans for the presence of a NAT device in the deployment.
NAT traversal is controlled by the following VQE-C parameters:
2-6
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 2 VQE-C Deployment Guidance
NAT Traversal
•
• sig_mode—Specifies whether or not NAT mode should be enabled. If this parameter is not specified, the default is assumed to be NAT mode. The sig_mode parameter can be set to “STD” to disable this feature but doing so is not recommended in any scenario. In STD mode, VQE-C does not use any
STUN messages. NAT mode is not completely standards-compliant, whereas STD mode is entirely standards-based. nat_binding_refresh_interval—Specifies how often (in seconds) VQE-C performs a STUN transaction to learn about changes in NAT presence and configuration, as well as to keep the
NAT-traversing connections active. The default value of 30 seconds should be sufficient for nearly all NAT scenarios. In the case where there is no NAT device present, and sig_mode is set to "NAT", the value of nat_binding_refresh_interval is irrelevant as there is no recurring STUN transactions after the VQE-C discovers that there is no NAT device.
Cisco CDA Visual Quality Experience Client System Configuration Guide
2-7
NAT Traversal
Chapter 2 VQE-C Deployment Guidance
2-8
Cisco CDA Visual Quality Experience Client System Configuration Guide
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.
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-1
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C System Configuration File Syntax
Groups
For 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;
};
Lists
For 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 Warnings
Error 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-2
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Usage Guidance
VQE-C Configuration Parameters: Usage Guidance
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
cdi_enable channel_lineup cli_ifname
deliver_paks_to_user domain_name_override
.enable
.rate
.burst
error_repair_smart_request_enab le
error_repair_repeat_request_ena ble fastfill_enable
Useful to
System
Integrator
Useful to
IPTV
Service
Provider
X
X
X
X
X
X
X
X
X
X
X
X
X x x x
X
X
X
X
Affects
CDI
Behavior
Affects
Error
Repair
Service
X x
X
X
X
X
X
X
Affects
RCC
Service
X
X
X
Affects
FEC
Service
X
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-3
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Usage Guidance
Table 3-1 Guidance on VQE-C Parameter Usage (continued)
VQE-C Parameter
integrated_rtp_fallback jitter_buff_size
max_receive_bandwidth_sd_rcc max_tuners min_hd_stream_bitrate
nat_binding_refresh_interval network_cfg_pathname
override_cfg_pathname pakpool_size pcr_restamp_enable
rcc_max_concurrent rcc_pakpool_max_pct rcc_start_timeout
repair_min_round_trip_time_abs
repair_trigger_point_abs rtcp_dscp_value
src_ip_filter_enable secured_vcds_port
secure_delivery_enable ssl_certs_pathname strip_rtp
X
X
X
X
X
X
X
X
X
Useful to
System
Integrator
Useful to
IPTV
Service
Provider
X x
X
X
X
X
X x
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
Affects
CDI
Behavior
X
X
X
Affects
Error
Repair
Service
X
X
X
X
X
X
X
X
X
X
X
Affects
RCC
Service
Affects
FEC
Service
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
3-4
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Usage Guidance
Table 3-1
VQE-C Parameter
udp_passthru_support update_interval_max
Guidance on VQE-C Parameter Usage (continued)
Useful to
System
Integrator
Useful to
IPTV
Service
Provider
X
X
X
X
X
X
X
X X
Affects
CDI
Behavior
Affects
Error
Repair
Service
X
X x x
Affects
RCC
Service
Affects
FEC
Service
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-5
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-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
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Integer
0
0 to 60,000
TRUE
FALSE
Initialization
VQE Release 3.3.0 and later releases
3-6
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
app_paks_per_rcc
Determines 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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Release Information
Integer
1
1 to 20 in VQE Release 3.0 and later releases.
1 to 1000 in VQE Release 2.1.
FALSE
FALSE
VQE Release 3.0.0 and later releases
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
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Release Information
Integer
40
10 to 100
FALSE
FALSE
VQE Release 3.0.0 and later releases
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-7
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
cdi_enable channel_lineup
Specifies 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).
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Release Information
String
"" (null string)
0 to 255 characters
FALSE
FALSE
VQE Release 3.0.0 and later releases
cli_ifname
Indicates 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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Release Information
Boolean
FALSE
TRUE or FALSE
FALSE
FALSE
VQE Release 3.0.0 and later releases
Specifies 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.
3-8
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
String
"lo"
"*" or a valid interface name
TRUE
FALSE
Initialization
VQE Release 3.0.0 and later releases
deliver_paks_to_user
The 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 .
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Release Information
Boolean
TRUE
TRUE or FALSE
FALSE
FALSE
VQE Release 3.1.0 and later releases
domain_name_override
This 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
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-9
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Release Information
String
"" (null string)
0 to 255 characters
FALSE
FALSE
VQE Release 1.0.0 and later releases
error_repair_enable
Specifies whether or not Unicast Retransmission error repair is enabled by default when the VQE-C application is first run.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Boolean
TRUE
TRUE or FALSE
TRUE
TRUE in VQE Release 3.4 and later releases.
FALSE in VQE Release 3.3 and earlier releases.
Channel change in VQE Release 3.4 and later releases.
Initialization in VQE Release 3.3 and earlier releases.
VQE Release 1.0.0 and later releases
3-10
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
error_repair_policer
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Boolean
TRUE
TRUE or FALSE
TRUE
TRUE in VQE Release 3.4 and later releases.
FALSE in VQE Release 3.3 and earlier releases.
Channel change in VQE Release 3.4 and later releases.
Initialization in VQE Release 3.3 and earlier releases.
VQE Release 1.0.0 and later releases
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Boolean
TRUE
TRUE or FALSE
TRUE
TRUE in VQE Release 3.4 and later releases.
FALSE in VQE Release 3.3 and earlier releases.
Channel change in VQE Release 3.4 and later releases.
Initialization in VQE Release 3.3 and earlier releases.
VQE Release 1.0.0 and later releases
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).
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-11
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
Type
Default Value
Range of Allowed Values
Configurable as Override
Boolean
FALSE
TRUE or FALSE
FALSE
Channel change in VQE Release 3.4 and later releases.
Initialization in VQE Release 3.3 and earlier releases.
VQE Release 2.1.0 and later releases
Changes Effective Upon
Release 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.
Type
Default Value
Range of Allowed Values
Configurable as Override
Changes Effective Upon
Release Information
Integer
5
1 to 100
FALSE
Channel change in VQE Release 3.4 and later releases.
Initialization in VQE Release 3.3 and earlier releases.
VQE Release 2.1.0 and later releases 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
Default Value
Range of Allowed Values
Configurable as Override
Changes Effective Upon
Release Information
Integer
10,000 milliseconds
1 to 60,000 milliseconds
FALSE
Channel change in VQE Release 3.4 and later releases.
Initialization in VQE Release 3.3 and earlier releases.
VQE Release 2.1.0 and later releases
3-12
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-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_enable
This 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
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Boolean
FALSE
TRUE or FALSE
TRUE
FALSE
Channel change
VQE Release 3.7.1 and later releases.
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
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-13
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-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_enable
This 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
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Boolean
FALSE
TRUE or FALSE
TRUE
FALSE
Channel change
VQE Release 3.7.1 and later releases
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
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Boolean
TRUE
TRUE or FALSE
TRUE
FALSE
3-14
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
Changes Effective Upon
Release Information
VQE-C Configuration Parameters: Reference Information
Channel change in VQE Release 3.4 and later releases.
Initialization in VQE Release 3.3 and earlier releases.
VQE Release 3.2.1 and later releases
fec_enable
Controls 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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Boolean
TRUE
TRUE or FALSE
TRUE
TRUE in VQE Release 3.4 and later releases.
FALSE in VQE Release 3.3 and earlier releases.
Channel Change in VQE Release 3.4 and later releases.
Initialization in VQE Release 3.3 and earlier releases.
VQE Release 2.1.0 and later releases
index_cfg_pathname
Specifies 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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Release Information
String
"" (null string)
0 to 255 characters
FALSE
FALSE
VQE Release 3.4 and later releases
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-15
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
input_ifname
The 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.)
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Release Information
String
""(null string) null string or an interface name
FALSE
FALSE
VQE Release 1.0.0 and later releases
integrated_rtp_fallback
This 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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Release Information
Boolean
TRUE
TRUE or FALSE
FALSE
FALSE
VQE Release 3.5.5 and later releases
jitter_buff_size
The 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.
3-16
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Integer
200
0 to 20,000
TRUE
TRUE in VQE Release 3.4 and later releases.
FALSE in VQE Release 3.3 and earlier releases.
Channel change in VQE Release 3.4 and later releases.
Initialization in VQE Release 3.3 and earlier releases.
VQE Release 1.0.0 and later releases
libcli_telnet_port
The 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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Integer
0
8000 to 65,535
TRUE
FALSE
Initialization
VQE Release 1.0.0 and later releases
log_level
Controls 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
Default Value
Range of Allowed Values
Configurable with Network
Integer
4
0 to 7
TRUE in VQE Release 3.5.6 and later releases. FALSE in VQE
Release 3.5.5 and earlier releases.
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-17
VQE-C Configuration Parameters: Reference Information
Configurable as Override
Changes Effective Upon
Release Information
Chapter 3 VQE-C Configuration File Syntax and Parameters
TRUE in VQE Release 3.5.6 and later releases. FALSE in VQE
Release 3.5.5 and earlier releases.
Initialization
VQE Release 1.0.0 and later releases
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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Integer
0
0 to 1,000,000,000
TRUE
FALSE
Channel change in VQE Release 3.4 and later releases.
Initialization in VQE Release 3.3 and earlier releases.
VQE Release 3.3.0 and later releases
max_paksize
The 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.
Type
Default Value
Integer
1508
3-18
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
1330 to 10,000
TRUE
FALSE
Initialization
VQE Release 1.0.0 and later releases
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%.
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-19
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-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 .
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Integer
0
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.
TRUE
TRUE in VQE Release 3.4 and later releases.
FALSE in VQE Release 3.3 and earlier releases.
Channel change in VQE Release 3.4 and later releases.
Initialization in VQE Release 3.3 and earlier releases.
VQE Release 3.3.0 and later releases
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
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Integer
0
0 to 1,000,000,000
TRUE
TRUE
Channel change
VQE Release 3.4 and later releases
3-20
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-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.
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-21
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-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
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Integer
0
0 to 1,000,000,000
TRUE
TRUE in VQE Release 3.4 and later releases.
FALSE in VQE Release 3.3 and earlier releases.
Channel change in VQE 3.4 and later releases.
Initialization in VQE 3.3 and earlier releases.
VQE Release 3.3.0 and later releases
3-22
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Integer
0
0 to 1,000,000,000
TRUE
TRUE
Channel change
VQE Release 3.4 and later releases
max_tuners
The 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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Release Information
Integer
1
1 to 32
FALSE
FALSE
VQE Release 1.0.0 and later releases
min_hd_stream_bitrate
Specifies 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.
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-23
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Integer
0
0 to 1,000,000,000
TRUE
TRUE in VQE Release 3.4 and later releases.
FALSE in VQE Release 3.3 and earlier releases.
Channel change in VQE Release 3.4 and later releases.
Initialization in VQE Release 3.3 and earlier releases.
VQE Release 3.3.0 and later releases
nat_binding_refresh_interval
The 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).
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Integer
30
0 to 100,000
TRUE
FALSE
Initialization
VQE Release 1.0.0 and later releases
network_cfg_pathname
The 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.
3-24
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Release Information
String
"" (null string)
0 to 255 characters
FALSE
FALSE
VQE Release 3.3.0 and later releases
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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Release Information
Integer
2
2 to 5
FALSE
FALSE
VQE Release 3.0.0 and later releases
output_pakq_limit
The limit on the size (in packets) of the output packet queue.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Integer
200
100 to 20,000
TRUE
FALSE
Initialization
VQE Release 1.0.0 and later releases
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-25
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
override_cfg_pathname
Specifies 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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Release Information
String
"" (null string)
1 to 255 characters
FALSE
FALSE
VQE Release 3.4 and later releases
pakpool_size
The 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 .
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Integer
1000
100 to 200,000
TRUE
FALSE
Initialization
VQE Release 1.0.0 and later releases
pcr_restamp_enable
This 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.
3-26
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Boolean
FALSE
TRUE or FALSE
TRUE
FALSE
Channel change
VQE Release 3.9 and later releases
qoe_enable
Indicates 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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Boolean
TRUE
TRUE or FALSE
TRUE
TRUE
Initialization
VQE Release 1.0.0 and later releases.
rcc_enable
Controls 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.
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-27
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-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-28
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Boolean
TRUE
TRUE or FALSE
TRUE
TRUE in VQE Release 3.4 and later releases.
FALSE in VQE Release 3.3 and earlier releases.
Initialization in VQE Release 3.3 and earlier releases.
Channel change in VQE Release 3.4 and later releases.
VQE Release 3.0.0 and later releases
rcc_extra_igmp_ip
Specifies 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
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
String
"" (null string)
0 to 255 characters
TRUE
TRUE
Channel change.
VQE Release 3.5.4 and later releases
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-29
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
rcc_max_concurrent
The 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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Integer
1
0 to 32
TRUE
FALSE
Initialization
VQE Release 3.5.5 and later releases
rcc_pakpool_max_pct
Specifies the maximum pakpool percentage allocated to RCC.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Release Information
Integer
80
0 to 100
FALSE
FALSE
VQE Release 3.3 and later releases
rcc_start_timeout
Controls 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
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Integer
120
0 to 1000
TRUE
FALSE
Initialization
VQE Release 3.0.0 and later releases.
3-30
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
reorder_delay
Specifies 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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Release Information
Integer
20
0 to 100
FALSE
FALSE
VQE Release 2.1.2 and later releases.
reorder_delay_abs
Specifies 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
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Integer
20
0 to 200
TRUE
FALSE
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-31
VQE-C Configuration Parameters: Reference Information
Changes Effective Upon
Release Information
Chapter 3 VQE-C Configuration File Syntax and Parameters
Channel change in VQE Release 3.4 and later releases.
Initialization in VQE Release 3.3 and earlier releases.
VQE Release 2.1.0 and later releases
repair_min_round_trip_time_abs
Specifies 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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Integer
0
0 to 3000
TRUE
FALSE
Channel change
VQE Release 3.7.1 and later releases.
repair trigger point
The 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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Integer
30
0 to 100
FALSE
3-32
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
Configurable as Override
Release Information
VQE-C Configuration Parameters: Reference Information
FALSE
VQE Release 1.0.0 and later releases
repair_trigger_point_abs
The 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
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Integer
20
0 to 200
TRUE
FALSE
Initialization in VQE Release 3.3 and earlier releases.
Channel change in VQE Release 3.4 and later releases.
VQE Release 1.0.0 and later releases
rtcp_dscp_value
Specifies 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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Integer
24
0 to 63
TRUE
FALSE
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-33
VQE-C Configuration Parameters: Reference Information
Changes Effective Upon
Release Information
Chapter 3 VQE-C Configuration File Syntax and Parameters
Channel change in VQE Release 3.4 and later releases.
Initialization in VQE Release 3.3 and earlier releases.
VQE Release 3.0.0 and later releases
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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
String
NAT
NAT or STD
TRUE
FALSE
Initialization
VQE Release 1.0.0 and later releases
so_rcvbuf
The size (in bytes) of the receive buffer to use when opening the VQE-C receive socket.
Type
Default Value
Range of Allowed Values
Configurable with Network
Integer
128,000
0 to 1,000,000
TRUE
3-34
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
Configurable as Override
Changes Effective Upon
Release Information
VQE-C Configuration Parameters: Reference Information
FALSE
Channel change in VQE Release 3.4 and later releases.
Initialization in VQE Release 3.3 and earlier releases.
VQE Release 1.0.0 and later releases
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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Boolean
FALSE
TRUE or FALSE
TRUE
FALSE
Initialization
VQE Release 3.3.0 and later releases
secured_vcds_port
This 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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective upon
Release Information
Integer
8443
1024 to 65,535
FALSE
FALSE
Initialization
VQE Release 3.10 and later releases
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-35
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
secure_delivery_enable
Indicates 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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Boolean
FALSE
TRUE or FALSE
FALSE
FALSE
Initialization
VQE Release 3.10 and later releases
ssl_certs_pathname
The 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.
Type String
Default Value
Range of Allowed Values
“” (null string)
0 to 255 characters
Configurable with Network FALSE
Configurable as Override FALSE
Release Information VQE Release 3.10 and later releases
strip_rtp
Indicates 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
Default Value
Range of Allowed Values
Boolean
TRUE
TRUE or FALSE
3-36
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
Type Boolean
Configurable with Network FALSE
Configurable as Override FALSE
Release Information VQE Release 1.0.0 and later releases
stun_optimization
This 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.
Type
Default Value
Boolean
TRUE
Range of Allowed Values TRUE or FALSE
Configurable with Network FALSE
Configurable as Override
Changes Effective Upon
FALSE
Initialization
Release Information VQE Release 3.6.3 and later releases
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.
Type
Default Value
String
None
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-37
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
Range of Allowed Values
Release Information
0 to 255 characters
VQE Release 1.0.0 and later releases url
The channel URL that this tuner is bound ("tuned") to upon startup.
Type String
Default Value None
Range of Allowed Values 0 to 255 characters
Release Information VQE Release 1.0.0 and later releases 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.
Type
Default Value
String
"" (null string)
Range of Allowed Values Any interface, or the null string
Release Information VQE Release 1.0.0 and later releases stream_output_url
The destination URL to send an output video stream.
Type String
Default Value None *
Range of Allowed Values 0 to 255 characters
Release Information VQE Release 1.0.0 and later releases
* 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.
Type
Default Value
Integer
0
Range of Allowed Values 0 to 1,000,000,000
Release Information VQE Release 3.3.0 and later releases
3-38
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-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.
Type
Default Value
Integer
0
Range of Allowed Values 0 to 1,000,000,000
Release Information VQE Release 3.3.0 and later releases
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.
Type
Default Value
Range of Allowed Values
Release Information
String
None
0 to 255
VQE Release 3.1.0 and later releases igmp_proxy_stb_ip_address
IP address of the STB. An address of "0.0.0.0" disables IGMP Proxy for the tuner.
Type String
Default Value none
Range of Allowed Values 0 to 255 characters
Release Information VQE Release 3.1.0 and later releases
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-39
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-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_support
This 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
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Release Information
Boolean
FALSE
TRUE or FALSE
FALSE
FALSE
VQE Release 3.5.5 and later releases
update_interval_max
Maximum 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).
3-40
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Integer
3600
The value 0, or a value in the range 30 to 604,800
TRUE
FALSE
Immediate in VQE Release 3.4 and later releases.
Initialization in VQE Release 3.3 and earlier releases.
VQE Release 3.0.0 and later releases
update_window
The 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
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Integer
60
1 to 100,000
TRUE
FALSE
Immediate in VQE Release 3.4 and later releases.
Initialization in VQE Release 3.3 and earlier releases.
VQE Release 1.0.0 and later releases
update_window
The 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
Default Value
Range of Allowed Values
Integer
60
1 to 100,000
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-41
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C Configuration Parameters: Reference Information
Type
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Integer
TRUE
FALSE
Immediate in VQE Release 3.4 and later releases.
Initialization in VQE Release 3.3 and earlier releases.
VQE Release 1.0.0 and later releases
vcds_server_port
This 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.
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Release Information
Integer
8554
1054 to 65,535
FALSE
FALSE
VQE Release 2.1.2 and later releases
vqec_enable
Indicates 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
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Boolean
TRUE
TRUE or FALSE
TRUE
FALSE
Initialization
VQE Release 1.0.0 and later releases.
3-42
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-C System Configuration File Examples
viewership_enable
Indicates 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
Type
Default Value
Range of Allowed Values
Configurable with Network
Configurable as Override
Changes Effective Upon
Release Information
Boolean
FALSE
TRUE or FALSE
TRUE
FALSE
Initialization
VQE Release 3.8 and later releases.
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;
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-43
VQE-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 = false error_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;
Chapter 3 VQE-C Configuration File Syntax and Parameters
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-44
Cisco CDA Visual Quality Experience Client System Configuration Guide
Chapter 3 VQE-C Configuration File Syntax and Parameters 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";
}
);
VQE-C System Configuration File Examples
Example 3: Another Common Normal Configuration
In 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;
Cisco CDA Visual Quality Experience Client System Configuration Guide
3-45
Chapter 3 VQE-C Configuration File Syntax and Parameters
VQE-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-46
Cisco CDA Visual Quality Experience Client System Configuration Guide
Download
Public link updated
The public link to your chat has been updated. You may view and manage your chat links after registration here.
Document public link
Advertisement