DATA MODEL DEFINITION |
|
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.
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 |
|---|---|---|
| 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. |
| 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. |
| [HDMI] | HDMI, High-Definition Multimedia Interface 1.4a, March 2010. |
| [RFC4078] | RFC 4078, The TV-Anytime Content Reference Identifier (CRID), IETF. |
| [SMPTE20022-1] | SMPTE 20022-1 Application Layer Forward Error Correction. |
| [SOAP1.1] | Simple Object Access Protocol (SOAP) 1.1, W3C. |
| [SPDIF] | S/PDIF, Sony/Philips Digital InterFace IEC-958, IEC. |
| [TR-135] | TR-135 Amendment 3, Data Model for a TR-069 Enabled STB, Broadband Forum, November 2012. |
| [TS102323] | ETSI TS 102 323, Digital Video Broadcasting (DVB); Carriage and signalling of TV-Anytime information in DVB transport streams, ETSI. |
For a given implementation of this data model, the Agent MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the Agent supports only a single parameter that was introduced in version 1.1, then it will indicate support for version 1.1. The version number associated with each object and parameter is shown in the Version column.
| Name | Type | Write | Description | Object Default | Version |
|---|---|---|---|---|---|
| STBService.{i}. | object | - | The top-level object for an STB CPE. | - | 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 |
| 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 |
| DisplayFormats | string | - | Comma-separated list of strings. Each entry is a supported display format and MUST be in the form of “x:y”, such as for example “4:3, 16:9, 14:9". | - | 1.1 |
| STBService.{i}.Capabilities.HDMI. | object | - | This object describes the characteristics of the HDMI interface, if any. | - | 1.1 |
| SupportedResolutions | string | - | Comma-separated list of strings. Video resolutions supported for the HDMI video output. Each list item is an enumeration of:
|
- | 1.1 |
| CECSupport | boolean | - | Indicates whether the STB is supporting HDMI-CEC features as described in [HDMI]. | - | 1.1 |
| HDMI3D | boolean | - | Indicates whether the STB is supporting the 3D video formats mandated by [HDMI]. | - | 1.1 |
| STBService.{i}.Capabilities.CDS. | object | - | This object describes the characteristics of the Content Download System, if any. | - | 1.1 |
| PushCapable | boolean | - | Capability of providing a CDS Push service for the operator initiated download of content items to local storage via a broadband IP connection. | - | 1.1 |
| PullCapable | boolean | - | Capability of providing a CDS Pull service for the user initiated download of content items to a local storage via a broadband IP connection. | - | 1.1 |
| STBService.{i}.Capabilities.ServiceMonitoring. | object | - | This object describes the capabilities of the ServiceMonitoring object. | - | 1.0 |
| MaxEventsPerSampleInterval | int[-1:] | - | Maximum number of events of each applicable statistic that the STB is able to store for each sample interval. A value of -1 indicates no specific maximum number of events. |
- | 1.1 |
| 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 |
| HDMINumberOfEntries | unsignedInt | - | The number of entries in the HDMI table. | - | 1.1 |
| SPDIFNumberOfEntries | unsignedInt | - | The number of entries in the SPDIF table. | - | 1.1 |
| 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).
At most one entry in this table can exist with a given value for Name. |
- | 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.Service. | object | - | DVB-T Current service details. | - | 1.1 |
| CurrentLogicalChannel | string(256) | - | The value MUST be the Path Name of a row in the ServiceListDatabase.LogicalChannel table. If the referenced object is deleted, the parameter value MUST be set to an empty string. It represents the logical channel object instance for the current service, For example: .Components.FrontEnd.1.DVBT.-ServiceListDatabase.LogicalChannel.12. | - | 1.1 |
| CurrentService | string(256) | - | The value MUST be the Path Name of a row in the ServiceListDatabase.LogicalChannel.{i}.Service table. If the referenced object is deleted, the parameter value MUST be set to an empty string. It represents the service object instance for the current service. For example: .Components.FrontEnd.1.DVBT.ServiceListDatabase.LogicalChannel.12.Service.1. | - | 1.1 |
| STBService.{i}.Components.FrontEnd.{i}.DVBT.ServiceListDatabase. | object | - | DVB-T 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 |
| 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 |
| Name | string(256) | - | Human-readable name associated with this service, e.g. read from the DVB service information metadata. | - | 1.1 |
| CBER | unsignedInt | - | Bit Error Ratio after correction, expressed in multiples of 1e-9 (indicates the quality of this service). | - | 1.1 |
| SNR | unsignedInt | - | Signal/Noise ratio in the carrier band, measured in dB (indicates the quality of this service). | - | 1.1 |
| 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 |
| STBService.{i}.Components.FrontEnd.{i}.IP.RTPAVPF. | object | - | Parameters related to RTP AVPF configuration as defined in [RFC4585] and [RFC4588]. | - | 1.0 |
| OperationMode | string | W | The operation mode of the Error Correction mechanism. Enumeration of:
In Auto mode, when Error Correction is enabled, the STB decides whether or not to run the Error Correction operation (e.g. after an error analysis). In Forced mode, when Error Correction is enabled the STB MUST run the Error Correction operation. |
- | 1.1 |
| ECOperationStatus | string | - | The status of RTP/AVPF operation. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- | 1.1 |
| STBService.{i}.Components.FrontEnd.{i}.IP.FEC. | object | - | Parameters related to AL-FEC configuration as defined in [SMPTE20022-1]. | - | 1.1 |
| Enable | boolean | W | Enables or disables FEC decoder operation. When set to true, enables the FEC decoder operation, immediately (Forced mode) or automatically when necessary (Auto mode). When set to false, disables the FEC decoder operation. |
- | 1.1 |
| OperationMode | string | W | The operation mode of the FEC decoder. Enumeration of:
In Auto mode, when Error Correction is enabled the STB decides whether or not to run the AL_FEC decoding (e.g. after an error analysis). In Forced mode, when Error Correction is enabled the STB MUST run the FEC decoding. |
- | 1.1 |
| ECOperationStatus | string | - | The status of FEC decoder operation. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- | 1.1 |
| STBService.{i}.Components.FrontEnd.{i}.IP.Inbound.{i}. | object | - | Inbound IP streams currently entering the STB via this front-end.
At most one entry in this table can exist with a given value for Name. |
- | 1.0 |
| Name | string(256) | - | Unique human-readable name associated with this inbound IP instance. | - | 1.1 |
| STBService.{i}.Components.FrontEnd.{i}.IP.Outbound.{i}. | object | - | Parameters related to an outbound IP stream.
At most one entry in this table can exist with a given value for Name. |
- | 1.0 |
| Name | string(256) | - | Unique human-readable name associated with this outbound IP instance. | - | 1.1 |
| STBService.{i}.Components.FrontEnd.{i}.IP.ForceMonitor. | object | - | Parameters used to describe the force monitoring operation. When running in the force monitoring mode, the STB MUST automatically connect to a test URI defined by the URI parameter whenever it detects that the IP tuner is not not receiving any data from the WAN. When running in normal mode, the STB does not perform any action when it does not receive any data from the IP tuner coming from the WAN. The force monitor mode allows to maintain an active stream coming from the network so as to keep collecting statistics. |
- | 1.1 |
| Enable | boolean | W | When set to true, forces the operation mode in ForceMonitor mode When set to false, forces operation mode in Normal mode. |
- | 1.1 |
| Status | string | - | Indicates the status of the statistic mode of operation. Enumeration of:
|
- | 1.1 |
| URI | string(256) | W | describes the service to connect to for force monitoring purposes with the same syntaxt as ServiceConnect.URI If a ServiceMonitoring.MainStream instance with ServiceType = TEST or IP-All is currently enabled, the STB MUST ensure that performance data for this service is collected in that instance. The value when read is not specified and need not be the value that was most recently written. |
- | 1.1 |
| STBService.{i}.Components.PVR. | object | - | PVR details. This is a read-only object that exists only to reference PVR storage objects. | - | 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.
At most one entry in this table can exist with a given value for Name. |
- | 1.0 |
| Name | string(256) | - | Unique human-readable name associated with this storage instance. | - | 1.1 |
| STBService.{i}.Components.SPDIF.{i}. | object | - | S/PDIF output instance table configuration. This object, if present, is connected to the audio ouput instance currently delivering S/PDIF audio format as described in [SPDIF].
At most one entry in this table can exist with a given value for Name. |
- | 1.1 |
| Enable | boolean | W | Enables or disables the S/PDIF output. | - | 1.1 |
| Status | string | - | The status of this S/PDIF output. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- | 1.1 |
| Name | string(256) | - | Human-readable name associated with this output. | - | 1.1 |
| ForcePCM | boolean | W | When set to true, forces the audio format over S/PDIF to be in PCM mode. When set to false, let the compressed audio format be carried over S/PDIF (passthrough). |
- | 1.1 |
| Passthrough | boolean | - | When in Passthrough mode, the STB sends the audio stream over S/PDIF without decoding it. | - | 1.1 |
| AudioDelay | unsignedInt | - | Audio delay value, in milliseconds, currently being applied to the audio stream on the S/PDIF interface. The audio delay is entered by the user via his local UI, when necessary for correcting the lipsync. | - | 1.1 |
| STBService.{i}.Components.VideoOutput.{i}. | object | - | Video output instance table.
At most one entry in this table can exist with a given value for Name. |
- | 1.0 |
| ColorbarEnable | boolean | W | Enables or disables the color bar display. When set to true, the CPE MUST suspend the running service currently using the video output (e.g. IPTV broadcast reception) and MUST display the color bar. When set to false, the CPE MUST resume the previousely running service. This parameter MUST be always initialized with the value false on STB boot. |
- | 1.1 |
| DisplayFormat | string | W | The value MUST be a member of the list reported by the Capabilities.VideoOutput.DisplayFormats parameter, or else be an empty string. Display format being connected to this VideoOutput. This parameter is used by the STB to determine whether an aspect ratio conversion is required. |
- | 1.1 |
| STBService.{i}.Components.HDMI.{i}. | object | - | HDMI instance table. This object allows configuration of the STB’s HDMI output.
At most one entry in this table can exist with a given value for Name. |
- | 1.1 |
| Enable | boolean | W | Enables or disables the HDMI output. | - | 1.1 |
| Status | string | - | The status of HDMI output. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- | 1.1 |
| Name | string(256) | - | Human-readable name associated with this output. | - | 1.1 |
| ResolutionMode | string | W | The resolution mode of the HDMI output. In Auto mode, the resolution is automatically set at the best format via HDMI protocols. In Manual mode, the resolution to be applied to the HDMI output is given by the ResolutionValue parameter. Enumeration of:
|
- | 1.1 |
| ResolutionValue | string | W | The value MUST be a member of the list reported by the Capabilities.HDMI.SupportedResolutions parameter, or else be an empty string. When ResolutionMode is set to Manual mode, a write action configures the resolution to be applied to the HDMI output, When ResolutionMode is set to Auto, a write action as no effect. A read action provides the current resolution of the HDMI output. |
- | 1.1 |
| STBService.{i}.Components.HDMI.{i}.DisplayDevice. | object | - | HDMI connected display device configuration. This object provides parameters from the HDMI connected device if any. | - | 1.1 |
| Status | string | - | The status of the connected HDMI Display device. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- | 1.1 |
| Name | string(256) | - | Human-readable name associated with this display device. | - | 1.1 |
| EEDID | hexBinary(256) | - | Enhanced Extended Display Information Data (E-EDID) retrieved from the connected HDMI device. | - | 1.1 |
| SupportedResolutions | string | - | Comma-separated list of strings. Each entry is a supported resolution of the connected HDMI device and MUST be one element of Capabilities.HDMI.SupportedResolutions. | - | 1.1 |
| PreferredResolution | string | - | The value MUST be a member of the list reported by the Capabilities.HDMI.SupportedResolutions parameter. Preferred connected HDMI device resolution format. | - | 1.1 |
| VideoLatency | unsignedInt | - | Video latency, in milliseconds, being applied in the connected HDMI device. This parameter is extracted from the E-EDID and can be used to compensate the video latency to preserve lipsync. | - | 1.1 |
| CECSupport | boolean | - | When set to true, indicates the connected HDMI device is supporting HDMI-CEC features. When set to false, indicates the connected HDMI device does not support HDMI CEC. |
- | 1.1 |
| AutoLipSyncSupport | boolean | - | When set to true, indicates the connected display device supports auto lip synchronization. This mode consists in communicating over HDMI, the delay to be applied by the STB to the audio in order to preserve the lip sync. | - | 1.1 |
| HDMI3DPresent | boolean | - | When set to true, indicates the connected display device supports the 3D video formats mandated by [HDMI]. | - | 1.1 |
| 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 |
| PreferredBehaviour | string(64) | W | Aspect ratio behaviour preference for display on monitor. If non-empty, the string MUST be one of the .Components.VideoOutput.{i}. AspectRatioBehaviour values. |
- | 1.1 |
| ResetPINCode | boolean | W | When set to true, the master PIN code for the STB is set to 0000. Setting it to false has no effect. The value is not saved in device state and is always false when read. It is not recommended that this be set to true without the user's permission. No data on the device such as PVR recordings are to be cleared as a result of resetting the PIN code. | - | 1.1 |
| 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 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, even when the STB is not receiving any data, 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 |
| EventsPerSampleInterval | unsignedInt[1:] | W | The number of event measurements of each applicable statistic that the STB is able to store for each sample interval. The STB MUST permit EventsPerSampleInterval to be set to any value in the range from 1 to Capabilities.ServiceMonitoring.MaxEventsPerSampleInterval. If EventsPerSampleInterval is changed while collection of Sample statistic is enabled, the STB will truncate or extend its event measurement buffers as appropriate, but event measurement collection MUST NOT otherwise be affected. For example, if ReportSamples is 24 and SampleInterval is 3600 (an hour), and EventsPerSampleInterval is 60, the STB can store up 60 event measurements per hour, or in total 1440 event measurements per day. |
- | 1.1 |
| 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.
At most one entry in this table can exist with a given value for ServiceType. |
- | 1.0 |
| ChannelChangeFailureTimeout | unsignedInt | W | Time period, in seconds, between a user channel change request (defined as the instant of transmission of the relevant control protocol message (IGMP JOIN or RTSP SETUP) or a tuner command in case of DTT), and the display of the first I frame for the current AVStream, above which a channel change is considered as failed. | - | 1.1 |
| 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 |
| TotalSeconds | unsignedInt | - | The number of seconds during which data was collected for this AV stream since last reset Each statistics category (Dejittering, RTP etc) has its own TotalSeconds parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. Individual TotalSeconds values can be less than the ResetTime, for several reasons, including the STB was not receiving any data (Standby mode without force monitoring). |
- | 1.1 |
| STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.DejitteringStats. | object | - | Total de-jittering statistics for this ServiceMonitoring main stream instance. | - | 1.0 |
| TotalSeconds | unsignedInt | - | The number of seconds during which data was collected for this AV stream since last reset Each statistics category (Dejittering, RTP etc) has its own TotalSeconds parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. Individual TotalSeconds values can be less than ServiceMonitoring.MainStream.{i}.Total.ResetTime, for several reasons, including:
|
- | 1.1 |
| EmptyBufferTime | unsignedInt | - | Total time, in milliseconds, for which the playout was stopped due to buffer issues (empty or too low level) for this AV stream. | - | 1.1 |
| STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.TCPStats. | object | - | Total TCP statistics for this ServiceMonitoring main stream instance. | - | 1.1 |
| TotalSeconds | unsignedInt | - | The number of seconds during which data was collected for this AV stream since last reset Each statistics category (Dejittering, RTP etc) has its own TotalSeconds parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. Individual TotalSeconds values can be less than ServiceMonitoring.MainStream.{i}.Total.ResetTime, for several reasons, including:
|
- | 1.1 |
| PacketsReceived | unsignedInt | - | Total number of TCP packets correctly received for this AV stream. | - | 1.1 |
| PacketsRetransmitted | unsignedInt | - | Total number of TCP packets being retransmitted for this AV stream. | - | 1.1 |
| BytesReceived | unsignedInt | - | Total number of bytes received for this AV stream. | - | 1.1 |
| 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 |
| TotalSeconds | unsignedInt | - | The number of seconds during which data was collected for this AV stream since last reset Each statistics category (Dejittering, RTP etc) has its own TotalSeconds parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. Individual TotalSeconds values can be less than ServiceMonitoring.MainStream.{i}.Total.ResetTime, for several reasons, including:
|
- | 1.1 |
| STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.MPEG2TSStats. | object | - | Total MPEG2-TS statistics for this ServiceMonitoring main stream instance. | - | 1.0 |
| TotalSeconds | unsignedInt | - | The number of seconds during which data was collected for this AV stream since last reset Each statistics category (Dejittering, RTP etc) has its own TotalSeconds parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. Individual TotalSeconds values can be less than ServiceMonitoring.MainStream.{i}.Total.ResetTime, for several reasons, including:
|
- | 1.1 |
| STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.VideoDecoderStats. | object | - | Total video decoder application layer statistics for this ServiceMonitoring main stream instance. | - | 1.0 |
| TotalSeconds | unsignedInt | - | The number of seconds during which data was collected for this AV stream since last reset Each statistics category (Dejittering, RTP etc) has its own TotalSeconds parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. Individual TotalSeconds values can be less than ServiceMonitoring.MainStream.{i}.Total.ResetTime, for several reasons, including:
|
- | 1.1 |
| STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.AudioDecoderStats. | object | - | Total audio decoder application layer statistics for this ServiceMonitoring main stream instance. | - | 1.0 |
| TotalSeconds | unsignedInt | - | The number of seconds during which data was collected for this AV stream since last reset Each statistics category (Dejittering, RTP etc) has its own TotalSeconds parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. Individual TotalSeconds values can be less than ServiceMonitoring.MainStream.{i}.Total.ResetTime, for several reasons, including:
|
- | 1.1 |
| STBService.{i}.ServiceMonitoring.MainStream.{i}.Total.VideoResponseStats. | object | - | Total video response statistics for this ServiceMonitoring main stream instance. | - | 1.0 |
| TotalSeconds | unsignedInt | - | The number of seconds during which data was collected for this AV stream since last reset Each statistics category (Dejittering, RTP etc) has its own TotalSeconds parameter, which indicates the number of seconds during which data was collected for that statistics category since last reset. Individual TotalSeconds values can be less than ServiceMonitoring.MainStream.{i}.Total.ResetTime, for several reasons, including:
|
- | 1.1 |
| ChannelChangeFailures | unsignedInt | - | Number of channel change failures. A channel change is considered as failed when the time period between a user channel change request and the display of the first I frame for this AVStream is above ServiceMonitoring.MainStream.{i}.ChannelChangeFailureTimeout. | - | 1.1 |
| ChannelFailures | string | - | Comma-separated list (up to 10 items) of strings. Each entry represents a channel for which a channel change failed. Channels MAY be described as IP address, URL or Service names as appropriate. Only last 10 failures are required to be reported. | - | 1.1 |
| MinimumVoDControlResponse | unsignedInt | - | Minimum time period, in milliseconds, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused. | - | 1.1 |
| MaximumVoDControlResponse | unsignedInt | - | Maximum time period, in milliseconds, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused. | - | 1.1 |
| RequestedTransactions | unsignedInt | - | Total number of RTSP protocol requests to start a VoD program display. Only meaningful for VoD. |
- | 1.1 |
| AccessSuccesses | unsignedInt | - | Total number of successful VoD attempts. An attempt is considered successful when the first I-frame is displayed by the client. Only meaningful for VoD. |
- | 1.1 |
| CompletionCount | unsignedInt | - | Total number of completed VoD requests. An attempt is defined successful if it continues until a RTSP protocol request to end the session is sent by the STB. Only meaningful for VoD. |
- | 1.1 |
| 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. 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. Some comma-separated lists contains terms that are colon-separated lists and are used to store measurements on an event basis. These colon-separated lists can contain up to Capabilities.ServiceMonitoring.MaxEventsPerSampleInterval values. 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 |
| STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.TCPStats. | object | - | TCP sample statistics for this ServiceMonitoring main stream instance. | - | 1.1 |
| 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.1 |
| PacketsReceived | string | - | Comma-separated list of unsigned integers. Each entry is the total number of TCP packets received for this AV stream during the sample interval. | - | 1.1 |
| PacketsRetransmitted | string | - | Comma-separated list of unsigned integers. Each entry is the total number of TCP packets being retransmitted this AV stream.during the sample interval. | - | 1.1 |
| BytesReceived | string | - | Comma-separated list of unsigned integers. Each entry is the total number of bytes received for this AV stream.during the sample interval. | - | 1.1 |
| STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.VideoResponseStats. | object | - | Video response Sample statistics for this ServiceMonitoring main stream instance. | - | 1.0 |
| AverageVoDControlResponse | string | - | Comma-separated list of unsigned integers. Each entry is the time period, in milliseconds, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream, computed as the average of the VoDControlResponse events that occured for this AV stream during the sample interval. Only measured when started from a non-play state, i.e. either idle or paused. | - | 1.1 |
| MinimumVoDControlResponse | string | - | Comma-separated list of unsigned integers. Each entry is the minimum time period, in milliseconds, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused. | - | 1.1 |
| MaximumVoDControlResponse | string | - | Comma-separated list of unsigned integers. Each entry is the maximum time period, in milliseconds, between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused. | - | 1.1 |
| VoDControlResponse | string | - | Comma-separated list of strings. Each entry is a colon separated list of time periods in milliseconds between the instant of transmitting a RTSP PLAY command to start playing stream, and displaying the first I-frame of unicast stream. Only measured when started from a non-play state, i.e. either idle or paused. A comma separates measurements made in different sample intervals, while a colon separates individual measurements within a specific sample interval. If no VoDControlResponse measurements were made during a specific sample interval then this MUST be represented by an empty string. Example: ,837:453:1234,759,,,923:698,,,1284 Here there were no measurements during first sample interval, three during the second, one during the third, etc. The statistics values in this list MUST be in time order, with the oldest one first and the most recent one last. This applies both to sample intervals and to individual measurements during a specific sample interval. |
- | 1.1 |
| VideoSystemResponse | string | - | Comma-separated list of strings. Each entry is a colon separated list of time periods in milliseconds between the instant of transmitting an IGMP JOIN or an RTSP SETUP command and the display of the first I frame that occurred for this AV stream during the sample interval. A comma separates measurements made in different sample intervals, while a colon separates individual measurements within a specific sample interval. If no VideoSystemResponse measurements were made during a specific sample interval then this MUST be represented by an empty string. Example: ,837:453:1234,759,,,923:698,,,1284 Here there were no measurements during first sample interval, three during the second, one during the third, etc. The statistics values in this list MUST be in time order, with the oldest one first and the most recent one last. This applies both to sample intervals and to individual measurements during a specific sample interval. |
- | 1.1 |
| RequestedTransactions | string | - | Comma-separated list of unsigned integers. Each entry is the number of RTSP protocol requests to start a VoD program display during the sample interval. Only meaningful for VoD. |
- | 1.1 |
| AccessSuccesses | string | - | Comma-separated list of unsigned integers. Each entry is the number of successful VoD attempts during the sample interval. An attempt is considered successful when the first I-frame is displayed by the client. Only meaningful for VoD. |
- | 1.1 |
| CompletionCount | string | - | Comma-separated list of unsigned integers. Each entry is the number of completed VoD requests during the sample interval. An attempt is defined successful if it continues until a RTSP protocol request to end the session is sent by the STB. Only meaningful for VoD. |
- | 1.1 |
| ChannelChangeFailures | string | - | Comma-separated list of unsigned integers. Each entry is the number of channel change failures. A channel change is considered as failed when the time period between a user channel change request and the display of the first I frame for this AVStream is above ServiceMonitoring.MainStream.{i}.ChannelChangeFailureTimeout. | - | 1.1 |
| 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; this is specified by ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStatsNumberOfEntries.
At most one entry in this table can exist with a given value for MetricName. |
- | 1.0 |
| Enable | boolean | W | Enables or disables this Metric instance. | - | 1.1 |
| Status | string | - | The status of this Metric instance. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- | 1.1 |
| MetricSampleInterval | unsignedInt | W | A time period measured in seconds. A new value for the high level metric is calculated every MetricSampleInterval seconds. The value for MetricSampleInterval MUST be less than, or equal to, ServiceMonitoring.SampleInterval. MetricSampleInterval SHOULD be chosen such that ServiceMonitoring.SampleInterval is an integer multiple of MetricSampleInterval. If not, the last metric sample interval in each sample interval MUST be shortened so that the last metric sample interval ends when the sample interval ends. The value for MetricSampleInterval is algorithm-specific. |
- | 1.1 |
| MetricThreshold | unsignedInt[0:65535] | W | The threshold value that controls the calculation of the MetricFailures parameter. | - | 1.1 |
| Metric | 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 as the average of the high level metric values calculated on a metric sample interval basis. The length of the metric sample interval is given by MetricSampleInterval. The interpretation of the metric values is algorithm-specific; the only constraints are that values have to be numeric, in the range [0:65535] and that lower values indicate worse QoE than do higher values. |
- | 1.1 |
| MetricFailures | 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 Metric was less than or equal to MetricThreshold. 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.1 |
| STBService.{i}.ServiceMonitoring.GlobalOperation. | object | - | Global operations statistics. | - | 1.1 |
| STBService.{i}.ServiceMonitoring.GlobalOperation.Total. | object | - | Global operations total statistics. | - | 1.1 |
| ServiceAccessTime | unsignedInt | - | The time period in, milliseconds, between the first message (e.g. DHCP Discover) sent by the STB during boot-up and the first multicast I-frame for the default channel displayed by the STB. | - | 1.1 |
| MinimumPortalResponse | unsignedInt | - | Minimum portal latency defined as the minimum time period, in milliseconds, between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information. | - | 1.1 |
| MaximumPortalResponse | unsignedInt | - | Maximum portal latency defined as the maximum time period, in milliseconds, between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information. | - | 1.1 |
| STBService.{i}.ServiceMonitoring.GlobalOperation.Sample. | object | - | Global operations sample statistics. | - | 1.1 |
| MinimumPortalResponse | string | - | Comma-separated list of unsigned integers. Each entry is the minimum portal latency defined as the minimum time period, in milliseconds, between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information during the sample interval. | - | 1.1 |
| MaximumPortalResponse | string | - | Comma-separated list of unsigned integers. Each entry is the maximum portal latency defined as the maximum time period, in milliseconds, between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information during the sample interval. | - | 1.1 |
| PortalResponse | string | - | Comma-separated list of strings. Each entry is a colon separated list of time periods (in milliseconds) between the instant of transmitting TCP SYN (the three way handshake) prior to first HTTP message, and receiving the last HTTP message carrying the information. A comma separates measurements made in different sample intervals, while a colon separates individual measurements within a specific sample interval. If no PortalResponse measurements were made during a specific sample interval then this MUST be represented by an empty string. Example: ,837:453:1234,759,,,923:698,,,1284 Here there were no measurements during first sample interval, three during the second, one during the third, etc. The statistics values in this list MUST be in time order, with the oldest one first and the most recent one last. This applies both to sample intervals and to individual measurements during a specific sample interval. |
- | 1.1 |
| STBService.{i}.Applications. | object | - | Applications. | - | 1.0 |
| ServiceProviderNumberOfEntries | unsignedInt | - | Number of Service Provider instances. | - | 1.1 |
| STBService.{i}.Applications.CDSPush. | object | - | Details of STB CDS Push logical internal parameters. | - | 1.1 |
| Reference | string(256) | - | The value MUST be the Path Name of a row in the StorageService.{i}.PhysicalMedium, StorageService.{i}.LogicalVolume or StorageService.{i}.LogicalVolume.{i}.Folder tables. It references the object instance dedicated to the CDS Push service. Example: “Device.Services.StorageService.1.LogicalVolume.1.Folder.1”. | - | 1.1 |
| ContentItemNumberOfEntries | unsignedInt | - | The number of entries in the ContentItem table. | - | 1.1 |
| STBService.{i}.Applications.CDSPush.ContentItem.{i}. | object | - | Content Item instance table.
At most one entry in this table can exist with a given value for ContentReferenceId. |
- | 1.1 |
| ContentReferenceId | string | - | Unique Content Item reference as defined in [TS102323], or [RFC4078]. | - | 1.1 |
| VersionNumber | unsignedInt[0:255] | - | Version number of the stored content item (a content item could be updated with a new version e.g. in case of errors in the video preventing the play out). | - | 1.1 |
| DeleteItem | boolean | W | When set to true, deletes this Content Item instance. The value is not saved in device state and is always false when read. | - | 1.1 |
| STBService.{i}.Applications.CDSPull. | object | - | Details of STB CDS Pull logical internal component. This object is present only if the user allowed (via his local STB UI) the remote management of the CDS Pull service. | - | 1.1 |
| Reference | string(256) | - | The value MUST be the Path Name of a row in the StorageService.{i}.PhysicalMedium, StorageService.{i}.LogicalVolume or StorageService.{i}.LogicalVolume.{i}.Folder tables. It references the object instance dedicated to the CDS Pull service. Example: “Device.Services.StorageService.1.LogicalVolume.1.Folder.1”. | - | 1.1 |
| ContentItemNumberOfEntries | unsignedInt | - | The number of entries in the ContentItem table. | - | 1.1 |
| STBService.{i}.Applications.CDSPull.ContentItem.{i}. | object | - | Content Item instance table.
At most one entry in this table can exist with a given value for ContentReferenceId. |
- | 1.1 |
| ContentReferenceId | string | - | Unique Content Item reference as defined in [TS102323], or [RFC4078]. | - | 1.1 |
| VersionNumber | unsignedInt[0:255] | - | Version number of the stored content item (a content item could be updated with a new version e.g. in case of errors in the video preventing the play out). | - | 1.1 |
| DeleteItem | boolean | W | When set to true, deletes this Content Item instance. The value is not saved in device state and is always false when read. | - | 1.1 |
| STBService.{i}.Applications.ServiceProvider.{i}. | object | - | Service Provider instance table.
At most one entry in this table can exist with a given value for Name. |
- | 1.1 |
| Name | string(256) | W | Service Provider name. | - | 1.1 |
| Domain | string(256) | W | Service Provider domain URI. | - | 1.1 |
| ServiceDiscoveryServer | string(256) | W | Service Provider’s Service Discovery Server. It MAY be configured in the format of IMS Public Service Identifier, or IP address or URL. | - | 1.1 |
| ActiveBCGServers | string(1024) | - | Comma separated list of the BCG (Broadband Content Guide) server URLs the STB is currently retrieving IPTV service information from. | - | 1.1 |
| Parameter |
|---|
| Parameter |
|---|
| Parameter |
|---|
| 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. |
| Name | Requirement |
|---|---|
| STBService.{i}.Components.FrontEnd.{i}.IP.RTPAVPF. | P |
| Enable | W |
| OperationMode | W |
| ECOperationStatus | R |
| Name | Requirement |
|---|---|
| STBService.{i}.Components.FrontEnd.{i}.IP.FEC. | P |
| Enable | W |
| OperationMode | W |
| ECOperationStatus | R |
| Name | Requirement |
|---|---|
| STBService.{i}.Components.FrontEnd.{i}.IP.ForceMonitor. | P |
| Enable | W |
| Status | R |
| URI | W |
| Name | Requirement |
|---|---|
| STBService.{i}.Capabilities.ServiceMonitoring. | P |
| HighLevelMetricNames | R |
| STBService.{i}.ServiceMonitoring.GlobalOperation.Total. | P |
| ServiceAccessTime | R |
| STBService.{i}.ServiceMonitoring.GlobalOperation.Sample. | P |
| PortalResponse | R |
| STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.VideoResponseStats. | P |
| AccessSuccesses | R |
| RequestedTransactions | R |
| CompletionCount | R |
| VideoSystemResponse | R |
| VoDControlResponse | R |
| STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.HighLevelMetricStats.{i}. | P |
| MetricName | R |
| SampleSeconds | R |
| MetricSampleInterval | R |
| Metric | R |
| STBService.{i}.ServiceMonitoring.MainStream.{i}.Sample.RTPStats. | P |
| PacketsExpected | R |
| PacketsReceived | R |