Broadband Forum

    DATA MODEL DEFINITION


TR-069 STBService:1.0 Service Object definition
tr-135-1-0-0.xml

License

Copyright (c) 2009-2017, Broadband Forum

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The above license is used as a license under copyright only. Please reference the Forum IPR Policy for patent licensing terms <https://www.broadband-forum.org/ipr-policy>.

Any moral rights which are necessary to exercise under the above license grant are also deemed granted under this license.

Table of Contents

Data Types

The Parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. These data types and the named data types used by this specification are described below.

Note: A Parameter that is defined to be one of the named data types is reported as such at the beginning of the Parameter's description via a reference back to the associated data type definition (e.g. [MacAddress]). However, such parameters still indicate their SOAP data type.

Data Type Base Type Description
Alias string(64)

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
Dbm1000 int The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.
IEEE_EUI64 string(23)

The IEEE EUI 64-bit identifier as defined in [EUI64]. The IEEE defined 64-bit extended unique identifier (EUI-64) is a concatenation of:

  • The 24-bit (OUI-24) or 36-bit (OUI-36) company_id value assigned by the IEEE Registration Authority (IEEE-RA), and
  • The extension identifier (40 bits for OUI-24 or 28 bits for OUI-36) assigned by the organization with that company_id assignment.

Possible patterns:

  • <Empty> (an empty string)
  • ([0-9A-Fa-f][0-9A-Fa-f]:){7}([0-9A-Fa-f][0-9A-Fa-f])
IPAddress string(45)

IP address, i.e. IPv4 address (or IPv4 subnet mask) or IPv6 address.

All IPv4 addresses and subnet masks MUST be represented as strings in IPv4 dotted-decimal notation. Here are some examples of valid IPv4 address textual representations:

  • 216.52.29.100
  • 192.168.1.254

All IPv6 addresses MUST be represented using any of the 3 standard textual representations defined in [RFC4291] Sections 2.2.1, 2.2.2 and 2.2.3. Both lower-case and upper-case letters can be used, but use of lower-case letters is RECOMMENDED. Here are some examples of valid IPv6 address textual representations:

  • 1080:0:0:800:ba98:3210:11aa:12dd
  • 1080::800:ba98:3210:11aa:12dd
  • 0:0:0:0:0:0:13.1.68.3

IPv6 addresses MUST NOT include zone identifiers. Zone identifiers are discussed in [Section 6/RFC4007].

Unspecified or inapplicable addresses (or IPv4 subnet masks) MUST be represented as empty strings unless otherwise specified by the parameter definition.

IPPrefix string(49)

IPv4 or IPv6 routing prefix in Classless Inter-Domain Routing (CIDR) notation [RFC4632]. This is specified as an IP address followed by an appended "/n" suffix, where n (the prefix size) is an integer in the range 0-32 (for IPv4) or 0-128 (for IPv6) that indicates the number of (leftmost) '1' bits of the routing prefix.

  • IPv4 example: 192.168.1.0/24
  • IPv6 example: 2001:edff:fe6a:f76::/64

If the IP address part is unspecified or inapplicable, it MUST be an empty string unless otherwise specified by the parameter definition. In this case the IP prefix will be of the form "/n".

If the entire IP prefix is unspecified or inapplicable, it MUST be an empty string unless otherwise specified by the parameter definition.

IPv4Address IPAddress(15)

IPv4 address (or subnet mask).

Can be any IPv4 address that is permitted by the IPAddress data type.

IPv4Prefix IPPrefix(18)

IPv4 address prefix.

Can be any IPv4 prefix that is permitted by the IPPrefix data type.

IPv6Address IPAddress(45)

IPv6 address.

Can be any IPv6 address that is permitted by the IPAddress data type.

IPv6Prefix IPPrefix(49)

IPv6 address prefix.

Can be any IPv6 prefix that is permitted by the IPPrefix data type.

MACAddress string(17)

All MAC addresses are represented as strings of 12 hexadecimal digits (digits 0-9, letters A-F or a-f) displayed as six pairs of digits separated by colons. Unspecified or inapplicable MAC addresses MUST be represented as empty strings unless otherwise specified by the parameter definition. Possible patterns:

  • <Empty> (an empty string)
  • ([0-9A-Fa-f][0-9A-Fa-f]:){5}([0-9A-Fa-f][0-9A-Fa-f])
StatsCounter32 unsignedInt

A 32-bit statistics parameter, e.g. a byte counter.

This data type SHOULD NOT be used for statistics parameters whose values might become greater than the maximum value that can be represented as an unsignedInt (i.e. 0xffffffff, referred to below as maxval). StatsCounter64 SHOULD be used for such parameters.

The value maxval indicates that no data is available for this parameter. In the unlikely event that the actual value of the statistic is maxval, the CPE SHOULD return maxval - 1.

The actual value of the statistic might be greater than maxval. Such values SHOULD wrap around through zero.

The term packet is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame.

StatsCounter64 unsignedLong

A 64-bit statistics parameter, e.g. a byte counter.

This data type SHOULD be used for all statistics parameters whose values might become greater than the maximum value that can be represented as an unsignedInt.

The maximum value that can be represented as an unsignedLong (i.e. 0xffffffffffffffff) indicates that no data is available for this parameter.

The term packet is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame.

UUID string(36:36)

Universally Unique Identifier. See [RFC4122]. Possible patterns:

  • [A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}
ZigBeeNetworkAddress string(4)

The ZigBee 16-bit network address (NWK) as defined in [ZigBee2007]. The address is assigned to a device by the network layer and used by the network layer for routing messages between devices. Possible patterns:

  • <Empty> (an empty string)
  • ([0-9A-Fa-f]){4}
base64 -

Base64 encoded binary (no line-length limitation).

