ToiFrontendServiceFrontendInfo Interface Reference

---

Description

This is the documentation for ToiFrontendServiceFrontendInfo.
This structure provides information about the frontend. Use toi.statics.ToiFrontendServiceFrontendInfo.create(<sessionId>, <frontendCapabilities>, <isLocked>, <centreFrequency>, <signalNoiseRatio>, <bitErrorRate>, <uncorrectedBlocks>, <rFLevel>, <extendedProperties>) to create an instance of ToiFrontendServiceFrontendInfo.

import "ToiFrontendServiceFrontendInfo.idl";

List of all members.

Public Attributes
attribute ToiMediaSession::TToiSessionId	sessionId
attribute ToiFrontendServiceFrontendCapabilities	frontendCapabilities
attribute boolean	isLocked
attribute long	centreFrequency
attribute long	signalNoiseRatio
attribute long	bitErrorRate
attribute long	uncorrectedBlocks
attribute long	rFLevel
attribute ToiFrontendService::TToiPropertySequence	extendedProperties

---

Member Data Documentation

attribute long ToiFrontendServiceFrontendInfo::bitErrorRate

A measure of the channel bit error rate in errors/10^9 bits. When the receiver does not have channel lock this value is -1.

attribute long ToiFrontendServiceFrontendInfo::centreFrequency

Centre frequency of a frontend.

attribute ToiFrontendService::TToiPropertySequence ToiFrontendServiceFrontendInfo::extendedProperties

The extended properties defined for the frontend.

attribute ToiFrontendServiceFrontendCapabilities ToiFrontendServiceFrontendInfo::frontendCapabilities

The frontend capabilities information.

attribute boolean ToiFrontendServiceFrontendInfo::isLocked

True if the frontend is locked to a channel, i.e. the tuner has acquired a lock and the demodulator is able to decode the digital data stream with reasonable accuracy.

attribute long ToiFrontendServiceFrontendInfo::rFLevel

The tuner input level in dBm. When not available the value is -1.

attribute ToiMediaSession::TToiSessionId ToiFrontendServiceFrontendInfo::sessionId

The session identifier. If the frontend is not in use by a media session, the value is -1, i.e. no media session associated.

attribute long ToiFrontendServiceFrontendInfo::signalNoiseRatio

Signal-to-noise ratio in tenth of a dB, i.e. the value 251 means 25.1 dB. When the receiver does not have channel lock this value is -1.

attribute long ToiFrontendServiceFrontendInfo::uncorrectedBlocks

The number of uncorrected blocks since the previous call to GetFrontendInfo(). When the frontend does not have channel lock this value is -1.