A minimum and maximum allowed length can be indicated using the form base64(Min:Max), where Min and Max are the minimum and maximum length in characters before Base64 encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in base64(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges.

boolean - Boolean, where the allowed values are 0 or 1 (or equivalently, true or false).
dateTime - The subset of the ISO 8601 date-time format defined by the SOAP dateTime type.
hexBinary -

Hex encoded binary.

A minimum and maximum allowed length can be indicated using the form hexBinary(Min:Max), where Min and Max are the minimum and maximum length in characters before Hex Binary encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in hexBinary(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges.

int -

Integer in the range -2147483648 to +2147483647, inclusive.

For some int types, a value range is given using the form int[Min:Max] or int[Min:Max step Step] where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

long -

Long integer in the range -9223372036854775808 to 9223372036854775807, inclusive.

For some long types, a value range is given using the form long[Min:Max] or long[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

object - A container for parameters and/or other objects. The full Path Name of a parameter is given by the parameter name appended to the full Path Name of the object it is contained within.
string - For strings, a minimum and maximum allowed length can be indicated using the form string(Min:Max), where Min and Max are the minimum and maximum string length in characters. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in string(Max). Multiple comma-separated ranges can be specified, in which case the string length will be in one of the ranges.
unsignedInt -

Unsigned integer in the range 0 to 4294967295, inclusive.

For some unsignedInt types, a value range is given using the form unsignedInt[Min:Max] or unsigned[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

unsignedLong -

Unsigned long integer in the range 0 to 18446744073709551615, inclusive.

For some unsignedLong types, a value range is given using the form unsignedLong[Min:Max] or unsignedLong[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

References

[AC-3] E-AC-3, Digital Audio Compression (AC-3) Standard, Rev. B, document number A/52B, ATSC, June 2005.
[D-Book] DGTVi D-Book v1.0, Compatible receivers for the Italian market, Sep 2004.
[ISO/IEC11172-1] ISO/IEC 11172-1 (1993), Information Technology - Coding of moving pictures and associated audio for digital storage media at up to about 1.5 Mbit/s - Part 1: System, ISO/IEC, 1993.
[ISO/IEC11172-3] ISO/IEC 11172-3 (1993), Information Technology - Coding of moving pictures and associated audio for digital storage media at up to about 1.5 Mbit/s - Part 3: Audio, ISO/IEC, 1993.
[ISO/IEC13818-1] ISO/IEC 13818-1 (2nd edition, 2000), Information technology - Generic coding of moving picture and associated audio information: Systems, ISO/IEC, 2000.
[ISO/IEC13818-3] ISO/IEC 13818-3 (2nd edition, 1998), Information technology - Generic coding of moving picture and associated audio information: Audio, ISO/IEC, 1998.
[ISO/IEC13818-6] ISO/IEC 13818-6 (2nd edition, 1998), Information technology - Generic coding of moving picture and associated audio information: Extensions for DSM-CC, ISO/IEC, 1998.
[ISO/IEC14496-3] ISO/IEC 14496-3:2001, Information technology - Coding of Audio-Visual objects - Part 3: Audio, ISO/IEC, 2001.
[ISO/IEC14496-10] ITU-T Rec. H.264 | ISO/IEC 14496-10:2004/AM 1, Part 10, Advanced Video Coding AMENDMENT 1: AVC fidelity range extensions, ISO/IEC, 2004.
[ISO/IEC23003-1] ISO/IEC 23003-1:2007, Information technology - MPEG audio technologies - Part 1: MPEG Surround, ISO/IEC, 2007.
[RFC1350] RFC 1350, The TFTP Protocol (Revision 2), IETF.
[RFC2228] RFC 2228, FTP Security Extensions, IETF.
[RFC2326] RFC 2326, Real Time Streaming Protocol (RTSP), IETF.
[RFC2960] RFC 2960, Stream Control Transmission Protocol (SCTP), IETF.
[RFC3066] RFC 3066, Tags for the Identification of Languages, IETF.
[RFC3376] RFC 3376, Internet Group Management Protocol (IGMP) Version 3, IETF.
[RFC3550] RFC 3550, RTP: A Transport Protocol for Real-Time Applications, IETF, July 2003.
[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[RFC4340] RFC 4340, Datagram Congestion Control Protocol (DCCP), IETF.
[RFC4585] RFC 4585, Extended RTP Profile for Real-time Transport Control Protocol (RTCP)-Based Feedback (RTP/AVPF), IETF.
[RFC4588] RFC 4588, RTP Retransmission Packet Format, IETF.
[RFC4632] RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006.
[SMPTE20022-1] SMPTE 20022-1 Application Layer Forward Error Correction.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[SSH-FTP] SSH File Transfer Protocol.
[TR-069a4] TR-069 Amendment 4, CPE WAN Management Protocol, Broadband Forum, 2011.
[TR-106a1] TR-106 Amendment 1, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2006.
[TR-135] TR-135, Data Model for a TR-069 Enabled STB, Broadband Forum.
[TR-140] TR-140, TR-069 Data Model for Storage Service Devices, Broadband Forum.
[TS102034] ETSI TS 102 034, Digital Video Broadcasting (DVB); Transport of MPEG-2 Based DVB Services, ETSI.
[VC-1] SMPTE VC-1, Compressed Video Bitstream Format and Decoding Process, document number 421M, SMPTE, Television, 2006.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

STBService:1.0 Data Model

Name Type Write Description Object Default Version
STBServiceNumberOfEntries unsignedInt - Number of entries in the STBService table. - 1.0
STBService.{i}. object - The top-level object for an STB CPE. - 1.0
Enable boolean W Enables or disables this STBService instance. - 1.0
STBService.{i}.Capabilities. object - The overall capabilities of the STB CPE. This is a constant read-only object, meaning that only a firmware update will cause these values to be altered. - 1.0
MaxActiveAVStreams int­[-1:] -

Maximum number of simultaneously active AV streams supported by the STB.

A value of -1 indicates no specific limit on the number of active streams.

A value of 0, while not strictly illegal, would indicate an STB that doesn't support AV streams, which is extremely unlikely.

- 1.0
MaxActiveAVPlayers int­[-1:] -

Maximum number of simultaneously active AV players supported by the STB. An AV player is associated with a presentation device (such as a TV set).

Note that this is the strict maximum but, depending on the AV streams to be decoded, a given STB may not always have the resources to run all of these AV players, e.g. it might be able to decode one main picture and one PIP in standard definition, but just a main picture and no PIP in high definition.

A value of -1 indicates no specific limit on the number of active players.

A value of 0, while not strictly illegal, would indicate an STB that doesn't support AV players, which is extremely unlikely.

- 1.0
STBService.{i}.Capabilities.FrontEnd. object - Front-end capabilities. - 1.0
STBService.{i}.Capabilities.FrontEnd.DVBT. object - Capabilities of the DVB-T receiver. - 1.0
MaxActiveDVBTStreams int­[-1:] -

Maximum number of simultaneous active AV streams supported by the DVB-T FrontEnd.

A value of -1 indicates no specific limit on the number of active streams.

- 1.0
MaxLogicalChannels int­[-1:] -

Maximum number of logical channels that can be contained in a Service List Database.

A value of -1 indicates no specific limit on the number of logical channels.

- 1.0
STBService.{i}.Capabilities.FrontEnd.IP. object - IP front-end capabilities. - 1.0
MaxActiveIPStreams int­[-1:] -

Maximum number of simultaneous active AV streams supported by the IP FrontEnd.

A value of -1 indicates no specific limit on the number of active streams.

- 1.0
MaxActiveInboundIPStreams int­[-1:] -

Maximum number of simultaneous active Inbound AV streams supported by the IP FrontEnd.

A value of -1 indicates no specific limit on the number of active streams.

- 1.0
MaxActiveOutboundIPStreams int­[-1:] -

Maximum number of simultaneous active Outbound AV streams supported by the IP FrontEnd.

A value of -1 indicates no specific limit on the number of active streams.

- 1.0
StreamingControlProtocols string -

Comma-separated list of strings. Supported streaming control protocols. Each list item is an enumeration of:

- 1.0
StreamingTransportProtocols string -

Comma-separated list of strings. Network protocols supported for AV streaming. Each list item is an enumeration of:

- 1.0
StreamingTransportControlProtocols string -

Comma-separated list of strings. Transport control protocols supported for AV streaming in combination with RTP. Each list item is an enumeration of:

- 1.0
DownloadTransportProtocols string -

Comma-separated list of strings. Network protocols supported for AV download. Each list item is an enumeration of:

- 1.0
MultiplexTypes string -

Comma-separated list of strings. AV multiplex types supported by the front end. Each list item is an enumeration of:

- 1.0
MaxDejitteringBufferSize int­[-1:] -

Describes the maximum de-jittering buffer size, in bytes, supported by the STB.

A value of -1 indicates no specific limit on the buffer size.

- 1.0
STBService.{i}.Capabilities.PVR. object - PVR capabilities. - 1.0
MaxIOStreams int­[-1:] -

Maximum number of AV streams that the PVR can simultaneously record.

A value of -1 indicates no specific limit on the number of streams.

- 1.0
MaxRecordingStreams int­[-1:] -

Maximum number of AV streams that the PVR can simultaneously record.

A value of -1 indicates no specific limit on the number of streams.

- 1.0
MaxPlaybackStreams int­[-1:] -

Maximum number of AV streams that the PVR can simultaneously play back.

A value of -1 indicates no specific limit on the number of streams.

- 1.0
MaxTimeDelay int­[-1:] -

Maximum time delay, in seconds, that the PVR time-shift mode can support.

A value of -1 indicates no specific limit on the time delay.

- 1.0
STBService.{i}.Capabilities.AudioDecoder. object - Audio decoder capabilities. - 1.0
AudioStandards string -

Comma-separated list of strings. Audio standards supported by this STB. Each list item is an enumeration of:

- 1.0
STBService.{i}.Capabilities.VideoDecoder. object - Video decoder capabilities. - 1.0
VideoStandards string -

Comma-separated list of strings. Video standards supported by this STB. Each list item is an enumeration of:

- 1.0
STBService.{i}.Capabilities.VideoDecoder.MPEG2Part2. object - Object describing the set of supported MPEG2 profiles and levels for this STB. It also describes the set of audio standards supported when MPEG2 Part 2 is used as the video standard. - 1.0
AudioStandards string - Comma-separated list of strings. Each list item MUST be a member of the list reported by the Capabilities.AudioDecoder.AudioStandards parameter. Audio Standards supported by the Player when associated with MPEG2 Part 2 Video. - 1.0
ProfileLevelNumberOfEntries unsignedInt - Number of instances of ProfileLevel. - 1.0
STBService.{i}.Capabilities.VideoDecoder.MPEG2Part2.ProfileLevel.{i}. object -

Table to describe the set of profiles and levels combinations supported by the STB when MPEG2 Part 2 is used as video standard.

At most one entry in this table can exist with the same values for Profile and Level. The table MUST include a distinct entry for each supported combination of these parameters.

- 1.0
Profile string -

Identifier of the MPEG2 Part 2 profile. Enumeration of:

  • SP (Simple Profile)
  • MP (Main Profile)
  • SNR (SNR Scalable)
  • Spt (Spatially Scalable)
  • HP (High Profile)
  • 4:2:2
- 1.0
Level string -

Identifier of the MPEG2 part 2 level. Enumeration of:

  • LL (Low Level)
  • ML (Main Level)
  • H-14 (High-1440)
  • HL (High Level)
- 1.0
MaximumDecodingCapability unsignedInt - The maximum decoding capability for this video standard in Kilobits per second. This strictly depends on the profile and level selected. - 1.0
STBService.{i}.Capabilities.VideoDecoder.MPEG4Part2. object - Object describing the set of supported profiles and levels for this STB. It also describes the set of audio standards supported when MPEG4 Part 2 is used as the video standard. - 1.0
AudioStandards string - Comma-separated list of strings. Each list item MUST be a member of the list reported by the Capabilities.AudioDecoder.AudioStandards parameter. Audio Standards supported by the Player when associated with MPEG4 Part 2 video. - 1.0
ProfileLevelNumberOfEntries unsignedInt - Number of instances of ProfileLevel. - 1.0
STBService.{i}.Capabilities.VideoDecoder.MPEG4Part2.ProfileLevel.{i}. object -

Table to describe the set of profiles and levels combinations supported by the STB when MPEG4 Part 2 is used as video standard.

At most one entry in this table can exist with the same values for Profile and Level. The table MUST include a distinct entry for each supported combination of these parameters.

- 1.0
Profile string -

Identifier of the MPEG4 Part 2 profile. Enumeration of:

- 1.0
Level string -

Identifier of the MPEG4 Part 2 level. Enumeration of:

- 1.0
MaximumDecodingCapability unsignedInt - The maximum decoding capability for this video standard in Kilobits per second. This strictly depends on the profile and level selected. - 1.0
STBService.{i}.Capabilities.VideoDecoder.MPEG4Part10. object - Object describing the set of supported profiles and levels for this STB. It also describes the set of audio standards supported when MPEG4 Part 10 is used as the video standard. - 1.0
AudioStandards string - Comma-separated list of strings. Each list item MUST be a member of the list reported by the Capabilities.AudioDecoder.AudioStandards parameter. Audio Standards supported by the Player when associated with MPEG4 Part 10 video. - 1.0
ProfileLevelNumberOfEntries unsignedInt - Number of instances of ProfileLevel. - 1.0
STBService.{i}.Capabilities.VideoDecoder.MPEG4Part10.ProfileLevel.{i}. object -

Table to describe the set of profiles and levels combinations supported by the STB when MPEG4 Part 10 is used as video standard.

  The table MUST include a distinct entry for each supported combination of these parameters.

At most one entry in this table can exist with the same values for Profile and Level.

- 1.0
Profile string -

Comma-separated list of strings. Supported MPEG4 Part 10 profiles. Each list item is an enumeration of:

- 1.0
Level string -

Comma-separated list of strings. Supported MPEG4 Part 10 Levels. Each list item is an enumeration of:

- 1.0
MaximumDecodingCapability unsignedInt - The maximum decoding capability for this video standard in Kilobits per second. This strictly depends on the profile and level selected. - 1.0
STBService.{i}.Capabilities.VideoDecoder.SMPTEVC1. object - Object describing the set of supported SMPTE-VC-1 profiles and levels for this STB. It also describes the set of audio standards supported when SMPTE-VC-1 is used as the video standard. - 1.0
AudioStandards string - Comma-separated list of strings. Each list item MUST be a member of the list reported by the Capabilities.AudioDecoder.AudioStandards parameter. Audio Standards supported by the Player when associated with SMPTE-VC-1 video. - 1.0
ProfileLevelNumberOfEntries unsignedInt - Number of instances of ProfileLevel. - 1.0
STBService.{i}.Capabilities.VideoDecoder.SMPTEVC1.ProfileLevel.{i}. object -

Table to describe the set of profiles and levels combinations supported by the STB when SMPTE-VC-1 is used as video standard.

At most one entry in this table can exist with the same values for Profile and Level. The table MUST include a distinct entry for each supported combination of these parameters.

- 1.0
Profile string -

Identifier of the SMPTE-VC-1 profile. Enumeration of:

  • SP (Simple Profile)
  • MP (Main Profile)
  • AP (Advanced Profile)
- 1.0
Level string -

Identifier of the SMPTE-VC-1 level. Enumeration of:

  • LL (Low Level)
  • ML (Medium Level)
  • HL (High Level)
  • L0 (Advanced Profile only)
  • L1 (Advanced Profile only)
  • L2 (Advanced Profile only)
  • L3 (Advanced Profile only)
  • L4 (Advanced Profile only)
- 1.0
MaximumDecodingCapability unsignedInt - The maximum decoding capability for this video standard in Kilobits per second. This strictly depends on the profile and level selected. - 1.0
STBService.{i}.Capabilities.AudioOutput. object - Audio output capabilities. The audio output stage may include selecting output formats, selecting output connectors, and copy protection. - 1.0
AudioFormats string -

Comma-separated list of strings. Supported audio output formats. Each list item is an enumeration of:

Note that these refer to supported output formats and not to physical connectors.

- 1.0
STBService.{i}.Capabilities.VideoOutput. object - Video output capabilities. The video output stage may include selecting output formats, selecting output connectors, and copy protection. - 1.0
CompositeVideoStandards string -

Comma-separated list of strings. Analog composite video standards supported for video output. This applies only to CVBS video output. Each list item is an enumeration of:

- 1.0
VideoFormats string -

Comma-separated list of strings. Supported video output formats. Each list item is an enumeration of:

Note that these refer to supported output formats and not to physical connectors.

- 1.0
Macrovision string­(32) - Supported version of Macrovision digital content protection standard. - 1.0
HDCP string­(32) - Supported version of HDCP digital content protection standard. - 1.0
STBService.{i}.Capabilities.CA. object - This object describes the characteristics of the Conditional Access, if any. - 1.0
CASystems string­(1024) - Comma-separated list (maximum list length 1024) of strings. Unique identifiers (e.g. commercial names) of supported CA systems. - 1.0
STBService.{i}.Capabilities.DRM. object - This object describes the characteristics of the Digital Rights Management, if any. - 1.0
DRMSystems string­(1024) - Comma-separated list (maximum list length 1024) of strings. Unique identifiers (e.g. commercial names) of supported DRM systems. - 1.0
STBService.{i}.Capabilities.ServiceMonitoring. object - This object describes the capabilities of the ServiceMonitoring object. - 1.0
ServiceTypes string -

Comma-separated list of strings. Supported service types, each of which relates to an AV stream source. Each list item is an enumeration of:

  • IPTV (WAN-sourced IPTV stream)
  • VoD (WAN-sourced VoD stream)
  • IP (WAN-sourced IP stream (includes IPTV and VoD)
  • CAB (Cable, e.g. DVB-C, Front End stream)
  • DTT (DTT, e.g. DVB-T, Front End stream)
  • SAT (Satellite, e.g. DVB-S, Front End stream)
  • PVR (PVR play-out stream)

Note that none of the standard service types cover LAN-sourced IP streams.

- 1.0
MaxActiveMainStreams int­[-1:] -

Maximum number of AV Main streams for which the STB can simultaneously collect statistics.

A value of -1 indicates no specific limit on the number of active streams.

- 1.0
MinSampleInterval int­[-1:] -

Minimum sample interval in seconds that the STB MUST be able to support.

A value of -1 indicates no specific minimum sample interval.

- 1.0
MaxReportSamples int­[-1:] -

Maximum number of samples of each statistic that the STB is able to store and report.

A value of -1 indicates no specific maximum number of samples.

- 1.0
HighLevelMetricNames string­(1024) - Comma-separated list (maximum list length 1024) of strings. The names of the supported high-level metrics. - 1.0
STBService.{i}.Capabilities.AudienceStats. object - This object describes the capabilities of the Applications.AudienceStats object. - 1.0
MaxAudienceStatsChannels int­[-1:] -

Maximum number of channels that the STB MUST support in the Applications.AudienceStats object

A value of -1 indicates no specific limit on the number of channels.

- 1.0
STBService.{i}.Components. object - Details of STB logical or physical internal components. Unlike the Capabilities object, which is read-only and which doesn't describe individual instances, this object contains some writeable parameters. - 1.0
FrontEndNumberOfEntries unsignedInt - Number of FrontEnd instances. - 1.0
AudioDecoderNumberOfEntries unsignedInt - Number of AudioDecoder instances. - 1.0
VideoDecoderNumberOfEntries unsignedInt - Number of VideoDecoder instances. - 1.0
AudioOutputNumberOfEntries unsignedInt - Number of AudioOutput instances. - 1.0
VideoOutputNumberOfEntries unsignedInt - Number of VideoOutput instances. - 1.0
SCARTNumberOfEntries unsignedInt - Number of SCART instances. - 1.0
CANumberOfEntries unsignedInt - Number of CA instances. - 1.0
DRMNumberOfEntries unsignedInt - Number of DRM instances. - 1.0
STBService.{i}.Components.FrontEnd.{i}. object - FrontEnd instance table. Each front-end instance, including vendor-specific front-end types, will normally have a sub-object that corresponds to the front-end type (e.g. DVB-T or IP). - 1.0
Enable boolean W Enables or disables this front-end. - 1.0
Status string -

The status of this front-end. Enumeration of:

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 1.0
Name string­(256) - Human-readable name associated with this front-end. - 1.0
STBService.{i}.Components.FrontEnd.{i}.DVBT. object -

DVB-T front-end details. This object will normally be present if and only if this front-end is a DVB-T front-end.

Parameters are taken from the DGTVi D-Book [D-Book].

- 1.0
STBService.{i}.Components.FrontEnd.{i}.DVBT.Modulation. object - DVB-T modulation details. - 1.0
Frequency unsignedInt W

Indicates the current frequency in kHz.

The value of this parameter is undefined while installing the service list (see Components.FrontEnd.{i}.DVBT.Install).

- 1.0
ChannelBandwidth string W

Indicates the channel bandwidth in use. Enumeration of:

- 1.0
Constellation string W

Indicates the current constellation in use. Enumeration of:

- 1.0
HierarchicalInformation string W

Hierarchical parameter alpha. The higher the value of alpha, the more noise-immune the High Priority Modulation is. Enumeration of:

  • 1 (no hierarchy)
  • 2
  • 4
- 1.0
CodeRateHP string W

Indicates the current code rate in use. Code rate applies to HP in case of hierarchical coding. Enumeration of:

- 1.0
CodeRateLP string W

Indicates the current code rate in use. Code rate applies to LP in case of hierarchical coding. Enumeration of:

- 1.0
GuardInterval string W

Indicates the current guard interval in use. Enumeration of:

- 1.0
TransmissionMode string W

Indicates the number of carriers in an OFDM frame. Enumeration of:

- 1.0
SNR unsignedInt - Signal/Noise ratio in the carrier band, measured in dB. - 1.0
BER unsignedInt - Bit Error Ratio before correction, expressed in multiples of 1e-6. - 1.0
CBER unsignedInt - Bit Error Ratio after correction, expressed in multiples of 1e-9. - 1.0
Locked boolean - Indicates whether or not the tuner is locked on a frequency. - 1.0
STBService.{i}.Components.FrontEnd.{i}.DVBT.Install. object -

DVB-T service list database installation. Supports maintenance of the service list database by scanning frequencies in order to detect services.

The service list database is in Components.FrontEnd.{i}.DVBT.ServiceListDatabase.

- 1.0
Start boolean W

Starts (when set to true) or stops (when set to false) scanning for services. The value is not saved in device state and is always false when read.

Discovered services are merged with those already present in the service list database. This supports cases where the frequency spectrum is not continuous.

In order to force a re-install, the service list database needs to be reset (see Components.FrontEnd.{i}.DVBT.ServiceListDatabase.Reset).

- 1.0
Status string -

Indicates the status of the scanning process. Enumeration of:

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 1.0
Progress unsignedInt­[0:100] - Progression in % of the current scan. The value is undefined when a scan is not in progress. - 1.0
StartFrequency unsignedInt W Frequency (in kHz) at which to start the scanning process. - 1.0
StopFrequency unsignedInt W Frequency (in kHz) at which to stop the scanning process. - 1.0
STBService.{i}.Components.FrontEnd.{i}.DVBT.ServiceListDatabase. object - DVB-T service list database. - 1.0
Reset boolean W When set to true, resets the service list database. Setting it to false has no effect. The value is not saved in device state and is always false when read. - 1.0
TotalServices unsignedInt - Total number of services defined in the service list database, i.e. the number of different DvbIds in the database. - 1.0
LogicalChannelNumberOfEntries unsignedInt - Number of logical channels in the service list database. - 1.0
STBService.{i}.Components.FrontEnd.{i}.DVBT.ServiceListDatabase.LogicalChannel.{i}. object -

DVB-T logical channel information.

At most one entry in this table can exist with a given value for LogicalChannelNumber.

- 1.0
LogicalChannelNumber unsignedInt - Logical channel number. - 1.0
ServiceNumberOfEntries unsignedInt - Number of services associated with this logical channel. - 1.0
STBService.{i}.Components.FrontEnd.{i}.DVBT.ServiceListDatabase.LogicalChannel.{i}.Service.{i}. object -

DVB-T service information.

At most one entry in this table can exist with a given value for DvbId.

- 1.0
DvbId string­(12) -

DVB Triplet [TS102034] that uniquely identifies the service in the service list database.

The DVB Triplet is a 12-byte string that is a concatenation of 4 hexadecimal characters for each of the following: Original Network Id, Transport Stream Id, Service Id. For example:

  • OriginalNetworkId = 8442 = 0x20FA
  • TransportStreamId = 4 = 0x0004
  • ServiceId = 257 = 0x0101

-> DvbId = 20FA00040101

- 1.0
Frequency unsignedInt - Transmitter frequency (in kHz) for this service. - 1.0
BER unsignedInt - Bit Error Ratio before correction, expressed in multiples of 1e-6 (indicates the quality of this service). - 1.0
Preferred boolean W

When set to true, identifies this as the preferred service for this logical channel and automatically sets Preferred to false for other services associated with this logical channel.

When set to false, cancels this service's preferred status and causes the service with the lowest BER (best received quality) to become the preferred service for this logical channel.

Whenever frequencies are re-scanned, all Preferred parameters are implicitly reset to false, i.e. a re-scan will always use the BER to determine preferred services, and will discard any past explicit overrides.

- 1.0
STBService.{i}.Components.FrontEnd.{i}.DVBT.LogicalChannelConnect. object - Connect to a DVB-T logical channel. - 1.0
LogicalChannelNumber unsignedInt W

Logical channel number to connect to (the logical channel's preferred service will be connected to).

If a ServiceMonitoring.MainStream instance with ServiceType = DTT is currently enabled, the STB MUST ensure that performance data for this service is collected in that instance.

The value is not saved in device state. The value when read is not specified and need not be the value that was most recently written.

- 1.0
STBService.{i}.Components.FrontEnd.{i}.DVBT.ServiceConnect. object - Connect to a DVB-T service. - 1.0
DvbId string­(12) W

DvbId of the service to connect to.

If a ServiceMonitoring.MainStream instance with ServiceType = DTT is currently enabled, the STB MUST ensure that performance data for this service is collected in that instance.

The value is not saved in device state. The value when read is not specified and need not be the value that was most recently written.

- 1.0
STBService.{i}.Components.FrontEnd.{i}.IP. object - IP front-end details. This object will normally be present if and only if the front-end is an IP front-end. - 1.0
InboundNumberOfEntries unsignedInt - Number of Inbound instances. - 1.0
OutboundNumberOfEntries unsignedInt - Number of Outbound instances. - 1.0
ActiveInboundIPStreams unsignedInt - Number of Inbound AV streams currently active (i.e. with Status != Disabled, which means audio or AV data are being processed). - 1.0
ActiveOutboundIPStreams unsignedInt - Number of Outbound AV streams currently active (i.e. with Status != Disabled, which means audio or AV data are being processed). - 1.0
STBService.{i}.Components.FrontEnd.{i}.IP.RTCP. object - Parameters related to RTCP receiver report generation as defined in [RFC3550]. - 1.0
Enable boolean W Enables or disables RTCP receiver report generation. - 1.0
Status string -

The status of RTCP receiver report generation. Enumeration of:

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 1.0
TxRepeatInterval unsignedInt­[1:] W Transmission repeat interval, in milliseconds. - 1.0
STBService.{i}.Components.FrontEnd.{i}.IP.RTPAVPF. object - Parameters related to RTP AVPF configuration as defined in [RFC4585] and [RFC4588]. - 1.0
Enable boolean W Enables or disables RTP/AVPF receiver report generation. - 1.0
Status string -

The status of RTP/AVPF receiver report generation. Enumeration of:

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 1.0
RetransmitTimeout unsignedInt W Time in milliseconds the receiver shall wait for a retransmitted packet before considering it to be lost. - 1.0
MinLossPackets unsignedInt W Minimum number of lost packets the receiver shall wait for before generating a retransmission request. - 1.0
MaxReportTime unsignedInt W Maximum time in milliseconds the receiver shall wait between a lost packet and the generation of a retransmission request. - 1.0
MaxLossBurst unsignedInt W Maximum number of consecutive lost packets for which the receiver shall attempt recovery. - 1.0
STBService.{i}.Components.FrontEnd.{i}.IP.IGMP. object - Parameters that are specific to IGMP clients when changing channels. - 1.0
Enable boolean W Enables or disables all IGMP support on the receiver side of the CPE. - 1.0
Status string -

Status of IGMP support on the receiver side of the CPE. Enumeration of:

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 1.0
MaximumNumberOfConcurrentGroups unsignedInt -

Maximum number of group memberships allowed simultaneously.

For example, this would need to be at least 2 in order to support a Multicast-delivered main picture and a Multicast-delivered PIP.

- 1.0
MaximumNumberOfTrackedGroups unsignedInt -

Maximum number of groups for which statistics will be tracked.

This relates only to the maintenance of statistics, and does not affect the operation of the STB.

- 1.0
LoggingEnable boolean W

Controls logging of IGMP traffic.

The CPE MAY choose to throttle log entries, e.g. if joins and leaves are occurring at an excessive rate.

- 1.0
DSCPMark unsignedInt­[0:63] W Diffserv code point to be used for outgoing IGMP packets. - 1.0
VLANIDMark int­[-1:] W

VLAN ID (as defined in 802.1Q) to be used for outgoing IGMP packets. A value of -1 indicates the default value is to be used.

If either the VLANIDMark or EthernetPriorityMark is greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.

- 1.0
EthernetPriorityMark int­[-1:] W

Ethernet priority code (as defined in 802.1D) to be used for outgoing IGMP packets. A value of -1 indicates the default value is to be used.

If either the VLANIDMark or EthernetPriorityMark are greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.

- 1.0
ClientVersion string -

The highest IGMP version supported by the IGMP Client. Enumeration of:

- 1.0
ClientRobustness unsignedInt W

Robustness is a way of indicating how vulnerable the network is to lost packets. IGMP can recover from robustness minus 1 lost IGMP packets.

RFC 3376 specifies a default of 2.

- 1.0
ClientUnsolicitedReportInterval unsignedInt­[1:25] W

The number of seconds between repetitions of a host's initial report of membership in a group.

RFC 3376 specifies a default of 1s.

- 1.0
ClientGroupNumberOfEntries unsignedInt - Number of entries in the ClientGroup table. - 1.0
ClientGroupStatsNumberOfEntries unsignedInt - Number of entries in the ClientGroupStats table. - 1.0
STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.ClientGroup.{i}. object -

IGMP Group table. This is the database that is maintained by the IGMP client to reflect the current group membership.

The CPE MUST support at least MaximumNumberOfConcurrentGroups table entries.

- 1.0
GroupAddress string­(45) - [IPAddress] The IP multicast group address for which this entry contains information. - 1.0
UpTime unsignedInt - Time elapsed in seconds since the multicast group has been a member on this interface. - 1.0
STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.ClientGroupStats.{i}. object -

IGMP Group statistics table. This stores per-group historical statistical data.

The CPE MUST support at least MaximumNumberOfTrackedGroups table entries. The CPE MAY reclaim entries based on the oldest membership reports.

- 1.0
GroupAddress string­(45) - [IPAddress] The IP multicast group address for which this entry contains information. - 1.0
TotalStart unsignedInt -

Number of seconds since the beginning of the period used for collection of Total statistics.

Statistics SHOULD continue to be accumulated across CPE reboots, though this may not always be possible.

- 1.0
CurrentDayStart unsignedInt -

Number of seconds since the beginning of the period used for collection of CurrentDay statistics.

The CPE MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this may not always be possible.

- 1.0
QuarterHourStart unsignedInt -

Number of seconds since the beginning of the period used for collection of QuarterHour statistics.

The CPE MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this may not always be possible.

- 1.0
STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.ClientGroupStats.{i}.Total. object - Total statistics for this multicast group. - 1.0
NumberOfJoins unsignedInt - Number of IGMP joins during this period. - 1.0
NumberOfLeaves unsignedInt - Number of IGMP leaves during this period. - 1.0
MaxJoinDelay unsignedInt - Maximum latency delay, in milliseconds, from the sending of a Join message for this group to the arrival of the first IP packet for this group during this period. - 1.0
STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.ClientGroupStats.{i}.CurrentDay. object - Current day statistics for this multicast group. - 1.0
NumberOfJoins unsignedInt - Number of IGMP joins during this period. - 1.0
NumberOfLeaves unsignedInt - Number of IGMP leaves during this period. - 1.0
MaxJoinDelay unsignedInt - Maximum latency delay, in milliseconds, from the sending of a Join message for this group to the arrival of the first IP packet for this group during this period. - 1.0
STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.ClientGroupStats.{i}.QuarterHour. object - Current quarter hour statistics for this multicast group. - 1.0
NumberOfJoins unsignedInt - Number of IGMP joins during this period. - 1.0
NumberOfLeaves unsignedInt - Number of IGMP leaves during this period. - 1.0
MaxJoinDelay unsignedInt - Maximum latency delay, in milliseconds, from the sending of a Join message for this group to the arrival of the first IP packet for this group during this period. - 1.0
STBService.{i}.Components.FrontEnd.{i}.IP.Dejittering. object - Parameters related to the de-jittering buffer configuration for all inbound IP streams. - 1.0
BufferSize unsignedInt W De-jittering buffer size, measured in milliseconds, on the receiver side of the CPE. The STB is responsible for converting this into the actual buffer size in bytes. - 1.0
BufferInitialLevel unsignedInt W Describes the number of milliseconds worth of data that should be in the receiver side dejittering buffer before play-out can start. Typically this would be half of the buffer size. - 1.0
STBService.{i}.Components.FrontEnd.{i}.IP.Inbound.{i}. object - Inbound IP streams currently entering the STB via this front-end. - 1.0
Status string -

The status of this Inbound stream. Enumeration of:

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 1.0
StreamingControlProtocol string - The value MUST be a member of the list reported by the Capabilities.FrontEnd.IP.StreamingControlProtocols parameter, or else be an empty string. Network protocol currently used for controlling streaming of the source content, or an empty string if the content is not being streamed or is being streamed but is not being controlled. - 1.0
StreamingTransportProtocol string - The value MUST be a member of the list reported by the Capabilities.FrontEnd.IP.StreamingTransportProtocols parameter, or else be an empty string. Network protocol currently used for streaming the source content, or an empty string if the content is not being streamed. - 1.0
StreamingTransportControlProtocol string - The value MUST be a member of the list reported by the Capabilities.FrontEnd.IP.StreamingTransportControlProtocols parameter, or else be an empty string. Transport control protocol currently used for streaming the source content, or an empty string if the content is not being streamed. - 1.0
MultiplexType string - The value MUST be a member of the list reported by the Capabilities.FrontEnd.IP.MultiplexTypes parameter, or else be an empty string. AV multiplex type currently used for the source content, or an empty string if the content is not being demultiplexed. - 1.0
DownloadTransportProtocol string - The value MUST be a member of the list reported by the Capabilities.FrontEnd.IP.DownloadTransportProtocols parameter, or else be an empty string. Network protocol currently used for downloading the source content, or an empty string if the content is not being downloaded. - 1.0
SourceAddress string­(45) - [IPAddress] IP address of the source of the current stream content. - 1.0
SourcePort unsignedInt­[0:65535] - TCP or UDP port number of the source of the current stream content, or 0 if the content is not being delivered via IP or if not applicable. - 1.0
DestinationAddress string­(45) - [IPAddress] IP address of the destination of the current stream content, or an empty string if the content is not being delivered via IP. - 1.0
DestinationPort unsignedInt­[0:65535] - TCP or UDP port number of the destination of the current stream content, or 0 if the content is not being delivered via IP or if not applicable. - 1.0
URI string­(256) -

RFC 3986 URI that indicates the current source (possibly including Multicast group and port, if relevant) of the stream content, or an empty string if the source is not known or cannot be represented as a URI.

For example, for a WAN-delivered stream this might be a content provider's URL, or for a LAN-delivered stream it might be an UPnP AV URN.

If specified, the URI MUST be consistent with the other source-related parameters.

- 1.0
STBService.{i}.Components.FrontEnd.{i}.IP.Outbound.{i}. object - Parameters related to an outbound IP stream. - 1.0
Status string -

The status of this Outbound stream. Enumeration of:

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 1.0
MultiplexType string - The value MUST be a member of the list reported by the Capabilities.FrontEnd.IP.MultiplexTypes parameter, or else be an empty string. AV multiplex type currently used for the destination content, or an empty string if the content is not being demultiplexed. - 1.0
URI string­(256) -

RFC 3986 URI that indicates the current destination (possibly including Multicast group and port, if relevant) of the stream content, or an empty string if the destination is not known or cannot be represented as a URI.

For example, this might be an UPnP AV URN.

- 1.0
STBService.{i}.Components.FrontEnd.{i}.IP.ServiceConnect. object - Parameters used to force connection to a dedicated IP stream for test purposes. - 1.0
URI string­(256) W

RFC 3986 URI that describes the service to connect to in the form:

  • <trsp>://<addr>:<port>?StrCtrl=<strctrl>?StrTrspCtrl=<trspctrl>?MuxType=<muxtype>

where:

  • <addr> is the IP address of the service source (for Unicast) or IGMP group (for Multicast).
  • <port> is the associated TCP/UDP port. If not specified, the STB is assumed to know and use an appropriate default port.
  • <trsp> is the streaming transport protocol and MUST be one of the values in Capabilities.FrontEnd.IP.StreamingTransportProtocols, which SHOULD be converted to lower-case.
  • <strctrl> is the streaming control protocol and MUST be one of the values in Capabilities.FrontEnd.IP.StreamingControlProtocols. If not specified, no streaming control protocol is to be used.
  • <trspctrl> is the streaming transport control protocol and MUST be one of the values in Capabilities.FrontEnd.IP.StreamingTransportControlProtocols. If not specified, no streaming transport control protocol is to be used.
  • <muxtype> is the multiplex type and MUST be one of the values in Capabilities.FrontEnd.IP.MultiplexTypes. This tells the STB which multiplex type to expect. If not specified, the STB is assumed to know, or to be able to determine, the multiplex type.

Note that download protocols are not supported by the above syntax. However, the specified syntax is just a baseline, and STBs MAY support an extended syntax.

Example of Multicast MPEG2-TS over RTP with no transport control:

Example of Multicast MPEG2-TS over RTP with AL-FEC transport control:

Example of Unicast MPEG2-TS over UDP with RTSP transport control:

Example of Unicast raw AV over RTP with RTCP control and RTSP transport control:

If a ServiceMonitoring.MainStream instance with ServiceType = IP or IPTV (or VoD if the URI accesses a VoD service) is currently enabled, the STB MUST ensure that performance data for this service is collected in that instance.

The value is not saved in device state. The value when read is not specified and need not be the value that was most recently written.

- 1.0
STBService.{i}.Components.PVR. object - PVR details. This is a read-only object that exists only to reference PVR storage objects. - 1.0
StorageNumberOfEntries unsignedInt - Number of Storage instances. - 1.0
STBService.{i}.Components.PVR.Storage.{i}. object - PVR storage table. There MUST be an instance for each storage object that can be accessed by the PVR. Entries MAY be dynamically created and deleted as storage devices become available and unavailable. - 1.0
Reference string­(256) -

References the corresponding StorageService [TR-140] instance, or an object contained within such an instance, e.g. a PhysicalMedium, LogicalVolume or Folder instance.

The value is the full hierarchical name of the corresponding object. Example: Device.Services.StorageService.1

- 1.0
STBService.{i}.Components.AudioDecoder.{i}. object - Audio decoder instance table. It contains data representing the current status of the Audio decoder. - 1.0
Enable boolean W Enables or disables this audio decoder. - 1.0
Status string -

The status of this audio decoder. Enumeration of:

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 1.0
Name string­(256) - Human-readable name associated with this audio decoder. - 1.0
AudioStandard string - The value MUST be a member of the list reported by the Capabilities.AudioDecoder.AudioStandards parameter, or else be an empty string. Audio standard currently being processed by this audio decoder, or an empty string if no audio standard is currently being processed. - 1.0
STBService.{i}.Components.VideoDecoder.{i}. object - Video decoder instance table. It contains data representing the current status of the video decoder. - 1.0
Enable boolean W Enables or disables this video decoder. - 1.0
Status string -

The status of this video decoder. Enumeration of:

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 1.0
Name string­(256) - Human-readable name associated with this video decoder. - 1.0
MPEG2Part2 string­(256) -

The value MUST be the Path Name of a row in the Capabilities.VideoDecoder.MPEG2Part2.ProfileLevel table. If the referenced object is deleted, the parameter value MUST be set to an empty string. MPEG2 Part 2 profile and level object instance, or an empty string if MPEG2 Part 2 is not used. For example:

.Capabilities.VideoDecoder.MPEG2Part2.ProfileLevel.2

- 1.0
MPEG4Part2 string­(256) -

The value MUST be the Path Name of a row in the Capabilities.VideoDecoder.MPEG4Part2.ProfileLevel table. If the referenced object is deleted, the parameter value MUST be set to an empty string. MPEG4 Part 2 profile and level object instance, or an empty string if MPEG4 Part 2 is not used). For example:

.Capabilities.VideoDecoder.MPEG4Part2.ProfileLevel.2

- 1.0
MPEG4Part10 string­(256) -

The value MUST be the Path Name of a row in the Capabilities.VideoDecoder.MPEG4Part10.ProfileLevel table. If the referenced object is deleted, the parameter value MUST be set to an empty string. MPEG4 Part 10 profile and level object instance, or an empty string if MPEG4 Part 10 is not used. For example:

.Capabilities.VideoDecoder.MPEG4Part10.ProfileLevel.2

- 1.0
SMPTEVC1 string­(256) -

The value MUST be the Path Name of a row in the Capabilities.VideoDecoder.SMPTEVC1.ProfileLevel table. If the referenced object is deleted, the parameter value MUST be set to an empty string. SMPTE-VC-1 profile and level object instance, or an empty string if SMPTE-VC-1 is not used. For example:

.Capabilities.VideoDecoder.SMPTEVC1.ProfileLevel.2

- 1.0
ContentAspectRatio string -

Indicates the native aspect ratio of the content available at this decoder. Enumeration of:

- 1.0
STBService.{i}.Components.AudioOutput.{i}. object - Audio output instance table. - 1.0
Enable boolean W Enables or disables this audio output. - 1.0
Status string -

The status of this audio output. Enumeration of:

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 1.0
Name string­(256) - Human-readable name associated with this audio output. - 1.0
AudioFormat string -

The value MUST be a member of the list reported by the Capabilities.AudioOutput.AudioFormats parameter, or else be an empty string. Currently active audio output format, or an empty string if no audio output format is currently active.

Note that this parameter refers to output formats and not to physical connectors.

- 1.0
AudioLevel unsignedInt­[0:100] W

The audio level on this audio output in % (0 is quietest and 100 is loudest). This setting is independent of the mute status.

For some audio formats, the audio level is not meaningful, in which case this parameter SHOULD have a fixed value of 0.

- 1.0
CancelMute boolean W When set to true, cancels this audio output's mute status. Setting it to false has no effect. The value is not saved in device state and is always false when read. - 1.0
SCARTs string­(1024) -

Comma-separated list (maximum list length 1024) of strings. Each list item MUST be the Path Name of a row in the Components.SCART table. If the referenced object is deleted, the corresponding item MUST be removed from the list. SCART object instances associated with this audio output, or an empty string if not associated with any SCART object instances. For example:

  • .Components.SCART.2
  • .Components.SCART.2,.Components.SCART.3
- 1.0
STBService.{i}.Components.VideoOutput.{i}. object - Video output instance table. - 1.0
Enable boolean W Enables or disables this video output. - 1.0
Status string -

The status of this video output. Enumeration of:

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 1.0
Name string­(256) - Human-readable name associated with this Video output. - 1.0
CompositeVideoStandard string -

The value MUST be a member of the list reported by the Capabilities.VideoOutput.CompositeVideoStandards parameter, or else be an empty string. The type of analog video standard currently in use or an empty string if no analog video standard is currently in use.

Note that this parameter applies only to the CVBS output format.

- 1.0
VideoFormat string W

The value MUST be a member of the list reported by the Capabilities.VideoOutput.VideoFormats parameter, or else be an empty string. Currently active video output format, or an empty string if no video output format is currently active.

Note that this parameter refers to output formats and not to physical connectors.

- 1.0
AspectRatioBehaviour string -

Indicates the aspect ratio behaviour for display on monitors with an aspect ratio different from that of the content, which is specified in Components.VideoDecoder.{i}.ContentAspectRatio (e.g. reproduction of HD content on SD monitors and vice versa). Enumeration of:

- 1.0
Macrovision boolean -

Indicates whether Macrovision analog protection is being used on this video output.

The Macrovision version supported is indicated in Capabilities.VideoOutput.Macrovision.

- 1.0
HDCP boolean -

Indicates whether HDCP is being used on this video output.

The HDCP version supported is indicated in Capabilities.VideoOutput.HDCP.

- 1.0
SCARTs string­(1024) -

Comma-separated list (maximum list length 1024) of strings. Each list item MUST be the Path Name of a row in the Components.SCART table. If the referenced object is deleted, the corresponding item MUST be removed from the list. SCART object instances associated with this video output, or an empty string if not associated with any SCART object instances. For example:

  • .Components.SCART.2
  • .Components.SCART.2,.Components.SCART.3
- 1.0
STBService.{i}.Components.SCART.{i}. object - SCART configuration. This object allows configuration of the STB's AV switching. - 1.0
Enable boolean W Enables or disables this SCART connector. - 1.0
Status string -

The status of this SCART connector. Enumeration of:

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 1.0
Name string­(256) - Human-readable name associated with this connector. - 1.0
Presence boolean W

Enables or disables the Presence control signal (pin 8 of the SCART connector), an output from the STB to control the display device connected to the SCART.

When enabled (set to true) the STB MUST drive pin 8 to the appropriate level to indicate the output video format (SD or HD) to the connected device.

When disabled (set to false) the STB MUST NOT drive pin 8.

- 1.0
STBService.{i}.Components.CA.{i}. object -

This object describes the characteristics of the Conditional Access, if any.

At most one entry in this table can exist with a given value for Name.

- 1.0
Enable boolean W Enables or disables this CA system. - 1.0
Status string -

The status of this CA system. Enumeration of:

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 1.0
Name string­(256) - The value MUST be a member of the list reported by the Capabilities.CA.CASystems parameter. Indicates a unique identifier (e.g. the commercial name: La 7 piu, Mediaset Premium) for this CA system. - 1.0
SmartCardReader string­(256) -

Path name of the smart card reader object instance containing the smart card (if any) associated with this CA system.

The value MUST be an empty string (if not associated with a smart card) or else be the full path name of the corresponding smart card reader object. For example:

Device.SmartCardReader.1

- 1.0
STBService.{i}.Components.DRM.{i}. object -

This object describes the characteristics of the Digital Rights Management, if any.

At most one entry in this table can exist with a given value for Name.

- 1.0
Enable boolean W Enables or disables this DRM system. - 1.0
Status string -

The status of this DRM system. Enumeration of:

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 1.0
Name string­(256) - The value MUST be a member of the list reported by the Capabilities.DRM.DRMSystems parameter. Indicates a unique identifier (e.g. the commercial name: La 7 piu, Mediaset Premium) for this DRM system. - 1.0
SmartCardReader string­(256) -

Path name of the smart card reader object instance containing the smart card (if any) associated with this DRM system.

The value MUST be an empty string (if not associated with a smart card) or else be the full path name of the corresponding smart card reader object. For example:

Device.SmartCardReader.1

- 1.0
STBService.{i}.AVStreams. object - AV Streams object. If more than one AV stream can be active at a time, it may contain several AVStream instances. - 1.0
ActiveAVStreams unsignedInt - Number of AV streams currently active (i.e. with Status != Disabled, which means audio or AV data are being processed). - 1.0
AVStreamNumberOfEntries unsignedInt - Number of AVStream instances. - 1.0
STBService.{i}.AVStreams.AVStream.{i}. object - Details of each AVStream. AV streams are created statically. Each AV stream corresponds to a valid {FrontEnd, AudioDecoder, VideoDecoder} instance combination (although if the PVR is active for this stream, only {FrontEnd} or {AudioDecoder, VideoDecoder} will be in use). - 1.0
Status string -

The status of this AV stream. Enumeration of:

An AV stream is disabled if any of the referenced objects are disabled.

If an AV stream is disabled then the values of other AV stream parameters are not significant.

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 1.0
Name string­(256) - Human-readable name associated with this stream, e.g. read from the DVB service information metadata. - 1.0
PVRState string -

Indicates whether this stream is using the PVR and, if so, the PVR state. Enumeration of:

  • Disabled (PVR not used by this stream)
  • Stopped (PVR playback not active)
  • Play (PVR playback active (and playing))
  • Paused (PVR playback active (paused))
  • FastForward (PVR playback active (fast forward))
  • Rewind (PVR playback active (rewind))

PVR record state can be inferred from whether the stream has an input FrontEnd: if so and PVRState is not Disabled, the PVR is recording.

- 1.0
FrontEnd string­(256) -

The value MUST be the Path Name of a row in the Components.FrontEnd table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Input FrontEnd object instance associated with this AV stream, or an empty string if not associated with a FrontEnd object). For example:

.Components.FrontEnd.2

- 1.0
Inbound string­(256) -

The value MUST be the Path Name of a row in the Components.FrontEnd.{i}.IP.Inbound table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Inbound IP stream object instance associated with the FrontEnd for this AV stream, or an empty string if the inbound stream is not delivered over IP. For example:

.Components.FrontEnd.2.Inbound.3

- 1.0
Outbound string­(256) -

The value MUST be the Path Name of a row in the Components.FrontEnd.{i}.IP.Outbound table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Outbound IP stream object instance associated with the output FrontEnd for this AV stream (which is always the IP FrontEnd), or an empty string if the outbound stream is not delivered over IP. For example:

.Components.FrontEnd.2.Outbound.3

- 1.0
AudioDecoder string­(256) -

The value MUST be the Path Name of a row in the Components.AudioDecoder table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Audio Decoder object instance associated with this AV stream, or an empty string if not associated with an Audio Decoder object. For example:

.Components.AudioDecoder.2

- 1.0
VideoDecoder string­(256) -

The value MUST be the Path Name of a row in the Components.VideoDecoder table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Video Decoder object instance associated with this AV stream, or an empty string if not associated with a Video Decoder object. For example:

.Components.VideoDecoder.2

- 1.0
CA string­(256) -

The value MUST be the Path Name of a row in the Components.CA table. If the referenced object is deleted, the parameter value MUST be set to an empty string. CA system object instance associated with this AV stream, or an empty string if not associated with a CA object. For example:

.Components.CA.2

- 1.0
DRM string­(256) -

The value MUST be the Path Name of a row in the Components.DRM table. If the referenced object is deleted, the parameter value MUST be set to an empty string. DRM system object instance associated with this AV stream, or an empty string if not associated with a DRM object. For example:

.Components.DRM.2

- 1.0
STBService.{i}.AVPlayers. object -

AV Players object. If more than one AV player can be active at a time, it may contain several AVPlayer instances.

AV players are created statically. Each AV player corresponds to a combination of several AV streams (one main screen video, several PIP, one audio) being connected to an AV presentation device (such as a TV set).

There is no guarantee that the STB has the resources to enable all of its AV players at the same time.

- 1.0
ActiveAVPlayers unsignedInt - Number of AV players currently active (i.e. with Status != Disabled, which means the AVPlayer is processing an audio or AV stream). - 1.0
AVPlayerNumberOfEntries unsignedInt - Number of AVPlayer instances. - 1.0
PreferredAudioLanguage string­(64) W

Human-readable string, as specified in [RFC3066], describing the audio language that SHOULD be used by the STB when receiving a multi-language audio multiplex.

An empty string indicates that there is no preferred audio language.

- 1.0
PreferredSubtitlingLanguage string­(64) W

Human-readable string, as specified in [RFC3066], describing the subtitling language that SHOULD be used by the STB when receiving multi-language subtitling.

A value of None indicates that no subtitling is required.

An empty string indicates that there is no preferred subtitling language.

- 1.0
STBService.{i}.AVPlayers.AVPlayer.{i}. object - List of AV Player objects. Each item is one particular AV player being processed by the STB. - 1.0
Enable boolean W Enables or disables this AV player. - 1.0
Status string -

The status of this AV player. Enumeration of:

If an AV player is disabled then the values of other AV player parameters are not significant.

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 1.0
Name string­(256) - Human-readable name associated with this AV player. - 1.0
AudioLanguage string­(64) - Human-readable string, as specified in [RFC3066], describing the audio language being currently processed by the AV player. - 1.0
SubtitlingStatus string -

The status of subtitling for this AV player. Enumeration of:

Subtitles are assumed to be shown only on the main screen.

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 1.0
SubtitlingLanguage string­(64) -

Human-readable string, as specified in [RFC3066], describing the subtitling language being currently processed by the AV player.

Subtitles are assumed to be shown only on the main screen.

- 1.0
AudioOutputs string­(1024) -

Comma-separated list (maximum list length 1024) of strings. Each list item MUST be the Path Name of a row in the Components.AudioOutput table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Audio output object instances associated with this AV player, or an empty string if not associated with any audio output object instances. For example:

.Components.AudioOutput.2

- 1.0
VideoOutputs string­(1024) -

Comma-separated list (maximum list length 1024) of strings. Each list item MUST be the Path Name of a row in the Components.VideoOutput table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Video output object instances associated with this AV player, or an empty string if not associated with any video output object instances. For example:

.Components.VideoOutput.2

- 1.0
MainStream string­(256) -

The value MUST be the Path Name of a row in the AVStreams.AVStream table. If the referenced object is deleted, the parameter value MUST be set to an empty string. AV stream object instance associated with this AV player that is being sent to the main screen, or an empty string if not associated with an AV stream object. For example:

.AVStreams.AVStream.2

- 1.0
PIPStreams string­(1024) -

Comma-separated list (maximum list length 1024) of strings. Each list item MUST be the Path Name of a row in the AVStreams.AVStream table. If the referenced object is deleted, the corresponding item MUST be removed from the list. AV stream object instances associated with this AV player that are being displayed as Picture In Picture (PIP), or an empty string if not associated with any PIP AV stream objects. For example:

  • .AVStreams.AVStream.2
  • .AVStreams.AVStream.2,.AVStreams.AVStream.3
- 1.0
STBService.{i}.ServiceMonitoring. object -

Contains statistics relating to the QoS / QoE of Main AV streams. These statistics are broken down into categories, e.g. de-jittering and RTP, and for each category there are two types of statistics:

  • Total statistics, which count the number of occurrences of something.
  • Sample statistics, which are measured over a sample interval, and are made available to the ACS as a list of the most recent n samples.

Total statistics are always collected (collection cannot be disabled, but the values can be reset).

For Sample statistics, an STB uses a single sample interval and number of samples (n) for all MainStream instances. The sample interval can be aligned with absolute time.

When Sample statistics collection is enabled, statistics collection MUST proceed regardless of whether there are any active Main AV streams. For example, when the STB is in Standby mode, there will be no active Main AV streams, but sample intervals will continue to be timed as normal.

Refer to [I.3/TR-135] for non-normative explanation of the operation of the ServiceMonitoring object.

- 1.0
SampleEnable boolean W

Enables or disables collection of Sample statistics.

When collection of Sample statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately.

- 1.0
SampleState string -

Indicates availability of Sample statistics. Enumeration of:

  • Disabled (Collection is disabled)
  • Enabled (Collection is enabled)
  • Trigger (Collection is enabled and the ACS should now fetch the collected data)

The Trigger value is only used for triggering the ACS to fetch the collected data and can only be used when FetchSamples is in the range [1:ReportSamples].

The transition from Enabled -> Trigger -> Enabled MUST be instantaneous and so will result in only a single value change for notification purposes.

- 1.0
SampleInterval unsignedInt­[1:] W

The sample interval in seconds. Each statistic is measured over this sample interval.

The STB MAY reject a request to set SampleInterval to less than Capabilities.ServiceMonitoring.MinSampleInterval.

Sample intervals MUST begin every SampleInterval seconds, with no delay between samples.

If SampleInterval is changed while collection of Sample statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately.

For example, if ReportSamples is 24 and SampleInterval is 3600 (an hour), the STB can store up to a day's worth of samples for each statistic.

- 1.0
ReportSamples unsignedInt­[1:] W

The number of samples that the STB can store and report for each statistic.

The STB MUST permit ReportSamples to be set to at least Capabilities.ServiceMonitoring.MaxReportSamples.

If ReportSamples is changed while collection of Sample statistics is enabled, the STB will truncate or extend its statistics buffers as appropriate, but statistics collection MUST NOT otherwise be affected.

For example, if ReportSamples is 24 and SampleInterval is 3600 (an hour), the STB can store up to a day's worth of samples for each statistic.

- 1.0
FetchSamples unsignedInt W

If collection of Sample statistics is enabled and FetchSamples is in the range [1:ReportSamples] then SampleState MUST transition from Enabled -> Trigger -> Enabled on completion of every FetchSamples sample intervals. Otherwise, this transition MUST NOT occur.

For example, if ReportSamples is 25 and FetchSamples is 24, then the STB will store 25 values for each statistic and the above SampleState transition will occur every 24 sample intervals, which means that the ACS could delay for up to two sample intervals before reading the stored values and would still not miss any samples (see also ForceSample).

- 1.0
TimeReference dateTime W

An absolute time reference in UTC to determine when sample intervals will complete. Each sample interval MUST complete at this reference time plus or minus an integer multiple of SampleInterval.

This time reference also determines when the SampleState Enabled -> Trigger -> Enabled transitions that are controlled by FetchSamples will occur. If collection of Sample statistics is enabled and FetchSamples is in the range [1:ReportSamples] then each such SampleState transition MUST occur at this reference time plus or minus an integer multiple of FetchSamples * SampleInterval (the fetch interval).

TimeReference is used only to set the "phase" of the sample and fetch intervals. The actual value of TimeReference can be arbitrarily far into the past or future.

If TimeReference is changed while collection of Sample statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately.

The Unknown Time value defined in [TR-106a1] indicates that no particular time reference is specified. That is, the STB MAY locally choose the time reference, and is required only to adhere to the specified sample and fetch intervals.

If absolute time is not available to the STB, its sample and fetch interval behavior MUST be the same as if the TimeReference parameter was set to the Unknown Time value.

For example, if SampleInterval is 3600 (an hour) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then sample intervals will complete on each UTC hour (00:00, 01:00, 02:00 etc).

If, in addition, FetchSamples is 24, then the fetch interval is 86400 (a day) and SampleState Enabled -> Trigger -> Enabled transitions will occur every day at UTC midnight.

Note that, if TimeReference is set to a time other than the Unknown Time, the first sample interval (which has to begin immediately) will almost certainly be shorter than SampleInterval). This is why TimeReference is defined in terms of when sample intervals complete rather than start.

- 1.0
ForceSample string W

Comma-separated list of booleans. When set to true, forces statistics for the current sample to be calculated and updated in the data model. Setting it to false has no effect. The value is not saved in device state and is always false when read.

If this is the first time that ForceSample has been set to true during the current sample interval, this MUST cause a new value to be added to each of the Sample statistics comma-separated list parameters, and the ReportEndTime and all SampleSeconds parameters MUST be updated accordingly.

If this is not the first time that ForceSample has been set to true during the current sample interval, then the new values that were added as described in the previous paragraph, and the ReportEndTime and all SampleSeconds parameters, MUST be updated accordingly.

Note that ForceSample just provides a sneak preview of the current sample. It does not create a new sample and it does not interfere with the sample interval schedule.

At the end of each sample interval, if ForceSample was set to true during the sample interval then the new values that were added as described above, and the ReportEndTime and all SampleSeconds parameters, will be updated accordingly. In other words, the partial sample data that was created when ForceSample was set to true will be updated one last time at the end of the sample interval.

- 1.0
ReportStartTime dateTime - The absolute time at which the sample interval for the first stored sample (for each statistic) started. - 1.0
ReportEndTime dateTime -

The absolute time at which the sample interval for the last stored sample (for each statistic) ended.

If ForceSample has been used to force statistics for the current sample to be calculated and updated in the data model, then ReportEndTime MUST be updated to reflect the actual time over which stored data was collected.

- 1.0
MainStreamNumberOfEntries unsignedInt - Number of MainStream instances. - 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}. object -

List of Main AV stream objects. Each instance is associated with a specified service type and will collect statistics only for the main stream that matches that service type.

Note that this means that streams that do not match an instance's service type MUST NOT contribute to the instance's Total and Sample statistics.

It is up to the STB to determine which AV stream should be regarded as the Main AV stream for a given service type at any given time. For example, if two active streams are associated with the same service type, the STB might prefer streams that are associated with an AV player, or if more than one stream is associated with an AV player, the STB might prefer a player that is outputting a DVI stream to a player that is outputting an RF stream.

Note that some parameters, e.g. Components.FrontEnd.{i}.IP.ServiceConnect.URI, include requirements that restrict the STB's freedom to determine which AV stream should be regarded as the Main AV stream for a given service.

- 1.0
Enable boolean W Enables or disables collection of Total and Sample statistics for this object instance. - 1.0
Status string -

Total and Sample statistics collection status for this object instance. Enumeration of:

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 1.0
ServiceType string W

The value MUST be a member of the list reported by the Capabilities.ServiceMonitoring.ServiceTypes parameter, or else be an empty string. Service type associated with this main stream instance, or an empty string if this instance is disabled.

The STB MUST reject a request that would result in a given AV stream contributing to more than one ServiceMonitoring.MainStream instance, e.g. it would reject a request to enable simultaneous collection of both IPTV and IP statistics, or to collect IPTV statistics on more than one instance.

- 1.0
AVStream string­(256) -

The value MUST be the Path Name of a row in the AVStreams.AVStream table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Main AV stream object instance currently associated with this ServiceMonitoring main stream instance. For example:

.AVStreams.AVStream.2

Note that, during the period of time over which Sample statistics are stored, this ServiceMonitoring main stream instance might be associated with many different AVStream instances. This parameter just provides information about which AVStream is currently being monitored.

- 1.0
Gmin unsignedInt W

Minimum number of consecutive received packets after the end of an RTP Loss Event. A Loss Event is defined as as a sequence of lost packets, possibly including islands of received packets. Each island consists of up to

(Gmin - 1) received packets (a sequence of Gmin received packets terminates the Loss Event, and so is not an island).

- 1.0
SevereLossMinDistance unsignedInt W The minimum distance required between error events before an RTP Loss Event is considered severe. Used in the calculation of SevereLossIndexCount and SevereLossIndexCountBeforeEC. - 1.0
SevereLossMinLength unsignedInt W The minimum value for the count of lost packets per RTP Loss Event before the count of lost packets is considered severe. Used in the calculation of SevereLossLengthCount and SevereLossLengthCountBeforeEC. - 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}.Total. object - Total statistics since this ServiceMonitoring main stream instance was last enabled or Total statistics were last reset. - 1.0
Reset boolean W When set to true, resets Total statistics for this ServiceMonitoring main stream instance. Setting it to false has no effect. The value is not saved in device state and is always false when read. - 1.0
ResetTime unsignedInt - Number of seconds since the Total statistics were last enabled or reset for this ServiceMonitoring main stream instance. - 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.DejitteringStats. object - Total de-jittering statistics for this ServiceMonitoring main stream instance. - 1.0
Overruns unsignedInt - Total number of times the receive jitter buffer has overrun for this AV stream. - 1.0
Underruns unsignedInt - Total number of times the receive jitter buffer has underrun for this AV stream. - 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.RTPStats. object -

Total RTP statistics for this ServiceMonitoring main stream instance.

If no EC is applied the BeforeEC statistics provide the same values as the corresponding statistics, e.g. when there is no EC, PacketsReceivedBeforeEC = PacketsReceived.

- 1.0
PacketsExpected unsignedInt - Total number of RTP packets expected for this AV stream as described in [A.3/RFC3550]. - 1.0
PacketsDiscarded unsignedInt -

Total number of packets discarded at the RTP layer for this AV stream because they were too late for playout, regardless of their being out of sequence or not.

These statistics are collected when no EC is applied or after any EC if available.

- 1.0
PacketsOutOfSequence unsignedInt -

Total number of packets out of sequence at the RTP level for this AV stream, regardless of their being too late for playout or not.

These statistics are collected when no EC is applied or after any EC if available.

- 1.0
PacketsReceived unsignedInt -

Total number of RTP packets received for this AV stream.

These statistics are collected when no EC is applied or after any EC if available.

- 1.0
PacketsReceivedBeforeEC unsignedInt -

Total number of RTP packets received for this AV stream.

These statistics are collected before any EC, if available, is applied.

- 1.0
PacketsLost unsignedInt -

Total number of RTP packets lost for this stream.

These statistics are collected when no EC is applied or after any EC if available.

- 1.0
PacketsLostBeforeEC unsignedInt -

Total number of RTP packets lost for this stream.

These statistics are collected before any EC, if available, is applied.

- 1.0
LossEvents unsignedInt -

Total number of Loss Events for this stream.

These statistics are collected when no EC is applied or after any EC if available.

- 1.0
LossEventsBeforeEC unsignedInt -

Total number of Loss Events for this stream.

These statistics are collected before any EC, if available, is applied.

- 1.0
SevereLossIndexCount unsignedInt -

Total number of Loss Events closer than SevereLossMinDistance.

These statistics are collected when no EC is applied or after any EC if available.

- 1.0
SevereLossIndexCountBeforeEC unsignedInt -

Total number of Loss Events closer than SevereLossMinDistance.

These statistics are collected before any EC, if available, is applied.

- 1.0
SevereLossLengthCount unsignedInt -

Total number of Loss Events longer than SevereLossMinLength.

These statistics are collected when no EC is applied or after any EC if available.

- 1.0
SevereLossLengthCountBeforeEC unsignedInt -

Total number of Loss Events longer than SevereLossMinLength.

These statistics are collected before any EC, if available, is applied.

- 1.0
RetransmitTimeouts unsignedInt -

Total number of RTP/AVPF retransmission timeouts ([RFC4585], [RFC4588])

If RTP/AVPF is not used this parameter does not increment

- 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.MPEG2TSStats. object - Total MPEG2-TS statistics for this ServiceMonitoring main stream instance. - 1.0
TSPacketsReceived unsignedInt - Total number of MPEG2-TS packets received for this AV stream. - 1.0
TSSyncByteErrorCount unsignedInt -

Total number of MPEG2-TS packets with an invalid transport sync byte received for this AV stream.

Not meaningful when MPEG2-TS is transported over IP.

- 1.0
TSSyncLossCount unsignedInt -

Total number of MPEG2-TS Loss of Synchronization Events for this AV stream.

Not meaningful when MPEG2-TS is transported over IP.

- 1.0
PacketDiscontinuityCounter unsignedInt -

Total number of MPEG2-TS Discontinuity errors that have been captured for this AV stream. This parameter accumulates all of the discontinuities observed for all currently monitored PIDs.

These statistics are collected when no CA decryption scheme is in use or after any CA decryption if in use.

- 1.0
PacketDiscontinuityCounterBeforeCA unsignedInt -

Total number of MPEG2-TS Discontinuity errors that have been captured for this AV stream. This parameter accumulates all of the discontinuities observed for all currently monitored PIDs.

These statistics are collected before any CA decryption scheme, if used, is applied.

- 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.VideoDecoderStats. object - Total video decoder application layer statistics for this ServiceMonitoring main stream instance. - 1.0
FrameRate unsignedInt - The frame rate at which the STB played out the video content for this AV stream. - 1.0
DecodedFrames unsignedInt - The number of video frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream. - 1.0
LostFrames unsignedInt - The number of video frames that could not be reproduced by the STB for this AV stream. - 1.0
ConcealedFrames unsignedInt - The number of video frames that were reproduced by the STB for which some information was missing and loss concealment was applied for this AV stream. - 1.0
IDecodedFrames unsignedInt - The number of I frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream. - 1.0
ILostFrames unsignedInt - The number of I frames that could not be reproduced by the STB for this AV stream. - 1.0
IConcealedFrames unsignedInt - The number of I frames that were reproduced by the STB for which some information was missing and loss concealment applied for this AV stream. - 1.0
PDecodedFrames unsignedInt - The number of P frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream. - 1.0
PLostFrames unsignedInt - The number of P frames that could not be reproduced by the STB for this AV stream. - 1.0
PConcealedFrames unsignedInt - The number of P frames that were reproduced by the STB for which some information was missing and loss concealment applied for this AV stream. - 1.0
BDecodedFrames unsignedInt - The number of B frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream. - 1.0
BLostFrames unsignedInt - The number of B frames that could not be reproduced by the STB for this AV stream. - 1.0
BConcealedFrames unsignedInt - The number of B frames that were reproduced by the STB for which some information was missing and loss concealment applied for this AV stream. - 1.0
AVResynchCounter unsignedInt - The number of AV resynchronizations that were performed by the STB for this AV stream. - 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.AudioDecoderStats. object - Total audio decoder application layer statistics for this ServiceMonitoring main stream instance. - 1.0
DecodedFrames unsignedInt - The number of audio frames that were decoded completely (errorless frames) or partially (corrupted frames) for this AV stream. - 1.0
DecodingErrors unsignedInt - The number of audio decoding errors detected for this AV stream. - 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.VideoResponseStats. object - Total video response statistics for this ServiceMonitoring main stream instance. - 1.0
MinimumVideoSystemResponse unsignedInt - Minimum time period (in milliseconds) between the instant of transmitting an IGMP JOIN command or an RTSP SETUP command, and the display of the first I frame for this AV stream. - 1.0
MaximumVideoSystemResponse unsignedInt - Maximum time period (in milliseconds) between the instant of transmitting an IGMP JOIN command or an RTSP SETUP command, and the display of the first I frame for this AV stream. - 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample. object -

Sample statistics collected since collection was last enabled or reset.

Most of the parameters in this object are comma-separated lists of individual statistics values, each of which corresponds to a sample interval.

The statistics values in these comma-separated lists MUST be in time order, with the oldest one first and the most recent one last.

Each comma-separated list can contain up to ReportSamples statistics values. When the list is full, each new value causes the oldest one to be discarded.

If no data was collected for a statistic during a sample interval then the value for that sample interval MUST be zero unless otherwise specified in the description of the individual statistics parameter.

- 1.0
SampleSeconds string -

Comma-separated list of unsigned integers. Each entry is the number of seconds during which data was collected for this AV stream during the sample interval. Each statistics category (Dejittering, RTP etc) has its own SampleSeconds parameter, which indicates the number of seconds during which data was collected for that statistics category during the sample interval.

Individual SampleSeconds values can be less than the SampleInterval, for several reasons, including:

  • The STB was in Standby mode for all or part of the sample interval.
  • TimeReference has been set to a time other than the Unknown Time and the current sample interval started part of the way through a scheduled sample interval.
  • ForceSample has been used to force statistics for the current sample to be calculated and updated in the data model.
- 1.0
SignificantChanges string - Comma-separated list of unsigned integers. Each entry is the total number of times that a channel change (or other potentially disruptive event) occurred for this AV stream during the sample interval. - 1.0
PVRTimeShift string - Comma-separated list of booleans. Each entry is a Boolean that indicates whether the PVR, with a non-zero time-shift, was used at any time for this AV stream during the sample interval. - 1.0
HighLevelMetricStatsNumberOfEntries unsignedInt - Number of HighLevelMetricStats instances. - 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.DejitteringStats. object - De-jittering Sample statistics for this ServiceMonitoring main stream instance. - 1.0
SampleSeconds string -

Comma-separated list of unsigned integers. Each entry is the number of seconds during which de-jittering data was collected for this AV stream during the sample interval.

Individual SampleSeconds values can be less than the sample interval, for several reasons, including:

- 1.0
Overruns string - Comma-separated list of unsigned integers. Each entry is the total number of times the receive jitter buffer has overrun for this AV stream during the sample interval. - 1.0
Underruns string - Comma-separated list of unsigned integers. Each entry is the total number of times the receive jitter buffer has underrun for this AV stream during the sample interval. - 1.0
EmptyBufferTime string - Comma-separated list of unsigned integers. Each entry is the time period, in milliseconds, for which the playout buffer was empty for this AV stream during the sample interval. - 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.RTPStats. object -

RTP Sample statistics for this ServiceMonitoring main stream instance.

If no EC is applied the BeforeEC statistics provide the same values as the corresponding statistics, e.g. when there is no EC, PacketsReceivedBeforeEC = PacketsReceived.

- 1.0
SampleSeconds string -

Comma-separated list of unsigned integers. Each entry is the number of seconds during which RTP data was collected for this AV stream during the sample interval.

Individual SampleSeconds values can be less than the sample interval, for several reasons, including:

- 1.0
PacketsExpected string - Comma-separated list of unsigned integers. Each entry is the total number of RTP packets expected for this AV stream during the sample interval as described in [A.3/RFC3550]. - 1.0
PacketsDiscarded string -

Comma-separated list of unsigned integers. Each entry is the number of packets that were discarded at the RTP layer for this AV stream during the sample interval because they were too late for playout, regardless of their being out of sequence or not.

These statistics are collected when no EC is applied or after any EC if available.

- 1.0
PacketsOutOfSequence string -

Comma-separated list of unsigned integers. Each entry is the number of packets out of sequence at the RTP level for this AV stream during the sample interval, regardless of their being too late for playout or not.

These statistics are collected when no EC is applied or after any EC if available.

- 1.0
PacketsReceived string -

Comma-separated list of unsigned integers. Each entry is the total number of RTP packets received for this AV stream during the sample interval.

These statistics are collected when no EC is applied or after any EC if available.

- 1.0
PacketsReceivedBeforeEC string -

Comma-separated list of unsigned integers. Each entry is the total number of RTP packets received for this AV stream during the sample interval.

These statistics are collected before any EC, if available, is applied.

- 1.0
RetransmitTimeouts string - Comma-separated list of unsigned integers. Each entry is the number of RTP/AVPF retransmission timeouts ([RFC4585], [RFC4588]) for this AV stream during the sample interval. - 1.0
PacketsLost string -

Comma-separated list of unsigned integers. Each entry is the total number of RTP packets lost for this AV stream during the sample interval.

Calculated by looking for missing RTP sequence headers.

These statistics are collected when no EC is applied or after any EC if available.

- 1.0
PacketsLostBeforeEC string -

Comma-separated list of unsigned integers. Each entry is the total number of RTP packets lost for this AV stream during the sample interval.

Calculated by looking for missing RTP sequence headers.

These statistics are collected before any EC, if available, is applied.

- 1.0
LossEvents string -

Comma-separated list of unsigned integers. Each entry is the total number of Loss Events for this AV stream during the sample interval.

These statistics are collected when no EC is applied or after any EC if available.

- 1.0
LossEventsBeforeEC string -

Comma-separated list of unsigned integers. Each entry is the total number of Loss Events for this AV stream during the sample interval.

These statistics are collected before any EC, if available, is applied.

- 1.0
SevereLossIndexCount string -

Comma-separated list of unsigned integers. Each entry is the total number of Loss Events that occurred at a distance shorter than SevereLossMinDistance from the previous Loss Event for this AV stream during the sample interval.

These statistics are collected when no EC is applied or after any EC if available.

- 1.0
SevereLossIndexCountBeforeEC string -

Comma-separated list of unsigned integers. Each entry is the total number of Loss Events that occurred at a distance shorter than SevereLossMinDistance from the previous Loss Event for this AV stream during the sample interval.

These statistics are collected before any EC, if available, is applied.

- 1.0
AverageLossDistance string -

Comma-separated list of unsigned integers. Each entry is the average distance in RTP packets between consecutive Loss Events for this AV stream during the sample interval.

These statistics are collected when no EC is applied or after any EC if available.

- 1.0
AverageLossDistanceBeforeEC string -

Comma-separated list of unsigned integers. Each entry is the average distance in RTP packets between consecutive loss events for this AV stream during the sample interval.

These statistics are collected before any EC, if available, is applied.

- 1.0
MinimumLossDistance string -

Comma-separated list of unsigned integers. Each entry is the length in RTP packets of the shortest distance between consecutive Loss Events for this AV stream during the sample interval.

These statistics are collected when no EC is applied or after any EC if available.

- 1.0
MinimumLossDistanceBeforeEC string -

Comma-separated list of unsigned integers. Each entry is the length in RTP packets of the shortest distance between consecutive Loss Events for this AV stream during the sample interval.

These statistics are collected before any EC, if available, is applied.

- 1.0
SevereLossLengthCount string -

Comma-separated list of unsigned integers. Each entry is the total number of Loss Events with length in RTP packets greater than SevereLossMinLength for this AV stream during the sample interval.

These statistics are collected when no EC is applied or after any EC if available.

- 1.0
SevereLossLengthCountBeforeEC string -

Comma-separated list of unsigned integers. Each entry is the total number of Loss Events with length in RTP packets greater than SevereLossMinLength for this AV stream during the sample interval.

These statistics are collected before any EC, if available, is applied.

- 1.0
MaximumLossPeriod string -

Comma-separated list of unsigned integers. Each entry is the length in RTP packets of the longest Loss Event for this AV stream during the sample interval.

These statistics are collected when no EC is applied or after any EC if available.

- 1.0
MaximumLossPeriodBeforeEC string -

Comma-separated list of unsigned integers. Each entry is the length in RTP packets of the longest Loss Event for this AV stream during the sample interval.

These statistics are collected before any EC, if available, is applied.

- 1.0
AverageLossPeriod string -

Comma-separated list of unsigned integers. Each entry is the average length in RTP packets of Loss Events for this AV stream during the sample interval.

These statistics are collected when no EC is applied or after any EC if available.

- 1.0
AverageLossPeriodBeforeEC string -

Comma-separated list of unsigned integers. Each entry is the average length in RTP packets of Loss Events for this AV stream during the sample interval.

These statistics are collected before any EC, if available, is applied.

- 1.0
MinimumLossPeriod string -

Comma-separated list of unsigned integers. Each entry is the length in RTP packets of the shortest RTP Loss Event for this AV stream during the sample interval.

These statistics are collected when no EC is applied or after any EC if available.

- 1.0
MinimumLossPeriodBeforeEC string -

Comma-separated list of unsigned integers. Each entry is the length in RTP packets of the shortest RTP Loss Event for this AV stream during the sample interval.

These statistics are collected before any EC, if available, is applied.

- 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.MPEG2TSStats. object - MPEG2-TS Sample statistics for this ServiceMonitoring main stream instance. - 1.0
SampleSeconds string -

Comma-separated list of unsigned integers. Each entry is the number of seconds during which MPEG2-TS data was collected for this AV stream during the sample interval.

Individual SampleSeconds values can be less than the sample interval, for several reasons, including:

- 1.0
TSPacketsReceived string - Comma-separated list of unsigned integers. Each entry is the total number of MPEG2-TS packets received for this AV stream during the sample interval. - 1.0
TSPacketsDrained string -

Comma-separated list of unsigned integers. Each entry is the total number of good MPEG2-TS packets removed from the buffer for this AV stream during the sample interval.

Packets received minus packets drained provides an indication how close the buffer came to over or under running during the sample interval.

- 1.0
TSSyncByteErrorCount string -

Comma-separated list of unsigned integers. Each entry is the total number of MPEG2-TS packets with an invalid transport sync byte for this AV stream during the sample interval.

Not meaningful when MPEG2-TS is transported over IP.

- 1.0
TSSyncLossCount string -

Comma-separated list of unsigned integers. Each entry is the total number of MPEG2-TS Loss of Synchronization Events for this AV stream during the sample interval.

Not meaningful when MPEG2-TS is transported over IP.

- 1.0
PacketDiscontinuityCounter string -

Comma-separated list of unsigned integers. Each entry is the total number of MPEG2-TS Discontinuity errors that were captured for this AV stream during the sample interval.

These statistics are collected when no CA decryption scheme is in use or after any CA decryption if in use.

- 1.0
PacketDiscontinuityCounterBeforeCA string -

Comma-separated list of unsigned integers. Each entry is the total number of MPEG2-TS Discontinuity errors that were captured for this AV stream during the sample interval.

These statistics are collected before any CA decryption scheme, if used, is applied.

- 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.VideoDecoderStats. object - Video decoder Sample statistics for this ServiceMonitoring main stream instance. - 1.0
SampleSeconds string -

Comma-separated list of unsigned integers. Each entry is the number of seconds during which video decoder data was collected for this AV stream during the sample interval.

Individual SampleSeconds values can be less than the sample interval, for several reasons, including:

- 1.0
FrameRate string - Comma-separated list of unsigned integers. Each entry is the frame rate at which the STB played out the video content for this AV stream during the sample interval. - 1.0
DecodedFrames string - Comma-separated list of unsigned integers. Each entry is the number of video frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval. - 1.0
LostFrames string - Comma-separated list of unsigned integers. Each entry is the number of video frames that could not be reproduced by the STB for this AV stream during the sample interval. - 1.0
ConcealedFrames string - Comma-separated list of unsigned integers. Each entry is the number of video frames that were reproduced by the STB for which some information was missing for this AV stream during the sample interval and loss concealment was applied. - 1.0
IDecodedFrames string - Comma-separated list of unsigned integers. Each entry is the number of I frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval. - 1.0
ILostFrames string - Comma-separated list of unsigned integers. Each entry is the number of I frames that could not be reproduced by the STB for this AV stream during the sample interval. - 1.0
IConcealedFrames string - Comma-separated list of unsigned integers. Each entry is the number of I frames that were reproduced by the STB for which some information was missing for this AV stream during the sample interval and loss concealment applied. - 1.0
PDecodedFrames string - Comma-separated list of unsigned integers. Each entry is the number of P frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval. - 1.0
PLostFrames string - Comma-separated list of unsigned integers. Each entry is the number of P frames that could not be reproduced by the STB for this AV stream during the sample interval. - 1.0
PConcealedFrames string - Comma-separated list of unsigned integers. Each entry is the number of P frames that were reproduced by the STB for which some information was missing for this AV stream during the sample interval and loss concealment applied. - 1.0
BDecodedFrames string - Comma-separated list of unsigned integers. Each entry is the number of B frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval. - 1.0
BLostFrames string - Comma-separated list of unsigned integers. Each entry is the number of B frames that could not be reproduced by the STB for this AV stream during the sample interval. - 1.0
BConcealedFrames string - Comma-separated list of unsigned integers. Each entry is the number of B frames that were reproduced by the STB for which some information was missing for this AV stream during the sample interval and loss concealment applied. - 1.0
AVResynchCounter string - Comma-separated list of unsigned integers. Each entry is the number of AV resynchronizations that were performed by the STB for this AV stream during the sample interval. - 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.AudioDecoderStats. object - Audio decoder Sample statistics for this ServiceMonitoring main stream instance. - 1.0
SampleSeconds string -

Comma-separated list of unsigned integers. Each entry is the number of seconds during which audio decoder data was collected for this AV stream during the sample interval.

Individual SampleSeconds values can be less than the sample interval, for several reasons, including:

- 1.0
DecodedFrames string - Comma-separated list of unsigned integers. Each entry is the number of audio frames that were decoded completely (errorless frames) or partially (corrupted frames) by the STB for this AV stream during the sample interval. - 1.0
DecodingErrors string - Comma-separated list of unsigned integers. Each entry is the number of audio decoding errors detected by the STB for this AV stream during the sample interval. - 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.VideoResponseStats. object - Video response Sample statistics for this ServiceMonitoring main stream instance. - 1.0
SampleSeconds string -

Comma-separated list of unsigned integers. Each entry is the number of seconds during which video response data was collected for this AV stream during the sample interval.

Individual SampleSeconds values can be less than the sample interval, for several reasons, including:

- 1.0
AverageVideoSystemResponse string - Comma-separated list of unsigned integers. Each entry is the time period (in milliseconds) between the instant of transmitting an IGMP JOIN or an RTSP SETUP command and the display of the first I frame, computed as the average of the VideoSystemResponse events that occured for this AV stream during the sample interval. - 1.0
MinimumVideoSystemResponse string - Comma-separated list of unsigned integers. Each entry is the minimum time period (in milliseconds) between the instant of transmitting an IGMP JOIN or an RTSP SETUP command and the display of the first I frame for this AV stream during the sample interval. - 1.0
MaximumVideoSystemResponse string - Comma-separated list of unsigned integers. Each entry is the maximum time period (in milliseconds) between the instant of transmitting an IGMP JOIN or an RTSP SETUP command and the display of the first I frame for this AV stream during the sample interval. - 1.0
STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStats.{i}. object -

High-level metric Sample statistics for this ServiceMonitoring main stream instance. One or more different high-level metrics can be supported.

At most one entry in this table can exist with a given value for MetricName.

- 1.0
MetricName string­(256) - The value MUST be a member of the list reported by the Capabilities.ServiceMonitoring.HighLevelMetricNames parameter. Indicates a unique identifier for this high-level metric. - 1.0
Metric1Threshold unsignedInt­[0:65535] W The threshold value that controls the calculation of the Metric1Failures parameter. - 1.0
Metric2Threshold unsignedInt­[0:65535] W The threshold value that controls the calculation of the Metric2Failures parameter. - 1.0
SampleSeconds string -

Comma-separated list of unsigned integers. Each entry is the number of seconds during which this high-level metric's data was collected for this AV stream during the sample interval.

Individual SampleSeconds values can be less than the sample interval, for several reasons, including:

- 1.0
Metric1 string -

Comma-separated list of unsigned integers (value 0 to 65535). Each entry is a high-level metric calculated for this AV stream during the sample interval.

The interpretation of the metric values is algorithm-specific; the only constraints are that values must be numeric, in the range [0:65535] and that lower values indicate worse QoE than do higher values.

- 1.0
Metric2 string -

Comma-separated list of unsigned integers (value 0 to 65535). Each entry is a high-level metric calculated for this AV stream during the sample interval.

The interpretation of the metric values is algorithm-specific; the only constraints are that values must be numeric, in the range [0:65535] and that lower values indicate worse QoE than do higher values.

- 1.0
Metric1Failures unsignedInt -

Counts the number of times (since the last time this MainStream and Sample statistics collection were both enabled) that a newly-calculated value of high-level metric Metric1 was less than or equal to Metric1Threshold.

This parameter can be incremented at any time during a sample interval, and might be incremented more than once during a single sample interval.

- 1.0
Metric2Failures unsignedInt -

Counts the number of times (since the last time this MainStream and Sample statistics collection were both enabled) that a newly-calculated value of high-level metric Metric2 was less than or equal to Metric2Threshold.

This parameter can be incremented at any time during a sample interval, and might be incremented more than once during a single sample interval.

- 1.0
STBService.{i}.Applications. object - Applications. - 1.0
STBService.{i}.Applications.AudienceStats. object - Audience viewing statistics. - 1.0
Enable boolean W Enables or disables collection of viewing statistics. Enabling collection of viewing statistics also resets the viewing statistics table. - 1.0
Reset boolean W

When set to true resets the viewing statistics table. Setting it to false has no effect. The value is not saved in device state and is always false when read.

Resetting statistics MUST reset all Channel.{i}.Duration parameters.

- 1.0
ResetTime unsignedInt - Number of seconds since the Audience statistics were last enabled or reset. - 1.0
ChannelNumberOfEntries unsignedInt - Number of instances of Channel. - 1.0
STBService.{i}.Applications.AudienceStats.Channel.{i}. object -

Table to record what the STB has been receiving. Time durations are recorded only for an AVPlayer's main AVStream (i.e. for TV channels being displayed in the main screen).

Each entry corresponds to a given TV channel and is indexed by channel name (the instance number is chosen by the STB and is not related to the channel number).

At most one entry in this table can exist with a given value for Name.

- 1.0
Name string­(256) - String describing the TV channel being displayed in the main screen. MUST be the value of the corresponding AVStreams.AVStream.{i}.Name parameter. - 1.0
Duration unsignedInt - The cumulative duration of this channel in seconds. - 1.0

Notification Requirements

Parameters for which Value Change Notification MAY be Denied

Parameter
STBService.{i}.Components.FrontEnd.{i}.DVBT.Modulation.
SNR
BER
CBER
STBService.{i}.Components.FrontEnd.{i}.DVBT.Install.
Progress
STBService.{i}.Components.FrontEnd.{i}.DVBT.ServiceListDatabase.LogicalChannel.{i}.Service.{i}.
BER
STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.ClientGroup.{i}.
UpTime
STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.ClientGroupStats.{i}.
TotalStart
CurrentDayStart
QuarterHourStart
STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.ClientGroupStats.{i}.Total.
NumberOfJoins
NumberOfLeaves
STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.ClientGroupStats.{i}.CurrentDay.
NumberOfJoins
NumberOfLeaves
STBService.{i}.Components.FrontEnd.{i}.IP.IGMP.ClientGroupStats.{i}.QuarterHour.
NumberOfJoins
NumberOfLeaves
STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.
ResetTime
STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.DejitteringStats.
Overruns
Underruns
STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.RTPStats.
PacketsExpected
PacketsReceived
PacketsReceivedBeforeEC
STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.MPEG2TSStats.
TSPacketsReceived
STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.VideoDecoderStats.
DecodedFrames
IDecodedFrames
PDecodedFrames
BDecodedFrames
STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.AudioDecoderStats.
DecodedFrames
STBService.{i}.Applications.AudienceStats.
ResetTime
STBService.{i}.Applications.AudienceStats.Channel.{i}.
Duration

Profile Definitions

Notation

The following abbreviations are used to specify profile requirements:

Abbreviation Description
R Read support is REQUIRED.
W Both Read and Write support is REQUIRED. This MUST NOT be specified for a parameter that is defined as read-only.
P The object is REQUIRED to be present.
C Creation and deletion of instances of the object is REQUIRED.
A Creation of instances of the object is REQUIRED, but deletion is not REQUIRED.
D Deletion of instances of the object is REQUIRED, but creation is not REQUIRED.

Baseline:1 Profile

This table defines the Baseline:1 profile for the STBService:1 data model. The minimum REQUIRED version for this profile is STBService:1.0.

Name Requirement
STBService.­{i}.­Capabilities. P
MaxActiveAVStreams R
MaxActiveAVPlayers R
STBService.­{i}.­Capabilities.­PVR. P
MaxIOStreams R
MaxRecordingStreams R
MaxPlaybackStreams R
MaxTimeDelay R
STBService.­{i}.­Capabilities.­AudioDecoder. P
AudioStandards R
STBService.­{i}.­Capabilities.­VideoDecoder. P
VideoStandards R
STBService.­{i}.­Capabilities.­VideoDecoder.­MPEG2Part2. P
AudioStandards R
ProfileLevelNumberOfEntries R
STBService.­{i}.­Capabilities.­VideoDecoder.­MPEG2Part2.ProfileLevel.­{i}. P
Profile R
Level R
MaximumDecodingCapability R
STBService.­{i}.­Capabilities.­VideoDecoder.­MPEG4Part2. P
AudioStandards R
ProfileLevelNumberOfEntries R
STBService.­{i}.­Capabilities.­VideoDecoder.­MPEG4Part2.ProfileLevel.­{i}. P
Profile R
Level R
MaximumDecodingCapability R
STBService.­{i}.­Capabilities.­VideoDecoder.­MPEG4Part10. P
AudioStandards R
ProfileLevelNumberOfEntries R
STBService.­{i}.­Capabilities.­VideoDecoder.­MPEG4Part10.ProfileLevel.­{i}. P
Profile R
Level R
MaximumDecodingCapability R
STBService.­{i}.­Capabilities.­VideoDecoder.­SMPTEVC1. P
AudioStandards R
ProfileLevelNumberOfEntries R
STBService.­{i}.­Capabilities.­VideoDecoder.­SMPTEVC1.ProfileLevel.­{i}. P
Profile R
Level R
MaximumDecodingCapability R
STBService.­{i}.­Capabilities.­AudioOutput. P
AudioFormats R
STBService.­{i}.­Capabilities.­VideoOutput. P
CompositeVideoStandards R
VideoFormats R
Macrovision R
HDCP R
STBService.­{i}.­Capabilities.­CA. P
CASystems R
STBService.­{i}.­Capabilities.­DRM. P
DRMSystems R
STBService.­{i}.­Capabilities.­ServiceMonitoring. P
MaxActiveMainStreams R
MinSampleInterval R
MaxReportSamples R
HighLevelMetricNames R
STBService.­{i}.­Components. P
FrontEndNumberOfEntries R
AudioDecoderNumberOfEntries R
VideoDecoderNumberOfEntries R
AudioOutputNumberOfEntries R
VideoOutputNumberOfEntries R
STBService.­{i}.­Components.­FrontEnd.­{i}. P
Status R
Name R
STBService.­{i}.­Components.­AudioDecoder.­{i}. P
Status R
Name R
AudioStandard R
STBService.­{i}.­Components.­VideoDecoder.­{i}. P
Status R
Name R
MPEG2Part2 R
MPEG4Part2 R
MPEG4Part10 R
SMPTEVC1 R
ContentAspectRatio R
STBService.­{i}.­Components.­AudioOutput.­{i}. P
Status R
Name R
AudioFormat R
AudioLevel R
CancelMute W
STBService.­{i}.­Components.­VideoOutput.­{i}. P
Status R
Name R
CompositeVideoStandard R
VideoFormat R
AspectRatioBehaviour R
STBService.­{i}.­AVStreams. P
ActiveAVStreams R
AVStreamNumberOfEntries R
STBService.­{i}.­AVStreams.­AVStream.­{i}. P
Status R
Name R
FrontEnd R
AudioDecoder R
VideoDecoder R
STBService.­{i}.­AVPlayers. P
ActiveAVPlayers R
AVPlayerNumberOfEntries R
PreferredAudioLanguage W
PreferredSubtitlingLanguage W
STBService.­{i}.­AVPlayers.­AVPlayer.­{i}. P
Status R
Name R
AudioLanguage R
SubtitlingStatus R
SubtitlingLanguage R
AudioOutputs R
VideoOutputs R
MainStream R
PIPStreams R

PVR:1 Profile

This table defines the PVR:1 profile for the STBService:1 data model. The minimum REQUIRED version for this profile is STBService:1.0.

Name Requirement
STBService.­{i}.­Components.­PVR. P
StorageNumberOfEntries R
STBService.­{i}.­Components.­PVR.­Storage.­{i}. P
Reference R
STBService.­{i}.­AVStreams.­AVStream.­{i}. P
PVRState R

DTT:1 Profile

This table defines the DTT:1 profile for the STBService:1 data model. The minimum REQUIRED version for this profile is STBService:1.0.

Name Requirement
STBService.­{i}.­Capabilities.­FrontEnd.­DVBT. P
MaxActiveDVBTStreams R
STBService.­{i}.­Components.­FrontEnd.­{i}.­DVBT.­Modulation. P
Frequency W
ChannelBandwidth W
Constellation W
HierarchicalInformation W
CodeRateHP W
CodeRateLP W
GuardInterval W
TransmissionMode W
SNR R
BER R
CBER R
Locked R
STBService.­{i}.­Components.­FrontEnd.­{i}.­DVBT.­Install. P
Start W
Status R
Progress R
StartFrequency W
StopFrequency W
STBService.­{i}.­Components.­FrontEnd.­{i}.­DVBT.­ServiceListDatabase. P
Reset W
TotalServices R
LogicalChannelNumberOfEntries R
STBService.­{i}.­Components.­FrontEnd.­{i}.­DVBT.­ServiceListDatabase.­LogicalChannel.­{i}. P
LogicalChannelNumber R
ServiceNumberOfEntries R
STBService.­{i}.­Components.­FrontEnd.­{i}.­DVBT.­ServiceListDatabase.­LogicalChannel.­{i}.­Service.­{i}. P
DvbId R
Frequency R
BER R
Preferred R
STBService.­{i}.­Components.­FrontEnd.­{i}.­DVBT.­LogicalChannelConnect. P
LogicalChannelNumber W
STBService.­{i}.­Components.­FrontEnd.­{i}.­DVBT.­ServiceConnect. P
DvbId W

IPTVBaseline:1 Profile

This table defines the IPTVBaseline:1 profile for the STBService:1 data model. The minimum REQUIRED version for this profile is STBService:1.0.

Name Requirement
STBService.­{i}.­Capabilities.­FrontEnd.­IP. P
StreamingControlProtocols R
StreamingTransportProtocols R
StreamingTransportControlProtocols R
DownloadTransportProtocols R
MultiplexTypes R
MaxDejitteringBufferSize R
STBService.­{i}.­Components.­FrontEnd.­{i}.­IP. P
InboundNumberOfEntries R
STBService.­{i}.­Components.­FrontEnd.­{i}.­IP.­IGMP. P
Status R
MaximumNumberOfConcurrentGroups R
ClientVersion R
ClientUnsolicitedReportInterval W
STBService.­{i}.­Components.­FrontEnd.­{i}.­IP.­Dejittering. P
BufferSize W
BufferInitialLevel W
STBService.­{i}.­Components.­FrontEnd.­{i}.­IP.­Inbound.­{i}. P
StreamingControlProtocol R
StreamingTransportProtocol R
StreamingTransportControlProtocol R
MultiplexType R
DownloadTransportProtocol R
SourceAddress R
SourcePort R
DestinationAddress R
DestinationPort R
URI R
STBService.­{i}.­Components.­FrontEnd.­{i}.­IP.­ServiceConnect. P
URI W
STBService.­{i}.­AVStreams.­AVStream.­{i}. P
Inbound R

RTCP:1 Profile

This table defines the RTCP:1 profile for the STBService:1 data model. The minimum REQUIRED version for this profile is STBService:1.0.

Name Requirement
STBService.­{i}.­Components.­FrontEnd.­{i}.­IP.­RTCP. P
Enable W
Status R
TxRepeatInterval W

RTPAVPF:1 Profile

This table defines the RTPAVPF:1 profile for the STBService:1 data model. The minimum REQUIRED version for this profile is STBService:1.0.

Name Requirement
STBService.­{i}.­Components.­FrontEnd.­{i}.­IP.­RTPAVPF. P
Enable W
Status R
RetransmitTimeout W
MinLossPackets W
MaxReportTime W
MaxLossBurst W

IPTVHomeNetwork:1 Profile

This table defines the IPTVHomeNetwork:1 profile for the STBService:1 data model. The minimum REQUIRED version for this profile is STBService:1.0.

Name Requirement
STBService.­{i}.­Components.­FrontEnd.­{i}.­IP. P
OutboundNumberOfEntries R
STBService.­{i}.­Components.­FrontEnd.­{i}.­IP.­Outbound.­{i}. P
MultiplexType R
URI R
STBService.­{i}.­AVStreams.­AVStream.­{i}. P
Outbound R

IGMP:1 Profile

This table defines the IGMP:1 profile for the STBService:1 data model. The minimum REQUIRED version for this profile is STBService:1.0.

Name Requirement
STBService.­{i}.­Components.­FrontEnd.­{i}.­IP.­IGMP. P
Enable R
Status R
MaximumNumberOfTrackedGroups R
LoggingEnable W
DSCPMark W
VLANIDMark W
EthernetPriorityMark W
ClientVersion R
ClientRobustness W
ClientUnsolicitedReportInterval W
ClientGroupNumberOfEntries R
ClientGroupStatsNumberOfEntries R
STBService.­{i}.­Components.­FrontEnd.­{i}.­IP.­IGMP.­ClientGroup.­{i}. P
GroupAddress R
UpTime R
STBService.­{i}.­Components.­FrontEnd.­{i}.­IP.­IGMP.­ClientGroupStats.­{i}. P
GroupAddress R
TotalStart R
CurrentDayStart R
QuarterHourStart R
STBService.­{i}.­Components.­FrontEnd.­{i}.­IP.­IGMP.­ClientGroupStats.­{i}.­Total. P
NumberOfJoins R
NumberOfLeaves R
MaxJoinDelay R
STBService.­{i}.­Components.­FrontEnd.­{i}.­IP.­IGMP.­ClientGroupStats.­{i}.­CurrentDay. P
NumberOfJoins R
NumberOfLeaves R
MaxJoinDelay R
STBService.­{i}.­Components.­FrontEnd.­{i}.­IP.­IGMP.­ClientGroupStats.­{i}.­QuarterHour. P
NumberOfJoins R
NumberOfLeaves R
MaxJoinDelay R

BasicPerfMon:1 Profile

This table defines the BasicPerfMon:1 profile for the STBService:1 data model. The minimum REQUIRED version for this profile is STBService:1.0.

Name Requirement
STBService.­{i}.­ServiceMonitoring. P
SampleEnable W
SampleState R
SampleInterval W
ReportSamples W
TimeReference W
ReportStartTime R
ReportEndTime R
MainStreamNumberOfEntries R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}. P
Enable W
Status R
ServiceType W
AVStream R
Gmin W
SevereLossMinDistance W
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Total. P
Reset W
ResetTime R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Total.­DejitteringStats. P
Overruns R
Underruns R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Total.­RTPStats. P
PacketsReceived R
PacketsLost R
LossEvents R
SevereLossIndexCount R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Total.­MPEG2TSStats. P
TSPacketsReceived R
PacketDiscontinuityCounter R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Total.­VideoDecoderStats. P
ILostFrames R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Total.­VideoResponseStats. P
MinimumVideoSystemResponse R
MaximumVideoSystemResponse R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Sample. P
SampleSeconds R
SignificantChanges R
PVRTimeShift R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Sample.­DejitteringStats. P
SampleSeconds R
Overruns R
Underruns R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Sample.­RTPStats. P
SampleSeconds R
PacketsReceived R
PacketsExpected R
PacketsLost R
PacketsLostBeforeEC R
LossEvents R
SevereLossIndexCount R
MaximumLossPeriod R
MinimumLossDistance R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Sample.­MPEG2TSStats. P
SampleSeconds R
TSPacketsReceived R
TSPacketsDrained R
PacketDiscontinuityCounter R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Sample.­VideoDecoderStats. P
SampleSeconds R
ILostFrames R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Sample.­VideoResponseStats. P
SampleSeconds R
AverageVideoSystemResponse R
MinimumVideoSystemResponse R
MaximumVideoSystemResponse R

ECPerfMon:1 Profile

This table defines the ECPerfMon:1 profile for the STBService:1 data model. The minimum REQUIRED version for this profile is STBService:1.0.

Name Requirement
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Total.­RTPStats. P
PacketsReceivedBeforeEC R
RetransmitTimeouts R
PacketsLostBeforeEC R
LossEventsBeforeEC R
SevereLossIndexCountBeforeEC R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Sample.­RTPStats. P
SampleSeconds R
PacketsReceivedBeforeEC R
RetransmitTimeouts R
PacketsLostBeforeEC R
LossEventsBeforeEC R
SevereLossIndexCountBeforeEC R
MinimumLossDistance R
MinimumLossDistanceBeforeEC R
MaximumLossPeriod R
MaximumLossPeriodBeforeEC R

VideoPerfMon:1 Profile

This table defines the VideoPerfMon:1 profile for the STBService:1 data model. The minimum REQUIRED version for this profile is STBService:1.0.

Name Requirement
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Total.­VideoDecoderStats. P
FrameRate R
LostFrames R
DecodedFrames R
IDecodedFrames R
ConcealedFrames R
IConcealedFrames R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Sample. P
HighLevelMetricStatsNumberOfEntries R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Sample.­DejitteringStats. P
SampleSeconds R
EmptyBufferTime R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Sample.­VideoDecoderStats. P
SampleSeconds R
FrameRate R
LostFrames R
DecodedFrames R
IDecodedFrames R
ConcealedFrames R
IConcealedFrames R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Sample.­HighLevelMetricStats.­{i}. -
SampleSeconds R
MetricName R
Metric1Threshold W
Metric1 R

AudioPerfMon:1 Profile

This table defines the AudioPerfMon:1 profile for the STBService:1 data model. The minimum REQUIRED version for this profile is STBService:1.0.

Name Requirement
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Total.­AudioDecoderStats. P
DecodedFrames R
DecodingErrors R
STBService.­{i}.­ServiceMonitoring.­MainStream.­{i}.­Sample.­AudioDecoderStats. P
SampleSeconds R
DecodedFrames R
DecodingErrors R

AudienceStats:1 Profile

This table defines the AudienceStats:1 profile for the STBService:1 data model. The minimum REQUIRED version for this profile is STBService:1.0.

Name Requirement
STBService.­{i}.­Applications.­AudienceStats. P
Enable W
Reset W
ResetTime R
ChannelNumberOfEntries R
STBService.­{i}.­Applications.­AudienceStats.­Channel.­{i}. P
Name R
Duration R

AnalogOutput:1 Profile

This table defines the AnalogOutput:1 profile for the STBService:1 data model. The minimum REQUIRED version for this profile is STBService:1.0.

Name Requirement
STBService.­{i}.­Components. P
SCARTNumberOfEntries R
STBService.­{i}.­Components.­VideoOutput.­{i}. P
VideoFormat W
Macrovision R
SCARTs R
STBService.­{i}.­Components.­SCART.­{i}. P
Status R
Name R
Presence R

DigitalOutput:1 Profile

This table defines the DigitalOutput:1 profile for the STBService:1 data model. The minimum REQUIRED version for this profile is STBService:1.0.

Name Requirement
STBService.­{i}.­Components.­VideoOutput.­{i}. P
HDCP R

CA:1 Profile

This table defines the CA:1 profile for the STBService:1 data model. The minimum REQUIRED version for this profile is STBService:1.0.

Name Requirement
STBService.­{i}.­Components. P
CANumberOfEntries R
STBService.­{i}.­Components.­CA.­{i}. P
Status R
Name R
SmartCardReader R
STBService.­{i}.­AVStreams.­AVStream.­{i}. P
CA R

DRM:1 Profile

This table defines the DRM:1 profile for the STBService:1 data model. The minimum REQUIRED version for this profile is STBService:1.0.

Name Requirement
STBService.­{i}.­Components. P
DRMNumberOfEntries R
STBService.­{i}.­Components.­DRM.­{i}. P
Status R
Name R
SmartCardReader R
STBService.­{i}.­AVStreams.­AVStream.­{i}. P
DRM R


Generated by Broadband Forum report.pl#422 (2018/03/28 version) on 2018/03/29 at 09:48:37.
report.pl --exitcode=fatals --altnotifreqstyle --ignoreenableparameter --immutablenonfunctionalkeys --cwmpindex=.. --nofontstyles --nowarnreport --quiet --report=html --outfile=tr-135-1-0-0.html tr-135-1-0-0.xml