The CWEK generation method is
$CWEK = H(CWEK CAM\_ID DSC\_ID)msb(128)$ | +| KPK | The abbreviation of key pairing key. The authorization centre (AC) generates the KPK if the KeyPairingID is valid. | +| HMAC_KEY | A hash-based message authentication code (HMAC) secret key. CAM uses HMAC_KEY to generate an HMAC value for the message including control words .
The HMAC_KEY generation method is
$HMAC\_KEY = H(RAND_{HMAC} CAM\_ID DSC\_ID)msb(160)$ , Here RAND HMAC is achieved by $PRF(X)msb(320)$ | +| RAND | Random number with 320 bits | +| K i | The pre-shared key having the size of 128 bits. The AC uniquely assigns three K i to each CAM. K i should be a generated random generation function. | + +# 4 Abbreviations and acronyms + +This Recommendation uses the following Abbreviations and acronyms: + +| | | +|------|------------------------------------| +| AC | Authorization Centre | +| ASN | Abstract Syntax Notation | +| BER | Basic Encoding Rules | +| CACS | Conditional Access Client Software | + +| | | +|--------|-------------------------------------------------| +| CAM | Conditional Access Module | +| CASS | CAM Authentication Sub-System | +| CCCIEK | Common CAM Client Image Encryption Key | +| CCI | CAM Client Image | +| CHK | Common Hash Key | +| CPE | Customer Premise Equipment | +| CWEK | Control Words Encryption Key | +| DOCSIS | Data Over Cable Service Interface Specification | +| HMAC | Hash-based Message Authentication Code | +| ICCIEK | Individual CAM Client Image Encryption Key | +| IHK | Individual Hash Key | +| IV | Initialization Vector | +| KPK | Key Pairing Key | +| MEK | Message Encryption Key | +| MK | Master Key | +| PRF | Pseudo Random number generation Function | +| PRNG | Pseudo Random Number Generator | +| RCAS | Renewable Conditional Access System | + +# 5 Conventions + +In this Recommendation: + +The keywords "**is required to**" indicate a requirement which must be strictly followed and from which no deviation is permitted if conformance to this document is to be claimed. + +The keywords "**is recommended**" indicate a requirement which is recommended but which is not absolutely required. Thus this requirement need not be present to claim conformance. + +The keywords "**is prohibited from**" indicate a requirement which must be strictly followed and from which no deviation is permitted if conformance to this document is to be claimed. + +The keywords "**can optionally**" indicate an optional requirement which is permissible, without implying any sense of being recommended. This term is not intended to imply that the vendor's implementation must provide the option and the feature can be optionally enabled by the network operator/service provider. Rather, it means the vendor may optionally provide the feature and still claim conformance with the specification. + +In the body of this document and its annexes, the words *shall*, *shall not*, *should*, and *may* sometimes appear, in which case they are to be interpreted, respectively, as *is required to*, *is prohibited from*, *is recommended*, and *can optionally*. The appearance of such phrases or keywords in an appendix or in material explicitly marked as *informative* are to be interpreted as having no normative intent. + +# 6 Overview of RCAS network protocol + + + +The diagram illustrates the reference architecture of RCAS, divided into Headend and Customer premise components connected by a Cable network (e.g., DOCSIS) for CRS. + +- Headend:** + - CAM authentication sub-system (CASS):** Interacts with the AC and the CAM in the customer premise via the cable network for authentication and CACS encryption key establishment. + - Authorization centre (AC):** Connected to the CASS and provides information for authentication. + - Secure CACS download sub-system:** Transmits CA client S/W to the CAM through a secure channel. + - Headend CAS system (including scrambler):** Receives content from content sources and billing, and transmits ECM/EMM and encrypted content to the CAM. +- Cable network (e.g., DOCSIS) for CRS:** A two-way network connecting the headend and the customer premise. +- Customer premise:** + - RCAS set-top box:** Contains the CAM, Descrambler, and TV. + - CAM:** Interacts with the CASS for authentication and receives CA client S/W from the secure CACS download sub-system. It obtains CW from the descrambler. + - Descrambler:** Receives encrypted content from the headend CAS system and CW from the CAM to produce clear content output to the TV. + - Client CAS block:** Associated with the CAM. + - Clear content output:** Delivered to the TV. + +Additional components and labels include: + +- RCAS headend:** Label for the CASS and AC. +- CAS operation block:** Label for the content sources and billing. +- Secure channel:** Between the secure CACS download sub-system and the CAM. +- ECM/EMM:** Transmitted from the headend CAS system to the CAM. +- Encrypted content:** Transmitted from the headend CAS system to the CAM. +- J.1003(14)\_F01:** Reference label at the bottom right. + +Figure 1 – Reference architecture of RCAS. The diagram shows the Headend and Customer premise connected by a Cable network. The Headend contains the CAM authentication sub-system (CASS), Authorization centre (AC), and Secure CACS download sub-system. The Customer premise contains the RCAS set-top box with CAM, Descrambler, and TV. The diagram illustrates the flow of authentication, key establishment, and content delivery. + +**Figure 1 – Reference architecture of RCAS** + +Figure 1 is a reference architecture illustrating a configuration of a renewable conditional access system (RCAS). The RCAS provides a mutual authentication method between a conditional access module (CAM) and a CAM authentication sub-system (CASS). A mutual authentication includes the CAM of a RCAS set-top box, the CASS of a RCAS headend and an authorization centre (AC) connected to the CASS. As shown in Figure 1 the CAM and the CASS interactively communicate with each other through a cable network for this mutual authentication. The AC provides a variety of important information used for authentication through the CASS. The CASS transmits information used for authentication received from the AC to the CAM by means of a suitable communication system such as data over cable service interface specification (DOCSIS). All types of key information generated during the authentication are managed by the AC. When the authentication is completed normally, the conditional access client software (CACS) is transmitted to the CAM through a secure CACS download sub-system. After downloading the CACS, the CAM obtains viewing entitlement with respect to a scrambled and transmitted broadcasting signal and provides a subscriber with a fee-based broadcasting service through customer premise equipment (CPE). The messages exchanged among the CAM, the CASS and the AC are defined as a RCAS network protocol. The RCAS network protocol enables a security and authentication function for messages exchanged among the CAM, the CASS and the AC. + +The specification of RCAS network protocol includes the following functions for authentication and secure download of CACS that are specified in [ITU-T J.1001]: + +- **Security announcement function:** The ability to provide information such as initial configuration, upgrade, or access information, to CAMs in the network through the RCAS network protocol. +- **Key establishment and authentication function:** The establishment CACS encryption and authentication key which is used for encrypting CACS to protect the image of CACS while it is delivered from the headend to CAM. +- **Supporting RCAS pairing function:** It is required that RCAS network protocol supports the RCAS pairing function which is specified in [ITU-T J.1002] while RCAS network protocol is operated. +- **Renewal information announcement function:** The ability to provide the CACS download information to CAM through the RCAS network protocol. + +# 7 Protocol processing procedures + +Figure 2 is a sequence chart illustrating a mutual authentication method based on RCAS network protocol. In this protocol, it is assumed that the CAM retains an AC certificate (AC X.509 certificate), a CAM certificate, a Ki value and a three operator variant algorithm configuration field (OP). The CASS is assumed to retain an AC certificate (AC X.509 certificate) and a CASS certificate (CASS X.509 certificate). The AC is assumed to retain an AC certificate (AC X.509 certificate), a CASS certificate (CASS X.509 certificate), a CAM certificate, a three OP, a Ki value and a key pairing identifier (ID). Under these assumptions, the sequence chart of a mutual authentication method includes an 'Announcement phase', a 'Key establishment phase', a 'CAM registration phase' and a 'CACS renewal phase' as shown in the Figure 2. + + + +``` + +sequenceDiagram + participant AC + participant CASS + participant CAM + + Note left of AC: Announcement phase + CASS->>CAM: RCASAnnounce + Note right of CASS: Opt + CASS->>CAM: RCASRenewal + + Note left of AC: Key establishment phase + CAM->>CASS: KeyRequest + CASS->>AC: KeyRequest + AC->>CASS: KeyResponse + CASS->>CAM: KeyResponse + Note right of CAM: CAM verifies message integrity and derives encryption keys + + Note left of AC: CAM registration phase + CAM->>CASS: CAMReg + Note right of CASS: CASS verifies message integrity and derives encryption keys, then confirms the keys + CASS->>CAM: CAMRegConfirm + + Note left of AC: CACS renewal phase + CASS->>CAM: RenewInfo + CAM->>CASS: RenewConfirm + +``` + +The sequence chart illustrates the interaction between three entities: AC (Authentication Center), CASS (Certificate Authority Server), and CAM (CAM Client). The process is divided into four distinct phases, each highlighted with a different background color: + +- Announcement phase (Yellow):** The CASS sends an `RCASAnnounce` message to the CAM. An optional `RCASRenewal` message is also shown. +- Key establishment phase (Green):** The CAM sends a `KeyRequest` to the CASS, which in turn sends a `KeyRequest` to the AC. The AC responds with a `KeyResponse` to the CASS, which then forwards it to the CAM. A note indicates that the CAM verifies message integrity and derives encryption keys. +- CAM registration phase (Blue):** The CAM sends a `CAMReg` message to the CASS. A note indicates that the CASS verifies message integrity, derives encryption keys, and then confirms the keys with a `CAMRegConfirm` message to the CAM. +- CACS renewal phase (Pink):** The CASS sends a `RenewInfo` message to the CAM, which responds with a `RenewConfirm` message. + +J.1003(14)\_F02 + +Sequence chart of RCAS network protocol showing four phases: Announcement, Key establishment, CAM registration, and CACS renewal between AC, CASS, and CAM entities. + +Figure 2 – A sequence chart of RCAS network protocol + +## 7.1 Announcement phase + +In the announcement phase, the RCAS headend controls the CASS to transmit an `RCASAnnounce` message or an `RCASRenewal` message to the CAM. The role of this message is to notify the start of RCAS network protocol as well as to provide the CASS server access information to all CAMs. + +The `RCASAnnounce` message provides the 'CAM Client Version' information such as 'CAM HW version', 'CAM SW version' and 'CACS type', etc., as well as 'CASS' information such as the 'IP address of CASS', 'IP connection type (e.g., TCP or UDP)' and the 'Listening port number', etc. The `RCASAnnounce` message is authenticated by the CASS using a hash-based message authentication code (HMAC) scheme and the CASS transmits the authenticated `RCASAnnounce` message to the + +CAM using a multicast scheme. The CAM performs a HMAC message authentication using a common hash key (CHK) which is assumed to be included in the CAM before the start of this phase. The HMAC message authentication is performed to authenticate the RCASAnnounce message received from the CASS and accordingly the CAM performs a key establishment phase. It must be noted that CAM should acquire CHK from the key establishment phase when the CHK of the CAM differs from that of the CASS, or when the CAM is moved to a CASS zone, or when the CAM is in a virgin state. + +The RCAS headend optionally can send an RCASRenewal message to CAMs using CASS when the RCAS headend wants to spread the download time intentionally as well as request key updates or purchase information. By utilizing this message, the RCAS headend can let a CAM know the CACS download time, or request the CAM to send a KeyRequest message or purchase information. To do this, the RCASRenewal message provides the information of CACS image download time, key upgrade request and purchase information request, etc. The RCASRenewal message is authenticated using the same method as that for the RCASAnnounce message. + +## 7.2 Key establishment phase + +In the key establishment phase, the RCAS headend receives a KeyRequest message from the CAM using the CASS in response to the RCASAnnounce message and transmits the received KeyRequest message to the AC. CASS receives the KeyResponse information from the AC in response to the KeyRequest message and transmits the received KeyResponse message to the CAM. + +Specifically, CAM transmits, to the CASS, a KeyRequest message digitally signed by a private key of the CAM. + +The RCAS headend verifies a digital signature of the KeyRequest message using the CASS and transmits a new KeyRequest message to the AC. Here, the new KeyRequest message is regenerated based on a key pairing ID and a CASS ID extracted from the KeyRequest message. + +The RCAS headend searches for a CAM certificate based on the key pairing ID using the AC and authenticates the CAM based on the CAM certificate. The AC defines a result of the authentication of the CAM in the KeyResponse message and transmits the KeyResponse message to the CASS. + +When the CAM is in the virgin state, the AC performs a transfer protocol pairing function. Alternatively, when the CAM is not in the virgin state, the AC performs a function of comparing the received pairing information with an initial pairing value. The detail specification of this pairing process is defined in [ITU-T J.1002]. + +Along with verifying the validation of CAM, the AC performs the process of CAM cloning detection. The detail descriptions concerning CAM cloning detection process are included in Annex C. + +The RCAS headend defines a CASS certificate in the KeyResponse message using the CASS and transmits the KeyResponse message to the CAM. + +When an authentication result value (Auth\_Rst) about the KeyResponse message is set as true, the CASS generates a CHK and an individual hash key (IHK) through a hash key generation process. Then CASS adds the generated CHK and IHK together with the CASS certificate to the KeyResponse message. In addition, the CASS digitally signs the KeyResponse message using a private key of the CASS and encrypts a part of the digitally signed KeyResponse message using a public key of the CAM. Finally CASS transmits the encrypted KeyResponse message to the CAM. + +On the CAM side, a decryption unit of the mutual authentication decrypts the KeyResponse message. The decryption unit decrypts one or more pieces of information contained in the KeyResponse message based on the CAM certificate. + + + +``` + +graph TD + Start([Start]) --> Step1[Receive and analyse +RCASAnnounce msg] + Step1 --> Decision1{Is CAM in VIRGIN state?} + Decision1 -- Yes --> Step5[Transmit KeyRequest +and extract public key +from KeyResponse] + Decision1 -- No --> Decision2{CASS ID of RCASAnnounce msg += CASS ID of CAM} + Decision2 -- No --> Step5 + Decision2 -- Yes --> Step3[Verify HMAC for +RCASAnnounce msg] + Step3 --> Decision3{Does authentication of +RCASAnnounce SUCCEED?} + Decision3 -- No --> Step5 + Decision3 -- Yes --> Step4[Tranmit KeyRequest and +extract public key, +private key and encryption +key from KeyResponse] + Step4 --> End([End]) + Step5 --> End + +``` + +J.1003(14)\_F03 + +Flowchart for Announcement & Key establishment phases in CAM. The process starts with 'Start', followed by 'Receive and analyse RCASAnnounce msg'. It then checks 'Is CAM in VIRGIN state?'. If 'Yes', it proceeds to 'Transmit KeyRequest and extract public key from KeyResponse'. If 'No', it checks 'CASS ID of RCASAnnounce msg = CASS ID of CAM'. If 'No', it proceeds to 'Transmit KeyRequest and extract public key from KeyResponse'. If 'Yes', it proceeds to 'Verify HMAC for RCASAnnounce msg'. It then checks 'Does authentication of RCASAnnounce SUCCEED?'. If 'No', it proceeds to 'Transmit KeyRequest and extract public key from KeyResponse'. If 'Yes', it proceeds to 'Tranmit KeyRequest and extract public key, private key and encryption key from KeyResponse', which then leads to 'End'. + +**Figure 3 – Flow chart for Announcement & Key establishment phases in CAM** + +Figure 3 is a flowchart for the processes of announcement and key establishment phases in the CAM. The CAM receives the RCASAnnounce message and analyses the received RCASAnnounce message. The CAM also determines whether a current state is in the virgin state. When the CAM is in the virgin state or when the CAM is moved to the CASS zone, the updating unit of the decryption unit extracts a newest CHK and updates the original CHK. The CAM determines whether a CASS ID contained in the RCASAnnounce message is identical to a CASS ID contained in the CAM. When determining that the two CASS IDs are different, the CAM performs the 'Transmit KeyRequest & extract public key from KeyResponse' operation. However, when the CAM is not in the virgin state, or when the CAM is not moved to the CASS zone, the authentication unit of the decryption unit performs the HMAC message authentication using the CHK retained in the CAM. The CAM also determines whether authentication of the RCASAnnounce message succeeds. When the authentication of the RCASAnnounce message is determined to have failed, the CAM performs the 'Transmit KeyRequest & extract public key from KeyResponse' operation. Alternatively, when the authentication of the RCASAnnounce message is determined to have succeeded, the CAM transmits + +the KeyRequest message to the CASS and extracts a public key, a private key and an encryption key from the KeyResponse message. + +## 7.3 CAM registration phase + +Between the key establishment phase and the CAM registration phase, an encryption key generation process takes place in the CASS using the method shown in Figure 4. The CASS generates two different encryption keys, the message encryption key (MEK) and the individual CAM client image encryption key (ICCIEK). The MEK and ICCIEK have a key length of 128 bits, are generated using an input of a pseudo random number generator (PRNG) as a master key (MK). Three $K_c$ values among input values of the SHA-1 hash function means that three $K_c$ are generated using three RAND values in RAND\_AC received from a CASS through a KeyResponse message. + + + +``` +graph TD; + AC["Authorization center (AC) +(RAND_AC, Kc)"] --> Input["CAM_ID | 3*Kc | NONCE_CAM | HW_Ver | SW_Ver"]; + Input --> SHA1["SHA1"]; + SHA1 --> MK["Master key (160 bits)"]; + MK --> PRF["PRF"]; + PRF --> MEK["Message encryption key +(PRNG_OUT[0] ... PRNG_OUT[127])"]; + PRF --> ICCIEK["Individual CAM client image encryption key +(PRNG_OUT[128] ... PRNG_OUT[256])"]; +``` + +The flowchart illustrates the encryption key generation process. It begins with the Authorization center (AC) providing RAND\_AC and Kc. These are combined into a message containing CAM\_ID, 3\*Kc, NONCE\_CAM, HW\_Ver, and SW\_Ver. This message is processed by SHA1 to produce a Master key (160 bits). This master key is then processed by a PRF to generate two encryption keys: the Message encryption key (MEK) and the Individual CAM client image encryption key (ICCIEK). The MEK is derived from PRNG\_OUT[0] to PRNG\_OUT[127], and the ICCIEK is derived from PRNG\_OUT[128] to PRNG\_OUT[256]. The diagram is labeled J.1003(14)\_F04. + +Flowchart of encryption key generation method + +**Figure 4 – Encryption keys generation method** + +In the CAM registration phase, the CAM transmits to the CASS, a CAMReg message containing hashed encryption keys which are the MEK and ICCIEK. After receiving a CAMReg message, the CASS generates two encryption keys using the same method shown in Figure 4 and then determines whether the encryption keys from the CAM are identical to the encryption keys which were generated in the CASS by comparing the hashed values of the MEK and ICCIEK. Then the CASS controls the CAMRegConfirm message to be transmitted to the CAM in response to the CAMReg message when the encryption keys are determined to be identical. + +When the encryption keys from the CAM are determined to differ from that from the CASS, the CASS transmits inconsistency information through a status message. + +The CAMRegConfirm message is authenticated using the HMAC-SHA1 method with the IHK and is encrypted using AES, the common CAM client image encryption key (CCCIEK), the initialization vector (IV) for ICCIEK encryption, the initialization vector for CCCIEK encryption, the initialization vector for MEK encryption and the Session\_ID. The CCCIEK generation method is shown in Figure 5. + +![Flowchart of the CCCIEK generation method. The process starts with CASS, which outputs CASS_Info | RAND | CAM_Client_Version. This is input to SHA1, which outputs a Master key (160 bits). This Master key is input to PRF, which outputs the Common CAM client image encryption key (PRNG_OUT[0] ... PRNG_OUT[127]). The diagram is labeled J.1003(14)_F05.](33ed1f9b27c7c21c797aa928b0f06851_img.jpg) + +``` + +graph TD + CASS[CASS] --> CASS_Info["CASS_Info | RAND | CAM_Client_Version"] + CASS_Info --> SHA1[SHA1] + SHA1 --> MasterKey["Master key (160 bits)"] + MasterKey --> PRF[PRF] + PRF --> CommonKey["Common CAM client image encryption key +(PRNG_OUT[0] ... PRNG_OUT[127])"] + J100314_F05[J.1003(14)_F05] + +``` + +Flowchart of the CCCIEK generation method. The process starts with CASS, which outputs CASS\_Info | RAND | CAM\_Client\_Version. This is input to SHA1, which outputs a Master key (160 bits). This Master key is input to PRF, which outputs the Common CAM client image encryption key (PRNG\_OUT[0] ... PRNG\_OUT[127]). The diagram is labeled J.1003(14)\_F05. + +**Figure 5 – CCCIEK generation method** + +## 7.4 CACS renewal phase + +In the CACS renewal phase, the RCAS headend controls RenewInfo from the CASS to the CAM. Here, the RenewInfo is used to permit the CAM to download CACS image information. + +After the HMAC message authentication is performed using the private key and a message is encrypted using the AES algorithm with the MEK and the IV of the MEK, the RenewInfo is transmitted to the CAM. + +The CAM receives the RenewInfo and normally performs message authentication and decryption operations. It then downloads the CACS image information from a server in which the CACS image information is stored. + +Since the CACS image information is encrypted using the AES algorithm with the ICCIEK and the CCCIEK, the CAM decrypts the CACS image information using the ICCIEK and the CCCIEK. + +A RenewConfirm message in response to the RenewInfo is transmitted from the CAM to the CASS. In addition when the PurchaseReport\_REQ is defined in the RenewInfo, the CAM applies the HMAC to the PurchaseReport message using the encryption key. Then the CAM transmits the encrypted PurchaseReport message to the CASS. + +# 8 Protocol security + +## 8.1 Message security + +In the cases of KeyRequest and KeyResponse messages, the message header and message content are digitally signed and delivered with the message itself. Some parameters in the KeyResponse message are encrypted with the public key encryption method. The other messages except the KeyRequest and KeyResponse are encrypted and authenticated as shown in Figure 6. The AES-128-CBC method is used for message content encryption. Note that message contents are basic encoding rules (BER) encoded before being AES-128-CBC encrypted. For message authentication and integrity, HMAC-SHA1 is used. The inputs of the HMAC-SHA1 process are the message header and the BER encoded message content. + + + +Figure 6: Message encryption and the HMAC process in an RCAS headend. The diagram shows the flow of data from a Header and Content through various processing blocks. The Header is processed by an HMAC-SHA1 block to produce 'Hdr/Cnt after HMAC'. The Content is processed by a BER encoder to produce 'Content after BER encoding', which is then processed by an AES-128-CBC encryption block to produce 'Content after AES encryption'. Both 'Hdr/Cnt after HMAC' and 'Content after AES encryption' are combined via a concatenation symbol (two vertical lines) to form the final output structure: Header, Content after AES encryption, and Hdr/Cnt after HMAC. A label 'J.1003(14)\_F06' is present at the bottom right. + +**Figure 6 – Message encryption and the HMAC process in an RCAS headend** + +## 8.2 CAM client image security + +The CAM client image is encrypted using the AES-128-CBC method. For CAM client image integrity, the SHA1 algorithm is applied to the CAM client image itself and the RCAS headend delivers the output of the SHA1 algorithm to a CAM using the RenewInfo message. On the CAM side, the decryption and integrity check process are carried out as shown in Figure 7. Initially the CAM client image is decrypted using the AES-128-CBC method and then the SHA1 algorithm is applied to the output of the decryption. Finally, the CAM can check the CAM client image integrity by comparing the output of the SHA1 algorithm and the delivered hashed value of the CAM client image. + + + +Figure 7: RCAS client image encryption/decryption and integrity check process. The diagram is split into two main sections: RCAS headend (left) and CAM (right). In the RCAS headend, the CAM client image is processed by a SHA1 block to produce 'CAM client image after SHA1', which is then placed into the 'RenewInfo content' of a 'RenewInfo Msg. header'. The CAM client image is also processed by an AES-128-CBC encryption block to produce 'CAM client image after AES encryption'. The 'RenewInfo content' is combined with an HMAC block. In the CAM, the 'CAM client image after AES encryption' is processed by an AES-128-CBC decryption block to produce the original 'CAM client image'. This 'CAM client image' is then processed by a SHA1 block to produce 'CAM client image after SHA1'. The 'CAM client image after SHA1' from the RCAS headend is compared with the 'CAM client image after SHA1' from the CAM via a 'SHA1 verification' block. A label 'J.1003(14)\_F07' is present at the bottom right. + +**Figure 7 – RCAS client image encryption/decryption and integrity check process** + +## 8.3 Security parameters generation + +Security parameters used in the RCAS network protocol are generated via the method specified in Table 1. + +**Table 1 – Security parameter generation method** + +| Parameter | Generation method | +|-----------|---------------------------------------------------------------------------------------------------------------------------------------| +| NONCE_CAM | Random value with a size of 16 bytes
Each session is required to have a unique NONCE_CAM value | +| RAND_AC | Three random values with a size of 16 bytes
Each random value of three of them is required to be unique with respect to each other | +| IV | Random value with a size of 16 bytes
Each session is required to have a unique IV value | +| Ki | Pre-shared key with a size of 128 bits
Each CAM is required to have a unique Ki value | +| Kc | It has a size of 64 bits and is recommended to be generated using the COMP128 algorithm version 4 (COMP128-4, GSM-MILENAGE)) | +| IHK | IHK = SHA1[RAND IHK CASS_IP Key_Paring_ID] | +| CHK | CHK = SHA1[RAND CHK CASS_Info] | +| MEK | See clause 7.3 and Figure 4 | +| ICCIEK | See clause 7.3 and Figure 4 | +| CCCIEK | See clause 7.3 and Figure 5 | + +# 9 Message + +## 9.1 Message format + +It is proposed that the message format between the CASS in the headend and the CAM in the user terminal is specified as shown in the Figure 3. The message format consists of a header, the message contents and the HMAC or message signature for message authentication. + + + +| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +|---------------------------|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|------------------|----|----|----|----|----|---|----------|---|---|---|---|---|---|---| +| 31 | 30 | 29 | 28 | 27 | 26 | 25 | 24 | 23 | 22 | 21 | 20 | 19 | 18 | 17 | 16 | 15 | 14 | 13 | 12 | 11 | 10 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| Message type | | | | | | | | | | | | | | | | Message lenght | | | | | | | | | | | | | | | +| Message length | | | | | | | | | | | | | | | | Message nonce | | | | | | | | | | | | | | | +| Message nonce | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| Message nonce | | | | | | | | | | | | | | | | Protocol version | | | | | | | Reserved | | | | | | | | +| Message contents | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| HMAC or message signature | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + +J.1003(14)\_F08 + +**Figure 8 – Proposed message format** + +It is proposed that the elements in the message header are specified as shown in Table 2. Note that ASN.1 syntax is used for specifying the 'Type (size)'. + +**Table 2 – Details of the proposed security message header** + +| Parameters | Type (size) | Description | | | | | | | | | | | | | | | | | | | | | | | | | | | +|------------------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------|--------------|----------------------|------------|----------|-------------|-----------------|--------|----------|---------------|-----------------|-----------|----------|--------------|-----------------|----------------|-----------------|------------|----------|-------------|-----------------|---------------|----------|----------------|-----------------| +| Message type | OCTET STRING (SIZE (2)) |
- – 0x0001: RCASAnnounce
- – 0x0002: RCASRenewal
- – 0x0003: KeyRequest
- – 0x0004: KeyResponse
- – 0x0005: CAMReg
- – 0x0006: CAMRegConfirm
- – 0x0007: RenewInfo
- – 0x0008: RenewConfirm
- – 0x0009: PurchaseReport
- – 0x000A: Status
- – 0x000B: LogRequest
- – 0x000C: LogResponse
- – 0x000D: KeyRegRequest
- – 0x000E: KeyRegResponse
This is an identifier which is used for preventing reply attack. The message initiator generates the new nonce and delivers it and the copied value of the nonce is used for the reply message. Note that the RCASAnnounce message uses a counter value, which is increased by one whenever a message is changed, as a nonce.
| Security Message | Usage |
|---|---|
| RCASAnnounce | Counter () |
| KeyRequest | Nonce #1 |
| KeyResponse | Copied nonce #1 |
| CAMReg | Nonce #2 |
| CAMRegConfirm | Copied nonce #2 |
| RenewInfo | Nonce #3 |
| RenewConfirm | Copied nonce #3 |
| PurchaseReport | Copied nonce #3 |
| LogRequest | Nonce #4 |
| LogResponse | Copied nonce #4 |
| KeyRegRequest | Nonce #5 |
| KeyRegResponse | Copied nonce #5 |
- 1. The CAM sends a KeyRegRequest message that includes the following parameters to the CASS:
- – Session ID
- – Key pairing ID
- – CAM's public key certificate
- 2. The CASS checks the validity of the received KeyRegRequest message with the following sequences:
- ① The CASS checks the validity of the CAM's public key certificate through the certificate chains
- ② If the CAM's public certificate is valid, the CASS authenticates the KeyRegRequest message with a digital signature method
- ③ If the CASS successfully authenticates the message, it sends the Session ID, Key Pairing ID, CAM ID, CAM HW version, CAM SW version and CAM's public key certificate to the AC. Otherwise, the CASS sends a failure message to the CAM and terminates the RCAS network protocol.
- 3. The AC registers the CAM ID after receiving the KeyRegRequest message from the CASS and generates RCAS network protocol relevant encryption keys and IVs. Note that the definitions of all keys except the authorization key (AK) are the same as the ones used in the normal RCAS network protocol:
- – AK
- – ICCIEK and ICCIEK's IV
- – CCCIEK and CCCIEK's IV
- – MEK and MEK's IV
- – KPK
The key generation methods are as follows:
Note that SHA-1(x y) denotes the result of applying the SHA-1 function to the concatenated bit strings x and y and Truncate(x,n) denotes the result of truncating x to its left-most n bits
- 1. AK is generated using the method below:
Note that AK_PAD is a SHA-1 padding value and it is generated by repeating 0xA3 63 times. Pseudo random number generation function (PRF) is a pseudo random number generation function- – AK = Truncate(PRf ( SHA-1 ( AK_PAD CAM_ID Session_ID NONCE_CAM HW_Version SW_Version ) ),128)
- 2. ICCIEK is generated using the method below:
Note that ICCIEK_PAD is a SHA-1 padding value, and it is generated by repeating 0xA6 63 times.- – ICCIEK = Truncate ( SHA-1( ICCIEK_PAD AK ), 128)
- 3. CCCIEK is generated using the method below:
Note that CCCIEK_PAD is a SHA-1 padding value and it is generated by repeating 0xAC 63 times.
- – CCCIEK = Truncate (SHA-1( CCCIEK_PAD AK ), 128)
4. MEK is generated using the method below:
Note that MEK_PAD is a SHA-1 padding value and it is generated by repeating 0x3A 63 times.
- – MEK = SHA-1( MEK_PAD AK), 128 )
5. MAK is generated using the method below:
Note that MAK_PAD is a SHA-1 padding value and it is generated by repeating 0x6A 63 times.
- – MAK = SHA-1( MAK_PAD AK), 128 )
6. Key pairing key (KPK) is generated using the method:
Note that KPK_PAD is a SHA-1 padding value, and it is generated by repeating 0xCA 63 times.
- – KPK = SHA-1( KPK_PAD AK), 128 )
(CAM → CASS) |
-- ===== -- KeyRegRequestMessage -- ===== KeyRegReqMsgContent ::= SEQUENCE { sessionID OCTET STRING (SIZE (10)), keyParingID OCTET STRING (SIZE (48)), cAMID OCTET STRING (SIZE (40)), -- CAM chip version hWVersion OCTET STRING (SIZE (4)), -- SW version of Bootloader sWversion OCTET STRING (SIZE (4)), -- cAMCertificate MUST be DER encoded cAMCertificate BIT STRING } |
+
+### B.1.2 KeyRegResponse
+
+| Items | Descriptions |
+|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Message roles | The RCAS system uses this message in the Keying & Registration phase and the CASS sends it to deliver AK to the CAM. |
+| Message encryption | Only AK is encrypted using the CAM's public key |
+| Message authentication | digital signature per CASS |
+| Message processing | - 1. The AC generates the listed parameter below and sends the Session ID and AK to the CASS
- – Session ID
- – AK
- – ICCIEK
- – ICCIEK IV
- – CCCIEK
- – CCCIEK IV
- – MEK
- – MEK IV
- – MAK
- – MAK IV
- – KPK
- 2. The CAM performs the message authentication process using a digital signature method
- 3. If the CAM can successfully verify the message authentication, it decrypts AK from the message using the CAM's private key
- 4. The CAM generates the listed parameters below using the same key generation methods as the ones used in the AC.
- – ICCIEK
- – ICCIEK IV
- – CCCIEK
- – CCCIEK IV
- – MEK
- – MEK IV
- – MAK
- – MAK IV
- – KPK
(CASS → CAM) |
-- ===== -- KeyRegResponseMessage -- ===== KeyRegRspMsgContent ::= SEQUENCE { sessionID OCTET STRING (SIZE (10)), rSAEncryptedContent } RSAEncryptedContent ::= RSAENCRYPTED{SEQUENCE { aK OCTET STRING (SIZE (16)) }} RSAENCRYPTED { ToBeEnciphered } ::= BIT STRING ( CONSTRAINED BY { -- shall be the result of applying the encipherment procedure -- to the -- BER-encoded octets of a value of -- ToBeEnciphered } ) |
+
+# Annex C
+
+## CAM cloning detection process
+
+(This annex forms an integral part of this Recommendation.)
+
+
+
+```
+
+graph TD
+ Start([Start]) --> RI[Receive information]
+ RI --> ID_V[ID validity check operation]
+ RI --> CAM_S[CAM state validity check operation]
+ RI --> V_I[Version information validity check operation]
+
+ subgraph ID_V [ID validity check operation]
+ ID_V1{Does CASS_ID exist in DB?}
+ ID_V2{Does CAM_ID exist in DB?}
+ ID_V3{Does DSC_ID exist in DB?}
+ ID_V1 -- No --> B1((B))
+ ID_V1 -- Yes --> ID_V2
+ ID_V2 -- No --> B2((B))
+ ID_V2 -- Yes --> ID_V3
+ ID_V3 -- No --> B3((B))
+ ID_V3 -- Yes --> CAM_S
+ end
+
+ subgraph CAM_S [CAM state validity check operation]
+ CAM_S1{CAM state = first state?}
+ CAM_S2{CAM state = second state?}
+ CAM_S3{CAM state = third state?}
+ CAM_S4{Does CAM version exist?}
+ CAM_S5[Authenticate CAM]
+ CAM_S6((A))
+ CAM_S1 -- Yes --> CAM_S5
+ CAM_S1 -- No --> CAM_S2
+ CAM_S2 -- Yes --> CAM_S4
+ CAM_S2 -- No --> CAM_S3
+ CAM_S3 -- Yes --> CAM_S5
+ CAM_S3 -- No --> B4((B))
+ CAM_S4 -- Yes --> CAM_S5
+ CAM_S4 -- No --> B5((B))
+ CAM_S5 -- Yes --> CAM_S6
+ end
+
+ subgraph V_I [Version information validity check operation]
+ V_I1{Is image version information updated?}
+ V_I2{Is CASS_ID updated?}
+ V_I3((A))
+ V_I4((B))
+ V_I1 -- Yes --> V_I3
+ V_I1 -- No --> V_I2
+ V_I2 -- Yes --> V_I3
+ V_I2 -- No --> V_I4
+ end
+
+ B1 --> AF[Authentication fails]
+ B2 --> AF
+ B3 --> AF
+ B4 --> AF
+ B5 --> AF
+ V_I4 --> AS[Authentication succeeds]
+ CAM_S6 --> AS
+
+ AF --> End([End])
+ AS --> End
+
+```
+
+Flowchart of the CAM cloning detection process in an AC when a 'RenewConfirm' is not received from a CASS. The process starts with 'Start' and 'Receive information'. It then enters three parallel check operations: 'ID validity check operation', 'CAM state validity check operation', and 'Version information validity check operation'. The 'ID validity check' checks if CASS\_ID, CAM\_ID, and DSC\_ID exist in a DB. The 'CAM state validity check' checks if the CAM is in its first, second, or third state. The 'Version information validity check' checks if the image version information or CASS\_ID has been updated. All three checks lead to a final 'Authentication fails' or 'Authentication succeeds' outcome, which ends the process.
+
+**Figure C.1 – CAM cloning detection process in an AC when a 'RenewConfirm' is not received from a CASS**
+
+Figure C.1 is a flowchart illustrating a CAM copy detection method using an AC. The CAM copy detection method of Figure C.1 is performed when a 'RenewConfirm' is not received from a CASS. In other words, when the CASS has a function of reusing a CAM authentication result received from the AC, instead of deleting the CAM authentication result, until a CAM receives the 'RenewConfirm', the CAM copy detection method of Figure C.1 is performed. The CAM copy detection method of Figure C.1 broadly includes an 'ID validity check operation', a 'CAM state validity check operation' and a 'version information validity check operation'.
+
+In the 'Receive information' operation, the AC receives, from at least one CASS, the CAM\_ID, CASS\_ID and DSC\_ID.
+
+In the 'ID validity check operation', the AC determines whether a CASS\_ID, a CAM\_ID and a DSC\_ID that are received from the at least one CASS exist in a DB. When the CASS\_ID, the CAM\_ID and the DSC\_ID are determined not to exist in the DB, the AC determines the value of the 'Auth\_Rst' to be 'failure'.
+
+In the 'CAM state validity check operation', the AC performs a second check operation of checking the validity of the CAM based on state information. Here, the state information of a CAM is received from the at least one CASS. Additionally, the state information of the CAM includes first state information indicating a state before a RCAS service is provided to a CAM, second state information
+
+indicating a state where a CAM is included in at least one MSO and joins the RCAS service and third state information indicating a state where a CAM is withdrawn from the RCAS service. Specifically, when an authentication request is received from a CAM in a 'Virgin' state, the AC changes the 'Virgin' state of the CAM to an 'Auth\_Service' and sets the value of the 'Auth\_Rst' to be 'success'. When an authentication request is received from a CAM in the 'Auth\_Service' state, the AC performs a third check operation. Furthermore, when an authentication request is received from a CAM in an 'Auth\_Not\_Service' state, the AC changes the 'Auth\_Not\_Service' state of the CAM to the 'Auth\_Service' state and sets the value of the 'Auth\_Rst' to be 'success'.
+
+In the 'version information validity check operation', the AC performs the third check operation of checking the validity of a CAM based on the version information. Here, the AC performs the third check operation, only when a CAM requesting authentication is in the 'Auth\_Service' state. First, the AC downloads in the DB, hardware and software version information corresponding to an ID value of the CAM that requests authentication. Subsequently, the AC determines whether the hardware and software version information called from the DB is identical to the hardware and software version information for the CAM received from the at least one CASS. When the called hardware and software version information is determined to be identical to the received hardware and software version information, the AC proceeds to a next operation. Conversely, when the called hardware and software version information is determined to differ from the received hardware and software version information, the AC sets the value of the 'Auth\_Rst' to be 'failure'. Additionally, the AC determines whether CAS image version information is updated, only when the received hardware and software version information is determined to be identical to the hardware and software version information stored in the DB. Here, the updated CAS image version information indicates that the CAS image version information stored in advance in the DB differs from version information newly received from the CASS. When determining that the CAS image version information is not updated, the AC determines whether a CASS-ID value is changed. Specifically, the AC determines whether a CASS-ID received from the CASS differs from a CASS-ID that is stored in the DB and is used to identify a CASS including a corresponding CAM. The AC determines whether the CASS-ID value is changed, to permit authentication of a normal CAM when the normal CAM moves on a CASS zone, despite the CAS image version information being updated. Finally, the AC authenticates the at least one CAM, based on a result of at least one of the first check operation, the second check operation and the third check operation. Here, when the state of the at least one CAM corresponds to the first state information and the third state information in the second check operation, the AC authenticates the at least one CAM. Additionally, when a validity check result value for the 'Version Info' is updated and when the state of the at least one CAM corresponds to the second state information, the AC authenticates a CAM.
+
+
+
+```
+
+graph TD
+ Start([Start]) --> Init[Number of times CAM is authenticated = 0]
+ Init --> C((C))
+ C --> RecInfo[Receive information]
+
+ subgraph Validation_Paths
+ direction LR
+ subgraph Path1
+ D1{Does CASS_ID exist in DB?} -- No --> B1((B))
+ D1 -- Yes --> D2{Does CAM_ID exist in DB?}
+ D2 -- No --> B2((B))
+ D2 -- Yes --> D3{Does DSC_ID exist in DB?}
+ D3 -- No --> B3((B))
+ D3 -- Yes --> A1((A))
+ end
+
+ subgraph Path2
+ D4{CAM state = 'Virgin' state?} -- Yes --> A2((A))
+ D4 -- No --> D5{CAM state = 'Auth_Service' state?}
+ D5 -- Yes --> D6{Number of times CAM is authenticated < 1}
+ D6 -- Yes --> A3((A))
+ D6 -- No --> A4((A))
+ D5 -- No --> D7{CAM state = 'Auth_Not_Service' state?}
+ D7 -- Yes --> A5((A))
+ D7 -- No --> B4((B))
+ end
+
+ subgraph Path3
+ D8{Does CAM HW/SW version exist in DB?} -- Yes --> A6((A))
+ D8 -- No --> D9{Is image client version updated?}
+ D9 -- Yes --> A7((A))
+ D9 -- No --> D10{Is CASS_ID changed?}
+ D10 -- Yes --> A8((A))
+ D10 -- No --> B5((B))
+ end
+ end
+
+ RecInfo --> Path1
+ RecInfo --> Path2
+ RecInfo --> Path3
+
+ A((A)) --> AuthSucceed[Authentication succeeds]
+ AuthSucceed --> D11{Number of times CAM is authenticated > allowed number of times CAM is authenticated?}
+
+ D11 -- Yes --> AuthFails[Authentication fails]
+ B((B)) --> AuthFails
+ AuthFails --> TransmitAuthRst1[Transmit Auth_Rst to CASS]
+ TransmitAuthRst1 --> End([End])
+
+ D11 -- No --> TransmitAuthRst2[Transmit Auth_Rst to CASS]
+ TransmitAuthRst2 --> IncCount[Increment by '1' number of times CAM is authenticated]
+ IncCount --> D12{Is image information authentication request message received?}
+
+ D12 -- No --> C_Loop((C))
+ D12 -- Yes --> ChangeState[Change to second state]
+ ChangeState --> ResetCount[Number of times CAM is authenticated = 0]
+ ResetCount --> End
+
+```
+
+Flowchart of CAM cloning detection process in AC when a 'RenewConfirm' is received from a CASS. The process starts with initializing a counter and receiving information. It then branches into three parallel validation paths checking database existence of IDs, CAM states, and version updates. These paths lead to either success (A), failure (B), or a loop (C). Success leads to further checks on authentication counts and message types before ending or resetting.
+
+J.1003(14)\_FC.2
+
+**Figure C.2 – CAM cloning detection process in AC when a 'RenewConfirm' is received from a CASS**
+
+Figure C.2 is a flowchart illustrating a CAM copy detection method using an AC. The CAM copy detection method of Figure C.2 is performed when a 'RenewConfirm' is received from a CASS. In other words, the CAM copy detection method of Figure C.2 is performed when the CASS does not have a function of reusing a CAM authentication result received from the AC instead of deleting the CAM authentication result, until the CAM receives the 'RenewConfirm' message.
+
+In the first operation, the AC checks a number of times that a CAM is authenticated to zero.
+
+In the 'Receive information' operation, the AC receives, from at least one CASS, CAM\_ID, CASS\_ID, and DSC\_ID.
+
+The first check operation of Figure C.2 is performed in the same manner as the first check operation of Figure C.1.
+
+The second check operation of Figure C.2 is performed in the same manner as the second check operation of Figure C.1, except for checking of the number of times that a CAM is authenticated. When the number of times the CAM is authenticated is less than '1', the AC performs a third check operation. Otherwise, the AC performs a fourth check operation of repeatedly checking whether CAM authentication is permitted. Here, a third check operation is performed in the same manner as the third check operation of Figure C.2.
+
+The fourth check operation of Figure C.2 is performed so that the AC repeatedly permit an authentication request from an identical CAM within the number of times the identical CAM is authenticated, until the 'RenewConfirm' is received from the CASS. Here, the number of times is determined in advance by an operator.
+
+# Bibliography
+
+- [b-ITU-T J.93] Recommendation ITU-T J.93 (1998), *Requirements for conditional access in the secondary distribution of digital television on cable television systems.*
+- [b-ITU-T J.193] Recommendation ITU-T J.193 (2004), *Requirements for the next generation of set-top-boxes.*
+- [b-ITU-T J.290] Recommendation ITU-T J.290 (2006), *Next generation set-top box core architecture.*
+
+
+
+# SERIES OF ITU-T RECOMMENDATIONS
+
+| | |
+|-----------------|----------------------------------------------------------------------------------------------------|
+| Series A | Organization of the work of ITU-T |
+| Series D | General tariff principles |
+| Series E | Overall network operation, telephone service, service operation and human factors |
+| Series F | Non-telephone telecommunication services |
+| Series G | Transmission systems and media, digital systems and networks |
+| Series H | Audiovisual and multimedia systems |
+| Series I | Integrated services digital network |
+| Series J | Cable networks and transmission of television, sound programme and other multimedia signals |
+| Series K | Protection against interference |
+| Series L | Construction, installation and protection of cables and other elements of outside plant |
+| Series M | Telecommunication management, including TMN and network maintenance |
+| Series N | Maintenance: international sound programme and television transmission circuits |
+| Series O | Specifications of measuring equipment |
+| Series P | Terminals and subjective and objective assessment methods |
+| Series Q | Switching and signalling |
+| Series R | Telegraph transmission |
+| Series S | Telegraph services terminal equipment |
+| Series T | Terminals for telematic services |
+| Series U | Telegraph switching |
+| Series V | Data communication over the telephone network |
+| Series X | Data networks, open system communications and security |
+| Series Y | Global information infrastructure, Internet protocol aspects and next-generation networks |
+| Series Z | Languages and general software aspects for telecommunication systems |
\ No newline at end of file
diff --git a/marked/J/T-REC-J.1015.1-202004-I_PDF-E/raw.md b/marked/J/T-REC-J.1015.1-202004-I_PDF-E/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..423b83a61bdbad931635153764a9d1f7ba4bc8b0
--- /dev/null
+++ b/marked/J/T-REC-J.1015.1-202004-I_PDF-E/raw.md
@@ -0,0 +1,318 @@
+
+
+**ITU-T**
+
+**J.1015.1**
+
+TELECOMMUNICATION
+STANDARDIZATION SECTOR
+OF ITU
+
+(04/2020)
+
+SERIES J: CABLE NETWORKS AND TRANSMISSION
+OF TELEVISION, SOUND PROGRAMME AND OTHER
+MULTIMEDIA SIGNALS
+
+Conditional access and protection – Exchangeable
+embedded conditional access and digital rights
+management solutions
+
+---
+
+**Embedded common interface for exchangeable
+CA/DRM solutions: The advanced security
+system – Key ladder block: Authentication of
+control word-usage rules information and
+associated data 1**
+
+Recommendation ITU-T J.1015.1
+
+
+
+# Recommendation ITU-T J.1015.1
+
+## **Embedded common interface for exchangeable CA/DRM solutions: The advanced security system – Key ladder block: Authentication of control word-usage rules information and associated data 1**
+
+## Summary
+
+Recommendation ITU-T J.1015.1 is part of a series covering the advanced security system key ladder block for the embedded common interface for exchangeable conditional access/digital rights management (CA/DRM) solutions specification.
+
+## History
+
+| Edition | Recommendation | Approval | Study Group | Unique ID* |
+|---------|----------------|------------|-------------|---------------------------------------------------------------------------|
+| 1.0 | ITU-T J.1015.1 | 2020-04-23 | 9 | 11.1002/1000/13837 |
+
+## Keywords
+
+Conditional access, CA, digital rights management, DRM, swapping.
+
+---
+
+\* To access the Recommendation, type the URL The mapping between the fields and the scheme_type defined in clause 7.2.2 is as follows:
NONE: Not encrypted;
SM4-CTR: sm4t;
SAMPLE-SM4-CTR: sm4r;
SM4-CBC: sm4c;
SAMPLE-SM4: sm4s. | +| URI | URI string for obtaining the license. The format is as follows:
"data:text/plain;base64, (the string of the base64-encoded pssh data specified in Table 7-6)" | Must exist in case METHOD is not NONE | +| KEYID | A hexadecimal integer that represents the key identifier. | Optional | +| IV | A hexadecimal integer that represents the initialiation vector for encryption. | Optional | +| KEYFORMAT | Set to "urn:uuid:3d5e6d35-9b9a-41e8-b843-dd3c6e72c42c" | Must exist in case METHOD is not NONE | + +Example: #EXT-X-KEY:METHOD=SM4-CBC, URI="data:text/plain;base64, AAAAi3Bzc2gAAAAPV5tNZuaQei4Q908bnLELAAAAGt7InZlcNpb24iOiJWMS4wliwiY29udGVudEIEIjoiYzJaaGMxSkJaWFY1U0VwR1UwcEliLCJraWRzIjpbInU3Nm1oNi90dUpDSnpZaUp2Y3U4ZHc9PSJdLCJibnNjaGVtYSI6InNtNGMifQ==",KEYID=0xbbbea687afedb89089cd8889bdcbbc77,IV=0x6c3369747530627476796a7679366d6c,KEYFORMAT="urn:uuid:3d5e6d35-9b9a-41e8-b843-dd3c6e72c42c" + +This Recommendation supports two HLS protocols encryption, which are HLS+TS and CMAF (CENC). In the HLS+TS mode, the content encryption information defined by the URI attribute of #EXT-X-KEY is used. + +# 8 License format + +## 8.1 License structure + +The license of digital rights management for video and audio content distribution (DRMVACD) consists of content, authorized objects, keys, key usage rules and license verification data, as shown in Figure 8-1. + + + +Figure 8-1: License structure diagram. A vertical stack of five boxes labeled 'License' at the top, followed by 'Content', 'Authorized object', 'Keys', 'Key usage rules', and 'License verification data'. Below the diagram is the text 'J.1041(25)'. + +**Figure 8-1 – License structure** + +The elements of the license are described as follows: + +- a) Content is digital information such as graphics, text, audio, video, and so on. +- b) The authorized object is the relevant rights bearer of the specified content. The authorized object is described by its unique identifier. +- c) A key is the key information contained in the license, including the key type, algorithm, key data, and so on. +- d) A key usage rule includes key index information and relevant rule information such as start time, end time, time period, number of uses, etc. The key should be reasonably used according to the key usage rules. +- e) The license verification data is used to verify all the unit data in front of it to ensure the integrity of the data. + +## **8.2 License encoding** + +### **8.2.1 Encoding method** + +License encoding consists of a license index unit and a series of basic units. The license index unit describes the version of the license, the license identifier (ID), and the number of basic units. The basic units include content unit, authorized object unit, key unit, key usage rule unit and license verification data unit, and so on. When a license is issued, it consists of one license index unit and one or more subsequent basic units, and the license index unit should be the first unit of the license. The license encoding structure is shown in Figure 8-2. + + + +Figure 8-2: License encoding structure diagram. A horizontal sequence of boxes: 'License index unit', 'Basic unit 1', 'Basic unit 2', '...', 'Basic unit n', and 'License verification data unit'. Below the diagram is the text 'J.1041(25)'. + +**Figure 8-2 – License encoding structure** + +All the license index unit and the basic units in the license consist of three parts which are unit identifier, length and data. The unit encoding method is shown in Figure 8-3. + + + +Figure 8-3: Unit encoding method diagram. A box divided into three main sections: 'Identifier' (containing 'Type 8 bits' and 'Index 8 bits'), 'Length' (containing 'Length 16 bits'), and 'Data' (containing 'Data N \* 8 bits'). Below the diagram is the text 'J.1041(25)'. + +**Figure 8-3 – Unit encoding method** + +The identifier consists of 2 bytes, including the type and index. The first byte is the type, and the second byte is the index of the unit in the license which is used to support segmented transmission of the license. The index of the unit starts from 0. Since the license index unit is the first unit of the license, its index is always 0, and the index of the basic units after the license index unit are incremented from there. + +Length is the length of the actual data information for the unit, which is represented by two bytes. + +Data is the actual data of the unit. + +Unit type is defined in Table 8-1. + +**Table 8-1 – Unit type** + +| Type | Encoding | +|---------------------------|-----------| +| License index | 0x00 | +| Content | 0x01 | +| Authorized object | 0x02 | +| Key | 0x03 | +| Key usage rule | 0x04 | +| License verification data | 0xFF | +| Reserved | 0x05~0xFE | + +A license consists of multiple independent units. The number and type of the units are identified by the license index unit. The authorized object unit contains information about the authorized party. The content unit includes a unique identifier of the key unit, and the content unit may correspond to multiple key units. The key usage rule unit corresponds to the key unit through the key identifier in it. The key unit corresponds to the key unit that encrypts the key through the upper key identifier. + +The DRM server generates a random session key which is a symmetric key used to encrypt the CEK and encrypts this session key with DRM client's public key. DRM server also generates a random hash-based message authentication code (HMAC) key, which is used to calculate HMAC to protect the integrity of the license, and use DRM client's public key to encrypt this HMAC key. The key units include CEK unit, session key unit, HMAC key unit, etc. License verification data unit is the last unit of a license, and one license has only one license verification data unit. The license verification data unit uses HMAC to protect the integrity and validity of the license. The license format is shown in Figure 8-4. + + + +J.1041(25) + +Diagram of License Format showing a vertical stack of units: License index unit, Content unit, Authorized object unit, CEK unit, Key usage rule unit, Session key unit, HMAC key unit, and License verification data unit. A bracket on the left labeled 'Data used to calculate license verification data' groups the last five units. Arrows point from the CEK unit, Key usage rule unit, and License verification data unit to the right. + +**Figure 8-4 – License Format** + +### 8.2.2 License index unit + +The license index unit is the first unit of the license, and includes version number, license identifier, the number of basic units and a timestamp. The data structure of license index unit is shown in Table 8-2. + +**Table 8-2 – Data structure of license index unit** + +| Field | Bits | Type | Description | +|-------------|------|--------|--------------------------------------| +| Type | 8 | uimsbf | 0x00 | +| Index | 8 | uimsbf | 0x00 | +| Length | 16 | uimsbf | Data length | +| Version | 8 | uimsbf | License version | +| LicenseID | 64 | uimsbf | License ID | +| UnitsNumber | 8 | uimsbf | Number of basic units in the license | +| TimeStamp | 32 | uimsbf | Timestamp | + +Type: the unit type, the license index unit type is 0x00. + +Index: the unit index, which is represented by one byte. The index of license index unit is 0. + +Length: the unit length, which is the length of the data after Length. + +Version: license version number, currently 0x02. + +LicenseID: unique identifier of the license. + +UnitsNumber: the number of basic units included after this license index unit. + +TimeStamp: the current UTC time when the license is generated, represented as the number of seconds since 00:00:00 on January 1, 1970. + +### 8.2.3 Content unit + +The content unit type is 0x01, and the data structure is shown in Table 8-3. + +**Table 8-3 – Data structure of content unit** + +| Field | Bits | Type | Description | +|-------------------------------|----------------------|--------|-------------------------------------------| +| Type | 8 | uimsbf | 0x01 | +| Index | 8 | uimsbf | 0x01~0xFF | +| Length | 16 | uimsbf | Data length | +| ContentIDLen | 8 | uimsbf | length of Content ID | +| ContentID | ContentIDLen × 8 | uimsbf | Content unique identifier | +| CEKCount | 8 | uimsbf | The number of CEKs contained in this unit | +| for (i=0; i< CEKCount; i++) { | | | | +| KeyIdentifierLen | 8 | uimsbf | length of CEK identifier | +| KeyIdentifier[] | KeyIdentifierLen × 8 | uimsbf | CEK identifier | +| } | | | | + +Type: the unit type, the content unit type is 0x01. + +Index: the unit index, which is represented by one byte. + +Length: the unit length, which is the length of the data after Length. + +ContentIDLen: the content unique identifier's length. + +ContentID: content unique identifier. + +CEKCount: the number of CEKs for this content. + +KeyIdentifierLen, KeyIdentifier: key identifier used to uniquely identify the key. The key is uniquely defined as a UUID, and the length of key identifier is represented by 1 byte. The number of KeyIdentifierLen and KeyIdentifier is CEKCount. + +### 8.2.4 Authorized object unit + +The authorized object is the relevant rights bearer of the specified content. The authorized object unit includes the authorized object type and the authorized object ID. The data structure of authorized object unit is shown in Table 8-4. + +**Table 8-4 – Data structure of Authorized object unit** + +| Field | Bits | Type | Description | +|------------|-------|--------|--------------------------------------------| +| Type | 8 | uimsbf | 0x02 | +| Index | 8 | uimsbf | 0x01~0xFF | +| Length | 16 | uimsbf | Data length | +| ObjectType | 8 | uimsbf | Authorized object type | +| ObjectID | 8 × N | uimsbf | Unique identifier of the authorized object | + +Type: the unit type, the authorized object unit type is 0x02. + +Index: the unit index, which is represented by one byte. + +Length: the unit length, which is the length of the data after Length. + +ObjectType: authorized object type, set to 0. + +ObjectID: the unique identifier of this authorized object which is represented by the unique identifier of the DRM device key. N represents the number of bytes of the ObjectID. + +### 8.2.5 Key unit + +The key unit includes key algorithm, key data, key type, key identifier as well as key type and key identifier for encrypting this key. The data structure of key unit is shown in Table 8-5. + +**Table 8-5 – Data structure of key unit** + +| Field | Bits | Type | Description | +|-----------------------|---------------------------|--------|------------------------------------| +| Type | 8 | uimsbf | 0x03 | +| Index | 8 | uimsbf | 0x01~0xff | +| Length | 16 | uimsbf | Data length | +| KeyAlgorithm | 8 | uimsbf | Key algorithm | +| KeyDataLen | 16 | uimsbf | Length of key data | +| KeyData[] | KeyDataLen × 8 | uimsbf | Key data | +| KeyType | 8 | uimsbf | Key type | +| KeyIdentifierLen | 8 | uimsbf | length of key identification | +| KeyIdentifier[] | KeyIdentifierLen × 8 | uimsbf | Key identification | +| UpperKeyType | 8 | uimsbf | Upper Key Type | +| UpperKeyIdentifierLen | 8 | uimsbf | length of Upper key identification | +| UpperKeyIdentifier[] | UpperKeyIdentifierLen × 8 | uimsbf | Upper key identification | + +KeyAlgorithm: key algorithm, one byte used to identify the encryption algorithm that is used to encrypt this key. The key algorithm is specified in Annex C. + +KeyDataLen, KeyData[]: the encrypted key data. + +KeyType: one byte is used to identify the function of this key. The key type is specified in Table 8-6. + +KeyIdentifierLen, KeyIdentifier: key identifier used to uniquely identify this key. KeyIdentifierLen represents the length of the key identifier in one byte. KeyIdentifier represents the key identifier. + +UpperKeyType: the key type of the key that is used to encrypt this key. The key type is specified in Table 8-6. + +UpperKeyIdentifierLen, UpperKeyIdentifier: unique identifier of the key that is used to encrypt this key. + +**Table 8-6 – Key type** + +| Type | Encoding | Description | +|--------------|----------|---------------------------------------------------------------------------------------------------------------------------------------| +| Content keys | 0x01 | CEK | +| Device key | 0x03 | Client key, the public key of the DRM client. In the device key unit, KeyData could be set to empty and KeyDataLen could be set to 0. | +| Session key | 0x20 | A temporary key that is used in a license to protect CEK. | +| HMAC key | 0x21 | A temporary key that is used in a license to calculate HMAC. | +| Reserved | Other | Reserved | + +### 8.2.6 Key usage rule unit + +Key usage rules specify that an authorized object should use the key according to the key usage rules. A key usage rule unit includes a key identifier and the usage rule. The data structure of the key usage rule unit is shown in Table 8-7. + +**Table 8-7 – Data structure of key usage rule unit** + +| Field | Bits | Type | Description | +|--------------------------------|----------------------|--------|-------------------------------| +| Type | 8 | uimsbf | 0x04 | +| Index | 8 | uimsbf | 0x01~0xFF | +| Length | 16 | uimsbf | Data length | +| KeyType | 8 | uimsbf | Key type | +| KeyIdentifierLen | 8 | uimsbf | Length of key identifier | +| KeyIdentifier[] | KeyIdentifierLen × 8 | uimsbf | Key identifier | +| KeyRulesNum | 8 | | Number of the key usage rules | +| for
(i=0;i
Status =
"deviceTimeError" | + +Type: message type, set to "licenseResponse". + +Version: The protocol version number agreed between the DRM server and the DRM client. The current version is "2.0" and should be downward compatible after upgrading to a higher version. + +Status: indicates whether the license request was successfully completed and shall comply with the provisions of Table 9-4. + +SelectedAlgorithm: the cryptographic algorithm selected by the DRM server, set to "KMSPProfile1". + +ResponseTime: the current DRM time of the DRM server, which is the number of seconds since 0:00:00 on January 1, 1970 UTC. The format is a decimal string. + +DeviceID: DRM client unique identifier, which shall be consistent with the DRM client unique identifier in the license request message. If the DRM client identifier in the license response message received by the DRM client is inconsistent with the current DRM client's identifier, the DRM client should ignore this message, base64 encoded. + +DRMServerID: DRM server unique identifier, using the public key hash value of its certificate as its unique identifier, base64 encoded. + +DeviceNonce: the random number sent by the DRM client, which should be the random number in the license request message, base64 encoded. + +ProtectedLicenses: one or more licenses requested by the DRM client returned by the DRM server. The license array "protectedLicenses" contains one or more licenses. + +``` + +"protectedLicenses" : [ + { + " licenseID" : "base64_string", + "license" : "base64_string" + }, + { + " licenseID" : "base64_string", + "license" : "base64_string" + }, + ... +] + +``` + +At least one license should be included in "protectedLicenses". The "licenseID" uses a base64-encoded string to represent the unique identity of the license, and the "license" uses a base64-encoded string to represent the corresponding license. Base64 encoding method follows [IETF RFC 2045]. + +CertificateChain: DRM server certificate chain. The certificate chain is an array of base64-encoded strings, each of which is a DER-encoded certificate. The certificate chain does not contain a root certificate. The DRM server certificate should be the first in the certificate chain, and each subsequent certificate shall be a direct attestation of the previous certificate, base64 encoded. + +OCSPResponse: DRM server OCSP response, base64 encoded. + +Signature: signature of the license response message, base64 encoded. + +The format of the license acquisition response message is as follows: + +``` + +{ + "type": "licenseResponse", + "status": "string", + "version": "2.0", + "selectedAlgorithm": "string", + "responseTime": "string", + "deviceID": "base64_string", + "drmServerID": "base64_string", + "nonce ": "base64_string", + "protectedLicenses ": [{ + "licenseID ": "base64_string", + "license ": "base64_string" + }, + { + "licenseID ": "base64_string", + "license ": "base64_string" + }, + ...], + "certificateChain ": ["base64_string", "base64_string", ...], + "ocspResponse ": "base64_string", + "signature ": "base64_string" +} + +``` + +## 9.3 Status information + +Error status information includes: DRM server rejects the request of DRM client; DRM server does not support the request of the current type (for example, the type of the license request message is incorrect.); DRM server cannot parse the request from DRM client (for example, the format of the license request message is incorrect.); DRM client is not authorized to access the DRM server (for example, the DRM client certificate has expired); the DRM server cannot verify the certificate chain of the DRM client; the DRM server cannot verify the signature in the request of DRM client; the time of the DRM client is inconsistent with that of the DRM server; and the license object requested by the DRM client cannot be found. When the DRM client time is inconsistent with that of the DRM server, the DRM client time must be calibrated based on the value of ResponseTime in the message, and then the license must be applied for again. Status information is specified in Table 9-4. + +**Table 9-4 – Status information** + +| JSON key | Value | Description | +|----------|-----------------------------|--------------------------------------------------------------------------------------| +| status | Success | Success. | +| | Abort | DRM server rejects the request of DRM client. | +| | typeNotSupported | DRM server does not support request of the current type. | +| | accessDenied | DRM client is not authorized to access DRM server. | +| | contentIDNotFound | DRM server cannot find the license object requested by DRM client. | +| | malformedRequest | DRM server cannot parse the request from DRM client. | +| | versionNotSupported | The DRM server does not support the protocol version used by the current DRM client. | +| | invalidCertificateChain | DRM server cannot verify the certificate chain of DRM client. | +| | signatureError | DRM server cannot verify the signature in the request of DRM client. | +| | deviceTimeError | The time of DRM client is inconsistent with that of DRM server. | +| | drmClientSecurityLevelError | DRM client security level is lower than the required security level. | + +## 9.4 Message signature mechanism + +The DRM client generates a LicenseRequest JSON String by setting the value of the signature attribute to an empty string, calculates the signature of this string, and fills the signature result into the LicenseRequest JSON String by setting the value of the signature attribute to base64 encoded signature result. + +The DRM server generates a LicenseResponse JSON String by setting the value of the signature attribute to an empty string, calculates the signature of this string, and fills the signature result into the LicenseResponse JSON String by setting the value of signature attribute to base64 encoded signature result. + +# 10 DRM server side + +DRM server includes content encryption, key management, key gateway, content authorization and other core modules. The content encryption module is responsible for the encryption of linear program or VoD content. The key management module is responsible for receiving content encryption key information for content encryption and performing secure storage and distribution. The key gateway module is responsible for receiving the content encryption key synchronized by each key management and receiving the key query of content authorization. Content authorization module queries the content encryption key from the key gateway, encapsulates the key into a license and sends the license to the DRM client. The DRM server-side framework is shown in Figure 10-1. + + + +The diagram illustrates the DRM server side framework. On the left, under the heading 'DRM server', there are four modules: 'Content encryption', 'Key management', 'Key gateway', and 'Content authorization'. 'Content encryption' is at the top, with an arrow pointing up to it from 'Key management'. 'Key management' has an arrow pointing right to 'Key gateway', which in turn has an arrow pointing right to 'Content authorization'. A dashed vertical line separates the 'DRM server' from the 'DRM client' on the right. Both 'Content encryption' and 'Content authorization' have arrows pointing across this dashed line to a box labeled 'DRM client'. The text 'J.1041(25)' is located below the 'DRM client' box. + +Figure 10-1 – DRM server side framework diagram + +**Figure 10-1 – DRM server side framework** + +This clause specifies the key synchronization protocol between the key management module and the key gateway module, and the key query protocol between the key gateway module and the content authorization module. The HTTP/HTTPS protocol and POST (JSON) interface are used for key synchronization and key query, and all certificate chains are in distinguished encoding rules (DER) coding format. + +## 10.1 Key synchronization protocol + +Key synchronization refers to the key management module to synchronize the encryption key of linear program or VoD content to the key gateway module. + +Key synchronization includes a key synchronization request message and a key synchronization response message. + +### 10.1.1 Key synchronization request + +The key synchronization request message is initiated by the key management module, and the key gateway module verifies and responds. The key synchronization request message includes the version number, unique identifier of the key management, nonce, content ID, content encryption key, certificate chain of the key management, digital signature, etc. The key synchronization request message is specified in Table 10-1. + +The content encryption key is encrypted by the public key of the key gateway module. After being received by the key gateway module, the content encryption key shall be securely stored. + +The digital signature in the request is generated using the private key of the key management module. + +**Table 10-1 – Key synchronization request message** + +| JSON key | Value type | Description | +|----------|------------|-------------| +| type | string | Mandatory | +| version | string | Mandatory | +| kmsID | string | Mandatory | +| nonce | string | Mandatory | + +**Table 10-1 – Key synchronization request message** + +| JSON key | Value type | Description | +|-------------------|--------------|-------------| +| selectedAlgorithm | string | Mandatory | +| contentInfos | object array | Mandatory | +| contentID | string | Mandatory | +| ceks | object array | Mandatory | +| cekID | string | Mandatory | +| encCEK | string | Mandatory | +| extension | string | Optional | +| startTime | string | Optional | +| endTime | string | Optional | +| contentRules | string | Optional | +| certificateChain | string array | Mandatory | +| signature | string | Mandatory | + +type: message type, set to "keySyncRequest". + +version: the current message protocol version number. The current version is "1.0". + +kmsID: identifier of the key management module, base64 encoded. + +nonce: generated by the sender of the message. It should be generated by the random number generator and encoded by base64. + +selectedAlgorithm: set to "KMSPProfile1". + +contentInfos: an array of content IDs and content encryption key objects. + +contentID: content identifier, base64 encoded. + +ceks: content encryption key object array, including the content encryption key identifier and the content encryption key. + +cekID: content encryption key identifier, base64 encoded. + +encCEK: content encryption key encrypted by the public key in the certificate of key gateway module, base64 encoded. + +extension: extension information, base64 encoded. + +startTime: start time of key usage rules, which is the number of seconds since 0:00:00 on January 1, 1970 UTC. The format is decimal string. + +endTime: end time of key usage rules, which is the number of seconds since 0:00:00 on January 1, 1970 UTC. The format is decimal string. + +contentRules: key usage rules of the content, base64 encoded. + +certificateChain: certificate chain of the key management, the certificate chain does not include the root certificate, base64 encoded. + +signature: the signature of the message, base64 encoded. + +The format of the key synchronization request message is as follows: + +``` +{ + "type": "keySyncRequest", + "version": "1.0", + "kmsID": "base64_string", + "nonce": "base64_string", + "selectedAlgorithm": "string", + "contentInfos": [{ + "contentID": "base64_string", + "ceks": [{ + "cekID": "base64_string", + "encCEK": "base64_string", + "extension": "base64_string", + "startTime": "string", + "endTime": "string" + }, + ...], + "contentRules": "base64_string" + }, + ...], + "certificateChain": ["base64_string", "base64_string", ...], + "signature": "base64_string" +} +``` + +### 10.1.2 Key synchronization response + +Key synchronization response message includes the version number, unique identifier of the key gateway, nonce, status, certificate chain of the key gateway, digital signature, etc. The key synchronization response message is specified in Table 10-2. + +The status of key synchronization processing includes successful synchronization, illegal certificate of the key management system, incorrect digital signature, unknown state, etc. + +A digital signature is generated by the private key of the key gateway module. + +**Table 10-2 – Key synchronization response message** + +| JSON key | Value type | Description | +|-------------------|--------------|-------------| +| type | string | Mandatory | +| version | string | Mandatory | +| keyGateWayID | string | Mandatory | +| nonce | string | Mandatory | +| status | string | Mandatory | +| selectedAlgorithm | string | Mandatory | +| certificateChain | string array | Mandatory | +| signature | string | Mandatory | + +type: message type, fixed to "keySyncResponse". + +version: the current message protocol version number. Set to "1.0". + +keyGateWayID: unique identifier of the key gateway, base64 encoded. + +nonce: the nonce shall be consistent with the one in key synchronization request message, base64 encoded. + +status: status information of this response, as specified in Table 10-3. + +**Table 10-3 – Status of key synchronization response** + +| Status | Description | +|-------------------------------|----------------------------------------------------------------| +| success | Success. | +| doNotSupportSelectedAlgorithm | Do not support the algorithms in the request. | +| certificationInvalid | Certificate of key management is not valid. | +| signatureInvalid | Signature in key synchronization request message is incorrect. | +| unknownError | Unknown error. | + +selectedAlgorithm: set to "KMSPProfile1". + +certificateChain: certificate chain of key gateway which does not include the root CA certificate, base64 encoded. + +signature: the signature of the message, base64 encoded. + +The format of key synchronization response message is as follows: + +``` +{ + "type": "keysyncResponse", + "version": "1.0", + "keyGateWayID": "base64_string", + "nonce": "base64_string", + "status": "string", + "selectedAlgorithm": "string", + "certificatechain": ["base64_string", "base64_string", ...], + "signature": "base64_string" +} +``` + +## 10.2 Key query protocol + +Key query refers to the content authorization module querying the content encryption key required by the client from the key gateway module. + +Key query includes a key query request message and key query response message. + +### 10.2.1 Key query request + +The key query request message is sent to the key gateway module by the content authorization module. The key query request message includes the version number, unique identifier of the DRM server, nonce, content ID, certificate chain of the DRM client, certificate chain of content authorization, and digital signature. The key query request message is specified in Table 10-4. + +**Table 10-4 – Key query request message** + +| JSON key | Value type | Description | +|-------------|------------|-------------| +| type | string | Mandatory | +| version | string | Mandatory | +| drmServerID | string | Mandatory | + +**Table 10-4 – Key query request message** + +| JSON key | Value type | Description | +|----------------------|--------------|-------------| +| nonce | string | Mandatory | +| selectedAlgorithm | string | Mandatory | +| contentIDs | object array | Mandatory | +| drmClientCertificate | string | Mandatory | +| certificateChain | string array | Mandatory | +| signature | string | Mandatory | + +type: message type, set to "keyRequest". + +version: the current message protocol version number. The current version is "1.0". + +drmServerID: unique identifier of content authorization module, base64 encoded. (Hash value of certificate public key) + +nonce: generated by the sender of the message. It should be generated by the random number generator and encoded by base64. + +selectedAlgorithm: set to "KMSPProfile1". + +contentIDs: an array of content ID objects, including content ID and optional start time and end time. + +drmClientCertificate: DRM client certificate, base64 encoded. + +certificateChain: certificate chain of content authorization module, the certificate chain does not include the root certificate, base64 encoded. + +signature: the signature of the message, base64 encoded. + +The format of key query request message is as follows: + +``` +{ + "type": "keyRequest", + "version": "1.0", + "drmServerID": "base64_string", + "nonce": "base64_string", + "selectedAlgorithm": "string", + "contentIDs": [{ + "contentID": "base64_string", + "startTime": "string", + "endTime": "string" + }, + ...], + "drmClientCertificate": "base64_string", + "certificateChain": ["base64_string", "base64_string", ...], + "signature": "base64_string" +} +``` + +### 10.2.2 Key query response + +The key query response message is sent to the content authorization module by the key gateway. The key query response message includes the version number, unique identifier of the key gateway, nonce, content ID, status, session key, content encryption key, certificate chain of the key gateway, and digital signature, etc. The key query response message is specified in Table 10-5. + +**Table 10-5 – Key query response message** + +| JSON key | Value type | Description | +|-------------------|--------------|-------------------------------| +| type | string | Mandatory | +| version | string | Mandatory | +| keyGateWayID | string | Mandatory | +| nonce | string | Mandatory | +| status | string | Mandatory | +| selectedAlgorithm | string | status= "success" is required | +| cekInfos | object array | status= "success" is required | +| contentID | string | status= "success" is required | +| sessionKeyID | string | status= "success" is required | +| encSessionKey | string | status= "success" is required | +| encCEKs | object array | status= "success" is required | +| cekID | string | status= "success" is required | +| encCEK | string | status= "success" is required | +| contentRules | string | Optional | +| certificateChain | string array | Mandatory | +| signature | string | status= "success" is required | + +type: message type, set to "keyResponse". + +version: the current message protocol version number. The current version is "1.0". + +keyGateWayID: the unique identifier of the key gateway, base64 encoded. + +nonce: the nonce should be consistent with the nonce of the key query request message, base64 encoded. + +status: status information of this response, as specified in Table 10-6. + +selectedAlgorithm: set to "KMSPProfile1". + +**Table 10-6 – Key query response status information** + +| Status | Description | +|-------------------------------|--------------------------------------------------------| +| success | Success. | +| doNotSupportSelectedAlgorithm | Do not support the algorithms in the request. | +| contentIDInvalid | The content ID cannot be found. | +| deviceCertInvalid | DRM client certificate is not valid. | +| drmServerCertInvalid | The certificate of content authorization is not valid. | +| drmServerIDInvalid | Content authorization is not on the white list. | +| signatureInvalid | Signature in key query request message is incorrect. | +| unknownError | Unknown error. | + +cekInfos: content encryption key object array. + +contentID: content ID, base64 encoded. + +sessionKeyID: session key identifier, base64 encoded. + +encSessionKey: The session key is a random key encrypted by the DRM client public key, that is, the session key in the content authorization license, base64 encoded. + +encCEKs: content encryption key array, base64 encoded. + +cekID: content encryption key identifier, base64 encoded. + +encCEK: the content encryption key encrypted by the session key, base64 encoded. + +contentRules: key usage rules of the content. + +certificateChain: certificate chain of key gateway module. The certificate chain does not include the root certificate, base64 encoded. + +signature: the signature of the message, base64 encoded. + +The format of key query response message is as follows: + +``` +{ + "type": "keyResponse", + "version": "1.0", + "keyGateWayID": "base64_string", + "nonce": "base64_string", + "status": "string", + "selectedAlgorithm": "string", + "cekInfos": [{ + "contentID": "base64_string", + "sessionKeyID": "base64_string", + "encSessionKey": "base64_string", + "encCEKs": [{ + "cekID": "base64_string", + "encCEK": "base64_string" + }, + ...], + "contentRules": "base64_string" + }, + ...], + "certificateChain": ["base64_string", "base64_string", ...], + "signature": "base64_string" +} +``` + +# Annex A + +## Formats of digital certificate, online certificate status protocol and certificate revocation list + +(This annex forms an integral part of this Recommendation.) + +This annex specifies digital certificate format, the online certificate status protocol message format, and the certificate revocation list format. + +These digital certificate formats shall conform to [IETF RFC 5280]. + +### A.1 Digital certificate format + +#### A.1.1 Root CA certificate + +Root CA certificate is a self-signed CA certificate, and both the DRM server and the DRM client use this certificate as the root of trust to verify other certificates and revocation lists. The format of the root CA certificate is shown in Table A.1. + +**Table A.1 – Format of root CA certificate** + +| Field | Description | +|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Version | Version, v3 with integer value 2. | +| SerialNumber | Serial number, a 4-byte random number. | +| Signature | Signature algorithm, SM3 with SM2, OID 1.2.156.10197.1.501, conforming to [ISO/IEC 14888-3:2018]. | +| Issuer | Issuer, same as the subject field. | +| Validity | Validity, valid for 50 years since the date of signature. | +| Subject | Subject, including attributes as follows:
– Country/region name (countryName) (e.g., "CN");
– Organization name (organizationName) (e.g., "CDTA");
– Common name (commonName) (e.g., "root CA"). | +| SubjectPublicKeyInfo | Subject public key information, including:
– algorithm identifier id-ecPublicKey OID 1.2.840.10045.2.1;
– SM2 curve identifier OID 1.2.156.10197.1.301;
– SM2 public key. | +| IssuerUniqueID | Unique ID of issuer; not used. | +| SubjectUniqueID | Unique ID of subject; not used. | +| BasicConstraints extension | Basic constraint extensions, a necessary and critical field. CA field is set as TRUE, and pathLenConstraint field is not used. | +| CRLDistributionPoints extension | CRL distribution points extension, not used. | +| KeyUsage extension | Key usage extension, a necessary and critical field. Only key usage bit keyCertSign and cRLSign are set. | +| AuthorityKeyIdentifier extension | Authority key identifier extension; not used. | + +**Table A.1 – Format of root CA certificate** + +| Field | Description | +|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SubjectKeyIdentifier extension | Subject key identifier extension, a necessary but not critical field. The method for generating the key identifier is in compliance with [IETF RFC 5280]. The keyIdentifier is composed of SM3 hash value of the BIT STRING subjectPublicKey (excluding tag, length and unused bits). | +| CertificatePolicies extension | Certificate policy extension; not used. | +| ExtKeyUsage extension | Extension keys usage extension; not used. | +| Id-pkix-ocsp-nocheck extension | Id-pkix-ocsp-nocheck extension; not used. | +| SignatureAlgorithmId | Signature algorithm ID, SM3 with SM2, OID 1.2.156.10197.1.501. | +| SignatureValue | Signature value. | + +#### A.1.2 DRM server CA certificate + +DRM server CA certificate is issued by the root CA and is stored in the DRM server. DRM server may send the certificate to DRM clients as part of the DRM server certificate chain. The format of the DRM server CA certificate is shown in Table A.2. + +**Table A.2 – Format of DRM server CA certificate** + +| Field | Description | +|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Version | Version, v3 with integer value 2. | +| SerialNumber | Serial number, a 4-byte random number. | +| Signature | Signature algorithm, SM3 with SM2, OID 1.2.156.10197.1.501, conforming to [ISO/IEC 14888-3:2018]. | +| Issuer | Issuer, same as root the CA subject field. | +| Validity | Validity, expiration date same as root the CA, and the start date is the time of certificate is signed. | +| Subject | Subject, including attributes as follows:
- – Country/region name (countryName) (e.g., "CN");
- – Organization name (organizationName) (e.g., "CDTA");
- – Common name (commonName) (e.g., "License Issuer CA 1").
- – algorithm identifier id-ecPublicKey OID 1.2.840.10045.2.1;
- – SM2 curve identifier OID 1.2.156.10197.1.301;
- – SM2 public key.
– Organization Name (organizationName) (such as "Sample Name");
optional attribute:
– Provided by DRM server. | +| SubjectPublicKeyInfo | Subject public key information, including:
– algorithmIdentifier id-ecPublicKey OID 1.2.840.10045.2.1;
– SM2 curve identifier OID 1.2.156.10197.1.301;
– SM2 public key. | +| IssuerUniqueID | Unique ID of issuer; not used. | +| SubjectUniqueID | Unique ID of subject; not used. | +| BasicConstraints extension | Basic constraint extension; not used. | +| CRLDistributionPoints extension | CRL distribution points extension, not used. | + +**Table A.3 – Format of DRM server certificate** + +| Field | Description | +|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| KeyUsage extension | Key usage extension, a necessary and critical field. Only bit digitalSignature key is set. | +| AuthorityKeyIdentifier extension | Authority key identifier extension, a necessary but non-critical field. It includes only the keyIdentifier field and has a value identical to the subjectKeyIdentifier extension of the corresponding DRM server CA certificate. | +| SubjectKeyIdentifier extension | Subject key identifier extension; not used. | +| CertificatePolicies extension | Certificate policy extension; not used. | +| ExtKeyUsage extension | Extension key usage extension, a necessary and critical field. It includes cdrm-kp-licenseIssuer object id (1.2.156.112560.7). | +| Id-pkix-ocsp-nocheck extension | Id-pkix-ocsp-nocheck extension; not used. | +| SignatureAlgorithmId | Signature algorithm ID, SM3 with SM2, OID 1.2.156.10197.1.501. | +| SignatureValue | Signature value. | + +#### **A.1.4 OCSP responder certificate** + +OCSP responder certificate is issued by the DRM server CA, and is stored in the OCSP responder. The certificate is sent to DRM clients with the OCSP response by the same DRM server when the DRM client makes an OCSP request. The format of the OCSP responder certificate is shown in Table A.4. + +**Table A.4 – Format of OCSP responder certificate** + +| Field | Description | +|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Version | Version, v3 with integer value 2. | +| SerialNumber | Serial number, a 4-byte random number. | +| Signature | Signature algorithm, SM3 with SM2, OID 1.2.156.10197.1.501, conforming to [ISO/IEC 14888-3:2018]. | +| Issuer | Same as the DRM Server CA subject field. | +| Validity | Validity, the validity period is within 3 months but should not exceed the certificate validity date of the corresponding DRM server CA certificate. | +| Subject | Subject, including attributes as follows:
- – Country/region name (countryName) (e.g., "CN");
- – Organization name (organizationName) (e.g., "CDTA");
- – Common name (commonName) (e.g., "OCSP Responder 1").
- – algorithm Identifier id-ecPublicKey OID 1.2.840.10045.2.1;
- – SM2 curve identifier OID 1.2.156.10197.1.301;
- – SM2 public key.
– Organization Name (organizationName) (such as "Sample Name");
optional attribute:
– Provided by DRM server. | +| SubjectPublicKeyInfo | Subject public key information, including:
– algorithmIdentifier id-ecPublicKey OID 1.2.840.10045.2.1;
– SM2 curve identifier OID 1.2.156.10197.1.301;
– SM2 public key. | + +**Table A.5 – Format of key management certificate** + +| Field | Description | +|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IssuerUniqueID | Unique ID of issuer; not used. | +| SubjectUniqueID | Unique ID of subject; not used. | +| BasicConstraints extension | Basic constraint extension; not used. | +| CRLDistributionPoints extension | CRL distribution points extension, not used. | +| KeyUsage extension | Key usage extension, a necessary and critical field. Only bit digitalSignature key is set. | +| AuthorityKeyIdentifier extension | Authority key identifier extension, a necessary but non-critical field. It only contains keyIdentifier field and has a value identical to subjectKeyIdentifier extension of corresponding DRM server CA certificate. | +| SubjectKeyIdentifier extension | Subject key identifier extension; not used. | +| CertificatePolicies extension | Certificate policy extension; not used. | +| ExtKeyUsage extension | Extension key usage extension, a necessary and critical field. It includes cdrm-kp-licenseIssuer object id (1.2.156.112560.23). | +| Id-pkix-ocsp-nocheck extension | Id-pkix-ocsp-nocheck extension; not used. | +| SignatureAlgorithmId | Signature algorithm ID, SM3 with SM2, OID 1.2.156.10197.1.501. | +| SignatureValue | Signature value. | + +#### A.1.6 Key gateway module certificate + +Key gateway certificate is issued by the DRM server CA, which identifies the key gateway system. The format of the key gateway certificate is shown in Table A.6. + +**Table A.6 – Format key gateway certificate** + +| Field | Description | +|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Version | Version, v3 with integer value 2. | +| SerialNumber | Serial number, a 4-byte random number. | +| Signature | Signature algorithm, SM3 with SM2, OID 1.2.156.10197.1.501, conform to [ISO/IEC 14888-3:2018]. | +| Issuer | Issuer, same as DRM server CA subject field. | +| Validity | Validity, the validity period is within 5 years from the issuance date but should not exceed the certificate validity date of the corresponding DRM server CA certificate. | +| Subject | Subject, mandatory attribute:
– Organization Name (organizationName) (such as "Sample Name");
optional attribute:
– Provided by DRM server. | + +**Table A.6 – Format key gateway certificate** + +| Field | Description | +|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SubjectPublicKeyInfo | Subject public key information, including:
– algorithmIdentifier id-ecPublicKey OID 1.2.840.10045.2.1;
– SM2 curve identifier OID 1.2.156.10197.1.301;
– SM2 public key. | +| IssuerUniqueID | Unique ID of issuer; not used. | +| SubjectUniqueID | Unique ID of subject; not used. | +| BasicConstraints extension | Basic constraint extension; not used. | +| CRLDistributionPoints extension | CRL distribution points extension, not used. | +| KeyUsage extension | Key usage extension, a necessary and critical field. Only bit digitalSignature key is set. | +| AuthorityKeyIdentifier extension | Authority key identifier extension, a necessary but non-critical field. It only contains the keyIdentifier field and has the value identical to subjectKeyIdentifier extension of the corresponding DRM server CA certificate. | +| SubjectKeyIdentifier extension | Subject key identifier extension; not used. | +| CertificatePolicies extension | Certificate policy extension; not used. | +| ExtKeyUsage extension | Extension key usage extension, a necessary and critical field. It includes cdrm-kp-licenseIssuer object id (1.2.156.112560.24). | +| Id-pkix-ocsp-nocheck Extension | Id-pkix-ocsp-nocheck extension; not used. | +| SignatureAlgorithmId | Signature algorithm ID, SM3 with SM2, OID 1.2.156.10197.1.501. | +| SignatureValue | Signature value. | + +#### A.1.7 Content encryption module certificate + +Content encryption certificate is issued by the DRM server CA, which identifies the content encryption system. The format of the content encryption certificate is shown in Table A.7. + +**Table A.7 – Format of content encryption certificate** + +| Field | Description | +|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Version | Version, v3 with integer value 2. | +| SerialNumber | Serial number, a 4-byte random number. | +| Signature | Signature algorithm, SM3 with SM2, OID 1.2.156.10197.1.501, conforming to [ISO/IEC 14888-3:2018]. | +| Issuer | Issuer, same as the DRM server CA subject field. | +| Validity | Validity, the validity period is within 5 years from the issuance date, but should not exceed the certificate validity date of the corresponding DRM server CA certificate. | + +**Table A.7 – Format of content encryption certificate** + +| Field | Description | +|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Subject | Subject, mandatory attribute:
– Organization Name (organizationName) (such as "Sample Name");
optional attribute:
– Provided by DRM server. | +| SubjectPublicKeyInfo | Subject public key information, including:
– algorithmIdentifier id-ecPublicKey OID 1.2.840.10045.2.1;
– SM2 curve identifier OID 1.2.156.10197.1.301;
– SM2 public key. | +| IssuerUniqueID | Unique ID of issuer; not used. | +| SubjectUniqueID | Unique ID of subject; not used. | +| BasicConstraints extension | Basic constraint extension; not used. | +| CRLDistributionPoints extension | CRL distribution points extension, not used. | +| KeyUsage extension | Key usage extension, a necessary and critical field. Only bit digitalSignature key is set. | +| AuthorityKeyIdentifier extension | Authority key identifier extension, a necessary but non-critical field. It only contains the keyIdentifier field and has a value identical to subjectKeyIdentifier extension of corresponding DRM server CA certificate. | +| SubjectKeyIdentifier extension | Subject key identifier extension; not used. | +| CertificatePolicies extension | Certificate policy extension; not used. | +| ExtKeyUsage extension | Extension key usage extension, a necessary and critical field. It includes cdrm-kp-licenseIssuer object id (1.2.156.112560.22). | +| Id-pkix-ocsp-nocheck extension | Id-pkix-ocsp-nocheck extension; not used. | +| SignatureAlgorithmId | Signature algorithm ID, SM3 with SM2, OID 1.2.156.10197.1.501. | +| SignatureValue | Signature value. | + +#### A.1.8 DRM device CA certificate + +DRM device CA certificate is issued by the root CA and is stored in DRM clients. DRM clients send their certificates to the DRM server as part of the DRM client certificate chain when the DRM server interacts with DRM clients. The format of the DRM device CA certificate is shown in Table A.8. + +**Table A.8 – Format of DRM device CA certificate** + +| Field | Description | +|--------------|---------------------------------------------------------------------------------------------------| +| Version | Version, v3 with integer value 2. | +| SerialNumber | Serial number, a 4-byte random number. | +| Signature | Signature algorithm, SM3 with SM2, OID 1.2.156.10197.1.501, conforming to [ISO/IEC 14888-3:2018]. | +| Issuer | Issuer, same as the root CA subject field. | + +**Table A.8 – Format of DRM device CA certificate** + +| Field | Description | +|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Validity | Validity, expiration date same as root CA with start date at the time when certificate is generated. | +| Subject | Subject, including attributes as follows:
– Country/region name (countryName) (e.g., "CN");
– Organization name (organizationName) (e.g., "CDTA");
– Common name (commonName) (e.g., "Device CA 1"). | +| SubjectPublicKeyInfo | Subject public key information, including:
– algorithmIdentifier id-ecPublicKey OID 1.2.840.10045.2.1
– SM2 curve identifier OID 1.2.156.10197.1.301
– SM2 public key | +| IssuerUniqueID | Unique ID of issuer; not used. | +| SubjectUniqueID | Unique ID of subject; not used. | +| BasicConstraints extension | Basic constraint extensions, a necessary and critical field. CA field is set as TRUE, and pathLenConstraint field is set as zero. | +| CRLDistributionPoints extension | CRL distribution points extension, not used. | +| KeyUsage extension | Key usage extension, a necessary and critical field. Only key use bit keyCertSign and cRLSign are set. | +| AuthorityKeyIdentifier extension | Authority key identifier extension, a necessary but non-critical field. It only contains the keyIdentifier field and has a value identical to subjectKeyIdentifier extension of corresponding root CA certificates. | +| SubjectKeyIdentifier extension | Subject key identifier extension, a necessary but not critical field. The method for generating the key identifier is in compliance with [IETF RFC 5280]. The keyIdentifier is composed of the SM3 hash value of the BIT STRING subjectPublicKey (excluding tag, length and unused bits). | +| CertificatePolicies extension | Certificate policy extension; not used. | +| ExtKeyUsage extension | Extension keys usage extension; not used. | +| Id-pkix-ocsp-nocheck extension | Id-pkix-ocsp-nocheck extension; not used. | +| SignatureAlgorithmId | Signature algorithm ID, SM3 with SM2, OID 1.2.156.10197.1.501. | +| SignatureValue | Signature value. | + +#### **A.1.9 DRM client certificate** + +DRM client certificate is issued by the DRM device CA. DRM clients send DRM client certificates to the DRM server as the first certificate in the DRM client certificate chain upon receiving a request. The format of the DRM client certificate is shown in Table A.9. + +**Table A.9 – Format of DRM client certificate** + +| Field | Description | +|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Version | Version, v3 with integer value 2. | +| SerialNumber | Serial number, the unique non-negative integer in device certificate issued by certification authority. The structure of the serial number field encoded by DER is simulated below: | + +**Table A.9 – Format of DRM client certificate** + +| Field | Description | +|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| |
Byte 1~2: CA ID. The first byte must not be 00h or the highest valid bit is not zero;
Byte 3~6: certificate batch number, the unique one in DRM Device CA;
Byte 7~20: Lowest 14 bytes of the SM3 hash value calculated with the certificate public key and the current date and time.
Serial numbers can be used to revoke a batch of keys and certificates in device CRL.
| +| Signature | Signature algorithm, SM3 with SM2, OID 1.2.156.10197.1.501, conforming to [ISO/IEC 14888-3:2018]. | +| Issuer | Issuer, same as the subject field issuing device CA certificate. | +| Validity | Validity, the validity period is for 20 years but should not exceed the validity date of device CA certificate. | +| Subject |Subject, mandatory attribute:
- – Organization name (organizationName), set by certification authority to specific device manufacturers.
- – Serial number (serialNumber), assigned by certification authority, and acquired with calculating SM3 hash value of public key.
- – Common name (commonName), consisting of three parts:
The first part represents the security level of the DRM client that uses the certificate:
"SW-", indicating that this client has achieved the security level of software;
"HW-", indicating that this client has achieved the security level of hardware;
"EH-", indicating that this client has achieved the security level of enhanced hardware.
The second part is the record number obtained by device manufacturer after passing security evaluation.
The third part is defined by device manufacturer or service provider and can be left blank.
Optional attributes:
Specified by device manufacturer.
| +| SubjectPublicKeyInfo |Subject public key information, including:
- – algorithmIdentifier id-ecPublicKey OID 1.2.840.10045.2.1;
- – SM2 curve identifier OID 1.2.156.10197.1.301;
- – SM2 public key.
CRL distribution points extension:
- a) Certificates issued by a device CA under the management of certification authority: not used.
- b) Certificates issued by an auxiliary device CA: a necessary but not-critical field.
It only contains a cRLIssuer field to define the distinguishable names of device CRL issuers.
| + +**Table A.9 – Format of DRM client certificate** + +| Field | Description | +|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| KeyUsage extension | Key usage extension, a necessary and critical field. Only key usage bit digitalSignature and keyEncipherment are set. | +| AuthorityKeyIdentifier extension | Authority key identifier extension, a necessary but non-critical field. It only contains the keyIdentifier field and has a value identical to subjectKeyIdentifier extension of the corresponding Device CA certificate. | +| SubjectKeyIdentifier extension | Subject key identifier extension; not used. | +| CertificatePolicies extension | Certificate policy extension; not used. | +| ExtKeyUsage extension | Extension key usage extension, a necessary and critical field. It includes cdrm-kp-drmAgent object identifier (1.2.156.112560.8). | +| Id-pkix-ocsp-nocheck extension | Id-pkix-ocsp-nocheck extension; not used. | +| SignatureAlgorithmId | Signature algorithm ID, SM3 with SM2, OID 1.2.156.10197.1.501. | +| SignatureValue | Signature value. | + +## **A.2 Online certificate status protocol** + +OCSP service is in compliance with [IETF RFC 6960]. HTTP/HTTPS protocol is used to transmit messages for the OCSP protocol. OCSP service request is initiated by the DRM server to an OCSP responder, and after the OCSP responder replies, the response is sent to the DRM client in the license acquisition protocol by the DRM server. The DRM client verifies the revocation status of the DRM server based on the OCSP response. + +The format of the OCSP request message is shown in Table A.10. + +**Table A.10 – Format of the OCSP request message** + +| Field | Description | +|-------------------------|----------------------------------------------------------------------------------------------------| +| Version | Version, v2 with integer value 1. | +| RequestorName | Requester name, optional, can be included in the request, but will be neglected by OCSP responder. | +| RequestList | Request list, a request list should be included. | +| Request | Request, a list should be included. | +| ReqCert | Request certificate field. | +| Hash-Algrithm | Hash algorithm, SM3. | +| IssuerName Hash | Hash value of issuer DN, which should not be cut off. | +| IssuerKey Hash | Hash value of issuer public key, which should not be cut off. | +| SerialNumber | Certificate serial number. | +| SingleRequest-extension | Single request extension; not used. | +| RequestExtensions | Request (list) extensions. Extensions other than those defined below should not be used. | + +**Table A.10 – Format of the OCSP request message** + +| Field | Description | +|----------------------------|-------------------------------------------------------------------------------------------------| +| Nonce (id-pkix-ocsp-nonce) | Random number, optional, non-critical. Repeated in response if it is given. | +| OptionalSignature | Optional signature, which may be included in requests, but will be neglected by OCSP responder. | + +The format of OCSP response message is shown in Table A.11. + +**Table A.11 – Format of the OCSP response message** + +| Field | Description | +|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| ResponseStatus | Response status: successful, malformedRequest, internalerror, trylater, sigRequired, unauthorized as appropriate. | +| ResponseBytes | Response bytes | +| ResponseType | Response type, basic OCSP response: id-pkix-ocsp-basic. | +| Response | Response, an eight-bit byte serial including BasicOcspResponse. | +| BasicOcspResponse | Basic OCSP response | +| TbsResponseData | Response data to be signed. | +| Version | Version, v2 (integer value 1). | +| ResponderID | Responder ID, key (not the name) hash is used with a value identical to the value of extension domain subjectKeyIdentifier of OCSP responder certificate. | +| ProducedAt | Production time; the time to produce the OCSP response. | +| Responses | Response list. | +| CertID | Certificate ID | +| HashAlgorithm | Hash algorithm, SM3, hash value should not be cut off. | +| IssuerName-Hash | Issuer name hash, the hash value of the issuer DN. | +| IssuerKeyHash | The issuer public key hash, the hash value of the issuer's public key. | +| SerialNumber | Certificate serial number. | +| CertStatus | Certificate status, options: good, revoked, unknown | +| ThisUpdate | Update time for this time, sourced from the thisUpdate field of CRL. | +| NextUpdate | Update time for next time, sourced from the nextUpdate field of CRL. | +| SingleExtensions | Single response extension, not used. | +| ResponseExtensions | Response extension; extensions other than the ones defined below are not used. | +| Nonce (id-pkix-ocsp-nonce) | Random number, optional but non-critical. Will be repeated in responses if given in request. | +| SignatureAlgorithm | Signature algorithm, SM3 with SM2, OID 1.2.156.10197.1.501, see [ISO/IEC 14888-3:2018]. | +| Signature | Signature. | + +**Table A.11 – Format of the OCSP response message** + +| Field | Description | +|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Certs | Certificate list: The OCSP responder certificate is provided to the DRM server in each OCSP response. However, this certificate may be removed from the OCSP response before the response is transferring to the DRM client. The DRM server CA and root CA certificates do not need to be provided, as they should have been preloaded into device during certificate provisioning. | + +## A.3 Certificate revocation list (CRL) + +Certificate revocation lists (CRLs) include the DRM client CA CRL, DRM client CRL, and DRM server CRL. + +DRM server verifies the status of DRM client certificate chain according to DRM client CA CRL and DRM client CRL. + +The OCSP responder generates OCSP responses for the DRM server certificate based on the DRM server CRL. CRLs are in compliance with [IETF RFC 5280]. They are DER encoded, and the properties of certificate issuer is UTF8String encoded. CRLs' syntax is as follows: + +``` + +CertificateList ::= SEQUENCE { + tbsCertList TBSCertList, + signatureAlgorithm AlgorithmIdentifier, + signatureValue BIT STRING} + +TBSCertList ::= SEQUENCE { + version Version OPTIONAL, + -If present, MUST be v2 + signature AlgorithmIdentifier, + issuer Name, + thisUpdate Time, + nextUpdate Time OPTIONAL, + revokedCertificates SEQUENCE of SEQUENCE { + userCertificate CertificateSerialNumber, + revocationDate Time, + crlEntryExtensions Extensions OPTIONAL + -If present, MUST be v2 + } OPTIONAL, + crlExtensions [0] EXPLICIT Extensions OPTIONAL + -If present, MUST be v2 +} + +``` + +# Annex B + +## H.264/H.265 content encryption method + +(This annex forms an integral part of this Recommendation.) + +This annex specifies the encryption methods for H.264 and H.265 encoded content. + +## B.1 H.264 + +For H.264 encoded video content, the supplemental enhancement information (SEI) information in the network abstract layer (NAL) unit type 6 contains CEI extension information. The NAL units with nal\_unit\_type of 1 or 5 are encrypted, and the other NAL units are not encrypted. User\_data\_unregistered in SEI is used to contain CEI information. user\_data\_payload\_byte indicates the CEI information. The UUID is a fixed value 70c1db9f-66ae-4127-bfc0-bb1981694b66. + +H.264 encoded video content can be encrypted using either full encryption mode or partial encryption mode. + +In full encryption mode, the data part of the slice is encrypted, and last part that is less than or equal to 16 bytes is not encrypted. Encryption algorithm is SM4. Encryption mode is CBC or CTR. The syntax is as follows: + +``` +Encrypted_NAL_Unit () +{ + nal_unit_type_byte // 1 byte + unencrypted_leader // 31 bytes + while (bytes_remaining() > 16) { + protected_block // 16 bytes + } + unencrypted_trailer // 1-16 bytes +} +``` + +In partial encryption mode, 10% of the slice data is encrypted, that is, after a 16-byte block is encrypted, the next nine 16-byte blocks are not encrypted, and last part less than or equal to 16 bytes is not encrypted. Encryption algorithm is SM4. Encryption mode is CBC or CTR. The syntax is as follows: + +``` +Encrypted_NAL_Unit () +{ + nal_unit_type_byte // 1 byte + unencrypted_leader // 31 bytes + while (bytes_remaining() > 0) { + if (bytes_remaining() > 16) { + encrypted_block // 16 bytes + } + unencrypted_block // MIN(144, bytes_remaining()) bytes + } +} +``` + +## B.2 H.265 + +For H.265 encoded video content, the SEI information in the NAL unit type 39 contains CEI extension information. The NAL units with nal\_unit\_type of 0-31 are encrypted, and the other NAL units are not encrypted. User-data\_unregistered in SEI is used to contain CEI information. user\_data\_payload\_byte indicates the CEI information. The UUID is a fixed value 70c1db9f-66ae-4127-bfc0-bb1981694b66. + +H.265 encoded video content can be encrypted using either full encryption mode or partial encryption mode. + +In full encryption mode, the data part of the slice is encrypted, and last part that is less than or equal to 16 bytes is not encrypted. Encryption algorithm is SM4. Encryption mode is CBC or CTR. The syntax is as follows: + +``` +Encrypted_NAL_Unit () +{ + nal_unit_type_byte // 1 byte + unencrypted_leader // 64 bytes + while (bytes_remaining() > 16) { + protected_block // 16 bytes + } + unencrypted_trailer // 1-16 bytes +} +``` + +In partial encryption mode, 10% of the slice data is encrypted, that is, after a 16-byte block is encrypted, the next nine 16-byte blocks are not encrypted, and last part less than or equal to 16 bytes is not encrypted. Encryption algorithm is SM4. Encryption mode is CBC or CTR. The syntax is as follows: + +``` +Encrypted_NAL_Unit () +{ + nal_unit_type_byte // 1 byte + unencrypted_leader // 64 bytes + while (bytes_remaining() > 0) { + if (bytes_remaining() > 16) { + encrypted_block // 16 bytes + } + unencrypted_block // MIN(144, bytes_remaining()) bytes + } +} +``` + +## B.3 TS encapsulation method extension + +When the encrypted H.264/H.265 encoded content is encapsulated in the TS encapsulation mode, video\_format defined in the Table 7-3 is defined as follows: + +'0011' indicates that the original video is encoded by H.265, '0100' indicates that the original video is encoded by H.264. + +## B.4 Emulation prevention + +To prevent the emulation of start codes, the encoded content after encryption shall be processed in accordance with the requirements of clause 7.1.3. + +# Annex C + +## Cryptographic algorithm + +(This annex forms an integral part of this Recommendation.) + +This annex specifies the cryptographic algorithms supported by digital rights management for video and audio content distribution. + +The cryptographic algorithm profile in the content license, license acquisition protocol, key synchronization protocol and key query protocol in this specification is defined as "KMSPProfile1", specified as the following: + +Video and audio contents are encrypted using SM4 algorithm, which complies with [ISO/IEC18033-3/AMD1]. Encryption mode is CBC or CTR; + +The DRM server generates the session key and uses the session key to encrypt the CEK. The encryption algorithm is SM4 algorithm, and the encryption mode is ECB or CTR. In CTR mode, the format is "[16-byte COUNTER][encrypted content encryption key]"; + +The DRM server encrypts the session key with the DRM client public key, and the encryption algorithm is SM2 public key encryption algorithm, which complies with [ISO/IEC 14888-3:2018]; + +If the CEK needs to be synchronized to the key gateway, the CEK needs to be encrypted by the key gateway public key, and the encryption algorithm is SM2 public key encryption algorithm, which complies with [ISO/IEC 14888-3:2018]; + +The DRM server encapsulates the encrypted session key, the encrypted CEK in the license and sends them to the DRM client. For details about the HMAC algorithm in the license, see [IETF RFC 2104]. The digest algorithm used by the HMAC algorithm is SM3 algorithm defined in [ISO/IEC 10118-3:2018], and the HMAC key is a 32-byte random number. + +The cryptographic algorithm in the license key unit is identified by a byte, where the high 4 bits are the type code of the cryptographic algorithm, and the low 4 bits are the algorithm code of the cryptographic algorithm. The cryptographic algorithms are specified in Table C.1. + +**Table C.1 – Cryptographic algorithm encoding** + +| Algorithm type | Type code | Algorithm name | Algorithm code | +|---------------------------------------------------------|-----------|------------------------|----------------| +| Hash algorithm(HashAlgorithm) | 0000 | Reserved | 0000 | +| | | Reserved | 0001 | +| | | HashAlgorithm:SM3 | 0010 | +| | | Reserved | 0011~1001 | +| | | User defined | 1010~1111 | +| Public key encryption algorithm
(PublicKeyAlgorithm) | 0001 | Reserved | 0000 | +| | | Reserved | 0001 | +| | | PublicKeyAlgorithm:SM2 | 0010 | +| | | Reserved | 0011~1001 | +| | | User defined | 1010~1111 | + +**Table C.1 – Cryptographic algorithm encoding** + +| Algorithm type | Type code | Algorithm name | Algorithm code | +|--------------------------------------------------|--------------------|------------------------------|-----------------------| +| Block cipher algorithm
(BlockCipherAlgorithm) | 0010 | Reserved | 0000 | +| | | BlockCipherAlgorithm:SM4-CBC | 0001 | +| | | BlockCipherAlgorithm:SM4-ECB | 0010 | +| | | BlockCipherAlgorithm:SM4-CTR | 0011 | +| | | Reserved | 0100~1001 | +| | | User defined | 1010~1111 | +| Signature Algorithm
(SignatureAlgorithm) | 0100 | Reserved | 0000 | +| | | Reserved | 0001 | +| | | SignatureAlgorithm:SM2 | 0010 | +| | | HMAC-SM3 | 0011 | +| | | Reserved | 0100~1001 | +| | | User defined | 1010~1111 | +| Reserved | 0011,
0101~1111 | Reserved | 0000~1111 | + +# Bibliography + +- [b-ITU-T X.800] Recommendation ITU-T X.800 (1991), *Security architecture for Open Systems Interconnection for CCITT applications*. +- [b-ITU-T X.1367] Recommendation ITU-T X.1367 (2020), *Standard format for Internet of things error logs for security incident operations*. +- [b-ITU-T Y.101] Recommendation ITU-T Y.101 (2000), *Global Information Infrastructure terminology: Terms and definitions*. + + + +## SERIES OF ITU-T RECOMMENDATIONS + +| | | +|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Series A | Organization of the work of ITU-T | +| Series D | Tariff and accounting principles and international telecommunication/ICT economic and policy issues | +| Series E | Overall network operation, telephone service, service operation and human factors | +| Series F | Non-telephone telecommunication services | +| Series G | Transmission systems and media, digital systems and networks | +| Series H | Audiovisual and multimedia systems | +| Series I | Integrated services digital network | +| Series J | Cable networks and transmission of television, sound programme and other multimedia signals | +| Series K | Protection against interference | +| Series L | Environment and ICTs, climate change, e-waste, energy efficiency; construction, installation and protection of cables and other elements of outside plant | +| Series M | Telecommunication management, including TMN and network maintenance | +| Series N | Maintenance: international sound programme and television transmission circuits | +| Series O | Specifications of measuring equipment | +| Series P | Telephone transmission quality, telephone installations, local line networks | +| Series Q | Switching and signalling, and associated measurements and tests | +| Series R | Telegraph transmission | +| Series S | Telegraph services terminal equipment | +| Series T | Terminals for telematic services | +| Series U | Telegraph switching | +| Series V | Data communication over the telephone network | +| Series X | Data networks, open system communications and security | +| Series Y | Global information infrastructure, Internet protocol aspects, next-generation networks, Internet of Things and smart cities | +| Series Z | Languages and general software aspects for telecommunication systems | \ No newline at end of file diff --git a/marked/J/T-REC-J.1103-201508-I_PDF-E/14a22f23ced8ba1d63ece69861dbaacc_img.jpg b/marked/J/T-REC-J.1103-201508-I_PDF-E/14a22f23ced8ba1d63ece69861dbaacc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..827609df9ad8667ae079f875841506349f063390 --- /dev/null +++ b/marked/J/T-REC-J.1103-201508-I_PDF-E/14a22f23ced8ba1d63ece69861dbaacc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c0d2afb537db9f3588854962a991eb1178220b2bbb8ff3cea6712979a53a864b +size 4107 diff --git a/marked/J/T-REC-J.1103-201508-I_PDF-E/16152cf1d84aea10848758f51a91ff6a_img.jpg b/marked/J/T-REC-J.1103-201508-I_PDF-E/16152cf1d84aea10848758f51a91ff6a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..36b5ee77457c861a3cf57f95b87b30ef4bc6604c --- /dev/null +++ b/marked/J/T-REC-J.1103-201508-I_PDF-E/16152cf1d84aea10848758f51a91ff6a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c7cdb3f14d9de4b7f5b8d63cf016c6253cd0a1430e2f16add2c838e378f8f083 +size 26538 diff --git a/marked/J/T-REC-J.1103-201508-I_PDF-E/33ed1f9b27c7c21c797aa928b0f06851_img.jpg b/marked/J/T-REC-J.1103-201508-I_PDF-E/33ed1f9b27c7c21c797aa928b0f06851_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..26b5bdf292cb20c817ddba383f6b097f81b87302 --- /dev/null +++ b/marked/J/T-REC-J.1103-201508-I_PDF-E/33ed1f9b27c7c21c797aa928b0f06851_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c8cdbe4608800d76af967f12fe5728d05431455422897e7cfa0b99569bc8ed13 +size 57050 diff --git a/marked/J/T-REC-J.1103-201508-I_PDF-E/75e4b78ee25f885d73120e3066a5253e_img.jpg b/marked/J/T-REC-J.1103-201508-I_PDF-E/75e4b78ee25f885d73120e3066a5253e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..34f28f09f4bf16256966933db5f253322cee408f --- /dev/null +++ b/marked/J/T-REC-J.1103-201508-I_PDF-E/75e4b78ee25f885d73120e3066a5253e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:32e58f21cc8ce6bfeef6c55478ff05b6d2d8369665bfdffb24e732bd52407a7f +size 192190 diff --git a/marked/J/T-REC-J.1103-201508-I_PDF-E/75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg b/marked/J/T-REC-J.1103-201508-I_PDF-E/75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d86ebb29d2ead1ccc22c36bfce1987a22e070a05 --- /dev/null +++ b/marked/J/T-REC-J.1103-201508-I_PDF-E/75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5f45826dbda9f5fd245460ad179ee506b06f927c04fc8fcf850325174708d8fa +size 25957 diff --git a/marked/J/T-REC-J.1103-201508-I_PDF-E/8307f6b04df072c9332f9987e034272c_img.jpg b/marked/J/T-REC-J.1103-201508-I_PDF-E/8307f6b04df072c9332f9987e034272c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ecc9a096ea4684e0e73445d787a2edccd8ef6705 --- /dev/null +++ b/marked/J/T-REC-J.1103-201508-I_PDF-E/8307f6b04df072c9332f9987e034272c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4bd2332da5bb8b104296b0f63d485e8c9ab6a24f9fa997638f3f283e08f8d9db +size 25844 diff --git a/marked/J/T-REC-J.1103-201508-I_PDF-E/8fa679f79a1bb1f527cba9f29e784e89_img.jpg b/marked/J/T-REC-J.1103-201508-I_PDF-E/8fa679f79a1bb1f527cba9f29e784e89_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..09511ca5cacbab71a9a9455903bbbea3259215b1 --- /dev/null +++ b/marked/J/T-REC-J.1103-201508-I_PDF-E/8fa679f79a1bb1f527cba9f29e784e89_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:54fa723c93f160d83765e53a9f34caa44ec8b8006db333fed4ffed78aae93b29 +size 74424 diff --git a/marked/J/T-REC-J.1103-201508-I_PDF-E/90ee16ccc0ad16aeca48087797d7b07f_img.jpg b/marked/J/T-REC-J.1103-201508-I_PDF-E/90ee16ccc0ad16aeca48087797d7b07f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6c927f7f9b9e814166a2750fa6147ca721131445 --- /dev/null +++ b/marked/J/T-REC-J.1103-201508-I_PDF-E/90ee16ccc0ad16aeca48087797d7b07f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4f0491e58175f3e52ced658318c58835d2954b521bff0c6e3768ddd2809f929a +size 25394 diff --git a/marked/J/T-REC-J.1103-201508-I_PDF-E/9c6461e1e94afae4dec455e69a2ce152_img.jpg b/marked/J/T-REC-J.1103-201508-I_PDF-E/9c6461e1e94afae4dec455e69a2ce152_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..63c630393d5a6bcfbd8997a312a7249b07f1c625 --- /dev/null +++ b/marked/J/T-REC-J.1103-201508-I_PDF-E/9c6461e1e94afae4dec455e69a2ce152_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c7473889dc870b5cf1b5117d66e9e9761aae6b4ea3fd1c042327e6997d495009 +size 34487 diff --git a/marked/J/T-REC-J.1103-201508-I_PDF-E/9cd90f495b95ad2116ff780248c26d95_img.jpg b/marked/J/T-REC-J.1103-201508-I_PDF-E/9cd90f495b95ad2116ff780248c26d95_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..85efb49b581c3c3181a93189e716d2eb5b521d71 --- /dev/null +++ b/marked/J/T-REC-J.1103-201508-I_PDF-E/9cd90f495b95ad2116ff780248c26d95_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:59829e6df614990d7bb9fe0095962cfddff295b7deca0eb3aaf415118163b5b8 +size 18713 diff --git a/marked/J/T-REC-J.1103-201508-I_PDF-E/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/marked/J/T-REC-J.1103-201508-I_PDF-E/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9e9a4c522bb8b0fd69cf36cc0fe4108664bc32e4 --- /dev/null +++ b/marked/J/T-REC-J.1103-201508-I_PDF-E/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8773051a4d5519c7d64c5140f2b98034cfffc2f18bf57ad7dfded040599f67e5 +size 62377 diff --git a/marked/J/T-REC-J.1103-201508-I_PDF-E/a5ee5c23b6dc52ec1d724b76d5a5f58f_img.jpg b/marked/J/T-REC-J.1103-201508-I_PDF-E/a5ee5c23b6dc52ec1d724b76d5a5f58f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..97ef8c2350dc795f23c28315ae98965fa11ba83f --- /dev/null +++ b/marked/J/T-REC-J.1103-201508-I_PDF-E/a5ee5c23b6dc52ec1d724b76d5a5f58f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a8da4f80704b8763c86c4c67f482a7fb4b868ba88f1c45d308c24e52f33c1feb +size 95691 diff --git a/marked/J/T-REC-J.1103-201508-I_PDF-E/af7916c89a458fdab6c3f443217388ae_img.jpg b/marked/J/T-REC-J.1103-201508-I_PDF-E/af7916c89a458fdab6c3f443217388ae_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8d80693ff5c3cfc293f6c49f9510ac1a461e9e60 --- /dev/null +++ b/marked/J/T-REC-J.1103-201508-I_PDF-E/af7916c89a458fdab6c3f443217388ae_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:07808bd82ea7863a901318ce23a0cdc9ab0b10255d3f33c7786ac0f655a15f19 +size 52605 diff --git a/marked/J/T-REC-J.1103-201508-I_PDF-E/cbdfdade780e677eb1c1aef3081ce9ef_img.jpg b/marked/J/T-REC-J.1103-201508-I_PDF-E/cbdfdade780e677eb1c1aef3081ce9ef_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..be3652377d786b8c5370afbd282b941f22ea302e --- /dev/null +++ b/marked/J/T-REC-J.1103-201508-I_PDF-E/cbdfdade780e677eb1c1aef3081ce9ef_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8aed5d3655a8d86a0aa78a08f2ec662d321acaf82b4efa5a4267611b767acdc4 +size 163912 diff --git a/marked/J/T-REC-J.1103-201508-I_PDF-E/d4af765160d04ecef538e5066006dc77_img.jpg b/marked/J/T-REC-J.1103-201508-I_PDF-E/d4af765160d04ecef538e5066006dc77_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4f8770e9115d6f00b568209ea6b1be12b955b342 --- /dev/null +++ b/marked/J/T-REC-J.1103-201508-I_PDF-E/d4af765160d04ecef538e5066006dc77_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d99711213a8faf07ed72a3bf402eddca1b5c0dfefde2264971982129d986464a +size 32964 diff --git a/marked/J/T-REC-J.1103-201508-I_PDF-E/e9314c83043183351ed74908e9bf2f90_img.jpg b/marked/J/T-REC-J.1103-201508-I_PDF-E/e9314c83043183351ed74908e9bf2f90_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b142741d1087259120d13419294b52fbe493e3f8 --- /dev/null +++ b/marked/J/T-REC-J.1103-201508-I_PDF-E/e9314c83043183351ed74908e9bf2f90_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cfab0d4faa8f0c2165ca74c1b97d204ed21032b9baecad85c95f257ca8eaa85b +size 30518 diff --git a/marked/J/T-REC-J.1103-201508-I_PDF-E/raw.md b/marked/J/T-REC-J.1103-201508-I_PDF-E/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..4c67d9b6a7b28229e664a0603034408a1f66f6a5 --- /dev/null +++ b/marked/J/T-REC-J.1103-201508-I_PDF-E/raw.md @@ -0,0 +1,891 @@ + + +**ITU-T** + +TELECOMMUNICATION +STANDARDIZATION SECTOR +OF ITU + +**J.1103** + +(08/2015) + +SERIES J: CABLE NETWORKS AND TRANSMISSION +OF TELEVISION, SOUND PROGRAMME AND OTHER +MULTIMEDIA SIGNALS + +Switched digital video over cable networks + +--- + +**Transmission specification for IP-based +switched digital video using data over cable +service interface specifications** + +Recommendation ITU-T J.1103 + + + +# Recommendation ITU-T J.1103 + +# Transmission specification for IP-based switched digital video using data over cable service interface specifications + +## Summary + +Recommendation ITU-T J.1103 describes the transmission specifications of IP-based switched digital video (SDV) using data over cable service interface specifications (DOCSIS) in a digital cable network. The cable broadcasting system has been changed to use resources efficiently and to transmit said resources in such a way that the varying needs of subscribers are easily accommodated. The transmission specifications described in this Recommendation are defined according to Recommendation ITU-T J.1101, *Functional requirements for IP-based switched digital video using data over cable service interface specifications*. These specifications are designed to maintain quality of service (QoS) while using bandwidth effectively in a hybrid fibre/coaxial (HFC) network environment. + +## History + +| Edition | Recommendation | Approval | Study Group | Unique ID* | +|---------|----------------|------------|-------------|---------------------------------------------------------------------------| +| 1.0 | ITU-T J.1103 | 2015-08-13 | 9 | 11.1002/1000/12572 | + +--- + +\* To access the Recommendation, type the URL
00 – Unicast
01 – Multicast
10 – Broadcast
11 – Reserved | +| TYPE_BOND | 1 | TYPE BONDING CONDITION
0 – Channel non-bonded
1 – Channel bonded | +| TYPE_PRIORITY | 1 | TYPE ZERO PRIORITY
0 – Zero priority
1 – Non-zero priority | +| TYPE_MESSAGE | 1 | TYPE MESSAGE
0 – User packet
1 – MAC management message | +| TYPE_RSVD | 3 | TYPE Reserved | +| PRIORITY | 4 | PRIORITY
0x 0 ~ 7: High value is high priority | +| DSID | 20 | Downstream ID | +| DC LIST MASK | 32 | Service available channel list | +| SFID_ADDR | 32 | Service flow ID | + +The service flow classification process is shown in Figure A.1. + +## 7.2 Packet scheduling + +Packet scheduling is required to determine the available downstream channel. It is possible to transmit a management message for a determined channel. The management packet format of a transmission specification is shown in Figure 4. Detailed definitions of the header elements are provided in Table 2. + + + +The diagram illustrates the structure of a management packet. The packet starts with an 'Internal header' (bits 0-31) containing DCID (0-7), UCID (8-15), and LEN (DA ~ CRC) (16-31). This is followed by a 'MAC management message header' which includes DA (bits 32-63), SA (bits 64-95), msg LEN (bits 96-127), DSAP (0x00) (bits 128-135), SSAP (0x00) (bits 136-143), Control (0x03) (bits 144-151), Version (bits 152-159), Type (bits 160-167), and RSVD (bits 168-175). The 'Management message payload' follows, indicated by a dashed box. The packet ends with a CRC field. + +Diagram of the management packet format showing fields: DCID, UCID, LEN (DA ~ CRC), DA, SA, msg LEN, DSAP (0x00), SSAP (0x00), Control (0x03), Version, Type, RSVD, Management message payload, and CRC. It also labels the 'Internal header' and 'MAC management message header'. + +J.1103(15)\_F04 + +**Figure 4 – The management packet format** + +**Table 2 – Management packet frame header** + +| Field | Length (Bit) | Function | +|-------|--------------|-----------------| +| DCID | 8 | Down channel ID | +| UCID | 8 | Up channel ID | +| LEN | 16 | Length | + +## 7.3 MAC header processing + +The MAC header processing unit is required to classify the packet and store it in the queue according to the transmission priority. The MAC header processing unit is required to process the stored packets according to the queue priority shown in Table 3. + +**Table 3 – Queue priority** + +| Input packet priority | Queue priority | +|-----------------------|----------------| +| 15 | 2 | +| 7, 6, 5, 4 | 1 | +| 3, 2, 1, 0 | 0 | + +Different MAC header types are created according to the packet type as shown in Table 4. + +**Table 4 – MAC packet header type** + +| MAC header type | Value | Packet type | +|--------------------|----------|-------------------------------------------------------------| +| Five-Byte DS EHDR | 00110xxx | Channel bonding unicast packet | +| | | Zero length packet | +| | 01110xxx | Channel bonding multicast packet | +| Three-Byte DS EHDR | 01010xxx | Non-bonding multicast packet | +| One-Byte DS EHDR | 00010xxx | Non-bonding and the priority of service flow is not zero | +| No DS EHDR | 00000xxx | Non-bonding and the priority of service flow is not defined | +| | 10000xxx | Non-bonding, broadcast and unknown MAC address message | +| | 00001xxx | Unicast MAC management message | +| | 01001xxx | Multicast MAC management message | + +The format of MAC header processing for a user data packet is shown in Figure 5 and the format of MAC header processing for a management packet is shown in Figure 6. + + + +The diagram illustrates the structure of a MAC packet for user data. At the top, bit positions 0, 8, 16, 24, and 32 are marked. The packet structure is as follows: + +- DOCSIS MAC header (five, three, one or no DS EHDR)**: A green-shaded block at the top, corresponding to the first 6 to 12 bytes. +- DA**: Destination Address field, 6 bytes long. +- DA** and **SA**: Source Address field, 6 bytes long, split into two 3-byte halves. +- Type/LEN**: Type or Length field, 2 bytes long. +- DSAP (0xAA)** and **SSAP (0xAA)**: Service Access Point fields, 1 byte each. +- Control (0x03)** and **ORG Code (0x00)**: Control and Organization Code fields, 1 byte each. +- Type (0x0800, 0x0806, 0x0835)**: EtherType field, 2 bytes long. +- Data (38 ~ 1492 bytes)**: The payload data. +- CRC**: Cyclic Redundancy Check field, 4 bytes long. + +Brackets on the right side of the diagram indicate that the first 6-12 bytes constitute the **DOCSIS MAC header (6 ~ 12 bytes)** and the remaining fields constitute the **802.3 MAC packet PDU (18-1518 bytes)**. + +J.1103(15)\_F05 + +Diagram of MAC header processing for a user data packet showing fields like DOCSIS MAC header, DA, SA, Type/LEN, Control, ORG Code, Type, Data, and CRC with bit positions 0, 8, 16, 24, 32. + +**Figure 5 –MAC header processing for a user data packet** + + + +Figure 6: MAC header processing for a management packet. The diagram shows a packet structure with fields: FC, MAC PARM, LEN, HCS, DA, DA, SA, SA, msg LEN, DSAP (0x00), SSAP (0x00), Control (0x03), Version, Type, RSVD, Management message payload, and CRC. Bit positions 0, 8, 16, 24, and 32 are marked at the top. Brackets on the right indicate the 'DOCSIS MAC header' (first two rows) and 'MAC management message header' (rows 3 through 7). + +**Figure 6 –MAC header processing for a management packet** + +The message format of a five-byte DS EHDR DOCSIS MAC header is shown in Figure 7. MAC header processing is required to operate the sequence count and count initialization at each DSID if the input packet is a bonded packet (Type=1). + +The setting of a five-byte DS EHDR DOCSIS MAC header is shown in Table 5. + + + +Figure 7: Message format of five-byte DS EHDR DOCSIS MAC header. The diagram shows a 32-bit header structure with fields: FC, MAC PARM, LEN, EH\_TYPE, EH\_LEN, TP, SCC, DSID, PSN, and HCS. Bit positions 0, 8, 16, 24, and 32 are marked at the top. A bracket on the right indicates the 'Bonded DOCSIS MAC header (12 bytes)' covering the first three rows. + +**Figure 7 – Message format of five-byte DS EHDR DOCSIS MAC header** + +**Table 5 – Setting of a five-byte DS EHDR DOCSIS MAC header** + +| Field | Size (bits) | Value | | +|-----------|-------------|-------|------------------------------------------------| +| FC | 8 | 0x01 | EHDR_ON = 1 | +| MAC_PARAM | 8 | 0x06 | Extended header length | +| LEN | 16 | | packet PDU length + 6 (extended header length) | +| EH_TYPE | 4 | 0x8 | | +| EH_LEN | 4 | 0x5 | | +| TP | 3 | | Priority of additional area | +| SCC | 1 | | DSID of initialization flag bit | + +**Table 5 – Setting of a five-byte DS EHDR DOCSIS MAC header** + +| Field | Size (bits) | Value | | +|-------|-------------|-------|--------------------------------------| +| DSID | 20 | | DSID of additional area | +| PSN | 16 | | DSID of current sequence count value | +| HCS | 16 | | Calculation of FC to PSN | + +- LEN: the sum of the length of the input packet and the value of the DOCSIS extended header length (6) +- TP: the priority value of the internal additional header in the input packet +- SCC: the initialization flag bit of the relevant DSID +- DSID: the DSID value of the internal additional header of the input packet +- PSN: the current sequence count value which the input packet belongs to +- HCS: the value created by the polynomial $X^{16} + X^{12} + X^5 + 1$ from FC to PSN + +The message format of a null packet DOCSIS MAC header is shown in Figure 8. MAC header processing is required to create null packets and increase the counter value by 1, if the DSID has no input packet (TYPE=0). The setting of a null packet DOCSIS MAC header is shown in Table 6. + + + +J.1103(15)\_F08 + +Figure 8: Message format of a null packet DOCSIS MAC header. The diagram shows a 32-bit header structure with fields FC, MAC PARM, LEN, EH\_TYPE, EH\_LEN, TP, SCC, DSID, PSN, and HCS. A bracket on the right indicates the 'Bonded DOCSIS MAC header (12 bytes)' covering the first 24 bits (FC through DSID). Bit positions 0, 8, 16, 24, and 32 are marked at the top. + +**Figure 8 – Message format of a null packet DOCSIS MAC header** + +**Table 6 – Setting of a null packet DOCSIS MAC header** + +| Field | Size (bits) | Value | | +|-----------|-------------|-------|--------------------------------------| +| FC | 8 | 0x01 | EHDR_ON = 1 | +| MAC_PARAM | 8 | 0x06 | Extended header length | +| LEN | 16 | | 6 (extended header length) | +| EH_TYPE | 4 | 0x8 | | +| EH_LEN | 4 | 0x5 | | +| TP | 3 | 0x0 | | +| SCC | 1 | | DSID of initialization flag bit | +| DSID | 20 | | DSID of additional area | +| PSN | 16 | | DSID of current sequence count value | +| HCS | 16 | | Calculation of FC to PSN | + +- LEN: the value of the DOCSIS extended header length (6) +- SCC: the initialization flat bit of the relevant DSID +- DSID: the DSID value of the internal additional header of the input packet +- PSN: the current sequence count value which the input packet belongs to + +- HCS: the value created by the polynomial $X^{16} + X^{12} + X^5 + 1$ from FC to PSN + +The message format of a three-byte DS EHDR DOCSIS MAC header is shown in Figure 9. MAC header processing is required to create the three-byte DS EHDR DOCSIS MAC header if the input packet is a non-bonded multicast packet (Type=2). + +The setting of a three-byte DS EHDR DOCSIS MAC header is shown in Table 7. + + + +Figure 9: Message format of a three-byte DS EHDR DOCSIS MAC header. The diagram shows a 32-bit header structure. Bit 0 to 8: FC (8 bits). Bit 8 to 16: MAC PARM (8 bits). Bit 16 to 32: LEN (16 bits). Below FC are EH\_TYPE (4 bits) and EH\_LEN (4 bits). Below MAC PARM are TP (3 bits) and x (1 bit). Below LEN is DSID (20 bits). Below EH\_TYPE and EH\_LEN is HCS (16 bits). A vertical double-headed arrow on the right indicates the 'Unbonded and group DOCSIS MAC header (10 bytes)' covering the first 80 bits (10 bytes). The diagram is labeled J.1103(15)\_F09. + +Figure 9 – Message format of a three-byte DS EHDR DOCSIS MAC header + +Table 7 – Setting of a three-byte DS EHDR DOCSIS MAC header + +| Field | Size (bits) | Value | | +|-----------|-------------|-------|------------------------------------------------| +| FC | 8 | 0x01 | EHDR_ON = 1 | +| MAC_PARAM | 8 | 0x04 | Extended header length | +| LEN | 16 | | packet PDU length + 4 (extended header length) | +| EH_TYPE | 4 | 0x8 | | +| EH_LEN | 4 | 0x3 | | +| TP | 3 | | Priority of additional area | +| Reserved | 1 | | DSID of initialization flag bit | +| DSID | 20 | | DSID of additional area | +| HCS | 16 | | Calculation of FC to DSID | + +- LEN: the length of the input packet protocol data unit (PDU) and the value of the DOCSIS extended header length (4) +- TP: the priority value of the internal additional header in the input packet +- SCC: the initialization flag bit of the relevant DSID +- DSID: the DSID value of the internal additional header of the input packet. +- HCS: the value created by the polynomial $X^{16} + X^{12} + X^5 + 1$ from FC to DSID. + +The message format of a one-byte DS EHDR DOCSIS MAC header is shown in Figure 10. MAC header processing is required to create the one-byte DS EHDR DOCSIS MAC header if the input packet is non-bonded and the priority of service flow is set up as a not zero value (Type=3). + +The setting of a one-byte DS EHDR DOCSIS MAC header is shown in Table 8. + + + +Figure 10: Message format of one-byte DS EHDR DOCSIS MAC header. The diagram shows a 32-bit header structure. Bit 0 to 8: FC (8 bits). Bit 8 to 16: MAC PARM (8 bits). Bit 16 to 32: LEN (16 bits). Below FC are EH\_TYPE (4 bits) and EH\_LEN (4 bits). Below MAC PARM are TP (3 bits) and xxxx (1 bit). Below LEN is HCS (16 bits). A vertical double-headed arrow on the right indicates the 'Unbonded and nonzero priority DOCSIS MAC header (8 bytes)' covering the first 64 bits (8 bytes). The diagram is labeled J.1103(15)\_F10. + +Figure 10 – Message format of one-byte DS EHDR DOCSIS MAC header + +**Table 8 – Setting of a one-byte DS EHDR DOCSIS MAC header** + +| Field | size (bits) | value | | +|-----------|-------------|-------|------------------------------------------------| +| FC | 8 | 0x01 | EHDR_ON = 1 | +| MAC_PARAM | 8 | 0x02 | Extended header length | +| LEN | 16 | | packet PDU length + 2 (extended header length) | +| EH_TYPE | 4 | 0x8 | | +| EH_LEN | 4 | 0x1 | | +| TP | 3 | | DSID of additional area | +| Reserved | 5 | 0x0 | | +| HCS | 16 | | Calculation of FC to PSN | + +- LEN: the length of the input packet PDU and the value of the DOCSIS extended header length (4). +- TP: the priority value of the internal additional header in the input packet +- HCS: the value created by the polynomial $X^{16} + X^{12} + X^5 + 1$ from FC to PSN + +The message format of a NO DS EHDR DOCSIS MAC header is shown in Figure 11. MAC header processing is required to create the no DS EHDR DOCSIS MAC header if the input packet is a non-bonded and the priority of service flow is not defined (Type=4). + +The setting of a NO DS EHDR DOCSIS MAC header is shown in Table 9. + + + +Diagram of NO DS EHDR DOCSIS MAC header structure. It shows a header with fields FC (8 bits), MAC PARM (8 bits), LEN (16 bits), and HCS (16 bits). Bit positions 0, 8, 16, 24, and 32 are marked. A bracket on the right indicates the 'Unbonded DOCSIS MAC header (6 bytes)' covering FC, MAC PARM, and LEN. The HCS field follows. Source: J.1103(15)\_F11. + +**Figure 11 – Message format of a NO DS EHDR DOCSIS MAC header** + +**Table 9 – Setting of a NO DS EHDR DOCSIS MAC header** + +| Field | Size (bits) | Value | | +|-----------|-------------|-------|--------------------------| +| FC | 8 | 0x00 | EHDR_ON = 0 | +| MAC_PARAM | 8 | 0x00 | 0 | +| LEN | 16 | | packet PDU length | +| HCS | 16 | | Calculation of FC to PSN | + +- LEN: the value of the length of the input packet PDU +- HCS: the value of polynomial $X^{16} + X^{12} + X^5 + 1$ from FC to LEN + +## 7.4 MPEG-2 TS convergence + +MPEG-2 TS convergence is required to store the DOCSIS MAC frame in the queue and for mapping to MPEG-2 TS. The mapped MPEG-2 TS is required to multiplex the MPEG-2 TS from an A/V encoder or re-multiplexer. The structure of MPEG-2 TS convergence is shown in Figure 12 and the structure of MPEG-2 TS encapsulation is shown in Figure 13. The setting values of MPEG-2 TS header are shown in Table 10. An example of MPEG-2 TS encapsulation is shown in Figure B.1. + + + +Figure 12: Structure of MPEG-2 TS convergence. This block diagram shows the convergence process. On the left, a 'DOCSIS MAC packet' enters a 'DOCSIS MAC packet FIFO'. Above it, 'SYNC message memory' is connected to an 'MPEG-2 TS encapsulator'. The 'DOCSIS MAC packet FIFO' also feeds into this encapsulator. An external 'From A/V encoder or remultiplexer' provides 'MPEG-2 TS' data to an 'MPEG-2 TS multiplex'. The encapsulator outputs 'MPEG-2 TS' data to this multiplex, which then outputs the final 'MPEG-2 TS' stream. A label 'J.1103(15)\_F12' is at the bottom right. + +**Figure 12 – Structure of MPEG-2 TS convergence** + +The MPEG-2 TS convergence is required to set the MPEG-2 TS header format in accordance with Table 10. MPEG-2 TS convergence is required to use the 'pointer field' as the payload unit start indicator (PUSI) is set to 1. + + + +| | | | | | | | | +|---|---|---|---|---|---|---|---| +| 0 | 1 | 0 | 0 | 1 | 1 | 1 | 1 | +| 0 | y | 0 | 1 | 1 | 1 | 1 | 1 | +| 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0 | +| 0 | 0 | 0 | 1 | x | x | x | x | + +Figure 13: Structure of MPEG-2 TS encapsulation. This diagram details the encapsulation process. It starts with a 'DOCSIS MAC Frame FIFO' containing four slots. An arrow labeled 'one MAC frame' points from the FIFO to a large dotted rectangle representing the MAC frame. Below the FIFO, a 'TS head block' is shown as a 4x4 grid of bits. A '4-bit counter' is connected to the bottom row of the TS head block. To the right of the MAC frame, 'MAC\_remains' are indicated. Below the MAC frame, an arrow labeled 'map MAC frame into payload of TS' points to a new structure. This structure consists of an 'MPEG TS header', a 'pointer\_field', a dotted rectangle representing the mapped MAC frame, and 'TS\_remains'. A yellow 'SYNC message' box is shown below the TS header, with a dashed arrow pointing to the 'pointer\_field'. The 'TS\_remains' part of the structure points to a 'TS FIFO' (four slots), which then points to 'To MPEG TS multiplex'. A label 'J.1103(15)\_F13' is at the bottom right. + +**Figure 13 – Structure of MPEG-2 TS encapsulation** + +**Table 10 – MPEG-2 TS header** + +| Field | Size (bits) | Value | | +|-------------------------------------|--------------------|--------------|----------| +| Sync_byte | 8 | 0x47 | | +| Transport_error_indicator | 1 | '0' | | +| Payload_unit_start_indicator (PUSI) | 1 | | | +| Transport_priority | 1 | '0' | Reserved | +| PID | 13 | 0x1FFE | | +| Transport_scrambling_control | 2 | '0' | Reserved | +| Adaptation_field_control | 2 | '01' | | +| Continuity_counter | 4 | | | + +## Annex A + +### The service flow classification process + +(This annex forms an integral part of this Recommendation.) + +The input packet is classified into only one service flow by field searching. The service flow classification process consists of a two-stage approach as follows: + +First stage: classification via the destination address of the input MAC packet + +Second stage: classification via a defined packet classifier + +Figure A.1 illustrates the service flow classification process. + +In the first stage, it is possible to determine a specific set-top box (STB) according to the destination MAC address of the input packet. It is necessary to find the specific address from the input MAC Dest. Addr. To CM Classifier Entity Table. + + + +The diagram illustrates the service flow classification process through six interconnected tables and numbered steps: + +- [1] Input MAC Dest. Addr. to CM classifier entity table**: + + +| IN pkt MAC | Table entry addr | +|------------|------------------| +| cm1 | 0xee080000 | +| cm2 | 0xee080008 | +| cm3 | ... | +| cm4 | ... | +| cm5 | ... | +| cpe1 | 0xee09ee06 | +| cpe2 | ... | +| cpe3 | | +| cpe4 | | +| gmac1 | | +| gmac2 | | +| gmac3 | | +- [2] CM classifier entity table**: + + +| CM MAC | Classifier entities (CLID's) | +|--------|------------------------------| +| cm1 | 5, 2, 3 | +| cm2 | 7, 2 | +| cm3 | - | +| ... | ... | +- [3] Classifier pattern table**: + + +| | +|----------| +| pattern1 | +| pattern2 | +| pattern3 | +- [4] Second stage classification table**: + + +| CM MAC + matched value | DS SFID | +|------------------------|---------| +| cm1 + str1 | | +| cm1 + str2 | | +| cm2 + str1 | | +| cm3 | | +| ... | | +- [5] Active DS service flow table**: + + +| DS SFID | CM MAC | DSID | DC Lists | Pkt type | Priority | QoS Class | +|---------|--------|------|----------|----------|----------|-----------| +| sfid 1 | cm1 | 3 | 0x000D | 1 | 1 | | +| sfid 2 | cm1 | 4 | 0x004E | 1 | 2 | | +| sfid 3 | cm2 | null | 0x0002 | 3 | 0 | | +| sfid 4 | cm3 | 6 | 0x0020 | 2 | 0 | | +| sfid 5 | cm4 | 7 | 0x0040 | 2 | 1 | | +| ... | ... | ... | ... | ... | ... | | +- [6] DS QoS attribution table**: + + +| QoS Class | Max susR | Max Burst | Min RvR | Ass. Min RvR | Max. Latency | Peak rate | +|-----------|----------|-----------|---------|--------------|--------------|-----------| +| 1 | | | | | | | +| 2 | | | | | | | +| 3 | | | | | | | +| ... | | | | | | | + +**Process Flow:** + +- (1)** Input MAC Dest. Addr. is used to look up the entry address in table [1], which points to the entry in table [2]. +- (2)** The classifier entities (CLID's) from table [2] are used to look up patterns in table [3]. +- (3)** A matching value is determined from the patterns in table [3]. +- (4)** The CM MAC Addr. and the Matching value are used to look up the DS SFID in table [4]. +- (5)** The DS SFID is used to look up the service flow details in table [5]. +- (6)** The QoS Class from table [5] is used to look up the QoS attributes in table [6]. + +Flowchart of the service flow classification process showing six tables and numbered steps (1-6). + +Figure A.1 – Example of a service flow classification process + +For the second stage, it is necessary to find a specific service flow using the following three tables: the CM Classifier Entity Table, the Classifier Pattern Table and the Second Stage Classification Table. + +The CM Classifier Entity Table is required to store the classifier ID. The maximum number of classifiers depends upon the specification of the headend MAC module. + +The input packet is classified into a specific service flow through a field search of the input packet. As stated previously the service flow is generally classified as follows. + +Step 1: Classification via the destination address of the input MAC packet + +Step 2: Classification via a defined packet classifier + +This classification is via the MAC packet destination address of stage 1. A specific MAC address of the terminal platform with which the MAC packet is associated can be found through the first stage of the classification process. In the second stage of the classification process, the final service flow is determined in the relevant terminal MAC in the case where the classification with other fields besides the input MAC address is defined during the registration of the relevant terminal platform or the dynamic service creation procedure. If there is no stage 2 of the classification process, the service flow is mapped as the default service flow (or primary service flow) which is allocated to the relevant terminal platform. Figure A.1 shows the mapping process through which the input packet is classified and mapped into one service flow. + +In the first stage of the classification process the terminal to which the packet is to be transmitted is determined according to the MAC address and the result of the Input MAC Dest. Addr to CM Classifier Entity Table. + +[1] Input MAC Dest. Addr to CM Classifier Entity Table + +The terminal platform associated with the input MAC destination address is set so that it is able to find the relevant saved address of the [2] CM Classifier Entity Table for the second classification. + +The saved address from the [2] CM Classifier Entity Table of the relevant cable modem (CM) is obtained from the destination MAC address of the input MAC packet through the [1] Input MAC Dest. Addr to CM Classifier Entity Table for the second classification of the relevant terminal platform. + +The aim of the second stage of the classification process is to find to which service flow in the relevant terminal platform the input packet relates and the following three tables are needed for this search: + +[2] CM Classifier Entity Table + +The MAC address of the CM and the classifier IDs which are to apply to each CM are saved according to priority. + +The classifier IDs are the IDs from the [3] Classifier Pattern Table and have values in the range 0 ~ 63556. + +In accordance with the supported specification of the headend MAC module, the maximum value of the classifier to which a terminal platform can apply is set at maximum. + +[3] Classifier Pattern Table + +This table contains the classifier patterns which are commonly used in the headend MAC. + +A single classifier can be composed from a combination of fields. + +[4] Second Stage Classification Table + +The table is set to find the service flow the result value from the MAC address of the CM to which the input packet is transmitted and the defined classifier in the relevant CM. + +The result value is input when the terminal platform MAC address and the classifier are applied. As for the result value, the address to which the specific service flow attribution of the [5] Active DS Service Flow Table is saved as output. + +The second stage of the classification process is as follows: + +From the address of the [2] CM Classifier Entity Table which is obtained from the first stage of the classification process, the terminal platform MAC address and the classifier ID which is applied in the CM are obtained. + +According to the MAC address of the relevant terminal platform and the order of the classifier ID which is to be applied to the relevant terminal platform, one character string is composed by adding the result value which is obtained by applying the classifier to the CM Classifier Entity Table. + +The value which is relevant to the resulting character string is obtained from the Second Stage Classification Table. Then the address of the service flow which belongs to the relevant character string is found on the [5] Active DS Service Flow Table. + +If the second classification procedure is completed, the address of the service flow where the packet belongs can be found on the [5] Active DS Service Flow Table. The basic attribution of the service flow which is necessary for downstream transmission can be obtained from the [5] Active DS Service Flow Table. + +### [5] Active DS Service Flow Table + +The basic information of downstream service flow is saved as below: + +- Terminal platform MAC address +- DSID +- DSID channel list +- Packet type +- Priority +- DS QoS attribution + +### [6] DS QoS Attribution Table + +The supported QoS is classified as the determined number and applied to the relevant service flow. + +The following attributions are saved in the DS QoS attribution table: + +- QoS class +- Maximum sustained traffic rate +- Minimum reserved traffic rate +- Assumed minimum reserved traffic rate +- Maximum latency +- Peak Rate + +The DS QoS attribution is not applied in the first implementation. + +The Create/Alter/Delete functions of each table are performed in the headend MAC control server module and completed through the following process. + +Presetting by the operator in the headend MAC module (provisioning) + +Signalling between the headend MAC module and the terminal platform MAC module (registration, DSA) + +Obtaining the CPE MAC address (address aging) + +The destination MAC address process for multicasting is dealt with separately as it is not relevant to certain terminal platforms (excluded from the first year implementation range). + +The [3] Classifier Pattern Table is required to store the classifier pattern and it consists of the following configuration fields: IPV4 packet classification, TCP/UDP packet classification, Ethernet LLC packet classification, IEEE 802.1P/Q packet classification and IPV6 packet classification. The classifier configuration fields are shown in Table A.1. + +**Table A.1 – Classifier configuration fields** + +| Function | Detailed field | +|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IPv4 Packet Classification | IPv4 Type of Service Range and Mask
IP Protocol
IPv4 Source Address
IPv4 Source Mask
IPv4 Destination Address
IPv4 Destination Mask | +| TCP/UDP Packet Classification | TCP/UDP Source Port Start
TCP/UDP Source Port End
TCP/UDP Destination Port Start
TCP/UDP Destination Port End | +| Ethernet LLC Packet Classification | Destination MAC Address
Source MAC Address
Ethertype/DSAP/MacType | +| IEEE 802.1P/Q Packet Classification | IEEE 802.1P Priority Range
IEEE 802.1Q VLAN ID | +| IPv6 Packet Classification | IPv6 Traffic Class Range and Mask
IPv6 Flow Label
IPv6 Next Header Type
IPv6 Source Address
IPv6 Source Prefix Length (bits)
IPv6 Destination Address
IPv6 Destination Prefix Length (bits) | + +The [4] Second Stage Classification Table is required to find the service flow and it is possible to find the DS SFID address of the [5] Active DS Service Flow Table. + +The [5] Active DS Service Flow Table is required to contain the following information: STB MAC address, DSID, DSID channel list, packet type, priority and DS QoS attribution. + +The [6] DS QoS Attribution Table is required to contain the following information: QoS Class, maximum sustained traffic rate, minimum reserved traffic rate, assumed minimum reserved traffic rate, maximum latency and peak rate. + +## Annex B + +## Examples of MPEG-2 TS encapsulation + +(This annex forms an integral part of this Recommendation.) + +Examples of MPEG-2 TS encapsulation are shown in Figure B.1. + +Case (a) is an example of one MPEG-2 TS transmission including a MAC frame. In this case PUSI is set to '1' and the 'pointer field' is set to '0'. + +Case (b) is an example of one MPEG-2 TS transmission including part of a MAC frame and another MAC frame. The value of PUSI is set to '1' and in the 'pointer field' the first 'stuff byte' is indicated. + +Case (c) is an example of one MPEG-2 TS transmission including multiple MAC frames. The value of PUSI is set to '1' and the 'pointer field' is set to '0'. + +Case (d) is an example of three MPEG-2 TS transmissions for one MAC frame. The value of PUSI is set to '1' and the 'pointer field' is set to '0' in the first MPEG-2 TS transmission. + +The value of PUSI is set to '0' in the second MPEG-2 TS transmission. + +The value of PUSI is set to '1' and the 'pointer field' indicates the first 'stuff byte' in the third MPEG-2 TS transmission. The third MPEG-2 TS transmission includes a part of one MAC frame and another MAC frame as in Case (b). + + + +DOCSIS MAC frame + +(a) + +| | | | | +|----------------|---------------|--|-------------| +| MPEG TS header | pointer_field | | stuff_bytes | +| PUSI = 1 | 0 | | 0xFF | + +DOCSIS MAC frame + +Frame #1 + +Frame #2 + +(b) + +| | | | | | +|----------------|---------------|------------------|-------------|---| +| MPEG TS header | pointer_field | tail of frame #1 | stuff_bytes | B | +| PUSI = 1 | ↑ | | | | + +DOCSIS MAC frame + +A + +B + +(c) + +| | | | | | +|----------------|---------------|---|---|-------------| +| MPEG TS header | pointer_field | A | B | stuff_bytes | +| PUSI = 1 | 0 | | | 0xFF | + +DOCSIS MAC frame + +Frame #1 + +Frame #2 + +(d) + +| | | | +|----------------|---------------|-------------------| +| MPEG TS header | pointer_field | Start of frame #1 | +| PUSI = 1 | 0 | | + +| | | | +|----------------|--------------------------|--| +| MPEG TS header | Continuation of frame #2 | | +| PUSI = 0 | | | + +| | | | | | +|----------------|---------------|------------------|-------------|----------| +| MPEG TS header | pointer_field | tail of frame #1 | stuff_bytes | Frame #2 | +| PUSI = 1 | ↑ 0xFF | | | | + +J.1103(15)\_FB.1 + +**Figure B.1 – Examples of MPEG-2 TS encapsulation format** + +## Bibliography + +- [b-ITU-T J.112] Recommendation ITU-T J.112 Annex B (2004), *Data-over-cable service interface specifications: Radio-frequency interface specification.* +- [b-ANSI/SCTE 133] ANSI/SCTE 133 (2010), *Downstream RF interface for Cable Modem Termination Systems.* +- [b-ANSI/SCTE 135-1] ANSI/SCTE 135-1 (2013), *DOCSIS 3.0 Part 1: Physical Layer Specification.* +- [b-ANSI/SCTE 135-2] ANSI/SCTE 135-2 (2013), *DOCSIS 3.0 Part 2: MAC and Upper Layer Protocols.* +- [b-ANSI/SCTE 135-4] ANSI/SCTE 135-4 (2013), *DOCSIS 3.0 Part 4: Operations Support Systems Interface.* +- [b-ANSI/SCTE 135-5] ANSI/SCTE 135-5 (2009), *DOCSIS 3.0 Part 5: Cable Modem to Customer Premise Equipment Interface.* +- [b-ANSI/SCTE 137-1] ANSI/SCTE 137-1 (2010), *Modular Headend Architecture Part 1: DOCSIS Timing Interface.* +- [b-ANSI/SCTE 137-2] ANSI/SCTE 137-2 (2010), *Modular Headend Architecture Part 2: M-CMTS Downstream External PHY Interface.* +- [b-ANSI/SCTE 137-3] ANSI/SCTE 137-3 (2010), *Modular Headend Architecture Part 3: M-CMTS Operations Support System Interface.* +- [b-ANSI/SCTE 137-4] ANSI/SCTE 137-4 (2010), *Modular Headend Architecture Part 4: Edge Resource Manager Interface for Modular Cable Modem Termination Systems.* +- [b-ANSI/SCTE 137-5] ANSI/SCTE 137-5 (2010), *Modular Headend Architecture Part 5: Edge QAM Provisioning and Management Interface.* + + + + + +## SERIES OF ITU-T RECOMMENDATIONS + +| | | +|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Series A | Organization of the work of ITU-T | +| Series D | General tariff principles | +| Series E | Overall network operation, telephone service, service operation and human factors | +| Series F | Non-telephone telecommunication services | +| Series G | Transmission systems and media, digital systems and networks | +| Series H | Audiovisual and multimedia systems | +| Series I | Integrated services digital network | +| Series J | Cable networks and transmission of television, sound programme and other multimedia signals | +| Series K | Protection against interference | +| Series L | Environment and ICTs, climate change, e-waste, energy efficiency; construction, installation and protection of cables and other elements of outside plant | +| Series M | Telecommunication management, including TMN and network maintenance | +| Series N | Maintenance: international sound programme and television transmission circuits | +| Series O | Specifications of measuring equipment | +| Series P | Terminals and subjective and objective assessment methods | +| Series Q | Switching and signalling | +| Series R | Telegraph transmission | +| Series S | Telegraph services terminal equipment | +| Series T | Terminals for telematic services | +| Series U | Telegraph switching | +| Series V | Data communication over the telephone network | +| Series X | Data networks, open system communications and security | +| Series Y | Global information infrastructure, Internet protocol aspects and next-generation networks | +| Series Z | Languages and general software aspects for telecommunication systems | \ No newline at end of file diff --git a/marked/J/T-REC-J.1107-201803-I_PDF-E/raw.md b/marked/J/T-REC-J.1107-201803-I_PDF-E/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..2bb8c65ca775d248c863e52262fdc1078700604f --- /dev/null +++ b/marked/J/T-REC-J.1107-201803-I_PDF-E/raw.md @@ -0,0 +1,397 @@ + + +**ITU-T** + +TELECOMMUNICATION +STANDARDIZATION SECTOR +OF ITU + +**J.1107** + +(03/2018) + +SERIES J: CABLE NETWORKS AND TRANSMISSION +OF TELEVISION, SOUND PROGRAMME AND OTHER +MULTIMEDIA SIGNALS + +Switched digital video over cable networks + +--- + +**Architecture and specification for radio over IP +transmission systems** + +Recommendation ITU-T J.1107 + + + +# Recommendation ITU-T J.1107 + +# Architecture and specification for radio over IP transmission systems + +## Summary + +As cable television (TV) networks migrate to deep fibre or fibre to the home (FTTH) architectures, it is now possible and easy to provide bidirectional high-quality media services that require very high-speed digital transmission of high-quality content. Cable TV networks provide services by transmitting radio frequency (RF) signals between the headend and a cable modem (CM). The configuration and devices of these networks are optimized for RF signal transmission. When migrating to all-fibre cable TV networks, changing the existing network devices to new network devices for service operators (SOs), who provide broadcasting and various data services through hybrid fibre coaxial (HFC)-based cable TV networks, is recommended. Therefore, a cost-effective solution for deployable and acceptable migration toward optic-based cable TV networks is required. + +Recommendation ITU-T J.1107 provides a cost-effective adaptable solution for HFC-based cable TV network devices in optic-based cable TV networks. The purpose of the radio over Internet protocol (RoIP) system is to transmit data over cable service interface specifications (DOCSIS)-based upstream (US) RF signals of CM to cable modem termination system (CMTS) through IP transmission in optic-based cable TV networks. + +## History + +| Edition | Recommendation | Approval | Study Group | Unique ID* | +|---------|----------------|------------|-------------|---------------------------------------------------------------------------| +| 1.0 | ITU-T J.1107 | 2018-03-16 | 9 | 11.1002/1000/13564 | + +## Keywords + +RoIP. + +--- + +\* To access the Recommendation, type the URL
a) Find, scan and manage current wireless network access points (AP) available;
b) Manage current network access linkage, such as connection establishment, disconnection, connection forbidden and connection deleting. | See clause C.3.3 | +| ScanResult | Class | WiFi scanning result, it describes information of a connection access point found by WiFi scanning. | See clause C.3.4 | + +### **6.2.5 Human-machine interaction unit** + +#### **6.2.5.1 Overview of the human-machine interaction unit** + +The human-machine interaction unit is used to implement the functions of device input control and front panel display control. The input packages user command sent by input devices such as remote controller, mouse, keyboard and front panel key as key message, and the output feeds information back through front panel or display screen. Meanwhile, it also supports speech input control and implementation. This unit defines the human-machine interaction module. Refer to Annex D for the detailed definition of the Java interface. + +#### **6.2.5.2 Human-machine interaction module** + +The human-machine interaction module provides the class and method related to human-machine interaction, including user input and front panel output. + +See Table 10 for an overview of the human-machine interaction module. + +**Table 10 – Overview of the human-machine interaction module** + +| Object name | Type | Description | Remarks | +|-------------|-----------|-----------------------------------|------------------| +| UserInput | Interface | Definition of user input message. | See clause D.2.1 | + +**Table 10 – Overview of the human-machine interaction module** + +| Object name | Type | Description | Remarks | +|------------------|-----------|-------------------------------------------------------------------------------------------------------------------------|-------------------| +| NgbKeyListener | Interface | Key event listener interface, it is implemented by the application which needs to monitor KeyEvent. | See clause D.2.2 | +| NgbMouseListener | Interface | Mouse event listener interface, it is implemented by the application which needs to monitor MouseEvent. | See clause D.2.3 | +| NgbVoiceListener | Interface | Voice event listener interface, it is implemented by the application which needs to monitor voice recognition. | See clause D.2.4 | +| FrontPanel | Class | Display output control for front panel information, including LED indicator light and LED digital tube display control. | See clause D.2.5 | +| NgbInputManager | Class | Input control manager, used to receive the listener of remote controller, key and mouse and control input. | See clause D.2.6 | +| NgbVoiceManager | Class | Voice-related control manager, used to control and implement voice recognition function. | See clause D.2.7 | +| NgbInputEvent | Event | Input event class, it is a base class of input events. | See clause D.2.8 | +| KeyEvent | Event | Key event class, it inherits NgbInputEvent class. | See clause D.2.9 | +| MouseEvent | Event | Mouse event class, it inherits NgbInputEvent class. | See clause D.2.10 | + +### 6.2.6 AV setting unit + +#### 6.2.6.1 Overview of the AV setting unit + +The AV setting unit is used to implement the functions of getting and setting audio video parameters, including audio output port status, track type, global volume and volume status, etc., as well as video output port status, window matching module, brightness, contrast ratio, saturation, system and transparency, etc. It defines the AV setting module. Refer to Annex E for the detailed definition of the Java interface. + +#### 6.2.6.2 AV setting module + +The AV setting module provides the class and method related to the setting of audio video output parameters. + +See Table 11 for an overview of the AV setting module. + +**Table 11 – Overview of the AV setting module** + +| Object name | Type | Description | Remarks | +|--------------|-------|----------------------------------------------------|------------------| +| AudioSetting | Class | Set various parameters of audio input/output unit. | See clause E.2.1 | +| VideoSetting | Class | Set various parameters of video input/output unit. | See clause E.2.2 | + +### 6.2.7 Media processing unit + +#### 6.2.7.1 Overview of the media processing unit + +The media processing unit is used to implement media player function, including playing, control and language selection, etc. It defines the media processing module. Refer to Annex F for the detailed definition of the Java interface. + +#### 6.2.7.2 Media processing module + +The media processing module provides the interface class of all media functions as well as relevant audio and video information classes. The media processing module is used to support DVB, VOD, IP broadcasting, IP broadcasting on demand and local broadcasting functions. + +The fundamental classes defined in the media processing module include: + +- MediaPlayer class; +- TrackInfo class for audio, video and subtitle; +- MediaFormat class. + +See Table 12 for an overview of the media processing module. + +**Table 12 – Overview of the media processing module** + +| Object name | Type | Description | Remarks | +|-------------|-------|-----------------------------------------------------------------------------------------------------------------------------|------------------| +| MediaPlayer | Class | Provide all media function interfaces. Support DVB, VOD, IP broadcasting, IP broadcasting on demand and local broadcasting. | See clause F.2.1 | +| TrackInfo | Class | Describe track information such as audio, video and subtitle. | See clause F.2.2 | +| MediaFormat | Class | Use HashMap to store audio video stream and other information. | See clause F.2.3 | + +### 6.2.8 System management unit + +#### 6.2.8.1 Overview of the system management unit + +The system management unit is used to implement peripheral device management, over the air (OTA) upgrade management, storage management and other system-related functions. It defines the system management module, OTA upgrade module and storage management module. Refer to Annex G for the detailed definition of the Java interface. + +#### 6.2.8.2 System management module + +The system management module provides the class and method for configuration parameter access, software and hardware configuration information retrieval, peripheral management and system operation, etc. + +See Table 13 for an overview of the system management module. + +**Table 13 – Overview of the system management module** + +| Object name | Type | Description | Remarks | +|----------------|-----------|---------------------------------------------------------------------|------------------| +| PeripheralType | Interface | Constant definition interface of peripheral type supported by TVOS. | See clause G.2.1 | + +**Table 13 – Overview of the system management module** + +| Object name | Type | Description | Remarks | +|--------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| Peripheral | Interface | Peripheral description interface, it provides the methods to get peripheral name, status, type and ID, etc. | See clause G.2.2 | +| PeripheralListener | Interface | Peripheral listener, it is implemented by the application. | See clause G.2.3 | +| PeripheralManager | Class | Peripheral manager, it is an entry class of peripheral management module. | See clause G.2.4 | +| DataConfig | Class | Configuration data access class, it provides the method to access configuration data saved in the receiving terminal non-volatile memory (NVM). | See clause G.2.5 | +| HardwareInfo | Class | Hardware information description class, it provides the method to get hardware parameter information at the receiving terminal. | See clause G.2.6 | +| SoftwareInfo | Class | Software information description class, it provides the method to get software parameter information at the receiving terminal. | See clause G.2.7 | +| SysTool | Class | System tool class, it provides the operation method for system standby, hibernation and restart, etc. | See clause G.2.8 | +| PeripheralEvent | Event | Peripheral message event. | See clause G.2.9 | + +#### **6.2.8.3 OTA upgrade module** + +The OTA upgrade module provides the class and method for OTA software upgrade detection and handling. + +See Table 14 for an overview of the OTA upgrade module. + +**Table 14 – Overview of the OTA upgrade module** + +| Object name | Type | Description | Remarks | +|------------------|-----------|-----------------------------------------------------------|------------------| +| OTAEVENTListener | Interface | OTA event listener, it is implemented by the application. | See clause G.3.1 | +| OTAManager | Class | OTA manager, it is an entry class of OTA function module. | See clause G.3.2 | +| OTAEVENT | Event | OTA event. | See clause G.3.3 | + +#### **6.2.8.4 Storage management module** + +The storage management module provides the class and method for storage device management and partitioned access of storage device. + +See Table 15 for an overview of the storage management module. + +**Table 15 – Overview of the storage management module** + +| Object name | Type | Description | Remarks | +|----------------------|-----------|------------------------------------------------------------------------------------------------------------------------|------------------| +| Storage | Interface | It describes storage device information, such as name, size, idle status and partition. | See clause G.4.1 | +| StorageEventListener | Interface | Storage event listener, it is implemented by the application. | See clause G.4.2 | +| StoragePartition | Interface | It describes partition information of storage device, such as name, size, idle status, access path and partition type. | See clause G.4.3 | +| StorageManager | Class | It provides the method to manage the storage device and partition the storage device. | See clause G.4.4 | +| StorageEvent | Event | Storage events related to the storage device. | See clause G.4.5 | + +### 6.2.9 Application engine unit + +#### 6.2.9.1 Overview of the application engine unit + +The application engine unit is used to implement the functions of channel search, electronic program guide acquisition and information search. It defines the channel search module, electronic program guide module and information search module. Refer to Annex H for the detailed definition of the Java interface. + +#### 6.2.9.2 Channel search module + +The channel search module provides the class and method related to channel search. + +See Table 16 for an overview of the channel search module. + +**Table 16 – Overview of the channel search module** + +| Object name | Type | Description | Remarks | +|----------------------------|-----------|--------------------------------------------------------------------------------------|------------------| +| ChannelScanListener | Interface | Channel scanning listener, it is implemented by the application. | See clause H.2.1 | +| ChannelScanEngine | Class | Search engine. It is an entry class of channel scanning function unit. | See clause H.2.2 | +| ChannelScanEvent | Event | Channel scanning event, base class | See clause H.2.3 | +| ChannelScanFailureEvent | Event | Channel scanning failure event, it inherits ChannelScanEvent class. | See clause H.2.4 | +| ChannelScanFinishEvent | Event | Channel scanning finish event, it inherits ChannelScanEvent class. | See clause H.2.5 | +| ChannelScanNITSuccessEvent | Event | Channel scanning success and NIT analysis event, it inherits ChannelScanEvent class. | See clause H.2.6 | +| ChannelScanSuccessEvent | Event | Channel scanning success event, it inherits ChannelScanEvent class. | See clause H.2.7 | + +#### 6.2.9.3 Electronic program guide module + +Electronic program guide (EPG) provides the method for terminal users to browse broadcasting service information, such as service name, program starting and ending time, and content outline, so that terminal users can fast retrieve and access the services. This part follows the analysis and presentation of EPG program information. + +The electronic program guide module provides the class and method for EPG information acquisition. Cache mechanism can be adopted for EPG information acquisition, or EPG information can be temporarily downloaded, if necessary. If the cache mechanism is applied, EPG information should be monitored in real time to ensure the application can extract the latest EPG information. + +See Table 17 for an overview of the electronic program guide module. + +**Table 17 – Overview of the electronic program guide module** + +| Object name | Type | Description | Remarks | +|----------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| ProgramEvent | Interface | It describes the information of a program event. | See clause H.3.1 | +| ProgramEventFilter | Interface | It defines the filter interface used by the application to query program event information from EPG module, and it is implemented by the application layer. | See clause H.3.2 | +| ProgramService | Interface | It describes service information of a program, and it is the packaging of a group of program event information belonging to the same service. | See clause H.3.3 | +| ProgramServiceFilter | Interface | It defines the filter interface used by the application to query program service information from EPG module, and it is implemented by the application layer. | See clause H.3.4 | +| EPGUpdateListener | Interface | PEG information update listener, it is implemented by the application. | See clause H.3.5 | +| EPGManager | Class | EPG manager, it is an entry class of EPG information retrieval. | See clause H.3.6 | +| EPGUpdateEvent | Event | EPG information update event. | See clause H.3.7 | + +#### 6.2.9.4 Information search module + +The information search module provides the class and method related to global search and auto complete search. The definitions of "global search" and "auto complete search" are as below: + +"Global search" – seek SI and PVR contents according to the search conditions set by users, and return meaningful results to improve user experience. + +"Auto complete search" – give matched character strings in the current data source according to user's input to shorten user's time to input query keywords and lower user's difficulty in inputting query keywords. + +The information search module includes the following components: + +- SearchManager – entry class of information search module; +- GlobalSearchSession – session associated with global search process; +- AutoCompleteSearchSession – session associated with auto complete search process. + +See Table 18 for an overview of the information search module. + +**Table 18 – Overview of the information search module** + +| Object name | Type | Description | Remarks | +|------------------------------|-----------|----------------------------------------------------------------------|------------------| +| AutoCompleteSearchListener | Interface | Auto complete search listener, it is implemented by the application. | See clause H.4.1 | +| AutoCompleteSearchResultItem | Interface | It describes the results of auto complete search and provides the | See clause H.4.2 | + +**Table 18 – Overview of the information search module** + +| Object name | Type | Description | Remarks | +|------------------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| | | method to get the results of auto complete search. | | +| AutoCompleteSearchResultList | Interface | It describes the list object of auto complete search results and provides the method to access the result items of auto complete search. | See clause H.4.3 | +| AutoCompleteSearchSession | Interface | It describes a session of auto complete search and provides the method to control the session of auto complete search. | See clause H.4.4 | +| GlobalSearchListener | Interface | Global search listener, it is implemented by the application. | See clause H.4.5 | +| GlobalSearchResultItem | Interface | It describes an object of global search result and provides the method to access the search results. | See clause H.4.6 | +| GlobalSearchResultList | Interface | It describes the list object of global search results and provides the method to access the result items of global search. | See clause H.4.7 | +| GlobalSearchSession | Interface | It describes a global search session and provides the method to control the global search session. | See clause H.4.8 | +| RetrieveDirection | Interface | It defines the constant of search result seeking direction. | See clause H.4.9 | +| SearchContentType | Interface | Content type constant definition. | See clause H.4.10 | +| SearchCriteriaFlags | Interface | Filtering criteria flag definition. | See clause H.4.11 | +| SearchFields | Interface | It provides the interface for setting search fields. | See clause H.4.12 | +| SearchHistoryItem | Interface | It describes a search history and provides the method to get all kinds of information of search history. | See clause H.4.13 | +| SearchHistoryList | Interface | It describes the search history list and provides the function of traversing the search history list. | See clause H.4.14 | +| SearchStatus | Interface | It defines the search status constant. | See clause H.4.15 | +| SourceType | Interface | Definition of search data source constant. | See clause H.4.16 | +| AutoCompleteSearchFilter | Class | It describes a filter of auto complete search and provides the method to set and get auto complete search filtering conditions. | See clause H.4.17 | +| GlobalSearchFilter | Class | It describes a filter of global search and provides the method to set and get global search filtering conditions. | See clause H.4.18 | + +**Table 18 – Overview of the information search module** + +| Object name | Type | Description | Remarks | +|--------------------|-------------|-----------------------------------------------------------------------------------------------------------|-------------------| +| SearchManager | Class | Search manager of global search and auto complete search, it is an entry class of search function module. | See clause H.4.19 | +| SortCriteria | Class | It defines sorting constant and sorting method. | See clause H.4.20 | + +### **6.2.10 Multi-screen interaction unit** + +#### **6.2.10.1 Overview of the multi-screen interaction unit** + +The multi-screen interaction unit is used to implement multi-screen interaction local area network (LAN) interface, and it defines the multi-screen interaction module. Refer to Annex I for the detailed definition of the Java interface. + +#### **6.2.10.2 Multi-screen interaction module** + +The multi-screen interaction module can implement the functions of discovering, connecting and controlling server equipment in LAN by the application client. + +See Table 19 for an overview of the multi-screen interaction module. + +**Table 19 – Overview of the multi-screen interaction module** + +| Object name | Type | Description | Remarks | +|----------------------|-------------|-------------------------------------------------------------------------------------------|------------------| +| IMultiScreenService | Interface | Function interface used to support multi-screen-interactive component in LAN environment. | See clause I.2.1 | +| IMultiScreenCallBack | Interface | Remote access interface provided by multi-screen-interactive component. | See clause I.2.2 | + +### **6.2.11 DRM management unit** + +#### **6.2.11.1 Overview of the DRM management unit** + +The DRM management unit is used to implement DRM management function, and It defines the DRM management module. Refer to Annex J for the detailed definition of the Java interface. + +#### **6.2.11.2 DRM management module** + +See Table 20 for an overview of the DRM management module. + +**Table 20 – Overview of the DRM management module** + +| Object name | Type | Description | Remarks | +|--------------------|-------------|-----------------------------------------------------------------------------------|------------------| +| CommonDrmManager | Class | DRM module class. | See clause J.2.1 | +| CommonDrmTeeRetVal | Class | Return type class of CommonDrm_SendCommandToTEE method of CommonDrmManager class. | See clause J.2.2 | + +### 6.2.12 DCAS management unit + +#### 6.2.12.1 Overview of the DCAS management unit + +The DCAS management unit is used to implement registration, filter setting and trusted application (Tapp) communication functions related to DCAS application, and It defines the conditional access system (CAS) descrambler module, CAS control module, CAS message module, and CAS listener module. Refer to Annex K for the detailed definition of the Java interface based on [b-ITU-T J.1033]. + +#### 6.2.12.2 CAS descrambler module + +The CAS descrambler module provides application programming interface for DCAS terminal software platform to descramble. + +See Table 21 for an overview of the CAS descrambler module. + +**Table 21 – Overview of the CAS descrambler module** + +| Object name | Type | Description | Remarks | +|-------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| CASModule | Interface | CASModule object used to express the request of descrambling a group of elementary streams. | See clause K.2.1 | +| CASDataUtils | Interface | Used to get and set Certification Authority (CA) information, read and write DCAS data. | See clause K.2.2 | +| CADescriptor | Interface | It provides CA descriptor information, and may provide CA descriptor in the PMT with given service. Besides, CA descriptor may appear in CAT. | See clause K.2.3 | +| CASServiceComponentInfo | Interface | It is used to extract the information of specific CA service component, such as entitlement control message (ECM) packet identifier (PID) and DescramblerContext used to load control word. | See clause K.2.4 | +| CASPacketListener | Interface | DCAS application receives out-of-band CAS Packets through this interface (such as EMMs). | See clause K.2.5 | +| CASSession | Interface | Provide the information about CAS session. | See clause K.2.6 | +| CASStatus | Interface | DCAS application sends CASStatus whenever descrambler status in DescramblerContext changes, and this status is used to prompt whether descrambling succeeds. If any descrambling component fails, this status must report descrambling request failure of the whole service. When the terminal software platform receives a new CATStatus, it should inform other applications through CAS event described here. | See clause K.2.7 | +| CATListener | Interface | DCAS application needs to implement the interface and uses CA descriptor in CAT to filter in-band entitlement management message (EMM). | See clause K.2.8 | +| CATNotifier | Interface | DCAS application uses this method to register a listener used to get CAT update notice. | See clause K.2.9 | +| CASModuleManager | Class | Used to register all CASModule implemented by DCAS application. | See clause K.2.10 | + +**Table 21 – Overview of the CAS descrambler module** + +| Object name | Type | Description | Remarks | +|---------------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| CASPermission | Class | Any DCAS application cannot access CASModuleManager until it gets CASPermission. This mechanism is used to ensure only DCAS application authorized by the network operator can use DCAS API. | See clause K.2.11 | + +#### 6.2.12.3 CAS control module + +The CAS control module provides application programming interface for DCAS terminal software platform to control CAS. + +See Table 22 for an overview of the CAS control module. + +**Table 22 – Overview of the CAS control module** + +| Object name | Type | Description | Remarks | +|--------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| DescramblerContext | Interface | It is a component used to control the descrambling function of terminal security chip. It can instantiate multiple DescramblerContext to descramble multiple code streams with different keys. | See clause K.3.1 | +| ChipController | Interface | It is a component used to control the execution of terminal security chip. | See clause K.3.2 | +| Key | Class | An elementary cipher key. | See clause K.3.3 | +| CWKey | Class | Descramble cipher or control word. | See clause K.3.4 | +| CASTEEManager | Class | Function interface with trusted application (TA) communication in trusted execution environment (TEE). | See clause K.3.5 | + +#### 6.2.12.4 CAS message module + +The CAS message module provides the function interface for DCAS message monitoring. + +See Table 23 for an overview of the CAS message module. + +**Table 23 – Overview of the CAS message module** + +| Object name | Type | Description | Remarks | +|------------------|-----------|-----------------------------------------------------------------------------|------------------| +| CASEventListener | Interface | It is used to implement the application of CAS event receiving. | See clause K.4.1 | +| CASAppInfo | Interface | Provide DCAS application information. | See clause K.4.2 | +| CASEventInfo | Interface | Provide CASEvent information. | See clause K.4.3 | +| CASEventManager | Class | The application uses CASEventManager to register listener to get CAS event. | See clause K.4.4 | + +#### 6.2.12.5 CAS listener module + +The CAS listener module provides application programming interface for DCAS detachable security device to monitor CAS. + +See Table 24 for an overview of the CAS listener module. + +**Table 24 – Overview of the CAS listener module** + +| Object name | Type | Description | Remarks | +|----------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------|------------------| +| DetachabeSecurityDevice | Interface | It is used by the application to register the listener of detachable security device so as to get device plug/unplug status. | See clause K.5.1 | +| DetachabeSecurityDevice Listener | Interface | Detachabe security device listener, it is used by the application to monitor device plug/unplug status. | See clause K.5.2 | + +## 6.3 TVOS WEB application programming interface + +### 6.3.1 Overview of the TVOS WEB application programming interface + +TVOS WEB application programming interface implements JavaScript (JS) packaging for each function component module interface in the component layer, provides invocation interface for WEB application in the form of JS object and supports the application to implement relevant digital television service functions such as electronic program guide, channel list and TV program playing. WEB application programming interface consists of 14 function units, including one-way broadcast network access unit, broadcast protocol processing unit, two-way broadband network access unit, human-machine interaction unit, AV setting unit, media processing unit, application management unit, system management unit, message management unit, application engine unit, broadcast message service management unit, multi-screen interaction unit, DRM management unit and DCAS management unit. + +The definition of TVOS WEB application programming interface conforms to the requirements of ECMA-262. + +### 6.3.2 One-way broadcast network access unit + +#### 6.3.2.1 Overview of the one-way broadcast network access unit + +The one-way broadcast network access unit is used to implement one-way broadcast network access function under digital television, including parameter control (tuning frequency, modulation mode and symbol rate), and acquisition of signal intensity, quality and other information. It defines the tuning and demodulation module. Refer to Annex L for the detailed definition of the JS interface. + +#### 6.3.2.2 Tuning and demodulation module + +See Table 25 for an overview of the tuning and demodulation module. + +**Table 25 – Overview of the tuning and demodulation module** + +| Object | Description | Remarks | +|----------------------|--------------------------------------------------|------------------| +| DvbcTuningParameters | DVB-C tuning and demodulation parameter object. | See clause L.2.3 | +| AbssTuningParameters | ABS-SS tuning and demodulation parameter object. | See clause L.2.4 | +| DtmbTuningParameters | DTMB tuning and demodulation parameter object. | See clause L.2.5 | +| DvbTune | Channel tuning and demodulation object. | See clause L.2.6 | +| DvbTunerInfo | Tunerid and Tuner type matching object. | See clause L.2.7 | +| DvbScan | Channel scanning object. | See clause L.2.8 | + +### 6.3.3 Broadcast protocol processing unit + +#### 6.3.3.1 Overview of the broadcast protocol processing unit + +The broadcast protocol processing unit is used to implement broadcast protocol processing, and It defines the DVB protocol processing module. Refer to Annex M for the detailed definition of the JS interface. + +#### 6.3.3.2 DVB protocol processing module + +See Table 26 for an overview of the DVB protocol processing module. + +**Table 26 – Overview of the DVB protocol processing module** + +| Object | Description | Remarks | +|--------------|------------------------------------------|-------------------| +| DvbBroadcast | DVB broadcast channel object. | See clause M.2.3 | +| DvbNetwork | DVB network object. | See clause M.2.4 | +| DvbBouquet | DVB bouquet object. | See clause M.2.5 | +| DvbTS | DVB transport stream object. | See clause M.2.6 | +| DvbService | DVB service object. | See clause M.2.7 | +| DvbVideoES | DVB video ES object. | See clause M.2.8 | +| DvbAudioES | DVB audio ES object. | See clause M.2.9 | +| DvbOtherES | Other ES objects except audio and video. | See clause M.2.10 | +| DvbEvent | DVB program event object. | See clause M.2.11 | + +### 6.3.4 Two-way broadband network access unit + +#### 6.3.4.1 Overview of the two-way broadband network access unit + +The two-way broadband network access unit is used to implement the functions related to two-way broadband network access control, including two-way network access management and data operation, etc., and it defines the two-way broadband network setting module. Refer to Annex N for the detailed definition of the JS interface. + +#### 6.3.4.2 Two-way broadband network setting module + +See Table 27 for an overview of the two-way broadband network setting module. + +**Table 27 – Overview of the two-way broadband network setting module** + +| Object | Description | Remarks | +|-----------|-----------------------------------|------------------| +| Broadband | Two-way broadband network object. | See clause N.2.2 | +| Ethernet | Ethernet card object. | See clause N.2.3 | +| AP | Wireless access point object. | See clause N.2.4 | +| IP | IP object. | See clause N.2.5 | +| Proxy | Network proxy object. | See clause N.2.6 | + +### 6.3.5 Human-machine interaction unit + +#### 6.3.5.1 Overview of the human-machine interaction unit + +The human-machine interaction unit is used to implement the functions of device input control and front panel display control. The input packages user command sent by input devices such as remote controller, mouse, keyboard and front panel key as key message, and the output feeds information + +back through front panel or display screen. It defines the user input unit module and front panel output module. Refer to Annex O for the detailed definition of the JS interface. + +#### 6.3.5.2 User input unit module + +See Table 28 for an overview of the user input unit module. + +**Table 28 – Overview of the user input unit module** + +| Object | Description | Remarks | +|--------|---------------------------------------|------------------| +| event | User input message management object. | See clause O.2.2 | + +#### 6.3.5.3 Front panel output module + +See Table 29 for an overview of the front panel output module. + +**Table 29 – Overview of the front panel output module** + +| Object | Description | Remarks | +|------------|---------------------|------------------| +| FrontPanel | Front panel object. | See clause O.3.1 | + +### 6.3.6 AV setting unit + +#### 6.3.6.1 Overview of the AV setting unit + +The AV setting unit is used to implement the functions of getting and setting audio video parameters, including audio output port status, track type, global volume and volume status, etc., as well as video output port status, window matching module, brightness, contrast ratio, saturation, system and transparency, etc. It defines the audio video parameter setting module. Refer to Annex P for the detailed definition of the JS interface. + +#### 6.3.6.2 Audio video parameter setting module + +See Table 30 for an overview of the audio video parameter setting module. + +**Table 30 – Overview of the audio video parameter setting module** + +| Object | Description | Remarks | +|--------------|---------------------------------|------------------| +| AudioSetting | Audio parameter setting object. | See clause P.2.1 | +| VideoSetting | Video parameter setting object. | See clause P.2.2 | + +### 6.3.7 Media processing unit + +#### 6.3.7.1 Overview of the media processing unit + +The media processing unit is used to implement media player function, including playing, control, event handling and exception handling, etc. It defines the media processing module. Refer to Annex Q for the detailed definition of the JS interface. + +#### 6.3.7.2 Media processing module + +See Table 31 for an overview of the media processing module. + +**Table 31 – Overview of the media processing module** + +| Object | Description | Remarks | +|-------------|----------------------|------------------| +| MediaPlayer | Media player object. | See clause Q.2.2 | + +### 6.3.8 Application management unit + +#### 6.3.8.1 Overview of the application management unit + +The application management unit is used to implement WEB application management function, including application query, application installation, application unloading, and application update, etc., and it defines the application management module. Refer to Annex R for the detailed definition of the JS interface. + +#### 6.3.8.2 Application management module + +See Table 32 for an overview of the application management module. + +**Table 32 – Overview of the application management module** + +| Object | Description | Remarks | +|--------|--------------------------------|------------------| +| widget | Application management object. | See clause R.2.2 | + +### 6.3.9 System management unit + +#### 6.3.9.1 Overview of the system management unit + +The system management unit is used to implement peripheral device management, OTA upgrade management, storage management and other system-related functions. It defines the data management module, external storage device management module, file management module, multimedia file management module, OTA software upgrade module, system tool module and software & hardware information module. Refer to Annex S for the detailed definition of the JS interface. + +#### 6.3.9.2 Data management module + +See Table 33 for an overview of the data management module. + +**Table 33 – Overview of the data management module** + +| Object | Description | Remarks | +|------------|---------------------------------------|------------------| +| DataConfig | Configuration data management object. | See clause S.2.2 | + +#### 6.3.9.3 External storage device management module + +See Table 34 for an overview of the external storage device management module. + +**Table 34 – Overview of the external storage device management module** + +| Object | Description | Remarks | +|----------------------|-----------------------------------------|------------------| +| StorageDeviceManager | External storage device manager object. | See clause S.3.2 | +| StorageDevice | External storage device object. | See clause S.3.3 | +| StoragePartition | External storage partition object. | See clause S.3.4 | + +#### 6.3.9.4 File management module + +See Table 35 for an overview of the file management module. + +**Table 35 – Overview of the file management module** + +| Object | Description | Remarks | +|---------------|---------------------------------------|------------------| +| FileManager | Directory and file management object. | See clause S.4.2 | +| Directory | Directory object. | See clause S.4.3 | +| File | File object | See clause S.4.4 | + +#### **6.3.9.5 Multimedia file module** + +See Table 36 for an overview of the multimedia file module. + +**Table 36 – Overview of the multimedia file module** + +| Object | Description | Remarks | +|---------------|--------------------|------------------| +| AudioFile | Audio file object. | See clause S.5.1 | +| VideoFile | Video file object. | See clause S.5.2 | +| ImageFile | Image file object. | See clause S.5.3 | + +#### **6.3.9.6 OTA software upgrade module** + +See Table 37 for an overview of the OTA software upgrade module. + +**Table 37 – Overview of the OTA software upgrade module** + +| Object | Description | Remarks | +|---------------|-----------------------------|------------------| +| Upgrade | OTA upgrade control object. | See clause S.6.2 | + +#### **6.3.9.7 System tool module** + +See Table 38 for an overview of the system tool module. + +**Table 38 – Overview of the system tool module** + +| Object | Description | Remarks | +|------------------|--------------------------------------------------------------------------------------------|------------------| +| Utility | Tool object used to complete event message acquisition and character string printing, etc. | See clause S.7.1 | +| GlobalVarManager | Global variable manager object. | See clause S.7.2 | +| Rectangle | Rectangular window object. | See clause S.7.3 | +| SysTool | System tool object. | See clause S.7.4 | + +#### **6.3.9.8 Software and hardware information module** + +See Table 39 for an overview of the software and hardware information module. + +**Table 39 – Overview of the software and hardware information module** + +| Object | Description | Remarks | +|---------------|--------------------------------------------------------------|------------------| +| HardwareInfo | Hardware parameter information object of receiving terminal. | See clause S.8.1 | +| SoftwareInfo | Software parameter information object of receiving terminal. | See clause S.8.2 | + +### 6.3.10 Message management unit + +#### 6.3.10.1 Overview of the message management unit + +The message management unit is used to implement the functions of receiving and managing messages, including key message and system message. This unit defines the message management module. Refer to Annex T for the detailed definition of the JS interface. + +#### 6.3.10.2 Message management module + +See Table 40 for an overview of the message management module. + +**Table 40 – Overview of the message management module** + +| Object | Description | Remarks | +|--------|-----------------|------------------| +| event | Message object. | See clause T.2.1 | + +### 6.3.11 Application engine unit + +#### 6.3.11.1 Overview of the application engine unit + +The application engine unit is used to implement the functions of channel management, electronic program guide acquisition, order reminder management and information search. It defines the electronic program guide module, channel management module, order reminder module and information search module. Refer to Annex U for the detailed definition of the JS interface. + +#### 6.3.11.2 Channel management module + +See Table 41 for an overview of the channel management module. + +**Table 41 – Overview of the channel management module** + +| Object | Description | Remarks | +|----------------|-------------------------|------------------| +| ChannelManager | Channel manager object. | See clause U.2.2 | +| Channel | Channel object. | See clause U.2.3 | + +#### 6.3.11.3 Electronic program guide module + +See Table 42 for an overview of the electronic program guide module. + +**Table 42 – Overview of the electronic program guide module** + +| Object | Description | Remarks | +|----------------|----------------------------------|------------------| +| EPGManager | EPG manager object. | See clause U.3.2 | +| ProgramEvent | Program event object. | See clause U.3.3 | +| ReferenceEvent | Reference program event object. | See clause U.3.4 | +| TimeShiftEvent | Time shift program event object. | See clause U.3.5 | + +#### 6.3.11.4 Order reminder module + +See Table 43 for an overview of the order reminder module. + +**Table 43 – Overview of the order reminder module** + +| Object | Description | Remarks | +|---------------|-----------------------|------------------| +| OrderManager | Order manager object. | See clause U.4.2 | +| Order | Order object. | See clause U.4.3 | + +#### **6.3.11.5 Information search module** + +See Table 44 for an overview of the information search module. + +**Table 44 – Overview of the information search module** + +| Object | Description | Remarks | +|---------------------------|--------------------------------------|------------------| +| SearchManager | Search manager object. | See clause U.5.2 | +| GlobalSearchSession | Global search session object. | See clause U.5.3 | +| AutoCompleteSearchSession | Auto complete search session object. | See clause U.5.4 | +| GlobalSearchFilter | Global search filter object. | See clause U.5.5 | +| AutoCompleteSearchFilter | Auto complete search filter object. | See clause U.5.6 | +| SortCritiria | Sorting mechanism object. | See clause U.5.7 | +| GlobalSearchResultItem | Search result item object. | See clause U.5.8 | +| SearchHistoryItem | Search history item object. | See clause U.5.9 | + +### **6.3.12 Broadcast message service management unit** + +#### **6.3.12.1 Overview of the broadcast message service management unit** + +The broadcast message service management unit is used to detect, receive and process broadcast message services, and supports the services of emergency broadcasting, message service, advertisement and on-screen display (OSD) text update, etc. Refer to Annex V for the detailed definition of the JS interface. + +#### **6.3.12.2 Broadcast message service management unit** + +The broadcast message service management module implements the functions of monitoring BAT table and NIT table, and filtering Section data of broadcast message service. Meanwhile, it gets CA user ID corresponding to the terminal through DCAS management unit interface. On this basis, it implements accurate reception of terminal emergency broadcasting and advertisement, etc. + +See Table 45 for an overview of the broadcast message service management module. + +**Table 45 – Overview of the broadcast message service management module** + +| Object | Description | Remarks | +|---------------|-------------------------------------------|------------------| +| DthManager | Broadcast message service manager object. | See clause V.2.2 | +| Ad | Advertisement object. | See clause V.2.3 | +| AdService | Advertisement service object. | See clause V.2.4 | + +### **6.3.13 Multi-screen interaction unit** + +#### **6.3.13.1 Overview of the multi-screen interaction unit** + +The multi-screen interaction unit is used to implement multi-screen interaction LAN interface, and it defines the multi-screen interaction module. Refer to Annex W for the detailed definition of the JS interface. + +#### 6.3.13.2 Multi-screen interaction module + +See Table 46 for an overview of the multi-screen interaction module. + +**Table 46 – Overview of the multi-screen interaction module** + +| Object | Description | Remarks | +|-------------|------------------------------------------|------------------| +| MultiScreen | Multi-screen interaction control object. | See clause W.2.1 | + +### 6.3.14 DRM management unit + +#### 6.3.14.1 Overview of the DRM management unit + +The DRM management unit is used to implement DRM management function, and it defines the DRM management module. Refer to Annex X for the detailed definition of the JS interface. + +#### 6.3.14.2 DRM management module + +See Table 47 for an overview of the DRM management module. + +**Table 47 – Overview of the DRM management module** + +| Object | Description | Remarks | +|------------------|---------------------|------------------| +| CommonDrmManager | DRM manager object. | See clause X.2.1 | + +### 6.3.15 DCAS management unit + +#### 6.3.15.1 Overview of the DCAS management unit + +The DCAS management unit is used to implement registration, filter setting and TApp communication functions related to DCAS application, and it defines the EPG\_DCAS module and DCAS\_APP module. Refer to Annex Y for the detailed definition of the JS interface based on [b-ITU-T J.1033]. + +#### 6.3.15.2 EPG\_DCAS module + +See Table 48 for an overview of the EPG\_DCAS module. + +**Table 48 – Overview of the EPG\_DCAS module** + +| Object | Description | Remarks | +|----------|-----------------------------|------------------| +| EPG_DCAS | DCAS message return object. | See clause Y.2.1 | + +#### 6.3.15.3 DCAS\_APP module + +See Table 49 for an overview of the DCAS\_APP module. + +**Table 49 – Overview of the DCAS\_APP module** + +| Object | Description | Remarks | +|----------------------|------------------------|------------------| +| JSDCAS.CASDescriptor | CAS descriptor object. | See clause Y.3.2 | +| JSDCAS.CASEcmEvent | Ecm message object. | See clause Y.3.3 | +| JSDCAS.CASEmmEvent | Emm message object. | See clause Y.3.4 | +| JSDCAS.CASFilter | CAS filter object. | See clause Y.3.5 | +| JSDCAS.CASM | CAS global object. | See clause Y.3.6 | + +**Table 49 – Overview of the DCAS\_APP module** + +| Object | Description | Remarks | +|-------------------------|------------------------------------------------|-------------------| +| JSDCAS.CASModule | CAS module object. | See clause Y.3.7 | +| JSDCAS.CASModuleManager | CAS module manager object. | See clause Y.3.8 | +| JSDCAS.CASPacketEvent | CAS data packet object. | See clause Y.3.9 | +| JSDCAS.CASSession | CAS descrambler request object. | See clause Y.3.10 | +| JSDCAS.CASStatus | CAS status message object. | See clause Y.3.11 | +| JSDCAS.TeeController | CAS and TEE communication controller object. | See clause Y.3.12 | +| JSDCAS.TeeRetVal | CAS and TEE communication return value object. | See clause Y.3.13 | + +# 7 Invocation mechanism + +The TVOS application framework layer consists of a JAVA application framework and a WEB application framework which respectively form application programming interfaces for JAVA application and WEB application at the application layer to be invoked so that these applications can complete their respective functions. + +The invocation model of the TVOS application programming interface is shown in Figure 1. + + + +Figure 1: Invocation model of TVOS application programming interface. The diagram shows three horizontal layers. The top layer is labeled 'Application layer' and contains two rounded rectangles: 'JAVA application' and 'WEB application'. Above these is a list of application types: 'DTV/OTT/payment /game/e-commerce/smart home/...'. The middle layer is a single row labeled 'Application programming interface'. The bottom layer is labeled 'Application framework' and contains two rounded rectangles: 'JAVA application framework' and 'WEB application framework'. A small label 'J.1206(24)' is at the bottom right. + +**Figure 1 – Invocation model of TVOS application programming interface** + +JAVA application uses TVOS JAVA application programming interface to implement corresponding functions through introducing Jar packet containing TVOS JAVA application programming interface in the development process. + +WEB application implements corresponding functions through introducing all kinds of built-in JavaScript objects provided by TVOS WEB application programming interface in the development process. + +# Annex A + +## JAVA-unidirectional broadcast network access unit + +(This annex forms an integral part of this Recommendation.) + +## A.1 Overview + +This annex defines the JAVA interface of the unidirectional broadcast network access unit, which is mainly the tuning and demodulation module, realizing the function of tuning and demodulation. + +## A.2 Tuning and demodulation module + +The tuning and demodulation module defines interfaces, classes and exceptions related to tuning and demodulation. + +See Table A.1 for the summary of tuning and demodulation module. + +**Table A.1 – Summary of the tuning and demodulation module** + +| Interface | | +|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DeliverySystemType | Definitions of constants of the delivery system type under the DVB technology system. | +| TuningParameters | Tuning and demodulation parameter interface. | +| TuningListener | The network interface event listener interface, providing a callback method for handling network interface related events, which is implemented by the application layer. | +| Classes | | +| DvbcTuningParameters | A tuning and demodulation parameter class applicable to the DVB-C delivery system. | +| AbsssTuningParameters | A tuning and demodulation parameter class applicable to the ABS-SS delivery system. | +| DtmbTuningParameters | A tuning and demodulation parameter class applicable to the DTMB delivery system. | +| TunerEvent | A class of tuner and demodulator events, which is a base class of network interface related events. | +| TunerTuningEvent | An event that the network interface starts tuning, inheriting the TunerEvent class. | +| TunerTuningOverEvent | An event that the tuning ends, inheriting the TunerEvent class. | +| Tuner | Tuning and demodulation control interface. | +| TunerManager | The tuning and demodulation manager class, which is used to track the broadcast network interface connected to the receiving device. It is the entry class of the tuning and demodulation unit. | +| Exceptions | | +| TunerException | Network interface exception, a base class of other network exceptions. | +| IncorrectLocatorException | An exception where the format of the locator is incorrect. It inherits the TunerException class. | +| StreamNotFoundException | No exception is found in the stream. It inherits the TunerException class. This exception is thrown when reference to the transport stream cannot be resolved. | + +**Table A.1 – Summary of the tuning and demodulation module** + +| | | +|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| TuningParameterNotFoundException | This exception is thrown when failed to obtain the current tuning and demodulation parameters or when the DeliverySystemType is wrong. | +|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| + +#### **A.2.1 Interface org.ngb.broadcast.dvb.tuner.DeliverySystemType** + +Prototype: public interface org.ngb.broadcast.dvb.tuner.DeliverySystemType + +Description: Definition of constants of the delivery system type under the DVB technology system, including the definitions of constants of the following three types of delivery systems: DVB-C, DTMB and ABS-SS. + +##### **A.2.1.1 Constant field – delivery system type** + +###### **A.2.1.1.1 SATELLITE\_DELIVERY\_SYSTEM** + +Prototype: public final static int SATELLITE\_DELIVERY\_SYSTEM = 0 + +Description: delivery system type – ABS-SS. + +###### **A.2.1.1.2 CABLE\_DELIVERY\_SYSTEM** + +Prototype: public final static int CABLE\_DELIVERY\_SYSTEM = 1 + +Description: delivery system type – DVB-C. + +###### **A.2.1.1.3 TERRESTRIAL\_DELIVERY\_SYSTEM** + +Prototype: public final static int TERRESTRIAL\_DELIVERY\_SYSTEM = 2 + +Description: delivery system type – DTMB (National Standard Terrestrial Digital TV). + +###### **A.2.1.1.4 UNKNOWN\_DELIVERY\_SYSTEM** + +Prototype: public final static int UNKNOWN\_DELIVERY\_SYSTEM = 0xFF + +Description: Unknown error type. + +#### **A.2.2 Interface org.ngb.broadcast.dvb.tuner.TuningParameters** + +Prototype: public interface org.ngb.broadcast.dvb.tuner.TuningParameters + +Description: Tuning and demodulation parameter interface. + +##### **A.2.2.1 Method** + +###### **A.2.2.1.1 getDeliverySystemType** + +Prototype: public int getDeliverySystemType() + +Description: Getting the applicable delivery system type suitable for tuning and demodulation parameters. + +Parameter: None. + +Return: Int type, indicating the delivery system type. For the value, please refer to the org.ngb.broadcast.dvb.tuner.DeliverySystemType interface and the "delivery system type" constant field definition. + +#### **A.2.3 Interface org.ngb.broadcast.dvb.tuner.TuningListener** + +Prototype: public interface org.ngb.broadcast.dvb.tuner.TuningListener + +Description: Network interface event listener interface, providing a callback method for handling network interface related events, which is implemented by the application layer. + +##### **A.2.3.1 Method** + +##### **A.2.3.1.1 receiveNIEvent** + +Prototype: public abstract void receiveNIEvent (org.ngb.broadcast.dvb.tuner.TunerEvent anEvent) + +Description: Network interface event callback method. + +Parameter: anEvent – An org.ngb.broadcast.dvb.tuner. A TunerEvent object, indicating a network interface event. + +Return: None. + +#### **A.2.4 Class org.ngb.broadcast.dvb.tuner.DvbcTuningParameters** + +Prototype: public class org.ngb.broadcast.dvb.tuner.DvbcTuningParameters implements org.ngb.broadcast.dvb.tuner.TuningParameters + +Description: Tuning and demodulation parameters type, applicable to the DVB-C delivery system. For getDeliverySystemType(), the return value of the method is fixed to DeliverySystemType.CABLE\_DELIVERY\_SYSTEM. + +##### **A.2.4.1 Constant field – modulation method** + +###### **A.2.4.1.1 DVB\_C\_MOD\_UNDEFINED** + +Prototype: public static final int DVB\_C\_MOD\_UNDEFINED = 0 + +Description: DVB-C modulation method – undefined. + +###### **A.2.4.1.2 DVB\_C\_MOD\_QAM16** + +Prototype: public static final int DVB\_C\_MOD\_QAM16 = 1 + +Description: DVB-C modulation method – 16-QAM. + +###### **A.2.4.1.3 DVB\_C\_MOD\_QAM32** + +Prototype: public static final int DVB\_C\_MOD\_QAM32 = 2 + +Description: DVB-C modulation method – 32-QAM. + +###### **A.2.4.1.4 DVB\_C\_MOD\_QAM64** + +Prototype: public static final int DVB\_C\_MOD\_QAM64 = 3 + +Description: DVB-C modulation method – 64-QAM. + +###### **A.2.4.1.5 DVB\_C\_MOD\_QAM128** + +Prototype: public static final int DVB\_C\_MOD\_QAM128 = 4 + +Description: DVB-C modulation method – 128-QAM. + +###### **A.2.4.1.6 DVB\_C\_MOD\_QAM256** + +Prototype: public static final int DVB\_C\_MOD\_QAM256 = 5 + +Description: DVB-C modulation method – 256-QAM. + +##### **A.2.4.2 Method** + +###### **A.2.4.2.1 DvbcTuningParameters** + +Prototype: public DvbcTuningParameters() + +Description: A construction method, creating a default DVB-C tuning and demodulation parameter object. + +Parameter: None. + +###### **A.2.4.2.2 DvbcTuningParameters** + +Prototype: public DvbcTuningParameters(int frequency, int modulation, int symbolRate) + +Description: A construction method, creating a DVB-C tuning and demodulation parameter object according to the input parameters. + +Parameter: frequency – Int type, indicating the center frequency of DVB-C signal, in kHz; + +modulation – Int type, indicating the DVB-C signal modulation method. For the value, please refer to the "modulation method" constant field definition of the org.ngb.broadcast.dvb.tuner.DvbcTuningParameters class; + +symbolRate – Int type, indicating the symbol rate of the DVB-C signal, in ksymbols/s. + +###### **A.2.4.2.3 setFrequency** + +Prototype: public void setFrequency(int frequency) + +Description: Setting the DVB-C signal tuning frequency. + +Parameter: frequency – Int type, indicating the center frequency of the DVB-C signal, in kHz. + +Return: None. + +###### **A.2.4.2.4 getFrequency** + +Prototype: public int getFrequency() + +Description: Getting DVB-C signal tuning frequency. + +Parameter: None. + +Return: Int type, indicating the tuning frequency of the DVB-C signal, in kHz. + +###### **A.2.4.2.5 setModulation** + +Prototype: public void setModulation(int modulation) + +Description: Setting the modulation method. + +Parameter: Int type, indicating DVB-C signal modulation method. For the value, please refer to the "modulation method" constant field definition of the org.ngb.broadcast.dvb.tuner.DvbcTuningParameters class. + +Return: None. + +##### **A.2.4.2.6 getModulation** + +Prototype: public int getModulation() + +Description: Getting the modulation method. + +Parameter: None. + +Return: Int type, indicating DVB-C signal modulation method. For the value, please refer to the "modulation method" constant field definition of the org.ngb.broadcast.dvb.tuner.DvbcTuningParameters class. + +##### **A.2.4.2.7 setSymbolRate** + +Prototype: public void setSymbolRate(int symbolRate) + +Description: Setting the symbol rate of the DVB-C signal. + +Parameter: symbolRate – Int type, indicating the symbol rate of the DVB-C signal, in ksymbols/s. + +Return: None. + +##### **A.2.4.2.8 getSymbolRate** + +Prototype: public int getSymbolRate() + +Description: Getting DVB-C signal symbol rate. + +Parameter: None. + +Return: Int type, indicating the symbol rate of the DVB-C signal, in ksymbol/s. + +#### **A.2.5 Class org.ngb.broadcast.dvb.tuner.AbsssTuningParameters** + +Prototype: public class org.ngb.broadcast.dvb.tuner.AbsssTuningParameters implements org.ngb.broadcast.dvb.tuner.TuningParameters + +Description: Tuning parameter class, applicable to the ABS-SS delivery system. + +For getDeliverySystemType(), the method return value is fixed to SATELLITE\_DELIVERY\_SYSTEM. + +##### **A.2.5.1 Constant field – polarization method** + +###### **A.2.5.1.1 ABS\_SS\_POLAR\_LINEAR\_H** + +Prototype: public static final int ABS\_SS\_POLAR\_LINEAR\_H = 0 + +Description: ABS-SS polarization method – horizontal line polarization. + +###### **A.2.5.1.2 ABS\_SS\_POLAR\_LINEAR\_V** + +Prototype: public static final int ABS\_SS\_POLAR\_LINEAR\_V = 1 + +Description: ABS-SS polarization method – vertical line polarization. + +##### **A.2.5.1.3 ABS\_SS\_POLAR\_CIRCULAR\_L** + +Prototype: public static final int ABS\_SS\_POLAR\_CIRCULAR\_L = 2 + +Description: ABS-SS polarization method – Left-hand circular polarization. + +###### **A.2.5.1.4 ABS\_SS\_POLAR\_CIRCULAR\_R** + +Prototype: public static final int ABS\_SS\_POLAR\_CIRCULAR\_R = 3 + +Description: ABS-SS polarization method – Right-hand circular polarization. + +##### **A.2.5.2 Method** + +###### **A.2.5.2.1 AbsssTuningParameters** + +Prototype: public AbsssTuningParameters() + +Description: A construction method, creating a default ABS-SS tuning and demodulation parameter object. + +Parameter: None. + +###### **A.2.5.2.2 AbsssTuningParameters** + +Prototype: public AbsssTuningParameters(int frequency, int symbolRate, int polarization) + +Description: A construction method, creating an ABS-SS tuning and demodulation parameter object according to the input parameters. + +Parameter: frequency – Int type, indicating the center frequency of the ABS-SS signal, in MHz; +symbolRate – Int type, indicating the symbol rate of ABS-SS signal, in ksymbol/s; + +polarization – Int type, indicating the polarization method of the ABS-SS signal. + +###### **A.2.5.2.3 setFrequency** + +Prototype: public void setFrequency(int freq) + +Description: Setting the center frequency of the ABS-SS signal. + +Parameter: freq – Int type, indicating the center frequency of the ABS-SS signal, in MHz. + +Return: None. + +###### **A.2.5.2.4 getFrequency** + +Prototype: public int getFrequency() + +Description: Getting the center frequency of the ABS-SS signal. + +Parameter: None. + +Return: Int type, indicating the center frequency of the ABS-SS signal, in MHz. + +###### **A.2.5.2.5 setPolarization** + +Prototype: public void setPolarization (int polarization) + +Description: Setting the polarization method. + +Parameter: polarization – Int type, indicating the polarization method of the ABS-SS signal. + +Return: None. + +###### **A.2.5.2.6 getPolarization** + +Prototype: public int getPolarization() + +Description: Getting ABS-SS signal polarization method. + +Parameter: None. + +Return: Int type, indicating the polarization method of the ABS-SS signal. + +##### **A.2.5.2.7 setSymbolRate** + +Prototype: public void setSymbolRate(int symbolRate) + +Description: Setting the symbol rate of the ABS-SS signal. + +Parameter: Int type, indicating the symbol rate of the ABS-SS signal, in ksymbol/s. + +Return: None. + +###### **A.2.5.2.8 getSymbolRate** + +Prototype: public int getSymbolRate() + +Description: Getting the symbol rate of the ABS-SS signal. + +Parameter: None. + +Return: Int type, indicating the symbol rate of the ABS-SS signal, in ksymbol/s. + +#### **A.2.6 Class org.ngb.broadcast.dvb.tuner.DtmbTuningParameters** + +Prototype: public class org.ngb.broadcast.dvb.tuner.DtmbTuningParameters implements org.ngb.broadcast.dvb.tuner.TuningParameters + +Description: Tuning and demodulation parameter class, applicable to the DTMB delivery system. For getDeliverySystemType(), the method return value is fixed to TERRESTRIAL\_DELIVERY\_SYSTEM. + +##### **A.2.6.1 Constant field – demodulation method** + +###### **A.2.6.1.1 DTMB\_MOD\_UNDEFINED** + +Prototype: public static final int DTMB\_MOD\_UNDEFINED = 0 + +Description: DTMB demodulation method – undefined. + +###### **A.2.6.1.2 DTMB\_MOD\_QAM4** + +Prototype: public static final int DTMB\_MOD\_QAM4 = 1 + +Description: DTMB demodulation method – 4-QAM. + +###### **A.2.6.1.3 DTMB\_MOD\_QAM4\_NR** + +Prototype: public static final int DTMB\_MOD\_QAM4\_NR = 2 + +Description: DTMB demodulation method – 4-QAM-NR. + +##### **A.2.6.1.4 DTMB\_MOD\_QAM16** + +Prototype: public static final int DTMB\_MOD\_QAM16 = 3 + +Description: DTMB demodulation method – 16-QAM. + +###### **A.2.6.1.5 DTMB\_MOD\_QAM32** + +Prototype: public static final int DTMB\_MOD\_QAM32 = 4 + +Description: DTMB demodulation method – 32-QAM. + +###### **A.2.6.1.6 DTMB\_MOD\_QAM64** + +Prototype: public static final int DTMB\_MOD\_QAM64 = 5 + +Description: DTMB demodulation method – 64-QAM. + +###### **A.2.6.1.7 DTMB\_MOD\_QAM128** + +Prototype: public static final int DTMB\_MOD\_QAM128 = 6 + +Description: DTMB demodulation method – 128-QAM. + +##### **A.2.6.1.8 DTMB\_MOD\_QAM256** + +Prototype: public static final int DTMB\_MOD\_QAM256 = 7 + +Description: DTMB demodulation method – 256-QAM. + +###### **A.2.6.1.9 DTMB\_MOD\_QAM512** + +Prototype: public static final int DTMB\_MOD\_QAM512 = 8 + +Description: DTMB demodulation method – 512-QAM. + +##### **A.2.6.1.10 DTMB\_BANDWIDTH\_6M** + +Prototype: public static final int DTMB\_BANDWIDTH\_6M = 6000 + +Description: DTMB frequency bandwidth 6M. + +##### **A.2.6.1.11 DTMB\_BANDWIDTH\_7M** + +Prototype: public static final int DTMB\_BANDWIDTH\_7M = 7000 + +Description: DTMB frequency bandwidth 7M. + +###### **A.2.6.1.12 DTMB\_BANDWIDTH\_8M** + +Prototype: public static final int DTMB\_BANDWIDTH\_8M = 8000 + +Description: DTMB frequency bandwidth 8M. + +##### **A.2.6.2 Method** + +###### **A.2.6.2.1 DtmbTuningParameters** + +Prototype: public DtmbTuningParameters() + +Description: A construction method, creating a default DTMB tuning and demodulation parameter object. + +Parameter: None. + +###### **A.2.6.2.2 DtmbTuningParameters** + +Prototype: public DtmbTuningParameters(int frequency, int modulation) + +Description: A construction method, creating a DTMB tuning and demodulation parameter object based on the input parameters. + +Parameter: frequency – Int type, indicating the center frequency of the DTMB signal, in kHz. + +modulation – Int type, indicating the modulation method of the DTMB signal. For the value, please refer to the constant field definition of the "modulation method" of the org.ngb.broadcast.dvb.tuner.DtmbTuningParameters class. + +###### **A.2.6.2.3 setFrequency** + +Prototype: public void setFrequency(int frequency) + +Description: Setting the center frequency of the DTMB signal. + +Parameter: frequency – Int type, indicating the center frequency of the DTMB signal, in kHz. + +Return: None. + +###### **A.2.6.2.4 setModulation** + +Prototype: public void setModulation (int modulation) + +Description: Setting the DTMB signal modulation method. + +Parameter: modulation – Int type, indicating the modulation method of the DTMB signal. For the value, please refer to the constant field definition of the "modulation method" of the org.ngb.broadcast.dvb.tuner.DtmbTuningParameters class. + +Return: None. + +##### **A.2.6.2.5 setBandWidth** + +Prototype: public void setBandWidth(int bandWidth) + +Description: Setting the DTMB frequency bandwidth. + +Parameter: bandWidth – Int type, indicating the DTMB frequency bandwidth. + +Return: None. + +##### **A.2.6.2.6 getFrequency** + +Prototype: public int getFrequency() + +Description: Getting the center frequency of the DTMB signal. + +Parameter: None. + +Return: Int type, indicating the center frequency of the DTMB signal, in kHz. + +##### **A.2.6.2.7 getModulation** + +Prototype: public int getModulation() + +Description: Getting the DTMB signal modulation method. After successful tuning and demodulation, call this method to return the modulation mode of the DTMB signal, otherwise the return value is meaningless. + +Parameter: None. + +Return: Int type, indicating the modulation method of the DTMB signal. For the value, please refer to the constant field definition of the "modulation method" of the org.ngb.broadcast.dvb.tuner.DtmbTuningParameters class. + +##### **A.2.6.2.8 getBandWidth** + +Prototype: public int getBandWidth() + +Description: Getting the DTMB frequency bandwidth. After successful tuning and demodulation, call this method to return the frequency bandwidth of the DTMB signal, otherwise the return value is meaningless. + +Parameter: None. + +Return: Int type, indicating the DTMB frequency bandwidth. + +##### **A.2.6.2.9 getCodingRatio** + +Prototype: public java.lang.String getCodingRatio() + +Description: Getting DTMB signal coding efficiency. After successful tuning and demodulation, call this method to return the coding efficiency of the DTMB signal, otherwise the return value is meaningless. + +Parameter: None. + +Return: A java.lang.String object, indicating the string description of the DTMB signal encoding efficiency, which can be "0.4", "0.6" or "0.8". + +##### **A.2.6.2.10 getPNMode** + +Prototype: public java.lang.String getPNMode() + +Description: Getting the DTMB signal frame header mode. After successful tuning and demodulation, call this method to return the frame header mode of the DTMB signal, otherwise the return value is meaningless. + +Parameter: None. + +Return: A java.lang.String object, indicating the DTMB signal frame header mode, such as "PN945". + +#### **A.2.7 Class org.ngb.broadcast.dvb.tuner.TunerEvent** + +Prototype: public abstract class org.ngb.broadcast.dvb.tuner.TunerEvent extends java.lang.Object + +Description: A tuner and demodulator event class, the base class of a group of network interface related events defined by this package. + +##### **A.2.7.1 Method** + +##### **A.2.7.1.1 TunerEvent** + +Prototype: public TunerEvent(java.lang.Object tuner) + +Description: Construction method. + +Parameter: tuner – A java.lang.Object object, indicating the tuner that issued this event. + +##### **A.2.7.1.2 getSource** + +Prototype: public java.lang.Object getSource() + +Description: Getting the object that generated the event. + +Parameter: None. + +Return: A java.lang.Object object, returning the object that generated the event. + +#### **A.2.8 Class org.ngb.broadcast.dvb.tuner.TunerTuningEvent** + +Prototype: public class org.ngb.broadcast.dvb.tuner.TunerTuningEvent extends org.ngb.broadcast.dvb.tuner.TunerEvent + +Description: An event that the network interface starts tuning, inheriting the org.ngb.broadcast.dvb.tuner.TunerEvent class. + +##### **A.2.8.1 Method** + +##### **A.2.8.1.1 TunerTuningEvent** + +Prototype: public TunerTuningEvent (Object tuner) + +Description: Construction method. + +Parameter: tuner – A java.lang.Object object, indicating the tuner object that starts tuning. + +#### **A.2.9 Class org.ngb.broadcast.dvb.tuner.TunerTuningOverEvent** + +Prototype: public class org.ngb.broadcast.dvb.tuner.TunerTuningOverEvent extends org.ngb.broadcast.dvb.tuner.TunerEvent + +Description: An event that the tuning ends, inheriting the org.ngb.broadcast.dvb.tuner.TunerEvent class. + +##### **A.2.9.1 Constant field – tuning result** + +###### **A.2.9.1.1 SUCCEEDED** + +Prototype: public final static int SUCCEEDED = 0 + +Description: The frequency lock is successful. + +##### **A.2.9.1.2 FAILED** + +Prototype: public final static int FAILED = 1 + +Description: The frequency lock fails. + +##### **A.2.9.2 Method** + +###### **A.2.9.2.1 TunerTuningOverEvent** + +Prototype: public TunerTuningOverEvent(java.lang.Object tuner, int status) + +Description: Construction method. + +Parameter: tuner – A java.lang.Object object, indicating the network interface that completes the tuning; + +status – Int type, indicating the status code that indicates whether the tuning action is successful. + +Return: None. + +###### **A.2.9.2.2 getStatus** + +Prototype: public int getStatus() + +Description: Getting the status code of the end of the tuning operation. + +Parameter: None. + +Return: Int type, indicating the status code of the end of the tuning. The value can be SUCCEEDED or FAILED. + +#### **A.2.10 Class org.ngb.broadcast.dvb.tuner.Tuner** + +Prototype: public class org.ngb.broadcast.dvb.tuner.Tuner + +Description: A tuning and demodulation controller class. + +##### **A.2.10.1 Method** + +###### **A.2.10.1.1 tune** + +Prototype: public void tune(org.ngb.broadcast.dvb.tuner.TuningParameters tuningParameters) throws java.lang.IllegalArgumentException, org.ngb.broadcast.dvb.tuner.TunerException + +Description: An asynchronous method, performing tuning and demodulation according to the specified tuning and demodulation parameters. + +- If an exception occurs, the state of the network interface will remain unchanged and no event will be generated; +- If no exception occurs, this method will send org.ngb.broadcast.dvb.tuner.TunerTuningEvent and org.ngb.broadcast.dvb.tuner.TunerTuningOverEvent events to the network interface event listener. + +Parameter: tuningParameters – An org.ngb.broadcast.dvb.tuner.TuningParameters object, indicating the tuning parameters. The method will further determine the type of the input parameter through the instanceof method. + +Return: None. + +Exception: java.lang.IllegalArgumentException – If the input tuning and demodulation parameters are invalid, this exception is thrown. + +org.ngb.broadcast.dvb.tuner.TunerException – If the tuning fails, this exception is thrown. + +##### **A.2.10.1.2 getSignalIntensity** + +Prototype: public int getSignalIntensity() + +Description: Getting the signal strength (signal level) of the current tuning frequency point. + +Parameter: None. + +Return: Int type, indicating the signal strength expressed as a percentage, the value range being 0-100, 0 indicating the signal strength is the weakest, and 100 indicating the signal strength is the strongest. + +##### **A.2.10.1.3 getSignalQuality** + +Prototype: public int getSignalQuality() + +Description: Getting the signal quality (signal-to-noise ratio) of the current tuning frequency point. + +Parameter: None. + +Return: Int type, indicating the signal quality expressed as a percentage, the value range being 0 to 100, 0 indicating the signal quality is the worst, and 100 indicating the signal quality is the best. + +##### **A.2.10.1.4 getCurrentTunningParam** + +Prototype: public org.ngb.broadcast.dvb.tuner.TuningParameters getCurrentTunningParam() +throws org.ngb.broadcast.dvb.tuner.TuningParameterNotFoundException + +Description: Getting the tuning parameters of the current tuning frequency point. + +Parameter: None. + +Return: Getting the tuning parameters of the current tuning frequency point. When it fails or org.ngb.broadcast.dvb.tuner.DeliverySystemType is wrong, an exception is thrown. After successful acquisition, you need to determine the specific type of the org.ngb.broadcast.dvb.tuner.TuningParameters instance. + +##### **A.2.10.1.5 addNetworkInterfaceListener** + +Prototype: public void addNetworkInterfaceListener(org.ngb.broadcast.dvb.tuner.TuningListener listener) + +Description: Register the network interface event listener. + +Parameter: listener – An org.ngb.broadcast.dvb.tuner.TuningListener object, indicating the network interface event listener to be registered. + +Return: None. + +###### **A.2.10.1.6 removeNetworkInterfaceListener** + +Prototype: public void removeNetworkInterfaceListener(org.ngb.broadcast.dvb.tuner.TuningListener listener) + +Description: Log off the network interface event listener. + +Parameter: listener – An org.ngb.broadcast.dvb.tuner.TuningListener object, indicating the network interface event listener to be registered. + +Return: None. + +##### **A.2.10.1.7 getCurrentTransportStream** + +Prototype: public org.davic.mpeg.TransportStream getCurrentTransportStream() + +Description: Getting the transport stream to which the current broadcast network interface is tuned. + +Parameter: None. + +Return: An org.davic.mpeg.TransportStream object, indicating the transport stream to which the current network interface is tuned. If the current network interface is not tuned to any transport stream, null is returned. + +###### **A.2.10.1.8 getDeliverySystemType** + +Prototype: public int getDeliverySystemType() + +Description: Getting the current broadcast network interface delivery type. + +Parameter: None. + +Return: Int type, indicating the delivery type of the current network interface. + +#### **A.2.11 Class org.ngb.broadcast.dvb.tuner.TunerManager** + +Prototype: public class org.ngb.broadcast.dvb.tuner.TunerManager + +Description: The modulation demodulation manager class is used to track the broadcast network interface connected to the receiving device, and is the entry class of the tuning and demodulation unit. + +##### **A.2.11.1 Method** + +###### **A.2.11.1.1 getInstance** + +Prototype: public static org.ngb.broadcast.dvb.tuner.TunerManager getInstance() + +Description: Getting the only instance of the TunerManager class implemented by the system. + +Parameter: None. + +Return: org.ngb.broadcast.dvb.tuner, a TunerManager class singleton. + +###### **A.2.11.1.2 getNetworkInterfaces** + +Prototype: public org.ngb.broadcast.dvb.tuner.Tuner[] getNetworkInterfaces() + +Description: Getting an array of all network interface objects connected to the receiving device. + +Parameter: None. + +Return: An array of Tuner objects. If not, it returns null. + +#### **A.2.12 Exception org.ngb.broadcast.dvb.tuner.TunerException** + +Prototype: public class org.ngb.broadcast.dvb.tuner.TunerException extends java.lang.Exception + +Description: Network interface exception, a group of base classes for other network exceptions defined by this package. + +#### **A.2.13 Exception org.ngb.broadcast.dvb.tuner.IncorrectLocatorException** + +Prototype: public class org.ngb.broadcast.dvb.tuner.IncorrectLocatorException extends org.ngb.broadcast.dvb.tuner.TunerException + +Description: An exception that the format of the locator is incorrect. It inherits the org.ngb.broadcast.dvb.tuner.TunerException class. + +#### **A.2.14 Exception org.ngb.broadcast.dvb.tuner.StreamNotFoundException** + +Prototype: public class org.ngb.broadcast.dvb.tuner.StreamNotFoundException extends org.ngb.broadcast.dvb.tuner.TunerException + +Description: No exception is found in the stream. It inherits the org.ngb.broadcast.dvb.tuner.TunerException class. This exception is thrown when the reference to the transport stream cannot be resolved because the transport stream is not in the StreamTable. + +#### **A.2.15 Exception org.ngb.broadcast.dvb.tuner.TuningParameterNotFoundException** + +Prototype: public class org.ngb.broadcast.dvb.tuner.TuningParameterNotFoundException extends org.ngb.broadcast.dvb.tuner.TunerException + +Description: It inherits org.ngb.broadcast.dvb.tuner.TunerException class. When getting the current tuning and demodulation parameters fails or org.ngb.broadcast.dvb.tuner.DeliverySystemType is wrong, this exception is thrown. + +# Annex B + +## JAVA-Broadcast protocol processing unit + +(This annex forms an integral part of this Recommendation.) + +## B.1 Overview + +This annex defines JAVA interfaces related to broadcast protocol processing, including MPEG object definition module, DVB object definition module, SECTION segment filtering module, URL encapsulation module, DVB locator module and broadcast protocol processing module. + +## B.2 MPEG object definition module + +The MPEG object definition module defines the most basic objects under the MPEG-2 system and the exceptions in the system. + +Defined the most basic MPEG-2 objects are: + +- Transport Stream; +- Elementary Stream; +- Service. + +Defined MPEG-2 exceptions are: + +- Not Authorized Exception; +- Resource Exception; +- Tuning Exception. + +The summary of MPEG object definition module is shown in Table B.1. + +**Table B.1 – Summary of MPEG object definition module** + +| | | +|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Interface | | +| NotAuthorizedInterface | An unauthorized broadcast content report interface, defining the failure reason constant and providing a method to find the failure reason. | +| Class | | +| TransportStream | An MPEG-2 transport stream class, indicating an MPEG-2 transport stream (TS) and providing a method for obtaining transport stream information. | +| ElementaryStream | An MPEG-2 elementary stream class, indicating an elementary stream (ES) carried in a transport stream (TS) and providing a method for obtaining elementary stream information. | +| Service | An MPEG-2 service class, indicating an MPEG-2 service carried in the transport stream, and providing a method for obtaining service information. | +| Exception | | +| NotAuthorizedException | An unauthorized broadcast content exception, implements NotAuthorizedInterface interface, thrown when accessing unauthorized scrambled data. | +| TuningException | Tuning and demodulation exception, thrown when tuning and demodulation fails. | +| ResourceException | Resource exception, thrown when operation cannot be performed due to lack of resources. | + +#### **B.2.1 Interface org.davic.mpeg.NotAuthorizedInterface** + +Prototype: public interface org.davic.mpeg.NotAuthorizedInterface + +Description: An unauthorized broadcast content report interface, defines the failure reason constant, and providing a method to find the failure reason. + +Example: + +- (1) Call the getType() method to determine whether the descrambling failure occurred in the service or the basic stream: + - If the getType() method returns SERVICE, call the getService() method to obtain the org.davic.mpeg.Service object that cannot be descrambled; + - If the getType() method returns ELEMENTARY\_STREAM, call the getElementaryStreams() method to obtain an array of org.davic.mpeg.ElementaryStream objects that cannot be descrambled; +- (2) Call the getReason() method to get the specific reason why it cannot be descrambled: + - POSSIBLE\_UNDER\_CONDITIONS, including the following secondary reasons: + - 1.1 COMMERCIAL\_DIALOG + - 1.2 MATURITY\_RATING\_DIALOG + - 1.3 TECHNICAL\_DIALOG + - 1.4 FREE\_PREVIEW\_DIALOG + - 1.5 OTHER + - NOT\_POSSIBLE, including the following secondary reasons: + - 1.6 NO\_ENTITLEMENT + - 1.7 MATURITY\_RATING + - 1.8 TECHNICAL + - 1.9 GEOGRAPHICAL\_BLACKOUT + - 1.10 OTHER + +##### **B.2.1.1 Constant field – main reason for failure** + +###### **B.2.1.1.1 POSSIBLE\_UNDER\_CONDITIONS** + +Prototype: public static final int POSSIBLE\_UNDER\_CONDITIONS = 0 + +Description: Main reason for failure – Accessible under certain conditions. + +###### **B.2.1.1.2 NOT\_POSSIBLE** + +Prototype: public static final int NOT\_POSSIBLE = 1 + +Description: Main reason for failure – Impossible to access. + +##### **B.2.1.2 Constant field – secondary reason for failure** + +###### **B.2.1.2.1 COMMERCIAL\_DIALOG** + +Prototype: public static final int COMMERCIAL\_DIALOG = 1 + +Description: The secondary reason for POSSIBLE\_UNDER\_CONDITIONS – A conversation about payment is required. + +###### **B.2.1.2.2 MATURITY\_RATING\_DIALOG** + +Prototype: public static final int MATURITY\_RATING\_DIALOG = 2 + +Description: The secondary reason for POSSIBLE\_UNDER\_CONDITIONS – A conversation about age restrictions is required. + +###### **B.2.1.2.3 TECHNICAL\_DIALOG** + +Prototype: public static final int TECHNICAL\_DIALOG = 3 + +Description: The secondary reason for POSSIBLE\_UNDER\_CONDITIONS – A dialogue about technical support is required. + +###### **B.2.1.2.4 FREE\_PREVIEW\_DIALOG** + +Prototype: public static final int FREE\_PREVIEW\_DIALOG = 4 + +Description: The secondary reason for POSSIBLE\_UNDER\_CONDITIONS – A dialogue explaining the free preview is required. + +###### **B.2.1.2.5 NO\_ENTITLEMENT** + +Prototype: public static final int NO\_ENTITLEMENT = 1 + +Description: The secondary reason for NOT\_POSSIBLE – The user is not authorized. + +###### **B.2.1.2.6 MATURITY\_RATING** + +Prototype: public static final int MATURITY\_RATING = 2 + +Description: The secondary reason for NOT\_POSSIBLE – Operation is not allowed due to age reasons. + +###### **B.2.1.2.7 TECHNICAL** + +Prototype: public static final int TECHNICAL = 3 + +Description: The secondary reason for NOT\_POSSIBLE – The operation is not allowed due to some technical reasons. + +###### **B.2.1.2.8 GEOGRAPHICAL\_BLACKOUT** + +Prototype: public static final int GEOGRAPHICAL\_BLACKOUT = 4 + +Description: The secondary reason for NOT\_POSSIBLE – Operation is not allowed due to geographic reasons. + +###### **B.2.1.2.9 OTHER** + +Prototype: public static final int OTHER = 5 + +Description: The secondary reason for POSSIBLE\_UNDER\_CONDITIONS and NOT\_POSSIBLE – Other reasons. + +##### **B.2.1.3 Constant field – MPEG-2 object** + +###### **B.2.1.3.1 SERVICE** + +Prototype: public static final int SERVICE = 0 + +Description: The MPEG-2 object where the error occurred – Access to the service object is denied. + +###### **B.2.1.3.2 ELEMENTARY\_STREAM** + +Prototype: public static final int ELEMENTARY\_STREAM = 1 + +Description: The MPEG-2 object where the error occurred – Access to the elementary stream object is denied. + +##### **B.2.1.4 Method** + +###### **B.2.1.4.1 getType** + +Prototype: public int getType() + +Description: Getting the MPEG-2 object type where the unauthorized error occurred. + +Parameter: None. + +Return: Int type, indicating the type of MPEG-2 object that cannot be descrambled. The value can be SERVICE or ELEMENTARY\_STREAM. For details, see the "MPEG-2 Object" constant field definition of the org.davic.mpeg.NotAuthorizedInterface interface. + +###### **B.2.1.4.2 getService** + +Prototype: public org.davic.mpeg.Service getService() + +Description: Getting MPEG-2 service objects that cannot be descrambled. + +Parameter: None. + +Return: A service object, indicating a service that cannot be descrambled. + +- If the type returned by the getType() method is SERVICE, this method returns a service object that cannot be descrambled; +- If the type returned by the getType() method is ELEMENTARY\_STREAM, this method returns null. + +###### **B.2.1.4.3 getElementaryStreams** + +Prototype: public org.davic.mpeg.ElementaryStream[] getElementaryStreams() + +Description: Getting the elementary stream object that cannot be descrambled. + +Parameter: None. + +Return: An array of ElementaryStream objects, indicating an elementary stream that cannot be descrambled. Otherwise, it returns null. + +- If the type returned by the getType() method is ELEMENTARY\_STREAM, this method returns an array of elementary stream objects that cannot be descrambled; +- If the type returned by the getType() method is SERVICE, this method returns null. + +###### **B.2.1.4.4 getReason** + +Prototype: public int[] getReason(int index) throws java.lang.IndexOutOfBoundsException + +Description: Getting the reason why it cannot be descrambled. + +Parameter: index – Int type, indicating the serial number of the component. + +- If the descrambling of the MPEG-2 service object fails, this parameter is set to 0; +- If the descrambling of the MPEG-2 elementary stream object fails, the index parameter indicates the sequence number of the org.davic.mpeg.ElementaryStream object array returned by the getElementaryStreams() method. + +Return: Int type array, the length of the array is 2, int[0] indicating the main reason, int[1] indicating the secondary reason. For the value, please refer to the constant field definition "main reason for failure" and "secondary reason for failure" of the org.davic.mpeg.NotAuthorizedInterface interface. + +Exception: java.lang.IndexOutOfBoundsException – If the MPEG-2 service object descrambling fails and the index parameter takes a non-zero value, this exception is thrown; if the MPEG-2 elementary stream object descrambling fails, and the index exceeds the length of the ElementaryStream array returned by the getElementaryStreams() method, this exception is thrown. + +#### **B.2.2 Class org.davic.mpeg.TransportStream** + +Prototype: public class org.davic.mpeg.TransportStream + +Description: An MPEG-2 transport stream class, indicating an MPEG-2 transport stream (TS), and providing a method for obtaining transport stream information. A transport stream object, indicating a transport stream that can be accessed through a specific network interface, which indicates that there is an implicit relationship between the transport stream object and the network interface. Therefore, if multiple network interfaces send the same transport stream at the same time, a separate transport stream object should also be constructed for the transport stream sent by each interface. + +##### **B.2.2.1 Method** + +###### **B.2.2.1.1 getTransportStreamId** + +Prototype: public int getTransportStreamId() + +Description: Obtain the transport stream identifier (that is, obtain the transport\_stream\_id field information in the PAT). + +Parameter: None. + +Return: Int type, indicating the identifier of the transport stream. + +##### **B.2.2.1.2 retrieveService** + +Prototype: public org.davic.mpeg.Service retrieveService(int serviceId) + +Description: Obtain the service object carried in the transport stream according to the specified service identifier. + +Parameter: serviceId – Int type, indicating the service identifier of the requested service. + +Return: An org.davic.mpeg.Service object, indicating the requested service. If the specified service does not exist, null is returned. + +##### **B.2.2.1.3 retrieveServices** + +Prototype: public org.davic.mpeg.Service[] retrieveServices() + +Description: Getting all service objects carried in the transport stream. + +Parameter: None. + +Return: An array of service objects, indicating all the services carried in the transport stream. If there is no service object, null is returned. + +#### **B.2.3 Class org.davic.mpeg.ElementaryStream** + +Prototype: public class org.davic.mpeg.ElementaryStream + +Description: An MPEG-2 elementary stream class, indicating an elementary stream (ES) carried in a transport stream (TS), and providing a method for obtaining elementary stream information. If an elementary stream is used for multiple services, multiple instances of this class should be implemented, that is, one instance is used for one service object. + +Description: The elementary stream information defined in this class comes from PMT. + +##### **B.2.3.1 Method** + +##### **B.2.3.1.1 getPID** + +Prototype: public int getPID() + +Description: Obtain the PID value of the transport packet carrying the elementary stream. + +Parameter: None. + +Return: Int type, indicating the PID value of the transport packet carrying the elementary stream. + +##### **B.2.3.1.2 getAssociationTag** + +Prototype: public java.lang.Integer getAssociationTag() + +Description: Obtain the DSM-CC association identifier of the elementary stream. + +Parameter: None. + +Return: A java.lang.Integer object, indicating the DSM-CC associated identifier of the elementary stream, or null is returned if there is no associated identifier. + +##### **B.2.3.1.3 getService** + +Prototype: public org.davic.mpeg.Service getService() + +Description: Getting the service to which the elementary stream belongs. + +Parameter: None. + +Return: An org.davic.mpeg.Service object, indicating the service that contains the elementary stream. + +#### **B.2.4 Class org.davic.mpeg.Service** + +Prototype: public class org.davic.mpeg.Service + +Description: An MPEG-2 service class, indicating an MPEG-2 service carried in the transport stream, and providing a method for obtaining service information. + +##### **B.2.4.1 Method** + +##### **B.2.4.1.1 getServiceId** + +Prototype: public int getServiceId() + +Description: Getting the service identifier (service\_id). + +Parameter: None. + +Return: Int type, indicating the service identifier of the service. + +##### **B.2.4.1.2 getTransportStream** + +Prototype: org.davic.mpeg.TransportStream getTransportStream() + +Description: Obtain the transport stream object that carries the service. + +Parameter: None. + +Return: An org.davic.mpeg.TransportStream object, indicating the transport stream object that carries the service. + +##### **B.2.4.1.3 retrieveElementaryStream** + +Prototype: public org.davic.mpeg.ElementaryStream retrieveElementaryStream(int pid) + +Description: According to the specified transport stream PID, obtain the elementary stream objects contained in the service. + +Parameter: pid – Int type, indicating the identifier of the transport packet that carries the elementary stream. + +Return: An ElementaryStream object indicating the elementary stream contained in the service, returning null if no specified elementary stream object is found. + +##### **B.2.4.1.4 retrieveElementaryStreams** + +Prototype: public org.davic.mpeg.ElementaryStream[] retrieveElementaryStreams() + +Description: Getting all the elementary stream objects in the service. + +Parameter: None. + +Return: An org.davic.mpeg.ElementaryStream object array indicating all the elementary streams in the service, and returning null if none. + +#### **B.2.5 Exception org.davic.mpeg.NotAuthorizedException** + +Prototype: public class org.davic.mpeg.NotAuthorizedException extends java.lang.Exception implements NotAuthorizedInterface + +Description: Unauthorized broadcast content exception, thrown when accessing unauthorized scrambled data. + +#### **B.2.6 Exception org.davic.mpeg.TuningException** + +Prototype: public class org.davic.mpeg.TuningException extends java.lang.Exception + +Description: Tuning and demodulation exception, thrown when tuning and demodulation fails. + +#### **B.2.7 Exception org.davic.mpeg.ResourceException** + +Prototype: public class org.davic.mpeg.ResourceException extends java.lang.Exception + +Description: Resource lack exception, thrown when operations cannot be performed due to resource lack. + +### **B.3 DVB object definition module** + +The DVB object definition module defines the basic objects of MPEG-2 under the DVB system: + +- DVB transport stream class (org.davic.mpeg.dvb.DvbTransportStream); +- DVB elementary stream class (org.davic.mpeg.dvb.DvbElementaryStream); +- DVB broadcasting service class (org.davic.mpeg.dvb.DvbService). + +The summary of DVB object definition module is shown in Table B.2. + +**Table B.2 – Summary of DVB object definition module** + +| Class | | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DvbElementaryStream | A DVB elementary stream class, indicating an MPEG-2 elementary stream (ES) that conforms to the semantic constraints of DVB carried in a transport stream (TS), and providing a method for obtaining DVB elementary stream information. | +| DvbService | A DVB service class, indicating an MPEG-2 service that conforms to the semantic constraints of DVB carried in the transport stream, and providing a method for obtaining DVB service information. | +| DvbTransportStream | A DVB transport stream class, indicating an MPEG-2 transport stream that conforms to the semantic constraints of DVB, and providing a method for obtaining DVB transport stream information. | + +#### **B.3.1 Class org.davic.mpeg.dvb.DvbElementaryStream** + +Prototype: public class org.davic.mpeg.dvb.DvbElementaryStream extends org.davic.mpeg.ElementaryStream + +Description: A DVB elementary stream class, indicating an MPEG-2 elementary stream (ES) that conforms to the semantic constraints of DVB carried in a transport stream (TS), and providing a method for obtaining DVB elementary stream information. + +##### **B.3.1.1 Method** + +##### **B.3.1.1.1 getComponentTag** + +Prototype: public java.lang.Integer getComponentTag() + +Description: Getting the component tag of the DVB elementary stream (that is, get the value of the component\_tag field in the descriptor of the stream\_identifier\_descriptor). + +Parameter: None. + +Return: A java.lang.Integer object, indicating the component tag of the DVB elementary stream. If there is no component tag (that is, the ES stream ring does not carry the descriptor of the stream\_identifier\_descriptor), it returns null. + +#### **B.3.2 Class org.davic.mpeg.dvb.DvbService** + +Prototype: public class org.davic.mpeg.dvb.DvbService extends org.davic.mpeg.Service + +Description: A DVB service class, indicating an MPEG-2 service that conforms to the semantic constraints of DVB carried in the transport stream, and providing a method for obtaining DVB service information. + +##### **B.3.2.1 Method** + +##### **B.3.2.1.1 retrieveDvbElementaryStream** + +Prototype: public org.davic.mpeg.dvb.DvbElementaryStream retrieveDvbElementaryStream(int componentTag) + +Description: Obtain the DVB elementary stream contained in the DVB service according to the specified component tag. + +Parameter: componentTag – Int type, indicating the component tag value of the DVB elementary stream. + +Return: An org.davic.mpeg.dvb.DvbElementaryStream object, indicating the DVB elementary stream object. If the DVB elementary stream specified by the parameter componentTag does not exist, null is returned. + +#### **B.3.3 Class org.davic.mpeg.dvb.DvbTransportStream** + +Prototype: public class org.davic.mpeg.dvb.DvbTransportStream extends org.davic.mpeg.TransportStream + +Description: A DVB transport stream class, indicating an MPEG-2 transport stream that conforms to the semantic constraints of DVB, and providing a method for obtaining DVB transport stream information. + +##### **B.3.3.1 Method** + +##### **B.3.3.1.1 getNetworkId** + +Prototype: public int getNetworkId() + +Description: Getting the network ID of the network where the DVB transport stream is located. + +Parameter: None. + +Return: Int type, indicating the network identifier of the network where the transport stream is located. + +##### **B.3.3.1.2 getOriginalNetworkId** + +Prototype: public int getOriginalNetworkId() + +Description: Getting the original network ID of the DVB transport stream. + +Parameter: None. + +Return: Int type, indicating the original network identifier of the transport stream. + +### **B.4 SECTION filter module** + +The SECTION filter module provides classes and methods related to MPEG-2 section filtering. + +The summary of the SECTION filter module is shown in Table B.3. + +**Table B.3 – Summary of the SECTION filter module** + +| | | +|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Interface | | +| SectionFilterListener | The section filter event listener interface, provides a callback method for section filter event handling, which is implemented by the application layer. | +| Class | | +| Section | An MPEG-2 section class, describing a section filtered from the transport stream. | +| SectionFilterGroup | A section filter group class, indicating an MPEG-2 filter group, can be activated and released as a basic operation unit. | +| SectionFilter | The section filter class, which is a base class for a group of section filter classes with different life cycles and cache length characteristics, provides basic operation methods of filters. | +| SimpleSectionFilter | The simple section filter class inherits the SectionFilter class. | +| TableSectionFilter | The table section filter class inherits the SectionFilter class. | +| RingSectionFilter | The ring section filter class inherits the SectionFilter class. | +| Event | | +| SectionFilterEvent | Section filter event class, a base class of a group of section filter event classes. | +| SectionAvailableEvent | Section data available events, inherit the SectionFilterEvent class, report filtering to a complete section. | +| VersionChangeDetectedEvent | The section filter version change event, inherits the SectionFilterEvent class. | +| EndOfFilteringEvent | Section filtering end event, inherits the SectionFilterEvent class, and reports the end of section filtering. | +| Event | | +| IncompleteFilteringEvent | Section filtering incomplete event, inherits the EndOfFilteringEvent class. | +| TimeoutEvent | Section filtering timeout event, inherits the EndOfFilteringEvent class. | +| FilterResourcesAvailableEvent | Filter resource available events, inherit the ResourceStatusEvent class. | +| ForcedDisconnectedEvent | The forced disconnection event between the section filter group and the transport stream, inherits the ResourceStatusEvent class. | +| Exception | | +| SectionFilterException | The base class for section filter exceptions. | +| ConnectionLostException | Connection lost exception, inherits the SectionFilterException class. | +| FilteringInterruptedException | Filtering interrupted exception, inherits the SectionFilterException class. | + +**Table B.3 – Summary of the SECTION filter module** + +| | | +|----------------------------------|-----------------------------------------------------------------------------------------------| +| FilterResourceException | Filter resource exception, inherits the SectionFilterException class. | +| IllegalFilterDefinitionException | Illegal filter definition exception, inherits the SectionFilterException class. | +| InvalidSourceException | Invalid section data source exception, inherits the SectionFilterException class. | +| NoDataAvailableException | No data available exception of the section objects inherits the SectionFilterException class. | + +The relationship between the objects of the SECTION filter module is shown in Figure B.1. + + + +``` + +classDiagram + class ResourceServer + class ResourceProxy + class TransportStream + class SectionFilterGroup + class SectionFilter + class SimpleSectionFilter + class RingSectionFilter + class TableSectionFilter + class ResourceStatusListener + class ResourceStatusEvent + class SectionFilterListener + class SectionFilterEvent + + ResourceServer <|-- TransportStream : realize + ResourceProxy <|-- TransportStream : realize + SectionFilterGroup --> TransportStream : attach/detach + SectionFilterGroup --> SectionFilter : create + SectionFilter <|-- SimpleSectionFilter : inherit + SectionFilter <|-- RingSectionFilter : inherit + SectionFilter <|-- TableSectionFilter : inherit + SectionFilterGroup --> ResourceStatusListener : callback + ResourceStatusListener --> ResourceStatusEvent : listen + SectionFilter --> SectionFilterListener : register/unregister + SectionFilterListener --> SectionFilterEvent : listen + ResourceStatusListener --> SectionFilterGroup : register/unregister + +``` + +UML class diagram showing relationships between ResourceServer, ResourceProxy, TransportStream, SectionFilterGroup, SectionFilter, SimpleSectionFilter, RingSectionFilter, TableSectionFilter, ResourceStatusListener, ResourceStatusEvent, SectionFilterListener, and SectionFilterEvent. Relationships include realize, attach/detach, create, inherit, callback, register/unregister, and listen. + +**Figure B.1 – Relationship between the objects of the SECTION filter module** + +The state transition diagram of the connection relationship between the SectionFilterGroup object and the TransportStream object is shown in Figure B.2. + + + +``` + +stateDiagram-v2 + [*] --> Unconnected + Unconnected --> Connected : attach() successful + Connected --> Unconnected : detach() + Connected --> Connection lost : The system is forcibly disconnected + Connection lost --> Unconnected : attach() failed + Connection lost --> Connected : detach() + +``` + +State transition diagram for the connection relationship between SectionFilterGroup and TransportStream. States: Unconnected, Connected, Connection lost. Transitions: attach() successful, detach(), attach() failed, The system is forcibly disconnected. + +**Figure B.2 – State transition diagram of the connection relationship between the SectionFilterGroup object and the TransportStream object** + +#### **B.4.1 Interface org.davic.mpeg.sections.SectionFilterListener** + +Prototype: public interface org.davic.mpeg.sections.SectionFilterListener extends java.util.EventListener. + +Description: The section filter event listener interface, provides a callback method for section filter event handling, which is implemented by the application layer. + +##### **B.4.1.1 Method** + +##### **B.4.1.1.1 sectionFilterUpdate** + +Prototype: void sectionFilterUpdate(org.davic.mpeg.sections.SectionFilterEvent event) + +Description: The callback method for section filtering event handling. + +Parameter: event – An org.davic.mpeg.sections.SectionFilterEvent object, indicating the section filtering event. The method implementer should further determine the type of event parameter through the instanceof method. + +Return: None. + +#### **B.4.2 Class org.davic.mpeg.sections.Section** + +Prototype: public class org.davic.mpeg.sections.Section implements Cloneable + +Description: The MPEG-2 section class describes a section filtered from the transport stream. The section object copied by the clone() method is an independent new object. The state change of the original object will not affect the new object. Copying objects with the clone() method must be implemented without throwing an exception. + +##### **B.4.2.1 Method** + +###### **B.4.2.1.1 clone** + +Prototype: public java.lang.Object clone() + +Description: Clone the section object. The section object copied by the clone() method is an independent new object. The state change of the original object will not affect the new object. Copying objects with the clone() method must be implemented without throwing an exception. + +Rewrite: The clone() method of the object class. + +Parameter: None. + +Return: Section object. + +##### **B.4.2.1.2 current\_next\_indicator** + +Prototype: public boolean current\_next\_indicator() throws org.davic.mpeg.sections.NoDataAvailableException + +Description: Getting the value of the current\_next\_indicator field in the section header. + +Parameter: None. + +Return: boolean type, true value indicating that the current\_next\_indicator field is 1, and false indicating that the current\_next\_indicator field is 0. + +Exception: org.davic.mpeg.sections.NoDataAvailableException – If the section data is not filtered, this exception is thrown. + +##### **B.4.2.1.3 getByteAt** + +Prototype: public byte getByteAt(int index) throws org.davic.mpeg.sections.NoDataAvailableException, java.lang.IndexOutOfBoundsException + +Description: Getting the specified byte of the filtered section data in the section object. + +Parameter: index-int type, indicating the position of the byte to be retrieved in the section. The index value of the first byte in the section (that is, the table\_id field) is 1. + +Exception: org.davic.mpeg.sections.NoDataAvailableException – If the section data is not filtered, this exception is thrown. + +java.lang.IndexOutOfBoundsException – This exception is thrown if the byte to be retrieved is out of the section data range. + +##### **B.4.2.1.4 getData** + +Prototype: public byte[] getData() throws org.davic.mpeg.sections.NoDataAvailableException + +Description: Obtain the filtered section data in the section object, including the section header. Each call to this method will return a new copy of the section data. + +Parameter: None. + +Return: None. + +Exception: org.davic.mpeg.sections.NoDataAvailableException – If the section data is not filtered, this exception is thrown. + +##### **B.4.2.1.5 getData** + +Prototype: public byte[] getData(int index, int length) throws org.davic.mpeg.sections.NoDataAvailableException, java.lang.IndexOutOfBoundsException + +Description: Getting the specified part of the filtered section data in the section object. Each call to this method will return a new copy of the section data. + +Parameter: index – Int type, indicating the position of the byte to be retrieved in the section. The index value of the first byte in the section (ie the table\_id field) is 1. + +length-int type, indicating the number of consecutive bytes of the data to be retrieved starting from the first byte. + +Return: None. + +Exception: org.davic.mpeg.sections.NoDataAvailableException – If the section data is not filtered, this exception is thrown. + +java.lang.IndexOutOfBoundsException – This exception is thrown if a certain part of the data to be retrieved is out of the range of the section data. + +##### **B.4.2.1.6 getFullStatus** + +Prototype: public boolean getFullStatus() + +Description: Determine whether the section object contains valid data. + +Parameter: None. + +Return: boolean type, true value indicating that the section object contains valid data, and false indicating that there is no valid data. + +###### **B.4.2.1.7 last\_section\_number** + +Prototype: public int last\_section\_number() throws org.davic.mpeg.sections.NoDataAvailableException + +Description: Getting the value of the last\_section\_number field of the section header. + +Parameter: None. + +Return: Int type, indicating the value of the last\_section\_number field. + +Exception: org.davic.mpeg.sections.NoDataAvailableException – If the section data is not filtered, this exception is thrown. + +##### **B.4.2.1.8 private\_indicator** + +Prototype: public boolean private\_indicator() throws org.davic.mpeg.sections.NoDataAvailableException + +Description: Getting the value of the private\_indicator field in the section header. + +Parameter: None. + +Return: None. + +Exception: org.davic.mpeg.sections.NoDataAvailableException – If the section data is not filtered, this exception is thrown. + +##### **B.4.2.1.9 section\_length** + +Prototype: public int section\_length() throws org.davic.mpeg.sections.NoDataAvailableException + +Description: Getting the value of the section\_length field in the section header. + +Parameter: None. + +Return: Int type, indicating the value of the section\_length field in the section header. + +Exception: org.davic.mpeg.sections.NoDataAvailableException – If the section data is not filtered, this exception is thrown. + +##### **B.4.2.1.10 section\_number** + +Prototype: public int section\_number() throws org.davic.mpeg.sections.NoDataAvailableException + +Description: Getting the value of the section\_number field in the section header. + +Parameter: None. + +Back: Int type, indicating the value of the section\_number field. + +Exception: org.davic.mpeg.sections.NoDataAvailableException – If the section data is not filtered, this exception is thrown. + +##### **B.4.2.1.11 section\_syntax\_indicator** + +Prototype: public boolean section\_syntax\_indicator() throws org.davic.mpeg.sections.NoDataAvailableException + +Description: Getting the value of the section\_syntax\_indicator field in the section header. + +Parameter: None. + +Return: boolean type, true value indicating section\_syntax\_indicator = 1, the false value indicating section\_syntax\_indicator=0. + +Exception: org.davic.mpeg.sections.NoDataAvailableException – If the section data is not filtered, this exception is thrown. + +##### **B.4.2.1.12 setEmpty** + +Prototype: public void setEmpty() + +Description: The data in the set section object is no longer valid, and is generally used by org.davic.mpeg.sections.RingSectionFilter to indicate that the specific object can be used again. + +Parameter: None. + +Return: None. + +##### **B.4.2.1.13 table\_id\_extension** + +Prototype: public int table\_id\_extension() throws org.davic.mpeg.sections.NoDataAvailableException + +Description: Getting the value of the table\_id\_extension field in the section header. + +Parameter: None. + +Return: Int type, indicating the value of the table\_id\_extension field. For the application, it needs to determine the specific semantics of the table\_id\_extension field according to the type of table\_id. + +Exception: org.davic.mpeg.sections.NoDataAvailableException – If the section data is not filtered, this exception is thrown. + +##### **B.4.2.1.14 table\_id** + +Prototype: public int table\_id() throws org.davic.mpeg.sections.NoDataAvailableException + +Description: Getting the value of the table\_id field in the section header. + +Parameter: None. + +Return: Int type, indicating the table\_id field of the section. + +Exception: org.davic.mpeg.sections.NoDataAvailableException – If the section data is not filtered, this exception is thrown. + +###### **B.4.2.1.15 version\_number** + +Prototype: public short version\_number() throws org.davic.mpeg.sections.NoDataAvailableException + +Description: Getting the value of the version\_number field in the section header. + +Parameter: None. + +Return: short type, indicating the value of the version\_number field. + +Exception: org.davic.mpeg.sections.NoDataAvailableException – If the section data is not filtered, this exception is thrown. + +#### **B.4.3 Class org.davic.mpeg.sections.SectionFilterGroup** + +Prototype: public class org.davic.mpeg.sections.SectionFilterGroup implements org.davic.resources.ResourceProxy, org.davic.resources.ResourceServer + +Description: Section filter group class, indicating an MPEG-2 filter group and can be activated and released as a basic operation unit. The purpose of this class is to minimize resource deadlocks that may occur between independent applications. + +##### **B.4.3.1 Method** + +###### **B.4.3.1.1 SectionFilterGroup** + +Prototype: public SectionFilterGroup(int numberOfFilters) throws java.lang.IllegalArgumentException + +Description: Construction method creates a section filter group object. + +Parameter: numberOfFilters – Int type, indicating the number of section filters that the section filter group needs to occupy. + +java.lang.IllegalArgumentException – If the parameter numberOfFilters is less than 1, this exception is thrown. + +##### **B.4.3.1.2 SectionFilterGroup** + +Prototype: public SectionFilterGroup(int numberOfFilters, boolean resourcePriority) throws java.lang.IllegalArgumentException + +Description: Construction method creates a section filter group object. + +Parameter: numberOfFilters – Int type, indicating the number of section filters that the section filter group object needs to occupy. + +resourcePriority – boolean type, indicating the relative priority of the resources possessed between the filter group object and other objects in the sections package when there are insufficient filter resources. True value indicates high priority, and false indicates low priority. The scope of the resourcePriority parameter is limited to one application. + +Exception: java.lang.IllegalArgumentException – If the parameter numberOfFilters is less than 1, this exception is thrown. + +##### **B.4.3.1.3 addResourceStatusEventListener** + +Prototype: public synchronized void addResourceStatusEventListener +(org.davic.resources.ResourceStatusListener listener) + +Description: Register the resource status change event listener of the filter group, and implement the addResourceStatusEventListener() method in the interface org.davic.resources.ResourceProxy. If this method is called multiple times, each listener object can be notified of each resource change. + +Parameter: listener An org.davic.resources.ResourceStatusListener object, indicating the resource status change event listener to be registered. + +Return: None. + +##### **B.4.3.1.4 removeResourceStatusEventListener** + +Prototype: public synchronized void removeResourceStatusEventListener +(org.davic.resources.ResourceStatusListener listener) + +Description: Unregister the resource status change event listener of the filter group, and implement the removeResourceStatusEventListener() method in the ResourceProxy interface. If the listener object was not notified originally, this method has no other effect. + +Parameter: listener An org.davic.resources.ResourceStatusListener object, indicating the resource status change event listener to be unregistered. + +Return: None. + +##### **B.4.3.1.5 attach** + +Prototype: public boolean attach(org.davic.mpeg.TransportStream stream, org.davic.resources.ResourceClient client, java.lang.Object requestData) throws org.davic.mpeg.sections.FilterResourceException, org.davic.mpeg.sections.InvalidSourceException, org.davic.mpeg.TuningException + +Description: Associate the filter group object with the transport stream. This filter group will try to obtain the number of section filters specified when it was created. Call the attach() method again on the connected filter group and return false directly. When using filters and filter groups, the order of function calling is: filter group attach, filter startFiltering, filter stopFiltering, filter group detach. + +Parameter: stream An org.davic.mpeg.TransportStream object, indicating the transport stream object; client – An org.davic.resources.ResourceClient object, indicating the resource client, the object that needs to be notified when the filter resource is lost; + +requestData – A java.lang.Object object, indicating the application-specific data passed to the resource client when the resource manager notifies that the resource is lost. + +Return: boolean type, returning true upon success and false upon failure. + +Exception: org.davic.mpeg.sections.FilterResourceException – If the reservation of a specific section filter fails, this exception is thrown; + +org.davic.mpeg.sections.InvalidSourceException – If the specified transport stream is invalid, this exception is thrown; + +org.davic.mpeg.TuningException – If it is not tuned to the specified transport stream, this exception is thrown. + +##### **B.4.3.1.6 detach** + +Prototype: public boolean detach() + +Description: Disconnect the filter group object from the transport stream. The section filter occupied by the filter group will be released. The disconnected filter group returns false directly. + +Parameter: None. + +Return: boolean type, returning true upon success and false upon failure. + +##### **B.4.3.1.7 getClient** + +Prototype: public org.davic.resources.ResourceClient getClient() + +Description: Getting the org.davic.resources.ResourceClient object specified in the attach() method so that you can be notified when the section filter is removed from the SectionFilterGroup. Implement the getClient() method in the interface org.davic.resources.ResourceProxy. + +Parameter: None. + +Return: An org.davic.resources.ResourceClient object, indicating a resource customer. If the filter group is not associated with the transport stream, null is returned. + +##### **B.4.3.1.8 getSource** + +Prototype: public org.davic.mpeg.TransportStream getSource() + +Description: Getting the transport stream currently associated with the filter group object. + +Parameter: None. + +Return: An org.davic.mpeg.TransportStream object, indicating the transport stream associated with this filter group. If the filter group is not associated with the transport stream, null is returned. + +###### **B.4.3.1.9 newRingSectionFilter** + +Prototype: public RingSectionFilter newRingSectionFilter(int ringSize) throws java.lang.IllegalArgumentException + +Description: Creating a ring section filter in the parent filter group. Once started, the ring section filter org.davic.mpeg.sections.RingSectionFilter object will use the section filter specified when the parent filter group was created. + +Parameter: ringSize – Int type, indicating the number of Section objects occupied by the ring section filter. + +Return: An org.davic.mpeg.sections.RingSectionFilter object, indicating a ring section filter. + +Exception: java.lang.IllegalArgumentException – If the parameter ringSize is less than 1, this exception is thrown. + +##### **B.4.3.1.10 newRingSectionFilter** + +Prototype: public RingSectionFilter newRingSectionFilter(int ringSize, int sectionSize) throws java.lang.IllegalArgumentException + +Description: Creating a ring section filter in the parent filter group. Once started, the ring section filter org.davic.mpeg.sections.RingSectionFilter object will use the section filter specified when the parent filter group was created. + +Parameter: ringSize – Int type, indicating the number of Section objects occupied by the ring section filter; + +sectionSize – Int type, indicating the length of the section data buffer, in bytes. If the length of the section to be filtered is greater than this value, the excess data will be cut off, and the filtering will continue without any notification to the application. + +Return: An org.davic.mpeg.sections.RingSectionFilter object, indicating a ring section filter. + +Exception: java.lang.IllegalArgumentException – If the ringSize parameter is less than 1 or the sectionSize parameter is less than 1, this exception is thrown. + +##### **B.4.3.1.11 newSimpleSectionFilter** + +Prototype: public SimpleSectionFilter newSimpleSectionFilter() + +Description: Creating a simple section filter in the parent filter group. Once started, the simple section filter org.davic.mpeg.sections.SimpleSectionFilter object will use the section filter specified when the parent filter group was created. This type of section filter has a buffer that can hold the default long section (4096 bytes). + +Parameter: None. + +Return: An org.davic.mpeg.sections.SimpleSectionFilter object, indicating a simple section filter. + +##### **B.4.3.1.12 newSimpleSectionFilter** + +Prototype: public SimpleSectionFilter newSimpleSectionFilter(int sectionSize) throws java.lang.IllegalArgumentException + +Description: Creating a simple section filter in the parent filter group. Once started, the simple section filter org.davic.mpeg.sections.SimpleSectionFilter object will use the section filter specified when the parent filter group was created. + +Parameter: sectionSize – Int type, indicating the length of the section data buffer, in bytes. If the length of the section to be filtered is greater than this value, the excess data will be cut off, and the filtering will continue without any notification to the application. + +Return: An org.davic.mpeg.sections.SimpleSectionFilter object, indicating a simple section filter. + +Exception: java.lang.IllegalArgumentException – If the sectionSize parameter is less than 1, this exception is thrown. + +##### **B.4.3.1.13 newTableSectionFilter** + +Prototype: public TableSectionFilter newTableSectionFilter() + +Description: Creating a table section filter in the parent filter group. Once started, the simple section filter org.davic.mpeg.sections.SimpleSectionFilter object will use the section filter specified when the parent filter group was created. Each section of the table section filter has a buffer that contains the default long section (4096 bytes). + +Parameter: None. + +Return: An org.davic.mpeg.sections.TableSectionFilter object, indicating a table section filter. + +##### **B.4.3.1.14 newTableSectionFilter** + +Prototype: public TableSectionFilter newTableSectionFilter(int sectionSize) throws java.lang.IllegalArgumentException + +Description: Creating a table section filter in the parent filter group. Once started, the simple section filter org.davic.mpeg.sections.SimpleSectionFilter object will use the section filter specified when the parent filter group was created. + +Parameter: sectionSize – Int type, indicating the length of the section data filter buffer, in byte. When the first section is captured and the total number of sections in the table is known, each section created will have a buffer of this length. If the length of the section to be filtered is greater than this value, the excess data will be truncated and the filtering will continue without any notification to the application. + +Return: An org.davic.mpeg.sections.TableSectionFilter object, indicating a table filter. Exception: java.lang.IllegalArgumentException – If the sectionSize parameter is less than 1, this exception is thrown. + +#### **B.4.4 Class org.davic.mpeg.sections.SectionFilter** + +Prototype: public abstract class org.davic.mpeg.sections.SectionFilter + +Description: Section filter class, which is a base class for a group of section filter classes with different life cycles and cache length characteristics, provides a basic filter operation method. If an org.davic.mpeg.sections.SectionFilterGroup object is disassociated from the transport stream due to user or resource recovery, etc., the section filter that has already started will continue to work. Therefore, when the org.davic.mpeg.sections.SectionFilterGroup object is again associated with the transport stream, these filters will be activated again. + +##### **B.4.4.1 Method** + +##### **B.4.4.1.1 addSectionFilterListener** + +Prototype: public synchronized void addSectionFilterListener(org.davic.mpeg.sections.SectionFilterListener listener) + +Description: Register the section filter event listener. + +Parameter: listener – An org.davic.mpeg.sections.SectionFilterListener object, indicating the section filter event listener to be registered. + +Return: None. + +##### **B.4.4.1.2 removeSectionFilterListener** + +Prototype: public synchronized void removeSectionFilterListener(org.davic.mpeg.sections.SectionFilterListener listener) + +Description: Unregister the section filter event listener. + +Parameter: listener – An org.davic.mpeg.sections.SectionFilterListener object, indicating the section filter event listener to be unregistered. + +Return: None. + +##### **B.4.4.1.3 setTimeout** + +Prototype: public void setTimeout(long milliseconds) throws java.lang.IllegalArgumentException + +Description: Setting the filter timeout period. When a timeout occurs, the generated timeout event org.davic.mpeg.sections.TimeoutEvent will be sent to the section filter event listener, and the filtering will stop. + +- For org.davic.mpeg.sections.SimpleSectionFilter, if no section data arrives within a certain period of time, this timeout event will be generated; +- For org.davic.mpeg.sections.TableSectionFilter, if no complete table arrives within a certain period of time, this timeout event will be generated; +- For org.davic.mpeg.sections.RingSectionFilter, this timeout event will be generated if the filter is not successfully performed after a certain period of time since the last successful filtering. + +Parameter: milliseconds – long type, indicating the timeout period, in milliseconds. If the parameter is set to 0, the timeout effect will be invalid. Setting the timeout is only valid for subsequent operations. The default value is 0. + +Return: None. + +Exception: java.lang.IllegalArgumentException – If the milliseconds value of the timeout parameter is negative, this exception is thrown. + +##### **B.4.4.1.4 startFiltering** + +Prototype: public boolean startFiltering(java.lang.Object appData, int pid) throws org.davic.mpeg.sections.FilterResourceException, org.davic.mpeg.NotAuthorizedException, org.davic.mpeg.sections.IllegalFilterDefinitionException, org.davic.mpeg.sections.ConnectionLostException + +Description: Start section filtering to filter out all sections carried in the transport packet specified by the pid parameter. The parent filter group org.davic.mpeg.sections.SectionFilterGroup object must first be associated with the transport stream. + +Parameter: appData – A java.lang.Object object, indicating the additional data object provided by the application, as a part of all filter event org.davic.mpeg.sections.SectionFilterEvent objects generated by this method call, the object will be passed to the registered section filter event Listener, the application can use this object for internal communication between applications. If the application does not require any additional data, this parameter can be set to null; + +pid – Int type, indicating the transport packet identifier (TS\_PID) to be filtered. + +Return: boolean type, returning true upon success and false upon failure. + +Exception: org.davic.mpeg.sections.FilterResourceException – When this method is called, if the total number of section filters started by the parent filter group org.davic.mpeg.sections.SectionFilterGroup is equal to the number of section filters occupied when the filter group is created, this exception is thrown. This exception applies regardless of whether the parent filter group is associated with the TS stream; + +org.davic.mpeg.NotAuthorizedException – If the section to be filtered is scrambled and has no descrambling permission, this exception is thrown; + +org.davic.mpeg.sections.IllegalFilterDefinitionException – If org.davic.mpeg.sections.TableSectionFilter calls this method, this exception is thrown; + +org.davic.mpeg.sections.ConnectionLostException – This exception is thrown if the parent filter group org.davic.mpeg.sections.SectionFilterGroup is in a state of losing connection due to lack of resources or if the section filter cannot complete the method call. + +##### **B.4.4.1.5 startFiltering** + +Prototype: public boolean startFiltering(java.lang.Object appData, int pid, int tableID) throws org.davic.mpeg.sections.FilterResourceException, org.davic.mpeg.NotAuthorizedException, org.davic.mpeg.sections.ConnectionLostException, org.davic.mpeg.sections.IllegalFilterDefinitionException + +Description: Start section filtering, filter out the section (section) carried in the transport packet specified by the pid parameter, and the table ID matches the tableID parameter. The parent filter group org.davic.mpeg.sections.SectionFilterGroup object must first be associated with the transport stream. + +Parameter: appData – A java.lang.Object object, indicating the additional data object provided by the application, as a part of all the filter event org.davic.mpeg.sections.SectionFilterEvent objects generated by this method call, the object will be passed to the registered section filter event Listener, the application can use this object for internal communication between applications. If the application does not require any additional data, this parameter can be set to null; + +pid-Int type, indicating the transport stream packet identifier (TS\_PID) to be filtered; + +tableID-Int type, indicating the table ID (table\_id) to be filtered. + +Return: boolean type, returning true upon success and false upon failure. + +Exception: org.davic.mpeg.sections.FilterResourceException – When this method is called, if the total number of section filters started by the parent filter group org.davic.mpeg.sections.SectionFilterGroup is equal to the number of section filters occupied when the filter group is created, this exception is thrown. This exception applies regardless of whether the parent filter group is associated with the TS stream; + +org.davic.mpeg.NotAuthorizedException – If the section to be filtered is scrambled and has no descrambling permission, this exception is thrown; + +org.davic.mpeg.sections.ConnectionLostException – If the parent filter group org.davic.mpeg.sections.SectionFilterGroup is in a state of losing connection, this exception is thrown due to lack of resources or when the method cannot be called by the section filter; + +org.davic.mpeg.sections.IllegalFilterDefinitionException – If the pid or tableID parameter is negative or out of the range defined by MPEG-2, this exception is thrown. + +##### **B.4.4.1.6 startFiltering** + +Prototype: public boolean startFiltering(java.lang.Object appData, int pid, int tableID, byte[] posFilterDef, byte[] posFilterMask) throws org.davic.mpeg.sections.FilterResourceException, org.davic.mpeg.sections.IllegalFilterDefinitionException, org.davic.mpeg.NotAuthorizedException, org.davic.mpeg.sections.ConnectionLostException + +Description: Start section filtering, filter out the section (section) carried in the transport packet specified by the parameter pid, and the table ID matches the tableID parameter, the section data matches the given byte filter, and the first byte of the filter byte array corresponds to the third byte of the section data. The parent filter group org.davic.mpeg.sections.SectionFilterGroup object must first be associated with the transport stream. If the following conditions are met, it means that the section data matches the given byte filter: + +$$(\text{posFilterDef}[i] \& \text{posFilterMask}[i]) == (\text{section data } [3+i] \& \text{posFilterMask}[i])$$ + +Parameter: appData – A java.lang.Object object, indicating the additional data object provided by the application, as a part of all the filter event org.davic.mpeg.sections.SectionFilterEvent objects generated by this method call, the object will be passed to the registered section filter event listener. This object can be used for internal communication between applications. If the application does not require any additional data, this parameter can be set to null; + +pid – Int type, indicating the transport stream packet identifier (TS\_PID) to be filtered; + +tableID – Int type, indicating the table ID (table\_id) to be filtered; + +posFilterDef – A byte array, indicating the value of bit matching in the section data; + +posFilterMask – A byte array, indicating the mask of bit matching in the section data, that is, only the bits with the mask value of '1' are compared. + +Return: Boolean type, returning true upon success and false upon failure. + +Exception: org.davic.mpeg.sections.FilterResourceException – When this method is called, if the total number of section filters started by the parent filter group org.davic.mpeg.sections.SectionFilterGroup is equal to the number of section filters occupied when the filter group is created, this exception is thrown. This exception applies regardless of whether the parent filter group is associated with the TS stream; + +org.davic.mpeg.sections.IllegalFilterDefinitionException – If an illegal filter is defined, or the length of the parameter posFilterDef array and the posFilterMask array are inconsistent, or the length exceeds the system's ability to filter, this exception is thrown; + +org.davic.mpeg.NotAuthorizedException – If the section to be filtered is scrambled and has no descrambling permission, this exception is thrown; + +org.davic.mpeg.sections.ConnectionLostException – This exception is thrown if the parent filter group org.davic.mpeg.sections.SectionFilterGroup is in a state of losing connection due to lack of resources or when the section filter cannot complete the method call. + +##### **B.4.4.1.7 startFiltering** + +Prototype: public boolean startFiltering(java.lang.Object appData, int pid, int tableID, + +byte[] posFilterDef, byte[] posFilterMask, + +byte[] negFilterDef, byte[] negFilterMask) + +throws org.davic.mpeg.sections.FilterResourceException, +org.davic.mpeg.sections.IllegalFilterDefinitionException, +org.davic.mpeg.NotAuthorizedException, org.davic.mpeg.sections.ConnectionLostException + +Description: Start section filtering, filter out the section (section) carried in the transport packet specified by the pid parameter, and the table ID matches the tableID parameter, the section data matches the given byte filter, and the first byte of the filter byte array corresponds to the third byte of the section data. The parent filter group org.davic.mpeg.sections.SectionFilterGroup object must first be associated with the transport stream. If the following conditions are met, it means that the section data matches the given byte filter: + +$$\begin{aligned} &((\text{posFilterDef}[i] \& \text{posFilterMask}[i]) == (\text{section data } [3+i] \& \text{posFilterMask}[i])) \&\& \\ &((\text{negFilterDef}[i] \& \text{negFilterMask}[i]) \neq (\text{section data } [3+i] \& \text{negFilterMask}[i])) \end{aligned}$$ + +Parameter: appData – A java.lang.Object object, indicating the additional data object provided by the application, as a part of all filter event SectionFilterEvent objects generated by this method call, the object will be passed to the registered section filter event Listener, the application can use this object for internal communication between applications. If the application does not require any additional data, this parameter can be set to null; + +pid – Int type, indicating the transport stream packet identifier (TS\_PID) to be filtered; + +tableID – Int type, indicating the table ID (table\_id) to be filtered; + +posFilterDef – A byte array, indicating the value of bit matching in the section data; + +posFilterMask – A byte array, indicating the mask of bit matching in the section data, that is, only the bits with the mask value of '1' are compared; + +negFilterDef – A byte array, indicating the value of bit matching in the section data; + +negFilterMask – A byte array, indicating the mask of bit matching in the section data, that is, only the bits with the mask value of '1' are compared; + +Return: boolean type, returning true upon success and false upon failure. + +Exception: org.davic.mpeg.sections.FilterResourceException – When this method is called, if the total number of section filters started by the parent filter group org.davic.mpeg.sections.SectionFilterGroup is equal to the number of section filters occupied when the filter group is created, this exception is thrown. This exception applies regardless of whether the parent section filter group is associated with the TS stream; + +org.davic.mpeg.sections.IllegalFilterDefinitionException – If an illegal filter is defined, or the lengths of the parameter posFilterDef array and the posFilterMask array are inconsistent, or the length exceeds the system's ability to filter, this exception is thrown; + +org.davic.mpeg.NotAuthorizedException – If the section to be filtered is scrambled and has no descrambling permission, this exception is thrown; + +org.davic.mpeg.sections.ConnectionLostException – This exception is thrown if the parent filter group org.davic.mpeg.sections.SectionFilterGroup is in a state of losing connection due to lack of resources or when the section filter cannot complete the method call. + +##### **B.4.4.1.8 startFiltering** + +Prototype: public boolean startFiltering(java.lang.Object appData, int pid, int tableID, + +int offset, byte[] posFilterDef, byte[] posFilterMask) + +throws org.davic.mpeg.sections.FilterResourceException, +org.davic.mpeg.sections.IllegalFilterDefinitionException, +org.davic.mpeg.NotAuthorizedException, org.davic.mpeg.sections.ConnectionLostException + +Description: Start the section filtering, filter out the section (section) carried in the transport packet specified by the pid parameter, and the table ID matches the tableID parameter, the section data matches the given byte filter, and the offset of section data corresponding to the first byte of the filter byte array is specified by the parameter offset. The parent filter group org.davic.mpeg.sections.SectionFilterGroup object must first be associated with the transport stream. If the following conditions are met, it means that the section data matches the given byte filter: + +$$(\text{posFilterDef}[i] \& \text{posFilterMask}[i]) == (\text{section data} [\text{offset}+i] \& \text{posFilterMask}[i])$$ + +Parameter: appData – A java.lang.Object object, indicating the additional data object provided by the application, as a part of all the filter events org.davic.mpeg.sections.SectionFilterEvent objects generated by this method call, the object will be passed to the registered section filter event listener, and the application can use this object for internal communication between applications. If the application does not require any additional data, this parameter can be set to null; + +pid – Int type, indicating the transport stream packet identifier (TS\_PID) to be filtered; + +tableID – Int type, indicating the table ID (table\_id) to be filtered; + +offset – Int type, indicating the offset of the section data corresponding to the first byte of the filter byte array, the value is greater than or equal to 3 and less than 31; + +posFilterDef – A byte array, indicating the value of bit matching in the section data; + +posFilterMask – A byte array, indicating the mask of bit matching in the section data, that is, only the bits with the mask value of '1' are compared. + +Return: boolean type, returning true upon success and false upon failure. + +Exception: org.davic.mpeg.sections.FilterResourceException – When this method is called, if the total number of section filters started by the parent filter group org.davic.mpeg.sections.SectionFilterGroup is equal to the number of section filters occupied when the filter group is created, this exception is thrown. This exception applies regardless of whether the parent section filter group is associated with the TS stream; + +org.davic.mpeg.sections.IllegalFilterDefinitionException – If an illegal filter is defined, or the lengths of the parameter posFilterDef array and the posFilterMask array are inconsistent, or the length exceeds the system's ability to filter, this exception is thrown; + +org.davic.mpeg.NotAuthorizedException – If the section to be filtered is scrambled and has no descrambling permission, this exception is thrown; + +org.davic.mpeg.sections.ConnectionLostException – This exception is thrown if the parent filter group org.davic.mpeg.sections.SectionFilterGroup is in a state of losing connection due to lack of resources or when the section filter cannot complete the method call. + +##### **B.4.4.1.9 startFiltering** + +Prototype: public boolean startFiltering(java.lang.Object appData, + +int pid, int tableID, int offset, + +byte[] posFilterDef, byte[] posFilterMask, + +byte[] negFilterDef, byte[] negFilterMask) + +throws org.davic.mpeg.sections.FilterResourceException, +org.davic.mpeg.sections.IllegalFilterDefinitionException, + +org.davic.mpeg.NotAuthorizedException, org.davic.mpeg.sections.ConnectionLostException + +Description: Start section filtering, filter out the section (section) carried in the transport packet specified by the pid parameter, and the table ID matches the tableID parameter, the section data matches the given byte filter, and the offset of the section data corresponding to the first byte of the filter byte array is specified by the parameter offset. The parent filter group org.davic.mpeg.sections.SectionFilterGroup object must first be associated with the transport stream. If the following conditions are met, it means that the section data matches the given byte filter: + +((posFilterDef[i] & posFilterMask[i]) == (section data [offset+i] & posFilterMask[i])) && + +((negFilterDef[i] & negFilterMask[i]) != (section data [offset+i] & negFilterMask[i])) + +Parameter: appData – A java.lang.Object object, indicating additional data objects provided by the application, as a part of all the filter events org.davic.mpeg.sections.SectionFilterEvent objects generated by this method call, this object will be passed to the registered section filter event listener, and the application can use this object for internal communications between applications. + +If the application does not require any additional data, this parameter can be set to null; + +pid – Int type, indicating the transport stream packet identifier (TS\_PID) to be filtered; + +tableID – Int type, indicating the table ID (table\_id) to be filtered; + +offset – Int type, indicating the offset of the section data corresponding to the first byte of the filter byte array, the value is greater than or equal to 3 and less than 31; + +posFilterDef – A byte array, indicating the value of bit matching in the section data; + +posFilterMask – A byte array, indicating the mask of bit matching in the section data, that is, only the bits with the mask value of '1' are compared; + +negFilterDef – A byte array, indicating the value of bit matching in the section data; + +negFilterMask – A byte array, indicating the mask of bit matching in the section data, that is, only the bits with the mask value of '1' are compared; + +Return: boolean type, returning true upon success and false upon failure. + +Exception: org.davic.mpeg.sections.FilterResourceException – When calling this method, if the total number of section filters started by the parent filter group org.davic.mpeg.sections.SectionFilterGroup is equal to the number of section filters occupied when the filter group is created, this exception is thrown. This exception applies regardless of whether the parent filter group is associated with the TS stream; + +org.davic.mpeg.sections.IllegalFilterDefinitionException – If an illegal filter is defined, or the lengths of the parameter posFilterDef array and the posFilterMask array are inconsistent, or the length exceeds the system's ability to filter, this exception is thrown; + +org.davic.mpeg.NotAuthorizedException – If the section to be filtered is scrambled and has no descrambling permission, this exception is thrown; + +org.davic.mpeg.sections.ConnectionLostException – This exception is thrown if the parent filter group org.davic.mpeg.sections.SectionFilterGroup is in a state of losing connection due to lack of resources or when the section filter cannot complete the method call. + +##### **B.4.4.1.10 stopFiltering** + +Prototype: public boolean stopFiltering() + +Description: Stop section filtering. If the parent filter group org.davic.mpeg.sections.SectionFilterGroup object is connected to a transport stream, the section filtering that matches this filter object will stop. When using filters and filter groups, the order of function calling is: filter group attach, filter startFiltering, filter stopFiltering, filter group detach. If the filter has been stopped, calling stopFiltering again will directly return false. + +Parameter: boolean type, returning true upon success and false upon failure. + +Return: None. + +#### **B.4.5 Class org.davic.mpeg.sections.SimpleSectionFilter** + +Prototype: public class org.davic.mpeg.sections.SimpleSectionFilter extends org.davic.mpeg.sections.SectionFilter + +Description: Simple section filter class, inherits org.davic.mpeg.sections.SectionFilter class. Simple section filter: Only used once. When a section that matches the specified filter condition is found, the simple section filter stops filtering, as if the SectionFilter.stopFiltering() method was called. + +##### **B.4.5.1 Method** + +##### **B.4.5.1.1 getSection** + +Prototype: public Section getSection() throws + +org.davic.mpeg.sections.FilteringInterruptedException + +Description: Getting the section data filtered by this filter. The section obtained by this method describes the last MPEG-2 section that satisfies the filter condition. If the simple filter is filtering, this method is blocked until the end of the filtering. If the startFiltering() method is not called again during this period, and this method is called repeatedly, the same section object will be returned. Every time a new filtering operation is started, a new section object is generated. The old section object will be deleted unless the application maintains the old section object itself. All operations that access the previous section object will throw the Exception org.davic.mpeg.sections.NoDataAvailableException. + +Parameter: None. + +Return: None. + +Exception: org.davic.mpeg.sections.FilteringInterruptedException – If the filtering operation stops before the matching section is found, this exception is thrown. + +#### **B.4.6 Class org.davic.mpeg.sections.TableSectionFilter** + +Prototype: public class org.davic.mpeg.sections.TableSectionFilter extends org.davic.mpeg.sections.SectionFilter + +Description: Table section filter class, inherits org.davic.mpeg.sections.SectionFilter class. Table section filter: Receive complete tables with minimal application intervention. When the table section filter is activated, it will filter the first section that meets the given filter conditions. Once the section is found, the last\_section\_number field will be used to determine the number of section objects required to form the entire table. After the number of section objects is determined, the filter is restarted to receive all sections in the table. Each time a section is received, an org.davic.mpeg.sections.SectionAvailableEvent event will be generated. After receiving the entire table, the end of filtering org.davic.mpeg.sections.EndOfFilteringEvent event will be generated. The version numbers of all sections in the table should be the same. If the version number of a filtered section is different from the first section, an org.davic.mpeg.sections.VersionChangeDetectedEvent event will be generated, the newly captured section will be ignored, and the original version of the section will continue to be filtered. + +Note that when setting segment filtering parameters: If there are too many constraints, the filter cannot stop automatically; and if the constraints are too wide, the filter will produce inconsistent results (for example: use org.davic.mpeg.sections.TableSectionFilter to filter some sections). When the API finds that the filter parameters are not fully defined, which may result in filter blocking or MPEG-2 incompatibility, the org.davic.mpeg.sections.IncompleteFilteringEvent event will be generated to stop the filtering. + +##### **B.4.6.1 Method** + +##### **B.4.6.1.1 getSections** + +Prototype: public Section[] getSections() throws org.davic.mpeg.sections.FilteringInterruptedException + +Description: Getting all the section data of the table filtered by this filter. This method will return an array of all section objects of the table. The array elements are arranged according to the section number section\_number. If some sections have not been filtered until this method is called, the corresponding record in the array is set to null. If no sections are filtered out, this method is blocked until at least one section is obtained or the filtering ends. If the startFiltering() method is not called again in the meantime, and this method is called repeatedly, the same array will be returned. Every time a new filtering operation is started, an array of section objects is created. The old section array object will be deleted unless the application maintains the old section array object. All operations that access the previous section array object will throw exception org.davic.mpeg.sections.NoDataAvailableException. + +Parameter: None. + +Return: None. + +Exception: org.davic.mpeg.sections.FilteringInterruptedException – If the filtering operation stops before the matching section is found, this exception is thrown. + +#### **B.4.7 Class org.davic.mpeg.sections.RingSectionFilter** + +Prototype: public class org.davic.mpeg.sections.RingSectionFilter extends org.davic.mpeg.sections.SectionFilter + +Description: Ring section filter class, inherits org.davic.mpeg.sections.SectionFilter class. + +Ring section filter class: Once started, there is no need to stop and reset, it is used to capture continuous MPEG-2 section data. An org.davic.mpeg.sections.RingSectionFilter object has a predetermined number of section objects. The section data captured one after another will be loaded into these section objects in turn. Filtering will continue when there are empty section objects. If the application wants to filter continuously, it needs to use the setEmpty method of the Section object to mark the section object as empty before the new object arrives. If the filtering operation encounters a non-empty section object, it will stop. Each time startFiltering is called, the section will be filtered from the beginning of the array. When the ring section filter is created for the first time, all sections are set to empty, after which the application will clear them. Starting the ring section filter will no longer clear the section. + +##### **B.4.7.1 Method** + +##### **B.4.7.1.1 getSections** + +Prototype: public org.davic.mpeg.sections.Section[] getSections() + +Description: Getting all section data filtered by this filter. + +Parameter: None. + +Return: None. + +Return: An Org.davic.mpeg.sections.Section object array, indicating the section data filtered by this filter. + +Org.davic.mpeg.sections.Section object array is always full of data, and the application is responsible for checking which data is valid. + +Before the new filter data arrives, calling this method repeatedly will get the same result. + +#### **B.4.8 Event org.davic.mpeg.sections.SectionFilterEvent** + +Prototype: public class org.davic.mpeg.sections.SectionFilterEvent extends java.util.EventObject + +Description: Section filtering events, a group of base classes of section filtering events defined by this package. + +#### **B.4.8.1 Method** + +##### **B.4.8.1.1 getSource** + +Prototype: public java.lang.Object getSource() + +Description: Getting the SectionFilter object that generated this event. + +Rewrite: A getSource() method of the java.util.EventObject class. + +Parameter: None. + +Return: An org.davic.mpeg.sections.SectionFilter object, indicating the source for generating this event. + +##### **B.4.8.1.2 getAppData** + +Prototype: public java.lang.Object getAppData() + +Description: Getting the application data passed through the startFiltering() method of the SectionFilter object. + +Parameter: None. + +Return: A Java.lang.Object object, indicating additional application data. + +#### **B.4.9 Event org.davic.mpeg.sections.SectionAvailableEvent** + +Prototype: public class org.davic.mpeg.sections.SectionAvailableEvent + +extends org.davic.mpeg.sections.SectionFilterEvent + +Description: Section data available event, inherits the org.davic.mpeg.sections.SectionFilterEvent class, reports filtering to a complete section. When a section that meets the filter conditions is successfully filtered from the transport stream, the event is generated by the org.davic.mpeg.sections.SimpleSectionFilter, org.davic.mpeg.sections.TableSectionFilter or org.davic.mpeg.sections.RingSectionFilter object. + +#### **B.4.10 Event org.davic.mpeg.sections.VersionChangeDetectedEvent** + +Prototype: public class org.davic.mpeg.sections.VersionChangeDetectedEvent + +extends org.davic.mpeg.sections.SectionFilterEvent + +Description: A section filter version change event, inherits the org.davic.mpeg.sections.SectionFilterEvent class. This event is generated by org.davic.mpeg.sections.TableSectionFilter, reporting that the received section is inconsistent with the previous section version. This event can only be generated once per filtering operation. Sections with different versions will be discarded. + +##### **B.4.10.1 Method** + +##### **B.4.10.1.1 getOriginalVersion** + +Prototype: public int getOriginalVersion() + +Description: Getting the old version number of the section data. + +Parameter: None. + +Return: Int type, indicating the old version number of the section data. + +##### **B.4.10.1.2 getNewVersion** + +Prototype: public int getNewVersion() + +Description: Getting the new version number of the section data. + +Parameter: None. + +Return: Int type, indicating the new version number of the section data. + +#### **B.4.11 Event org.davic.mpeg.sections.EndOfFilteringEvent** + +Prototype: public class org.davic.mpeg.sections.EndOfFilteringEvent extends org.davic.mpeg.sections.SectionFilterEvent + +Description: Section filtering end event, inherits the org.davic.mpeg.sections.SectionFilterEvent class, reports the end of section filtering. When the filtering ends, the event is generated by the org.davic.mpeg.sections.RingSectionFilter and org.davic.mpeg.sections.TableSectionFilter objects. This event is not generated when the org.davic.mpeg.sections.SimpleSectionFilter filtering ends. + +#### **B.4.12 Event org.davic.mpeg.sections.IncompleteFilteringEvent** + +Prototype: public class org.davic.mpeg.sections.IncompleteFilteringEvent extends org.davic.mpeg.sections.EndOfFilteringEvent + +Description: Section filtering incomplete event, inherits org.davic.mpeg.sections.EndOfFilteringEvent class. It is used to report the end of the filtering operation generated by org.davic.mpeg.sections.TableSectionFilter. This event is generated when the API finds that the section parameters are not fully defined, which will result in blocking the filter or incompatibility with MPEG-2. + +#### **B.4.13 Event org.davic.mpeg.sections.TimeoutEvent** + +Prototype: public class org.davic.mpeg.sections.TimeoutEvent extends org.davic.mpeg.sections.EndOfFilteringEvent + +Description: Section filtering timeout event, inherits org.davic.mpeg.sections.EndOfFilteringEvent class. This event is generated when the section filtering operation times out. + +- For org.davic.mpeg.sections.SimpleSectionFilter, this event will be generated if the section data is not filtered within the specified time; +- For org.davic.mpeg.sections.TableSectionFilter, this event is generated if the entire table is not filtered within the specified time; +- For org.davic.mpeg.sections.RingSectionFilter, if the specified time is exceeded after the last section is successfully filtered, this event is generated. + +#### **B.4.14 Event org.davic.mpeg.sections.FilterResourcesAvailableEvent** + +Prototype: public class org.davic.mpeg.sections.FilterResourcesAvailableEvent extends org.davic.resources.ResourceStatusEvent + +Description: Filter resource available event, inherits the org.davic.resources.ResourceStatusEvent class. This event indicates that there are sufficient section filter resources for the section filter group. For example: if a section filter group is created with 4 filters, at least 4 filters are available when the event occurs. Note that they may no longer be available when the application tries to connect the section filter group again. Therefore, this event is a useful reminder for applications that try to connect to the section filter group again. This event only occurs after the org.davic.mpeg.sections.ForcedDisconnectedEvent event and before the application successfully connects to the section filter group again. + +#### **B.4.15 Event org.davic.mpeg.sections.ForcedDisconnectedEvent** + +Prototype: public class org.davic.mpeg.sections.ForcedDisconnectedEvent extends org.davic.resources.ResourceStatusEvent + +Description: Forced disconnected event between the section filter group and the transport stream inherits the org.davic.resources.ResourceStatusEvent class. Report that the previously available transport stream is no longer available, or the section filter resource has been removed from the connected section filter group. In the second case, in addition to generation of this event, a notifyRelease() method of org.davic.resources.ResourceClient is also called at the same time. + +##### **B.4.15.1 Method** + +##### **B.4.15.1.1 getSource** + +Prototype: public java.lang.Object getSource() + +Description: Getting org.davic.mpeg.sections.SectionFilterGroup object that generated the event. + +Rewrite: GetSource() method of the ResourceStatusEvent class. + +Return: A SectionFilterGroup object, indicating the section filter group that generated the event. + +#### **B.4.16 Exception org.davic.mpeg.sections.SectionFilterException** + +Prototype: public class org.davic.mpeg.sections.SectionFilterException extends java.lang.Exception + +Description: Section filter exception, a base class of a group of section filter exception defined by this package. + +#### **B.4.17 Exception org.davic.mpeg.sections.ConnectionLostException** + +Prototype: public class org.davic.mpeg.sections.ConnectionLostException extends org.davic.mpeg.sections.SectionFilterException + +Description: Connection loss exception, inherits org.davic.mpeg.sections.SectionFilterException class. This exception indicates that org.davic.mpeg.sections.SectionFilterGroup has lost connection or resources and cannot be called to the startFiltering() method. It is only generated by the SectionFilterGroup object in the lost connection state. + +#### **B.4.18 Exception org.davic.mpeg.sections.FilteringInterruptedException** + +Prototype: public class org.davic.mpeg.sections.FilteringInterruptedException extends org.davic.mpeg.sections.SectionFilterException + +Description: Filtering interrupted exception, inherits org.davic.mpeg.sections.SectionFilterException class. This exception indicates that the filtering operation was interrupted before the data was filtered. + +#### **B.4.19 Exception org.davic.mpeg.sections.FilterResourceException** + +Prototype: public class org.davic.mpeg.sections.FilterResourceException extends org.davic.mpeg.sections.SectionFilterException + +Description: Filter resource exception, inherits org.davic.mpeg.sections.SectionFilterException class. This exception indicates that when org.davic.mpeg.sections.SectionFilterGroup is in a connected or disconnected state, there are insufficient resources to complete the operation. + +#### **B.4.20 Exception org.davic.mpeg.sections.IllegalFilterDefinitionException** + +Prototype: public class org.davic.mpeg.sections.IllegalFilterDefinitionException extends org.davic.mpeg.sections.SectionFilterException + +Description: Illegal filter definition exception, inherits org.davic.mpeg.sections.SectionFilterException class. This exception indicates that the filter definition of the filter is invalid. + +#### **B.4.21 Exception org.davic.mpeg.sections.InvalidSourceException** + +Prototype: public class org.davic.mpeg.sections.InvalidSourceException extends org.davic.mpeg.sections.SectionFilterException + +Description: Section data source invalid exception, inherits org.davic.mpeg.sections.SectionFilterException class. + +#### **B.4.22 Exception org.davic.mpeg.sections.NoDataAvailableException** + +Prototype: public class org.davic.mpeg.sections.NoDataAvailableException extends org.davic.mpeg.sections.SectionFilterException + +Description: Section object no available data exception, inherits org.davic.mpeg.sections.SectionFilterException class. + +### **B.5 URL package module** + +URL package module provides URL package reference method. + +The summary of URL package module is shown in Table B.4. + +**Table B.4 – Summary of URL package module** + +| | | +|-------------------------|-----------------------------------------------------------------| +| Class | | +| Locator | Resource locator class, packages the URL into a locator object. | +| Exception | | +| InvalidLocatorException | Invalid locator exception. | + +#### **B.5.1 Class org.davic.net.Locator** + +Prototype: public class org.davic.net.Locator + +Description: Resource locator class, packages the URL into a locator object. + +##### **B.5.1.1 Method** + +###### **B.5.1.1.1 Locator** + +Prototype: public Locator(java.lang.String url) + +Description: Construction method creates a resource locator object. + +Parameter: url – A java.lang.String object, indicating a URL string. + +###### **B.5.1.1.2 hasMultipleTransformations** + +Prototype: public boolean hasMultipleTransformations() + +Description: Indicate whether this locator is mapped to multiple transport-related locator formats. + +Parameter: None. + +Return: Boolean type, true indicating this locator is mapped to multiple transport-related locator formats, false indicating No. + +##### **B.5.1.1.3 toExternalForm** + +Prototype: public abstract java.lang.String toExternalForm() + +Description: Getting the URL string corresponding to the locator. If a non-empty but invalid URL is used to create a locator instance, the behavior of the system depends on the specific implementation. + +Parameter: None. + +Return: A java.lang.String object, indicating the URL string corresponding to this locator. + +##### **B.5.1.1.4 toString** + +Prototype: public java.lang.String toString() + +Description: Getting URL string. + +Rewrite: A toString() method of the java.lang.Object class. + +Parameter: None. + +Return: A java.lang.String object, indicating a URL string. + +##### **B.5.1.1.5 equals** + +Prototype: public boolean equals(Object obj) + +Description: Determine whether the obj object is the same as this example. + +Rewrite: An equals() method of the Object class. + +Parameter: An Obj-Locator object, indicating the locator to be compared. + +Return: Boolean type, true value indicating that the obj object is the same as this instance, and false indicating that it is not the same. + +#### **B.5.2 Exception org.davic.net.InvalidLocatorException** + +Prototype: public class org.davic.net.InvalidLocatorException extends java.lang.Exception + +Description: Invalid locator exception. This exception is thrown when one or more parameters of the Locator object are invalid. + +### **B.6 DVB locator module** + +DVB locator module provides a reference method for accessing DVB broadcasting services and their contents. + +The summary of DVB locator module is shown in Table B.5. + +**Table B.5 – Summary of DVB locator module** + +| | | +|------------------------|----------------------------------------------------------------------------------------------------------------------| +| Class | | +| DvbLocator | DVB locator class, packages URL in DVB format into locator object. | +| DvbNetworkBoundLocator | DVB locator class bound to the network, this type of object uniquely identifies a given entity and transport system. | + +#### **B.6.1 Class org.davic.net.dvb.DvbLocator** + +Prototype: public class org.davic.net.dvb.DvbLocator extends org.davic.net.Locator + +Description: DVB locator class, packages URL in DVB format into locator object. + +##### **B.6.1.1 Method** + +##### **B.6.1.1.1 DvbLocator** + +Prototype: public DvbLocator(int onid, int tsid) throws Org.davic.net.InvalidLocatorException + +Description: Construction method creates a DVB locator object in the URL format "dvb://original\_network\_id.transport\_stream\_id". + +Parameter: onid – Int type, indicating an original network identifier (original\_network\_id); + +tsid – Int type, indicating a transport stream identifier (transport\_stream\_id). + +Exception: org.davic.net.InvalidLocatorException – If the parameter cannot identify a valid locator (for example, the value identifier is out of range), this exception is thrown. + +##### **B.6.1.1.2 DvbLocator** + +Prototype: public DvbLocator(int onid, int tsid, int serviceid) throws org.davic.net.InvalidLocatorException + +Description: Construction method creates a DVB locator object in the URL format "dvb://original\_network\_id.transport\_stream\_id.service\_id". + +Parameter: onid – Int type, indicating an original network identifier (original\_network\_id); + +tsid – Int type, indicating a transport stream identifier (transport\_stream\_id). If the value is -1, it means that the locator does not contain the transport stream identifier (transport\_stream\_id); + +serviceid – Int type, indicating a service identifier (service\_id). + +Exception: org.davic.net.InvalidLocatorException – If the parameter cannot identify a valid locator (for example, the value identifier is out of range), this exception is thrown. + +##### **B.6.1.1.3 DvbLocator** + +Prototype: public DvbLocator(int onid, int tsid, int serviceid, int eventid) + +throws org.davic.net.InvalidLocatorException + +Description: Construction method creates a DVB locator object in the URL format "dvb://original\_network\_id.transport\_stream\_id.service\_id;event\_id". + +Parameter: onid – Int type, indicating an original network identifier (original\_network\_id); + +tsid – Int type, indicating a transport stream identifier (transport\_stream\_id). If the value is -1, it means that the locator does not contain the transport stream identifier (transport\_stream\_id); + +serviceid – Int type, indicating a service identifier (service\_id); + +eventid – Int type, indicating an event identifier (event\_id). + +Exception: org.davic.net.InvalidLocatorException – If the parameter cannot identify a valid locator (for example, the value identifier is out of range), this exception is thrown. + +##### **B.6.1.1.4 DvbLocator** + +Prototype: public DvbLocator(int onid, int tsid, int serviceid, int eventid, int componenttag) + +throws org.davic.net.InvalidLocatorException + +Description: Construction method creates a DVB locator object in the "dvb://original\_network\_id.transport\_stream\_id.service\_id.component\_tag;eventid" or "dvb://original\_network\_id.transport\_stream\_id. + +service\_id.component\_tag" URL format. + +Parameter: onid – Int type, indicating an original network identifier (original\_network\_id); + +tsid – Int type, indicating a transport stream identifier (transport\_stream\_id). + +If the value is -1, it means that the locator does not contain the transport stream identifier (transport\_stream\_id); + +serviceid – Int type, indicating a service identifier (service\_id); + +eventid – Int type, indicating an event identifier (event\_id). If the value is -1, it means that the locator does not contain the event identifier (event\_id); + +componenttag – Int type, indicating an elementary stream component tag (component\_tag). + +Exception: org.davic.net.InvalidLocatorException – If the parameter cannot identify a valid locator (for example, the value identifier is out of range), this exception is thrown. + +##### **B.6.1.1.5 DvbLocator** + +Prototype: public DvbLocator(int onid, int tsid, int serviceid, + +int eventid, int[] componenttags) + +throws org.davic.net.InvalidLocatorException + +Description: Construction method creates a DVB locator object in the "dvb://original\_network\_id.transport\_stream\_id.service\_id.component\_tag{&component\_tag};event\_id" or "dvb://original\_network\_id.transport\_stream\_id.service\_id.component\_tag{&component\_tag}" URL format. + +Parameter: onid-Int type, indicating an original network identifier (original\_network\_id); + +tsid-Int type, indicating a transport stream identifier (transport\_stream\_id). If the value is -1, it means that the locator does not contain the transport stream identifier (transport\_stream\_id); + +serviceid – Int type, indicating a service identifier (service\_id); + +eventid – Int type, indicating an event identifier (event\_id). If the value is -1, it means that the locator does not contain the event identifier (event\_id); + +componenttags – An int type array, indicating an array of elementary stream component tags (component\_tag). + +Exception: org.davic.net.InvalidLocatorException – If the parameter cannot identify a valid locator (for example, the value identifier is out of range), this exception is thrown. + +##### **B.6.1.1.6 DvbLocator** + +Prototype: public DvbLocator(int onid, int tsid, int serviceid, int eventid, + +int[] componenttags, java.lang.String filePath) + +throws org.davic.net.InvalidLocatorException + +Description: Construction method creates a DVB locator object in the "dvb://original\_network\_id.transport\_stream\_id.service\_id.component\_tag{&component\_tag};event\_id/filepath" or "dvb://original\_network\_id.transport\_stream\_id.service\_id.component\_tag{&component\_tag}/filepath" URL format. + +Parameter: onid – Int type, indicating an original network identifier (original\_network\_id); + +tsid – Int type, indicating a transport stream identifier (transport\_stream\_id). If the value is -1, it means that the locator does not contain the transport stream identifier (transport\_stream\_id); + +serviceid – Int type, indicating a service identifier (service\_id); + +eventid – Int type, indicating an event identifier (event\_id). If the value is -1, it means that the locator does not contain the event identifier (event\_id); + +componenttags – An int type array, indicating an array of elementary stream component tags (component\_tag); + +filePath – A java.lang.String object, indicating the file path string, including the initial slash. + +Exception: org.davic.net.InvalidLocatorException – If the parameter cannot identify a valid locator (for example, the value identifier is out of range), this exception is thrown. + +###### **B.6.1.1.7 DvbLocator** + +Prototype: public DvbLocator(java.lang.String url) throws org.davic.net.InvalidLocatorException + +Description: Construction method creates a DVB locator object based on the input string. + +Parameter: url – A java.lang.String object, indicating a DVB URL string. + +Exception: org.davic.net.InvalidLocatorException – If the parameter cannot identify a valid locator (for example: the numerical identifier is out of range, does not conform to the DVB URL format, etc.), this exception is thrown. + +###### **B.6.1.1.8 getComponentTags** + +Prototype: public int[] getComponentTags() + +Description: Obtain an elementary stream component tag array information contained in the DVB locator. + +Parameter: None. + +Return: An int type array, indicating the array of elementary stream component tags, if the locator does not contain component tag information, the length of the array is 0. + +###### **B.6.1.1.9 getEventId** + +Prototype: public int getEventId() + +Description: Getting the event identifier information contained in the DVB locator. + +Parameter: None. + +Return: Int type, indicating an event identifier, if not, it returns -1. + +###### **B.6.1.1.10 getFilePath** + +Prototype: public java.lang.String getFilePath() + +Description: Getting the file name and path information contained in the DVB locator. + +Parameter: None. + +Return: A Java. Lang. string object, indicating a path string, including the beginning slash. If the locator has no path information, null is returned. + +##### **B.6.1.1.11 getOriginalNetworkId** + +Prototype: public int getOriginalNetworkId() + +Description: Getting an original network identifier information contained in the DVB locator. + +Parameter: None. + +Return: int type, indicating an original network identifier, if not, -1 is returned. + +###### **B.6.1.1.12 getTransportStreamId** + +Prototype: public int getTransportStreamId() + +Description: Getting a transport stream identifier information contained in the DVB locator. + +Parameter: None. + +Return: int type, indicating a transport stream identifier, if not, -1 is returned. + +##### **B.6.1.1.13 getServiceId** + +Prototype: public int getServiceId() + +Description: Getting the service identifier information contained in DVB locator. + +Parameter: None. + +Return: int type, indicating a service identifier, if not, -1 is returned. + +###### **B.6.1.1.14 toExternalForm** + +Prototype: public java.lang.String toExternalForm() + +Description: Getting the URL string corresponding to the locator. If a non-empty but invalid URL is used to create an instance of the locator, the behavior of the system depends on the specific implementation. Implement an toexternalform () method of the locator class. + +Parameter: None. + +Return: A java.lang.String object, indicating an URL string corresponding to this locator. + +#### **B.6.2 Class org.davic.net.dvb.DvbNetworkBoundLocator** + +Prototype: public class org.davic.net.dvb.DvbNetworkBoundLocator extends org.davic.net.DvbLocator + +Description: DVB locator class bound to network, uniquely identifies a given entity and transport system. For example, a service may be transported in satellite and ground network, dvblocator object may be the same, but dvbnetworkboundlocator object is different. + +##### **B.6.2.1 Method** + +###### **B.6.2.1.1 DvbNetworkBoundLocator** + +Prototype: public DvbNetworkBoundLocator(org.davic.net.dvb.DvbLocator unboundLocator, int networkId) + +throws org.davic.net.InvalidLocatorException + +Description: Construct method creates a DVB locator object bound to the network. + +Parameter: unboundLocator – An org.davic.net.dvb.dvblocator object, indicating a DVB locator not bound with the transport network; + +networkId – int type, indicating network identifier. + +Exception: org.davic.net.InvalidLocatorException – If the parameter cannot identify a valid locator (for example, the numeric identifier is out of range), this exception is thrown. + +###### **B.6.2.1.2 getNetworkId** + +Prototype: public int getNetworkId() + +Description: Getting a network identifier. + +Parameter: None. + +Return: int type, indicating network identifier. + +### **B.7 Broadcast protocol processing module** + +The broadcast protocol processing module defines the java interface related to DVB broadcast protocol processing. + +See Table B.6 for the summary of broadcast protocol processing module. + +**Table B.6 – Summary of the broadcast protocol processing module** + +| Interface | | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SICommonInformation | A PSI / Si public information interface, providing a method to obtain psi / Si public features. | +| SINetwork | A network information interface, providing a method to obtain a network information. Each SINetwork object is uniquely identified by the network_ID. | +| SIBouquet | A service group information interface, providing a method to obtain the information of the service group (bouquet). Each SIBouquet object is uniquely identified by the network_id, bouquet_id. | + +**Table B.6 – Summary of the broadcast protocol processing module** + +| | | +|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SIService | A service information interface, providing a method to obtain the service information. Each SIService object is uniquely identified by the network_id, original_network_id, transport_stream_id and service_id. | +| SIEvent | A program event information interface, providing a method to obtain the event information. Each SIEvent object is common uniquely identified by network_id, original_network_id, transport_stream_id, service_id and event_id. | +| SITransportStream | A transport stream information interface, providing a method to obtain transport stream information, each SITransportStream object is common uniquely identified by network_id, original_network_id and transport_stream_id. | +| SIElementaryStream | An elementary stream information interface, providing a method to obtain elementary stream information, each SIElementaryStream object is common uniquely identified by network_id, original_network_id, transport_stream_id, service_id and component_tag(or elementary_PID). | +| SITime | A time information interface, providing a method to obtain time information. The time information is obtained from TDT or TOT, each SITime object is uniquely identified by network_id. | +| SIDescriptor | A Descriptor information interface, providing a method related to descriptor access. | +| SIRequest | PSI / Si information request interface, describes a PSI / SI information retrieval request generated by the application, the application can cancel the request through this object. | +| SIRetrieveListener | SI information acquisition event listener is implemented by application program. | +| SIUpdateListener | PSI / SI table update event listener is implemented by application program. | +| SIDescriptorTag | Descriptors tag constant definition interface, values see GB / T 28161-2011. | +| SIRunningStatus | For the definition interface of running state constant of broadcasting service or event, please refer to GB / T 28161-2011. | +| SIServiceType | Service type constant definition interface, see GB / T 28161-2011 for values. | +| SIStreamType | For the definition interface of stream type constant, see GB / T 17975.1-2010 for values. | +| Class | | +| SIDatabase | A PSI / SI information database, providing a management and operation method of PSI / SI information database in DVB mode. It is the entry class for application to obtain PSI / SI information. | +| SIRequestFailureType | The reason why the PSI / SI information request failed. | +| Event | | +| SIRetrieveEvent | PSI / SI information request event is the base class of a group of events related to PSI / SI information request defined in this package. One PSI / SI information request will only generate one such event. | +| SISuccessRetrieveEvent | PSI / SI information request success event inherits SIRetrieveEvent class. | +| SIFailureRetrieveEvent | PSI / SI information request failure event inherits SIRetrieveEvent class. | +| SIUpdateEvent | PSI/SI table update event. | +| Exception | | +| InvalidPeriodException | This exception is thrown when the specified date is invalid. | + +#### **B.7.1 Interface org.ngb.broadcast.dvb.si.SICommonInformation** + +Prototype: public interface org.ngb.broadcast.dvb.si.SICommonInformation + +Description: A PSI / SI public information interface, providing a method to obtain PSI / SI public features. + +###### **B.7.1.1 Constant field – PSI / SI object type** + +#### **B.7.1.1.1 SI\_BOUQUET** + +Prototype: public static final int SI\_BOUQUET = 0 + +Description: SI information identification – Service group information. + +#### **B.7.1.1.2 SI\_NETWORK** + +Prototype: public static final int SI\_NETWORK = 1 + +Description: SI information identification – Network information. + +#### **B.7.1.1.3 SI\_SERVICE** + +Prototype: public static final int SI\_SERVICE = 2 + +Description: SI information identification – Service information. + +#### **B.7.1.1.4 SI\_TS** + +Prototype: public static final int SI\_TS = 3 + +Description: SI information identification – Transport stream (TS) information. + +#### **B.7.1.1.5 SI\_ES** + +Prototype: public static final int SI\_ES = 4 + +Description: SI information identification – Elementary stream (ES) information. + +#### **B.7.1.1.6 SI\_EVENT** + +Prototype: public static final int SI\_EVENT = 5 + +Description: SI information identification – Event (event) information. + +#### **B.7.1.1.7 SI\_TIME** + +Prototype: public static final int SI\_TIME = 6 + +Description: SI information identification – Time information. + +### **B.7.1.2 Method** + +#### **B.7.1.2.1 getType** + +Prototype: public int getType() + +Description: Getting SI object type that implements this interface. + +Parameter: None. + +Return: Int type, indicating SI object type that implements this interface. For the value, please refer to the "PSI/SI Object Type" constant field definition of the org.ngb.broadcast.dvb.si.SICommonInformation interface. + +#### **B.7.1.2.2 getSIDatabase** + +Prototype: public org.ngb.broadcast.dvb.si.SIDatabase getSIDatabase() + +Description: Getting PSI/SI database to which the SI object implementing this interface belongs. + +Parameter: None. + +Return: An SIDatabase object, indicating PSI/SI database to which the SI object implementing this interface belongs. + +## **B.7.2 Interface org.ngb.broadcast.dvb.si.SINetwork** + +Prototype: public interface org.ngb.broadcast.dvb.si.SINetwork + +extends org.ngb.broadcast.dvb.si.SICommonInformation + +Description: A Network information interface, providing a method for obtaining network information. Each SINetwork object is uniquely identified by network\_id. The receiving terminal may access multiple broadcast networks at the same time, for example, access to the national standard terrestrial wireless network and wired network at the same time, and distinguish network objects by network\_id. + +### **B.7.2.1 Method** + +#### **B.7.2.1.1 getNetworkID** + +Prototype: public int getNetworkID() + +Description: Getting network identifier (ie the network\_id field of the NIT). + +Parameter: None. + +Return: Int type, indicating the unique identifier (network\_id) of the unidirectional broadcast network object. + +#### **B.7.2.1.2 getNetworkName** + +Prototype: public java.lang.String getNetworkName() + +Description: Getting the full name of the network. + +Return: A java.lang.String object, indicating the network name. + +#### **B.7.2.1.3 getShortNetworkName** + +Prototype: public java.lang.String getShortNetworkName() + +Description: Getting abbreviation of the network name. + +Return: A java.lang.String object, indicating the abbreviation of the network name, or null is returned if there is no abbreviation of the network name. + +Example: "[0x86]Asterix[0x87] Digital Satellite TV Network" + +Full name of the network: "Asterix Digital Satellite TV Network". + +Abbreviation of the network name: "Asterix". + +#### **B.7.2.1.4 getServicesLocators** + +Prototype: public org.ngb.broadcast.dvb.si.DvbNetworkBoundLocator[] getServicesLocators() + +Description: Obtain locators of all services belonging to the network. + +Parameter: None. + +Return: An org.davic.net.dvb.DvbNetworkBoundLocator object array, indicating locators of all services under the network. If not, the length of the returned array is 0. + +#### **B.7.2.1.5 getService** + +Prototype: public org.ngb.broadcast.dvb.si.SIService getService +(org.davic.net.dvb.DvbLocator locator) + +Description: According to the specified service locator, the service objects belonging to the network are obtained. + +Parameter: locator – An org.davic.net.dvb.DvbLocator object, indicating the locator of the service. + +Return: An org.davic.net.dvb.si.SIService object, indicating the service object under the network. + +### **B.7.3 Interface org.ngb.broadcast.dvb.si.SIBouquet** + +Prototype: public interface org.ngb.broadcast.dvb.si.SIBouquet extends +org.ngb.broadcast.dvb.si.SICommonInformation + +Description: Service group (bouquet) information interface, each org.ngb.broadcast.dvb.si.SIBouquet object is uniquely identified by network\_id and bouquet\_id, that is, if service groups with the same bouquet\_id appear in multiple networks, this specification stipulates that multiple org.ngb.broadcast.dvb.si.SIBouquet object instances should be created for such service groups, and they are distinguished by network\_id. + +#### **B.7.3.1 Method** + +##### **B.7.3.1.1 getNetwork** + +Prototype: public org.ngb.broadcast.dvb.si.SINetwork getNetwork() + +Description: Getting the network of this org.ngb.broadcast.dvb.si.sibouquet object. + +Parameter: None. + +Return: An org.ngb.broadcast.dvb.si.SINetwork object, indicating the network instance to which the org.ngb.broadcast.dvb.si.sibouquet object belongs. + +##### **B.7.3.1.2 getNetworkID** + +Prototype: public int getNetworkID() + +Description: Getting network identifier to which the service group belongs. + +Parameter: None. + +Return: Int type, indicating the network identifier (network\_id). + +##### **B.7.3.1.3 getBouquetID** + +Prototype: public int getBouquetID() + +Description: Obtain a service group identifier (that is, the bouquet\_id field of the BAT table). + +Parameter: None. + +Return: Int type, indicating the service group identifier (bouquet\_id). + +##### **B.7.3.1.4 getBouquetName** + +Prototype: public java.lang.String getBouquetName() + +Description: Getting the full name of the service group. + +Parameter: None. + +Return: A java.lang.String object, indicating the name of the service group. If no information is available, null will be returned. + +#### **B.7.3.1.5 getShortBouquetName** + +Prototype: public java.lang.String getShortBouquetName() + +Description: Getting short name of the service group. + +Parameter: None. + +Return: A Java.lang.String object, indicating the short name of the service group. If the short name of the service group does not exist, null will be returned. + +#### **B.7.3.1.6 getService** + +Prototype: public SIService getService(org.davic.net.dvb.DvbLocator locator) + +Description: According to the specified service locator, obtain the specified service in the service group. + +Parameter: locator – An org.davic.net.dvb.DvbLocator object, indicating the locator of the specified service. + +Return: An SIService object, indicating the service object under the service group. If it does not exist, it returns null. + +#### **B.7.3.1.7 getServicesLocators** + +Prototype: public DvbNetworkBoundLocator[] getServicesLocators() + +Description: Obtain the locators of all services belonging to the service group. + +Parameter: None. + +Return: An org.davic.net.dvb.DvbNetworkBoundLocator object array, indicating the locators of all services under the service group. If not, the length of the returned array is 0. + +### **B.7.4 Interface org.ngb.broadcast.dvb.si.SIService** + +Prototype: public interface org.ngb.broadcast.dvb.si.SIService extends org.ngb.broadcast.dvb.si.SICommonInformation + +Description: Service information interface, each org.ngb.broadcast.dvb.si.SIService object is common uniquely identified by the four elements of network\_id, original\_network\_id, transport\_stream\_id and service\_id. In the same network, an org.ngb.broadcast.dvb.si.SIService object is uniquely determined by the three elements of original\_network\_id, transport\_stream\_id, and service\_id. However, a service may belong to multiple networks. This specification stipulates that multiple org.ngb.broadcast.dvb.si.SIService objects should be created for such services and are distinguished by network\_id, that is, in the application scenario of receiving multiple network signals, four elements are used to uniquely determine a service. + +#### **B.7.4.1 Method** + +##### **B.7.4.1.1 getServiceName** + +Prototype: public java.lang.String getServiceName() + +Description: Getting the full name of the service. + +Parameter: None. + +Return: A Java.lang.String object, indicating the service name, if no information is available, null is returned. + +##### **B.7.4.1.2 getShortServiceName** + +Prototype: public java.lang.String getShortServiceName() + +Description: Getting abbreviation of the service name. + +Parameter: None. + +Return: A Java.lang.String object, indicating the abbreviation of the service name. If the abbreviation of the service name does not exist, null is returned. + +Example: The [0x86]P[0x87]ay [0x86]M[0x87]ovie [0x86]C[0x87]hannel + +Full name of the service – "The Pay Movie Channel". + +Abbreviation of the service name – "PMC". + +#### **B.7.4.1.3 getServiceProviderName** + +Prototype: public java.lang.String getServiceProviderName() + +Description: Getting full name of the service provider. + +Parameter: None. + +Return: A Java.lang.String object, indicating the name of the broadcast service provider. If no information is available, null will be returned. + +#### **B.7.4.1.4 getShortServiceProviderName** + +Prototype: public java.lang.String getShortServiceProviderName() + +Description: Getting abbreviation of the service provider. + +Parameter: None. + +Return: A Java.lang.String object, indicating the abbreviation of the service provider's name. If there is no abbreviation information, null will be returned. + +#### **B.7.4.1.5 getServiceType** + +Prototype: public int getServiceType() + +Description: Obtain the broadcast service type (service\_type) from the service\_descriptor descriptor in the SDT table. + +Parameter: None. + +Return: Short type, indicating the broadcast service type. For the value, see the "Service Type" constant field definition of the SIServiceType interface. + +#### **B.7.4.1.6 getChannelNumber** + +Prototype: public int getChannelNumber() + +Description: Getting a logical channel number of the service. The method of obtaining the logical channel number is determined by the system (depending on the operator). + +Parameter: None. + +Return: Int type, indicating the logical channel number of the service. + +NOTE – The logical channel number is unique in the same network. + +#### **B.7.4.1.7 getDvbLocator** + +Prototype: public org.davic.net.dvb.DvbNetworkBoundLocator getDvbLocator() + +Description: Getting a locator of the service object. + +Parameter: None. + +Return: An org.davic.net.dvb.DvbNetworkBoundLocator object, indicating the locator of this service object. + +#### **B.7.4.1.8 getNetworkID** + +Prototype: public int getNetworkID() + +Description: Getting the network identifier to which the service object belongs. + +Parameter: None. + +Return: Int type, indicating the network identifier (network\_id). + +#### **B.7.4.1.9 getOriginalNetworkID** + +Prototype: public int getOriginalNetworkID() + +Description: Getting the original network identifier to which the service object belongs. + +Parameter: None. + +Return: Int type, indicating the original network identifier to which the service object belongs. + +#### **B.7.4.1.10 getTransportStreamID** + +Prototype: public int getTransportStreamID() + +Description: Getting a transport stream identifier to which the service object belongs. + +Parameter: None. + +Return: Int type, indicating the transport stream identifier to which the service object belongs. + +#### **B.7.4.1.11 getServiceID** + +Prototype: public int getServiceID() + +Description: Getting the service identifier. + +Parameter: None. + +Return: Int type, indicating the service identifier. + +#### **B.7.4.1.12 getNetwork** + +Prototype: public org.ngb.broadcast.dvb.si.SINetwork getNetwork() + +Description: Getting SINetwork object to which this org.ngb.broadcast.dvb.si.SIService object belongs. + +Parameter: None. + +Return: An SINetwork object, indicating the SINetwork object to which this SIService object belongs. + +#### **B.7.4.1.13 getTransportStream** + +Prototype: public org.ngb.broadcast.dvb.si.SITransportStream getTransportStream() + +Description: Getting org.ngb.broadcast.dvb.si.SITransportStream object to which this org.ngb.broadcast.dvb.si.SIService object belongs. + +Parameter: None. + +Return: An org.ngb.broadcast.dvb.si.SITransportStream object, indicating this org.ngb.broadcast.dvb.si.SITransportStream object to which the org.ngb.broadcast.dvb.si.SIService object belongs. + +#### **B.7.4.1.14 getBouquets** + +Prototype: public org.ngb.broadcast.dvb.si.SIBouquet[] getBouquets() + +Description: Getting all org.ngb.broadcast.dvb.si.SIBouquet objects to which this org.ngb.broadcast.dvb.si.SIService object belongs. + +Parameter: None. + +Return: An org.ngb.broadcast.dvb.si.SIBouquet object array, indicating all org.ngb.broadcast.dvb.si.SIBouquet objects to which this org.ngb.broadcast.dvb.si.SIService object belongs. + +#### **B.7.4.1.15 getFreeCAMode** + +Prototype: public boolean getFreeCAMode() + +Description: Obtain the free\_CA\_mode flag from the SDT table. + +Parameter: None. + +Return: Boolean type, indicating the free\_CA\_mode flag, true value indicating that the service is scrambled and the receiving is controlled by the CA; false value indicating that the service is not scrambled and the receiving is free. + +#### **B.7.4.1.16 getPcrPID** + +Prototype: public int getPcrPID() + +Description: Obtain the TS\_PID of the PCR referenced by the service (that is, the PCR\_PID field carried by the PMT). + +Parameter: None. + +Return: Int type, indicating the PCR\_PID of the broadcast service. + +#### **B.7.4.1.17 getEITPresentFollowingFlag** + +Prototype: public boolean getEITPresentFollowingFlag() + +Description: Obtain the EIT\_present\_following\_flag flag from the SDT table. + +Parameter: None. + +Return: Boolean type, indicating the EIT\_present\_following\_flag flag, true value indicating that the service has current/follow-up information of EIT, and false value indicating that the service has no current/follow-up information of EIT. + +#### **B.7.4.1.18 getEITScheduleFlag** + +Prototype: public boolean getEITScheduleFlag() + +Description: Obtain the EIT\_schedule\_flag flag from the SDT table. + +Parameter: None. + +Return: Boolean type, indicating the EIT\_schedule\_flag flag, true value indicating that the service has EIT schedule information, and false value indicating that the service does not have EIT schedule information. + +#### **B.7.4.1.19 retrieveElementaryStreams** + +Prototype: public SIRequest retrieveElementaryStreams(java.lang.Object appData, org.ngb.broadcast.dvb.si.SIRetrieveListener listener, short[] someDescriptorTags) + +throws java.lang.IllegalArgumentException + +Description: An Asynchronous method, obtaining the elementary stream information contained in the broadcast service. + +- When the interface successfully completes the acquisition action, it will send an org.ngb.broadcast.dvb.si.SISuccessRetrieveEvent event to the listener, and return an array of org.ngb.broadcast.dvb.si.SICommonInformation objects through the getResult() method of the event object, from this array, all retrieved elementary stream objects (SIElementaryStream) can be obtained; +- If the elementary stream object that meets the conditions is not retrieved, the org.ngb.broadcast.dvb.si.SIFailureRetrieveEvent event should be sent to the listener, and the failure reason org.ngb.broadcast.dvb.si.SIRequestFailureType can be obtained from the event object. + +Parameter: appData – A java.lang.Object object, indicating additional information provided by the application. When the retrieval action is completed, this object will be passed to the listening interface by the system. The application can use this object for internal communication. If the application does not require any additional information, this parameter can be set to null; + +listener – An org.ngb.broadcast.dvb.si.SIRetrieveListener object, is used to receive retrieval notification events; + +someDescriptorTags – A Short type array, indicating a set of tag values of descriptors that the application cares about. The interface should retrieve all descriptor information that the application cares about, represented by an org.ngb.broadcast.dvb.si.SIDescriptor object. + +- If the array contains only one element and the value is -1, it indicates that the application cares about all the descriptors in the PMT table; +- If the array object is null, it indicates that the application does not care about any descriptors. + +Return: An SIRequest object, indicating an information retrieval request session. + +Exception: java.lang.IllegalArgumentException – If the input parameter is invalid, the exception is thrown. + +## **B.7.5 Interface org.ngb.broadcast.dvb.si.SITransportStream** + +Prototype: public interface org.ngb.broadcast.dvb.si.SITransportStream extends org.ngb.broadcast.dvb.si.SICommonInformation + +Description: Transport stream (transport\_stream) information interface. Each org.ngb.broadcast.dvb.si.SITransportStream object is uniquely determined by network\_id, original\_network\_id and transport\_stream\_id. In the same network, the transport stream is uniquely determined by both original\_network\_id and transport\_stream\_id; However, a transport stream may be transmitted on multiple networks. This specification stipulates that multiple org.ngb.broadcast.dvb.si.SITransportStream instances should be created for such transport stream and are distinguished by network\_id, that is, in application scenarios in which multiple network signals are received, an org.ngb.broadcast.dvb.si.SITransportStream object is uniquely determined through network\_id, original\_network\_id, and transport\_stream\_id. + +### **B.7.5.1 Method** + +#### **B.7.5.1.1 getNetworkID** + +Prototype: public int getNetworkID() + +Description: Getting a network identifier to which the transport stream object belongs. + +Parameter: None. + +Return: Int type, indicating the network identifier to which the transport stream object belongs. + +#### **B.7.5.1.2 getOriginalNetworkID** + +Prototype: public int getOriginalNetworkID() + +Description: Getting an original network identifier to which the SI object implementing the interface belongs. + +Parameter: None. + +Return: Int type, indicating the original network identifier to which the SI object that implements the interface belongs. + +#### **B.7.5.1.3 getTransportStreamID** + +Prototype: public int getTransportStreamID() + +Description: Getting the transport stream identifier to which the SI object that implements the interface belongs. + +Parameter: None. + +Return: Int type, indicating the transport stream identifier to which the SI object that implements the interface belongs. + +#### **B.7.5.1.4 getNetwork** + +Prototype: public org.ngb.broadcast.dvb.si.SINetwork getNetwork() + +Description: Getting SINetwork object to which this org.ngb.broadcast.dvb.si.SITransportStream object belongs. + +Parameter: None. + +Return: An org.ngb.broadcast.dvb.si.SINetwork object, indicating the SINetwork object to which this org.ngb.broadcast.dvb.si.SITransportStream object belongs. + +### **B.7.6 Interface org.ngb.broadcast.dvb.si.SIElementaryStream** + +Prototype: public interface org.ngb.broadcast.dvb.si.SIElementaryStream extends org.ngb.broadcast.dvb.si.SICommonInformation + +Description: Elementary stream (elementary\_stream) information interface of the broadcast service. Each org.ngb.broadcast.dvb.si.SIElementaryStream object is uniquely determined by the network\_id, original\_network\_id, transport\_stream\_id, service\_id, and component\_tag (or elementary\_PID) identifiers. An elementary stream may belong to multiple services. This specification stipulates that multiple org.ngb.broadcast.dvb.si.SIElementaryStream objects should be created for such elementary stream, it is jointly and uniquely determined by network\_id, original\_network\_id, transport\_stream\_id, service\_id and component\_tag (or elementary\_PID). + +#### **B.7.6.1 Method** + +##### **B.7.6.1.1 getComponentTag** + +Prototype: public byte getComponentTag() + +Description: Getting a tag of the elementary stream component. + +Parameter: None. + +Return: Byte type, indicating the elementary stream component tag. If the elementary stream does not carry stream\_identifier\_descriptor, its component tag value defaults to -2. + +#### **B.7.6.1.2 getElementaryPID** + +Prototype: public short getElementaryPID() + +Description: Obtain the transport stream packet identifier (TS\_PID) that carries the elementary stream. + +Parameter: None. + +Return: Short type, indicating the transport stream packet identifier that carries the elementary stream. + +#### **B.7.6.1.3 getNetworkID** + +Prototype: public int getNetworkID() + +Description: Getting the network identifier to which the elementary stream object belongs. + +Parameter: None. + +Return: Int type, indicating the network identifier (network\_id). + +#### **B.7.6.1.4 getOriginalNetworkID** + +Prototype: public int getOriginalNetworkID() + +Description: Getting an original network identifier to which the elementary stream object belongs. + +Parameter: None. + +Return: Int type, indicating the original network identifier to which the elementary stream object that implements the interface belongs. + +#### **B.7.6.1.5 getTransportStreamID** + +Prototype: public int getTransportStreamID() + +Description: Getting the transport stream identifier to which the elementary stream object belongs. + +Parameter: None. + +Return: Int type, indicating the transport stream identifier to which the elementary stream object belongs. + +#### **B.7.6.1.6 getServiceID** + +Prototype: public int getServiceID() + +Description: Getting the service identifier to which the elementary stream object belongs. + +Parameter: None. + +Return: Int type, indicating the service identifier to which the elementary stream object belongs. + +#### **B.7.6.1.7 getStreamType** + +Prototype: public byte getStreamType() + +Description: Getting the elementary stream type. + +Parameter: None. + +Return: Byte type, indicating the elementary stream type. For the value, see the stream type constant field definition of the org.ngb.broadcast.dvb.si.SIStreamType interface. + +#### **B.7.6.1.8 getService** + +Prototype: public SIService getService() + +Description: Getting the org.ngb.broadcast.dvb.si.SIService object to which this org.ngb.broadcast.dvb.si.SIElementaryStream object belongs. + +Parameter: None. + +Return: An org.ngb.broadcast.dvb.si.SIService object, indicating the SIService object to which this org.ngb.broadcast.dvb.si.SIElementaryStream object belongs. + +## **B.7.7 Interface org.ngb.broadcast.dvb.si.SIEvent** + +Prototype: public interface org.ngb.broadcast.dvb.si.SIEvent +extends org.ngb.broadcast.dvb.si.SICommonInformation + +Description: Program event information interface, each org.ngb.broadcast.dvb.si.SIEvent object is uniquely identified by network\_id, original\_network\_id, transport\_stream\_id, service\_id, and event\_id. A program event may belong to multiple services. This specification stipulates that multiple org.ngb.broadcast.dvb.si.SIEvent objects should be created for such a program event, it is uniquely identified by network\_id, original\_network\_id, transport\_stream\_id, service\_id, and event\_id. + +### **B.7.7.1 Method** + +#### **B.7.7.1.1 getNetworkID** + +Prototype: public int getNetworkID() + +Description: Getting the network identifier to which the elementary stream object belongs. + +Parameter: None. + +Return: Int type, indicating the network identifier (network\_id). + +#### **B.7.7.1.2 getOriginalNetworkID** + +Prototype: public int getOriginalNetworkID() + +Description: Getting the original network identifier to which the event object belongs. + +Parameter: None. + +Return: Int type, indicating the original network identifier to which the event object belongs. + +#### **B.7.7.1.3 getTransportStreamID** + +Prototype: public int getTransportStreamID() + +Description: Getting the transport stream identifier to which the event object belongs. + +Parameter: None. + +Return: Int type, indicating the transport stream identifier to which the event object belongs. + +#### **B.7.7.1.4 getServiceID** + +Prototype: public int getServiceID() + +Description: Getting the service identifier to which the event object belongs. + +Parameter: None. + +Return: Int type, indicating the service identifier to which the event object belongs. + +#### **B.7.7.1.5 getEventID** + +Prototype: public int getEventID() + +Description: Getting the event identifier. + +Parameter: None. + +Return: Int type, indicating the event identifier. + +#### **B.7.7.1.6 getDvbLocator** + +Prototype: public org.davic.net.dvb.DvbNetworkBoundLocator getDvbLocator() + +Description: Getting the locator of the event object. + +Parameter: None. + +Return: An org.davic.net.dvb.DvbNetworkBoundLocator object, indicating the locator of the event object. + +#### **B.7.7.1.7 getService** + +Prototype: public org.ngb.broadcast.dvb.si.SIService getService() + +Description: Getting the org.ngb.broadcast.dvb.si.SIService object to which this org.ngb.broadcast.dvb.si.SIEvent object belongs. + +Parameter: None. + +Return: An org.ngb.broadcast.dvb.si.SIService object, indicating the org.ngb.broadcast.dvb.si.SIService object to which this org.ngb.broadcast.dvb.si.SIEvent object belongs. + +#### **B.7.7.1.8 getNibbles** + +Prototype: public byte[] getNibbles() + +Description: Getting the program content classification information, which comes from the content descriptor (content\_descriptor) in the EIT. + +Parameter: None. + +Return: Byte type array, indicating the content classification information associated with this program event. If the content descriptor (content\_descriptor) does not exist, null is returned. + +- byte[0] – The upper 4 bits represent the second-level content classification (content\_nibble\_level\_2); the lower 4 bits represent the first-level content classification (content\_nibble\_level\_1); +- byte[1] – The upper 4 bits represent the second-level custom classification (user\_nibble\_level\_2); the lower 4 bits represent the first-level custom classification (user\_nibble\_level\_1). + +#### **B.7.7.1.9 getStartTime** + +Prototype: public java.util.Date getStartTime() + +Description: Getting the start time of the event. + +Parameter: None. + +Return: A java.util.Date object, indicating the start time of the broadcast program event. + +#### **B.7.7.1.10 getDuration** + +Prototype: public long getDuration() + +Description: Getting the duration of the event. + +Parameter: None. + +Return: Long type, indicating the duration of the event, in seconds. + +#### **B.7.7.1.11 getEndTime** + +Prototype: public Date getEndTime() + +Description: Getting the end time of the event. + +Parameter: None. + +Return: Java.util.Date object, indicating the end time of the event. + +#### **B.7.7.1.12 getEventName** + +Prototype: String getEventName() + +Description: Getting the full name of the event (event\_name). + +Parameter: None. + +Return: Java.lang.String object, indicating the full name of the event. + +#### **B.7.7.1.13 getShortEventName** + +Prototype: public java.lang.String getShortEventName() + +Description: Getting the abbreviation of the event name. + +Parameter: None. + +Return: Java.lang.String object, indicates the abbreviation of the event name. If there is no abbreviation information, null is returned. + +#### **B.7.7.1.14 getEventDescription** + +Prototype: public java.lang.String getEventDescription() + +Description: Getting the description of the event. + +Parameter: None. + +Return: Java.lang.String object, indicates the description of the event. + +#### **B.7.7.1.15 getFreeCAMode** + +Prototype: public boolean getFreeCAMode() + +Description: Getting the scrambling flag (free\_CA\_mode) of the broadcast program event. + +Parameter: None. + +Return: Boolean type, indicating whether the broadcast program event is scrambled, true value indicating that the event is scrambled and receiving is controlled by CA; false value indicating that it is not scrambled and can be received freely. + +#### **B.7.7.1.16 getRunningStatus** + +Prototype: public byte getRunningStatus() + +Description: Getting the running status information of the event. + +Parameter: None. + +Return: Byte type, indicating the running status of the event, for the value, please refer to the "running status" constant field definition of the org.ngb.broadcast.dvb.si.SIRunningStatus interface. + +### **B.7.8 Interface org.ngb.broadcast.dvb.si.SITime** + +Prototype: public interface org.ngb.broadcast.dvb.si.SITime + +extends org.ngb.broadcast.dvb.si.SICommonInformation + +Description: A Time information interface, providing a method to obtain time information, the time information is obtained from TDT or TOT. + +### B.7.8.1 Method + +#### B.7.8.1.1 getUTCtime + +Prototype: java.util.Date getUTCtime() + +Description: Getting UTC time and date. + +Parameter: None. + +Return: Java.util.Date object, indicating UTC time, the information is obtained from TDT or TOT. + +### B.7.9 Interface org.ngb.broadcast.dvb.si.SIDescriptor + +Prototype: public interface org.ngb.broadcast.dvb.si.SIDescriptor + +Description: Descriptor information interface. The descriptor consists of three parts, as shown in Figure B.3: + +- Tag (descriptor\_tag) – Uniquely identifies a descriptor; +- Content length (descriptor\_length) – Indicating the number of bytes in the content part; +- Content: Byte array, the specific syntax and semantics are related to the tag type. + + + +The diagram illustrates the structure of a SIDescriptor. It consists of three main fields: 'Tag', 'Length', and 'Content'. The 'Tag' and 'Length' fields are shown as separate boxes. The 'Content' field is a larger box containing several bytes, with the first three bytes explicitly labeled with indices '0', '1', and '2'. The last byte of the content is labeled 'length-1'. A horizontal bracket above the 'Content' field is labeled 'Total length bytes'. The reference 'J.1206(24)' is noted at the bottom right of the diagram. + +Schematic diagram of SIDescriptor structure showing Tag, Length, and Content fields with indices. + +Figure B.3 – Schematic diagram of SIDescriptor structure + +### B.7.9.1 Method + +#### B.7.9.1.1 getByteAt + +Prototype: public byte getByteAt(int index) throws java.lang.IndexOutOfBoundsException + +Description: Getting the byte at the specified index position in the content. + +Parameter: index-int type, the index value of the descriptor content position, position 0 corresponds to the first byte after the descriptor\_length field. + +Return: Byte type, indicating the byte data at the specified position. + +Exception: java.lang.IndexOutOfBoundsException – If the parameter index is less than 0 or index is greater than or equal to descriptor\_length, this exception is thrown. + +#### B.7.9.1.2 getContent + +Prototype: public byte[] getContent() + +Description: Getting the content of the descriptor. + +Parameter: None. + +Return: A byte array, indicating the content part of the descriptor, that is, all bytes after the descriptor\_length field. + +#### B.7.9.1.3 getContentLength + +Prototype: public short getContentLength() + +Description: Getting the length of the descriptor content. + +Parameter: None. + +Return: Short type, indicating the length of the descriptor content, that is, the value of the descriptor\_length field, in bytes. + +#### **B.7.9.1.4 getTag** + +Prototype: public short getTag() + +Description: Getting the descriptor tag (descriptor\_tag). + +Parameter: None. + +Return: Short type, indicating the value of the descriptor tag field. For the value, see the "descriptor tag" constant field definition of the SIDescriptorTag interface. + +#### **B.7.10 Interface org.ngb.broadcast.dvb.si.SIRequest** + +Prototype: public interface org.ngb.broadcast.dvb.si.SIRequest + +Description: PSI/SI information request interface, describes a PSI/SI information retrieval request generated by the application. The application can cancel the request through this object. + +##### **B.7.10.1 Method** + +###### **B.7.10.1.1 cancelRequest** + +Prototype: public void cancelRequest() + +Description: Cancel this request action. + +Parameter: None. + +Return: None. + +#### **B.7.11 Interface org.ngb.broadcast.dvb.si.SIRetrieveListener** + +Prototype: public interface org.ngb.broadcast.dvb.si.SIRetrieveListener extends java.util.EventListener + +Description: SI information acquisition event listener is implemented by the application program. + +##### **B.7.11.1 Method** + +###### **B.7.11.1.1 postEvent** + +Prototype: public void postEvent(org.ngb.broadcast.dvb.si.SIRetrieveEvent event) + +Description: Send SI information to get the event. + +Parameter: event – An org.ngb.broadcast.dvb.si.SIRetrieveEvent object, indicating SI information acquisition event. The application should call the instanceOf method to further determine the object type of the event, which may be an org.ngb.broadcast.dvb.si.SISuccessRetrieveEvent object or an org.ngb.broadcast.dvb.si.SIFailureRetrieveEvent object. + +Return: None. + +#### **B.7.12 Interface org.ngb.broadcast.dvb.si.SIUpdateListener** + +Prototype: public interface org.ngb.broadcast.dvb.si.SIUpdateListener extends java.util.EventListener + +Description: PSI/SI table update event listener is implemented by the application program. + +##### **B.7.12.1 Method** + +###### **B.7.12.1.1 postEvent** + +Prototype: public void postEvent(org.ngb.broadcast.dvb.si.SIUpdateEvent event) + +Description: PSI/SI update event callback method is used to obtain the changed PSI/SI object. + +Parameter: event – An org.ngb.broadcast.dvb.si.SIUpdateEvent object, indicating an event in which PSI/SI information changes. + +Return: None. + +### **B.7.13 Interface org.ngb.broadcast.dvb.si.SIDescriptorTag** + +Prototype: public interface org.ngb.broadcast.dvb.si.SIDescriptorTag + +Description: Descriptor tag constant interface, see GB/T 28161-2011 for details. + +#### **B.7.13.1 Constant field – descriptor tag** + +##### **B.7.13.1.1 TAG\_NETWORK\_NAME** + +Prototype: public static final short TAG\_NETWORK\_NAME = 64 + +Description: Network name descriptor tag. + +##### **B.7.13.1.2 TAG\_SERVICE\_LIST** + +Prototype: public static final short TAG\_SERVICE\_LIST = 65 + +Description: Service list descriptor tag. + +##### **B.7.13.1.3 TAG\_STUFFING** + +Prototype: public static final short TAG\_STUFFING = 66 + +Description: Fill the descriptor tag. + +##### **B.7.13.1.4 TAG\_SATELLITE\_DELIVERY\_SYSTEM** + +Prototype: public static final short TAG\_SATELLITE\_DELIVERY\_SYSTEM = 67 + +Description: Satellite delivery system descriptor tag. + +##### **B.7.13.1.5 TAG\_CABLE\_DELIVERY\_SYSTEM** + +Prototype: public static final short TAG\_CABLE\_DELIVERY\_SYSTEM = 68 + +Description: Wire delivery system descriptor tag. + +##### **B.7.13.1.6 TAG\_VBI\_DATA** + +Prototype: public static final short TAG\_VBI\_DATA = 69 + +Description: VBI data descriptor tag. + +##### **B.7.13.1.7 TAG\_TELETEXT** + +Prototype: public static final short TAG\_TELETEXT = 70 + +Description: Teletext descriptor tag. + +##### **B.7.13.1.8 TAG\_BOUQUET\_NAME** + +Prototype: public static final short TAG\_BOUQUET\_NAME = 71 + +Description: Service group name descriptor tag. + +##### **B.7.13.1.9 TAG\_SERVICE** + +Prototype: public static final short TAG\_SERVICE = 72 + +Description: Service descriptor tag. + +#### **B.7.13.1.10 TAG\_COUNTRY\_AVAILABILITY** + +Prototype: public static final short TAG\_COUNTRY\_AVAILABILITY = 73 + +Description: Descriptor for country/region service approval. + +#### **B.7.13.1.11 TAG\_LINKAGE** + +Prototype: public static final short TAG\_LINKAGE = 74 + +Description: Link descriptor tag. + +#### **B.7.13.1.12 TAG\_NVOD\_REFERENCE** + +Prototype: public static final short TAG\_NVOD\_REFERENCE = 75 + +Description: Quasi-video-on-demand reference descriptor tag. + +#### **B.7.13.1.13 TAG\_TIME\_SHIFTED\_SERVICE** + +Prototype: public static final short TAG\_TIME\_SHIFTED\_SERVICE = 76 + +Description: Time-shifted service descriptor tag. + +#### **B.7.13.1.14 TAG\_SHORT\_EVENT** + +Prototype: public static final short TAG\_SHORT\_EVENT = 77 + +Description: Short event descriptor tag. + +#### **B.7.13.1.15 TAG\_EXTENDED\_EVENT** + +Prototype: public static final short TAG\_EXTENDED\_EVENT = 78 + +Description: Extended event descriptor tag. + +#### **B.7.13.1.16 TAG\_TIME\_SHIFTED\_EVENT** + +Prototype: public static final short TAG\_TIME\_SHIFTED\_EVENT = 79 + +Description: Time-shifted event descriptor tag. + +#### **B.7.13.1.17 TAG\_COMPONENT** + +Prototype: public static final short TAG\_COMPONENT = 80 + +Description: Component descriptor tag. + +#### **B.7.13.1.18 TAG\_MOSAIC** + +Prototype: public static final short TAG\_MOSAIC = 81 + +Description: Mosaic descriptor tag. + +#### **B.7.13.1.19 TAG\_STREAM\_IDENTIFIER** + +Prototype: public static final short TAG\_STREAM\_IDENTIFIER = 82 + +Description: Stream identification descriptor tag. + +#### **B.7.13.1.20 TAG\_CA\_IDENTIFIER** + +Prototype: public static final short TAG\_CA\_IDENTIFIER = 83 + +Description: Conditional receiving identification descriptor tag. + +#### **B.7.13.1.21 TAG\_CONTENT** + +Prototype: public static final short TAG\_CONTENT = 84 + +Description: Content descriptor tag. + +#### **B.7.13.1.22 TAG\_PARENTAL\_RATING** + +Prototype: public static final short TAG\_PARENTAL\_RATING = 85 + +Description: Parental rating descriptor tag. + +#### **B.7.13.1.23 TAG\_VBI\_TELETEXT** + +Prototype: public static final short TAG\_VBI\_TELETEXT = 86 + +Description: VBI teletext descriptor. + +#### **B.7.13.1.24 TAG\_TELEPHONE** + +Prototype: public static final short TAG\_TELEPHONE = 87 + +Description: Phone descriptor tag. + +#### **B.7.13.1.25 TAG\_LOCAL\_TIME\_OFFSET** + +Prototype: public static final short TAG\_LOCAL\_TIME\_OFFSET = 88 + +Description: Local time offset descriptor tag. + +#### **B.7.13.1.26 TAG\_SUBTITLING** + +Prototype: public static final short TAG\_SUBTITLING = 89 + +Description: Subtitle descriptor tag. + +#### **B.7.13.1.27 TAG\_TERRESTRIAL\_DELIVERY\_SYSTEM** + +Prototype: public static final short TAG\_TERRESTRIAL\_DELIVERY\_SYSTEM = 90 + +Description: Ground delivery system descriptor tag. + +#### **B.7.13.1.28 TAG\_MULTILINGUAL\_NETWORK\_NAME** + +Prototype: public static final short TAG\_MULTILINGUAL\_NETWORK\_NAME = 91 + +Description: Multilingual network name descriptor tag. + +#### **B.7.13.1.29 TAG\_MULTILINGUAL\_BOUQUET\_NAME** + +Prototype: public static final short TAG\_MULTILINGUAL\_BOUQUET\_NAME = 92 + +Description: Multilingual service group descriptor tag. + +#### **B.7.13.1.30 TAG\_MULTILINGUAL\_SERVICE\_NAME** + +Prototype: public static final short TAG\_MULTILINGUAL\_SERVICE\_NAME = 93 + +Description: Multilingual service name descriptor tag. + +#### **B.7.13.1.31 TAG\_MULTILINGUAL\_COMPONENT** + +Prototype: public static final short TAG\_MULTILINGUAL\_COMPONENT = 94 + +Description: Multilingual component descriptor tag. + +#### **B.7.13.1.32 TAG\_PRIVATE\_DATA\_SPECIFIER** + +Prototype: public static final short TAG\_PRIVATE\_DATA\_SPECIFIER = 95 + +Description: Private data specifier descriptor tag. + +#### **B.7.13.1.33 TAG\_SERVICE\_MOVE** + +Prototype: public static final short TAG\_SERVICE\_MOVE = 96 + +Description: Service move descriptor tag. + +#### **B.7.13.1.34 TAG\_SHORT\_SMOOTHING\_BUFFER** + +Prototype: public static final short TAG\_SHORT\_SMOOTHING\_BUFFER = 97 + +Description: Short smoothing buffer descriptor tag. + +#### **B.7.13.1.35 TAG\_FREQUENCY\_LIST** + +Prototype: public static final short TAG\_FREQUENCY\_LIST = 98 + +Description: Frequency list descriptor tag. + +#### **B.7.13.1.36 TAG\_PARTIAL\_TRANSPORT\_STREAM** + +Prototype: public static final short TAG\_PARTIAL\_TRANSPORT\_STREAM = 99 + +Description: Frequency list descriptor tag. + +#### **B.7.13.1.37 TAG\_DATA\_BROADCAST** + +Prototype: public static final short TAG\_DATA\_BROADCAST = 100 + +Description: Data broadcast descriptor tag. + +#### **B.7.13.1.38 TAG\_CA\_SYSTEM** + +Prototype: public static final short TAG\_CA\_SYSTEM = 101 + +Description: CA system descriptor tag. + +#### **B.7.13.1.39 TAG\_DATA\_BROADCAST\_ID** + +Prototype: public static final short TAG\_DATA\_BROADCAST\_ID = 102 + +Description: Data broadcast identification descriptor tag. + +#### **B.7.13.1.40 TAG\_TRANSPORT\_STREAM** + +Prototype: public static final short TAG\_TRANSPORT\_STREAM = 103 + +Description: Transport stream descriptor tag. + +#### **B.7.13.1.41 TAG\_DSNG** + +Prototype: public static final short TAG\_DSNG = 104 + +Description: Digital satellite news gathering descriptor tag. + +#### **B.7.13.1.42 TAG\_PDC** + +Prototype: public static final short TAG\_PDC = 105 + +Description: Program delivery control descriptor tag. + +#### **B.7.13.1.43 TAG\_AC\_3** + +Prototype: public static final short TAG\_AC\_3 = 106 + +Description: AC3 descriptor tag. + +#### **B.7.13.1.44 TAG\_ANCILLARY\_DATA** + +Prototype: public static final short TAG\_ANCILLARY\_DATA = 107 + +Description: Ancillary data descriptor tag. + +#### **B.7.13.1.45 TAG\_ANNOUNCEMENT\_SUPPORT** + +Prototype: public static final short TAG\_ANNOUNCEMENT\_SUPPORT = 110 + +Description: Announcement support descriptor tag. + +#### **B.7.14 Interface org.ngb.broadcast.dvb.si.SIRunningStatus** + +Prototype: public interface org.ngb.broadcast.dvb.si.SIRunningStatus + +Description: Running state constant definition interface of the broadcast service (service) or program (event), see GB/T 28161-2011 for the value. + +##### **B.7.14.1 Constant field – running status** + +###### **B.7.14.1.1 UNDEFINED** + +Prototype: public static final byte UNDEFINED = 0 + +Description: Running status-undefined. + +###### **B.7.14.1.2 NOT\_RUNNING** + +Prototype: public static final byte NOT\_RUNNING = 1 + +Description: Running status-not running. + +###### **B.7.14.1.3 STARTS\_IN\_A\_FEW\_SECONDS** + +Prototype: public static final byte STARTS\_IN\_A\_FEW\_SECONDS = 2 + +Description: Running status-about to run. + +###### **B.7.14.1.4 PAUSING** + +Prototype: public static final byte PAUSING = 3 + +Description: Running state-pausing state. + +###### **B.7.14.1.5 RUNNING** + +Prototype: public static final byte RUNNING = 4 + +Description: Running status-running. + +#### **B.7.15 Interface org.ngb.broadcast.dvb.si.SIServiceType** + +Prototype: public interface org.ngb.broadcast.dvb.si.SIServiceType + +Description: Service type (service\_type) constant definition interface, and the value is detailed in GB/T 28161-2011. + +##### **B.7.15.1 Constant field – service type** + +###### **B.7.15.1.1 SERVICE\_TYPE\_RESERVED** + +Prototype: public static final short SERVICE\_TYPE\_RESERVED = 0 + +Description: Service type-reserved for use. + +###### **B.7.15.1.2 SERVICE\_TYPE\_DIGITAL\_TELEVISION** + +Prototype: public static final short SERVICE\_TYPE\_DIGITAL\_TELEVISION = 1 + +Description: Service type – digital television broadcasting service. + +#### **B.7.15.1.3 SERVICE\_TYPE\_DIGITAL\_RADIO\_SOUND** + +Prototype: public static final short SERVICE\_TYPE\_DIGITAL\_RADIO\_SOUND = 2 + +Description: Service type – digital sound broadcasting service. + +#### **B.7.15.1.4 SERVICE\_TYPE\_TELETEXT** + +Prototype: public static final short SERVICE\_TYPE\_TELETEXT = 3 + +Description: Service type – teletext service. + +#### **B.7.15.1.5 SERVICE\_TYPE\_NVOD\_REFERENCE** + +Prototype: public static final short SERVICE\_TYPE\_NVOD\_REFERENCE = 4 + +Description: Service type – NVOD reference service. + +#### **B.7.15.1.6 SERVICE\_TYPE\_NVOD\_TIME\_SHIFTED** + +Prototype: public static final short SERVICE\_TYPE\_NVOD\_TIME\_SHIFTED = 5 + +Description: Service type – NVOD time shifted service. + +#### **B.7.15.1.7 SERVICE\_TYPE\_MOSAIC** + +Prototype: public static final short SERVICE\_TYPE\_MOSAIC = 6 + +Description: Service type – mosaic service. + +#### **B.7.15.1.8 SERVICE\_TYPE\_DATA\_BROADCAST** + +Prototype: static final short SERVICE\_TYPE\_DATA\_BROADCAST = 12 + +Description: Service type – data broadcasting service. + +#### **B.7.16 Interface org.ngb.broadcast.dvb.si.SIStreamType** + +Prototype: public interface org.ngb.broadcast.dvb.si.SIStreamType + +Description: Elementary stream stream type constant (stream\_type) definition interface, for the value of the stream type constant, please refer to the standard definition of GB/T 17975.1-2010 "General Coding of Information Technology Moving Pictures and Its Accompanying Information Part 1: System". + +#### **B.7.16.1 Constant – ES Stream Tpe** + +##### **B.7.16.1.1 ES\_PRIVATE\_RESERVED** + +Prototype: public static final byte ES\_PRIVATE\_RESERVED = 0 + +Description: ES stream type-reserved. + +##### **B.7.16.1.2 ES\_MPEG1\_VIDEO** + +Prototype: public static final byte ES\_MPEG1\_VIDEO = 1 + +Description: ES stream type – GB/T 17191.2 video. + +##### **B.7.16.1.3 ES\_MPEG2\_VIDEO** + +Prototype: public static final byte ES\_MPEG2\_VIDEO = 2 + +Description: ES stream type – GB/T 17975.2 video. + +##### **B.7.16.1.4 ES\_MPEG1\_AUDIO** + +Prototype: public static final byte ES\_MPEG1\_AUDIO = 3 + +Description: ES stream type – GB/T 17191.2 audio. + +#### **B.7.16.1.5 ES\_MPEG2\_AUDIO** + +Prototype: public static final byte ES\_MPEG2\_AUDIO = 4 + +Description: ES stream type – GB/T 17975.2 audio. + +#### **B.7.16.1.6 ES\_PRIVATE\_SECTION** + +Prototype: public static final byte ES\_PRIVATE\_SECTION = 5 + +Description: ES stream type-private section. + +#### **B.7.16.1.7 ES\_PRIVATE\_DATA** + +Prototype: public static final byte ES\_PRIVATE\_DATA = 6 + +Description: ES stream type – PES packet containing private data. + +#### **B.7.16.1.8 ES\_MHEG** + +Prototype: public static final byte ES\_MHEG = 7 + +Description: ES stream type – ISO/IEC 13522-1 MHEG. + +#### **B.7.16.1.9 ES\_DSMCC** + +Prototype: public static final byte ES\_DSMCC = 8 + +Description: Stream type – ISO/IEC 13818-1 Appendix B DSMCC. + +#### **B.7.16.1.10 ES\_DSMCC\_A** + +Prototype: public static final byte ES\_DSMCC\_A = 10 + +Description: ES stream type – ISO/IEC 13818-6 Type A. + +#### **B.7.16.1.11 ES\_DSMCC\_B** + +Prototype: public static final byte ES\_DSMCC\_B = 11 + +Description: ES stream type – ISO/IEC 13818-6 Type B. + +#### **B.7.16.1.12 ES\_DSMCC\_C** + +Prototype: public static final byte ES\_DSMCC\_C = 12 + +Description: ES stream type – ISO/IEC 13818-6 Type C. + +#### **B.7.16.1.13 ES\_DSMCC\_D** + +Prototype: public static final byte ES\_DSMCC\_D = 13 + +Description: ES stream type – ISO/IEC 13818-6 Type D. + +#### **B.7.16.1.14 ES\_AVS\_VIDEO** + +Prototype: public static final byte ES\_AVS\_VIDEO = 66 + +Description: ES stream type – GB/T 20090.2 – 2006 video type. + +### **B.7.17 Class org.ngb.broadcast.dvb.si.SIDatabase** + +Prototype: public class org.ngb.broadcast.dvb.si.SIDatabase + +Description: A PSI/SI information database, providing the management and operation methods of the PSI/SI information database in DVB mode, and is an entry class for applications to obtain PSI/SI information. Each physical broadcast network interface corresponds to a SIDatabase object. If the + +receiving terminal has only one physical broadcast network interface, there is only one org.ngb.broadcast.dvb.si.SIDatabase object. When implementing the system, the following special application scenarios need to be considered: + +- Scenario 1 – The same physical interface is connected to multiple broadcast networks. For example, terrestrial wireless Tuner may be connected to wireless networks of different operators. At this time, the physical interface corresponds to only one org.ngb.broadcast.dvb.si.SIDatabase object; +- Scenario 2 – Multiple physical interfaces are connected to the same broadcast network. For example, a receiver with PVR function has two Tuners connected to the wired network at the same time. In this case, the system should implement multiple org.ngb.broadcast.dvb.si.+SIDatabase objects. The information maintained by each SIDatabase is the same. + +### **B.7.17.1 Method** + +#### **B.7.17.1.1 getDatabase** + +Prototype: public static org.ngb.broadcast.dvb.si.SIDatabase[] getDatabase() + +Description: Obtain SI database instances. The receiving terminal may have multiple broadcast network interfaces (for example, simultaneous connection to a wired network and a national standard terrestrial wireless network). Each network interface corresponds to one SI database instance. If there are multiple network interfaces, this method returns multiple SI database instances. + +Return: org.ngb.broadcast.dvb.si.SIDatabase object array, indicating SI database instance. + +NOTE – When implementing the system, the following special scenarios need to be considered: + +- Scenario 1 – The same physical network interface is connected to multiple broadcast networks. For example, the ground wireless Tuner may be connected to the wireless networks of different operators. In this scenario, there is only one org.ngb.broadcast.dvb.si.SIDatabase instance; +- Scenario 2 – Multiple physical network interfaces are connected to the same broadcast network. For example, a receiver with PVR function has two or more Tuners connected to the same network at the same time. In this scenario, there are multiple org.ngb.broadcast.dvb.si. SIDatabase instances. + +#### **B.7.17.1.2 getID** + +Prototype: public int getID() + +Description: Getting a globally unique identifier of the org.ngb.broadcast.dvb.si.SIDatabase object. + +Parameter: None. + +Return: Int type, indicating the globally unique identifier of the org.ngb.broadcast.dvb.si.SIDatabase object. + +#### **B.7.17.1.3 addNITUpdateListener** + +Prototype: public boolean addNITUpdateListener(org.ngb.broadcast.dvb.si.SIUpdateListener listener, int networkId) throws java.lang.IllegalArgumentException + +Description: Register the NIT update event listener. When the NIT is updated, a SIUpdateEvent event will be sent to the registered listener object. Whole process listening, when the network interface associated with the org.ngb.broadcast.dvb.si.SIDatabase object is tuned to another transport stream, the listening process does not stop. + +Parameter: listener – An org.ngb.broadcast.dvb.si.SIUpdateListener object, indicating the listener object to be registered to receive the NIT update event; + +networkId – Int type, indicating the unique identifier of NIT. + +Return: Boolean type, indicating the registration result, true value indicating that the registration is successful, and false value indicating that the registration fails. + +Exception: java.lang.IllegalArgumentException – If the network specified by the parameter network\_id does not exist, this exception is thrown. + +#### **B.7.17.1.4 removeNITUpdateListener** + +Prototype: public boolean removeNITUpdateListener(org.ngb.broadcast.dvb.si.SIUpdateListener listener, int network\_id) throws java.lang.IllegalArgumentException + +Description: Unregister the NIT update event listener. If the listener associated with the parameter network\_id does not exist, this method fails, but no exception is thrown. + +Parameter: listener – An org.ngb.broadcast.dvb.si.SIUpdateListener object, indicating the listener object to be unregistered that receives the NIT update event; + +network\_id – Int type, indicating the unique identifier of NIT. + +Return: Boolean type, indicating the unregister result, true value indicating that the unregister is successful, and false value indicating that the unregister fails. + +Exception: java.lang.IllegalArgumentException – If the network specified by the parameter network\_id does not exist, this exception is thrown. + +#### **B.7.17.1.5 addBATUpdateListener** + +Prototype: public boolean addBATUpdateListener(org.ngb.broadcast.dvb.si.SIUpdateListener listener, int networkId, int bouquetId) +throws java.lang.IllegalArgumentException + +Description: Register BAT update event listener. When the BAT is updated, an org.ngb.broadcast.dvb.si.SIUpdateEvent event will be sent to the registered listener object. Whole process listening, when the network interface associated with the org.ngb.broadcast.dvb.si.SIDatabase object is tuned to another transport stream, the listening process does not stop. + +Parameter: listener – An org.ngb.broadcast.dvb.si.SIUpdateListener object, indicating the listener object to be registered to receive the BAT update event; + +networkId – Int type, indicating the network identifier of the network where BAT is located; + +bouquetId – Int type, indicating the unique identifier of BAT. + +Return: Boolean type, indicating the registration result, true value indicating that the registration is successful, and false value indicating that the registration fails. + +Exception: java.lang.IllegalArgumentException –If the service group specified by the parameters network\_id and bouquet\_id does not exist, this exception is thrown. + +#### **B.7.17.1.6 removeBATUpdateListener** + +Prototype: public boolean removeBATUpdateListener(org.ngb.broadcast.dvb.si.SIUpdateListener listener, int networkId, int bouquetId) throws java.lang.IllegalArgumentException + +Description: Unregister the BAT update event listener. If the listener associated with the parameter bouquet\_id does not exist, this method fails, but no exception is thrown. + +Parameter: listener – An org.ngb.broadcast.dvb.si.SIUpdateListener object, indicating the listener object to be unregistered that receives the BAT update event; + +networkId – Int type, indicating the network identifier of the network where BAT is located; + +bouquetId – Int type, indicating the unique identifier of BAT. + +Return: Boolean type, indicating the unregister result, true value indicating that the unregister is successful, and false value indicating that the unregister failed. + +Exception: java.lang.IllegalArgumentException – If the service group specified by the parameters networkId and bouquetId does not exist, this exception is thrown. + +#### **B.7.17.1.7 addPATUpdateListener** + +Prototype: public void addPATUpdateListener(org.ngb.broadcast.dvb.si.SIUpdateListener listener) + +Description: Register the PAT update event listener. When the PAT is updated, a SIUpdateEvent event will be sent to the registered listener object. Only the PAT in the current transport stream is listened. When the network interface associated with the org.ngb.broadcast.dvb.si.SIDatabase object is tuned to another transport stream, the listening process should stop in the background. + +Parameter: listener – An org.ngb.broadcast.dvb.si.SIUpdateListener object, indicating the listener object to be registered that receive the PAT update event. + +Return: None. + +#### **B.7.17.1.8 removePATUpdateListener** + +Prototype: public void removePATUpdateListener(org.ngb.broadcast.dvb.si.SIUpdateListener listener) + +Description: Unregister the PAT update event listener. + +Parameter: listener – An org.ngb.broadcast.dvb.si.SIUpdateListener object, indicating the listener object to be unregistered that receives PAT update events. + +Return: None. + +#### **B.7.17.1.9 addPMTUpdateListener** + +Prototype: public boolean addPMTUpdateListener(org.ngb.broadcast.dvb.si.SIUpdateListener listener, int networkId, int originalNetworkId, int transportStreamId, int serviceId) throws java.lang.IllegalArgumentException + +Description: Register the PMT update event listener. If the services specified by networkId, originalNetworkId, transportStreamId and serviceId are carried in the current transport stream, when the PMT is updated, an org.ngb.broadcast.dvb.si.SIUpdateEvent object will be sent to the registered listener object. Only the PMT in the current transport stream is listened. When the network interface associated with the org.ngb.broadcast.dvb.si.SIDatabase object is tuned to another transport stream, the listening process should stop in the background. + +Parameter: listener – An org.ngb.broadcast.dvb.si.SIUpdateListener object, indicating the listener object to be registered that receives the PMT update event; + +networkId – Int type, indicating the network identifier; + +originalNetworkId – Int type, indicating the original network identifier; + +transportStreamId – Int type, indicating the transport stream identifier; + +serviceId – Int type, indicating the service identifier. + +Return: Boolean type, indicating the registration result, true value indicating that the registration is successful, and false value indicating that the registration fails. + +Exception: java.lang.IllegalArgumentException – If the service specified by the parameters networkId, originalNetworkId, transportStreamId, and serviceId does not exist, this exception is thrown. + +#### **B.7.17.1.10 removePMTUpdateListener** + +Prototype: public boolean removePMTUpdateListener(org.ngb.broadcast.dvb.si.SIUpdateListener listener, int networkId, int originalNetworkId, int transportStreamId,int serviceId) throws java.lang.IllegalArgumentException + +Description: Unregister the PMT update event listener. + +Parameter: listener – An org.ngb.broadcast.dvb.si.SIUpdateListener object, indicating the listener object to be unregistered that receives the PMT update event; + +networkId – Int type, indicating the network identifier; + +originalNetworkId – Int type, indicating the original network identifier; + +transportStreamId – Int type, indicating the transport stream identifier; + +serviceId – Int type, indicating the service identifier. + +Return: Boolean type, indicating the unregister result, true value indicating that the unregister is successful, and false value indicating that the unregister failed. + +Exception: java.lang.IllegalArgumentException – If the service specified by the parameters networkId, originalNetworkId, transportStreamId, and serviceId does not exist, this exception is thrown. + +#### **B.7.17.1.11 addSDTUpdateListener** + +Prototype: public boolean addSDTUpdateListener(org.ngb.broadcast.dvb.si.SIUpdateListener listener, int networkId, int originalNetworkId, int transportStreamId) throws java.lang.IllegalArgumentException + +Description: Register the SDT update event listener. When the SDT specified by the parameters network\_id, originalNetworkId, and transportStreamId is updated, an SIUpdateEvent event will be sent to the registered listener object. Only the SDT in the current transport stream is listened. When the network interface associated with the SIDatabase object starts to tune to another transport stream, the listening process should stop in the background. + +Parameter: listener – An org.ngb.broadcast.dvb.si.SIUpdateListener object, indicating the listener object to be registered that receives the SDT update event; + +networkId – Int type, indicating the network identifier; + +originalNetworkId – Int type, indicating the original network identifier; + +transportStreamId – Int type, indicating the transport stream identifier. + +Return: Boolean type, indicating the registration result, true value indicating that the registration is successful, and false value indicating that the registration fails. + +Exception: java.lang.IllegalArgumentException – If the SDT specified by the parameters networkId, originalNetworkId, and transportStreamId does not exist, this exception is thrown. + +#### **B.7.17.1.12 removeSDTUpdateListener** + +Prototype: public boolean removeSDTUpdateListener(org.ngb.broadcast.dvb.si.SIUpdateListener listener, int networkId, int originalNetworkId, int transportStreamId) throws java.lang.IllegalArgumentException + +Description: Unregister the SDT update event listener. + +Parameter: listener – An org.ngb.broadcast.dvb.si.SIUpdateListener object, indicating the listener object to be unregistered that receives the SDT update event; + +networkId – Int type, indicating the network identifier; + +originalNetworkId – Int type, indicating the original network identifier; + +transportStreamId – Int type, indicating the transport stream identifier. + +Return: Boolean type, indicating the unregister result, true value indicating that the unregister is successful, and false value indicating that the unregister failed. + +Exception: java.lang.IllegalArgumentException – If the SDT specified by the parameters networkId, originalNetworkId, and transportStreamId does not exist, this exception is thrown. + +#### **B.7.17.1.13 getAllNetworks** + +Prototype: public org.ngb.broadcast.dvb.si.SINetwork[] getAllNetworks() + +Description: Getting current network information. + +Return: org.ngb.broadcast.dvb.si.SINetwork array + +#### **B.7.17.1.14 getAllServices** + +Prototype: public org.ngb.broadcast.dvb.si.SIService[] getAllServices() + +Description: Getting service information. + +Return: org.ngb.broadcast.dvb.si.SIService array + +#### **B.7.17.1.15 getAllTransportStreams** + +Prototype: public org.ngb.broadcast.dvb.si.SITransportStream[] getAllTransportStreams() + +Description: Getting all transport stream information. + +Return: org.ngb.broadcast.dvb.si.SITransportStream array + +#### **B.7.17.1.16 getSIBouquets** + +Prototype: public org.ngb.broadcast.dvb.si.SIBouquet[] getSIBouquets(int network\_id, int original\_network\_id, int transport\_stream\_id, int service\_id) + +Description: Getting a frequency point and the org.ngb.broadcast.dvb.si.SIBouquet where the program is located. If the parameters are all -1, all org.ngb.broadcast.dvb.si.SIBouquet will be returned. + +Parameter: network\_id – Int type, indicating the network identifier, if it is -1, it means to retrieve the network information described in the current and other network NIT tables; + +original\_network\_id – int type, the original network identifier; + +transport\_stream\_id – int type, the transport stream identifier; + +service\_id – Program identifier, that is, channel program number, if it is -1, it means it does not match the program identifier; + +Return: org.ngb.broadcast.dvb.si.SIBouquet object array. + +#### **B.7.17.1.17 getSIElementStreams** + +Prototype: public org.ngb.broadcast.dvb.si.SIElementaryStream[] getSIElementStreams(int network\_id, int original\_network\_id, int transport\_stream\_id, int service\_id) + +Description: Getting the SIElementaryStream of a certain program, if the parameters are all -1, then return the SIElementaryStream of all programs. + +Parameter: network\_id – Int type, indicating the network identifier, if it is -1, it means to retrieve the network information described in the current and other network NIT tables; + +original\_network\_id – int type, the original network identifier; + +transport\_stream\_id – int type, the transport stream identifier; + +service\_id – Program identifier, that is, channel program number, if it is -1, it means it does not match the program identifier; + +Return: org.ngb.broadcast.dvb.si.SIElementaryStream object array. + +#### **B.7.17.1.18 getSIServices** + +Prototype: public org.ngb.broadcast.dvb.si.SIService[] getSIServices(int network\_id,int original\_network\_id,int transport\_stream\_id,int service\_id) + +Description: Getting the specified service information org.ngb.broadcast.dvb.si.SIService. + +Parameter: network\_id-Int type, indicating the network identifier, if it is -1, it means to retrieve the network information described in the current and other network NIT tables; + +original\_network\_id – int type, the original network identifier; + +transport\_stream\_id – int type, the transport stream identifier; + +service\_id – Program identifier, that is, channel program number, if it is -1, it means it does not match the program identifier; + +Return: org.ngb.broadcast.dvb.si.SIService object array. + +#### **B.7.17.1.19 getPreferredLanguage** + +Prototype: public java.lang.String getPreferredLanguage() + +Description: Getting the default language type for querying SI text information set by the application. + +Parameter: None. + +Return: A java.lang.String object, indicating the default language type for querying SI text information set by the application. The three-letter language code follows GB/T 4880.2-2000. + +#### **B.7.17.1.20 setPreferredLanguage** + +Prototype: public void setPreferredLanguage(java.lang.String iso639code) + +Description: Setting the default language type for the application to query SI text information. + +Parameter: iso639code – A java.lang.String object, indicating the language type of SI text information, and the three-letter language code follows GB/T 4880.2-2000. + +Return: None. + +### **B.7.18 Class org.ngb.broadcast.dvb.si.SIRequestFailureType** + +Prototype: public class org.ngb.broadcast.dvb.si.SIRequestFailureType + +Description: Reason for failure of PSI/SI information retrieval. + +#### **B.7.18.1 Constant field – failure reason** + +##### **B.7.18.1.1 UNKNOWN** + +Prototype: public static final int UNKNOWN = 0 + +Description: Reason for retrieval failure-unknown. + +##### **B.7.18.1.2 CANCELED** + +Prototype: public static final int CANCELED = 1 + +Description: Reason for failure of retrieval – the request was cancelled by the application. + +#### **B.7.18.1.3 DATA\_UNAVAILABLE** + +Prototype: public static final int DATA\_UNAVAILABLE = 2 + +Description: Reason for failure of retrieval – data is unavailable. + +#### **B.7.18.1.4 INSUFFICIENT\_RESOURCES** + +Prototype: public static final int INSUFFICIENT\_RESOURCES = 3 + +Description: Reason for failure of retrieval – insufficient resources. + +### **B.7.18.2 Method** + +#### **B.7.18.2.1 getCode** + +Prototype: public int getCode() + +Description: Getting the reason code of the information retrieval failure. + +Parameter: None. + +Return: int type, indicating the reason code for the failure of information retrieval, + +for the value, see the the constant field definition "Failure Reason" of the org.ngb.broadcast.dvb.si.SIRequestFailureType interface. + +#### **B.7.18.2.2 toString** + +Prototype: public java.lang.String toString() + +Description: Getting a text description of the reason for the failure of information retrieval. + +Rewrite: toString() method of the java.lang.Object class. + +Parameter: None. + +Return: A java.lang.String object, indicating a text description of the reason for the failure of information retrieval. + +### **B.7.19 Event org.ngb.broadcast.dvb.si.SIRetrieveEvent** + +Prototype: public class org.ngb.broadcast.dvb.si.SIRetrieveEvent extends java.util.EventObject + +Description: PSI/SI information request event is the base class of a group of events related to the PSI/SI information request defined by this package. Only one such event can be generated in one PSI/SI information request. + +#### **B.7.19.1 Method** + +##### **B.7.19.1.1 getSource** + +Prototype: public java.lang.Object getSource() + +Description: Getting the SIRequest object that generated the event. + +Rewrite: getSource() method of the java.util.EventObject class. + +Parameter: None. + +Return: An org.ngb.broadcast.dvb.si.SIRequest object, indicating the SIRequest object that generated the event. + +##### **B.7.19.1.2 getAppData** + +Prototype: public java.lang.Object getAppData() + +Description: Getting additional application data information. + +Parameter: None. + +Return: A java.lang.Object object, indicating additional application data. + +#### **B.7.20 Event org.ngb.broadcast.dvb.si.SISuccessRetrieveEvent** + +Prototype: public class org.ngb.broadcast.dvb.si.SISuccessRetrieveEvent extends org.ngb.broadcast.dvb.si.SIRetrieveEvent + +Description: PSI/SI information or descriptor request success event. + +##### **B.7.20.1 Method** + +###### **B.7.20.1.1 getResult** + +Prototype: public java.util.Enumeration getResult() + +Description: Getting the successful retrieval result. + +Parameter: None. + +Return: A java.util.Enumeration object, indicating the retrieval result. Since both PSI/SI information and descriptor information retrieved through asynchronous methods are returned through this event object, the enumeration object element may be of org.ngb.broadcast.dvb.si.SICommonInformation type or org.ngb.broadcast.dvb.si.SIDescriptor type, the application should further determine the type of the enumeration object element through the instanceof method. + +#### **B.7.21 Event org.ngb.broadcast.dvb.si.SIFailureRetrieveEvent** + +Prototype: public class org.ngb.broadcast.dvb.si.SIFailureRetrieveEvent extends org.ngb.broadcast.dvb.si.SIRetrieveEvent + +Description: PSI/SI information request failure event. + +##### **B.7.21.1 Method** + +###### **B.7.21.1.1 getReason** + +Prototype: public org.ngb.broadcast.dvb.si.SIRequestFailureType getReason() + +Description: Getting the reason for the failure to retrieve PSI/SI information. + +Parameter: None. + +Return: org.ngb.broadcast.dvb.si.SIRequestFailureType object, indicates the reason for the failure to retrieve PSI/SI information. + +#### **B.7.22 Event org.ngb.broadcast.dvb.si.SIUpdateEvent** + +Prototype: public class org.ngb.broadcast.dvb.si.SIUpdateEvent extends java.util.EventObject + +Description: PSI/SI table update event. The application program should first call the getTableID() method to determine which PSI/SI table is updated, and then obtain other parameters according to the specific table type. + +##### **B.7.22.1 Method** + +###### **B.7.22.1.1 getTableID** + +Prototype: public int getTableID() + +Description: Getting the updated PSI/SI table identifier (table\_id). + +Return: Int type, indicating the updated PSI/SI table identifier. + +#### **B.7.22.1.2 getBouquetID** + +Prototype: public int getBouquetID() + +Description: Getting the service group identifier (bouquet\_id). + +Parameter: None. + +Return: Int type, indicating the service group identifier. The return value is meaningful when the BAT is updated. + +#### **B.7.22.1.3 getNetworkID** + +Prototype: public int getNetworkID() + +Description: Getting the identifier of the network. + +Parameter: None. + +Return: Int type, indicating the network identifier. The return value is meaningful when the NIT is updated. + +#### **B.7.22.1.4 getOriginalNetworkID** + +Prototype: public int getOriginalNetworkID() + +Description: Getting the original network identifier. + +Parameter: None. + +Return: Int type, indicating the original network identifier. The return value is meaningful when PMT/SDT/EIT is updated. + +#### **B.7.22.1.5 getServiceID** + +Prototype: public int getServiceID() + +Description: Getting the service identifier. + +Return: Int type, indicating the service identifier (service\_id). The return value is meaningful when the PMT/EIT is updated. + +#### **B.7.22.1.6 getTransportStreamID** + +Prototype: public int getTransportStreamID() + +Description: Getting the transport stream identifier. + +Parameter: None. + +Return: Int type, indicating the transport stream identifier. The return value is meaningful when PAT/PMT/SDT/EIT is updated. + +#### **B.7.23 Exception org.ngb.broadcast.dvb.si.InvalidPeriodException** + +Prototype: public class org.ngb.broadcast.dvb.si.InvalidPeriodException + +extends java.lang.Exception + +Description: Invalid period exception. When the specified date is invalid, the exception is thrown. + +## Annex C + +### JAVA-Two-way broadband network access unit + +(This annex forms an integral part of this Recommendation.) + +#### C.1 Overview + +This annex defines the JAVA interface related to two-way broadband network access, including Ethernet management module and WiFi management module. + +#### C.2 Ethernet management module + +The Ethernet management module provides DHCP information and management information for the Ethernet. + +The summary of the Ethernet management module is shown in Table C.1. + +**Table C.1 – Summary of Ethernet management module** + +| | | +|-----------------|-----------------------------------------------------------------------------| +| Interface | | +| Listener | Ethernet status change event listener, implemented by the application layer | +| Class | | +| DhcpInfo | Provide a method to obtain DHCP configuration information. | +| EthernetManager | Provide a method for Ethernet management. | + +##### C.2.1 Interface org.tvos.net.Listener + +Prototype: public interface org.tvos.net.Listener + +Description: The Ethernet status change event listener is implemented by the application layer. + +###### C.2.1.1 Method + +###### C.2.1.1.1 onAvailabilityChanged + +Prototype: public void onAvailabilityChanged(boolean isAvailable) + +Description: The interface is notified of whether the Ethernet is available. + +Parameter: isAvailable – Boolean type, true indicating available, false indicating unavailable. + +Return: None. + +##### C.2.2 Class org.tvos.net.DhcpInfo + +Prototype: public class org.tvos.net.DhcpInfo implements org.tvos.os.Parcelable + +Description: A DHCP configuration information class, providing a method for obtaining DHCP configuration information. + +###### C.2.2.1 Attributes + +###### C.2.2.1.1 ipAddress + +Prototype: public int ipAddress + +Description: Indicating IP address information. + +###### C.2.2.1.2 gateway + +Prototype: public int gateway + +Description: Indicating gateway information. + +#### **C.2.2.1.3 dns1** + +Prototype: public int dns1 + +Description: Indicating dns1 information. + +#### **C.2.2.1.4 dns2** + +Prototype: public int dns2 + +Description: Indicating dns2 information. + +#### **C.2.2.1.5 serverAddress** + +Prototype: public int serverAddress + +Description: Indicating serverAddress information. + +### **C.2.3 Class org.tvos.net.EthernetManager** + +Prototype: public org.tvos.net.EthernetManager(org.tvos.content.Context context, org.tvos.net.IEthernetManager service) + +Description: An Ethernet connection management class, providing a method of connecting to the Ethernet network. + +#### **C.2.3.1 Constant field** + +##### **C.2.3.1.1 ETHERNET\_STATE\_DISABLED** + +Prototype: public static final int ETHERNET\_STATE\_DISABLED = 0 + +Description: Ethernet disable constant definition. + +##### **C.2.3.1.2 ETHERNET\_STATE\_ENABLED** + +Prototype: public static final int ETHERNET\_STATE\_ENABLED = 1 + +Description: Ethernet enable constant definition. + +##### **C.2.3.1.3 ETHERNET\_STATE\_UNKNOWN** + +Prototype: public static final int ETHERNET\_STATE\_UNKNOWN = 2 + +Description: Ethernet UNKNOWNND constant definition, usually represented in the initialized phase. + +##### **C.2.3.1.4 EVENT\_DHCP\_CONNECT\_SUCCESSED** + +Prototype: public static final int EVENT\_DHCP\_CONNECT\_SUCCESSED = 10 + +Description: DHCP connection is successful. + +##### **C.2.3.1.5 EVENT\_DHCP\_CONNECT\_FAILED** + +Prototype: public static final int EVENT\_DHCP\_CONNECT\_FAILED = 11 + +Description: DHCP connection failed. + +#### **C.2.3.2 Method** + +##### **C.2.3.2.1 isAvailable** + +Prototype: public boolean isAvailable() + +Description: Whether the current Ethernet interface is available. + +Parameter: None. + +Return: Boolean type, true indicating available, false indicating unavailable. + +#### **C.2.3.2.2 addListener** + +Prototype: public void addListener(org.tvos.net.Listener listener) + +Description: Add Ethernet status change event listening interface. + +Parameter: listener – org.tvos.net.Listener type, listening callback function, implemented by the application. + +Return: None. + +#### **C.2.3.2.3 removeListener** + +Prototype: public void removeListener(org.tvos.net.Listener listener) + +Description: Delete the Ethernet status change event listening interface. + +Parameter: listener – org.tvos.net.Listener type, listening callback function, implemented by the application. + +Return: None. + +#### **C.2.3.2.4 getConfiguration** + +Prototype: public org.tvos.net.IpConfiguration getConfiguration() + +Description: Getting network configuration information. + +Parameter: None. + +Return: An org.tvos.net.IpConfiguration object, indicating network configuration information. + +#### **C.2.3.2.5 setConfiguration** + +Prototype: public void setConfiguration(org.tvos.net.IpConfiguration config) + +Description: Setting the network configuration information. + +Parameter: A config – org.tvos.net.IpConfiguration object, indicating the configuration information of the network. + +Return: None. + +#### **C.2.3.2.6 setEthernetEnabled** + +Prototype: public void setEthernetEnabled(boolean enable) + +Description: Setting Ethernet enable. + +Parameter: enable-boolean type, true indicating enable; false indicating disable. + +Return: None. + +#### **C.2.3.2.7 getEthernetState** + +Prototype: public int getEthernetState() + +Description: Getting the Ethernet status. + +Parameter: None. + +Return: Int type, indicating the Ethernet status. + +- ETHERNET\_STATE\_DISABLED, Ethernet disable status; +- ETHERNET\_STATE\_ENABLED, Ethernet enabling status; +- ETHERNET\_STATE\_UNKNOWN, unknown status. + +#### **C.2.3.2.8 getDhcpInfo** + +Prototype: public org.tvos.net.DhcpInfo getDhcpInfo() + +Description: Getting Ethernet DHCP information. + +Parameter: None. + +Return: An org.tvos.net.DhcpInfo object, indicating DHCP information of the Ethernet. + +#### **C.2.3.2.9 getNetLinkStatus** + +Prototype: public boolean getNetLinkStatus() + +Description: Getting physical link status of the network. + +Parameter: None. + +Return: Boolean type, true indicating connected, false indicating not connected. + +#### **C.2.3.2.10 getNetLinkStatus** + +Prototype: public int getNetLinkStatus() + +Description: Specify the network port to get the physical link status of the network. + +Parameter: None. + +Return: int type, 1 indicating connected; 0 indicating not connected; -1 indicating the specified network port is not found. + +#### **C.2.3.2.11 getInterfaceName** + +Prototype: public java.lang.String getInterfaceName() + +Description: Getting the network name. + +Parameter: None. + +Return: A java.lang.String type, indicating the network name. + +#### **C.2.3.2.12 setEthernetMode** + +Prototype: public void setEthernetMode(java.lang.String mode, org.tvos.net.DhcpInfo dhcpInfo) + +Description: Setting the network mode. + +Parameter: mode – java.lang.String type, can have four values: ETHERNET\_CONNECT\_MODE\_DHCP, ETHERNET\_CONNECT\_MODE\_MANUAL, ETHERNET\_CONNECT\_MODE\_PPPOE, ETHERNET\_CONNECT\_MODE\_NONE; + +A dhcpInfo-org.tvos.net.DhcpInfo object, indicating DHCP information. + +Return: None. + +#### **C.2.3.2.13 getEthernetMode** + +Prototype: public java.lang.String getEthernetMode() + +Description: Getting the network mode. + +Parameter: None. + +Return: java.lang.String type, indicating the network mode, which can have four values: ETHERNET\_CONNECT\_MODE\_DHCP, ETHERNET\_CONNECT\_MODE\_MANUAL, ETHERNET\_CONNECT\_MODE\_PPPOE, and ETHERNET\_CONNECT\_MODE\_NONE. + +#### **C.2.3.2.14 getDeviceNameList** + +Prototype: public java.lang.String[] getDeviceNameList() + +Description: Getting the name of the available physical network port. + +Parameter: None. + +Return: A java.lang.String array, indicating the list of network port names. + +#### **C.2.3.2.15 getTotalInterface** + +Prototype: public int getTotalInterface() + +Description: Getting the number of available physical network ports. + +Parameter: None. + +Return: Int type, indicating the number of network ports. + +#### **C.2.3.2.16 enableEthernet** + +Prototype: public void enableEthernet(boolean enable) + +Description: Enabled network. + +Parameter: enable-boolean type, true indicating enable; false indicating disable. + +Return: None. + +#### **C.2.3.2.17 setInterfaceName** + +Prototype: public boolean setInterfaceName(java.lang.String iface) + +Description: Setting the name of the network port. + +Parameter: iface-java.lang.String type, the value being eth0, eth1, etc. + +Return: Boolean type, true indicating success; false indicating failure. + +#### **C.2.3.2.18 getDhcpOption60State** + +Prototype: public int getDhcpOption60State() + +Description: Getting the status of Dhcp Option60/Option61. + +Parameter: None. + +Return: int type, can take the following three values OPTION60\_STATE\_DISABLED, OPTION60\_STATE\_ENABLED, OPTION60\_STATE\_UNKNOWN. + +#### **C.2.3.2.19 getDhcpOption60Login** + +Prototype: public java.lang.String getDhcpOption60Login() + +Description: Getting the username of Dhcp Option61. + +Parameter: None. + +Return: java.lang.String type, indicating the Option 61 username. + +#### **C.2.3.2.20 getDhcpOption60Password** + +Prototype: public java.lang.String getDhcpOption60Password() + +Description: Getting the Dhcp Option60 password. + +Parameter: None. + +Return: java.lang.String type, indicating the password. + +#### **C.2.3.2.21 setDhcpOption60** + +Prototype: public void setDhcpOption60(boolean enable, java.lang.String login, java.lang.String password) + +Description: Setting the username and password of Dhcp Option60. + +Parameter: enable – boolean type, indicating enable or disable; + +login – java.lang.String type, indicating the username; + +password – java.lang.String, indicating the password. + +Return: None. + +#### **C.2.3.2.22 getDhcpOption125State** + +Prototype: public int getDhcpOption125State() + +Description: Getting the status of DHCP Option125. + +Parameter: None. + +Return: int type, the value being OPTION125\_STATE\_DISABLED or OPTION125\_STATE\_ENABLED or OPTION125\_STATE\_UNKNOWN. + +#### **C.2.3.2.23 getDhcpOption125Info** + +Prototype: public java.lang.String getDhcpOption125Info() + +Description: Getting DHCP Option125 information. + +Parameter: None. + +Return: java.lang.String type, indicating DHCP Option125 information. + +#### **C.2.3.2.24 setDhcpOption125** + +Prototype: public void setDhcpOption125(boolean enable, java.lang.String option125Info) + +Description: Setting DHCP Option125 information. + +Parameter: enable-boolean type, indicating enable or disable. + +option125Info – java.lang.String type, indicating Option125 information. + +Return: None. + +#### **C.2.3.2.25 enableIpv6** + +Prototype: public void enableIpv6(boolean enable) + +Description: Enable IPv6. + +Parameter: enable – boolean type, indicating enable or disable. + +Return: None. + +#### **C.2.3.2.26 getIpv6PersistedState** + +Prototype: public int getIpv6PersistedState() + +Description: Getting DHCPv6 status. + +Parameter: None. + +Return: int type, the value being DHCPV6\_STATE\_ENABLED, DHCPV6\_STATE\_DISABLED, DHCPV6\_STATE\_UNKNOWN. + +#### C.2.3.2.27 setEthernetMode6 + +Prototype: public void setEthernetMode6(java.lang.String mode) + +Description: Setting the mode for obtaining IPv6 addresses. + +Parameter: mode-java.lang.String type, the value being ETHERNET\_CONNECT\_MODE\_DHCP or ETHERNET\_CONNECT\_MODE\_MANUAL. + +Return: None. + +### C.3 WiFi management module + +The WiFi management module provides classes and methods related to WiFi network interface control. + +The summary of WiFi management module is shown in Table C.2. + +**Table C.2 – Summary of WiFi management module** + +| Interface | | +|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ActionListener | WiFi status change event listener is implemented by the application layer. | +| Class | | +| WifiInfo | An WiFi connection information class, providing a method to obtain WiFi connection information. | +| WifiManager | An WiFi manager, providing the management function of WiFi wireless network:
1) Find, scan and manage currently available wireless network access points (AP);
2) Manage currently active network access links, such as establishing connection, disconnecting connection, disabling connection, deleting connection, etc. | +| ScanResult | WiFi scan result describes a connection access point information found by the WiFi scan. | + +#### C.3.1 Interface org.tvos.net.wifi.ActionListener + +Prototype: public interface org.tvos.net.wifi.ActionListener + +Description: WiFi status change event listener interface is implemented by the application layer. + +##### C.3.1.1 Method + +###### C.3.1.1.1 onSuccess + +Prototype: public void onSuccess() + +Description: WiFi connection is successful. + +Parameter: None. + +Return: None. + +###### C.3.1.1.2 onFailure + +Prototype: public void onFailure(int reason) + +Description: WiFi connection failed. + +Parameter: reason – int type, indicating the reason for the connection failure. For the value, please refer to the constant field definition of the "WiFi Status" of WifiManager. + +Return: None. + +### **C.3.2 Class org.tvos.net.wifi.WifiInfo** + +Prototype: public class org.tvos.net.wifi.WifiInfo implements org.tvos.os.Parcelable + +Description: WiFi connection information class, describes the WiFi connection status. + +#### **C.3.2.1 Method** + +##### **C.3.2.1.1 getMacAddress** + +Prototype: public java.lang.String getMacAddress() + +Description: Getting the hotspot routing MAC address. + +Parameter: None. + +Return: java.lang.String object, indicating the hotspot routing MAC address. + +##### **C.3.2.1.2 getSSID** + +Prototype: public java.lang.String getSSID() + +Description: Getting the SSID of the current network connection. + +Parameter: None. + +Return: java.lang.String object, indicating the SSID of the current network connection. + +##### **C.3.2.1.3 isHiddenSSID** + +Prototype: public boolean isHiddenSSID() + +Description: Determine whether the current connection hides the SSID (that is, does not broadcast the SSID). + +Parameter: None. + +Return: boolean type, indicating whether the connection is to hide the SSID, true value indicating that the SSID is hidden, and the false value indicating that the SSID is broadcast. + +##### **C.3.2.1.4 getLinkSpeed** + +Prototype: public int getLinkSpeed() + +Description: Getting the speed of the network connection. + +Parameter: None. + +Return: Int type, indicating the network connection speed in megabits per second (Mb/s). + +##### **C.3.2.1.5 getNetworkId** + +Prototype: public int getNetworkId() + +Description: Getting the identifier number of the current network connection. + +Parameter: None. + +Return: Int type, indicating the network identifier of the current network connection. + +##### **C.3.2.1.6 getBSSID** + +Prototype: public java.lang.String getBSSID() + +Description: Getting the BSSID of the access point. + +Parameter: None. + +Return: java.lang.String type, returning the BSSID of the access point. + +#### **C.3.2.1.7 getIpAddress** + +Prototype: public int getIpAddress() + +Description: Getting the ip address of the current connection. + +Parameter: None. + +Return: Int type, indicating the IP address of the current connection. + +#### **C.3.2.1.8 getFrequency** + +Prototype: public int getFrequency() + +Description: Getting the transmit frequency of the current connection. + +Parameter: None. + +Return: Int type, indicating the transmitting frequency of the current connection, in MHz. + +### **C.3.3 Class org.tvos.net.wifi.WifiManager** + +Prototype: public class org.tvos.net.wifi.WifiManager + +Description: A WiFi manager, providing the management function of WiFi wireless network: + +- 1) Find, scan and manage currently available wireless network access points (AP); +- 2) Manage the currently active network access links, such as establishing a connection, disconnecting the connection, disabling the connection, and deleting the connection. + +#### **C.3.3.1 Constant field – WiFi status** + +##### **C.3.3.1.1 ERROR\_AUTHENTICATING** + +Prototype: public static final int ERROR\_AUTHENTICATING = 1 + +Description: The error code returned when authentication fails. + +##### **C.3.3.1.2 WIFI\_STATE\_DISABLING** + +Prototype: public static final int WIFI\_STATE\_DISABLING = 0 + +Description: Intermediate state when wifi is disabled. + +##### **C.3.3.1.3 WIFI\_STATE\_DISABLED** + +Prototype: public static final int WIFI\_STATE\_DISABLED = 1 + +Description: WiFi disabled state. + +##### **C.3.3.1.4 WIFI\_STATE\_ENABLING** + +Prototype: public static final int WIFI\_STATE\_ENABLING = 2 + +Description: Intermediate state of wifi enabled. + +##### **C.3.3.1.5 WIFI\_STATE\_ENABLED** + +Prototype: public static final int WIFI\_STATE\_ENABLED = 3 + +Description: WiFi enabled state. + +##### **C.3.3.1.6 WIFI\_STATE\_UNKNOWN** + +Prototype: public static final int WIFI\_STATE\_UNKNOWN = 4 + +Description: wifi unknown status. When returning to this status, it means that there is usually an error. + +### **C.3.3.2 Method** + +#### **C.3.3.2.1 WifiManager** + +Prototype: public WifiManager(org.tvos.content.Context context, org.tvos.net.wifi.IWifiManager service) + +Description: Getting an example of the WiFi wireless network manager implemented by the system. + +Parameter: context-org.tvos.content.Context object, indicating the context of the application; +service-org.tvos.net.wifi.Iwifimanager object, indicating WiFi service. + +Return: None. + +#### **C.3.3.2.2 getConfiguredNetworks** + +Prototype: public List
[ { "deliveryType":1, "deliveryParams":[ {"frequency":626000, "symbolRate":6875, "modulation":3}, {"frequency":634000, "symbolRate":6875, "modulation":3}, {"frequency":642000, "symbolRate":6875, "modulation":3} ] }, ... { "deliveryType":10, "deliveryParams":[ {"frequency":12020, "symbolRate":28800, "polarization":3} ] }, { "deliveryType":12, "deliveryParams":[ {"frequency":642000} ] } ] NOTE – The JSON format of the key value of the DVBMainFrequencyInfo key can describe multiple transmission systems, and each transmission system can describe multiple main frequency point information. In this example, the above JSON string describes the DVB-C, ABS-SS, and DTMB transmission systems, where DVB-C
| + +**Table G.2 – Key name and key value table of system data table** + +| Key Name | Key Value | | +|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | transmission system contains 3 main frequency point information, and ABS-SS transmission system contains 1 main frequency point information. DTMB transmission system includes 1 main frequency point information. | | +| DVBMainFrequencyInfo | deliveryType | Int type, indicating the type of the delivery system. For the values, refer to the constant field definition of the DeliverySystemType interface and the DvbDeliverySystemType interface "Delivery System Type". | +| | Frequency | Int type, indicating the tuning frequency, and is measured in a unit related to the value of the deliveryType field:- – If deliveryType=1, it indicates DVB-C delivery system, in kHz;
- – If deliveryType=10, it indicates ABS-SS delivery system, in MHz;
- – If deliveryType=12, it indicates DTMB delivery system, in kHz;
- – If deliveryType is another value, this key is meaningless.
- – If deliveryType=12, it indicates DTMB delivery system, this key is meaningless.
- – If deliveryType=1, it indicates DVB-C delivery system. For the value, please refer to the constant field definition of "modulation mode" of DvbcTunningParameters class;
- – If deliveryType is another value, this key is meaningless.
- – If deliveryType=10, it indicates ABS-SS delivery system. For the value, please refer to the "Polarization Mode" constant field definition of AbsssTunningParameters class;
- – If deliveryType is another value, this key is meaningless.
int type, indicating the start date for searching the program table. The default is 0, indicating that the current day will be the start date of the search, 1 indicating the | + +**Table G.2 – Key name and key value table of system data table** + +| Key Name | Key Value | | | +|--------------|-------------|------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | second day, 2 indicating the third day,..., and so on. | +| | | search_days | Int type, indicating how many consecutive days the program table will search. | +| | | program_event_max_count | Int type, indicating the maximum number of EPG searching program events. If the value is -1, it indicates unlimited. | +| AudioSetting | Use | Describe audio settings information. | | +| | JSON Format | {
"enableGlobalVolume":0,
"outputVolume":50,
"spdifMode":"PCM",
"soundMode":0
} | | +| AudioSetting | Description | enableGlobalVolume | Int type, indicating whether to enable unified volume control, value:
– 0-indicating that the application allows users to individually set the volume of each channel;
– 1-indicating that the volume of all live TV, audio broadcast, near video on demand (NVOD), and mosaic is unified as the outputVolume value. | +| | | outputVolume | Int type, indicating that the receiving terminal outputs analog volume, the value range being 0-100, 0 indicating mute, 100 indicating maximum volume, and taking effect immediately after setting. | +| | | spdifMode | Character string, indicating the signal format of the SPDIF output interface of the receiving terminal. The value is:
– "ORIGINAL" – indicating original code output (not decoded);
– "PCM" – indicating PCM format output (decoded);
– "default" – indicating that the original code or PCM output is determined according to the stream_type field value of the PMT table;
– "OFF" – indicating that SPDIF output is turned off. | +| | | soundMode | Int type, indicating a channel mode. The value is:
– 0-indicating stereo sound;
– 1-indicating a single left channel, that is, there is no sound in the right channel;
– 2-indicating a single right channel, that is, there is no sound in the left channel;
– 3-indicating mixing. | +| VideoSetting | Use | Describe video settings information. | | +| | JSON format | {
"videoStandard":27400,
"OSDAlpha":0
} | | + +**Table G.2 – Key name and key value table of system data table** + +| Key Name | Key Value | | | +|----------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Description | videoStandard | Int type, indicating the video output format. For the value, see the constant field definition of "output format" of VideoSetting class. | +| | | OSDAlpha | Int type, indicating the transparency of the OSD layer, the value range being 0-100, 0 indicating completely opaque, and 100 indicating completely transparent. | +| UserPreference | Use | Describe user preference setting information. | | +| | JSON Format | {
"audioLang":"zho",
"osdLang":"eng"
} | | +| | Description | audioLang | A character string, indicating the audio language preferred by the user. Three-letter language code follows GB/T 4880.2-2000 standard. | +| | | osdLang | A character string, indicating the user's preferred interface language. Three-letter language code follows GB/T 4880.2-2000 standard. | +| Portal | Use | Describe portal server address information. | | +| | JSON format | {
"address":"http://ngb.com",
"port":8080
} | | +| | Description | address | A character string, indicating a portal server address. | +| | | port | Int type, indicating an access port of the portal server. | +| NTP | Use | Describe network time protocol (NTP) server address information. | | +| | JSON format | {
"address":"http://ntp.com",
"port":8080
} | | +| | Description | address | A character string, indicating NTP server address. | +| | | port | Int type, indicating an access port of the NTP server. | +| VODChannel | Use | Describe VOD server address information. | | +| | JSON format | {
"MD5":"5A8B6493",
"VODParams":[
{
"frequency":634000,
"symbolRate":6875,
"modulation":3,
"QAMName":1234
},
{
"frequency":642000,
"symbolRate":6875,
"modulation":3,
"QAMName":4321
} | | + +**Table G.2 – Key name and key value table of system data table** + +| Key Name | Key Value | | | +|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| |
}, { "frequency":650000, "symbolRate":6875, "modulation":3, "QAMName":8888 } ] } NOTE – Only applicable to cable digital TV. | | |
+| VODChannel | Description | MD5 | A character string, indicating MD5 code of configuration file. |
+| | | frequency | Int type, indicating the frequency of IPQAM frequency point, in kHz. |
+| | | symbolRate | Int type, indicating a symbol rate of IPQAM frequency point, in ksymbol/s. |
+| | | modulation | Int type, indicating IPQAM frequency point modulation mode. For the value, please refer to the constant field definition of "modulation mode" in the DvbcTunningParameters class. |
+| | | QAMName | Int type, indicating VOD area code. |
+| UserInfo | Use | Describe end user information. | |
+| | JSON format | { "account":"882012459", "customerGroup":"group1", "adminPassword":"12345" } | |
+| | Description | account | A character string, indicating a device account (UserID, user account information synchronized by BOSS/SMS). |
+| | | customerGroup | A character string, indicating a user group where the terminal is located. |
+| | | adminPassword | A character string, indicating an administrator password, used to enter the system setting interface and watch locked channels. |
+| Autodeployer | Use | Describe application automatic deployment information. | |
+| | JSON format | { "mode":"auto-ip", "ocPath":[ { "deliveryType":1, "deliveryParams":[ {"frequency":626000, "symbolRate":6875, "modulation":3}, {"frequency":634000, "symbolRate":6875, "modulation":3}, {"frequency":642000, "symbolRate":6875, "modulation":3} ] } ], ... ] | |
+
+**Table G.2 – Key name and key value table of system data table**
+
+| Key Name | | Key Value | |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| "ipPath":[ { "udpPath":"192.168.1.12", "udpPort":8080, "downloadTimeOut":60 }, ... ] } NOTE – A one-way broadcast channel supports multiple delivery systems and multiple frequency points to issue XML signaling files; and a two-way broadband channel supports multiple UDP servers to issue XML signaling files.
| | | | +| Description | | mode |A character string indicating the method of obtaining the XML signaling file for automatic deployment. The value is:
- – "ip" – means to obtain the XML signaling file from the two-way broadband channel;
- – "oc" – means to obtain the XML signaling file from the one-way broadcast channel;
- – "auto-ip" – means self-adaptation, preferentially obtain XML signaling files from the two-way broadband channel;
- – "auto-oc" – means self-adaptation, preferentially obtain XML signaling file from unidirectional broadcast channel.
JSON object type, indicating OC download path of the xml signaling file that is automatically deployed.
- – deliveryType: Int type, indicating the type of delivery system, same as the explanation of the DVBMainFrequencyInfo key;
- – deliveryParams: JSON object, same as the explanation of the DVBMainFrequencyInfo key.
JSON object type, indicating ip download path of the xml signaling file for automatic deployment.
- – udpPath: A character string, indicating UDP server address;
- – udpPort: Int type, indicating UDP service port;
- – downloadTimeOut: Int type, indicating the application download timeout time, in seconds.
CASEventListener | It should be implemented by applications that need to receive CAS events. |
+| CASAppInfo | It provides information about DCAS applications. |
+| CASEventInfo | It provides CASEvent information. |
+| Class | |
+| CASEventManager | The application uses CASEventManager registration listener to obtain CAS events. |
+
+##### K.4.1 Interface `org.ngb.net.cas.event.CASEventListener`
+
+Prototype: `public interface org.ngb.net.cas.event.CASEventListener`
+
+Description: This interface should be implemented by applications that need to receive CAS events. `CASEvents` provides the CA Status and basic information of the current `ServiceContext`.
+
+###### K.4.1.1 Method
+
+###### K.4.1.1.1 `receiveCASEvent`
+
+Prototype: `public void receiveCASEvent(java.lang.Object serviceContext, int appId, int orgId, boolean isSuccess, int caToken)`
+
+Description: This method is used to deliver CAS events to applications registered with CAS event listeners.
+
+Parameter: `serviceContext` – A `java.lang.Object` object, a handle to which the CAS event belongs.
+
+`appId` – int type, used to identify the DCAS application sending the event. These identifiers can be applied to communicate through IXC and DCAS applications. When there is no DCAS application that can descramble a given code stream, the terminal software platform should use the value null as the value of `appId` to call this method, and the application that obtains this kind of CAS event notification should handle this situation according to its own design and implementation;
+
+`orgId` – int type, used to identify the DCAS application that sent the event. Identify the organization to which the App belongs;
+
+`isSuccess` – boolean type, a boolean value to indicate whether descrambling was successful;
+
+`caToken` – int type, a token of the DCAS application sent back through the IXC, and the application can use the token to query the DCAS application for specific network information through the IXC.
+
+Return: None.
+
+#### **K.4.1.1.2 receiveCASOSDEvent**
+
+Prototype: public void receiveCASOSDEvent(java.lang.Object serviceContext, int appId, int orgId, byte[] msg, int[] flag)
+
+Description: This method is used to deliver OSD events of CAS to applications registered with CAS event listeners.
+
+Parameter: serviceContextCAS – java.lang.Object object, a handle to which the event belongs;
+
+appId – int type, used to identify the DCAS application that sent the event. These identifiers can be applied to communicate through IXC and DCAS applications. When there is no DCAS application that can descramble a given code stream, the terminal software platform should use the value null as the value of casAppId to call this method, and the application that obtains such a CAS event notification should handle this situation according to its own design and implementation;
+
+orgId – int type, used to identify the DCAS application that sent the event, and identify the organization to which the App belongs.
+
+msg – A byte array, used to deliver OSD content;
+
+flag – An int array, used to identify the type of OSD.
+
+Return: None.
+
+#### **K.4.1.1.3 receiveCASFingerEvent**
+
+Prototype: public void receiveCASFingerEvent(java.lang.Object serviceContext, int appId, int orgId, byte[] msg)
+
+Description: This method is used to pass the CAS fingerprint event to the application registered with the CAS event listener.
+
+Parameter: serviceContext – java.lang.Object object, a handle to which the CAS event belongs;
+
+appId – int type, used to identify the DCAS application sending the event. These identifiers can be applied to communicate through IXC and DCAS applications. When there is no DCAS application that can descramble a given code stream, the terminal software platform should use the value null as the value of casAppId to call this method, and the application that obtains such a CAS event notification should handle this situation according to its own design and implementation;
+
+orgId – int type, used to identify the DCAS application that sent the event. Identify the organization to which the App belongs;
+
+msg – A byte array, used to pass content of fingerprints.
+
+Return: None.
+
+### **K.4.2 Interface org.ngb.net.cas.event.CASAppInfo**
+
+Prototype: public interface org.ngb.net.cas.event.CASAppInfo
+
+Description: This interface provides information about DCAS applications.
+
+#### **K.4.2.1 Method**
+
+##### **K.4.2.1.1 getAID**
+
+Prototype: public int getAID()
+
+Description: This method returns Application ID of DCAS application.
+
+Parameter: None.
+
+Return: int type, application ID of DCAS application.
+
+#### **K.4.2.1.2 getOID**
+
+Prototype: public int getOID()
+
+Description: This method returns organization ID of the DCAS application.
+
+Parameter: None.
+
+Return: int type, organization ID of the DCAS application.
+
+### **K.4.3 Interface org.ngb.net.cas.event.CASEventInfo**
+
+Prototype: public interface org.ngb.net.cas.event.CASEventInfo
+
+Description: This interface provides CASEvent information.
+
+#### **K.4.3.1 Constant field**
+
+##### **K.4.3.1.1 TYPE\_PRESENTATION**
+
+Prototype: public static final int TYPE\_PRESENTATION = 0x00000001
+
+Description: It indicates the type of TYPE\_PRESENTATION.
+
+##### **K.4.3.1.2 TYPE\_RECORDING**
+
+Prototype: public static final int TYPE\_RECORDING = 0x00000002
+
+Description: It indicates the type of TYPE\_RECORDING.
+
+##### **K.4.3.1.3 TYPE\_BUFFERING**
+
+Prototype: public static final int TYPE\_BUFFERING = 0x00000004
+
+Description: It indicates the type of TYPE\_PRESENTATION.
+
+#### **K.4.3.2 Method**
+
+##### **K.4.3.2.1 getType**
+
+Prototype: public int getType()
+
+Description: This method returns type of operation that generated the CAS Event.
+
+Parameter: None.
+
+Return: int type, type of operation, it can be one or a combination of the values defined in this interface.
+
+##### **K.4.3.2.2 getNetworkInterface**
+
+Prototype: public org.davic.net.tuning.NetworkInterface getNetworkInterface()
+
+Description: This method returns NetworkInterface related to CAS Event.
+
+Parameter: None.
+
+Return: one org.davic.net.tuning.NetworkInterface object.
+
+##### **K.4.3.2.3 getAssociatedService**
+
+Prototype: public java.lang.Object getAssociatedService()
+
+Description: This method returns service associated with CAS Event.
+
+Parameter: None.
+
+Return: one Service object.
+
+#### **K.4.3.2.4 getServiceContext**
+
+Prototype: public java.lang.Object getServiceContext()
+
+Description: This method returns ServiceContext associated with CAS event.
+
+Note that ServiceContext has no practical meaning in some operations. This method returns null.
+
+Parameter: None.
+
+Return: one ServiceContext object.
+
+#### **K.4.4 Class org.ngb.net.cas.event.CASEventManager**
+
+Prototype: public class org.ngb.net.cas.event.CASEventManager
+
+Description: The application uses CASEventManager to register a listener to obtain CAS events.
+
+CAS events provide the current CA Status and basic information.
+
+##### **K.4.4.1 Method**
+
+###### **K.4.4.1.1 getInstance**
+
+Prototype: public static org.ngb.net.cas.event.CASEventManager getInstance()
+
+Description: This method is used to obtain a single CASEventManager instance.
+
+Parameter: None.
+
+Return: org.ngb.net.cas.event.CASEventManager instance.
+
+###### **K.4.4.1.2 addListener**
+
+Prototype: public void addListener(org.ngb.net.cas.event.CASEventListener aCASEventListener)
+
+Description: This method is used to register a CASEventListener for the application. The listener is used to pass all CAS events.
+
+Parameter: aCASEventListener — org.ngb.net.cas.event.CASEventListener object, CASEventListener that needs to be registered.
+
+Return: None.
+
+###### **K.4.4.1.3 removeListener**
+
+Prototype: public void removeListener(org.ngb.net.cas.event.CASEventListener aCASEventListener)
+
+Description: This method is used to unregister a CASEventListener for the application.
+
+Parameter: aCASEventListener — org.ngb.net.cas.event.CASEventListener object, CASEventListener that has been registered.
+
+Return: None.
+
+#### **K.5 CAS listener module**
+
+The CAS listener module provides a DCAS detachable security device API.
+
+The summary of the CAS listener module is shown in Table K.4.
+
+**Table K.4 – Summary of CAS listener module**
+
+| Interface | |
+|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
+| DetachbleSecurityDevice | A listener for an application to register a detachable security device to obtain a plug-in/out status of the device. |
+| DetachbleSecurityDeviceListener | A listener for the detachable safety device, should be implemented by an application that needs to listen to the plug-in/out status of the device. |
+
+**K.5.1 Interface org.ngb.net.cas.detachable.DetachableSecurityDevice**
+
+Prototype: public interface org.ngb.net.cas.detachable.DetachableSecurityDevice
+
+Description: This interface indicates a component (smart card, etc.) used to control communication with a detachable safety device.
+
+**K.5.1.1 Method**
+
+**K.5.1.1.1 open**
+
+Prototype: public void open() throws org.ngb.net.cas.controller.CADriverException
+
+Description: This method is used to initiate a session between the detachable security devices for the DCAS application.
+
+Parameter: None.
+
+Return: None.
+
+Exception: org.ngb.net.cas.controller.CADriverException, if a driver error occurs, this exception is thrown.
+
+**K.5.1.1.2 close**
+
+Prototype: public void close() throws org.ngb.net.cas.controller.CADriverException
+
+Description: This method is used to close the session between the detachable security devices for the DCAS application.
+
+Parameter: None.
+
+Return: None.
+
+Exception: org.ngb.net.cas.controller.CADriverException, if a driver error occurs, this exception is thrown.
+
+**K.5.1.1.3 reset**
+
+Prototype: public byte[] reset() throws org.ngb.net.cas.controller.CADriverException
+
+Description: This method is used to reset the detachable security device and return the data (the data is ATR in the case of a smart card).
+
+Parameter: None.
+
+Return: A byte array, data returned by the reset of the storage device.
+
+Exception: An org.ngb.net.cas.controller.CADriverException, if a driver error occurs, this exception is thrown.
+
+**K.5.1.1.4 sendData**
+
+Prototype: public void sendData(byte [] data) throws org.ngb.net.cas.controller.CADriverException
+
+Description: This method is used in the DCAS application to send data to a detachable security device.
+
+Parameter: data – A byte array, data that needs to be sent.
+
+Return: None.
+
+Exception: An org.ngb.net.cas.controller.CADriverException, if a driver error occurs, this exception is thrown.
+
+#### **K.5.1.1.5 registerListener**
+
+Prototype: public void
+
+registerListener(org.ngb.net.cas.detachable.DetachableSecurityDeviceListener aListener)
+
+Description: This method is used for the DCAS application to register a listener that receives data sent by a detachable safety device.
+
+Parameter: aListener – An org.ngb.net.cas.detachable.DetachableSecurityDeviceListener to be registered.
+
+Return: None.
+
+#### **K.5.1.1.6 removeListener**
+
+Prototype: public void removeListener()
+
+Description: This method is used in DCAS applications to delete registered listeners.
+
+Parameter: None.
+
+Return: None.
+
+### **K.5.2 Interface org.ngb.net.cas.detachable.DetachableSecurityDeviceListener**
+
+Prototype: public interface org.ngb.net.cas.detachable.DetachableSecurityDeviceListener
+
+Description: This interface should be implemented by the DCAS application to receive the status of the detachable safety device and the data sent.
+
+#### **K.5.2.1 Field**
+
+##### **K.5.2.1.1 DEVICE\_IN**
+
+Prototype: public static final int DEVICE\_IN = 1
+
+Description: It is used to describe a state of a detachable security device: plug-in (smart card is plugged in in the case of a smart card).
+
+##### **K.5.2.1.2 DEVICE\_OUT**
+
+Prototype: public static final int DEVICE\_OUT = 2
+
+Description: It is used to describe a state of a detachable security device: plug-out (smart card is plugged out in the case of a smart card).
+
+##### **K.5.2.1.3 DEVICE\_ERROR**
+
+Prototype: public static final int DEVICE\_ERROR = 3
+
+Description: It is used to describe a state of a detachable security device: error (it indicates an error of smart card in the case of a smart card).
+
+#### **K.5.2.2 Method**
+
+##### **K.5.2.2.1 receiveDeviceStatus**
+
+Prototype: public void receiveDeviceStatus(int status)
+
+Description: This method should be implemented by the DCAS application to receive the state of the detachable safety device. Notify the DCAS application when the state of the detachable safety device changes.
+
+Parameter: status – int type, the state of the detachable safety device.
+
+Return: None.
+
+#### **K.5.2.2.2 receiveData**
+
+Prototype: public void receiveData(byte[] data)
+
+Description: This method is called when the detachable security device sends data to the DCAS application.
+
+Parameter: data – A byte array, data sent by the detachable security device.
+
+Return: None.
+
+## Annex L
+
+### JavaScript-Unidirectional broadcast network access unit
+
+(This annex forms an integral part of this Recommendation.)
+
+#### L.1 Overview
+
+This annex defines the JavaScript interface related to one-way broadcast network access, mainly the tuning and demodulation module.
+
+#### L.2 Tuning and demodulation module
+
+This module defines JS objects related to tuning and demodulation: DvbctuningParameters, AbsssTuningParameters, DtmbTuningParameters, DvbTune, DvbTunerInfo, DvbScan. The structural relationship is as follows:
+
+
+
+The diagram illustrates the object structure of the tuning and demodulation module. It shows a vertical hierarchy of objects. At the top, three objects are grouped together by a grey bracket: DvbctuningParameters, AbsssTuningParameters, and DtmbTuningParameters. Below this group is DvbTune. An arrow labeled 'getAllTunerInfos' points from DvbTune to the next object, DvbTunerInfo. DvbTunerInfo and DvbScan are grouped together by another grey bracket at the bottom. The label 'J.1206(24)' is located at the bottom right of the diagram.
+
+Object structure diagram of the tuning and demodulation module
+
+Figure L.1 – Object structure diagram of the tuning and demodulation module
+
+##### L.2.1 Message
+
+See Table L.1 for Message definitions that the tuning and demodulation module may send to the application layer.
+
+Table L.1 – Tuning and demodulating module messages
+
+| Message name | event.which | event.modifiers | Message description |
+|----------------------|-------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| MSG_DVB_TUNE_SUCCESS | 10001 | number | Locking is successful, the JSON format of the message character string is:{ "deliveryType":param1 Note 1 ,
"freq":param2 Note 2 } | + +**Table L.1 – Tuning and demodulating module messages** + +| Message name | event.which | event.modifiers | Message description | +|-----------------------------|-------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MSG_DVB_TUNE_FAILED | 10002 | number | Locking failed, the JSON format of the message character string is:
{"deliveryType":param1,
"freq":param2} | +| MSG_DVB_TUNE_SIGNAL_WEAK | 10003 | number | The signal at the current frequency point is weak, and the JSON format of the message character string is:
{"deliveryType":param1,
"freq":param2} | +| MSG_DVB_TUNE_SIGNAL_LOST | 10004 | number | The signal at the current frequency point is lost, and the JSON format of the message character string is:
{"deliveryType":param1,
"freq":param2} | +| MSG_DVB_TUNE_SIGNAL_RECOVER | 10005 | number | The signal at the current frequency point is restored, and the JSON format of the message character string is:
{"deliveryType":param1,
"freq":param2} | +| Reserved | 10006~10024 | – | | +| MSG_DVB_SCAN_START | 10025 | number | The channel scan starts, and the JSON format of the message character string is:
{"deliveryType":param1} | +| MSG_DVB_SCAN_FINISHED | 10026 | number | The channel scan is completed, the JSON format of the message character string is:
{"deliveryType":param1} | +| MSG_DVB_SCAN_FAILED | 10027 | number | The channel scan failed, and the JSON format of the message character string is:
{"deliveryType":param1}
Send this message if no service is found after the channel scan is over. | + +**Table L.1 – Tuning and demodulating module messages** + +| Message name | event.which | event.modifiers | Message description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MSG_DVB_SCAN_FIND_SERVICES | 10028 | number | The channel scan finds the service, the JSON format of the message character string is:
{
"deliveryType": param1,
"freq": param2,
"serviceCount": param3
}
This message is sent when the current frequency point search is finished. | +| MSG_DVB_SCAN_STOP_SUCCESS | 10029 | number | Succeeded in terminating the search, the JSON format of the message character string is:
{"deliveryType": param1} | +| MSG_DVB_SCAN_STOP_FAILED | 10030 | number | Failed to terminate the search, the JSON format of the message character string is:
{"deliveryType": param1}
(It's better to return the reason for failure) | +| Reserved | 10031~10100 | – | | +| MSG_DVB_SCAN_SAVE_SUCCESS | 10101 | – | Succeeded in saving the channel data to NVM. | +| MSG_DVB_SCAN_SAVE_FAILED | 10102 | – | Failed to save the channel data to NVM. | +| MSG_DVB_SCAN_REVERT_SUCCESS | 10103 | – | Succeeded in importing the channel data from NVM. | +| MSG_DVB_SCAN_REVERT_FAILED | 10104 | – | Failed to import the channel data from NVM. | +| MSG_DVB_SCAN_DELETE_SUCCESS | 10105 | – | Succeeded in clearing the channel data in NVM and RAM. | +| MSG_DVB_SCAN_DELETE_FAILED | 10106 | – | Failed to clear the channel data in NVM and RAM. | +| Reserved | 10107~10200 | | | +|
The value of event.modifiers is automatically given by the system, and its data type is:
- – "number", indicating that the value is the ID of the message description character string, which can be obtained through the Utility.getEventInfo() method.
- – "-", indicating event.modifiers is undefined.
NOTE 1 – param1: number type, see the constant definition of "Type of DVB delivery system" for the value.
NOTE 2 – param2: number type, indicating the frequency at the frequency point. If the value of deliveryType is 10 (indicating ABS-SS delivery system), it is measured in MHz; otherwise in kHz.
NOTE 3 – param3: number type, indicating the number of services found in the frequency point specified by param2.
| | | | + +## L.2.2 Constants + +The definition of tuning and demodulation module constants is shown in Table L.2. + +**Table L.2 – Tuning and demodulation module constants** + +| Constants | Description | +|--------------------------------------|---------------------------------------------------------| +| Type of DVB delivery system | | +| const DVB_DELIVERY_TYPE_DVB_C = 1; | DVB-C delivery system | +| const DVB_DELIVERY_TYPE_ABS_SS = 10; | ABS-SS delivery system | +| const DVB_DELIVERY_TYPE_DTMB = 12; | DTMB delivery system | +| DVB-C Modulation mode | | +| const DVB_C_MOD_UNDEFINED = 0; | undefined | +| const DVB_C_MOD_QAM16 = 1; | 16-QAM. | +| const DVB_C_MOD_QAM32 = 2; | 32-QAM. | +| const DVB_C_MOD_QAM64 = 3; | 64-QAM. | +| const DVB_C_MOD_QAM128 = 4; | 128-QAM. | +| const DVB_C_MOD_QAM256 = 5; | 256-QAM. | +| ABS-SS Polarization mode | | +| const ABS_SS_POLAR_LINEAR_H = 0; | Linear polarization-horizontal polarization. | +| const ABS_SS_POLAR_LINEAR_V = 1; | Linear polarization-vertical polarization. | +| const ABS_SS_POLAR_CIRCULAR_L = 2; | Circular polarization-left-hand circular polarization. | +| const ABS_SS_POLAR_CIRCULAR_R = 3; | Circular polarization-Right-hand circular polarization. | +| DTMB Modulation mode | | +| const DTMB_MOD_UNDEFINED = 0; | Undefined | +| const DTMB_MOD_QAM4 = 1; | 4-QAM. | +| const DTMB_MOD_QAM4_NR = 2; | 4-QAM-NR. | +| const DTMB_MOD_QAM16 = 3; | 16-QAM. | +| const DTMB_MOD_QAM32 = 4; | 32-QAM. | +| const DTMB_MOD_QAM64 = 5; | 64-QAM. | + +## L.2.3 DvbcTuningParameters object + +DvbcTuningParameters object is a local object, which indicates the tuning and demodulation parameters applicable to the DVB-C delivery system. + +Example 1: + +``` +//create DvbcTuningParameters object +var dvbcParams = new DvbcTuningParameters(); +dvbcParams.frequency = 312000; //312.000MHz +dvbcParams.symbol_rate = 27450; //27.450Msymbol/s +dvbcParams.modulation = DVB_C_MOD_QAM64; //64 QAM +``` + +Example 2: + +``` +//create DvbcTuningParameters object +var dvbcParams = new DvbcTuningParameters(312000, 27450, DVB_C_MOD_QAM64); +``` + +### L.2.3.1 Property + +The definition of the DvbcTuningParameters object property is shown in Table L.3. + +NOTE – For the properties of DvbcTuningParameters, see the definition of cable\_delivery\_system\_descriptor in GB/T 28161-2011. + +**Table L.3 – Properties of DvbcTuningParameters objects** + +| Property name | Type | Properties of read and write | Description | +|---------------|--------|------------------------------|-----------------------------------------------------------------| +| frequency | number | Read/write | It indicates the tuning frequency of the DVB-C signal, in kHz. | +| symbol_rate | number | Read/write | It indicates the symbol rate of the DVB-C signal, in ksymbol/s. | +| modulation | number | Read/write | It indicates the DVB-C signal modulation mode. | + +### L.2.3.2 Method + +#### L.2.3.2.1 DvbcTuningParameters + +Prototype: DvbcTuningParameters() + +Description: A Construction method, creating a default DVB-C tuning and demodulation parameter object. + +Parameter: None. + +#### L.2.3.2.2 DvbcTuningParameters + +Prototype: DvbcTuningParameters(frequency, symbolRate, modulation) + +Description: A Construction method, creating a DVB-C tuning and demodulation parameter object according to the specified parameters. + +Parameter: frequency – number type, indicating the tuning frequency of the DVB-C signal, in kHz; +symbolRate – number type, indicating the symbol rate of the DVB-C signal, in ksymbol/s; +modulation – number type, indicating the DVB-C signal modulation mode. + +### L.2.4 AbsssTuningParameters object + +An AbsssTuningParameters object is a local object, indicating the tuning and demodulation parameters of the ABS-SS delivery system. + +Example 1: + +``` +//create AbsssTuningParameters object: +var absssParams = new AbsssTuningParameters(); +absssParams.frequency = 12020; //12.020GHz +absssParams.symbol_rate = 28800; //28.8Msymbol/s +absssParams.polarization = ABS_SS_POLAR_CIRCULAR_R; //Right-handed circular polarization +``` + +Example 2: + +``` +//create AbsssTuningParameters object +var absssParams = new AbsssTuningParameters(12020, 28800, ABS_SS_POLAR_CIRCULAR_R); +``` + +#### L.2.4.1 Properties + +The definition of the AbsssTuningParameters object property is shown in Table L.4. + +**Table L.4 – Table of AbsssTuningParameters properties** + +| Property name | Type | Property | Description | +|---------------|--------|------------|------------------------------------------------------------------| +| frequency | number | Read/write | It indicates the frequency of the ABS-SS signal, in MHz. | +| symbol_rate | number | Read/write | It indicates the symbol rate of the ABS-SS signal, in ksymbol/s. | +| polarization | number | Read/write | It indicates the polarization mode of the ABS-SS signal. | + +#### L.2.4.2 Method + +##### L.2.4.2.1 AbsssTuningParameters + +Prototype: AbsssTuningParameters() + +Description: Construction method. + +Parameter: None. + +##### L.2.4.2.2 AbsssTuningParameters + +Prototype: AbsssTuningParameters(frequency, symbol\_rate, polarization) + +Description: Construction method. + +Parameter: frequency – number type, ABS-SS signal frequency, in MHz; + +symbol\_rate – number type, ABS-SS signal symbol rate, in ksymbol/s; + +polarization– number type, indicating the polarization mode of the ABS-SS signal. + +#### L.2.5 DtmbTuningParameters object + +DtmbTuningParameters object is a local object, which indicates the tuning and demodulation parameters of the DTMB delivery system. + +Example 1: + +//Create DtmbTuningParameters object: + +``` +var dtmbParams = new DtmbTuningParameters(); +``` + +``` +dtmbParams.frequency = 714000; //714.000MHz +``` + +Example 2: + +``` +var dtmbParams = new DtmbTuningParameters(714000); +``` + +#### L.2.5.1 Properties + +The definition of the DtmbTuningParameters object property is shown in Table L.5. + +NOTE – For the DtmbTuningParameters property, please refer to the definition of terrestrial\_delivery\_system\_descriptor in GB/T 28161-2011. + +**Table L.5 – Table of DtmbTuningParameters properties** + +| Property name | Type | Property | Description | +|---------------|--------|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| frequency | number | Read/write | It indicates the center frequency of the DTMB signal, in kHz. | +| modulation | number | Read only | It indicates the modulation mode of DTMB signal. | +| codingRatio | string | Read only | It indicates the coding efficiency of DTMB signal, which can be "0.4", "0.6" or "0.8". | +| PNMode | string | Read only | It indicates the frame header mode of DTMB signal, which can be a value such as "PN945". This property is meaningful only after successful tuning and demodulation. | + +**L.2.5.2 Method** + +**L.2.5.2.1 DtmbTuningParameters** + +Prototype: DtmbTuningParameters() + +Description: A Construction method. + +Parameter: None. + +**L.2.5.2.2 DtmbTuningParameters** + +Prototype: DtmbTuningParameters(frequency) + +Description: A Construction method. + +Parameter: frequency – number type, indicating the center frequency of DTMB signal, in kHz; + +**L.2.6 DvbTune object** + +DvbTune object is a built-in object, which realizes channel tuning and signal demodulation. Two types of objects are defined. NGBDvbTune() defaults tunerId to 0, and NGBDvbTune(tunerId) specifies the tunerId when creating the object. + +**L.2.6.1 Method** + +**L.2.6.1.1 tune** + +Prototype: tune(deliveryType, paramsObj) + +Description: An Asynchronous method, tuning to the specified frequency point. + +- If the frequency lock is successful, the message MSG\_DVB\_TUNE\_SUCCESS will be sent to the page; +- If the frequency lock fails, the message MSG\_DVB\_TUNE\_FAILED will be sent to the page; +- If the signal is weak, the message MSG\_DVB\_TUNE\_SIGNAL\_WEAK will be sent to the page; +- If the signal is lost, the message MSG\_DVB\_TUNE\_SIGNAL\_LOST will be sent to the page; +- If the signal is restored, the message MSG\_DVB\_TUNE\_SIGNAL\_RECOVER will be sent to the page. + +Parameter: deliveryType– number type, indicating the type of paramsObj object; + +paramsObj – it indicates tuning and demodulation parameters, the type is specified by the deliveryType parameter: + +- DVB\_DELIVERY\_TYPE\_DVB\_S – The type of paramsObj is DvbsTuningParameters; +- DVB\_DELIVERY\_TYPE\_DVB\_C – The type of paramsObj is DvbcTuningParameters; +- DVB\_DELIVERY\_TYPE\_DVB\_T – The type of paramsObj is DvbtTuningParameters; +- DVB\_DELIVERY\_TYPE\_ABS\_SS – The type of paramsObj is AbsssTuningParameters; +- DVB\_DELIVERY\_TYPE\_DTMB – The type of paramsObj is DtmbTuningParameters. + +Return: None. + +#### L.2.6.1.2 getTunerSignalInfo + +Prototype: string getTunerSignalInfo() + +Description: A Synchronous method, acquiring tuner information, including signal quality, signal strength, bit error rate, signal level, and signal-to-noise ratio. + +Parameter: None. + +Return: + +- If the acquisition succeeds, it will return a description character string in the form of "{SignalQuality:XXX,signalStrength:XXX,errorRate:XXX,signalLevel:XXX,signalNoiseRatio:XXX}". +- If the acquisition fails, it will return null. + +#### L.2.6.1.3 getAllTunerInfos + +Prototype: DvbTunerInfo[] getAllTunerInfos() + +Description: Getting all tuner information supported by the current system. + +Parameter: None. + +Return: A DvbTunerInfo object array. + +### L.2.7 DvbTunerInfo object + +The DvbTunerInfo object is a local object, used to describe the matching relationship between TunerId and Tuner types. + +#### L.2.7.1 Properties + +The definition of the DvbTunerInfo object property is shown in Table L.6. + +**Table L.6 – DvbTunerInfo object property** + +| Property name | Type | Read/write property | Description | +|---------------|--------|---------------------|------------------------------------------------------------| +| tunerId | number | Read/write | It indicates the Tuner ID value. | +| tunerType | number | Read/write | It indicates the Tuner type corresponding to the Tuner ID. | + +### L.2.8 DvbScan object + +DvbScan object is a built-in object, which implements channel scan. + +Channel scan method definition: + +Manual search: According to the set tuning and demodulation parameters, searching for broadcast and TV program channels within a single frequency point; + +Automatic search: Searching for NIT according to the starting channel specified by the operator, and then automatically search for broadcast and TV program channels in the entire network according to the instructions of the NIT; the operator may specify multiple starting channels, as long as the NIT is successfully found at any one of the frequency points, it can perform automatic search. + +Zone search: According to china's digital television channel assignment table, searching for radio and television programs frequency by frequency within the specified starting and ending frequency range. + +This specification does not mandate the storage mechanism of channel scan results in the receiving terminal. To help understand the channel data access method provided by the DvbScan object, this specification gives examples to illustrate the storage mechanism that the receiving terminal may use. + +Example: After the channel scan is completed, the PSI/SI data (except for the EIT table) will be stored in three storage areas, namely A, B and C. The division of storage areas is shown in Figure L.2. + + + +``` + +graph LR + subgraph RAM + A[Area A] -- "DvbScan.update()" --> B[Area B] + end + B -- "DvbScan.save()" --> C[Area C] + C -- "DvbScan.revert()" --> B + style RAM fill:none,stroke:none + style NVM fill:none,stroke:none + style J120624 text-align:right,font-size:small + J1206(24) + +``` + +Schematic diagram of the storage area of channel scan results. The diagram shows two main storage areas: RAM and NVM. RAM contains two sub-areas, Area A and Area B. NVM contains Area C. Arrows indicate data flow: DvbScan.update() from Area A to Area B, DvbScan.save() from Area B to Area C, and DvbScan.revert() from Area C back to Area B. A small label 'J.1206(24)' is in the bottom right corner. + +**Figure L.2 – Schematic diagram of the storage area of channel scan results** + +The storage information in the NVM area is not lost when power is off. This type of storage includes Flash, E2PROM, and disk. The storage area C is assigned in the NVM to store the channel data successfully found by the receiving terminal. + +When the receiving terminal is in the power-off state, the PSI/SI data is only stored in the NVM. When the receiving terminal is powered on, the system will automatically import the PSI/SI data from the area C to the area B in the RAM for applications to call. + +In the process of searching channels, the newly searched data will be temporarily saved in Area A. After the search is completed and confirmed by the user, the application calls the DvbScan.update() method to update the newly searched data to area B. The application calls the DvbScan.save() method to save the data in area B to area C, otherwise the search results will be lost after power off. If the application wants to abandon the newly searched results, it can call the DvbScan.revert() method to restore the old data in the area C to the area B. + +DvbScan has two construction methods, DvbScan() uses tunerId as 0 by default, and DvbScan(tunerId) can specify the tunerId value when searching. + +### L.2.8.1 Method + +#### L.2.8.1.1 startScan + +Prototype: startScan(scanType, deliveryType, objArray[]) + +Description: An Asynchronous method, starting channel scan, wherein search mode is determined by scanType parameter, the system will perform tuning and demodulation automatically. + +- When the search starts, the message MSG\_DVB\_SCAN\_START will be sent to the page; +- After the current frequency point search is completed, if the service is found, the message MSG\_DVB\_SCAN\_FIND\_SERVICES will be sent to the page; +- After all the channels are searched, the message MSG\_DVB\_SCAN\_FINISHED will be sent to the page; +- If no channel is found, the message MSG\_DVB\_SCAN\_FAILED will be sent to the page. + +Parameter: scanType – number type, indicating the channel scan method, the value is as follows: + +- 0-indicating manual search, the length of the parameter objArray array is 1, indicating the tuning and demodulation parameters of the frequency to be searched; +- 1-indicating automatic search, the parameter objArray array indicating the starting channel tuning and demodulation parameters, the length of the array is greater than or equal to 1; as long as the NIT is successfully analyzed at one of the frequency points, the search can be automatically completed according to the instructions of the NIT, and the other frequency point parameters of the array can be ignored; +- 2-indicating zone search, the length of the parameter objArray array is 2, objArray[0] indicating the tuning and demodulation parameters at the beginning of the interval, and objArray[1] indicating the tuning and demodulation parameters at the end of the interval; the interval settings should comply with relevant national regulations. + +deliveryType – number type, indicating the type of the objArray object array. + +objArray[] – indicating tuning and demodulation parameters, the type is specified by the deliveryType parameter; + +- DVB\_DELIVERY\_TYPE\_DVB\_S– the type of objArray is 4er; +- DVB\_DELIVERY\_TYPE\_DVB\_C– the type of objArray is DvbcTuningParameters; +- DVB\_DELIVERY\_TYPE\_DVB\_T– the type of objArray is DvbtTuningParameters; +- DVB\_DELIVERY\_TYPE\_ABS\_SS – the type of objArray is AbsssTuningParameters; +- DVB\_DELIVERY\_TYPE\_DTMB – the type of objArray is DtmbTuningParameters. + +Return: None. + +#### **L.2.8.1.2 startScan** + +Prototype: startScan(pid, tableid, deliveryType, objArray[]) + +Description: An Asynchronous method, starting channel scan, wherein the search mode is determined by scanType parameter, the system will perform tuning and demodulation automatically. + +- When the search starts, the message MSG\_DVB\_SCAN\_START will be sent to the page +- After the search is completed, the message MSG\_DVB\_SCAN\_FINISHED will be sent to the page; +- If no channel is found, the message MSG\_DVB\_SCAN\_FAILED will be sent to the page. + +Parameter: pid – number type, indicating the PID of the TS packet where the specified program information data needs to be searched; + +tableid – number type, indicating the need to search for the tableid assigned by the specified program information data; + +deliveryType – number type, indicating the type of objArray object array. + +objArray[] – indicating tuning and demodulation parameters, the type being specified by the deliveryType parameter; + +- DVB\_DELIVERY\_TYPE\_DVB\_S– the type of objArray is 4er; +- DVB\_DELIVERY\_TYPE\_DVB\_C– the type of objArray is DvbcTuningParameters; +- DVB\_DELIVERY\_TYPE\_DVB\_T– the type of objArray is DvbtTuningParameters; +- DVB\_DELIVERY\_TYPE\_ABS\_SS – the type of objArray is AbsssTuningParameters; +- DVB\_DELIVERY\_TYPE\_DTMB – the type of objArray is DtmbTuningParameters. + +Return: None. + +### L.2.8.1.3 startScan + +Prototype: startScan(string jsonSIInfo) + +Description: Transferring the program information data in JSON format to the DTV component for analysis and storage. + +Since it is only data analysis and does not consume too much time, the synchronous mode is adopted. + +Parameter: jsonSIInfo – string type, applying the PSI/SI information in JSON format obtained from the operator's front-end. The detailed field definitions of JSON information are shown in Table L.7, Table L.8, Table L.9, Table L.10, Table L.11, and Table L.12, Table L.13, Table L.14, Table L.15 and Table L.16. + +Return: 0 – success; + +-1 – data format error. + +**Table L.7 – Data structure definition of configuration table program information** + +| Field | Type | Description | +|---------------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Version | Number | The version of the program data is used to ensure that the terminal and the front-end programs are consistent. The initial value of the front end is 1, and 1 is added to the value when the program data has any change, and it is consistent with the version in the NIT table. | +| OperatorID | Number | Operator number | +| NetWorkID | Number | Network ID | +| OperatorNames | Array | Operator name | +| DeliveryInfos | Object | Delivery stream information, frequency point information in the network. | +| Services | Array | Program information. | +| Groups | Array | Program grouping information. | + +**Table L.8 – Data structure definition of operator name information** + +| Field | Type | Description | +|-------|--------|----------------| +| lang | String | Language type. | +| Name | String | Operator name. | + +**Table L.9 – Data structure definition of delivery information** + +| Field | Type | Description | +|--------------|--------|-----------------------------------------------| +| DeliveryType | Number | Delivery type, 1: DVB-C, 2: DTMB-T, 3: ABS-S. | +| TSNumb | Number | Number of delivery streams. | +| Translates | Object | Frequency point information. | + +**Table L.10 – Data structure definition of frequency point information** + +| Field | Type | Description | +|-------------------|--------|-----------------------------------------------------------------------------------------------------| +| TsIndex | Number | Sequence number of delivery stream. | +| Name | String | Name of delivery stream. | +| OriginalNetworkID | Number | Original network ID. | +| TSId | Number | Delivery stream ID. | +| frequency | Number | Frequency, in kHz. | +| symboRate | Number | Symbol rate, in kbit/s. | +| Modulation | Number | Modulation mode, see SI definition: 0, reserved1:16QAM, 2:32QAM, 3:64QAM
4:128QAM, 5:256QAM. | + +**Table L.11 – Data structure definition of program information** + +| Field | Type | Description | +|-------------------|--------|-------------------------------------------------------------------------| +| OriginalNetworkID | Number | Original network ID. | +| TSId | Number | Delivery stream ID. | +| ServerID | Number | Server ID. | +| TSId | Number | Delivery stream ID. | +| RegionCode | Array | Region code. | +| PcrPid | Number | PCR PID. | +| ServiceNames | Array | Program name (multi-encoding format name). | +| PMT Pid | Number | Pmt Pid, keep consistent with the description in the SDT table. | +| ServiceType | Number | Program type, see SI definition. | +| logicNo | Number | Logical channel number. | +| SoundChannel | Number | 0: Stereo, 1: Left channel, 2: Right channel, 3: Mono channel. | +| VolumeOffset | Number | Volume compensation value. The value range is negative 5 to positive 5. | +| Video | Object | Video stream information. | +| Audios | Array | Audio stream array. | +| OtherES | Array | Other data flow information. | + +**Table L.12 – Data structure definition of video stream information** + +| Field | Type | Description | +|-----------|--------|---------------------------------| +| VideoPid | Number | Video stream PID. | +| VideoType | Number | Video stream encoding type. | +| CAInfo | Array | Conditional access information. | + +**Table L.13 – Data structure definition of audio stream information** + +| Field | Type | Description | +|-----------|--------|---------------------------------| +| AudioLang | String | Language type. | +| AudioPid | Number | Audio PID. | +| AudioType | Number | Audio stream encoding type. | +| CAInfo | Array | Conditional access information. | + +**Table L.14 – Data structure definition of other elementary stream information** + +| Field | Type | Description | +|--------|--------|---------------------------------| +| ESType | Number | Type of elementary stream. | +| Pid | Number | PID. | +| CAInfo | Array | Conditional access information. | + +**Table L.15 – Data structure definition of conditional access information** + +| Field | Type | Description | +|------------|--------|---------------------------| +| CASystemID | Number | Supplier ID of CA system. | +| EcmPid | Number | PID of control word. | + +**Table L.16 – Data structure definition of program grouping information** + +| Field | Type | Description | +|---------------|--------|---------------------------------------| +| Names | Array | Information of group name. | +| GroupID | Number | Number of group name. | +| GroupServices | Array | List of program numbers in the group. | + +Example: + +TVOS-SI + +``` +{ + "Version":0001, + "OperatorID":3356, + "NetWorkID":1234, + "OperatorNames":[ + { "Lang":"chi", + "Name":" Jilin Broadcasting", + }, + ], + "DeliveryInfo":{ + "DeliveryType":1, + "TSNumb": 25, + "Translates":[ +``` + +``` + + "TsIndex":1, + "Name":"ss" + "OriginalNetworkID":223, + "TSId":123, + "frequency":256000, + "symboRate":6875, + "Modulation":"64QAM", + ], +}, + +/* "DeliveryInfo":{ + "DeliveryType":"ABS-S", + "TSNumb": xxx, + "Translates":[ + "TsIndex":1, + "Name":"ss" + "OriginalNetworkID":223, + "TSId":123, + "Polarisation":00 + "frequency":300000, + "symboRate":6875, + ], +*/ + + "Services":[ +"OrgNetWorkID":223, +"TSID":123 + "ServerID":XXX, + "RegionCode":[xxx,xxx], + "PcrPid":2011, + "ServiceNames":[ + { "lang":"chi", + "ServiceName":" Jilin Satellite TV ", + "ProviderName":"Jilin TV Station", + }, + { "lang":"eng", + "ServiceName":"jilinweishi", + "ProviderName":"jilin", + }, + ], + ], +} + +``` + +``` + +], +"PMTPid":xxx, +"ServiceType":1, +"logicNo":xxx, +"SoundChannel":xxx, +"VolumeOffset":xxx, +"Video":{ + "VideoPid":xxx, + "VideoType":1, + "CAInfo":[ + "CASystemID":XXX + "EcmPid":xxx, + ], +}, +"Audios":[ + {"AudioLang":"ch", + "AudioPid":xxx, + "AudioType":1, + "CAInfo":[ + "CASystemID":XXX + "EcmPid":xxx, + ], + }, + {"AudioLang":"eng", + "AudioPid":xxx, + "AudioType":1, + "CAInfo":[ + "CASystemID":XXX + "EcmPid":xxx, + ], + }, +], +"OtherES":[ + "ESType":xx, + "Pid":xxx, + "CAInfo":[ + "CASystemID":XXX + ] +] + +``` + +``` + + "EcmPid":xxx, + ], +], +], +"Groups":[ + {"Names":[ +{ "lang":"chi", + "name":"HD", +}, +] + "GroupID":xxx + "GroupServices":[ + "ServiceID":123, + "ServiceID":125, + ] + }, +], +} + +``` + +#### L.2.8.1.4 stopScan + +Prototype: stopScan() + +Description: An Asynchronous method, terminating the channel scan. + +- If the termination succeeds, the message MSG\_DVB\_SCAN\_STOP\_SUCCESS is sent to the page; +- If the termination fails, the message MSG\_DVB\_SCAN\_STOP\_FAILED is sent to the page. + +Parameter: None. + +Return: None. + +#### L.2.8.1.5 update + +Prototype: number update() + +Description: Update PSI/SI data. + +Example: Use the PSI/SI data that has been successfully found in the area A to update the corresponding data in the area B, and the other data in the area B remain unchanged. + +Parameter: None. + +Return: number type, 1 indicating the update was successful, the update failed. + +#### L.2.8.1.6 save + +Prototype: save() + +Description: An Asynchronous method, saving PSI/SI data to NVM. After the search is completed, call this method to update the data in the NVM, otherwise the original channel data will be maintained after restarting the receiving terminal. + +- If the save succeeds, the message MSG\_DVB\_SCAN\_SAVE\_SUCCESS will be sent to the page; +- If the save fails, the message MSG\_DVB\_SCAN\_SAVE\_FAILED will be sent to the page. + +Example: Saving the PSI/SI data in area B of RAM to area C in NVM. + +Parameter: None. + +Return: None. + +#### **L.2.8.1.7 revert** + +Prototype: revert() + +Description: An Asynchronous method, importing PSI/SI data from NVM to RAM. + +- If the import succeeds, the message MSG\_DVB\_SCAN\_REVERT\_SUCCESS will be sent to the page; +- If the import fails, MSG\_DVB\_SCAN\_REVERT\_FAILED will be sent to the page. + +Example: After deleting all the data in the area B, reimport the PSI/SI data from the area C in the NVM. + +Parameter: None. + +Return: None. + +#### **L.2.8.1.8 deleteAll** + +Prototype: deleteAll() + +Description: An Asynchronous method, clearing PSI/SI data in RAM and NVM. + +- If the clearing succeeds, the message MSG\_DVB\_SCAN\_DELETE\_SUCCESS will be sent to the page; +- If the clearing fails, the message MSG\_DVB\_SCAN\_DELETE\_FAILED will be sent to the page. + +Example: Clear PSI/SI data in area B and area C. + +Parameter: None. + +Return: None. + +## Annex M + +### JavaScript-Broadcast protocol processing unit + +(This annex forms an integral part of this Recommendation.) + +#### M.1 Overview + +This annex defines JavaScript interfaces related to broadcast protocol processing, mainly including DVB protocol modules. + +#### M.2 DVB protocol processing module + +This module defines JS objects related to DVB broadcast protocol processing: DvbBroadcast, DvbNetwork, DvbBouquet, DvbTS, DvbService, DvbVideoES, DvbAudioES, DvbOtherES, the structure relationship is shown in Figure M.1. + + + +The diagram illustrates the hierarchical structure of DVB protocol processing objects. At the root is **DvbBroadcast**. It has direct associations with **DvbNetwork** (network\_id), **DvbBouquet** (network\_id, bouquet\_id), **DvbTS** (network\_id, original\_network\_id, transport\_stream\_id), **DvbService** (network\_id, original\_network\_id, transport\_stream\_id, service\_id), and **DvbMosaic** (network\_id, original\_network\_id, transport\_stream\_id, service\_id). **DvbNetwork** and **DvbBouquet** both point to **DvbTS**. **DvbTS** points to **DvbService**. **DvbService** has associations with **DvbOtherES** (stream\_type, elementary\_PID), **DvbVideoES** (stream\_type, elementary\_PID), **DvbAudioES** (stream\_type, elementary\_PID), and **DvbLogicCell**. **DvbMosaic** also points to **DvbLogicCell**. The diagram is labeled J.1206(24). + +Structure diagram of DVB protocol processing module object + +Figure M.1 – Structure diagram of DVB protocol processing module object + +#### M.2.1 Message + +The message definition that the DVB protocol processing module may send to the application layer is shown in Table M.1. + +**Table M.1 – Message definition of DVB protocol processing module** + +| Message | event.which | event.modifiers | Description of message | +|--------------------|-------------|-----------------|------------------------------------------------------------------------------------------------------------------------| +| MSG_DVB_NIT_CHANGE | 11001 | number | NIT version changes, the JSON format of the message character string is:
{"oldVersion":param1, "newVersion":param2} | +| MSG_DVB_PAT_CHANGE | 11002 | number | PAT version changes, the JSON format of the message character string is:
{"oldVersion":param1, "newVersion":param2} | +| Reserved | 11003~11200 | – | | + +The value of event.modifiers is automatically given by the system, and its data type: + +- "number", indicating that the value is the ID of the message description character string, which can be obtained through the Utility.getEventInfo() method. If the "message description" defines the JSON format of the message character string, the message content will be retrieved according to the format. +- "-", indicating that event.modifiers is undefined. + +**M.2.2 Constants** + +The constant definition of the DVB protocol processing module is shown in Table M.2. + +**Table M.2 – DVB protocol processing module constants** + +| Constants | Description | +|--------------------------------------------------|---------------------------------------------------------------------| +| Service type | | +| const DVB_SERVICE_TYPE_DTV = 0x01; | Digital TV Broadcasting Service | +| const DVB_SERVICE_TYPE_DAB = 0x02; | Digital Sound Broadcasting Service | +| const DVB_SERVICE_TYPE_TELETEXT = 0x03; | Teletext Service | +| const DVB_SERVICE_TYPE_NVOD_REF = 0x04; | NVOD Reference Service | +| const DVB_SERVICE_TYPE_NVOD_SHIFT = 0x05; | NVOD Time-shifted Service | +| const DVB_SERVICE_TYPE_MOSAIC = 0x06; | Mosaic Service | +| const DVB_SERVICE_TYPE_DATA = 0x0C; | Data Broadcasting Service | +| const DVB_SERVICE_TYPE_AVC_SD = 0x16; | Advanced coding standard definition digital TV (H.264) | +| const DVB_SERVICE_TYPE_AVC_SD_NVOD_SHIFT = 0x17; | Advanced coding standard definition NVOD time shift service (H.264) | +| const DVB_SERVICE_TYPE_AVC_SD_NVOD_REF = 0x18; | Advanced coding standard definition NVOD reference service (H.264) | +| const DVB_SERVICE_TYPE_AVC_HD = 0x19; | Advanced coding high-definition digital TV (H.264) | +| const DVB_SERVICE_TYPE_AVC_HD_NVOD_SHIFT = 0x1A; | Advanced encoding high-definition NVOD time shift service (H.264) | + +**Table M.2 – DVB protocol processing module constants** + +| Constants | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| const DVB_SERVICE_TYPE_AVC_HD_NVOD_REF = 0x1B; | Advanced coding high-definition NVOD reference service (H.264) | +| const DVB_SERVICE_TYPE_AVC_3DHD = 0x1C; | Advanced encoding HD frame compatible with 3D digital TV (H.264) | +| const DVB_SERVICE_TYPE_AVC_3DHD_SHIFT = 0x1D; | Advanced encoding HD frame compatible with 3D NVOD time shift service (H.264) | +| const DVB_SERVICE_TYPE_AVC_3DHD_REF = 0x1E; | Advanced coding HD frame compatible with 3D NVOD reference service (H.264) | +| NOTE – The service type constant definition is quoted from GB/T 28161-2011 Table 70 "Service Type Coding" and ETSI EN 300 468 v1.12.1 (2011-10) Table 87 "Service type coding". | | +| Sorting basis | | +| const DVB_SORT_TYPE_NETWORK_ID = 0x01; | Sort by network_id. | +| const DVB_SORT_TYPE_BOUQUET_ID = 0x02; | Sort by bouquet_id. | +| const DVB_SORT_TYPE_ONET_ID = 0x03; | Sort by original_network_id. | +| const DVB_SORT_TYPE_TS_ID = 0x04; | Sort by transport_stream_id. | +| const DVB_SORT_TYPE_SERVICE_ID = 0x05; | Sort by service_id. | +| const DVB_SORT_TYPE_SERVICE_TYPE = 0x06; | Sort by service_type. | +| const DVB_SORT_TYPE_SERVICE_NAME = 0x07; | Sort by service_name. | +| const DVB_SORT_TYPE_CHANNEL_ID = 0x10; | Sort by user channel number. | +| const DVB_SORT_TYPE_LOGICAL_ID = 0x11; | Sort by logical channel number. | +| const DVB_SORT_TYPE_FTA_SCR = 0x20; | Sort according to whether it is encrypted or not. | +| Sorting method | | +| const DVB_SORT_ORDER_NONE = 0x00; | Do not sort. | +| const DVB_SORT_ORDER_ASC = 0x01; |
- – If the sorting basis is DVB_SORT_TYPE_FTA_SCR, it means non-encrypted to encrypted arrangement;
- – If the sorting basis is other, it means sorting in ascending order.
- – If the sorting basis is DVB_SORT_TYPE_FTA_SCR, it means encrypted to non-encrypted sorting;
- – If the sorting basis is other, it means sorting in descending order.
- – 0-undefined;
- – 1-not running;
- – 2-Start after a few seconds (for example, video recording);
- – 3-Pause;
- – 4-Running;
- – 5-7-Reserved for use.
- – true-indicating that the current/follow-up information of the EIT of the service exists in the current transport stream;
- – false-indicating that the current/follow-up information of the EIT of the service is not in the current transport stream.
- – true-indicating that the EIT schedule information of the service exists in the current transport stream.
- – false-indicating that the EIT schedule information of the service is not in the current transport stream.
- – true-the receiving of one or more code streams is controlled by the CA system;
- – false-all components of the service are not scrambled.
– 0x01-GB/T 17191.2 video;
– 0x02-ISO/IEC 13818-2 video or GB/T 17191.2 restricted parameter video stream. | +| elementary_PID | number | Read only | Get the PID of the transport stream carrying the video elementary stream. | +| component_tag | number | Read only | It indicates the component ID.
The system should obtain information from the stream_identifier_descriptor related to the elementary stream.
If there is no information available, it is set to -1 by default. | + +## M.2.8 DvbAudioES object + +The DvbAudioES object is a local object, used to describe the audio elementary stream information in a certain service. + +### M.2.8.1 Property + +The definition of the DvbAudioES object property is shown in Table M.9. + +**Table M.9 – Table of DvbAudioES property** + +| Property name | Type | Read/write property | Description | +|----------------|--------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| stream_type | number | Read only | It indicates the type of audio elementary stream, the value is:
– 0x03-GB/T 17191.3 audio;
– 0x04-ISO/IEC 13818-3 audio. | +| elementary_PID | number | Read only | It indicates the PID of the transport stream that carries the audio elementary stream. | +| component_tag | number | Read only | It indicates the component ID.
The system should obtain information from the stream_identifier_descriptor related to the elementary stream. If there is no information available, it is set to -1 by default. | +| Lingual | string | Read only | It indicates the audio language, and the three-letter code of the language follows the GB/T 4880.2-2000 standard. | + +## M.2.9 DvbOtherES object + +The DvbOtherES object is a local object, which is used to store the elementary stream information in a certain service except for audio and video. + +### M.2.9.1 Property + +The definition of the DvbOtherES object property is shown in Table M.10. + +**Table M.10 – Table of DvbOtherES property** + +| Property name | Type | Read/write property | Description | +|----------------|--------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| stream_type | number | Read only | It indicates the type of elementary stream, and the value is other allowed values except 0x01, 0x02, 0x03 and 0x04. | +| elementary_PID | number | Read only | It indicates the PID of the transport stream that carries the elementary stream. | +| component_tag | number | Read only | It indicates the component ID.
The system should obtain information from the stream_identifier_descriptor related to the elementary stream. If there is no information available, it is set to -1 by default. | + +## M.2.10 DvbEvent object + +The DvbEvent object is a local object, used to save program event information in digital TV broadcasting and sound broadcasting channels, and is uniquely identified by network\_id, original\_network\_id, transport\_stream\_id, service, and event\_id. + +Example: + +//The DvbEvent object can be obtained in the following ways. + +``` +var dvbEventArray[] = dvbService.getEvents(startDate, endDate). +``` + +### M.2.10.1 Property + +The definition of the DvbEvent object property is shown in Table M.11. + +**Table M.11 – Table of DvbEvent property** + +| Property name | Type | Read/write property | Description | +|---------------------|--------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| network_id | number | Read only | It indicates the network ID to which the program event belongs. | +| original_network_id | number | Read only | It indicates the original network ID to which the program event belongs. | +| transport_stream_id | number | Read only | It indicates the transport stream ID to which the program event belongs. | +| service_id | number | Read only | It indicates the service ID to which the program event belongs. | +| event_id | number | Read only | It indicates the program event ID. | +| event_name | string | Read only | It indicates the name of the program event. | +| event_description | string | Read only | It indicates the description of the program event. | +| running_status | number | Read only | It indicates the running status of the program event, the value is:
- – 0-undefined;
- – 1-not running;
- – 2-Start after a few seconds (for example, video recording);
- – 3-Pause;
- – 4-Running;
- – 5-7-Reserved for use.
–true-scrambled;
–false-No scrambling. | + +**M.2.10.2 Method** + +**M.2.10.2.1 getEventName** + +Prototype: string getEventName() + +Description: Getting the full name of the program event. + +Parameter: None. + +Return: string type, indicating the full name of the program event. + +**M.2.10.2.2 getShortEventName** + +Prototype: string getShortEventName() + +Description: Getting the abbreviation of the program event. + +Parameter: None. + +Return: string type, indicating the abbreviation of the program event. If the abbreviation of the event does not exist, undefined is returned. + +**M.2.10.2.3 getEventDescription** + +Prototype: string getEventDescription() + +Description: Getting the description information of the program event. The program event description information is obtained from the description of short\_event\_descriptor. This method should return the program event description information that matches the preferred language set by the user. + +Parameter: None. + +Return: string type, indicating the description of the program event. + +**M.2.10.2.4 getLocation** + +Prototype: string getLocation() + +Description: Getting the event locator described by the four elements of original\_network\_id, transport\_stream\_id, service\_id and event\_id. + +Parameter: None. + +Return: string type, indicating the program event locator. + +## Annex N + +### JavaScript-Two-way broadband network access unit + +(This annex forms an integral part of this Recommendation.) + +#### N.1 Overview + +This annex defines the functional modules related to two-way broadband network access control: broadband network settings. + +#### N.2 Broadband network setting module + +This module defines JS objects related to broadband network settings: Broadband, Ethernet, IP, Proxy, and the relationship is shown in Figure N.1. + + + +``` + +graph LR + Broadband --> Ethernet + Ethernet --> IP + Ethernet --> HTTPProxy --> Proxy1[Proxy] + Ethernet --> HTTPSProxy --> Proxy2[Proxy] + Ethernet --> FTPProxy --> Proxy3[Proxy] + +``` + +Schematic diagram of object relationship of broadband network setting module. The diagram shows a hierarchy starting with 'Broadband' pointing to 'Ethernet'. 'Ethernet' then branches into 'IP', 'HTTPProxy', 'HTTPSProxy', and 'FTPProxy'. 'HTTPProxy', 'HTTPSProxy', and 'FTPProxy' each point to a 'Proxy' object. The diagram is labeled J.1206(24). + +Figure N.1 – Schematic diagram of object relationship of broadband network setting module + +#### N.2.1 Message + +The definition of messages that the broadband network setting module may send to the application layer is shown in Table N.1. + +Table N.1 – Messages of broadband network setting module + +| Message name | event.which | event.modifiers | Message description | +|---------------------------------|-------------|-----------------|----------------------------------------------------------------------------| +| MSG_BROADBAND_SAVE_CFG_SUCCESS | 12001 | – | The network configuration information was successfully written to the NVM. | +| MSG_BROADBAND_SAVE_CFG_FAILED | 12002 | – | Failed to write network configuration information to NVM. | +| MSG_BROADBAND_SUBMIT_SUCCESS | 12003 | – | The network configuration parameters were submitted successfully. | +| MSG_BROADBAND_SUBMIT_FAILED | 12004 | – | Failed to submit network configuration parameters. | +| MSG_BROADBAND_NTP_READY_SUCCESS | 12005 | – | The synchronization of the network NTP time is successful. | +| MSG_BROADBAND_NTP_SYNC_TIMEOUT | 12006 | – | The synchronization of the network NTP time timed out. | + +**Table N.1 – Messages of broadband network setting module** + +| Message name | event.which | event.modifiers | Message description | +|----------------------------------|-------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Reserved | 12007~12014 | | | +| MSG_BROADBAND_DHCP_READY_SUCCESS | 12015 | – | The network DHCP function is successfully enabled. | +| MSG_BROADBAND_DHCP_TIMEOUT | 12016 | – | The network DHCP function has timed out. | +| Reserved | 12017~12027 | | | +| MSG_BROADBAND_PING_RESPONSE | 12028 | number | PING command response. | +| MSG_BROADBAND_GET_NETWORK_STATE | 12029 | number | Network status, the message description string JSON format is:
{
"targetAddress":param1 Note 1 ,
"lostPacketRate":param2 Note 2 ,
"bandwidth":param3 Note 3 ,
"delay":param4 Note 4
} | +| MSG_BROADBAND_LINK_AP_SUCCESS | 12030 | – | The wireless AP is successfully connected. | +| MSG_BROADBAND_LINK_AP_FAILED | 12031 | – | Failed to connect the wireless AP. | +| MSG_BROADBAND_SCAN_AP_FIND | 12032 | number | Each time a wireless hotspot is successfully found, the message is sent. | +| MSG_BROADBAND_SCAN_AP_SUCCESS | 12033 | number | Send the message when the designated number of wireless hotspots are searched. | +| MSG_BROADBAND_SCAN_AP_FAILED | 12034 | – | If no wireless hotspot is found within the specified timeout period, the message will be sent. | +| Reserved | 12035~12055 | | | +| MSG_BROADBAND_DISCONNECTED | 12056 | – | The network cable is disconnected. | +| MSG_BROADBAND_CONNECTED | 12057 | – | The network cable is connected. | +| MSG_BROADBAND_LAN_DISCONNECTED | 12058 | – | This message is sent when the network is disconnected. | +| MSG_BROADBAND_LAN_CONNECTED | 12059 | – | This message is sent when the network is connected. | +| MSG_BROADBAND_IP_RENEW | 12060 | number | In DHCP mode, the IP address is automatically updated. | +| Reserved | 12061~12500 | | | + +**Table N.1 – Messages of broadband network setting module** + +| Message name | event.which | event.modifiers | Message description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|-----------------|---------------------| +| The value of event.modifiers is automatically given by the system, and its data type is:
– "Number", indicating that the value is the ID of the message description string, which can be obtained through the Utility.getEventInfo() method. If the "message description" defines the message string JSON format, the message content will be retrieved according to the format.
– "-", indicating that event.modifiers is undefined.
NOTE 1 – param1: string type, indicating the target IP address.
NOTE 2 – param2: number type, indicating packet loss rate.
NOTE 3 – param3: number type, indicating bandwidth, in Mbps.
NOTE 4 – param2: number type, indicating delay, in ms. | | | | + +## N.2.2 Broadband object + +The Broadband object is a built-in object that describes the properties of two-way broadband and network configuration information. + +### N.2.2.1 Property + +The definition of Broadband object property is shown in Table N.2. + +**Table N.2 – Property of Broadband object** + +| Property name | Type | Property | Description | +|---------------|--------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| portalIP | string | Read only | It indicates the IP address of the portal server, the format is:
– IPv4-"xxx.xxx.xxx.xxx", see IETF RFC 791 for details;
– IPv6-"x:x:x:x:x:x:x", see IETF RFC 2373 for details. | +| portalPort | number | Read only | It indicates the port of the portal server. | +| appServerIP | string | Read only | It indicates the IP address of the application download server, format:
– IPv4-"xxx.xxx.xxx.xxx", see IETF RFC 791 for details;
– IPv6-"x:x:x:x:x:x:x", see IETF RFC 2373 for details. | +| appServerPort | number | Read only | It indicates the port of the application download server. | +| Host | string | Read only | It indicates a character string with which the network recognizes the terminal device, that is, the host name, which does not exceed 255 bytes. The terminal device can also be identified by this name in the LAN. | +| workGroup | string | Read only | It indicates the workgroup to which the network belongs. | + +### N.2.2.2 Method + +#### N.2.2.2.1 getAllEthernets + +Prototype: Ethernet[] getAllEthernets() + +Description: Getting all broadband network equipment objects of the receiving terminal. + +Parameter: empty. + +Return: Array of Ethernet objects. If there is no such object, the length of the returned array is 0. + +#### N.2.2.2.2 ping + +Prototype: ping(address, parameter) + +Description: An Asynchronous method, executing the ping command of the operating system. Each time the system receives a ping packet response, it sends a message MSG\_BROADBAND\_PING\_RESPONSE to the page, the event.modifiers property returns the ID of the message description string, and the message description string is obtained through the Utility.getEventInfo() method. + +Parameter: address – string type, indicating the target address of the ping command, which can be IP or domain name. + +parameter – string type, indicating the parameter of the ping command, the value is: + +- "-t"–indicating continuous ping the target address until manually stopped. + +Return: None. + +#### **N.2.2.2.3 cancelPing** + +Prototype: number cancelPing() + +Description: Cancel the ongoing ping operation. + +Parameter: None. + +Return: number type, the value being: + +- 0-indicating that the current ping operation has ended or there is currently no ping operation; +- 1-indicating that the ping operation being executed has been successfully stopped. + +#### **N.2.2.2.4 queryNetworkState** + +Prototype: queryNetworkState(targetAddress) + +Description: An Asynchronous method, getting the network status from the current network to the specified target address. When the operation is completed, the system should send the message MSG\_BROADBAND\_GET\_NETWORK\_STATE to the page, the property of event.modifiers returns the ID of the message description string, and the message description string is obtained through the Utility.getEventInfo(ID) method. The JSON format is: + +``` +{ + "targetAddress":"192.168.1.12", + "lostPacketRate":0, + "bandwidth":8, + "delay":100 +} +``` + +where: + +- targetAddress – string type, indicating the target address, the format is: + - IPv4 – "xxx.xxx.xxx.xxx", see IETF RFC 791 for details; + - IPv6 – "x:x:x:x:x:x:x:x", see IETF RFC 2373 for details. +- lostPacketRate – number type, indicating the packet loss rate, percentage, and the value range being 0~100; +- bandwidth – number type, indicating the bandwidth, in Mbps; +- delay – number type, indicating the delay, in milliseconds. + +Parameter: *targetAddress*–string type, indicating the target IP address, the format is: + +- IPv4 – "xxx.xxx.xxx.xxx", see IETF RFC 791 for details; +- IPv6 – "x:x:x:x:x:x:x:x", see IETF RFC 2373 for details. + +Return: None. + +#### N.2.2.2.5 getDeviceState + +Prototype: number getDeviceState(device) + +Description: Getting device status. + +Parameter: *device* – String type, indicating the device name, the device type can be network card or cable modem. + +- If it is a network card, the value is "eth0", "eth1", etc.; +- If it is a cable modem, the value is "cm". + +Return: number type, the device status value is shown in Table N.3. + +**Table N.3 – Table of device status** + +| Device | Return value | Description | +|-------------------------------------------|--------------|---------------------------------------------------------------------------------------------------------------------| +| All devices are applicable | 0 | The device does not exist and cannot be accessed. | +| | 1 | The device exists, but the status cannot be obtained. | +| eth0, eth1 and other network card devices | 101 | The network cable is connected. | +| | 102 | The network cable is off. | +| Cm | 201 | The network connection is normal. | +| | 202 | The network connection is interrupted. | +| | 203 | The network status does not change, but it is bad. | +| | 204 | The communication between the Cable Modem and the receiving terminal is interrupted. | +| | 205 | The communication between the Cable Modem and the receiving terminal is interrupted, the reconnection is performed. | + +#### N.2.2.2.6 NTPUpdate + +Prototype: boolean NTPUpdate() + +Description: An asynchronous method, synchronizing NTP time. + +- If the page gets the message MSG\_BROADBAND\_NTP\_READY\_SUCCESS, it indicates that the synchronization of the network NTP time is successful; +- If the page gets the message MSG\_BROADBAND\_NTP\_SYNC\_TIMEOUT, it indicates that the synchronization of the network NTP time has timed out. + +Parameter: None. + +Return: boolean type, true indicating that the execution of the synchronization of NTP time starts, false indicating that the execution is not performed. + +NOTE – The return value only indicates whether the program starts to perform the synchronization of NTP time, and does not indicate the actual synchronization result. The actual synchronization result is notified by a message. + +If it returns false, it may be caused by reasons such as not setting the NTP server. + +#### N.2.2.2.7 save + +Prototype: save() + +Description: An Asynchronous method, writing network information into NVM. + +- If the save is successful, send the message MSG\_BROADBAND\_SAVE\_CFG\_SUCCESS; +- If the save fails, send the message MSG\_BROADBAND\_SAVE\_CFG\_FAILED. + +Parameter: None. + +Return: None. + +### N.2.3 Ethernet object + +The Ethernet object is a local object, used to describe the detailed information of the local network card, and corresponds to the network card one-to-one, that is, the number of the network cards corresponds the number of the Ethernet objects. + +Example: + +``` +var ethernetArray = Broadband.getAllEthernets();//Getting an array of all network card objects of the receiving terminal +``` + +``` +var ethernet = ethernetArray[i]; +``` + +#### N.2.3.1 Property + +The definition of the Ethernet object property is shown in Table N.4. + +**Table N.4 – Ethernet object property** + +| Property name | Type | Read/write property | Description | +|----------------|---------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| enableFlag | number | Read/write | It indicates whether the network card is available, which is equivalent to the enable or disable function on the PC, the value is:
– 1-indicating that the network card is available;
– 0-indicating that the network card is not available.
NOTE – The submitParameters() method takes effect only upon being called. | +| DHCPflag | boolean | Read/write | It indicates whether to enable DHCP, the value is:
– true-indicating DHCP is enabled;
– false-indicating DHCP is disabled.
NOTE – The submitParameters() method take effect only upon being called. | +| DHCPAutoGetDNS | number | Read/write | It indicates whether this Ethernet object uses automatically obtained DNS, the value is:
– 0-indicating do not use dynamically obtained DNS, but use manually set DNS;
– 1-indicating use dynamically obtained DNS instead of manually set DNS.
If Ethernet.DHCPflag=false; Setting this property is invalid.
NOTE – The submitParameters() method takes effect only upon being called. | +| description | string | Read only | It indicates the description information of the network card. | + +**Table N.4 – Ethernet object property** + +| Property name | Type | Read/write property | Description | +|-----------------------|--------------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MACAddress | string | Read only | It indicates the 6-byte physical address of the current network card, and every two hexadecimal numbers are separated by "-", such as "00-15-F2-63-7A-83". | +| Ips | IP Array | Read only | It indicates an array of IP objects. | +| DNSs | string Array | Read only | It indicates an array of DNS server IP addresses, the format is:
–IPv4-"xxx.xxx.xxx.xxx", see IETF RFC 791 for details;
–IPv6-"x:x:x:x:x:x:x:x", see IETF RFC 2373 for details. | +| DHCPLeaseObtained | string | Read only | It indicates the start time of IP address lease in DHCP mode, the format is: yyyy-mm-dd hh:mm:ss. | +| DHCPLeaseExpires | string | Read only | It indicates the expiration time of the IP address in DHCP mode, the format is: yyyy-mm-dd hh:mm:ss. | +| DHCP-IP | IP | Read only | It indicates an IP object dynamically assigned by DHCP. | +| DHCP-Server | string | Read only | It indicates that the IP address of the DHCP server is provided on the current network, the format is:
–IPv4-"xxx.xxx.xxx.xxx", see IETF RFC 791 for details;
–IPv6-"x:x:x:x:x:x:x:x", see IETF RFC 2373 for details. | +| DHCP-Port | number | Read only | It indicates the port number of DHCP. | +| communicateWay | number | Read/write | It indicates network bandwidth and communication method, the value is:
– 0-indicating adaptive;
– 1-indicating 10M full duplex;
– 2-indicating 10M half-duplex;
– 3-indicating 100M full duplex;
– 4-indicating 100M half-duplex. | +| LANStatus | number | Read only | It indicates the connection status of Ethernet mode, the value is:
– 0-indicating no connection;
– 1-indicating connected. | +| sentPackages | number | Read only | It indicates the number of data packets sent by the network card. | +| receivedPackages | number | Read only | It indicates the number of data packets received by the network card. | +| currentConnectionType | string | Read only | It indicates the connection type of the current network card, the value is "ethernet", "ppp" or "pppoe", etc. | +| HTTPProxy | Proxy | Read only | It indicates the hyper text transfer protocol (HTTP) proxy object. | +| HTTPSProxy | Proxy | Read only | It indicates the HTTPS proxy object. | +| FTPProxy | Proxy | Read only | It indicates the FTP proxy object. | + +### N.2.3.2 Method + +#### N.2.3.2.1 setDNS + +Prototype: setDNS(index, dns) + +Description: Modifying the DNS server. + +Parameter: index – index of the DNS server to be modified; + +dns – string type, DNS IP address, the format is: + +- IPv4-"xxx.xxx.xxx.xxx", see IETF RFC 791 for details; +- IPv6-"x:x:x:x:x:x:x:x", see IETF RFC 2373 for details. + +Return: None. + +#### **N.2.3.2.2 addIP** + +Prototype: boolean addIP(ip) + +Description: Add an IP object to the network card. + +Parameter: ip – IP object. + +Return: boolean type, true indicating success, false indicating failure. + +#### **N.2.3.2.3 deleteIPByIndex** + +Prototype: boolean deleteIPByIndex(index) + +Description: Delete the IP object set in the network card through the IP array subscript. + +Parameter: index – number type, indicating the array subscript. + +Return: boolean type, true indicating success, false indicating failure. + +#### **N.2.3.2.4 deleteIPByAddress** + +Prototype: boolean deleteIPByAddress(address) + +Description: Delete the IP object set in the network card by IP address. + +Parameter: address – string type, indicating the IP address, the format is: + +- IPv4-"xxx.xxx.xxx.xxx", see IETF RFC 791 for details; +- IPv6-"x:x:x:x:x:x:x:x", see IETF RFC 2373 for details. + +Return: boolean type, true indicating success; false indicating failure. + +#### **N.2.3.2.5 getAPs** + +Prototype: AP[] getAPs() + +Description: Getting all wireless hotspot objects. Only used for wireless network card. + +Parameter: None. + +Return: An AP object array. + +#### **N.2.3.2.6 scanAP** + +Prototype: scanAP(maxCount, timeOut) + +Description: An Asynchronous method, searching for wireless AP. + +- If no wireless hotspot is found within the timeout period specified by the parameter timeOut, send the message MSG\_BROADBAND\_SCAN\_AP\_FAILED to the page; +- Each time a wireless hotspot is searched, send the message MSG\_BROADBAND\_SCAN\_AP\_FIND to the page. The event.modifiers property carries the JSON string ID of the AP object, and the JSON string is obtained through the Utility.getEventInfo(ID) method. + +- If the search for maxCount wireless hotspots has been completed, send the message MSG\_BROADBAND\_SCAN\_AP\_SUCCESS to the page. + +Parameter: maxCount – number type, indicating the maximum number of APs to be searched. + +timeOut – number type, indicating the search timeout period, in seconds. + +Return: None. + +#### **N.2.3.2.7 connectAP** + +Prototype: connectAP(essId, keyType, key) + +Description: An Asynchronous method, connecting to the wireless network card access point. + +- If the connection is successful, send the message MSG\_BROADBAND\_LINK\_AP\_SUCCESS; +- If the connection fails, send the message MSG\_BROADBAND\_LINK\_AP\_FAILED. + +Parameter: essId – string type, indicating the wireless network card ID. + +keyType – number type, indicating the key data type of the wireless network card. + +key – string type, indicating an authentication key. + +Return: None. + +#### **N.2.3.2.8 disconnectAP** + +Prototype: number disconnectAP() + +Description: Disconnecting from the wireless hotspot. + +Parameter: None. + +Return: number type, returning 0 if it succeeds, and returning an error code if it fails. + +#### **N.2.3.2.9 getConnectedAP** + +Prototype: AP getConnectedAP() + +Description: Getting the connected wireless hotspot object. + +Parameter: None. + +Return: AP object. + +#### **N.2.3.2.10 submitParameters** + +Prototype: submitParameters() + +Description: An Asynchronous method, submitting all the properties of the Ethernet object of the network card to the bottom layer at one time. + +- If the submission is successful, send the message MSG\_BROADBAND\_SUBMIT\_SUCCESS to the page; +- If the submission fails, send the message MSG\_BROADBAND\_SUBMIT\_FAILED to the page. + +Parameter: None. + +Return: None. + +### **N.2.4 AP object** + +The AP object is a local object, which is used to describe wireless hotspot information. + +#### N.2.4.1 Property + +The definition of AP object property is shown in Table N.5. + +**Table N.5 – Table of AP object property** + +| Property name | Type | Read/write property | Description | +|----------------|--------|---------------------|-------------------------------------------------------------------| +| essId | string | Read only | It indicates the ID of the wireless hotspot. | +| signalStrength | string | Read only | It indicates the signal strength of the wireless hotspot. | +| linkQuality | string | Read only | It indicates the link quality of the wireless hotspot. | +| encType | number | Read only | It indicates the wireless hotspot authentication encryption type. | + +The definition of wireless network card authentication encryption type is shown in Table N.6. + +**Table N.6 – Authentication encryption type of wireless network card** + +| Type value | Description | +|------------|-------------------------------------------------| +| 0 | No encryption. | +| 1 | WEPOpen encryption. | +| 2 | Shared sharing mode to encrypt WEP information. | +| 3 | Wi-Fi Protected Access Protocol. | +| 4 | Wi-Fi Protected Access Protocol 2. | + +The error code comparison table of the wireless network card is shown in Table N.7. + +**Table N.7 – Error code comparison table of wireless network card** + +| Error code | Meaning | +|------------|----------------------------------------------------------------------| +| 0 | Success. | +| 1 | Parameter error. | +| 2 | The wireless network card failed to start. | +| 3 | The wireless network card failed to be switched off. | +| 4 | Error in connecting. | +| 5 | Error in setting the key. | +| 6 | Error in clearing the authentication information. | +| 7 | The name of the wireless network card access point was not obtained. | + +The definition of the data type of wireless network card key is shown in Table N.8. + +**Table N.8 – Data type of wireless network card key** + +| keyType value | Description | +|---------------|---------------------------------| +| 0 | Encryption in hexadecimal mode. | +| 1 | Encryption in ansi coding mode. | +| 2 | Encryption in string method. | + +## N.2.5 IP object + +The IP object is a local object, used to describe IP address information. + +Example: + +``` +//Create and set IP objects through the network card +``` + +``` +var ethernetArray = Broadband.getAllEthernets();//Get an array of all network card objects of the receiving terminal +``` + +``` +var ethernet = ethernetArray[0]; +``` + +``` +var ip = ethernet.IPs[0];//Getting the 0th IP object in the IP object array under the 0th network card object +``` + +``` +//Through the construction method, create an IP object +``` + +``` +ip = new IP(address, mask, gateway); +``` + +### N.2.5.1 Property + +The definition of the IP object property is shown in Table N.9. + +**Table N.9 – Table of IP object property** + +| Property name | Type | Property | Description | +|---------------|--------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Address | string | Read/write | It indicates the IP address, the format is:
– IPv4-"xxx.xxx.xxx.xxx", see IETF RFC 791 for details;
– IPv6-"x:x:x:x:x:x:x", see IETF RFC 2373 for details. | +| Mask | string | Read/write | It indicates the subnet mask of the IP address, and the format corresponds to the IP address. | +| Gateway | string | Read/write | It indicates the gateway of the IP address, the format is:
– IPv4 – "Xxx.xxx.xxx.xxx", see IETF RFC 791 for details;
– IPv6 – "X:x:x:x:x:x:x", see IETF RFC 2373 for details. | + +### N.2.5.2 Method + +#### N.2.5.2.1 IP + +Prototype: IP(address, mask, gateway) + +Description: IP object construction method. + +Parameter: address – string type, indicating the IP address, the format is the same as the description of the "address" property in Table T.9. + +mask – string type, indicating the subnet mask of the IP address, the format is the same as the description of the "mask" property in Table T.9. + +gateway – string type, indicating the gateway of the IP address, the format is the same as the description of the "gateway" property in Table T.9. + +## N.2.6 Proxy object + +The Proxy object is a local object, describing the proxy server information in the network. + +### N.2.6.1 Property + +The definition of the Proxy object property is shown in Table N.10. + +**Table N.10 – Table of Proxy object property** + +| Property name | Type | Property | Description | +|-----------------|--------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| userName | string | Read/write | It indicates the username of the current proxy server access mode, the value is 0-30 characters, and cannot be a space. The proxy server requires a username and password to connect to some proxies. | +| password | string | Read/write | It indicates the password of the current proxy server access mode, the value is 0-30 characters, and it can be a space. The proxy server requires a username and password to connect to some proxies. | +| Enable | number | Read/write | It indicates whether to enable proxy, the value is:
– 0-indicating that the current proxy is invalid;
– 1-indicating that the current proxy takes effect immediately. | +| unusedProxyURLs | string Array | Read/write | It indicates the URL that does not use a proxy, and each character string cannot exceed 255 characters at most. | +| Server | string | Read/write | It indicates the IP address or domain name address of the proxy server, which cannot exceed 255 characters. | +| Port | number | Read/write | It indicates the port number of the server that provides the proxy service, and the value is 0 to 5 numeric characters. | + +## Annex O + +### JavaScript-Human-computer interaction unit + +(This annex forms an integral part of this Recommendation.) + +#### O.1 Overview + +This annex defines functional modules related to human-computer interaction: user input module, front panel output module. + +#### O.2 User input module + +##### O.2.1 Overview of the user input module + +User input refers to the user sending user instructions to the receiving terminal through some input devices such as remote control, mouse, keyboard, front panel keys, etc., and these user instructions are uniformly encapsulated into key messages for processing. + +Sources of messages captured by the application layer: + +Remote control, keyboard, mouse, front panel and other keys to trigger messages; + +The application layer captures messages in the following ways: + +- Keyboard: The application captures keyboard messages through `document.onkeydown`, `document.onkeyup` and `document.onkeypress`, and the message code is consistent with the PC method; +- Mouse: The application captures mouse messages through `document.onmousedown`, `document.onmouseup`, `document.onmousemove`, etc., and the message code is consistent with the PC method; +- Remote control: The application captures remote control messages through `document.onkeydown` and `document.onkeyup`, and the message code is compatible with the PC mode; +- Front panel: The application captures front panel messages through `document.onkeydown` and `document.onkeyup`, and the message code is consistent with the remote control method. + +##### O.2.2 event object + +###### O.2.2.1 Property + +The event object is a built-in object, and the properties of the event object are shown in Table O.1. + +**Table O.1 – Properties of event object** + +| Property name | Type | Read/write property | Description | +|---------------------------|--------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|
event.type | number | Read only | It indicates the type of event that occurred, that is, the name of the event represented by the current event object, which has the same name as the registered event handle, such as "onclick"; or the property of the event handle deletes the prefix "on", such as "click". |
+| event.source | number | Read only | It indicates the source of the message. |
+| event.which | number | Read only | It indicates the code value of the message. |
+
+**Table O.1 – Properties of event object**
+
+| Property name | Type | Read/write property | Description |
+|-----------------|--------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| event.modifiers | number | Read only | It indicates the extended property of the message. If the extended property of the message is empty, modifiers returns 0; if the extended property of the message is number type, then modifiers returns the value; if the extended property of the message is a character string, then modifiers returns an ID value, which is generated internally by the system, as a pointer to the specific character string content, the application can call the Utility.getEventInfo(ID) method to retrieve the character string content. |
+
+**O.2.2.2 Message source**
+
+The definition of the message source (event.source) is shown in Table O.2.
+
+**Table O.2 – Definition of event.source**
+
+| event.source | Description |
+|--------------|----------------------------------------------|
+| 1002 | It indicates the remote control key message. |
+| 1003 | It indicates the front panel key message. |
+
+**O.2.2.3 Key message**
+
+The definition of the key message is shown in Table D.2.1.5.
+
+**O.3 Front panel output module**
+
+This module defines the JS object related to the front panel output: FrontPanel.
+
+**O.3.1 FrontPanel object**
+
+The FrontPanel object is a built-in object that provides front panel operation interfaces such as character string display, status indication, time and date display, and information clearing.
+
+**O.3.1.1 Constant**
+
+Constant definitions of the FrontPanel object are shown in Table O.3.
+
+**Table O.3 – Constant of FrontPanel object**
+
+| Constants | Description |
+|------------------------|--------------|
+| Indication type | |
+| const TYPE_MAIL = 0; | Mail |
+| const TYPE_SIGNAL = 1; | Signal |
+| const TYPE_POWER = 2; | Power supply |
+| const TYPE_RADIO = 3; | Broadcast |
+| Indicating status | |
+| const STATUS_OFF = 0; | Off |
+| const STATUS_ON = 1; | On |
+
+**Table O.3 – Constant of FrontPanel object**
+
+| Constants | Description |
+|------------------------------------|-------------------------|
+| const STATUS_UNKNOWN = 2; | Unknown |
+| Character string display alignment | |
+| const ALIGN_CENTER = 0; | horizontal center align |
+| const ALIGN_LEFT = 1; | horizontal left align |
+| const ALIGN_RIGHT = 2; | horizontal right align |
+
+### **O.3.1.2 Method**
+
+#### **O.3.1.2.1 clear**
+
+Prototype: boolean clear()
+
+Description: Clearing the information displayed on the front panel, including the character string information displayed on the front panel, time and date information, etc.
+
+Parameter: empty.
+
+Return: boolean type, true indicating the removal is successful, false indicating the removal failed.
+
+#### **O.3.1.2.2 displayDate**
+
+Prototype: boolean displayDate(date)
+
+Description: Displaying the current time and date information.
+
+Parameter: date – Date type, indicating time and date.
+
+Return: boolean type, true indicating display success, false indicating display failure. If the terminal does not support it, it does not respond to the call of this method and returns false.
+
+#### **O.3.1.2.3 displayText**
+
+Prototype: boolean displayText(str)
+
+Description: displaying a character string, which is displayed in horizontal center alignment by default.
+
+Parameter: str – string type, indicating the character string to be displayed.
+
+Return: boolean type, true value indicating that the display is successful, and false value indicating that the display fails.
+
+#### **O.3.1.2.4 displayText**
+
+Prototype: boolean displayText(str, align)
+
+Description: This character string is displayed with specified alignment. If the terminal does not support the specified alignment, this parameter can be ignored.
+
+Parameter: str – string type, indicating the character string to be displayed.
+
+align – number type, indicating the horizontal alignment.
+
+Return: boolean type, true value indicating that the display is successful, and false value indicating that the display fails.
+
+#### **O.3.1.2.5 getMaxChars**
+
+Prototype: number getMaxChars()
+
+Description: Getting the number of display characters supported by the front panel.
+
+Parameter: None.
+
+Return: number type, indicating the number of display characters supported by the front panel.
+
+#### **O.3.1.2.6 getStatus**
+
+Prototype: number getStatus(type)
+
+Description: Getting the front panel indication status according to the type.
+
+Parameter: type – number type, specify the indication type.
+
+Return: number type, indicating the indication status. If the type parameter specifies a valid indication type, its actual status (value STATUS\_ON or STATUS\_OFF) is returned; if the type parameter specifies an invalid indication type, it returns STATUS\_UNKNOWN.
+
+#### **O.3.1.2.7 setStatus**
+
+Prototype: boolean setStatus(type, status)
+
+Description: Setting the front panel indication status.
+
+Parameter: type – number type, specify the indication type;
+
+status – number type, indication status.
+
+Return: boolean type, true value indicating the setting is successful, false value indicating the setting fails.
+
+## Annex P
+
+### JavaScript-AV setting unit
+
+(This annex forms an integral part of this Recommendation.)
+
+#### P.1 Overview
+
+This annex defines the function modules related to AV settings: audio parameter settings and video parameter settings. All setting methods not only write the setting parameters into NVM, but also take effect immediately.
+
+#### P.2 Audio and video parameter setting module
+
+This module defines JS objects related to audio and video parameter settings: AudioSetting and VideoSetting. The system should verify the permissions of the application, and only privileged applications can call the methods provided by this class.
+
+##### P.2.1 AudioSetting object
+
+AudioSetting is a built-in object that provides a method for setting audio parameters.
+
+###### P.2.1.1 Constant
+
+The constant definition of AudioSetting object is shown in Table P.1.
+
+**Table P.1 – Constants of AudioSetting object**
+
+| Constants | Description |
+|-------------------------------|---------------|
+| Channel type | |
+| const CHANNEL_STEREO = 0; | Stereo |
+| const CHANNEL_LEFT = 1; | Left channel |
+| const CHANNEL_RIGHT = 2; | Right channel |
+| const CHANNEL_MIXED_MONO = 3; | Mixed sound |
+| Audio port type | |
+| const PORT_HDMI = 0; | HDMI port |
+| const PORT_SPDIF = 1; | SPDIF port |
+
+###### P.2.1.2 Method
+
+###### P.2.1.2.1 getOutputInterfaceList
+
+Prototype: string[] getOutputInterfaceList()
+
+Description: Getting a list of all available audio output ports of the receiving terminal.
+
+Parameter: None.
+
+Return: A string array, indicating the names of all available audio output interfaces of the receiving terminal, such as "RCA", "S/PDIF", "HDMI", etc. If there is no audio output port available, the length of the returned array is 0.
+
+###### P.2.1.2.2 getOutputInterfaceStatus
+
+Prototype: boolean getOutputInterfaceStatus(port)
+
+Description: Getting the enabling status of the audio output port.
+
+Parameter: port – string type, indicating the name of the audio output interface, obtained by the `getOutputInterfaceList()` method.
+
+Return: boolean type, true value indicating the audio output port is allowed to output, and false value indicating that the audio output port is forbidden to output.
+
+#### **P.2.1.2.3 disableOutputInterface**
+
+Prototype: boolean `disableOutputInterface(port)`
+
+Description: Disable output of the audio output port.
+
+Parameter: port – string type, indicating the name of the audio output interface, obtained by the `getOutputInterfaceList()` method.
+
+Return: boolean type, true value indicating the prohibition is successful, and false value indicating the prohibition fails.
+
+#### **P.2.1.2.4 enableOutputInterface**
+
+Prototype: boolean `enableOutputInterface(port)`
+
+Description: Allow audio port output.
+
+Parameter: port – string type, indicating the name of the audio output interface, obtained by the `getOutputInterfaceList()` method.
+
+Return: boolean type, true value indicating success, and false value indicating failure.
+
+#### **P.2.1.2.5 getOutputVolume**
+
+Prototype: number `getOutputVolume()`
+
+Description: Getting the global output volume.
+
+Parameter: None.
+
+Return: number type, indicating the global output volume, the value range being 0-100, 0 indicating mute, 100 indicating maximum volume.
+
+#### **P.2.1.2.6 setOutputVolume**
+
+Prototype: boolean `setOutputVolume(volume)`
+
+Description: Setting the global output volume.
+
+NOTE – The actual output volume of a broadcast program = global output volume + the increase of the broadcast program relative to the global output volume.
+
+Parameter: volume – number type, indicating the global output volume, the value range being 0-100, 0 indicating mute, 100 indicating maximum volume.
+
+Return: boolean type, true indicating setting is successful, false indicating setting failed.
+
+#### **P.2.1.2.7 getOutputChannelMode**
+
+Prototype: number `getOutputChannelMode()`
+
+Description: Getting the current output channel type.
+
+Parameter: None.
+
+Return: number type.
+
+#### **P.2.1.2.8 setOutputChannelMode**
+
+Prototype: boolean `setOutputChannelMode(audioChannel)`
+
+Description: Setting the current output channel type.
+
+Parameter: audioChannel – number type.
+
+Return: boolean type, true value indicating the setting is successful, false value indicating the setting fails.
+
+#### **P.2.1.2.9 getOutputSPDIFMode**
+
+Prototype: number getOutputSPDIFMode()
+
+Description: Getting the data format of the S/PDIF output interface (compressed or PCM format).
+
+Parameter: None.
+
+Return: number type, indicating the data format of the S/PDIF output interface, with a value of 0 for PCM format, and 1 for compressed format.
+
+#### **P.2.1.2.10 setOutputSPDIFMode**
+
+Prototype: setOutputSPDIFMode(mode)
+
+Description: Setting the data format of the S/PDIF output interface (compressed or PCM format).
+
+Parameter: mode – number type, indicating the audio mode of the SPDIF output interface, the value is:
+
+- 0-indicating the PCM format, that is, compressed audio is decoded by the receiving terminal;
+- 1-indicating the compressed format, that is, compressed audio is decoded by an external decoding device.
+
+Return: None.
+
+#### **P.2.1.2.11 isMute**
+
+Prototype: boolean isMute()
+
+Description: Getting the mute status flag.
+
+Parameter: None.
+
+Return: boolean type, true value indicating mute, false value indicating sound.
+
+#### **P.2.1.2.12 mute**
+
+Prototype: boolean mute()
+
+Description: Setting mute.
+
+Parameter: None.
+
+Return: boolean type, true value indicating the setting is successful, false value indicating the setting fails.
+
+#### **P.2.1.2.13 unMute**
+
+Prototype: boolean unMute()
+
+Description: Unmute.
+
+Parameter: None.
+
+Return: boolean type, true value indicating the cancellation is successful, and false value indicating that the cancellation failed.
+
+#### **P.2.1.2.14 getOutputHDMIMode**
+
+Prototype: number getOutputHDMIMode()
+
+Description: Getting the data format of the HDMI output interface.
+
+Parameter: None.
+
+Return: number type, indicating the data format of the HDMI output interface.
+
+- 0-indicating off;
+- 1-Auto-negotiation;
+- 2-LPCM, output decoded signal;
+- 3-RAW, output the original signal.
+
+#### P.2.1.2.15 **setOutputHDMIFMMode**
+
+Prototype: `setOutputHDMIMode(mode)`
+
+Description: Setting the data format of the HDMI output interface (compressed or PCM format).
+
+Parameter: `mode`–number type, indicating the audio mode of the HDMI output interface, the value is:
+
+- 0-indicating off;
+- 1-Auto-negotiation;
+- 2-LPCM, output decoded signal;
+- 3-RAW, output the original signal.
+
+Return: None.
+
+### P.2.2 **VideoSetting object**
+
+`VideoSetting` is a built-in object that provides a method for setting video parameters.
+
+#### P.2.2.1 **Constant**
+
+The definitions of the `VideoSetting` object constants are shown in Table P.2.
+
+**Table P.2 – VideoSetting object constants**
+
+| Constants | Description |
+|--------------------------------------------------|--------------------------------------------|
+| Video output channel | |
+| const VOUT_SD = 1; | SD output channel |
+| const VOUT_HD = 2; | HD output channel |
+| Video window matching mode | |
+| const MATCH_METHOD_LETTER_BOX = 1; | Mailbox mode ( letter_box ) |
+| const MATCH_METHOD_PAN_SCAN = 2; | Full screen mode ( pan_scan ) |
+| const MATCH_METHOD_COMBINED = 3; | Combination mode ( combined ) |
+| const MATCH_METHOD_IGNORE = 4; | Ignore mode ( ignore ) |
+| Video output system | |
+| const VOUT_STANDARD_UNKNOWN = 0; | unknown |
+| const VOUT_STANDARD_NTSC_J = 101; | SD-NTSC-J/3.5795MHz color subcarrier |
+| const VOUT_STANDARD_NTSC_M = 102; | SD-NTSC-M/3.5795MHz color subcarrier |
+| const VOUT_STANDARD_NTSC_443 = 103; | SD-NTSC-443/4.4336MHz color subcarrier |
+| const VOUT_STANDARD_PAL_B = 211; | SD-PAL-B (Australia) |
+| const VOUT_STANDARD_PAL_B1 = 212; | SD-PAL-B1 (Hungary) |
+| const VOUT_STANDARD_PAL_D = 213; | SD-PAL-D (Mainland China) |
+| const VOUT_STANDARD_PAL_D1 = 214; | SD-PAL-D1 (Poland) |
+
+**Table P.2 – VideoSetting object constants**
+
+| Constants | Description |
+|---------------------------------------------------|-------------------------------------------|
+| const VOUT_STANDARD_PAL_G = 215; | SD-PAL-G (Europe) |
+| const = 216; | SD-PAL-H (Europe) |
+| constVOUT_STANDARD_PAL_I = 217; | SD-PAL-I (UK, Hong Kong, Macau) |
+| const VOUT_STANDARD_PAL_K = 218; | SD-PAL-K (Europe) |
+| const VOUT_STANDARD_PAL_M = 220; | SD-PAL-M (Brazil) |
+| const VOUT_STANDARD_PAL_N = 221; | SD-PAL-N (Jamaica, Uruguay) |
+| const VOUT_STANDARD_PAL_NC = 222; | SD-PAL-NC (Argentina) |
+| constVOUT_STANDARD_SECAM_B = 311; | SD-SECAM-B |
+| const VOUT_STANDARD_SECAM_D = 312; | SD-SECAM-D |
+| const VOUT_STANDARD_SECAM_G = 313; | SD-SECAM-G |
+| const = 314; | SD-SECAM-I |
+| const VOUT_STANDARD_SECAM_K = 315; | SD-SECAM-K |
+| constVOUT_STANDARD_SMPTE274_1080I_50 = 27400; | HD-SMPTE274/1920x1080I/50HZ/1125 lines |
+| const VOUT_STANDARD_SMPTE274_1080I_59_94 = 27401; | HD-SMPTE274/1920x1080I/59.94HZ/1125 lines |
+| const VOUT_STANDARD_SMPTE274_1080I_60 = 27402; | HD-SMPTE274/1920x1080I/60HZ/1125 lines |
+| const V = 27410; | HD-SMPTE274/1920x1080P/23.98HZ/1125 lines |
+| const VOUT_STANDARD_SMPTE274_1080P_24 = 27411; | HD-SMPTE274/1920x1080P/24HZ/1125 lines |
+| constVOUT_STANDARD_SMPTE274_1080P_25 = 27412; | HD-SMPTE274/1920x1080P/25HZ/1125 lines |
+| const VOUT_STANDARD_SMPTE274_1080P_29_97 = 27413; | HD-SMPTE274/1920x1080P/29.97HZ/1125 lines |
+| const OUT_STANDARD_SMPTE274_1080P_30 = 27414; | HD-SMPTE274/1920x1080P/30HZ/1125 lines |
+| const VOUT_STANDARD_SMPTE274_1080P_50 = 27415; | HD-SMPTE274/1920x1080P/50HZ/1125 lines |
+| const = 27416; | HD-SMPTE274/1920x1080P/59.94HZ/1125 lines |
+| constVOUT_STANDARD_SMPTE274_1080P_60 = 27417; | HD-SMPTE274/1920x1080P/60HZ/1125 lines |
+| const VOUT_STANDARD_SMPTE295_1080I_50 = 29500; | HD-SMPTE295/1920x1080I/50HZ/1250 lines |
+| const VOUT_STANDARD_SMPTE295_1080P_50 = 29510; | HD-SMPTE295/1920x1080P/50HZ/1250 lines |
+| const VOUT_STANDARD_SMPTE296_720P_23_98 = 29610; | HD-SMPTE296/1280x720P/23.98HZ/750 lines |
+| const VOUT_STANDARD_SMPTE296_720P_24 = 29611; | HD-SMPTE296/1280x720P/24HZ/750 lines |
+
+**Table P.2 – VideoSetting object constants**
+
+| Constants | Description |
+|--------------------------------------------------|-----------------------------------------|
+| constVOUT_STANDARD_SMPTE296_720P_25 = 29612; | HD-SMPTE296/1280x720P/25HZ/750 lines |
+| const VOUT_STANDARD_SMPTE296_720P_29_97 = 29613; | HD-SMPTE296/1280x720P/29.97HZ/750 lines |
+| const VOUT_STANDARD_SMPTE296_720P_30 = 29614; | HD-SMPTE296/1280x720P/30HZ/750 lines |
+| const VOUT_STANDARD_SMPTE296_720P_50 = 29615; | HD-SMPTE296/1280x720P/50HZ/750 lines |
+| const = 29616; | HD-SMPTE296/1280x720P/59.94HZ/750 |
+| constVOUT_STANDARD_SMPTE296_720P_60 = 29617; | HD-SMPTE296/1280x720P/60HZ/750 lines |
+| const VOUT_STANDARD_2160P_24 = 29618; | HD-3840x2160P/24HZ |
+| const VOUT_STANDARD_2160P_25 = 29619; | HD-3840x2160P/25HZ |
+| const VOUT_STANDARD_2160P_30 = 29620; | HD-3840x2160P/30HZ |
+| const VOUT_STANDARD_2160P_50 = 29621; | HD-3840x2160P/50HZ |
+| constVOUT_STANDARD_2160P_60 = 29622; | HD-3840x2160P/60HZ |
+| constVOUT_STANDARD_4096P_24 = 29623; | HD-4096x2160P/24HZ |
+
+### P.2.2.2 Method
+
+#### P.2.2.2.1 getOutputInterfaceList
+
+Prototype: string[] getOutputInterfaceList()
+
+Description: Getting a list of all available video output ports of the receiving terminal.
+
+Parameter: None.
+
+Return: string array, indicating the names of all available video output interfaces of the receiving terminal, such as "CVBS", "YUV", "HDMI-0", "HDMI-1", "DVO", etc. If no video output port is available, the length of the returned array is 0.
+
+#### P.2.2.2.2 getOutputInterfaceStatus
+
+Prototype: boolean getOutputInterfaceStatus(port)
+
+Description: Getting the enabling status of the video output port.
+
+Parameter: port – string type, indicating the name of the video output interface, obtained by the getOutputInterfaceList() method.
+
+Return: boolean type, true value indicating the video output interface allows output, and false value indicating that the video output interface prohibits output.
+
+#### P.2.2.2.3 disableOutputInterface
+
+Prototype: boolean disableOutputInterface(port)
+
+Description: Disable video output port output.
+
+Parameter: port – string type, indicating the name of the video output interface, obtained by the getOutputInterfaceList() method.
+
+Return: boolean type, true value indicating the prohibition is successful, and false value indicating that the prohibition fails.
+
+#### **P.2.2.2.4 enableOutputInterface**
+
+Prototype: boolean enableOutputInterface(port)
+
+Description: Allow video output port output.
+
+Parameter: port – string type, indicating the name of the video output interface, obtained by the getOutputInterfaceList() method.
+
+Return: boolean type, true value indicating success is allowed, and false value indicating that failure is allowed.
+
+#### **P.2.2.2.5 getOutputBrightness**
+
+Prototype: number getOutputBrightness()
+
+Description: Getting the brightness of the video output.
+
+Parameter: None.
+
+Return: number type, indicating the brightness of the video output. The value range being from 0 to 100, 0 indicating the darkest, and 100 indicating the brightest.
+
+#### **P.2.2.2.6 getOutputContrast**
+
+Prototype: number getOutputContrast()
+
+Description: Getting the contrast of the video output.
+
+Parameter: None.
+
+Return: number type, indicating the contrast of the video output, and the value range being 0-100 from small to large.
+
+#### **P.2.2.2.7 getOutputSaturation**
+
+Prototype: number getOutputSaturation()
+
+Description: Getting the saturation (chromaticity) of the video output.
+
+Parameter: None.
+
+Return: number type, indicating the saturation (chromaticity) of the video output, and the value range being 0-100 from small to large.
+
+#### **P.2.2.2.8 getOutputStandard**
+
+Prototype: number getOutputStandard(device)
+
+Description: Getting the video output format.
+
+Parameter: device – number type, indicating the video output channel, the value is VOUT\_SD or VOUT\_HD.
+
+Return: number type, indicating the format of the video output.
+
+#### **P.2.2.2.9 getOutputTransparency**
+
+Prototype: number getOutputTransparency()
+
+Description: Getting the transparency of the video output.
+
+Parameter: None.
+
+Return: number type, indicating transparency, the value range being 0-100, 0 indicating completely opaque, and 100 indicating completely transparent.
+
+#### **P.2.2.2.10 setOutputBrightness**
+
+Prototype: boolean setOutputBrightness(value)
+
+Description: Setting the brightness of the video output. This setting cannot be applied to a single video output unit, and it takes effect for all video output units at the same time.
+
+Parameter: value – number type, indicating the brightness of the video output, the value range being 0-100 from small to large, 0 indicating the darkest, and 100 indicating the brightest.
+
+Return: boolean type, true value indicating the setting is successful, false value indicating the setting fails.
+
+#### **P.2.2.2.11 setOutputContrast**
+
+Prototype: boolean setOutputContrast(value)
+
+Description: The contrast of the video output. This setting cannot be applied to a single video output unit, and it takes effect for all video output units at the same time.
+
+Parameter: value – number, indicating the contrast of the video output, the value range being 0-100 from small to large.
+
+Return: boolean type, true value indicating the setting is successful, false value indicating the setting fails.
+
+#### **P.2.2.2.12 setOutputSaturation**
+
+Prototype: boolean setOutputSaturation(value)
+
+Description: Setting the saturation (chroma) of the video output. This setting cannot be applied to a single video output unit, and it takes effect for all video output units at the same time.
+
+Parameter: value – number, indicating the saturation (chroma), and the value range being 0-100 from small to large.
+
+Return: boolean type, true value indicating the setting is successful, false value indicating the setting fails.
+
+#### **P.2.2.2.13 setOutputStandard**
+
+Prototype: number setOutputStandard(device, standard)
+
+Description: Setting the video output format. The SD output unit and HD output unit need to be set separately.
+
+Parameter: device – number type, indicating the video output unit;
+
+standard – number type, indicating the video output format. The SD output unit can only choose the SD format, and the HD output unit can only choose the HD format.
+
+Return: boolean type, true value indicating the setting is successful, false value indicating the setting fails.
+
+#### **P.2.2.2.14 setOutputTransparency**
+
+Prototype: boolean setOutputTransparency(value)
+
+Description: Setting the transparency of the video output. This method cannot be set for a single video output unit, and it is effective for all video output units.
+
+Parameter: value – number, indicating transparency, the value range being 0-100, 0 indicating completely opaque, and 100 indicating completely transparent.
+
+Return: boolean type, true value indicating the setting is successful, false value indicating the setting fails.
+
+#### **P.2.2.2.15 setOutputMatchMethod**
+
+Prototype: setOutputMatchMethod(mode)
+
+Description: Setting the video output window matching mode.
+
+Parameter: mode – number type.
+
+Return: None.
+
+#### **P.2.2.2.16 getOutputMatchMethod**
+
+Prototype: number getOutputMatchMethod()
+
+Description: Getting the matching mode of the video output window.
+
+Parameter: None.
+
+Return: number type.
+
+#### **P.2.2.2.17 getOutputAspectRatio**
+
+Prototype: getOutputAspectRatio()
+
+Description: Getting the aspect ratio of the video output.
+
+Parameter: None.
+
+Return: number type, 0 indicating 16:9; 1 indicating 4:3.
+
+#### **P.2.2.2.18 setOutputAspectRatio**
+
+Prototype: setOutputAspectRatio(mode)
+
+Description: Setting the video output aspect ratio.
+
+Parameter: mode – number type, 0 indicating 16:9; 1 indicating 4:3.
+
+Return: None.
+
+#### **P.2.2.2.19 GetColorSpaceMode**
+
+Prototype: number GetColorSpaceMode()
+
+Description: Getting the color space mode.
+
+Parameter: None.
+
+Return: number type, 0-RGB444, 1-YCBCR422, 2 -YCBCR444, 3-YCBCR420.
+
+#### **P.2.2.2.20 GetDeepColorMode**
+
+Prototype: number GetDeepColorMode()
+
+Description: Getting the color space mode.
+
+Parameter: None.
+
+Return: number type, 0-COLOR\_24BIT, 1-COLOR\_30BIT, 2-COLOR\_36BIT, 3-COLOR\_DEEP\_OFF.
+
+#### **P.2.2.2.21 SetColorSpaceAndDeepColor**
+
+Prototype: boolean SetColorSpaceAndDeepColor( colorSpace, deepColor)
+
+Description: Setting the color space, dark mode.
+
+Parameter: `colorSpace` – number type, 0-RGB444, 1-YCBCR422, 2-YCBCR444, 3-YCBCR420
+
+`deepColor` – number type, 0-COLOR\_24BIT, 1-COLOR\_30BIT, 2-COLOR\_36BIT, 3-COLOR\_DEEP\_OFF
+
+Return: boolean type, true value indicating the setting is successful, false value indicating the setting fails.
+
+#### **P.2.2.2.22 GetHDRType**
+
+Prototype: number GetHDRType()
+
+Description: Getting HDR mode.
+
+Parameter: None.
+
+Return: number type, 0-HDRTYPE\_SDR, 1-HDRTYPE\_DOLBY, 2-HDRTYPE\_HDR10, 3-C HDRTYPE\_AUTO.
+
+#### **P.2.2.2.23 SetHDRType**
+
+Prototype: boolean SetHDRType(type)
+
+Description: Setting HDR mode.
+
+Parameter: `type` – number type, 0-HDRTYPE\_SDR, 1-HDRTYPE\_DOLBY, 2-HDRTYPE\_HDR10, 3-C HDRTYPE\_AUTO
+
+Return: boolean type, true value indicating the setting is successful, false value indicating the setting fails.
+
+#### **P.2.2.2.24 GetStereoOutMode**
+
+Prototype: number GetStereoOutMode()
+
+Description: Getting the 3D output mode.
+
+Parameter: None.
+
+Return: number type, 0-3D\_NONE, 1-3D\_FRAME\_PACKING, 2-3D\_SIDE\_BY\_SIDE\_HALF, 3-3D\_TOP\_AND\_BOTTOM, 4-3D\_FIELD\_ALTERNATIVE, 5-3D\_LINE\_ALTERNATIVE, 6-3D\_SIDE\_BY\_SIDE\_FULL, 7-3D\_L\_DEPTH, 8-3D\_L\_DEPTH\_GRAPHICS\_GRAPHICS\_DEPTH.
+
+#### **P.2.2.2.25 SetStereoOutMode**
+
+Prototype: boolean SetStereoOutMode(mode, fps)
+
+Description: Setting the 3D output mode.
+
+Parameter: `mode` – number type, 0-3D\_NONE, 1-3D\_FRAME\_PACKING, 2-3D\_SIDE\_BY\_SIDE\_HALF, 3-3D\_TOP\_AND\_BOTTOM, 4-3D\_FIELD\_ALTERNATIVE, 5-3D\_LINE\_ALTERNATIVE, 6-3D\_SIDE\_BY\_SIDE\_FULL, 7-3D\_L\_DEPTH, 8-3D\_L\_DEPTH\_GRAPHICS\_GRAPHICS\_DEPTH
+
+`Fps` – number type, video frame rate, the values are 23, 24, 25, 30, 50, 59, 60.
+
+Return: boolean type, true value indicating the setting is successful, false value indicating the setting fails.
+
+#### **P.2.2.2.26 GetRightEyeFirst**
+
+Prototype: number GetRightEyeFirst()
+
+Description: Getting which eye of the 3D output signal is to come out first.
+
+Parameter: None.
+
+Return: number type, the values are 0-LEFT\_EYE\_FIRST, 1-RIGHT\_EYE\_FIRST.
+
+#### **P.2.2.2.27 SetRightEyeFirst**
+
+Prototype: boolean SetRightEyeFirst(Outpriority)
+
+Description: Setting which eye of the 3D output signal is to come out first.
+
+Parameter: Outpriority – number type, 0-LEFT\_EYE\_FIRST, 1-RIGHT\_EYE\_FIRST
+
+Return: boolean type, true value indicating the setting is successful, false value indicating the setting fails.
+
+#### **P.2.2.2.28 GetStereoDepth**
+
+Prototype: number GetStereoDepth()
+
+Description: Getting 3D picture depth adjustment information.
+
+Parameter: None.
+
+Return: number type, the value being 0-10.
+
+#### **P.2.2.2.29 SetStereoDepth**
+
+Prototype: boolean SetStereoDepth(depth)
+
+Description: Setting 3D picture depth adjustment information.
+
+Parameter: depth – number type, 0-10.
+
+Return: boolean type, true value indicating the setting is successful, false value indicating the setting fails.
+
+#### **P.2.2.2.30 getPictureMode()**
+
+Prototype: number getPictureMode()
+
+Description: Getting the picture mode.
+
+Parameter: None.
+
+Return: number type, 0 standard, 1 dynamic, 2 soft, 4 users, 5 gorgeous, 6 natural, 7 sports.
+
+#### **P.2.2.2.31 setPictureMode**
+
+Prototype: boolean setPictureMode(mode)
+
+Description: Setting the picture mode.
+
+Parameter: mode – number type, 0 standard, 1 dynamic, 2 soft, 4 users, 5 gorgeous, 6 natural, 7 sports.
+
+Return: boolean type, true value indicating the setting is successful, false value indicating the setting fails.
+
+#### **P.2.2.2.32 getDisplayHue**
+
+Prototype: number getDisplayHue()
+
+Description: Getting the picture mode.
+
+Parameter: None.
+
+Return: number type, the value range being 0-100, indicating the color adjustment value.
+
+#### **P.2.2.2.33 setDisplayHue**
+
+Prototype: boolean setDisplayHue(hue)
+
+Description: Setting the picture mode.
+
+Parameter: hue – number type, the value range being 0-100, indicating the color adjustment value.
+
+Return: boolean type, true value indicating the setting is successful, false value indicating the setting fails.
+
+#### **P.2.2.2.34 SaveDisplayFmt**
+
+Prototype: boolean SaveDisplayFmt()
+
+Description: Saving the video output format permanently effective.
+
+Parameter: None.
+
+Return: boolean type, true value indicating success, false value indicating failure.
+
+#### **P.2.2.2.35 setOptimalFormatEnable**
+
+Prototype: boolean setOptimalFormatEnable(enabled)
+
+Description: Setting automatic optimization video output format enable.
+
+Parameter: enabled – number type, 0-indicating disable, 1-indicating enable.
+
+Return: boolean type, true value indicating the setting is successful, false value indicating the setting fails.
+
+#### **P.2.2.2.36 getOptimalFormatEnable**
+
+Prototype: number getOptimalFormatEnable()
+
+Description: Getting the automatic optimization video output format enable.
+
+Parameter: None – number type, 0-indicating disable, 1-indicating enable.
+
+Return: number type, 0 indicating disable, 1 indicating enable.
+
+## Annex Q
+
+### JavaScript-Media processing unit
+
+(This annex forms an integral part of this Recommendation.)
+
+#### Q.1 Overview
+
+This annex defines a functional module related to media processing: media playback module.
+
+#### Q.2 Media playback module
+
+This module defines the JS object related to media playReturn: MediaPlayer.
+
+##### Q.2.1 Message
+
+Definitions of messages sent by the media player module to the application layer is shown in the following table, and the message received on the application uses document.onsystemevent.
+
+**Table Q.1 – Messages of media playback module**
+
+| Name of messages | event.which | event.modifiers | Description of messages |
+|---------------------------|-----------------|-----------------|----------------------------------------|
+| MSG_MEDIA_URL_VALID | 13001 | – | The media source path is valid. |
+| MSG_MEDIA_URL_INVALID | 13002 | – | The media source path is invalid. |
+| MSG_MEDIA_PLAY_SUCCESS | 13003 | – | Playback started successfully. |
+| MSG_MEDIA_PLAY_FAILED | 13004 | – | Failed to start playback. |
+| MSG_MEDIA_SETPACE_SUCCESS | 13005 | – | The step size is set successfully. |
+| MSG_MEDIA_SETPACE_FAILED | 13006 | – | Failed to set the step size. |
+| MSG_MEDIA_SEEK_SUCCESS | 13007 | – | Playback time point set successfully. |
+| MSG_MEDIA_SEEK_FAILED | 13008 | – | Failed to set the playback time point. |
+| MSG_MEDIA_PAUSE_SUCCESS | 13009 | – | Playback paused successfully. |
+| MSG_MEDIA_PAUSE_FAILED | 13010 | – | Failed to pause the playback. |
+| MSG_MEDIA_RESUME_SUCCESS | 13011 | – | Playback resumed successfully. |
+| MSG_MEDIA_RESUME_FAILED | 13012 | – | Failed to resume the playback. |
+| MSG_MEDIA_STOP_SUCCESS | 13013 | – | Playback stopped successfully. |
+| MSG_MEDIA_STOP_FAILED | 13014 | – | Failed to stop the playback. |
+| Reserved | 13015~13200 | | | + +**Table Q.1 – Messages of media playback module** + +| Name of messages | event.which | event.modifiers | Description of messages | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|------------------------|--------------------------------| +| The value of event.modifiers is automatically given by the system, and its data type:
– "Number", indicating that the value is the ID of the message description character string, which can be obtained through the Utility.getEventInfo() method. If the "message description" defines the JSON format of the message character string, the message content will be retrieved according to the format.
– "-", indicating that event.modifiers is undefined. | | | | + +### **Q.2.2 MediaPlayer object** + +The MediaPlayer object is a local object and needs to be created "new" before use. + +This object defines the properties and methods for media playback in the Web page. The media source can be TV broadcast, sound broadcast or NVOD, it can also be a UDP unicast or multicast stream, or it can be a media file stored locally in the receiving terminal. This object only needs to know the media type and the location (URL) of the media to play this media. + +The display of the video layer must be rendered transparent by the video element. In the page layout, the video element specifies the position, size, and level of the video on the page. The page must use ``, src Empty, for example: `` + +After the MediaPlayer object is constructed, it can only be used in a single web page, and is uniquely identified by the object name; the player instance corresponds to the media decoding resource of the receiving terminal, and is not bound to the web page, and can be used across pages, and is uniquely identified through the player instance ID, the player instance ID is automatically generated by the system. The browser must control the player instance to achieve media playback through the properties and methods provided by the MediaPlayer object, and one MediaPlayer object can only be bound to one player instance, and one player instance can only be bound to one MediaPlayer object at the same time. The relationship between the MediaPlayer object and the player instance is shown in Figure Q.1. + + + +Schematic diagram showing two overlapping web browser windows, 'Webpage 1' and 'Webpage 2'. 'Webpage 1' contains a media player interface. A line labeled 'MediaPlayer Object (Object name: mp1)' points to the window title bar. Another line labeled 'MediaPlayer Object (Object name: mp2)' points to the window title bar of 'Webpage 2'. A line labeled 'bindPlayerInstance()' points from the media player interface in 'Webpage 1' to a box labeled 'Player instance (Hardware or software decoding resources)'. The text 'J.1206(24)' is in the bottom right corner of the diagram area. + +**Figure Q.1 – Schematic diagram of the relationship between the MediaPlayer object and the media playback instance** + +Example: + +The MediaPlayer object created in the web page can control the player instance on the receiving terminal, and the life cycle of the player instance is cross-page. Identify the currently bound player instance through the playerInstanceID property of the MediaPlayer object. + +``` +//In the first web page, create a MediaPlayer object mp1 +var mp1 = new MediaPlayer(); +//Read the local media player instance ID +var nativePlayerInstanceID = mp1.getPlayerInstanceID(); +//Reserve this player instance identifier through global variables for cross-page use +GlobalVarManager.setItemValue("PLAYER_INSTANCE_ID", nativePlayerInstanceID); +//The MediaPlayer object is bound to the player instance +mp1.bindPlayerInstance(nativePlayerInstanceID); +mp1.setMediaSource(mediaURL); //Set media source +mp1.play(); //Start playing +... +mp1.setPace(2); //fast forward, 2x speed playback +... +mp1.setPace(1); //resume playback at normal speed +... +mp1.pause(); //pause playback +mp1.resume(); //resume playback +``` + +``` + +mp1.stop(); //stop playback +mp1.unbindPlayerInstance(nativePlayerInstanceID); +//In the next web page, create a MediaPlayer object mp2 +var mp2 = new MediaPlayer(); +//Getting the player instance ID of the previous page through global variables +var nativePlayerInstanceID = GlobalVarManager.getItemValue("PLAYER_INSTANCE_ID"); +//According to the player instance ID passed from the previous page, bind the MediaPlayer +//object and the media player instance +mp2.bindPlayerInstance(nativePlayerInstanceID); +mp2.setMediaSource(mediaURL); //Set media source +mp2.play(); //start playback +mp2.pause(); //pause playback +mp2.resume(); //resume playback +mp2.stop(); //stop playback +mp2.unbindPlayerInstance(nativePlayerInstanceID); + +``` + +### Q.2.2.1 Media playback status + +The media player has the following playback status: initialization, binding, stop, playing (forward/backward/fast forward/slow forward/fast backward/slow backward), pause and unbinding. The status transition diagram is shown in Figure Q.2. + + + +``` + +stateDiagram-v2 + [*] --> Initialization + Initialization --> Binding : bindPlayerInstance() + Binding --> Stop : setMediaSource() + Stop --> Playing : play() + Stop --> Unbinding : unbindPlayerInstance() + Stop --> Stop : stop() + Playing --> Stop : stop() + Playing --> Playing : seek() + Playing --> Pause : pause() + Pause --> Playing : resume() + Pause --> Stop : stop() + Pause --> Playing : seek() + +``` + +Schematic diagram of media playback status transition. The diagram shows five states: Initialization, Binding, Stop, Playing, and Pause, plus an Unbinding state. Transitions are: Initialization to Binding via bindPlayerInstance(); Binding to Stop via setMediaSource(); Stop to Playing via play(); Stop to Unbinding via unbindPlayerInstance(); Stop to Stop via stop() (self-loop); Playing to Stop via stop() (self-loop); Playing to Playing via seek() (self-loop); Playing to Pause via pause(); Pause to Playing via resume(); Pause to Stop via stop() (curved arrow); Pause to Playing via seek() (self-loop). + +J.1206(24) + +**Figure Q.2 – Schematic diagram of media playback status transition** + +The various statuses of media playback in Figure Q.2 are described as follows: + +- Initialization status: When the MediaPlayer object is created, it enters the initialization status. +- Binding status: When the MediaPlayer object calls the bindPlayerInstance() method, it enters the binding status. +- Stop status: When the MediaPlayer object calls the setMediaSource() or stop() method, it enters the stop status. At this time, the video and audio stop playing, and the video screen is in a hidden state. +- Playback status: When the MediaPlayer object calls the play() method, it enters the playback status, including forward, backward, fast forward, slow forward, fast backward, and slow backward. The relationship between the playback step size and the playback status is shown in Table Q.2. + +**Table Q.2 – Relationship between the playback step size and the playback status** + +| Playback status | Step size (pace) | Description | +|-----------------|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Forward | 1 | When the play() method is used to start playback, pace = 1, it enters the forward status, and the default step size is 1. | +| Backward | −1 | When the play() method is used to start playback, pace = −1, if the media is not played from the beginning, it will enter the backward status. | +| Fast forward | 2, 4, 8, 16, 32 | When the play() method is used to start playback, and pace = 2, 4, 8, 16, 32, it enters the fast forward status. | +| Slow forward | 1/2, 1/4, 1/8 | When the play() method is used to start playback, and pace = 1/2, 1/4, 1/8, it enters the slow forward status. | +| Fast backward | −2, −4, −8, −16, −32 | When the play() method is used to start playback, and pace = −2, −4, −8, −16, −32, if the media is not played from the beginning, it will enter the fast backward status. | +| Slow backward | −1/2, −1/4, −1/8 | When the play() method is used to start playback, and pace = −1/2, −1/4, −1/8, if the media is not played from the beginning, it will enter the slow backward status. | + +- Pause status: When the MediaPlayer object calls the pause() method, it can enter the pause status; in the pause status, the video picture continues to occupy the screen space, and it can be set to a static frame (default) or black field. +- Unbinding status: When the MediaPlayer object calls the unbindPlayerInstance() method, it can enter the unbinding status. Release resources. + +The played media sources have the following forms: + +- Broadcasting services, including TV services, audio broadcasting services, NVOD services, etc.; +- Interactive TV services, including video-on-demand, time-shifted TV and channel review, etc.; +- The code stream sent to the terminal through IP-UDP; +- Media files stored locally on the terminal. + +The playback status and playback step size supported by different sources of media are shown in Table Q.3. + +**Table Q.3 – Table of media playback status and step size** + +| Media source | Initiali-
zation | Bind-
ing | Ready | Playback | | | | | | Pause | Stop | Unbind-
ing | +|------------------------------|---------------------|--------------|-------|--------------|---------------|------------------|------------------------|----------------------|-----------------------|-------|------|----------------| +| | | | | For-
ward | Back-
ward | Fast-
forward | Fast-
back-
ward | Slow
for-
ward | Slow
back-
ward | | | | +| Broad-
casting
service | √ | √ | √ | √ | N/A | N/A | N/A | N/A | N/A | √ | √ | √ | +| Interactive
TV service | √ | √ | √ | √ | √ | √ | √ | N/A | N/A | √ | √ | √ | +| IP-UDP
coding
stream | √ | √ | √ | √ | N/A | N/A | N/A | N/A | N/A | √ | √ | √ | + +**Table Q.3 – Table of media playback status and step size** + +| Media source | Initialization | Binding | Ready | Playback | | | | | | Pause | Stop | Unbinding | +|-------------------|----------------|---------|-------|----------|----------|--------------|---------------|--------------|---------------|-------|------|-----------| +| | | | | Forward | Backward | Fast-forward | Fast-backward | Slow forward | Slow backward | | | | +| Local media files | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | + +**Q.2.2.2 Property** + +The definition of the media player object property is shown in Table Q.4. + +**Table Q.4 – Properties of the MediaPlayer object** + +| Property name | Type | Read and write property | Description | +|------------------|--------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | Read only | It indicates the locator of the media file. | +| playerInstanceID | number | Read only | It indicates the player instance ID bound to the current MediaPlayer object. If the value is -1, it indicates that the current MediaPlayer object has not been bound to any player instance.
For example, before calling bindPlayerInstance() method, or after calling unbindPlayerInstance() method, read this property, it should return -1. | + +**Q.2.2.3 Method** + +**Q.2.2.3.1 MediaPlayer** + +Prototype: MediaPlayer() + +Description: Construction method, create a default MediaPlayer object. + +Parameter: None. + +**Q.2.2.3.2 getPlayerInstanceID** + +Prototype: number getPlayerInstanceID() + +Description: Getting the player instance ID available locally on the receiving terminal, which is automatically assigned by the system. + +Parameter: None. + +Return: number type, returning 0-255 if it succeeds, and returning -1 if it fails. + +**Q.2.2.3.3 bindPlayerInstance** + +Prototype: number bindPlayerInstance(playerInstanceID) + +Description: The MediaPlayer object is bound to the player instance. + +Parameter: playerInstanceID – number type, indicating the local player instance ID, the value range being 0-255. + +Return: number type, returning 0 if it succeeds, and returning -1 if it fails. + +**Q.2.2.3.4 unbindPlayerInstance** + +Prototype: number unbindPlayerInstance(playerInstanceID) + +Description: The MediaPlayer object is unbound with the current player instance, and the related resources of the player are released. + +Parameter: playerInstanceID – number type, indicating the local player instance ID, the value range being 0-255. + +Return: number type, returning 0 if it succeeds, and returning –1 if it fails. + +**Q.2.2.3.5 setMediaSource** + +Prototype: number setMediaSource(mediaURL) + +Description: An Asynchronous method, setting the URL address of the media to be played. After setting this parameter, the system automatically detects the legality of the set mediaURL. + +- If the URL is legal, send the message MSG\_MEDIA\_URL\_VALID to the page; +- If the URL is illegal, send the message MSG\_MEDIA\_URL\_INVALID to the page. + +Only after receiving the message MSG\_MEDIA\_URL\_VALID, the page can call the play() method to play. + +Parameter: mediaURL – string type, media path expressed in URL format, description of the URL format is shown in Table Q.5. + +**Table Q.5 – Format of media source** + +| Media source | mediaURL | Description | +|----------------------|---------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Broadcasting service | dvb://
- – Broadcasting services;
- – Service components, such as elementary streams such as video, audio, or subtitles;
- – Events of broadcasting service;
- – Files in OC/DC carousel.
For multi-tuner scenes, expand to dvbelement://frequency.symbolrate.modulation.serviceid.pmtpid.pcrpid.videotype.videopid.audiotype.audiopid?tunerid=xxx. | +| Broadcasting service | dvbelement://frequency.symbolrate.modulation.serviceid.-1.-1.-1.-1.-1.-1 | Play by specifying the frequency and other program information to meet the need for scrambled stream and multi-track playback when the program is not searched. The format is dvbelement://frequency.symbolrate.modulation.serviceid.-1.-1.-1.-1.-1.-1.
In this scene, the media engine parses pmtpid from the code stream according to serviceid, and parses pcrpid, videotype, videopid, audiotype, and audiopid according to pmtpid. If pmtpid exists and is valid, it does not search for pmtpid, and parses pcrpid, videotype, videopid, audiotype, and | + +Rec. ITU-T J.1206 (01/2024) 365 + +**Table Q.5 – Format of media source** + +| Media source | mediaURL | Description | +|------------------------|--------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | audiopid according to pmtpid. The frequency is measured in kilohertz, all numbers are decimal, and the invalid parameter is -1, such as dvbelement://131000.6875.64.3.-1.-1.-1.-1.-1.-1.-1 or dvbelement://131000.6875.64.3.4.-1.-1.-1.-1.-1.-1. For multi-tuner scenes, expand to dvbelement://frequency.symbolrate.modulation.serviceid.-1.-1.-1.-1.-1.-1.-1?tunerid=xxx. | +| Interactive TV service | rtsp://
- – Video on demand;
- – Time-shifted TV;
- – Channel review.
- – When the front end uses UDP unicast, MulticastAddress is "0.0.0.0"; when the front end uses UDP multicast, MulticastAddress is the sending multicast address;
- – UDPPort is the UDP port number;
- – Programmnumber is the service ID number;
- – VideoPID is the video PID;
- – AudioPID is the audio PID;
- 1. The application can be downloaded to the local storage through multiple data channels such as http, https, DVB OC data push, etc. from the website or specified URL, APPSTORE;
- 2. Copy applications directly from other storage devices to local storage.
- 1. The installation package can only be installed through the signature verification;
- 2. Decompress the installation package to the specified location in the local storage.
- 1. Delete the installation package;
- 2. Delete the buffered data files stored locally by the application;
- 3. Delete the decompressed directory.
- 1. Get the application list on the server;
- 2. Check the updated version on the server, and upgrade if there is a new version.
- 1. The application's access to system resources;
- 2. Application permissions need to be classified and prioritized;
- 3. The settings of application permissions can be modified and configured through the configuration file of the installation package;
- 4. Application startup and operation need to be carried out in the sandbox and also need permission for control.
- 1. Query of application operating status information;
- 2. Access authority information for system resources owned by the application;
- 3. Version information of the application.
- 1. Ensure the legitimacy of the application source through digital signature;
- 2. The generated installation package database requires root permission control to prevent unauthorized users from modifying the installation package database and ensure the security of the file;
- 3. After decompressing the application files and directory tree, only the application manager has read and write permissions to prevent applications from reading each other and ensure the isolation between applications;
- 4. Startup and operation, and access to resources need to be controlled through permissions to ensure the safety of application operation.
2. Switch between application and launcher;
3. Switch between applications;
4. Management of focus;
5. Processing of independent applications. | + +## **R.2 Application management module** + +This module defines the JS object related to application management: widget. + +### **R.2.1 window object extended property widget** + +``` +interface partial Window : EventTarget { + readonly attribute Widget widget; +}; +``` + +### **R.2.2 widget object** + +The widget object is a built-in object and is used directly. + +#### **R.2.2.1 Overview** + +The widget object contains read-only properties, methods, and message feedback. + +``` +interface Widget { + readonly attribute DOMString author; //corresponding to the author element of config.xml + readonly attribute DOMString description; //corresponding to the description element of config.xml + readonly attribute DOMString name; //corresponding to the name element of config.xml + readonly attribute DOMString shortName; //corresponding to the name short property of config.xml + readonly attribute DOMString version; //corresponding to the widget version property of config.xml + readonly attribute DOMString id; //corresponding to the widget id property of config.xml + readonly attribute DOMString authorEmail; //corresponding to the author email property of config.xml + readonly attribute DOMString authorHref; //corresponding to the author href property of config.xml + readonly attribute Storage preferences; //corresponding to the preference element of config.xml + readonly attribute unsigned long height; //corresponding to the widget height property of config.xml + readonly attribute unsigned long width; //corresponding to the widget width property of config.xml + void launchWidget(DOMString widgetname, DOMString src, DOMString type); +}; +``` + +``` + +void installWidget(DOMString widgetname, DOMString id, DOMString url); //Install widget +void updateWidget(DOMString widgetname, DOMString id, DOMString url); // Update + widget +DOMString checkWidget(DOMString widgetname, DOMString id, DOMString url); //Check + widget, return version number +void uninstallWidget(DOMString widgetname, DOMString id); //Uninstall widget +void deletePackage(DOMString widgetname, DOMString id); //Delete application package +//The following are several messages that the application manager feeds back to the application +attribute EventHandler onstart; +attribute EventHandler onresume; +attribute EventHandler onpause; +attribute EventHandler onstop; +attribute EventHandler onterminate; +attribute EventHandler ondownloadsuccess; +attribute EventHandler ondownloadfail; +attribute EventHandler ondownloadsize; +}; + +``` + +### Example of use + +The widget's config.xml configuration file is as follows: + +#### Packaged Web Apps (Widgets) – Packaging and XML Configuration (Second Edition) + +``` + +
+
+
+
+ +
+
+
+```
+
+### R.2.2.2 Property
+
+The definition of the widget object property is shown in Table R.2.
+
+Table R.2 – Properties of widget object
+
+| Property name | Type | Read/write property | Description |
+|---------------|--------|---------------------|--------------------------------------------------------|
+| Author | string | Read only | corresponding to the author element of config.xml |
+| description | string | Read only | corresponding to the description element of config.xml |
+| Name | string | Read only | corresponding to the name element of config.xml |
+| shortName | string | Read only | corresponding to the name short property of config.xml |
+
+**Table R.2 – Properties of widget object**
+
+| Property name | Type | Read/write property | Description |
+|---------------|----------------------|---------------------|------------------------------------------------------------|
+| Version | string | Read only | corresponding to the widget version property of config.xml |
+| Id | string | Read only | corresponding to the widget id property of config.xml |
+| authorEmail | string | Read only | corresponding to the author email property of config.xml |
+| authorHref | string | Read only | corresponding to the author href property of config.xml |
+| preferences | Storage | Read only | corresponding to the preference element of config.xml |
+| Height | Number unsigned long | Read only | corresponding to the widget height property of config.xml |
+| width | Number unsigned long | Read only | corresponding to the widget width property of config.xml |
+
+**R.2.2.3 Method**
+
+**R.2.2.3.1 launchWidget**
+
+Prototype: void launchWidget(DOMString widgetname, DOMString src, DOMString type)
+
+Description: Start the widget on the launcher or return the widget to the launcher.
+
+Parameter: widgetname – DOMString type, which is the start of the widget, which is the character string, if the widgetname is widget.launcher.home, it indicates that it must return to the launcher;
+
+src – DOMString type, it is obtained through the src of the content element of the widget's config.xml file;
+
+type – DOMString type, it is obtained by the type of the content element of the widget's config.xml file.
+
+Return: None.
+
+**R.2.2.3.2 installWidget**
+
+Prototype: void installWidget(DOMString widgetname, DOMString id, DOMString url)
+
+Description: Download and install the widget. If the widget does not exist, download it from the location specified by the url first.
+
+Parameter: widgetname – DOMString type, which is widget name, which is a character string;
+
+id – DOMString type, which is widget identifier, which is a character string;
+
+url – DOMString type, which is the download location of the specified widget, which is a character string.
+
+Return: None.
+
+**R.2.2.3.3 updateWidget**
+
+Prototype: void updateWidget(DOMString widgetname, DOMString id, DOMString url)
+
+Description: update widget.
+
+Parameter: widgetname – DOMString type, which is widget name, which is a character string;
+
+id – DOMString type, which is widget identifier, which is a character string;
+
+url – DOMString type, which is the download location of the specified widget, which is a character string.
+
+Return: None.
+
+#### **R.2.2.3.4 checkWidget**
+
+Prototype: DOMString checkWidget(DOMString widgetname, DOMString id, DOMString url)
+
+Description: detect widget.
+
+Parameter: widgetname – DOMString type, which is widget name, which is a character string;
+
+id – DOMString type, which is widget identifier, which is a character string;
+
+url – DOMString type, which is the download location of the specified widget, which is a character string.
+
+Return: version number.
+
+#### **R.2.2.3.5 uninstallWidget**
+
+Prototype: void uninstallWidget(DOMString widgetname, DOMString id)
+
+Description: Uninstall the widget.
+
+Parameter: widgetname – DOMString type, which is widget name, which is a character string;
+
+id – DOMString type, which is widget identifier, which is a character string;
+
+Return: None.
+
+#### **R.2.2.3.6 deletePackage**
+
+Prototype: void deletePackage(DOMString widgetname, DOMString id)
+
+Description: Delete the application package.
+
+Parameter: widgetname – DOMString type, which is widget name, which is a character string;
+
+id – DOMString type, which is widget identifier, which is a character string;
+
+Return: None.
+
+#### **R.2.2.4 Message callback**
+
+Message callback, used to feed back the current application process status and download status, the callback details are shown in Table R.3.
+
+**Table R.3 – Message callback of widget object**
+
+| Callback name | Description |
+|----------------------|-----------------------------------------------------------------|
+| onstart | Feedback status when the application process starts |
+| onresume | Feedback status when the application process is running |
+| onpause | Feedback status when the application process is paused |
+| onstop | Feedback status when the application process is stopped |
+| onterminate | Feedback status when the application process is interrupted |
+| ondownloadsuccess | Feedback status when the application is downloaded successfully |
+| ondownloadfail | Feedback status when downloading the application fails |
+
+**Table R.3 – Message callback of widget object**
+
+| Callback name | Description |
+|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ondownloadsize | 
Name
+Version:
++
...
++ +
The feedback status when the application is being downloaded, including the total size and the current number of bytes, see:
interface WidgetEvent: Event {
readonly attribute long widgetEvenTtype;
readonly attribute long download_totoalsize;
readonly attribute long download_currSize;}; |
+
+## Annex S
+
+### JavaScript-System management unit
+
+(This annex forms an integral part of this Recommendation.)
+
+#### S.1 Overview
+
+This annex defines the functional modules related to system management: data management, storage device management, file management, multimedia files, OTA software upgrades, system tools, and software and hardware information query.
+
+#### S.2 Data management module
+
+This module defines the JS object related to data management: DataConfig.
+
+##### S.2.1 Message
+
+The definition of the message that the data management module may send to the application layer is shown in Table S.1.
+
+**Table S.1 – Definition table of data management module message**
+
+| Message name | event.which | event.modifiers | Message description |
+|--------------------------------|-------------|-----------------|--------------------------------------------------------|
+| MSG_SAVE_DATA_SUCCESS | 14001 | – | Data writing is completed. |
+| MSG_SAVE_DATA_FAILED | 14002 | – | Data writing is not completed. |
+| MSG_REMOVE_DATA_SUCCESS | 14003 | – | Data deletion is completed. |
+| MSG_REMOVE_DATA_FAILED | 14004 | – | Data deletion is not completed. |
+| MSG_REVERT_DATA_SUCCESS | 14005 | – | Data recovery is completed. |
+| MSG_REVERT_DATA_FAILED | 14006 | – | Data recovery is not completed. |
+| MSG_RESTORE_TO_DEFAULT_SUCCESS | 14007 | – | Data restoration to factory settings is completed. |
+| MSG_RESTORE_TO_DEFAULT_FAILED | 14008 | – | Data restoration to factory settings is not completed. |
+| Reserved | 14009~14100 | | |
+
+NOTE – The value of event.modifiers is automatically given by the system, and its data type:
+
+- "Number" indicating that the value is the ID of the message description string, which can be obtained through the Utility.getEventInfo() method. If the "message description" defines the message character string JSON format, the message content will be retrieved according to the format.
+- "-", indicating event.modifiers is undefined.
+
+##### S.2.2 DataConfig object
+
+The DataConfig object is a built-in object.
+
+System parameters and user parameters are stored in the receiving terminal NVM in the form of a data table, and the data table is accessed in the form of "key name + key value". The key value is stored in JSON format in RAM and NVM. When the application reads the data, it should be parsed according to the application scenario corresponding to the key name.
+
+System parameters are provided by the system and stored in the system data table; user parameters are set by the application program and stored in the user data table. The system data table is used to store the global configuration information set by the system. Key names and key values are publicly disclosed in JSON format. Authorized applications can set/read parameters, but cannot delete data items; user data tables are maintained by the application itself, the JSON formats of the key names and key values are not publicly available.
+
+After the receiving terminal is turned on, the data table is automatically read from the NVM to the RAM; after the user sets the parameters, the data in the RAM can be saved to the NVM.
+
+NOTE – The system saves the setting values of the following functions. The saved values will be used next time the system is turned on, and will not be displayed in the system information table.
+
+Volume setting, setting S/PDIF output interface data format, channel setting, video resolution, graphics layer transparency, display aspect ratio.
+
+The JSON formats of the key names and key values of the system data table are shown in Table S.2.
+
+**Table S.2 – Definition table of data management module message**
+
+| Key name | Key value | |
+|----------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| DVBMainFrequencyInfo | Use | It describes DVB main frequency point information. |
+| | JSON format | [ { "deliveryType":1, "deliveryParams":[ {"frequency":626000, "symbolRate":6875, "modulation":3}, {"frequency":634000, "symbolRate":6875, "modulation":3}, {"frequency":642000, "symbolRate":6875, "modulation":3} ] }, ... ] NOTE – The JSON format of the key value of the DVBMainFrequencyInfo key can describe multiple delivery systems, and each delivery system can describe multiple main frequency point information. In this example, the above-mentioned JSON character string describes a DVB-C delivery system, and the delivery system includes 3 main frequency point information.
| +| | Description | deliveryType | +| | | Int type, indicating the type of the delivery system, for the values, please see the constant field definition of the DeliverySystemType interface "Delivery System Type". | +| | | frequency | +| | | Int type, indicating the tuning frequency, and is measured in a unit related to the value of the deliveryType field:- – If deliveryType=1, it indicates DVB-C delivery system, in kilohertz (kHz);
- – If deliveryType is other value, this key is meaningless.
– If deliveryType=1, it indicates DVB-C delivery system. For the values, please see the constant field definition of "modulation mode" of the DvbcTunningParameters class;
– If deliveryType is other value, this key is meaningless. | +| EPGSetting | Use | It describes EPG search setting information. | | +| | JSON format | { "search_start_date":0, "search_days":7, "program_event_maxcount":255 } | | +| | Description | search_start_date | Int type, indicating the start date of the system searching the program table. The default is 0, indicating that the current day will be the start date of the search, 1 indicating the second day, 2 indicating the third day,..., and so on. | +| | | search_days | Int type, indicating how many consecutive days the system will search for the program table. | +| | | program_event_max_count | Int type, indicating the maximum number of program events searched by EPG. If the value is -1, it means unlimited. | +| AudioSetting | Use | It describes audio settings information. | | +| | JSON format | { "enableGlobalVolume":0 } | | +| | Description | enableGlobalVolume | Int type, indicating whether to enable unified volume control, the value is:
– indicating whether the application allows the user to set the volume of each channel separately;
– the application allows to indicate that the volume of all live TV, audio broadcasting, NVOD, and mosaic is unified as the outputVolume value. | +| | | | | +| UserPreference | Use | It describes user preference setting information. | | +| | JSON format | { "audioLang":"zho", "osdLang":"eng" } | | +| | Description | audioLang | Character string, indicating the audio language preferred by the user. The three-letter language code follows GB/T 4880.2-2000. | + +**Table S.2 – Definition table of data management module message** + +| Key name | Key value | | | +|------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| | | osdLang | Character string, indicating the interface language preferred by the user. The three letter language code follows GB/T 4880.2-2000. | +| Portal | Use | It describes the portal server address information. | | +| | JSON format | {
"address":"http://ngb.com",
"port":8080,
"returnChannel":"modulator"
} | | +| | Description | address | Character string, indicating the portal server address. | +| | | port | Int type, indicating the access port of the portal server. | +| | | returnChannel | Character string, indicating a return channel, the values modulator and ethernet indicate the network modulator and Ethernet respectively. | +| NTP | Use | It describes the NTP server address information. | | +| | JSON format | {
"address":"http://ntp.com",
"port":8080
} | | +| | Description | address | Character string, indicating the NTP server address. | +| | | port | Int type, indicating the NTP server access port. | +| VODChannel | Use | It describes the VOD server address information. | | +| | JSON format | {
"MD5":"5A8B6493",
"VODParams":[
{
"frequency":634000,
"symbolRate":6875,
"modulation":3,
"QAMName":1234
},
{
"frequency":642000,
"symbolRate":6875,
"modulation":3,
"QAMName":4321
},
{
} | | + +**Table S.2 – Definition table of data management module message** + +| Key name | Key value | | +|--------------|--------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| |
"frequency":650000, "symbolRate":6875, "modulation":3, "QAMName":8888 } ] }NOTE – Only applicable to cable digital TV. | | +| Description | MD5 | Character string, indicating the MD5 code of the configuration file. | +| | frequency | Int type, indicating the frequency of the IPQAM frequency, in kilohertz (kHz). | +| | symbolRate | Int type, indicating the symbol rate of the IPQAM frequency point, in thousand symbols per second (ksymbol/s). | +| | modulation | Int type, indicating the IPQAM frequency point modulation mode. For the value, please refer to the constant field definition of "modulation mode" of the DvbcTunningParameters class. | +| | QAMName | Int type, indicating the VOD area code. | +| UserInfo | Use | It describes end user information. | +| | JSON format |
{ "adminPassword":"12345" } |
+| | Description | adminPassword Character string, indicating the administrator password, used to enter the system setting interface and watch locked channels. |
+| Autodeployer | Use | It describes the automatic deployment information of the application. |
+| | JSON format | { "mode":"auto-ip", "ocPath":[ { "deliveryType":1, "deliveryParams":[ {"frequency":626000, "symbolRate":6875, "modulation":3}, {"frequency":634000, "symbolRate":6875, "modulation":3}, {"frequency":642000, "symbolRate":6875, "modulation":3} ] }, ... ], "ipPath":[ { "udpPath":"192.168.1.12", "udpPort":8080, "downloadTimeout":60 } ] } |
+
+**Table S.2 – Definition table of data management module message**
+
+| Key name | Key value | |
+|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| | }, ... ] }
NOTE – The one-way broadcast channel supports multiple delivery systems and multiple frequency points to issue XML signaling files; the two-way broadband channel supports multiple UDP servers to issue XML signaling files.
| | +| Autodeployer | Description |mode
Character string, indicating the method of obtaining the XML signaling file for automatic deployment, the value is:
- – The method of obtaining the file indicates obtaining the XML signaling file from the two-way broadband channel;
- – File; Broadband channel indicates obtaining XML signaling file from one-way broadcast channel;
- – File; Broadcast channel acquisition value: it indicates self-adaptation most of the time, and preferentially obtains XML signaling file from two-way broadband channel;
- – File; it indicates self-adaptation preferentially from two-way broadband communication, and preferentially obtains XML signaling file from one-way broadband channel.
ocPath
JSON object type indicates OC download path for automatic deploying the xml signaling file.
- – Path. It indicates the automatic deployment of broadcast communication: int type, indicating the type of delivery system, same as the explanation of the DVBMainFrequencyInfo key;
- – Explanation; inFrequency: JSON object, same as the explanation of DVBMainFrequencyInfo key.
ipPath
JSON object type, indicating the ip download path for automatic deploying the xml signaling file.
- – Path. It indicates automation: character string, indicating the UDP server address;
- – Device address; It indicates automation: Int type, indicating UDP service port;
- – Port; It indicates automatic deployment of uencyI: Int type, indicating application download timeout time, in second.
{ "bakerFreq": { "frequency": 626000, "symbolRate": 6875, "modulation": 3 } } |
+
+**Table S.2 – Definition table of data management module message**
+
+| Key name | Key value | |
+|----------|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| | },"serviceGroupId": 1
} | | +| | frequency | Int type, indicating the tuning frequency,
– in kilohertz (kHz); | +| | symbolRate | Int type, indicating the symbol rate, in thousand
symbols per second (ksymbol/s). | +| | modulation | Int type, indicating the modulation mode, for
the value, please refer to the constant field
definition of "modulation mode" of the
DvbcTunningParameters class; | +| | serviceGroupId | Service Group Id value | + +### S.2.2.1 Method + +#### S.2.2.1.1 createUserPropertyTable + +Prototype: number createUserPropertyTable(name) + +Description: Creating a new user data table. + +Parameter: name – string type, indicating the name of the user data table. + +Return: number type, the value being: + +- If the user data table is created successfully, the return value is greater than 0, which is used to indicate the globally unique data table identifier; +- If the creation of the user data table fails due to unknown reasons, the value 0 will be returned; +- If the user data table to be created already exists, the value –1 will be returned; +- If the name of the user data table to be created is invalid (for example, it is a null or empty character string), the value –2 will be returned. + +#### S.2.2.1.2 getUserPropertyTable + +Prototype: number getUserPropertyTable(name) + +Description: Getting the user data table. + +Parameter: name – string type, indicating the name of the user data table. + +Return: number type, the value being as follows: + +- If the user data table is successfully obtained, the return value is greater than 0, which is used to indicate the globally unique data table identifier; +- If the user data table fails to be obtained due to unknown reasons, the value 0 will be returned; +- If the user data table to be obtained does not exist, the value –1 is returned; +- If the name of the user data table to be obtained is invalid (for example, it is a null or empty character string), the value –2 is returned. + +#### S.2.2.1.3 deleteUserPropertyTable + +Prototype: number deleteUserPropertyTable(tableID) + +Description: Delete the user data table. + +Parameter: tableID – number type, user data table ID. + +Return: number type, the value being as follows: + +- If the user data table is deleted successfully, the return value is greater than 0, which is used to indicate the globally unique data table identifier; +- If the user data table fails to be deleted due to unknown reasons, the value 0 will be returned; +- If the user data table to be deleted does not exist, the value –1 is returned; +- If the name of the user data table to be deleted is invalid (for example, it is a null or empty character string), the value –2 will be returned. + +#### **S.2.2.1.4 getSystemPropertyTable** + +Prototype: number getSystemPropertyTable() + +Description: Obtain the system data table. + +Parameter: None. + +Return: number type, the value being as follows: + +- If the system data table is successfully obtained, the return value is greater than 0, which is used to indicate the globally unique data table identifier; +- If the system data table fails to be obtained due to unknown reasons, the value 0 will be returned; +- If the system data table to be obtained does not exist, the value –1 is returned. + +#### **S.2.2.1.5 createItem** + +Prototype: createItem(tableID,strItem,strValue) + +Description: Creating a data item in the user data table and assign an initial value to the content of this data item. The operation on the system data table is invalid. + +Parameter: tableID – number type, user data table ID. + +strItem – string type, key name of the newly created data item. + +strValue – string type, JSON format character string, indicating the key value of the newly created data item. + +Return: number type, the value being as follows: + +- If the data item is created successfully, the return value is greater than 0; +- If the creation of the data item fails due to unknown reasons, the value 0 will be returned; +- If the input data table ID does not exist, the value –1 will be returned; +- If the name of the input data item already exists in the data table, the value –2 will be returned; +- If the name of the input data item is invalid (for example, null or empty character string), the value -3 is returned. + +#### **S.2.2.1.6 deleteItem** + +Prototype: deleteItem(tableID,strItem) + +Description: Delete a data item in the user data table. The operation on the system data table is invalid. + +Parameter: tableID – number type, data table ID. + +strItem – string type, name of the data item. + +Return: number type, the value being as follows: + +- If the deletion is successful, the return value is greater than 0; + +- If the deletion of the data item fails due to unknown reasons, the value 0 will be returned; +- If the data item does not exist, the value $-1$ is returned. + +#### S.2.2.1.7 **getProperty** + +Prototype: string getProperty(tableID, strItem) + +Description: Getting the value of a data item (read from memory). Both system data table and user data table can be operated. + +Parameter: tableID – number type, data table ID. + +strItem – string type, name of the data item. + +Return: string type, value of the data item; if the data item does not exist, null is returned. + +#### S.2.2.1.8 **setProperty** + +Prototype: number setProperty(tableID, strItem, strValue) + +Description: Setting the value of a data item (write to memory). Both system data table and user data table can be operated. + +Parameter: tableID – number type, indicating the data table ID; + +strItem – string type, indicating the name of the data item; + +strValue – string type, indicating the value of the data item. + +Return: number type, the value being as follows: + +- If the modification is successful, the return value is greater than 0; +- If the modification of the content fails due to unknown reasons, the value 0 will be returned; +- If the data item does not exist, the value $-1$ is returned. + +#### S.2.2.1.9 **saveToNvm** + +Prototype: boolean saveToNvm(tableID) + +Description: An Asynchronous method, writing the data table in RAM to NVM, overwrite the data table in NVM. Both system data table and user data table can be operated. + +- If the data is written successfully, send the message MSG\_SAVE\_DATA\_SUCCESS to the page; +- If the data writing fails, send the message MSG\_SAVE\_DATA\_FAILED to the page. + +Parameter: tableID – number type, data table ID. + +Return: boolean type, true indicating the start of the execution, false indicating unexecution, and whether the execution result is successful is known by capturing the message. + +#### S.2.2.1.10 **removeFromNvm** + +Prototype: boolean removeFromNvm(tableID) + +Description: An Asynchronous method, deleting the user table specified by the tableID parameter in the NVM. + +- If the data is deleted successfully, send the message MSG\_REMOVE\_DATA\_SUCCESS to the page; +- If the data deletion fails, send the message MSG\_REMOVE\_DATA\_FAILED to the page. + +Parameter: tableID – number type, indicating the data table ID. + +Return: boolean type, true indicating the start of the execution, false indicating unexecution, and whether the execution result is successful is known by capturing the message. + +#### S.2.2.1.11 revertFromNvm + +Prototype: boolean revertFromNvm(tableID) + +Description: An Asynchronous method, importing the data table in NVM into RAM, overwrite the current data table in memory. Both system data table and user data table can be operated. + +- If the data coverage is successful, send the message MSG\_REVERT\_DATA\_SUCCESS to the page; +- If the data coverage fails, send the message MSG\_REVERT\_DATA\_FAILED to the page. + +Parameter: tableID – number type, indicating the data table ID. + +Return: boolean type, true indicating the start of the execution, false indicating unexecution, and whether the execution result is successful is known by capturing the message. + +#### S.2.2.1.12 restoreDefault + +Prototype: boolean restoreDefault() + +Description: An Asynchronous method, restoring the system data table in NVM to the factory setting state, and update the system data table in RAM synchronously. + +- If the data is restored successfully, send the message MSG\_RESTORE\_TO\_DEFAULT\_SUCCESS to the page; +- If the data recovery fails, send the message MSG\_RESTORE\_TO\_DEFAULT\_FAILED to the page. + +Parameter: None. + +Return: boolean type, true indicating the start of the execution, false indicating unexecution, and whether the execution result is successful is known by capturing the message. + +### S.3 External storage device management module + +This module defines JS objects related to external storage device management: StorageDeviceManager, StorageDevice, StoragePartition. + +#### S.3.1 Message + +The definition of message that the external storage device management module may send to the application layer is shown in Table S.3. + +**Table S.3 – Definition table of message of external storage device management module** + +| Message name | event.which | event.modifiers | Message format | +|------------------------------|-------------|-----------------|------------------------------------------| +| MSG_DEVICE_UNINSTALL_SUCCESS | 14101 | – | The device is successfully uninstalled. | +| MSG_DEVICE_UNINSTALL_FAILED | 14102 | – | The uninstallation of the device failed. | +| Reserved | 14103~14200 | | | + +NOTE – The value of event.modifiers is automatically given by the system, and its data type: + +- "Number", indicating that the value is the ID of the message description character string, which can be obtained through the Utility.getEventInfo() method. If the "message description" defines the message character string JSON format, the message content will be retrieved according to the format. +- "–", indicating event.modifiers is undefined. + +### S.3.2 StorageDeviceManager object + +The StorageDeviceManager object is a built-in object, which completes the management and setting operations of external storage devices. + +#### S.3.2.1 Method + +##### S.3.2.1.1 uninstallDeviceByID + +Prototype: public boolean uninstallDeviceByID(id) + +Description: An Asynchronous method, uninstalling the device based on the device ID. + +- If the uninstallation is successful, it will return "MSG\_UNINATALL\_DEVICE\_SUCCESS" message; +- If the uninstallation fails, it will return "MSG\_UNINATALL\_DEVICE\_FAILED" message. + +Parameter: id – number type, device ID. + +Return: boolean type, true value indicating the start of the execution, false indicating unexecution, and whether the execution result is successful is known by capturing the message. + +##### S.3.2.1.2 getAllStorageDevices + +Prototype: public StorageDevice[] getAllStorageDevices() + +Description: Obtain all storage device information. + +Parameter: None. + +Return: Array of StorageDevice objects. + +### S.3.3 StorageDevice object + +The StorageDevice object is a local object, which describes storage device information, including name, size, free space, etc. + +Example: + +``` +//Create StorageDevice object through the StorageDeviceManager method. +var storageDeviceArray = StorageDeviceManager.getAllStorageDevices(); +var storageDevice = storageDeviceArray[0]; +``` + +#### S.3.3.1 Property + +The definition of the property of the StorageDevice object is shown in Table S.4. + +**Table S.4 – Table of StorageDevice property** + +| Property name | Type | Read and write property | Description | +|---------------|--------|-------------------------|--------------------------------------------------| +| Id | number | Read only | Get the unique identifier of the storage device. | +| Name | string | Read only | Get the name of the storage device. | + +**Table S.4 – Table of StorageDevice property** + +| Property name | Type | Read and write property | Description | +|---------------|--------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| status | number | Read only | Get the status information of the storage device, the value is:
- – 0-indicating that the storage device has been uninstalled;
- – 1-indicating that the storage device has been found and the type has been determined;
- – 2-indicating that the storage device is ready;
- – 3-indicating that the storage device is not available.
1) Local storage directory path similar to /storage/storage0/xx;
2) The USB external storage directory path obtained through the related objects of the device management interface. | + +### S.4.3.2 Method + +#### S.4.3.2.1 Directory + +Prototype: `Directory(path)` + +Description: Construction method, which creates a new `Directory` object instance based on the specified path name. + +Parameter: `path` – string type, indicating the character string of the directory path. + +#### S.4.3.2.2 getFileList + +Prototype: `FileObj[] getFileList()` + +Description: Getting the files contained in the current directory. + +Parameter: None. + +Return: File object array, if the directory does not contain any files, the length of the returned array is 0. + +#### S.4.3.2.3 getDirList + +Prototype: `Directory[] getDirList()` + +Description: Getting the subdirectories contained in the current directory. + +Parameter: None. + +Return: Directory object array, if the directory does not contain any subdirectories, the length of the returned array is 0. + +### S.4.4 FileObj object + +`FileObj` is a local object, used to manage files. This object is equivalent to a mirror image of the local storage area file, USB external storage file or front-end file in the memory. Unless the `saveAs(path)` method is called to save the file, the actual file will not be changed. + +#### S.4.4.1 Property + +The definition of the property of the `FileObj` object is shown in Table S.8. + +**Table S.8 – Table of the property of the FileObj object** + +| Property name | Type | Read and write property | Description | +|---------------|--------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| size | number | Read only | Get the size of the file, in bytes. | +| name | String | Read only | Get the name of the file (including extension). | +| path | String | Read only | Get the absolute path (including the file name) where the file is located in the following four ways:
1) Local storage file path similar to
/storage/storage0/xx/xx.txt ;2) The USB external storage file path obtained through the related objects of the device management interface;
3) oc address path of
dvb://onid.tsid.serviceid.component_tag/xx/xx.txt ;4) http address path similar to
http://x.x.x.x/xx/xx.txt . |
+
+#### **S.4.4.2 Method**
+
+##### **S.4.4.2.1 FileObj**
+
+Prototype: FileObj(locator)
+
+Description: Construction method, which creates a file object according to the specified file path name.
+
+Parameter: locator – string type, indicating the locator of the file. See the path property description of the table of the property of the FileObj object for the format.
+
+##### **S.4.4.2.2 open**
+
+Prototype: open(mode)
+
+Description: Open the file for various editing operations.
+
+Parameter: mode – number type, 1 indicating open in text mode; 0 indicating open in binary mode.
+
+Return: number type, 1 indicating opening is successful; 0 indicating opening failed.
+
+##### **S.4.4.2.3 close**
+
+Prototype: close()
+
+Description: Close the file for the save operation.
+
+Parameter: None.
+
+Return: number type, 1 indicating closing is successful; 0 indicating closing failed.
+
+##### **S.4.4.2.4 readFile**
+
+Prototype: readFile(len)
+
+Description: Read len bytes of data from the file and return it as a character string.
+
+Parameter: len – number type, indicating reading the content of len byte length.
+
+Return: string type, returning the read content as a character string.
+
+##### **S.4.4.2.5 readAllFile**
+
+Prototype: readAllFile()
+
+Description: Read all the contents of the file and return it as a character string.
+
+Parameter: None.
+
+Return: string type, returning the read content as a character string.
+
+#### **S.5 Multimedia file module**
+
+This module defines JS objects related to multimedia files: AudioFile, VideoFile and ImageFile.
+
+##### **S.5.1 AudioFile object**
+
+The AudioFile object is a local object. This object describes the detailed information of an audio file.
+
+Example:
+
+```
+//Create an AudioFile object.
+```
+
+```
+var audioFile = new AudioFile(path);
+```
+
+##### **S.5.1.1 Property**
+
+The definition of the property of the AudioFile object is shown in Table S.9.
+
+**Table S.9 – Table of the property of the AudioFile**
+
+| Property name | Type | Read and write name | Description |
+|------------------|--------|---------------------|-------------------------------------------------------|
+| Type | string | Read only | Get the audio file type, refer to MIME. |
+| location | string | Read only | Get the locator (resource locator) of the audio file. |
+| fileName | string | Read only | Get the audio file name. |
+| fileSize | number | Read only | Get the size of the audio file, in bytes. |
+| sampleRate | number | Read only | Sampling rate, such as 32000, 44100, 48000, in Hz. |
+| numberOfChannels | number | Read only | The number of channels. |
+| duration | number | Read only | The playback time of the audio file, in seconds. |
+| Date | Date | Read only | The release date of the audio. |
+| Title | string | Read only | The title of the audio. |
+| Artist | string | Read only | Artist/performer. |
+| album | string | Read only | The album name. |
+
+**S.5.1.2 Method****S.5.1.2.1 AudioFile**
+
+Prototype: AudioFile(path)
+
+Description: Construction method, create a new audio file object according to the specified path.
+
+Parameter: path – string type, indicating the audio file path.
+
+**S.5.2 VideoFile object**
+
+The VideoFile object is a local object. This object describes the detailed information of a video file.
+
+Example:
+
+```
+//Create a VideoFile object.
+```
+
+```
+var videoFile = new VideoFile(path);
+```
+
+**S.5.2.1 Property**
+
+The definition of the property of the VideoFile object is shown in Table S.10.
+
+**Table S.10 – Table of the property of the VideoFile**
+
+| Property name | Type | Read and write property | Description |
+|---------------|--------|-------------------------|---------------------------------------------------------|
+| typeContainer | string | Read only | Encapsulation format, such as "AVI", "MP4", "MKV", etc. |
+| typeVideo | string | Read only | Video type, refer to MIME. |
+| typeAudio | string | Read only | Audio type of the accompanying sound, refer to MIME. |
+| location | string | Read only | The locator (resource locator) of the video file. |
+| fileName | string | Read only | The name of the video file. |
+| fileSize | number | Read only | The size of the video file, in bytes. |
+| bitRate | number | Read only | Play rate, in kilobits per second (kb/s) |
+| duration | number | Read only | The playback time of the file, in seconds. |
+
+**Table S.10 – Table of the property of the VideoFile**
+
+| Property name | Type | Read and write property | Description |
+|------------------|--------|-------------------------|------------------------------------------------------------------------------------|
+| width | number | Read only | The width of the video, in pixels. |
+| height | number | Read only | The height of the video, in pixels. |
+| aspectRatio | string | Read only | Video aspect ratio, such as "16:9". |
+| fps | number | Read only | Video frame rate. |
+| sampleRate | number | Read only | Audio sampling rate of the accompanying sound, such as 32000, 44100, 48000, in Hz. |
+| numberOfChannels | number | Read only | The number of channels. |
+
+**S.5.2.2 Method****S.5.2.2.1 VideoFile**
+
+Prototype: VideoFile(path)
+
+Description: Construction method, create a new video file object according to the specified path.
+
+Parameter: path – string type, indicating the path of the video file.
+
+**S.5.3 ImageFile object**
+
+The ImageFile object is a local object. This object describes the detailed information of a picture file.
+
+Example:
+
+```
+//Create an ImageFile object.
+```
+
+```
+var imageFile = new ImageFile(path);
+```
+
+**S.5.3.1 Property**
+
+The property of the ImageFile object is shown in Table S.11.
+
+**Table S.11 – Table of the property of the ImageFile**
+
+| Property name | Type | Property | Description |
+|---------------|--------|-----------|---------------------------------------------------|
+| type | string | Read only | For the type of image file, refer to MIME. |
+| location | string | Read only | The locator (resource locator) of the image file. |
+| fileName | string | Read only | The name of the image file. |
+| width | number | Read only | The width of the picture file, in pixels. |
+| height | number | Read only | The height of the picture file, in pixels. |
+
+**S.5.3.2 Method****S.5.3.2.1 ImageFile**
+
+Prototype: ImageFile(path)
+
+Description: Construction method, create a new image file object according to the specified path.
+
+Parameter: path – string type, image file path.
+
+**S.6 OTA software upgrade module**
+
+This module defines the JS object related to OTA software upgrade: Upgrade.
+
+### S.6.1 Message
+
+The definition of the message that the OTA software upgrade module may send to the application layer is shown in Table S.12.
+
+**Table S.12 – Message definition table of OTA software upgrade module**
+
+| Message name | event.which | event.modifiers | Message description |
+|------------------|-------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------|
+| MSG_FORCE_OTA | 22101 | – | It indicates the OTA upgrade is mandatory, the system automatically downloads the set-top box software image and upgrades the set-top boxNote. |
+| MSG_OPTIONAL_OTA | 22102 | – | It indicates that the OTA upgrade is not mandatory, and the user can choose whether to upgrade this time. |
+| Reserved | 22103~22200 | | |
+
+### S.6.2 Upgrade object
+
+The Upgrade object is a built-in object that provides JS methods for OTA or local upgrade operations.
+
+#### S.6.2.1 Method
+
+##### S.6.2.1.1 checkOTA
+
+Prototype: boolean checkOTA()
+
+Description: Determine whether the front end deploys a new OTA upgrade. This method is mainly used to manually detect OTA upgrade information.
+
+Parameter: None.
+
+Return: boolean type, true indicating there is OTA upgrade, false indicating there is no OTA upgrade.
+
+##### S.6.2.1.2 startOTA
+
+Prototype: startOTA()
+
+Description: Start the OTA upgrade.
+
+Parameter: None.
+
+Return: None.
+
+##### S.6.2.1.3 getOTAName
+
+Prototype: string getOTAName()
+
+Description: Getting the name of the OTA upgrade event, which is different from the name of the OTA provider and refers to the text description of the OTA upgrade event.
+
+Parameter: None.
+
+Return: string type, indicating the name of the OTA upgrade event.
+
+### S.7 System tool module
+
+This module defines tool JS objects: Utility, GlobalVarManager, Rectangle and SysTool.
+
+## S.7.1 Utility object
+
+The Utility object is a built-in object, which can complete the acquisition of event messages and the printing of character strings.
+
+### S.7.1.1 Method
+
+#### S.7.1.1.1 getEventInfo
+
+Prototype: string getEventInfo(id)
+
+Description: Getting a detailed description of the message.
+
+Parameter: id – number type, indicating the message description character string ID.
+
+Return: string type, indicating the detailed description information of the message.
+
+#### S.7.1.1.2 println
+
+Prototype: println(str)
+
+Description: Print the character string, the parameter supports the addition operation of the character string, and the printing will automatically wrap. This method outputs the print information to the serial port, which is convenient for developers to check debugging information.
+
+Parameter: str – string type, indicating the character string to be printed.
+
+Return: None.
+
+## S.7.2 GlobalVarManager object
+
+This object is a built-in object, used for global variable management.
+
+### S.7.2.1 Method
+
+#### S.7.2.1.1 setItemValue
+
+Prototype: setItemValue(key, value)
+
+Description: Setting global variable parameters.
+
+Parameter: key – string type, indicating the global variable keyword, which is set by the application; value – number type, indicating the global variable value.
+
+Return: None.
+
+#### S.7.2.1.2 getItemValue
+
+Prototype: number getItemValue(key)
+
+Description: Getting global variable parameters.
+
+Parameter: key – string type, indicating the global variable keyword, which should correspond to the key in the GlobalVarManager.setItemValue() method.
+
+Return: number type, returning the value of the global variable specified by the keyword key; if the global variable specified by the keyword key does not exist, it returns null.
+
+#### S.7.2.1.3 setItemStr
+
+Prototype: setItemStr(key, str)
+
+Description: Setting global variable parameters.
+
+Parameter: key – string type, indicating the global variable keyword, which is set by the application; str – string type, indicating the global variable value.
+
+Return: None.
+
+#### S.7.2.1.4 getItemStr
+
+Prototype: string getItemStr(key)
+
+Description: Getting global variable parameters.
+
+Parameter: key – string type, indicating the global variable keyword, which should correspond to the key in the GlobalVarManager.setItemStr() method.
+
+Return: string type, returning the global variable value specified by the keyword key; if the global variable specified by the keyword key does not exist, it returns null.
+
+#### S.7.2.1.5 removeItem
+
+Prototype: removeItem(key)
+
+Description: Delete a global variable parameter.
+
+Parameter: key – string type, global variable keyword; if the global variable specified by the keyword key does not exist, no operation is performed.
+
+Return: None.
+
+#### S.7.2.1.6 clearAll
+
+Prototype: clearAll()
+
+Description: Delete all global variable parameters.
+
+Parameter: None.
+
+Return: None.
+
+### S.7.3 Rectangle object
+
+The Rectangle object is a local object.
+
+#### S.7.3.1 Property
+
+The property definition of the Rectangle object is shown in Table S.13.
+
+**Table S.13 – Table of the property of Rectangle object**
+
+| Property name | Type | Read and write property | Description |
+|---------------|--------|-------------------------|------------------------------------------------------------------------------------|
+| left | number | Read/write | The X-axis coordinate of the upper left corner of the Rectangle object, in pixels. |
+| top | number | Read/write | The Y-axis coordinate of the upper left corner of the Rectangle object, in pixels. |
+| width | number | Read/write | The width of the Rectangle object, in pixels. |
+| height | number | Read/write | The height of the Rectangle object, in pixels. |
+
+#### S.7.3.2 Method
+
+##### S.7.3.2.1 Rectangle
+
+Prototype: Rectangle(left, top, width, height)
+
+Description: Construction method, which creates a new rectangular object according to the specified coordinates and width and height.
+
+Parameter: left – number type, the X-axis coordinate of the upper left corner of the rectangle, in pixel;
+
+right – number type, the Y-axis coordinate of the upper left corner of the rectangle, in pixel;
+
+width – number type, the width of the rectangle, in pixel;
+
+height – number type, the height of the rectangle, in pixel.
+
+#### S.7.4 SysTool object
+
+This object is a built-in object and provides methods for system standby, sleep, and restart operations. The system should verify the permissions of the application, and only privileged applications can call the methods provided by this class. Standby – The CPU of the receiving terminal is still working, used to run some background programs, such as push downloads, software upgrades, etc., for the turning off all audio and video output, from the appearance, the receiving terminal has stopped working. Sleep – The CPU of the receiving terminal stops working, and the power supply of the CPU and the motherboard is completely cut off. Then, depending on the external single-chip or other means to monitor the activation command issued by the remote control, start the switching power supply to supply power to the CPU and the main board to realize the remote start-up. This method consumes less energy. The relevant methods of this object should be implemented according to the actual capabilities of the receiver. For example, if sleep is not supported, the implementation of the sleep() method is empty or the same as the standBy() method.
+
+##### S.7.4.1 Method
+
+###### S.7.4.1.1 standBy
+
+Prototype: standBy()
+
+Description: Control the receiver to enter the standby state. The CPU is still running.
+
+Parameter: None.
+
+Return: None.
+
+###### S.7.4.1.2 sleep
+
+Prototype: sleep()
+
+Description: Control the receiver to enter the sleep state, and the CPU will power off and stop working.
+
+Parameter: None.
+
+Return: None.
+
+###### S.7.4.1.3 reboot
+
+Prototype: reboot()
+
+Description: Restart the receiver.
+
+Parameter: None.
+
+Return: None.
+
+###### S.7.4.1.4 wakeUp
+
+Prototype: wakeUp()
+
+Description: Wake up the receiver.
+
+Parameter: None.
+
+Return: None.
+
+###### S.7.4.1.5 getStandByState
+
+Prototype: number getStandByState()
+
+Description: Getting the standby state.
+
+Parameter: None.
+
+Return: number 1-true standby/sleep; 2-false standby/standBy; 3-normal work.
+
+## S.8 Software and hardware information query module
+
+This module defines JS objects related to receiving terminal software and hardware information query: HardwareInfo, SoftwareInfo.
+
+### S.8.1 HardwareInfo object
+
+HardwareInfo is a built-in object, which is used to describe the hardware parameter information of the receiving terminal.
+
+#### S.8.1.1 Property
+
+The property definition of the HardwareInfo object is shown in Table S.14.
+
+**Table S.14 – Table of the property of HardwareInfo object**
+
+| Property name | Type | Read and write property | Description |
+|------------------|--------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Flash.size | string | Read only | Get the size of the receiving terminal's flash memory, in MB. |
+| RAM.size | string | Read only | Get the size of the receiving terminal's memory, in MB. |
+| RAM.type | string | Read only | Get the memory type of the receiving terminal, which can take the values "SDRAM", "DDR", "DDR2", etc. |
+| SOC.model | string | Read only | Get the model of the main chip of the receiving terminal. |
+| SOC.frequency | string | Read only | Get the operating frequency of the main chip of the receiving terminal, in MHz. |
+| SOC.provider | string | Read only | Get the name of the provider of the main chip of the receiving terminal. |
+| HW.version | string | Read only | Get the hardware version number of the receiving terminal. |
+| STB.TPtype | string | Read only | Get the transmission mode type of the receiving terminal, the value can be a combination of "DVB-C", "DVB-S", "DVB-T", "ABS-SS", and "DTMB". |
+| STB.definition | string | Read only | Get the definition type of the receiving terminal, which can take the values "HD" and "SD". |
+| STB.provider | string | Read only | Get the name of the provider of the receiving terminal. |
+| STB.brand | string | Read only | Get the brand name of the receiving terminal. |
+| STB.model | string | Read only | Get the model of the receiving terminal. |
+| STB.serialnumber | string | Read only | Get the serial number of the receiving terminal. |
+| STB.returnPath | string | Read only | Get the property of the return channel of the receiving terminal. The value "modulator" indicates cableModem; the value "ethernet" indicates Ethernet. |
+
+### S.8.2 SoftwareInfo object
+
+SoftwareInfo is a built-in object, which is used to describe the parameter information of the receiving terminal software.
+
+### S.8.2.1 Property
+
+The property definition of the SoftwareInfo object is shown in Table S.15.
+
+**Table S.15 – Table of the property of SoftwareInfo**
+
+| Property name | Type | Read and write property | Description |
+|-----------------------------|-------------|--------------------------------|----------------------------------------------------------------|
+| OS.name | string | Read only | Get the name of the operating system software. |
+| OS.version | string | Read only | Get the version number of the operating system software. |
+| OS.provider | string | Read only | Get the name of the provider of the operating system software. |
+| middleware.name | string | Read only | Get the name of the system software. |
+| middleware.version | string | Read only | Get the version number of the system software. |
+| middleware.provider | string | Read only | Get the name of the provider of the system software. |
+| middleware.releaseDate | string | Read only | Get the release date of the system software. |
+| middleware.copyright | string | Read only | Get the copyright information of the system software. |
+| middleware.RAMSize | string | Read only | Get the memory space occupied by the system software, in KB. |
+| middleware.NVMSize | string | Read only | Get the NVM space occupied by the system software, in KB. |
+| middleware.platform_profile | string | Read only | Get the platform grade supported by the system software. |
+| loader.name | string | Read only | Get the name of the software update module (loader). |
+| loader.version | string | Read only | Get the version number of the software update module (loader). |
+| loader.provider | string | Read only | Get the provider of the software update module (loader). |
+| loader.size | string | Read only | Get the size of the software update module (loader), in KB. |
+| CA.name | string | Read only | Get the name of the CA software. |
+| CA.version | string | Read only | Get the version number of the CA software. |
+| CA.provider | string | Read only | Get the provider of the CA software. |
+| Driver.vision | string | Read only | Version number of the receiving terminal driver. |
+
+## Annex T
+
+### JavaScript-Message management unit
+
+(This annex forms an integral part of this Recommendation.)
+
+#### T.1 Overview
+
+This annex defines functional modules related to message management.
+
+#### T.2 Message management module
+
+This module defines JS object related to message processing: event.
+
+The messages captured by the application layer have the following two sources:
+
+- System messages, such as successful frequency lock, channel scan completed, network signal interruption, etc.;
+- Key messages, such as remote control, keyboard, mouse, front panel and other key trigger messages;
+
+The application layer captures messages in the following ways:
+
+- System message: The application captures system messages through `document.onsystemevent`;
+- Key message:
+ - Keyboard: The application captures keyboard messages through `document.onkeydown`, `document.onkeyup` and `document.onkeypress`, and the message code is consistent with the PC mode;
+ - Mouse: The application captures mouse messages through `document.onmousedown`, `document.onmouseup`, `document.onmousemove`, etc., and the message code is consistent with the PC mode;
+ - Remote control: The application captures remote control messages through `document.onkeydown` and `document.onkeyup`, and the message code is compatible with the PC mode. The definition of the extended key message code is shown in Table T.1;
+ - Front panel: The application captures front panel messages through `document.onkeydown` and `document.onkeyup`, and the message code is consistent with the remote control mode.
+
+##### T.2.1 event object
+
+The event object is a built-in object.
+
+###### T.2.1.1 Property
+
+The property of the event object is shown in Table T.1.
+
+**Table T.1 – Property of event object**
+
+| Property name | Type | Read and write property | Description |
+|-------------------------|--------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| event.type | number | Read only | It indicates the type of event that occurred, that is, the name of the event represented by the current event object, which has the same name as the registered event handle, such as |
+
+**Table T.1 – Property of event object**
+
+| Property name | Type | Read and write property | Description |
+|-----------------|--------|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| | | | "onclick"; or the prefix "on" is deleted for the property of the event handle, such as "click". Same as W3C definition. |
+| event.source | number | Read only | It indicates the source of the message. |
+| event.which | number | Read only | It indicates the code value of the message. |
+| event.modifiers | number | Read only | It indicates the extended property of the message. If the extended property of the message is empty, modifiers returns 0; if the extended property of the message is number type, then modifiers returns the value; if the extended property of the message is a character string, then modifiers returns an ID value, which is generated internally by the system, as a pointer to the specific character string content, the application can call the Utility.getEventInfo(ID) method to retrieve the character string content. |
+
+**T.2.1.2 Message source**
+
+The definition of the message source (event.source) is shown in Table T.2.
+
+**Table T.2 – event.source definition**
+
+| event.source | Description |
+|--------------|----------------------------------------------|
+| 1001 | It indicates system messages. |
+| 1002 | It indicates the remote control key message. |
+| 1003 | It indicates the front panel key message. |
+
+**T.2.1.3 System message**
+
+For system messages, see the definitions of messages in Annexes L, M, N, Q, S, U, V and other annexes.
+
+**T.2.1.4 Key message**
+
+Refer to clause D.2.1.5 for the key message definition.
+
+## Annex U
+
+### JavaScript-Application engine unit
+
+(This annex forms an integral part of this Recommendation.)
+
+#### U.1 Overview
+
+This annex defines some commonly used application engine modules: channel management, electronic program guide, scheduled reminder management, information search, etc.
+
+#### U.2 Channel management module
+
+This module defines JS objects related to channel management: ChannelManager, Channel.
+
+##### U.2.1 Message
+
+The definitions of messages that the channel management module may send to the application layer are shown in Table U.1.
+
+**Table U.1 – Channel management module mMessage**
+
+| Message name | event.which | event.modifiers | Message description |
+|--------------------------------|-------------|-----------------|-------------------------------------------------------------------------|
+| MSG_CHANNEL_RAM_TO_NVM_SUCCESS | 19001 | – | It indicates that writing channel data from RAM to NVM is successful. |
+| MSG_CHANNEL_RAM_TO_NVM_FAILED | 19002 | – | It indicates that writing channel data from RAM to NVM failed. |
+| MSG_CHANNEL_NVM_TO_RAM_SUCCESS | 19003 | – | It indicates that restoring channel data from NVM to RAM is successful. |
+| MSG_CHANNEL_NVM_TO_RAM_FAILED | 19004 | – | It indicates that restoring channel data from NVM to RAM failed. |
+| Reserved | 19005~19500 | | |
+
+NOTE – The value of event.modifiers is automatically given by the system, and its data type:
+
+- "Number", indicating that the value is the ID of the message description character string, which can be obtained through the Utility.getEventInfo() method. If the "message description" defines the message character string JSON format, the message content will be retrieved according to the format.
+- "–", indicating event.modifiers is undefined.
+
+##### U.2.2 ChannelManager object
+
+This object is a built-in object that describes how users manage channels.
+
+###### U.2.2.1 Method
+
+###### U.2.2.1.1 getChannelByChannelID
+
+Prototype: Channel getChannelByChannelID(channelId)
+
+Description: Getting the channel object based on the channel ID.
+
+Parameter: channelId – number type, indicating the channel ID, it must be a decimal integer greater than 0.
+
+Return: Channel object.
+
+#### **U.2.2.1.2 getChannelByLogicalID**
+
+Prototype: Channel getChannelByLogicalID(logicalId)
+
+Description: Getting the channel object according to the logical channel number.
+
+Parameter: logicalId – number type, indicating the logical channel number, it must be a decimal integer greater than 0.
+
+Return: Channel object.
+
+#### **U.2.2.1.3 getChannelByServiceID**
+
+Prototype: Channel getChannelByServiceID(serviceId)
+
+Description: Getting the channel object based on the service ID.
+
+Parameter: serviceId – number type, indicating the service ID corresponding to the channel, and the value range being 0-65535.
+
+Return: Channel object.
+
+#### **U.2.2.1.4 getLastChannel**
+
+Prototype: Channel getLastChannel()
+
+Description: Getting the previously opened channel.
+
+Parameter: None.
+
+Return: Channel object.
+
+#### **U.2.2.1.5 getLastChannel**
+
+Prototype: Channel getLastChannel(serviceType)
+
+Description: Getting the previously opened channel of the specified type.
+
+Parameter: serviceType – number type, indicating the type of the service.
+
+Return: Channel object.
+
+#### **U.2.2.1.6 getShutDownChannel**
+
+Prototype: Channel getShutDownChannel()
+
+Description: Getting shutdown channel.
+
+Parameter: None.
+
+Return: Channel object.
+
+NOTE – After the user turns on a certain channel, or switches channels, the system will immediately set the just now opened channel as the shutdown channel. In any case, the shutdown channel can be obtained. If the system has set the shutdown channel, it will get the set value; otherwise, the system decides the shutdown channel by itself.
+
+#### **U.2.2.1.7 getShutDownChannel**
+
+Prototype: Channel getShutDownChannel(serviceType)
+
+Description: Getting the shutdown channel of the specified type.
+
+Parameter: serviceType – number type, indicating the service type.
+
+Return: Channel object.
+
+NOTE – After the user turns on a certain channel, or switches channels, the system will immediately set the just now opened channel as the shutdown channel. In any case, the shutdown channel can be obtained. If the system has set the shutdown channel, the value obtained is the set value; otherwise, in the service type specified by serviceType, the system determines the shutdown channel by itself.
+
+#### **U.2.2.1.8 delChannel**
+
+Prototype: number delChannel(obj)
+
+Description: Delete the specified channel from the channel list.
+
+NOTE – Operate on the channel list in RAM.
+
+Parameter: obj – Channel object.
+
+Return: number type, 1 indicating the deletion is successful, 0 indicating the deletion failed.
+
+#### **U.2.2.1.9 deleteAll**
+
+Prototype: number deleteAll()
+
+Description: Delete all channels in the channel list.
+
+NOTE – Operate on the channel list in RAM.
+
+Parameter: None.
+
+Return: number type, 1 indicating success, 0 indicating failure.
+
+#### **U.2.2.1.10 deleteAllDelMarked**
+
+Prototype: number deleteAllDelMarked()
+
+Description: Delete all channel objects marked for deletion in the channel list.
+
+NOTE – Operate on the channel list in RAM.
+
+Return: number type, 1 indicating success, 0 indicating failure.
+
+#### **U.2.2.1.11 deleteAllFavorites**
+
+Prototype: number deleteAllFavorites()
+
+Description: Delete all favorite channels.
+
+NOTE – Operate on the channel list in RAM.
+
+Parameter: None.
+
+Return: number type, 1 indicating success, 0 indicating failure.
+
+#### **U.2.2.1.12 resetProperties**
+
+Prototype: resetProperties()
+
+Description: Reset all the channels that the user has set as favorite, locked, hidden, etc., and all channels are changed to non-favorite, non-locked, and non-hidden.
+
+NOTE – Operate on the channel list in RAM.
+
+Parameter: None.
+
+Return: number type, 1 indicating success, 0 indicating failure.
+
+#### **U.2.2.1.13 swap**
+
+Prototype: swap(obj1,obj2)
+
+Description: Exchange the positions of the channel object obj1 and the channel object obj2 in the channel list.
+
+NOTE – Operate on the channel list in RAM.
+
+Parameter: obj1 – indicating the Channel object;
+
+obj2 – indicating the Channel object.
+
+Return: None.
+
+#### U.2.2.1.14 sort
+
+Prototype: sort(sortTypeArray[], sortOrderArray[])
+
+Description: Sort the channels according to the specified method.
+
+NOTE – Operate on the channel list in RAM.
+
+Parameter: sortTypeArray – number type array, indicating the sorting basis. There can be one or more sorting basis, but they cannot be repeated. The priority of the sorting basis is related to the order of the array members. The smaller the subscript of the array member, the higher the priority.
+
+sortOrderArray – number type array, indicating the sorting mode.
+
+Return: None.
+
+NOTE – The hidden and locked channels must also be sorted. If two or more channels are sorted on the same basis, the previous sorting order between these channels will be maintained.
+
+Example:
+
+```
+//Sort the channels in ascending order by service_id, and the channels with the same
+//service_id are sorted in the order before this time,
+sort([DVB_SORT_TYPE_SERVICE_ID], [DVB_SORT_ORDER_ASC]);
+//Sort the channels according to whether they are encrypted first, non-encrypted channels
+//are first, and encrypted channels are second; channels that are both non-encrypted or
+//encrypted are then sorted in ascending order by service_name, and channels with the
+//same service_name are sorted in the order before this sorting
+sort([DVB_SORT_TYPE_FTA_SCR, DVB_SORT_TYPE_SERVICE_NAME],
+[DVB_SORT_ORDER_ASC,DVB_SORT_ORDER_DESC]);
+```
+
+#### U.2.2.1.15 filter
+
+Prototype: Channel[] filter(filterTypeArray[], valueArray[])
+
+Description: Filter out the new channel list with specified conditions in the current channel list.
+
+Parameter: filterTypeArray – number type array, indicating the filtering basis. The value of each member of the array is shown in Table U.2. There can be one or more sorting basis, the members cannot be repeated, and the filtering basis has no priority.
+
+**Table U.2 – Filter filtering-conditions**
+
+| filterTypeArray value | Description | Value corresponding to valueArray |
+|---------------------------------------|------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|
+| const FILTER_TYPE_SERVICETYPE = 1000; | Filter out the channels of the specified service type. | See the definition of "Service Type Constant" for the value. |
+| const FILTER_TYPE_FAV = 1001; | Filter out the channels with the specified favorite level. | Value:– 0-indicating filtering non-favorite channels;
– 1-indicating filtering favorite channels. | + +**Table U.2 – Filter filtering-conditions** + +| filterTypeArray value | Description | Value corresponding to valueArray | +|--------------------------------|------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| const FILTER_TYPE_BAT = 1002; | Filter out the channels under the specified service group. | It indicates bouquet_id. | +| const FILTER_TYPE_FTA = 1003; | Filter out encrypted or non-encrypted channels. | Value:
– 0-indicating filtering out non-encrypted channels;
– 1-indicating filtering out encrypted channels. | +| const FILTER_TYPE_HIDE = 1004; | Filter out hidden or non-hidden channels. | Value:
– 0-indicating only filtering out non-hidden channels;
– 1-indicating only filtering out hidden channels. | + +valueArray – number type array, which has the same length as filterTypeArray. The members of the array should correspond to the members of the filterTypeArray one-to-one, respectively indicating the value of each filterTypeArray member. + +Return: Channel object array. + +Example: + +``` +//It indicates filtering out the favorite channels among all TV broadcast channels +filter([FILTER_TYPE_SERVICETYPE, FILTER_TYPE_FAV], + [DVB_SERVICE_TYPE_DTV, 1]); + +//It indicates filtering out all encrypted channels in the service group with bouquet_id=10 +filter([FILTER_TYPE_BAT, FILTER_TYPE_FTA],[10,1]); +``` + +**U.2.2.1.16 save** + +Prototype: save() + +Description: An Asynchronous method, saving the channel list data in RAM to NVM. + +- If the save is successful, send the message MSG\_CHANNEL\_RAM\_TO\_NVM\_SUCCESS; +- If the save fails, send the message MSG\_CHANNEL\_RAM\_TO\_NVM\_FAILED. + +Parameter: None. + +Return: None. + +**U.2.2.1.17 restore** + +Prototype: restore() + +Description: An Asynchronous method, restoring the channel list data in NVM to RAM. + +- If the restoration is successful, send the message MSG\_CHANNEL\_NVM\_TO\_RAM\_SUCCESS; +- If the restoration fails, send the message MSG\_CHANNEL\_NVM\_TO\_RAM\_FAILED. + +Parameter: None. + +Return: None. + +### U.2.3 Channel object + +The Channel object is a local object, used to describe the properties and methods related to the behavior of users and operators. + +#### U.2.3.1 Property + +The properties of the Channel object are defined in Table U.3. + +**Table U.3 – Table of Channel object properties** + +| Property name | Type | Property | Description | +|---------------|--------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| channelId | number | Read/write | It indicates the channel number assigned by the receiving terminal.
NOTE – The channel number assigned by the receiving terminal refers to the number assigned to the channel by the terminal system software, and the assignment strategy is determined by the terminal software. After the channelId is generated, it remains unchanged during the life cycle of the Channel object, and channel ordering and switching operations may modify the value of channelId. | +| logicalId | number | Read only | It indicates the logical channel number of the channel.
If the channel does not have a logical channel number, this property returns the value -1. The acquisition of the logical channel number is related to the operator and is implemented by the receiving terminal itself. | +| isDeleted | number | Read/write | It indicates the delete flag of the channel. The value is:
– 0-indicating no delete flag is set;
– 1-indicating that the delete flag is set. | +| isFavorite | number | Read/write | It indicates the favorite level of the channel in the favorite class, value:
– 0-indicating dislike;
– 1-indicating like. | +| isLocked | number | Read/write | It indicates the locked state of the channel, value:
– 0-indicating the channel is not locked;
– 1-indicating the channel is locked.
When a channel is locked, the user needs to enter the password before watching the program of the channel. | + +**Table U.3 – Table of Channel object properties** + +| Property name | Type | Property | Description | +|-----------------|---------|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| isHided | number | Read/write | It indicates the hidden state of the channel, value:
– 0 indicating not hidden;
– 1 indicating hidden.
Once a channel is "hidden", it will not appear in the channel list, nor can it be watched by the up/down button on the remote control. It can only be watched after entering the "System Settings" to cancel its hidden state. | +| deltVolume | number | Read/write | It indicates the value-added ( $\pm$ ) relative to the global volume, namely:
Channel actual audio = global volume + deltVolume
NOTE – The modification takes effect immediately. | +| supportPlayback | boolean | Read only | It indicates whether the channel supports time-shifted lookback service, value:
– true-indicating support;
– false-indicating not supported. | + +### U.2.3.2 Method + +#### U.2.3.2.1 getService + +Prototype: DvbService getService() + +Description: Getting DvbService object corresponding to the current channel object. + +Parameter: None. + +Return: DvbService object. + +## U.3 Electronic Program Guide Module + +This module defines JS objects related to the electronic program guide: EPGManager, ProgramEvent, ReferenceEvent and TimeShiftEvent. + +### U.3.1 Message + +The message definition that the electronic program guide module may send to the application layer is shown in Table U.4. + +**Table U.4 – Electronic Program Guide module message** + +| Message name | event.which | event.modifiers | Message description | +|---------------------------------|-------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MSG_EPG_SEARCH_SUCCESS | 18001 | number | EPG search is completed successfully. | +| MSG_EPG_SEARCH_EXCEED_MAX_COUNT | 18002 | number | When the search result reaches the maximum value, the search automatically stops.
The maximum number of ProgramEvent is specified by EPGSetting.program_event_max | + +**Table U.4 – Electronic Program Guide module message** + +| Message name | event.which | event.modifiers | Message description | +|-------------------------------------------|-------------|-----------------|---------------------------------------------------------------------------------------------------------------------------------------| +| | | | count in the data management module. | +| MSG_EPG_SEARCH_REFRESH | 18003 | number | EPG data update.
When EPG has searched part of the data, the message is sent. | +| MSG_EPG_SEARCH_TIMEOUT | 18004 | number | Search EPG timed out. When no program information is searched within the time period specified by the interface, the message is sent. | +| MSG_EPG_RECEIVE_NVODREFERENCE_SUCCESS | 18005 | number | Successfully received NVOD reference event. | +| MSG_EPG_RECEIVE_ALL_NVODREFERENCE_SUCCESS | 18006 | number | The data of all NVOD frequency points has been received. | +| MSG_EPG_RECEIVE_NVODREFERENCE_TIMEOUT | 18007 | number | NVOD reference event search timed out. | +| MSG_EPG_RECEIVE_NVODTIMESHIFT_SUCCESS | 18008 | number | Successfully received a time-shift event under a reference event. | +| MSG_EPG_RECEIVE_NVODTIMESHIFT_TIMEOUT | 18009 | number | NVOD time-shift event receiving timed out. | +| Reserved | 18010~18500 | | | + +NOTE – The value of event.modifiers is automatically given by the system, and its data type: + +- "Number", indicating the maskId of the search session. +- "-", indicating event.modifiers is undefined. + +### U.3.2 EPGManager object + +The EPGManager object is a built-in object. This object provides a method to obtain an array of events under a specified class. + +#### U.3.2.1 Constant + +The definition of program type constants is shown in Table U.5. + +**Table U.5 – Program type constants** + +| Constants | Description | +|------------------------------------------|---------------------------| +| Movie/drama | | +| const CONTENT_TYPE_MOVIE=0x10; | Movie/Drama (general) | +| const CONTENT_TYPE_MOVIE_DETECTIVE=0x11; | Detective/Thrill | +| const CONTENT_TYPE_MOVIE_ADVENTURE=0x12; | Expedition/Western/War | +| const CONTENT_TYPE_MOVIE_FANTASY=0x13; | Sci-Fi/Magic/Horror | +| const CONTENT_TYPE_MOVIE_COMEDY=0x14; | Comedy | +| const CONTENT_TYPE_MOVIE_SOAP=0x15; | Series/Situation/Folklore | +| const CONTENT_TYPE_MOVIE_ROMANCE=0x16; | Romantic | + +**Table U.5 – Program type constants** + +| Constants | Description | +|---------------------------------------------|--------------------------------------------------------| +| const CONTENT_TYPE_MOVIE_CLASSIC=0x17; | Serious/Classic/Religious/Historic Film/Drama | +| const CONTENT_TYPE_MOVIE_ADULT=0x18; | Adult film/drama | +| News/Real Time | | +| const CONTENT_TYPE_NEWS=0x20; | News/Current Affairs (general) | +| const CONTENT_TYPE_NEWS_WEATHER=0x21; | News/Weather | +| const CONTENT_TYPE_NEWS_MAGAZINE=0x22; | News Magazine | +| const CONTENT_TYPE_NEWS_DOCUMENTARY=0x23; | Documentary TV | +| const CONTENT_TYPE_NEWS_DISCUSSION=0x24; | Discussion/Interview/Debate | +| Performance/Entertainment | | +| const CONTENT_TYPE_SHOW=0x30; | Performance/Entertainment (general) | +| const CONTENT_TYPE_SHOW_GAME=0x31; | Recreation/Guess/Athletics | +| const CONTENT_TYPE_SHOW_VARIETY=0x32; | Various performances | +| const CONTENT_TYPE_SHOW_TALK=0x33; | Talk show | +| Sports | | +| const CONTENT_TYPE_SPORTS=0x40; | Sports (general) | +| const CONTENT_TYPE_SPORTS_SPECIAL=0x41; | Specific events (Olympics, World Cup, etc.) | +| const CONTENT_TYPE_SPORTS_MAGAZINE=0x42; | Sports magazine | +| const CONTENT_TYPE_SPORTS_SOCCER=0x43; | Football/rugby | +| const CONTENT_TYPE_SPORTS_TENNIS=0x44; | Tennis/Squash | +| const CONTENT_TYPE_SPORTS_TEAM=0x45; | Team events (including football) | +| const CONTENT_TYPE_SPORTS_ATHLETIC=0x46; | Track and field | +| const CONTENT_TYPE_SPORTS_MOTOR=0x47; | Racing car | +| const CONTENT_TYPE_SPORTS_WATER=0x48; | Water sports | +| const CONTENT_TYPE_SPORTS_WINTER=0x49; | Winter sports | +| const CONTENT_TYPE_SPORTS_EQUESTRAIN=0x4A; | Horse racing | +| const CONTENT_TYPE_SPORTS_MARTIAL=0x4B; | Martial arts | +| Children's/Youth Program | | +| const CONTENT_TYPE_CHILDREN=0x50; | Children/youth program (general) | +| const CONTENT_TYPE_CHILDREN_PRESCHOOL=0x51; | Programs for preschoolers | +| const CONTENT_TYPE_CHILDREN_6TO14=0x52; | Entertainment programs suitable for 6 to 14 years old | +| const CONTENT_TYPE_CHILDREN_10TO16=0x53; | Entertainment programs suitable for 10 to 16 years old | +| const CONTENT_TYPE_CHILDREN_SCHOOL=0x54; | Information/education/teaching program | +| const CONTENT_TYPE_CHILDREN_CARTOON=0x55; | Cartoon/Puppet | +| Music/ballet/dance | | + +**Table U.5 – Program type constants** + +| Constants | Description | +|----------------------------------------------|--------------------------------------------| +| const CONTENT_TYPE_MUSIC=0x60; | Music/ballet/dance (general) | +| const CONTENT_TYPE_MUSIC_POP=0x61; | Rock/pop | +| const CONTENT_TYPE_MUSIC_CLASSICAL=0x62; | Serious music/classical music | +| const CONTENT_TYPE_MUSIC_FOLK=0x63; | Folk/Traditional Music | +| const CONTENT_TYPE_MUSIC_JAZZ=0x64; | Jazz | +| const CONTENT_TYPE_MUSIC_OPERA=0x65; | Musical/opera | +| const CONTENT_TYPE_MUSIC_BALLET=0x66; | Ballet | +| Art/Culture (excluding music) | | +| const CONTENT_TYPE_ARTS=0x70; | Art/Culture (excluding music, general) | +| const CONTENT_TYPE_ARTS_PERFORMANCE=0x71; | Performance art | +| const CONTENT_TYPE_ARTS_ARTS=0x72; | Fine arts | +| const CONTENT_TYPE_ARTS_RELIGION=0x73; | Religion | +| const CONTENT_TYPE_ARTS_CULTURE=0x74; | Pop culture/traditional art | +| const CONTENT_TYPE_ARTS_LITERATURE=0x75; | Literature | +| const CONTENT_TYPE_ARTS_FILM=0x76; | Film/movie | +| const CONTENT_TYPE_ARTS_VIDEO=0x77; | Experimental movie/video | +| const CONTENT_TYPE_ARTS_PRESS=0x78; | Broadcast/News | +| const CONTENT_TYPE_ARTS_NEW=0x79; | New media | +| const CONTENT_TYPE_ARTS_MAGAZINE=0x7A; | Art/Cultural Magazine | +| const CONTENT_TYPE_ARTS_FASHION=0x7B; | Fashion | +| Social/Political Hotspot/Economy | | +| const CONTENT_TYPE_SOCIAL=0x80; | Social/Political Hotspot/Economy (General) | +| const CONTENT_TYPE_SOCIAL_MAGAZINE=0x81; | Magazine/Report/Documentary | +| const CONTENT_TYPE_SOCIAL_ECONOMICS=0x82; | Economic/Social Consulting | +| const CONTENT_TYPE_SOCIAL_PEOPLE=0x83; | Special character | +| Science/Education/Fact Topics | | +| const CONTENT_TYPE_EDUCATION=0x90; | Science/education/fact topics (general) | +| const CONTENT_TYPE_EDUCATION_NATUAL=0x91; | Nature/animal/environment | +| const CONTENT_TYPE_EDUCATION_TECNOLOGY=0x92; | Technology/Natural Science | +| const CONTENT_TYPE_EDUCATION_MEDICAL=0x93; | Medicine/Physiology/Psychology | +| const CONTENT_TYPE_EDUCATION_FOREIGN=0x94; | Abroad/expedition | +| const CONTENT_TYPE_EDUCATION_SOCIAL=0x95; | Social/Spiritual Science | +| const CONTENT_TYPE_EDUCATION_EDUCATION=0x96; | Re-education | +| const CONTENT_TYPE_EDUCATION_LANGUAGE=0x97; | Language | +| Leisure and entertainment | | +| const CONTENT_TYPE_LEISURE=0xA0; | Leisure and entertainment (general) | + +**Table U.5 – Program type constants** + +| Constants | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| const CONTENT_TYPE_LEISURE_TRAVLE=0xA1; | Sightseeing/travel | +| const CONTENT_TYPE_LEISURE_HANDICRAFT=0xA2; | Handicraft | +| const CONTENT_TYPE_LEISURE_MOTOR=0xA3; | Self-driving | +| const CONTENT_TYPE_LEISURE_HEALTH=0xA4; | Fitness/health | +| const CONTENT_TYPE_LEISURE_COOKING=0xA5; | Cooking | +| const CONTENT_TYPE_LEISURE_SHOPPING=0xA6; | Advertising/shopping | +| const CONTENT_TYPE_LEISURE_GARDENING=0xA7; | Gardening | +| Describe special characteristics | | +| const CONTENT_TYPE_DESCRIPTION_LANGUAGE=0xB0; | Original language | +| const CONTENT_TYPE_DESCRIPTION_COLOR=0xB1; | Black/white | +| const CONTENT_TYPE_DESCRIPTION_UNPUBLISHED=0xB2; | Unreleased | +| const CONTENT_TYPE_DESCRIPTION_LIVE=0xB3; | Live | +| NOTE – The upper 4 bits of the constant value are the first-level program content classification, and the lower 4 bits are the second-level program content classification, such as 0xB1, where 0xB indicates the first-level program content classification, and 0x1 indicates the second-level program content classification. | | + +**U.3.2.2 Method** + +**U.3.2.2.1 searchProgramEvent** + +Prototype: number searchProgramEvent(tsList, mask, endureTime) + +Description: An Asynchronous method, within the date range defined by the global parameters EPGSetting.search\_start\_date and EPGSetting.search\_days, searching for the program event message specified by the parameter mask according to the frequency list specified by the parameter tsList. + +- Send the message MSG\_EPG\_SEARCH\_SUCCESS after the search is completed; +- If some data is received during the search, the message MSG\_EPG\_SEARCH\_REFRESH can be sent to notify the page that some data has been searched, and the corresponding data can be obtained through the EPGManager.getProgramsByService() method; +- When the search time reaches the timeout value specified by the parameter endureTime, the system automatically stops the search and sends the message MSG\_EPG\_SEARCH\_TIMEOUT. + +The event.modifiers property of the message object should carry the search process identifier (maskId). + +Parameter: tsList – DvbTS object array, specify the list of frequency points for searching program information. + +mask – number type, indicating the search mask. The basic masks are: + +- 0x01 – indicating searching for actual PF; +- 0x02 – indicating searching for actual schedule; +- 0x04 – indicating searching for other PF; +- 0x08 – indicating searching for other schedule. + +The mask value can be composed of one or more basic masks, such as 0x03=(0x01|0x02), which indicates searching for the data of actual PF and actual schedule. + +endureTime – number type, indicating the timeout period for searching for EPG message, in seconds. + +Return: number type, indicating the unique identifier (maskId) assigned by the system for this asynchronous process. + +#### **U.3.2.2.2 searchProgramEventByService** + +Prototype: number searchProgramEventByService(serviceLocator, mask, endureTime) + +Description: An Asynchronous method, within the date range defined by the global parameters EPGSetting.search\_start\_date and EPGSetting.search\_days, searching for the program event message specified by the parameter mask according to the service specified by the parameter serviceLocator. + +Parameter: serviceLocator – string type, indicating the broadcast service locator. + +mask – number type, indicating the search mask. The basic masks are: + +- 0x01 – indicating searching for actual PF; +- 0x02 – indicating searching for actual schedule; +- 0x04 – indicating searching for other PF; +- 0x08 – indicating searching for other schedule. + +The mask value can be composed of one or more basic masks, such as 0x03=(0x01|0x02), which indicates searching for the data of actual PF and actual schedule. + +endureTime – number type, indicating the timeout period for searching for EPG message, in seconds. + +Return: number type, indicating the unique identifier (maskId) assigned by the system for this asynchronous process. + +#### **U.3.2.2.3 searchNVODRefEvents** + +Prototype: number searchNVODRefEvents(endureTime) + +Description: An Asynchronous method, notifying the system to start receiving NVOD reference event data. + +- If the NVOD data on a certain frequency point is successfully found, send the message MSG\_EPG\_RECEIVE\_NVODREFERENCE\_SUCCESS to the page, and all the received data can be obtained through the getReferenceEvents() method; +- If the data of all NVOD frequency points is received, send the message MSG\_EPG\_RECEIVE\_ALL\_NVODREFERENCE\_SUCCESS to the page, and the search results are saved in the memory, and all the data can be obtained through getReferenceEvents(); +- If the search time reaches endureTime, send the message MSG\_EPG\_RECEIVE\_NVODREFERENCE\_TIMEOUT to the page. At this time, the getReferenceEvents() method can also be called to obtain the information that has been searched. + +Use the exitNVODMode() method to exit the receiving of the reference event. + +Parameter: endureTime: number type, indicating the timeout period for searching for NVOD message, in seconds. + +Return: number type, indicating the unique identifier (maskId) assigned by the system for this asynchronous process. + +#### **U.3.2.2.4 searchNVODRefEvents** + +Prototype: number searchNVODRefEvents(tsArray, endureTime) + +Description: An Asynchronous method, notifying the system to start receiving NVOD reference event data at the specified TS frequency. + +- If the NVOD data on a certain frequency point is successfully found, send the message MSG\_EPG\_RECEIVE\_NVODREFERENCE\_SUCCESS to the page, and all the received data can be obtained through the getReferenceEvents() method; +- If the data of all NVOD frequency points is received, send the message MSG\_EPG\_RECEIVE\_ALL\_NVODREFERENCE\_SUCCESS to the page, and the search results are saved in the memory, and all the data can be obtained through getReferenceEvents(); +- If the search time reaches endureTime, send the message MSG\_EPG\_RECEIVE\_NVODREFERENCE\_TIMEOUT to the page. At this time, the getReferenceEvents() method can also be called to obtain the information that has been searched. + +Use the exitNVODMode() method to exit the receiving of the reference event. + +Parameter: tsArray – DvbTS object array, search for the NVOD data of the specified TS frequency point. + +endureTime – number type, indicating the timeout period for searching for NVOD message, in seconds. + +Return: number type, indicating the unique identifier (maskId) assigned by the system for this asynchronous process. + +#### **U.3.2.2.5 getPresentProgram** + +Prototype: programEvent getPresentProgram(serviceLocator) + +Description: Getting the current program of the specified service. + +Parameter: serviceLocator – string type, indicating the broadcast service locator. + +Return: ProgramEvent object. + +#### **U.3.2.2.6 getPresentProgramsByContentType** + +Prototype: programEvent[] getPresentProgramsByContentType(contentType) + +Description: According to the program content classification value specified in the parameter, search for the current program message that meets the conditions in the current EPG database. + +Parameter: contentType – number type, indicating the type of program content classification. + +Return: ProgramEvent object array. + +#### **U.3.2.2.7 getPresentProgramsByName** + +Prototype: programEvent[] getPresentProgramsByName(str) + +Description: According to the program name specified in the parameter, search for the current program message that meets the conditions in the current EPG database. + +Parameter: str – string type, indicating search keyword. + +Return: ProgramEvent object array. + +#### **U.3.2.2.8 getFollowingProgram** + +Prototype: programEvent getFollowingProgram(serviceLocator) + +Description: Getting the following program of the specified service. + +Parameter: serviceLocator – string type, indicating the broadcast service locator. + +Return: ProgramEvent object. + +#### **U.3.2.2.9 getFollowingProgramsByContentType** + +Prototype: programEvent[] getFollowingProgramsByContentType(contentType) + +Description: A Synchronous method, according to the program content classification value specified in the parameter, searching for the following program information that meets the conditions in the current EPG database. + +Parameter: contentType – number type, indicating the type of program content classification. + +Return: ProgramEvent object array. + +#### **U.3.2.2.10 getFollowingProgramsByName** + +Prototype: programEvent[] getFollowingProgramsByName(str) + +Description: A Synchronous method, according to the program name specified in the parameter, searching the current program information that meets the conditions in the current EPG database. + +Parameter: str – string type, indicating search keyword. + +Return: ProgramEvent object array. + +#### **U.3.2.2.11 getProgramsByService** + +Prototype: programEvent[] getProgramsByService(serviceLocator) + +Description: Getting all program information of a specified service. + +Parameter: serviceLocator – string type, indicating the broadcast service locator. + +Return: ProgramEvent object array. + +#### **U.3.2.2.12 getProgramsByDate** + +Prototype: programEvent[] getProgramsByDate(serviceLocator, beginDate, endDate) + +Description: A Synchronous method, according to the start date and end date specified in the parameter, getting the program information that meets the conditions in the specified service. + +Parameter: serviceLocator – string type, indicating the broadcast service locator. + +beginDate – Date type object, indicating the start date. + +endDate – Date type object, indicating the end date. + +Return: ProgramEvent object array. + +#### **U.3.2.2.13 getProgramsByDirection** + +Prototype: programEvent[] getProgramsByDirection(serviceLocator, beginDate, count, isForward) + +Description: A Synchronous method, according to the start date and search direction specified in the parameters, getting the specified number of program message in the specified service. + +Parameter: serviceLocator – string type, indicating the broadcast service locator. + +beginDate – Date type object, start date. + +count – number type, indicating the number of program message to be obtained. + +isForward – number type, 0 indicating backward search; 1 indicating forward search. + +Return: ProgramEvent object array. + +#### **U.3.2.2.14 getProgramsByContentType** + +Prototype: `programEvent[] getProgramsByContentType(contentType)` + +Description: A Synchronous method, according to the program content classification value specified in the parameter, searching for the program information that meets the conditions in the current EPG database. + +Parameter: `contentType` – number type, program content classification type. + +Return: ProgramEvent object array. + +#### **U.3.2.2.15 getProgramsByName** + +Prototype: `programEvent[] getProgramsByName(str)` + +Description: A Synchronous method, according to the program name specified in the parameter, searching the program information that meets the conditions in the current EPG database. + +Parameter: `str` – string type, indicating search keyword. + +Return: ProgramEvent object array. + +#### **U.3.2.2.16 getReferencePrograms** + +Prototype: `ReferenceEvent[] getReferencePrograms(serviceLocator)` + +Description: A Synchronous method, getting the reference program on the designated reference service. + +Parameter: `serviceLocator` – string type, indicating the reference service locator. + +Return: ReferenceEvent object array. + +#### **U.3.2.2.17 getReferenceEvents** + +Prototype: `ReferenceEvent[] getReferenceEvents(sortType, sortOrder)` + +Description: Getting the searched ReferenceEvent object array. + +Parameter: `sortType` – number type, indicating sorting basis, value: + +- 1-indicating sorting according to the reference event ID; +- 2-indicating sorting according to the reference event name. + +`sortOrder`-number type, indicating the sorting method, value: + +- 0-indicating descending sort; +- 1-indicating ascending sort. + +Return: ReferenceEvent object array. + +#### **U.3.2.2.18 exitNVODMode** + +Prototype: `exitNVODMode()` + +Description: Exit the receiving of NVOD data. + +Parameter: None. + +Return: None. + +### **U.3.3 ProgramEvent object** + +The ProgramEvent object is a local object, used to store program event information related to user behavior. + +### U.3.3.1 Property + +The property definition of the ProgramEvent object is shown in Table U.6. + +**Table U.6 – Table of ProgramEvent property** + +| Property name | Type | Property | Description | +|---------------|-----------------|------------|------------------------------------------------------------------------------------------------------------------| +| channelObj | Channel object | Read only | Channel object to which the program event belongs. | +| eventObj | DvbEvent object | Read only | DvbEvent object corresponding to the program event. | +| isBooked | number | Read/write | Whether the program is reserved to be marked, value:
– 0-indicating not reserved;
– 1-indicating reserved. | + +### U.3.4 ReferenceEvent object + +ReferenceEvent is a local object, used to store reference event message related to user behavior. + +#### U.3.4.1 Property + +The property definitions of the ReferenceEvent object are shown in Table U.7. + +**Table U.7 – Table of ReferenceEvent property** + +| Property name | Type | Property | Description | +|---------------|-----------------|-----------|------------------------------------------------------------------------| +| channelObj | Channel object | Read only | Reference service Channel object to which the reference event belongs. | +| eventObj | DvbEvent object | Read only | DvbEvent object corresponding to the reference event. | + +#### U.3.4.2 Method + +##### U.3.4.2.1 searchSchedules + +Prototype: number searchSchedules(endureTime) + +Description: An Asynchronous method, searching all time-shift event message corresponding to the reference event. + +Parameter: endureTime – number type, allowable receiving timeout time, in seconds. + +Return: number type, + +- 1-indicating that there is no data in the cache, and the bottom layer will automatically lock the frequency point. If the data is received successfully, the message MSG\_EPG\_RECEIVE\_NVODTIMESHIFT\_SUCCESS will be sent; when the search time reaches the endureTime, the system will automatically stop the search and send the message MSG\_EPG\_RECEIVE\_NVODTIMESHIFT\_TIMEOUT, the getSchedules() function can also be called at this time to obtain the information that has been searched. +- 2-indicating that the NVOD time-shift event message that you want to collect already exists in the cache and is complete and can be obtained directly. At this time, no more messages will be returned to the page, and the time-shifted event message can be directly obtained when the return value is determined to be 2 on the page. + +#### U.3.4.2.2 getSchedules + +Prototype: TimeShiftEvent[] getSchedules() + +Description: Getting a list of all time-shifted events within a few days from this moment on the reference event. Time-shifted events that have been played that day will be discarded, and the time-shifted events will be sorted according to the start time. + +Parameter: None. + +Return: TimeShiftEvent object array. + +#### U.3.4.2.3 getPresentSchedules + +Prototype: TimeShiftEvent[] getPresentSchedules() + +Description: Getting all the time-shift event objects currently being played carried in the reference event, and the elements in the array are sorted according to the playback start time. + +Parameter: None. + +Return: TimeShiftEvent object array. + +#### U.3.4.2.4 getFollowingSchedules + +Prototype: TimeShiftEvent[] getFollowingSchedules() + +Description: Getting all the time-shift event objects for the next playback carried in the reference event, and the elements in the array are sorted according to the playback start time. + +Parameter: None. + +Return: TimeShiftEvent object array. + +### U.3.5 TimeShiftEvent object + +The TimeShiftEvent object is a local object, used to save time-shift event information. + +#### U.3.5.1 Property + +The properties of the TimeShiftEvent object are shown in Table U.8. + +**Table U.8 – Table of TimeShiftEvent object property** + +| Property name | Type | Property | Description | +|---------------|-----------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| channelObj | Channel object | Read only | Channel object to which the time-shift event belongs. | +| refChannelObj | Channel object | Read only | Reference service Channel object corresponding to the time-shift event. | +| eventObj | DvbEvent object | Read only | DvbEvent object corresponding to the time-shift event. | +| refEventObj | DvbEvent object | Read only | Reference DvbEvent object corresponding to the time-shift event. | +| status | number | Read only | Get the time-shift event status, value:
– -1-indicating that the playback has been completed;
– 0-indicating it is broadcasting;
– 1-indicating it has not been broadcast yet.
This property is a real-time value. | + +**Table U.8 – Table of TimeShiftEvent object property** + +| Property name | Type | Property | Description | +|---------------|-----------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| orderIndex | number | Read only | It indicates the position of the time-shifted event in the reservation list, value:
– -1-indicating not reserved;
– $\geq 0$ -indicating the position of the time-shift event in the reservation list. | +| preEvent | TimeShiftEvent object | Read only | Get the previous time-shift event of the time-shift event. If null is returned, it indicates that the object is the first time-shift event. | +| nextEvent | TimeShiftEvent object | Read only | Get the next time-shift event of the time-shift event, if it returns null, it indicates that the object is the last time-shift event. | + +#### U.4 Reservation reminder module + +##### U.4.1 Message + +The message definition that the reservation reminder module may send to the application layer is shown in Table U.9. + +**Table U.9 – Reservation reminder module messages** + +| Message name | event.which | event.modifiers | Message description | +|-------------------------------|-------------|-----------------|-------------------------------------------------------------------------| +| MSG_REMIND_RAM_TO_NVM_SUCCESS | 20001 | – | It indicates that writing channel data from RAM to NVM is successful. | +| MSG_REMIND_RAM_TO_NVM_FAILED | 20002 | – | It indicates that writing channel data from RAM to NVM failed. | +| MSG_REMIND_NVM_TO_RAM_SUCCESS | 20003 | – | It indicates that restoring channel data from NVM to RAM is successful. | +| MSG_REMIND_NVM_TO_RAM_FAILED | 20004 | – | It indicates restoring channel data from NVM to RAM failed. | +| Reserved | 20005~20500 | | | + +NOTE – The value of event.modifiers is automatically given by the system, and its data type: +– "Number", indicating that the value is the ID of the message description character string, which can be obtained through the Utility.getEventInfo() method. If the "message description" defines the message character string JSON format, the message content will be retrieved according to the format. +– "-", indicating that event.modifiers is undefined. + +##### U.4.2 OrderManager object + +The OrderManager object is a built-in object, used to describe the management mode of user reservations. + +###### U.4.2.1 Property + +The property definition of the OrderManager object is shown in Table U.10. + +**Table U.10 – OrderManager object properties** + +| Property name | Type | Property | Description | +|------------------|--------|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| advanceRemind | number | Read/write | This interface is used to set the pop-up reminder time of the reserved program, that is, how long the reserved program will be played, and that the page reminds the user how long it will start to play the reserved program. The default value is 60, in seconds. | +| conflictInterval | number | Read/write | This interface is used to set the conflict threshold of reserved programs. If the user wants to reserve program A, within the range of the set minutes of the start time of program A, no other programs that have been reserved before can start to play, otherwise the system will not add a program reservation, and a reservation conflict program list will be generated in the memory (Which programs that have been reserved have conflict with the programs in this reservation on the start time), the default value for calling getConflictEvents() method is 5, in minute. | +| remindType | number | Read/write | 0-indicating that the conflict Interval value is set as the conflict determination condition;
1-indicating that the entire duration of the program is used as the conflict determination condition. | + +**U.4.2.2 Method** + +**U.4.2.2.1 getPlayingList** + +Prototype: Order[] getPlayingList() + +Description: Getting all the Order objects currently being played in the reservation list. + +Parameter: None. + +Return: Order object array. + +**U.4.2.2.2 getRemindList** + +Prototype: Order[] getRemindList() + +Description: Getting all Remind objects to be played in the reservation list. + +Parameter: None. + +Return: Order object array. + +**U.4.2.2.3 getOrders** + +Prototype: Order[] getOrders(type) + +Description: Getting all reserved programs according to the specified type. + +Parameter: type – number type, indicating the type of program reservation, value: + +- 0 or no parameter indicating obtaining all types of program reservations; +- 1 indicating obtaining the program reservation of the video type; +- 2 indicating obtaining the program reservation of the audio type; +- 3 indicating obtaining the program reservation of the NVOD type. + +Return: Order object array. + +#### **U.4.2.2.4 getOrderByID** + +Prototype: Order getOrderByID(orderID) + +Description: Obtain the reservation object according to the reservation identifier. + +Parameter: orderID – number type, indicating the identifier of the reservation, and the value range being 0-65535. + +Return: Order object. + +#### **U.4.2.2.5 getOrderByEvent** + +Prototype: getOrderByEvent(type, eventObj) + +Description: Obtain the reservation object according to the event object corresponding to the reservation. + +Parameter: type – indicating the eventObj parameter object type, value: + +- 0-indicating eventObj is ProgramEvent object; +- 1-indicating that eventObj is TimeShiftEvent object. + +eventObj-ProgramEvent object or TimeshiftEvent object, the type of the object is determined by the type parameter. + +Return: Order object, if there is no corresponding Order object, null is returned. + +#### **U.4.2.2.6 getConflictOrders** + +Prototype: Order[] getConflictOrders() + +Description: Getting the conflict reservation list, when the user wants to reserve a new program (the application calls the OrderManager.addEvent(obj) method), if the start time of the new program and the start time of the reserved program have conflict according to OrderManager.conflictInterval, the system will not add the program reservation, and a reservation conflict program list will be generated in the memory (which programs that have been reserved have conflict with the programs in this reservation on the start time), the reservation conflict program list can be accessed and retrieved by this method. + +Parameter: None. + +Return: Order object array. + +#### **U.4.2.2.7 getDelMarkedList** + +Prototype: Order[] getDelMarkedList() + +Description: Getting the reservation program list that are currently marked for deletion. + +Parameter: None. + +Return: Order object array. + +#### **U.4.2.2.8 addEvent** + +Prototype: number addEvent(type, eventObj) + +Description: Add reservation program information to the user reservation list. + +NOTE – Only operate on the reservation list in RAM. + +Parameter: type – indicating the type of the obj parameter object, the value is: + +- 0-indicating that the eventObj parameter is of ProgramEvent type; +- 1-indicating that the eventObj parameter is of TimeShiftEvent type. + +eventObj – ProgramEvent or TimeShiftEvent object to be reserved, the type is specified by the type parameter. + +Return: number type, the value being: + +- 1-indicating the addition is successful; +- 0-indicating the program has been broadcast; +- -1-indicating adding conflict; +- -2-indicating there is no corresponding service; +- -3-indicating that the reserved space is full. + +#### **U.4.2.2.9 deleteOrder** + +Prototype: deleteOrder(orderObj) + +Description: Delete the specified reserved program from the reservation program list. + +NOTE – Only operate on the reservation list in RAM. + +Parameter: orderObj – Order object. + +Return: number type, 1 indicating successful deletion of the reserved program, 0 indicating failure to delete the reserved program. + +#### **U.4.2.2.10 deleteAll** + +Prototype: deleteAll() + +Description: Delete all reserved programs in the program reservation list. + +NOTE – Only operate on the reservation list in RAM. + +Parameter: None. + +Return: None. + +#### **U.4.2.2.11 deleteAllDelMarked** + +Prototype: deleteAllDelMarked() + +NOTE – Only operate on the reservation list in RAM. + +Description: Delete all reserved programs of the specified type from the user reservation program list, and clear related information from the NVM. + +Parameter: None. + +Return: None. + +#### **U.4.2.2.12 delConflictOrders** + +Prototype: number delConflictOrders() + +NOTE – Only operate on the reservation list in RAM. + +Description: Delete all conflicting reserved programs. + +Parameter: None. + +Return: number type, value 0 indicating deletion failed, 1 indicating deletion succeeded. + +#### **U.4.2.2.13 restore** + +Prototype: restore() + +Description: Import the program reservation list saved by the current NVM into RAM. + +Parameter: None. + +Return: number type, value 1 indicating success in restoring the reservation data in the NVM to the memory, and 0 indicating failure. + +#### U.4.2.2.14 save + +Prototype: save() + +Description: Saving the program reservation list in RAM to the NVM of the receiving terminal. + +Parameter: None. + +Return: None. + +### U.4.3 Order object + +The Order object is a local object, used to describe the program reservation information. + +#### U.4.3.1 Property + +The properties of the Order object are shown in Table U.11. + +**Table U.11 – Table of Order object property** + +| Property name | Type | Property | Description | +|---------------|---------------------------------|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| orderID | number | Read only | Get the identifier of the current reservation. When a user reserves a program on the terminal interface, the system generates an Order object and assigns an orderID. It must be ensured that the orderID is unique among the Order objects of all users that currently exist. | +| channelObj | Channel | Read only | Get the channel object to which the current reservation belongs. | +| deleteFlag | number | Read/write | Mark the reserved program with the deletion mark, the value is:
– 0-indicating there is no deletion mark;
– 1-indicating that there is a deletion mark. | +| Type | number | Read only | It indicates the eventObj object type, the value being:
– 0-indicating that the eventObj property is ProgramEvent object;
– 1-indicating that the eventObj property is TimeShiftEvent object. | +| eventObj | ProgramEvent/
TimeShiftEvent | Read only | Get the event object corresponding to the current reservation, the type is specified by the type property. | + +### U.5 Message search module + +The message search module defines JS objects related to global search and matching search: SearchManager, GlobalSearchSession, AutoCompleteSearchSession, GloalSearchFilter, AutoCompleteSearchFilter, GlobalSearchResultItem, AutoCompleteSearchItem and SearchHistoryItem. + +Definition of terms: + +- Global Search – Find SI, PVR and other content according to the search conditions set by the user, and return meaningful search results to improve the user experience; +- Matching search – According to the user's input, the character string that can be matched in the current data source is given to shorten the time for the user to enter the querying keyword and reduce the difficulty for the user to enter the querying keyword. + +The message search module is divided into the following components: + +- Search Manager (SearchManager) – the entry class of the message search module. +- Global Search Session (GlobalSearchSession)-session associated with the global search process. +- Matching search session (AutoCompleteSearchSession) – the session associated with the ongoing matching search process. + +### U.5.1 Constants + +The constant definitions of this module are shown in Table U.12. + +**Table U.12 – Constant definitions of message search module** + +| Constants | Value | Description | +|------------------------------------|-------|--------------------------------------------------------------------------------------------------------| +| Data source type | | | +| SourceType.ALL | 0 | It indicates that the data source of the search is two parts: broadcast data and local recording data. | +| SourceType.BROADCAST | 1 | It indicates that the data source of the search is broadcast data. | +| SourceType.RECORDED | 2 | It indicates that the searched data source is local recording data. | +| Search field | | | +| SearchFields.ALL_STRING_FIELDS | 0 | It indicates searching all character string fields. | +| SearchFields.SYNOPSIS | 4 | It indicates searching profile field. | +| SearchFields.TITLE | 5 | It indicates searching title field. | +| Data content type | | | +| SearchContentType.ALL | 0 | It indicates searching for data in both audio and video formats. | +| SearchContentType.AUDIO_ONLY | 1 | It indicates searching for data only in the audio format. | +| SearchContentType.VIDEO_ONLY | 2 | It indicates searching for data only in the video format. | +| Get paging direction | | | +| RetrieveDirection.FIRST_PAGE | 0 | It indicates that the data on the first page is got according to the getting results by paging. | +| RetrieveDirection.NEXT_PAGE | 1 | It indicates that the data on the next page is got according to the getting results by paging. | +| RetrieveDirection.PREVIOUS_PAGE | 2 | It indicates that the data on the previous page is got according to the getting results by paging. | +| Filter condition | | | +| SearchCriteriaFlags.FLAG_NONE | 0 | Filter condition flag-empty. | +| SearchCriteriaFlags.FLAG_SD_EVENT | 1 | Filter condition tag-filter standard definition content. | +| SearchCriteriaFlags.FLAG_HD_EVENT | 2 | Filter condition tag-filter high definition content. | +| SearchCriteriaFlags.FLAG_3D_EVENT | 4 | Filter condition tag-filter 3D content. | +| SearchCriteriaFlags.FLAG_CLEAR | 32 | Filter condition tag-filter unscrambled content. | +| SearchCriteriaFlags.FLAG_SCRAMBLED | 64 | Filter condition tag-filter scrambled content. | + +**Table U.12 – Constant definitions of message search module** + +| Constants | Value | Description | +|-------------------------------------|-------|--------------------------------------------------------| +| Search status | | | +| SearchStatus.INITIATED | 0 | Search status-initialization is complete. | +| SearchStatus.IN_PROGRESS | 1 | Search status-in progress. | +| SearchStatus.COMPLETED | 2 | Search status-end. | +| SearchStatus.INTERRUPTED | 3 | Search status-interrupted. | +| SearchStatus.TIMEOUT | 4 | Search status-search stops after timeout. | +| SearchStatus.TIMEOUT_STOP_FAILED | 5 | Search status-search stop failed after timeout. | +| SearchStatus.FAILED | 6 | Search status-search failed. | +| SearchStatus.STOP_SUCCESS | 7 | Search status—successfully stop the search. | +| SearchStatus.STOP_FAILED | 8 | Search status-failed to stop the search. | +| SearchStatus.DISPOSE_SUCCESS | 9 | Search status-successfully close the search. | +| SearchStatus.DISPOSE_FAILED | 10 | Search status-close the search failed. | +| SearchStatus.RETRIEVAL_SUCCESS | 11 | Search status—successfully get the search results. | +| SearchStatus.RETRIEVAL_FAILED | 12 | Search status-failed to get the search results. | +| SearchStatus.RETRIEVAL_INSUFFICIENT | 13 | Search status-not enough search results are available. | + +## U.5.2 SearchManager object + +SearchManager is a built-in object, the manager of global search and matching search, and the entry class of the information search module. At the same time, the historical search records can be got through it. + +### U.5.2.1 Method + +#### U.5.2.1.1 getAutoCompleteSearchSession + +Prototype: AutoCompleteSearchSession getAutoCompleteSearchSession(autoCompleteFilter) + +Description: Getting the matching search session object. Each matching search object is an independent search session. The system can only have one matching search session at a time. + +Parameter: autoCompleteFilter – An AutoCompleteSearchFilter object, indicating a matching search filter. + +Return: An AutoCompleteSearchSession object, indicating an instance of the matching search session. + +#### U.5.2.1.2 getGlobalSearchSession + +Prototype: GlobalSearchSession getGlobalSearchSession(globalFilter,sortCriteria) + +Description: Getting the global search session object. Each global search session object is an independent search session. In order to have multiple global search sessions at the same time, the application needs not only to obtain different objects, but also to handle the corresponding callback function. According to the terminal capabilities, the system decides itself whether to support multiple global search sessions at the same time. + +Parameter: globalFilter – A GlobalSearchFilter object, indicating the global search filter. + +sortCriteria – A SortCriteria object, indicating the criteria for sorting search results. + +Return: A GlobalSearchSession object, indicating an instance of the global search session. + +#### U.5.2.1.3 getSearchHistory + +Prototype: SearchHistoryItem[] getSearchHistory() + +Description: Getting a list of historical search records. + +Parameter: None. + +Return: SearchHistoryItem array, indicating historical search records. If there is a successful search record before, and the application explicitly calls the method for saving search result, this method returns the history record of the successful search; if the history record is empty, the returned array length is 0. + +#### U.5.2.1.4 clearSearchHistory + +Prototype: void clearSearchHistory() + +Description: Clear historical search records. At any time, the application can call this method to clear historical search records to protect personal privacy. + +Parameter: None. + +Return: None. + +### U.5.3 GlobalSearchSession object + +GlobalSearchSession describes a global search session, provides interfaces for the global search session and related control. + +#### U.5.3.1 Constants + +The constant definitions of the GlobalSearchSession object are shown in Table U.13. + +**Table U.13 – Table of GlobalSearchSession object constant definition** + +| Constant | Value | Description | +|-------------------|-------|------------------------------------------------------------------------------------------------------------------------| +| DEFAULT_PAGE_SIZE | 6 | The default page size of the global search results, that is, the number of search result items contained in each page. | + +#### U.5.3.2 Property + +The property definition of the GlobalSearchSession object is shown in Table U.14. + +**Table U.14 – GlobalSearchSession object properties** + +| Property name | Type | Read and write property | Description | +|---------------------|------------------|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| pageSize | number | Read and write | When returning search results by page, specify the number of results contained in each page.
The default value is GlobalSearchSession.DEFAULT_PAGE_SIZE. | +| onGlobalSearchStart | Function pointer | Read and write | Global search session start event handling method. | +| onGlobalSearchStop | Function pointer | Read and write | Global search session closing event handling method. | + +**Table U.14 – GlobalSearchSession object properties** + +| Property name | Type | Read and write property | Description | +|-------------------------|------------------|-------------------------|------------------------------------------------------------------------| +| onGlobalSearchDestroy | Function pointer | Read and write | Global search session destruction event handling method. | +| onGlobalSearchRetrieval | Function pointer | Read and write | Global search session obtains the search result event handling method. | +| onGlobalSearchError | Function pointer | Read and write | Global search session error event handling method. | + +Examples of using the callback method properties of the GlobalSearchSession object are as follows: + +``` + +var globalSearchSession = SearchManager.getGlobalSearchSession(globalFilter, sortCriteria); +globalSearchSession.onGlobalSearchStart = eventHandle; +globalSearchSession.onGlobalSearchStop = eventHandle; +globalSearchSession.onGlobalSearchDestroy = eventHandle; +globalSearchSession.onGlobalSearchRetrieval = eventHandle; +globalSearchSession.onGlobalSearchError = eventHandle; +globalSearchSession.pageSize = 10; +..... +globalSearchSession.startSearch("The Founding of A Party"); +..... +//definition of callback method +function eventHandle(aEvent) { +..... +switch (aEvent){ + case COMPLETED: + break; +} +..... +} +..... + +``` + +### U.5.3.3 Method + +#### U.5.3.3.1 startSearch + +Prototype: void startSearch(searchStr) + +Description: Start a new global search request. Once the search is completed, the system will notify the application through an event to get the search results. + +Parameter: searchStr – string type, indicating the character string to be searched entered by the user. + +Return: None. + +#### **U.5.3.3.2 stopSearch** + +Prototype: void stopSearch() + +Description: Terminate the global search request that has been started before. + +Parameter: None. + +Return: None. + +#### **U.5.3.3.3 getSearchResultList** + +Prototype: GlobalSearchResultItem[] getSearchResultList() + +Description: To get the global search results, the application needs to wait for the event trigger before calling this method. The results are stored in the same cache. Once a new search is initialized, this interface can no longer be used to obtain the results of the last search. + +Parameter: None. + +Return: A GlobalSearchResultItem array, indicating global search results. If there is no search result, the length of the returned array is 0. + +#### **U.5.3.3.4 getResultCount** + +Prototype: number getResultCount() + +Description: Getting the number of search result items. If the search has not been completed and is partially updated, the number of results will also be updated according to the change of the search element. For each threshold limit, the application will receive a notification of SearchStatus.IN\_PROGRESS. + +Parameter: None. + +Return: number type, indicating the number of search result items. + +#### **U.5.3.3.5 dispose** + +Prototype: void dispose() + +Description: Destroy global search session objects that are no longer needed. + +NOTE – After the global search is completed, once the session is no longer needed, this method must be called to release the corresponding resources. + +Parameter: None. + +Return: None. + +#### **U.5.3.3.6 retrievePage** + +Prototype: void retrievePage(retrieveDirection) + +Description: Getting the data on the first page, the next page or the previous page from the search result list, an asynchronous method, waiting for event processing mechanism. + +Parameter: retrieveDirection – number type, used to specify the direction of getting the result. + +Return: None. + +#### **U.5.3.3.7 saveRecentSearchQuery** + +Prototype: void saveRecentSearchQuery() + +Description: Saving the latest search results to the history records. + +Parameter: None. + +Return: None. + +### U.5.3.4 Callback method + +The event description of the GlobalSearchSession object is shown in Table U.15, and the value of the event code is shown in the "Search Status" constant definition in Table U.12. + +**Table U.15 – GlobalSearchSession object related events** + +| Trigger event | Callback disposal method | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| COMPLETED
IN_PROGRESS
INITIATED | onGlobalSearchStart | +| STOP_SUCCESS | onGlobalSearchStop | +| DISPOSE_SUCCESS | onGlobalSearchDestroy | +| RETRIEVAL_SUCCESS | onGlobalSearchRetrieval | +| FAILED
INTERRUPTED
TIMEOUT_STOP_FAILED
TIMEOUT
DISPOSE_FAILED
RETRIEVAL_FAILED
RETRIEVAL_INSUFFICIENT
STOP_FAILED
EXPAND_RESULT_FAILED | onGlobalSearchError | + +#### U.5.3.4.1 onGlobalSearchStart + +Description: The properties of the GlobalSearchSession object, the callback method of the global search session start event. It is used to monitor the global search start event, the application should assign it an event handling function handle to handle the corresponding event. + +Prototype: function eventHandle(aEvent) + +Parameter: aEvent – number type, indicating the global search event. + +Return: None. + +#### U.5.3.4.2 onGlobalSearchStop + +Description: The properties of the GlobalSearchSession object, the callback method of the global search session stop event. It is used to monitor the global search stop event, the application should assign it an event handling function handle to handle the corresponding event. + +Prototype: function eventHandle(aEvent) + +Parameter: aEvent – number type, indicating the global search event. + +Return: None. + +#### U.5.3.4.3 onGlobalSearchDestroy + +Description: The properties of the GlobalSearchSession object, the callback method of the global search session destruction event. It is used to monitor the global search destruction event, the application should assign it an event handling function handle to handle the corresponding event. + +Prototype: function eventHandle(aEvent) + +Parameter: aEvent – number type, indicating the global search event. + +Return: None. + +#### U.5.3.4.4 onGlobalSearchRetrieval + +Description: The properties of the GlobalSearchSession object, the global search session gets the search result event callback method. It is used to monitor the global search to get some search result events, the application should assign it an event handling function handle to handle the corresponding event. + +Prototype: function eventHandle(aEvent) + +Parameter: aEvent – number type, indicating the global search event. + +Return: None. + +#### U.5.3.4.5 onGlobalSearchError + +Description: The properties of the GlobalSearchSession object, the callback method of the global search session error event. It is used to monitor the global search error event, the application should assign it an event handling function handle to handle the corresponding event. + +Prototype: function eventHandle(aEvent) + +Parameter: aEvent – number type, indicating the global search event. + +Return: None. + +### U.5.4 AutoCompleteSearchSession object + +The matching search session object provides a matching search session control method. + +#### U.5.4.1 Property + +The property definition of the AutoCompleteSearchSession object is shown in Table U.16. + +**Table U.16 – AutoCompleteSearchSession object properties** + +| Property name | Type | Read and write property | Description | +|-------------------------------|------------------|-------------------------|-----------------------------------------------------------------------| +| onAutoCompleteSearchStart | Function pointer | Read and write | Matching search session start event handling method. | +| onAutoCompleteSearchStop | Function pointer | Read and write | Matching search session closing event handling method. | +| onAutoCompleteSearchDestroy | Function pointer | Read and write | Matching search session destruction event handling method. | +| onAutoCompleteSearchRetrieval | Function pointer | Read and write | Matching search session gets the search result event handling method. | +| onAutoCompleteSearchError | Function pointer | Read and write | Matching search session error event handling method. | + +Examples of using the callback method properties of the AutoCompleteSearchSession object are as follows: + +``` +var autoCompleteSearchSession = + SearchManager.getAutoCompleteSearchSession(autoCompleteFilter); +autoCompleteSearchSession.onAutoCompleteSearchStart = eventHandle; +autoCompleteSearchSession.onAutoCompleteSearchStop = eventHandle; +autoCompleteSearchSession.onAutoCompleteSearchDestroy = eventHandle; +``` + +``` + +autoCompleteSearchSession.onAutoCompleteSearchRetrieval = eventHandle; +autoCompleteSearchSession.onAutoCompleteSearchError = eventHandle; +..... +autoCompleteSearchSession.startSearch("The Founding of A Party"); +..... +//Definition of callback method +function eventHandle(aEvent) { +..... +switch (aEvent){ + case COMPLETED: + break; +} +..... +} +..... + +``` + +## U.5.4.2 Method + +### U.5.4.2.1 startSearch + +Prototype: void startSearch(searchStr) + +Description: Start a new matching search request. Once the search is completed, the search engine will notify the application to get the search results. After starting the search, the application needs to wait for the notification of onAutoCompleteSearchStart() event and then get the results. + +NOTE 1 – If the timeout of AutoCompleteSearchFilter is set to 0, the search will stop only when the stopSearch() method is explicitly called. + +NOTE 2: + +- 1 Get matching search results by calling the getSearchResultList() method; +- 2 Terminate the previous search request that is still in progress by calling the stopSearch() method; +- 3 If the matching search session is no longer used, release it by calling the dispose() method; +- 4 At the same time, only one matching search session can be active. During this period, the startSearch() and stopSearch() methods can be called repeatedly, but when the matching search session is no longer needed, dispose () method should be called to close the search session and release resources; the search results are stored in the same cache. Once a new search is started, the old search results will no longer be valid. + +Parameter: searchStr – string type, indicating the keyword character string entered by the user to be searched. + +Return: None. + +### U.5.4.2.2 stopSearch + +Prototype: void stopSearch() + +Description: Terminate previously initiated matching search requests. + +NOTE – This operation only terminates the matching search, but the matching search session is still valid, and the corresponding resources are not released. This method should be forced to be called in the following scenarios: + +- If the matching search has been started and the results are waiting to be returned, the user must call the `stopSearch()` method to terminate the search when the user enters another character before the search engine returns the results; +- The timeout limit of the matching search filter is set to 0, so that it will always wait for the search result. If there is no corresponding matching result, the `stopSearch()` method must be called to terminate the search before starting another search. + +Tip: If the matching search has been completed, there is no need to call this method. + +Parameter: None. + +Return: None. + +#### U.5.4.2.3 **dispose** + +Prototype: `void dispose()` + +Description: Destroy matching search session objects that are no longer needed. + +NOTE – After the matching search is completed, once the session is no longer needed, this method must be called to release the corresponding resources. + +Parameter: None. + +Return: None. + +#### U.5.4.2.4 **getSearchResultList** + +Prototype: `string[] getSearchResultList()` + +Description: Getting the results of a matching search. + +Parameter: None. + +Return: string array, indicating all the searched character string arrays that match the querying keywords entered by the user. + +#### U.5.4.3 **Callback method** + +The event description of the `AutoCompleteSearchSession` object is shown in Table U.17. + +**Table U.17 – AutoCompleteSearchSession object related events** + +| Search event | Callback disposal method | +|----------------------------------------------------|------------------------------------------| +| COMPLETED |
onAutoCompleteSearchStart |
+| STOP_SUCCESS | onAutoCompleteSearchStop |
+| DISPOSE_SUCCESS | onAutoCompleteSearchDestroy |
+| FAILEDTIMEOUT
STOP_FAILED
DISPOSE_FAILED |
onAutoCompleteSearchError |
+
+##### U.5.4.3.1 **onAutoCompleteSearchStart**
+
+Description: The properties of the `AutoCompleteSearchSession` object, the matching search session start event callback method. It is used to monitor the matching search start event. The application should assign it an event handling function handle to handle the corresponding event.
+
+Prototype: `function eventHandle(aEvent)`
+
+Parameter: `aEvent` – number type, indicating matching search event.
+
+Return: None.
+
+#### **U.5.4.3.2 onAutoCompleteSearchStop**
+
+Description: Properties of the AutoCompleteSearchSession object, the matching search session stop event callback method. It is used to monitor the matching search stop event. The application should assign it an event handling function handle to handle the corresponding event.
+
+Prototype: function eventHandle(aEvent)
+
+Parameter: aEvent – number type, indicating matching search event.
+
+Return: None.
+
+#### **U.5.4.3.3 onAutoCompleteSearchDestroy**
+
+Description: properties of the AutoCompleteSearchSession object, the matching search session destruction event callback method. It is used to monitor the matching search destruction event. The application should assign it an event handling function handle to handle the corresponding event.
+
+Prototype: function eventHandle(aEvent)
+
+Parameter: aEvent – number type, indicating matching search event.
+
+Return: None.
+
+#### **U.5.4.3.4 onAutoCompleteSearchError**
+
+Description: properties of the AutoCompleteSearchSession object, the matching search session error event callback method. It is used to monitor the matching search error event. The application should assign it an event handling function handle to handle the corresponding event.
+
+Prototype: function eventHandle(aEvent)
+
+Parameter: aEvent – number type, indicating matching search event.
+
+Return: None.
+
+### **U.5.5 GlobalSearchFilter object**
+
+The global search filter object provides methods for setting and obtaining global search filter conditions. The global search filter conditions can be:
+
+- Search data source;
+- Search field;
+- The language of the text information;
+- The maximum number of returned results;
+- Search timeout time limit.
+
+NOTE – The application using GlobalSearchFilter can obtain the following effects: According to the specified search data source and search field, the search result list that matches the keyword input by the user is listed within the timeout limit, and the number of search results is less than or equal to the maximum value set by the application.
+
+#### **U.5.5.1 Constants**
+
+The constant definitions of the GlobalSearchFilter object are shown in Table U.18.
+
+**Table U.18 – Table of GlobalSearchFilter object constant definition**
+
+| Constant | Value |
+|-----------------------------------|--------------|
+| DEFAULT_MAX_GLOBAL_SEARCH_RESULTS | 50 |
+
+### U.5.5.2 Property
+
+The properties of the GlobalSearchFilter objects are defined in the following table.
+
+**Table U.19 – Definitions of GlobalSearchFilter object properties**
+
+| Property name | Type | Read and write property | Description |
+|----------------|--------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------|
+| source | number | Read and write | Specify the search source, the default is SourceType.ALL. |
+| contentType | number | Read and write | It indicates the content type, the default is SearchContentType.ALL. |
+| contentNibble | number | Read and write | It indicates the class of the program to be filtered. |
+| searchField | number | Read and write | Search fields, the default is SearchFields.ALL_STRING_FIELDS. |
+| searchLanauage | string | Read and write | Preset system language on the receiving terminal, the default is "zho". |
+| criteriaFlags | number | Read and write | It indicates filter conditions. |
+| maxResults | number | Read and write | It indicates the maximum number of returned results, the default value is GlobalSearchFilter.DEFAULT_MAX_GLOBAL_SEAR CH_RESULTS. |
+| threshold | number | Read and write | Set the threshold of search query results, the default is 0. |
+| timeLimit | number | Read and write | Timeout setting, the default is 0, in milliseconds. |
+
+### U.5.5.3 Method
+
+#### U.5.5.3.1 GlobalSearchFilter
+
+Prototype: GlobalSearchFilter()
+
+Description: Construction method, creates a GlobalSearchFilter object.
+
+Parameter: None.
+
+### U.5.6 AutoCompleteSearchFilter object
+
+Matching search filter object, provides methods for setting and obtaining matching search filter conditions. The matching search filter conditions can be:
+
+- Search data source;
+- Search field;
+- Language of the text information;
+- Maximum number of returned results;
+- Search timeout time limit.
+
+NOTE – The application uses AutoCompleteSearchFilter to obtain the following effects: According to the specified search data source and search field, a list of prompt character strings that match the characters input by the user are listed within the timeout limit, and the number of character strings is less than or equal to the maximum value set by the application.
+
+#### U.5.6.1 Constants
+
+The constant definitions of the AutoCompleteSearchFilter object are shown in the following table.
+
+**Table U.20 – AutoCompleteSearchFilter object constant**
+
+| Constant | Value |
+|------------------------------------------|-------|
+| DEFAULT_MAX_AUTO_COMPLETE_SEARCH_RESULTS | 10 |
+
+**U.5.6.2 Property**
+
+The property definitions of the AutoCompleteSearchFilter object are shown in the following table.
+
+**Table U.21 – AutoCompleteSearchFilter Object Properties**
+
+| Property name | Type | Property | Description |
+|----------------|--------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
+| source | number | Read and write | Specify the search source, the default is SourceType.ALL. |
+| searchField | number | Read and write | Search fields, the default value is SearchFields.ALL_STRING_FIELDS. |
+| searchLanauage | string | Read and write | It indicates the language of the search text, following the three-letter code agreed by the GB/T 4880.2-2000 standard, and the default value is "zho". |
+| maxResults | number | Read and write | It indicates the maximum number of returned results, the default value is AutoCompleteSearchFilter.DEFAULT_MAX_AUTO_COMPLETE_SEARCH_RESULTS. |
+| timeLimit | number | Read and write | Timeout setting, the default value is 0, in milliseconds. |
+
+**U.5.6.3 Method****U.5.6.3.1 AutoCompleteSearchFilter**
+
+Prototype: AutoCompleteSearchFilter()
+
+Description: Construction method, creates an AutoCompleteSearchFilter object.
+
+Parameter: None.
+
+**U.5.7 SortCriteria object**
+
+The SortCriteria object describes the sorting mechanism of the search results, including two rules, one is to sort according to the specified field, and the other is to use it in ascending or descending order. The two rules need to be used in combination, that is, sort a field in ascending or descending order.
+
+**U.5.7.1 Constants**
+
+The constant definitions of the SortCriteria object are shown in Table U.22.
+
+**Table U.22 – Constants of SortCriteria object**
+
+| Constants | Value |
+|---------------------------------------|-------|
+| Sorting method (ascending/descending) | |
+| SORT_ORDER_NONE | 0 |
+| SORT_ORDER_ASCENDING | 1 |
+| SORT_ORDER_DESCENDING | 2 |
+| Sorting basis | |
+
+**Table U.22 – Constants of SortCriteria object**
+
+| Constants | Value |
+|--------------------------|-------|
+| SORT_TYPE_NONE | 0 |
+| SORT_TYPE_TITLE | 1 |
+| SORT_TYPE_START_TIME | 2 |
+| SORT_TYPE_CONTENT_NIBBLE | 15 |
+
+**U.5.7.2 Property**
+
+The property definitions of the SortCriteria object are shown in Table U.23.
+
+**Table U.23 – Table of SortCriteria object property definitions**
+
+| Property name | Type | Read and write property | Description |
+|---------------|--------|-------------------------|-------------------------------------------------------------------------------|
+| sortOrder | number | Read and write | The possible values are the "sorting method" constants defined in Table W.22. |
+| sortType | number | Read and write | The possible values are the "sorting basis" constants defined in Table W.22. |
+
+**U.5.7.3 Method**
+
+**U.5.7.3.1 SortCriteria**
+
+Prototype: SortCriteria()
+
+Description: Construction method, creates a default SortCriteria object for sorting search results.
+
+Parameter: None.
+
+**U.5.7.3.2 SortCriteria**
+
+Prototype: SortCriteria(field, order)
+
+Description: A construction method, creating a SortCriteria object according to the specified parameters, which is used to sort the search results.
+
+Parameter: field – number type, which specifies which field to be sorted, which can be the "sorting basis" constants defined in Table W.22 for the value.
+
+order – number type, which specifies the ascending or descending type of sorting, which can be the "sorting method" constant defined in Table W.22 for the value.
+
+**U.5.8 GlobalSearchResultItem object**
+
+**U.5.8.1 Constant**
+
+The constant definitions of the GlobalSearchResultItem object are shown in Table U.24.
+
+**Table U.24 – GlobalSearchResultItem object constants**
+
+| Constants | Value | Description |
+|------------------|-------|------------------------------------------------------|
+| CONTENT_DVBEVENT | 0 | It indicates that the content type is DvbEvent type. |
+| CONTENT_PVREVENT | 1 | It indicates that the content type is PVREvent type. |
+
+### U.5.8.2 Property
+
+The property definition of the GlobalSearchResultItem object is shown in Table U.25.
+
+**Table U.25 – GlobalSearchResultItem object properties**
+
+| Property name | Type | Read and write property | Description |
+|---------------|--------|-------------------------|--------------------------------------------------------|
+| contentType | number | Read only | The value can be CONTENT_DVBEVENT or CONTENT_PVREVENT. |
+
+### U.5.8.3 Method
+
+#### U.5.8.3.1 getContent
+
+Prototype: object getContent()
+
+Description: Getting the object associated with this search result. The object may be of type DvbEvent or PVREvent, indicated by the contentType property.
+
+Parameter: None.
+
+Return: Object object type, the specific type is determined according to the value of the contentType property:
+
+- If contentType=GlobalSearchResultItem.CONTENT\_DVBEVENT, then return DvbEvent object;
+- If contentType=GlobalSearchResultItem.CONTENT\_PVREVENT, then return the PVREvent object;
+
+### U.5.9 SearchHistoryItem object
+
+The SearchHistoryItem object describes a search history record and provides methods to obtain various information about the search history record.
+
+#### U.5.9.1 Method
+
+##### U.5.9.1.1 getContentType
+
+Prototype: number getContentType()
+
+Description: Getting the content type of this search history record.
+
+Parameter: None.
+
+Return: number type, indicating the content type of the search history record.
+
+##### U.5.9.1.2 getCriteriaFlags
+
+Prototype: number getCriteriaFlags()
+
+Description: Getting the filter character of the search history record.
+
+Parameter: None.
+
+Return: number type, indicating the filter condition of the search history record.
+
+##### U.5.9.1.3 getSearchField
+
+Prototype: number getSearchField()
+
+Description: Getting the search field of this search history record.
+
+Parameter: None.
+
+Return: number type, indicating the search field of the search history record.
+
+#### **U.5.9.1.4 getSearchString**
+
+Prototype: string getSearchString()
+
+Description: Getting the search keyword character string of the search history record.
+
+Parameter: None.
+
+Return: string type, indicating the search keyword character string entered by the user.
+
+#### **U.5.9.1.5 getSortCriteria**
+
+Prototype: SortCriteria getSortCriteria()
+
+Description: Getting the sorting information of the search record.
+
+Parameter: None.
+
+Return: SortCriteria object, indicating the sorting method and sorting basis of the search results.
+
+#### **U.5.9.1.6 getSource**
+
+Prototype: number getSource()
+
+Description: Getting the search source of this search history record.
+
+Parameter: None.
+
+Return: number type, indicating the search source.
+
+## Annex V
+
+### JavaScript-Broadcast Information Service Management Unit
+
+(This annex forms an integral part of this Recommendation.)
+
+#### V.1 Overview
+
+This annex defines the relevant JavaScript interface of the broadcast information service management unit.
+
+#### V.2 Broadcast information service management module
+
+This module defines JS objects related to broadcast information service management: DthManager, Ad, AdService.
+
+##### V.2.1 Message
+
+The message definition of the broadcast information service management module is shown in Table V.1.
+
+**Table V.1 – Broadcast Information service management module message definition**
+
+| Message name | event.which | event.modifiers | Message description |
+|--------------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| DTH_EVENT_EMBD_TRIG | 15001 | number | Emergency broadcast event trigger event, the message character string JSON format is:{ "service_id":param1 Note 1 ,
"ts_id":param2 Note 2 ,
"orig_net_id":param3 Note 3 } | +| DTH_EVENT_EMBD_CANCEL | 15002 | – | Emergency broadcast event cancel event. | +| DTH_EVENT_OSD_UPDATE | 15003 | number | Prompt application, there is a new OSD prompt message | +| DTH_EVENT_SERVICE_UPDATE | 15004 | number, a parameter of 0 indicates that the program does not need to be updated immediately, a parameter of 1 indicates that the program information is forced to be updated | NIT service update | +| DTH_EVENT_RESET_DATA | 15005 | When the parameter is 01, the set-top box data is required to be erased immediately (dth processing, | Erase messages reported by the data | + +**Table V.1 – Broadcast Information service management module message definition** + +| Message name | event.which | event.modifiers | Message description | +|-----------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------| +| | | just reporting a message to the application), when the parameter is 0, it indicates that the state of erasing the set-top box is restored to the normal state. | | +| DTH_EVENT_GPRS_SEND_STATUS | 15006 | A message of 01 indicates a successful sending, and a message of 00 indicates a failed sending | Determining whether the data is sent successfully | +| DTH_EVENT_BOUQUET_ID_UPDATE | 15007 | number | Bouquet id update message | +| DTH_EVENT_UPGRADE_TRIG | 15008 | A message of 01 indicates a mandatory upgrade, and a message of 00 indicates a non-mandatory upgrade | Software upgrade message | +| DTH_EVENT_FINGERPRINT_TRIG | 15009 | number | Fingerprint trigger event. Note 4 | +| DTH_EVENT_GPRS_STATUS | 15010 | number | Current available status. Note 5 | +| DTH_EVENT_GPRS_BASE_STATION | 15011 | number | GPRS current base station information. Note 6 | +| Reserved | 15012–15100 | – | | + +The value of event.modifiers is automatically given by the system, and its data type: + +- "number", indicating that the value is the ID of the message description character string, which can be obtained through the Utility.getEventInfo() method. If the "message description" defines the message character string JSON format, the message content will be retrieved according to the format. +- "-", indicating event.modifiers is undefined. + +NOTE 1 – param1: number type, program service ID; + +NOTE 2 – param2: number type, transport stream ID. + +NOTE 3 – param3: number type, network ID. + +NOTE 4 – Fingerprint trigger event, the message character string JSON format is: { + +char\_color: number //Text color + +reg\_highlight: number //Background area height + +reg\_width: number //Background area width + +reg\_color: number //Background area color + +X\_Reg\_Offset: number // Background area x coordinate + +**Table V.1 – Broadcast Information service management module message definition** + +| Message name | event.which | event.modifiers | Message description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Y_Reg_Offset: number // Background area y coordinate
X_Text_Offset: number // Text x coordinate
Y_Text_Offset: number // Text y coordinate
Duration: number //duration
fs_text: String //Text content
};
NOTE 5 – Currently available status: {
0, //Module is normal and currently available
-1, //Module is being initialized
-2, //Module SIM is abnormal
-3, //Module network is abnormal
-4, //Module is in a busy status, and need to be obtained later.
-5, //No response from the module
-6, //Other errors
} | | | NOTE 6 – Base station information report event, the JSON format contained in the array is: [{
LAC:number /*location area code location area code*/
Cell_ID:number /* Cell (base station) number*/
Bsic_ID:number /* Base station identification code (C network)*/
ucMNC:number /* Network number*/
strength:number /*Signal strength*/
},
...
] | + +## V.2.2 DthManager object + +DthManager object is a built-in object that provides management methods for DTH components. + +### V.2.2.1 Method + +#### V.2.2.1.1 startServer + +Prototype: number startServer() + +Description: The DTH component is called in the live broadcast star application. The server side of the DTH component is started. You need to wait for the live broadcast star application to start before calling this interface to start each function of the DTH component. + +Parameter: None. + +Return: number type, value: 0: indicating success. Non-0: indicating failure. + +#### V.2.2.1.2 stopServer + +Prototype: number stopServer() + +Description: After the live broadcast star application exits, call this interface to stop each function of the DTH component. + +Parameter: None. + +Return: number type, value: 0: indicating success. Non-0: indicating failure. + +### **V.2.2.1.3 getADFinishStatus** + +Prototype: number getADFinishStatus() + +Description: Obtain the processing status of the boot advertisement, that is, obtain whether the advertisement is ready. + +Parameter: None. + +Return: number type, value: 1 indicating processing is completed and the application can work normally, 0 indicating processing is in progress, and the application needs to continue to wait. + +### **V.2.2.1.4 getAllAds** + +Prototype: Ad[] getAllAds(epgInfoType,serviceid) + +Description: Getting the advertisement image information object. + +Parameter: epgInfoType – number type, indicating various types of advertising space, defined as follows: + +``` +enum { + EPGINFO_TYPE_EPG_CONFIG_DATA = 0xF0F0, + EPGINFO_TYPE_BOOTLOGO = 1, + EPGINFO_TYPE_MAINMENU, + EPGINFO_TYPE_CHANNEL_LIST, + EPGINFO_TYPE_FAV_CHANNEL_LIST, + EPGINFO_TYPE_EPG_LIST, + EPGINFO_TYPE_PFBAR, + EPGINFO_TYPE_VOLUMEBAR, + EPGINFO_TYPE_AUDIOLOGO, + EPGINFO_TYPE_ERROR, +}; + +serviceid – number type, when it is EPGINFO_TYPE_PFBAR or +EPGINFO_TYPE_VOLUMEBAR, serviceid is the serviceid of the channel corresponding +to the advertisement, otherwise it is 0. +``` + +Return: Array of Ad objects. + +### **V.2.2.1.5 getOsdXmlFile** + +Prototype: String getOsdXmlFile() + +Description: Getting the save address of the XML file updated by OSD text. + +Parameter: None. + +Return: String type, the storage location of the XML file updated by OSD text in the box. + +### **V.2.2.1.6 getOsdInfo** + +Prototype: String getOsdInfo(tag) + +Description: Obtain osd event message that needs to be displayed. + +Parameter: tag – String type. It is the prompt message code corresponding to osd. + +Return: String type, returning the corresponding osd event message. + +#### **V.2.2.1.7 startAdPCT** + +Prototype: number startAdPCT(transport\_stream\_id) + +Description: Getting the first picture of the boot advertisement. Real-time ad filtering for a certain tp should be turned on instead. + +Parameter: transport\_stream\_id – number type, transport stream id. + +Return: number type, value: 0 indicating successful acquisition, non-0 indicating failed acquisition, and the application displaying the default picture. + +#### **V.2.2.1.8 stopEMBDAction** + +Prototype: number stopEMBDAction() + +Description: The live broadcast star receives the event information of canceling the emergency broadcast, and calls this interface to make the DTH component stop sending the current emergency broadcast. + +Parameter: None. + +Return: number type, value: 0: successful operation, non-0: failed operation. + +#### **V.2.2.1.9 recordAVBEvent** + +Prototype: recordAVBEvent(event\_id, event\_param) + +Description: Detect user events and save them. + +Parameter: event\_id – number type, event number; + +event\_param – number type, setting the event parameters according to the event number. + +Return: None. + +#### **V.2.2.1.10 dataBDStart** + +Prototype: number dataBDStart(file\_path) + +Description: Provide the storage path of the information service file, and start the information service receiving. + +Parameter: file\_path – String type, the storage path of the message service file. If the parameter is empty, the default path is /data/db/dth/datadb. + +Return: number type, value: 0: successful operation, non-0: failed operation. + +#### **V.2.2.1.11 dataBDStop** + +Prototype: number dataBDStop() + +Description: Suspension of message service receiving. + +Parameter: None. + +Return: number type, value: 0: successful operation, non-0: failed operation. + +#### **V.2.2.1.12 getDATABDFinishPercent** + +Prototype: number getDATABDFinishPercent() + +Description: Getting the percentage of download completion. + +Parameter: None. + +Return: number type, value: 0-100: percentage of download completion, other values: failed operation. + +#### **V.2.2.1.13 getDataBDXmlFileData** + +Prototype: String getDataBDXmlFileData(file\_name) + +Description: Obtain the corresponding message service data. + +Parameter: file\_name – String type, the file name of the message service file. If the parameter is empty, the default path is /data/db/dth/datadb. + +Return: String type, returning the corresponding message service data. + +#### **V.2.2.1.14 GPRSTransmit** + +Prototype: String GPRSTransmit(conn\_type, addr, port, data, timeout, retry\_count) + +Description: Sending data through GPRS module and receive returned data. (Asynchronous interface) + +Parameter: conn\_type – number type, the type of GPRS connection server is 0 or 1, 0: TCP; 1: UDP; addr – String type, the domain name or IP address of the server; + +port – number type, the port number of the server; + +data – String type, transmitted data; + +timeout – number type, the timeout period for waiting for the return of transmission data; + +retry\_count – number type, the number of retries for transmission failure. + +Return: String type: If it is empty, it indicates failure, and if it is not empty, it indicates the data returned by the receiving module. + +#### **V.2.2.1.15 getGPRSStatus** + +Prototype: number getGPRSStatus() + +Description: Getting whether GPRS is currently in a normal available state. + +Parameter: None. + +Return: number type, value: 0: GPRS status is normal, non-0: GPRS status is abnormal. + +#### **V.2.2.1.16 getGprsBaseStationInfo** + +Prototype: number getGprsBaseStationInfo() + +Description: Asynchronous interface, obtains current base station information. + +Parameter: None. + +Return: 0 indicating success, others indicating failure. + +#### **V.2.2.1.17 SaveNITServiceUpdateVersion** + +Prototype: number SaveNITServiceUpdateVersion() + +Description: After the application updates the program information, notify dth to save the current service update descriptor version. + +Parameter: None. + +Return: number type, value: 0: successful save, non-0: failed save. + +#### **V.2.2.1.18 GetBouquetId** + +Prototype: number GetBouquetId() + +Description: Getting the current bouquet id. + +Parameter: None. + +Return: number type, the current bouquetid. + +#### **V.2.2.1.19 SaveNITServiceUpdateVersion** + +Prototype: number SaveNITServiceUpdateVersion() + +Description: After the application updates the program information, notify dth to save the current service update descriptor version. + +Parameter: None. + +Return: number type, 0 indicating success, others indicating failure. + +#### **V.2.2.1.20 dataBDdeleteFiles** + +Prototype: number dataBDdeleteFiles() + +Description: Delete all downloaded information service files (called when exiting the information service). + +Parameter: None. + +Return value: number type, 0 indicating success, others indicating failure. + +### **V.2.3 Ad object** + +#### **V.2.3.1 Property** + +The property definition of the Ad object is shown in Table V.2. + +**Table V.2 – Ad object properties** + +| Property name | Type | Read and write property | Description | +|----------------------|-------------|--------------------------------|-------------------------------------------------------------------------------------------| +| adPath | string | Read only | It indicates the storage address of the advertisement. | +| startDate | string | Read only | It indicates the start date of playing for the advertisement, the format is "YYYY-MM-DD". | +| startTime | string | Read only | It indicates the start time of playing for the advertisement, the format is "hh:mm:ss". | +| endDate | string | Read only | It indicates the end date of playing for the advertisement, the format is "YYYY-MM-DD". | +| endTime | string | Read only | It indicates the ending time of playing for the advertisement, the format is "hh:mm:ss". | +| Property name | Type | Read and write property | Description | +| duration | number | Read only | It indicates the playing time of the advertisement, in seconds. | +| tableExtId | number | Read only | It indicates the type of program-associated advertisement of the advertisement. | + +#### **V.2.3.2 Method** + +##### **V.2.3.2.1 getAllAdServices** + +Prototype: AdService[] getAllAdServices() + +Description: Getting all relevant channel parameters and AdService objects of channel-related advertisements. + +Parameter: None. + +Return value: AdService object array. + +## V.2.4 AdService object + +### V.2.4.1 Property + +The property definition of the AdService object is shown in Table V.3. + +**Table V.3 – AdService object properties** + +| Property name | Type | Read and write property | Description | +|---------------|--------|-------------------------|----------------------------------------------------------------------| +| onId | number | Read only | It indicates the onid of the channel-related advertisement. | +| tdId | number | Read only | It indicates the tdId of the channel-related advertisement. | +| serviceId | number | Read only | It indicates the serviceId of the channel-related advertisement. | +| associateType | number | Read only | It indicates the associateType of the channel-related advertisement. | + +## Annex W + +### JavaScript-Multi-screen Interactive Unit + +(This annex forms an integral part of this Recommendation.) + +#### W.1 Overview + +This annex defines the JavaScript interface related to the multi-screen interactive unit. + +##### W.1.1 Scene description + +1. There are currently two playback devices of TVOS system, namely A and B, and both A and B systems are connected to the same LAN. +2. The application program of A system uses the startMultiScreenServer method to start the multi-terminal linkage service through the MultiScreen multi-terminal linkage communication object provided by the A system, and transmits the multi-terminal linkage component message of the B system to the A system. +3. Then the application uses the findSPs method to search for the B system equipment under the same LAN, and realizes the connection with the B system through the A system through the connect method. +4. After the connection is successful, the A system program receives the connection status information through the MultiScreenEvent interface provided by the B system, and informs the A system of the connection status by the onConnected method. So far, the A and B systems have realized multi-terminal linkage communication. The application can pass the operation data information of the A system or more video data information to the B system by the inputKeyCode provided by the MultiScreen object, and realize the related operation and playback on the B system. + +#### W.2 Multi-screen interactive module + +This module supports finding and connection between the client and server in the LAN. The multi-screen interactive component provides a JavaScript interface for the upper application of the Web APP, which can realize the functions of the WEB application in the LAN to find, connect, and control the server equipment. + +This module defines the JS object related to multi-screen interaction: MultiScreen. + +##### W.2.1 MultiScreen object + +###### W.2.1.1 Method + +###### W.2.1.1.1 startMultiScreenServer + +Prototype: int startMultiScreenServer (String spName, String spDeviceType, String spServiceInfo, String spVersion, String ipaddress, int port, String hostname) + +Description: A Remote interface, starting multi-screen interactive component server. + +Parameter: + +spName – String type, name of multi-screen interactive component server; + +spDeviceType – String type, device type of the multi-screen interactive component server; + +spServiceInfo – String type, service information of multi-screen interactive component server; + +spVersion – String type, version of multi-screen interactive component server; + +ipaddress – String type, ip address of the searched multi-screen interactive component device; + +port – int type, port number of the searched multi-screen interactive component device; + +hostname – String type, host name of the searched multi-screen interactive component device. + +Return: int type, returning 0 if the remote interface is called successfully, otherwise returning an error code. + +#### **W.2.1.1.2 stopMultiScreenServer** + +Prototype: int stopMultiScreenServer() + +Description: A Remote interface, stoping multi-screen interactive component server. + +Parameter: None. + +Return: int type, returning 0 if the remote interface is called successfully, otherwise returning an error code. + +#### **W.2.1.1.3 startMultiScreenClient** + +Prototype: int startMultiScreenClient(String clientName) + +Description: A Remote interface, starting multi-screen interactive component client. + +Parameter: clientName – String type, name of the multi-screen interactive component client. + +Return: int type, returning 0 if the remote interface is called successfully, otherwise returning an error code. + +#### **W.2.1.1.4 stopMultiScreenClient** + +Prototype: int stopMultiScreenClient() + +Description: A Remote interface, closing the multi-screen interactive component client. + +Parameter: None. + +Return: int type, returning 0 if the remote interface is called successfully, otherwise returning an error code. + +#### **W.2.1.1.5 findSPs** + +Prototype: int findSPs() + +Description: A Remote interface, searching the multi-screen interactive service component device under the LAN. + +Parameter: None. + +Return: int type, returning 0 if the remote interface is called successfully, otherwise returning an error code. + +#### **W.2.1.1.6 connect** + +Prototype: int connect(String spName, String spDeviceType, String spServiceInfo, String spVersion, String ipaddress, int port, String hostname) + +Description: remote interface, which is connected to the server device of the multi-screen interactive service component under the LAN. + +Parameter: spName – String type, name of multi-screen interactive component server; + +spDeviceType – String type, device type of the multi-screen interactive component server; + +spServiceInfo – String type, service information of multi-screen interactive component server; + +spVersion – String type, version of multi-screen interactive component server; + +ipaddress – String type, ip address of the searched multi-screen interactive component device; + +port – int type, port number of the searched multi-screen interactive component device; + +hostname – String type, host name of the searched multi-screen interactive component device. + +Return: int type, returning 0 if the remote interface is called successfully, otherwise returning an error code. + +#### **W.2.1.1.7 queryInfo** + +Prototype: int queryInfo(String ipaddress, int port, String hostname, String cmdid, String attribute, String params) + +Description: Remote interface, the multi-screen interactive component client requests to obtain it. + +Parameter: ipaddress – String type, ip address of the searched multi-screen interactive component device; + +port – int type, port number of the searched multi-screen interactive component device; + +hostname – String type, host name of the searched multi-screen interactive component device; + +cmdid – String type, instruction id of the request information; + +attribute – String type, instruction name of the request information; + +params – String type, instruction parameter of the request information. + +Return: int type, returning 0 if the remote interface is called successfully, otherwise returning an error code. + +#### **W.2.1.1.8 execCmd** + +Prototype: int execCmd(String ipaddress, int port, String hostname, String cmd, String param) + +Description: Remote interface, the multi-screen interactive component client requests to execute instructions. + +Parameter: ipaddress – String type, ip address of the searched multi-screen interactive component device; + +port – int type, port number of the searched multi-screen interactive component device; + +hostname – String type, host name of the searched multi-screen interactive component device; + +action – String type, key instruction; + +param – String type, parameter attached to the key instruction. + +Return: int type, returning 0 if the remote interface is called successfully, otherwise returning an error code. + +#### **W.2.1.1.9 inputKeyCode** + +Prototype: int inputKeyCode(String ipaddress, int port, String hostname, String action, String param) + +Description: Remote interface, the multi-screen interactive component client sends instructions input by virtual keys. + +Parameter: ipaddress – String type, ip address of the searched multi-screen interactive component device; + +port – int type, port number of the searched multi-screen interactive component device; + +hostname – String type, host name of the searched multi-screen interactive component device; + +action – String type, key instruction; + +param – String type, parameters attached to the key instruction. + +Return: int type, returning 0 if the remote interface is called successfully, otherwise returning an error code. + +#### **W.2.1.1.10 boardCastAllDevice** + +Prototype: int boardCastAllDevice(String cmd,String param) + +Description: Remote interface, the multi-screen interactive component server sends broadcast to all connected devices. + +Parameter: cmd – String type, broadcast instruction; + +param – String type, parameters attached to the broadcast instruction; + +Return: int type, returning 0 if the remote interface is called successfully, otherwise returning an error code. + +### **W.2.2 Message callback EventHandler** + +``` +interface MultiScreenEvent : Event { + readonly attribute String spName; + readonly attribute String spDeviceType; + readonly attribute String spServiceInfo; + readonly attribute String spVersion; + readonly attribute String ipaddress; + readonly attribute int port; + readonly attribute String hostname; + readonly attribute String id; + readonly attribute String attribute; + readonly attribute String param; + readonly attribute String action; + readonly attribute String cmd; +}; +``` + +#### **W.2.2.1 Method** + +##### **W.2.2.1.1 onSpFounded** + +Prototype: [RuntimeEnabled=MultiScreenEvent]EventHandler onSpFounded + +Description: Notifying the Web APP multi-screen interactive component that the service search is completed. + +Parameter: spName – String type, service name of the searched multi-screen interactive component; + +spDeviceType – String type, device type of the searched multi-screen interactive component; + +spServiceInfo – String type, server information of the searched multi-screen interactive component; + +spVersion – String type, server service version of the searched multi-screen interactive component; + +ipaddress – String type, ip address of the searched multi-screen interactive component device; + +port – int type, port number of the searched multi-screen interactive component device; + +hostname – String type, host name of the searched multi-screen interactive component device. + +#### **W.2.2.1.2 onConnected** + +Prototype: [RuntimeEnabled=MultiScreenEvent] EventHandler onConnected + +Description: Notifying the Web APP multi-screen interactive component that the service connection is completed. + +Parameter: spName – String type, service name of the searched multi-screen interactive component; +spDeviceType – String type, device type of the searched multi-screen interactive component; +spServiceInfo – String type, server information of the searched multi-screen interactive component; +spVersion – String type, server service version of the searched multi-screen interactive component; +ipaddress – String type, ip address of the searched multi-screen interactive component device; +port – int type, port number of the searched multi-screen interactive component device; +hostname – String type, host name of the searched multi-screen interactive component device. + +#### **W.2.2.1.3 onConnectRefused** + +Prototype: [RuntimeEnabled=MultiScreenEvent] EventHandler onConnectRefused + +Description: Notifying the Web APP multi-screen interactive component that the service connection is refused. + +Parameter: spName – String type, service name of the searched multi-screen interactive component; +spDeviceType – String type, device type of the searched multi-screen interactive component; +spServiceInfo – String type, server information of the searched multi-screen interactive component; +spVersion – String type, service version of the searched multi-screen interactive component server; +ipaddress – String type, ip address of the searched multi-screen interactive component device; +port – int type, port number of the searched multi-screen interactive component device; +hostname – String type, host name of the searched multi-screen interactive component device. + +#### **W.2.2.1.4 onDisconnected** + +Prototype: [RuntimeEnabled=MultiScreenEvent] EventHandler onConnectRefused + +Description: Notifying the Web APP multi-screen interactive component that the service connection is refused. + +Parameter: spName – String type, service name of the searched multi-screen interactive component; +spDeviceType – String type, device type of the searched multi-screen interactive component; +spServiceInfo – String type, server information of the searched multi-screen interactive component; +spVersion – String type, service version of the searched multi-screen interactive component server; +ipaddress – String type, ip address of the searched multi-screen interactive component device; +port – int type, port number of the searched multi-screen interactive component device; +hostname – String type, host name of the searched multi-screen interactive component device. + +#### **W.2.2.1.5 onServiceActivited** + +Prototype: [RuntimeEnabled=MultiScreenEvent] EventHandler onServiceActivited + +Description: Notifying the Web APP multi-screen interactive component that the service is activated. + +Parameter: ipaddress – String type, ip address of the searched multi-screen interactive component device; + +port – int type, port number of the searched multi-screen interactive component device; +hostname – String type, host name of the searched multi-screen interactive component device. + +#### **W.2.2.1.6 onServiceDeactivated** + +Prototype: [RuntimeEnabled=MultiScreenEvent] EventHandler onServiceDeactivated + +Description: Notifying the Web APP multi-screen interactive component that the service is unregistered. + +Parameter: ipaddress – String type, ip address of the searched multi-screen interactive component device; + +port – int type, port number of the searched multi-screen interactive component device; + +hostname – String type, host name of the searched multi-screen interactive component device. + +#### **W.2.2.1.7 onQueryInfo** + +Prototype: [RuntimeEnabled=MultiScreenEvent] EventHandler onQueryInfo + +Description: Notifying the Web APP that the data request sent by the client of the multi-screen interactive component has been received. + +Parameter: ipaddress – String type, ip address of the searched multi-screen interactive component device; + +port – int type, port number of the searched multi-screen interactive component device; + +hostname – String type, host name of the searched multi-screen interactive component device; + +id – String type, instruction id of the received request; + +attribute – String type, instruction property of the received request; + +param – String type, parameters attached to the received request. + +#### **W.2.2.1.8 onQueryResponse** + +Prototype: [RuntimeEnabled=MultiScreenEvent] EventHandler onQueryResponse + +Description: Notifying the Web APP that the multi-screen interactive component server has responded to the data request. + +Parameter: ipaddress – String type, ip address of the searched multi-screen interactive component device; + +port – int type, port number of the searched multi-screen interactive component device; + +hostname – String type, host name of the searched multi-screen interactive component device; + +id – String type, instruction id of the received request; + +attribute – String type, instruction property of the received request; + +param – String type, parameters attached to the received request. + +#### **W.2.2.1.9 onExecute** + +Prototype: [RuntimeEnabled=MultiScreenEvent] EventHandler onExecute + +Description: Notifying the Web APP that the client of the multi-screen interactive component has sent an execution instruction request. + +Parameter: ipaddress – String type, ip address of the searched multi-screen interactive component device; + +port – int type, port number of the searched multi-screen interactive component device; + +hostname – String type, host name of the searched multi-screen interactive component device; + +cmd – String type, instructions executed; + +param – String type, parameters attached to the instruction executed. + +#### **W.2.2.1.10 onInputKeyCode** + +Prototype: [RuntimeEnabled=MultiScreenEvent] EventHandler onInputKeyCode + +Description: Notifying the Web APP that the client of the multi-screen interactive component has sent a request to perform key injection. + +Parameter: ipaddress – String type, ip address of the searched multi-screen interactive component device; + +port – int type, port number of the searched multi-screen interactive component device; + +hostname – String type, host name of the searched multi-screen interactive component device; + +cmd – String type, instructions executed; + +param – String type, executing the parameters attached to the instruction. + +#### **W.2.2.1.11 onNotify** + +Prototype: [RuntimeEnabled=MultiScreenEvent] EventHandler onNotify + +Description: Notifying the Web APP that the multi-screen interactive component has received a notification. + +Parameter: ipaddress – String type, ip address of the searched multi-screen interactive component device; + +port – int type, port number of the searched multi-screen interactive component device; + +hostname – String type, host name of the searched multi-screen interactive component device; + +cmd – String type, received instruction; + +param – String type, instruction parameter received. + +## Annex X + +### JavaScript-DRM management unit + +(This annex forms an integral part of this Recommendation.) + +#### X.1 Overview + +This specification defines JavaScript interfaces of the DRM management module. + +#### X.2 DRM management module + +##### X.2.1 DrmManager object + +Example of using DrmManager object: + +``` +var drmManager=new DrmManager();//create DrmManager object +var uuid=new String("2d7d041436f2a048a0c4c1ccbb64546"); +drmManager.Drm_RegisterApp("unitend",uuid, 0, register_pridata,"unitend",1,0,0);//DRM +APP register +var resultdata=drmManager.Drm_SendCommandToTA(1,"unitend");//send commands to TEE +drmManager.Drm_UnRegisterApp();//unregister DRM APP +``` + +##### X.2.1.1 Message + +The message definition sent by the DRM module to the application layer is shown in Table X.1. + +**Table X.1 – DRM module message definition** + +| Message name | event. which | event. modifiers | Message description | +|--------------------|--------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MSG_DRM_LICENSEREQ | 11000 | number | DRM license acquisition message, message character string JSON format: {"DrmLicenseReqData":param1, "DrmLicenseDataLen":param2}. Among them, param1 is the data related to obtaining the license; param2 is the length of the data related to obtaining the license. | +| MSG_DRM_DECRYPTREQ | 11001 | number | DRM decrypt message, message character string JSON format {"DrmDecryptReqData":param1, "DrmDecryptReqDataLen": param2}. Among them, param1 is the relevant data used to decrypt the stream; param2 is the length of the relevant data used to decrypt the stream. | +| MSG_DRM_MESSAGE | 11002 | number | DRM notification message, message character string JSON format: {"DrmMessageType":param1, "DrmMessage":param2, "DrmMessageLen": param3}. Among them, param1 is the type of notification message; param2 is the data transmitted by the notification message; param3 is the length of the data transmitted by the notification message. | + +### **X.2.1.2 Method** + +#### **X.2.1.2.1 Drm\_RegisterApp** + +Prototype: number Drm\_RegisterApp (DrmSystemID, TAUUID register\_commandid,register\_pridata,enflag,licensereq\_commandId,decrypt\_commandId) + +Description: DRM APP registration extension, licensereq and decrypt command ID can be privately defined. + +Parameter: DrmSystemID – string type, indicating the unique identifier of DRM APP; + +TAUUID – string type, indicating the unique identifier of the TApp corresponding to the DRM APP; register\_commandid – number type, indicating the registered commandid for communication with TApp; + +register\_pridata – string type, indicating the private registration data carried by the registration of communication with TApp, which is used for TApp to verify the legality of DRM APP; + +enflag – number type, indicating a decryption call method; + +licensereq\_commandId – number type, indicating the commandid corresponding to the query license; + +decrypt\_commandId – number type, indicating the commandid corresponding to the decrypt data. + +Return: number type, 0 indicating success, non-0 indicating failure. + +#### **X.2.1.2.2 Drm\_UnRegisterApp** + +Prototype: number Drm\_UnRegisterApp() + +Description: DRM APP unregistration. + +Parameter: None. + +Return: number type, 0 indicating success, non-0 indicating failure. + +#### **X.2.1.2.3 Drm\_SendCommandToTA** + +Prototype: string Drm\_SendCommandToTA(commandId, sendData) + +Description: Send commands to TEE. + +Parameter: commandId – string type, indicating the command ID; + +sendData – string type, indicating the data sent. + +Return: string type, returning the TEE processing result in JSON format. + +#### **X.2.1.2.4 Drm\_SendMessageToPlayer** + +Prototype: number Drm\_SendMessageToPlayer(type,message) + +Description: Send a message to the player. + +Parameter: type – number type, indicating the message type; + +Message – string type, indicating message data. + +Return: number type, 0 indicating success, non-0 indicating failure. + +## Annex Y + +### JavaScript-DCAS management unit + +(This annex forms an integral part of this Recommendation.) + +#### Y.1 Overview + +This annex defines the functional modules related to DCAS management. DCAS client software and application software can be developed through the DCAS JavaScript application programming interface. + +#### Y.2 EPG DCAS module + +This module defines the DCAS module and EPG-related JavaScript objects: EPG\_DCAS object. + +##### Y.2.1 EPG\_DCAS object + +The EPG\_DCAS object is a built-in object, which provides the JavaScript method of the EPG\_DCAS module. + +###### Y.2.1.1 Method + +###### Y.2.1.1.1 getActivationStatus + +Prototype: number getActivationStatus() + +Description: Getting the activation status. + +Parameter: None. + +Return: number type, value: 0-indicating it has been activated. Non-0 indicating that the status is unknown. + +###### Y.2.1.1.2 getBeidouInfo + +Prototype: string getBeidouInfo() + +Description: Getting current Beidou information. + +Parameter: None. + +Return: String type, the current Beidou information, the character string JSON format is: + +``` +{ + "islocked":param1, + "latitude":param2, + "longitude":param3 + "sat num":param4 + "SNR":param5 +} +``` + +###### Y.2.1.1.3 getCASVersion + +Prototype: string getCASVersion() + +Description: Getting CAS version information. + +Parameter: None. + +Return: String type, value: if it is empty, it indicates that the CAS version information is not obtained, and if it is not empty, it indicates that the CAS version information is received. + +#### **Y.2.1.1.4 getCASVendorId** + +Prototype: number getCASVendorId() + +Description: Getting the current CAS vendor ID. + +Parameter: None. + +Return: number type, value: 0 indicating that the current CAS vendor ID is not obtained, and non-0 indicating that the current CAS vendor ID is obtained. + +#### **Y.2.1.1.5 getChipID** + +Prototype: string getChipID() + +Description: Getting the chip ID. + +Parameter: None. + +Return: String type, value: if it is empty, it indicates that the chip ID is not obtained, and if it is not empty, it indicates that the chip ID is obtained. + +#### **Y.2.1.1.6 getHSMID** + +Prototype: string getHSMID() + +Description: Getting the HSM chip ID. + +Parameter: None. + +Return: String type, value: if it is empty, it indicates that the HSM chip ID is not obtained, and if it is not empty, it indicates that the HSM chip ID is obtained. + +#### **Y.2.1.1.7 getValidPosition** + +Prototype: string getValidPosition() + +Description: Getting valid location information allowed by the current set-top box. + +Parameter: None. + +Return: String type, value: if it is empty, it indicates that no valid location information is obtained, and if it is not empty, it indicates that valid location information is obtained. The return value is in JSON format: + +``` +{ + "latitude":param1, + "longitude":param2 +} +``` + +#### **Y.2.1.1.8 getPersonalBits** + +Prototype: number getPersonalBits() + +Description: Getting regional personal Bits. + +Parameter: None. + +Return: number type, value: 0 indicating that the regional personal Bits are not obtained, and non-0 indicating that the regional personal Bits are obtained. + +#### Y.2.1.1.9 getZipCode + +Prototype: string getZipCode() + +Description: Getting the region code. + +Parameter: None. + +Return: String type, value: if it is empty, it indicates the area code is not obtained, and if it is not empty, it indicates the area code is obtained. + +### Y.3 DCAS\_APP module + +See Table Y.1 for the description of DCAS\_APP module objects. + +**Table Y.1 – Object description of DCAS\_APP module** + +| Object name | Description | +|-------------------------|----------------------------------------------------------------------------------------------------------------| +| JSDCAS.CASDescriptor | CA description object, this object is used to express the CA descriptor in PMT or CAT. | +| JSDCAS.CASEcmEvent | ECM event object, this object contains information about ECM events. | +| JSDCAS.CASEmmEvent | ECM event object, this object contains information about EMM events. | +| JSDCAS.CASFilter | Filter object, this object expresses the filter conditions required when filtering in-band or out-of-band EMM. | +| JSDCAS.CASM | The global object of CASM, from which you can access the CAS manager and controller objects. | +| JSDCAS.CASModule | CAS module object interface, implemented by the JS DCAS application, is an interface provided to the platform. | +| JSDCAS.CASModuleManager | CASModuleManager object, this object provides the interface required by JSDCAS application. | +| JSDCAS.CASPacketEvent | CAS data packet event object notifies the JS DCAS application of out-of-band CAS data packet events. | +| JSDCAS.CASSession | CAS Sesion object, the platform generates a CAS Session object for each descrambling request. | +| JSDCAS.CASStatus | CAS status object, through this object, JSDCAS transfers the descrambling status to the platform. | +| JSDCAS.TeeController | TEE control right object, controller for JS DCAS and TEE communication. | +| JSDCAS.TeeRetVal | TEE return object, the object contains data, errors and other information returned from TEE. | + +#### Y.3.1 Application interface call time sequence + +The basic time sequence of the DCAS application interface is shown in Figure Y.1. + + + +``` + +sequenceDiagram + participant Media + participant DCAS App + participant DCAS manager + participant DTV + participant DCAS TApp + + DCAS App->>DCAS manager: registerCASModule + DCAS App->>DCAS manager: enableDescramblingRequests + Media->>DCAS manager: DCASAL_stopDescrambling + DCAS manager-->>DCAS App: onStopDescrambling + Media->>DCAS manager: DCASAL_startDescrambling + DCAS manager-->>DCAS App: onStartDescrambling + DCAS App->>DCAS manager: startEcmLoading + DCAS manager->>DTV: DTVAL_startFiltering + DTV-->>DCAS manager: ECM filtered + DCAS manager-->>DCAS App: onEcmEvent + DCAS App->>DCAS manager: sendCommandToTEE + DCAS manager->>DCAS TApp: TEE_Client_API + DCAS TApp->>DCAS TApp: loadCW + DCAS TApp-->>DCAS manager: Return data + DCAS manager-->>DCAS App: Return data + DCAS App->>DCAS manager: sendDescramblingEvent + DCAS manager-->>Media: sendCASEvent + +``` + +J.1206(23) + +Sequence diagram showing the basic call time sequence of DCAS application interface. Lifelines: Media, DCAS App, DCAS manager, DTV, DCAS TApp. The sequence involves registration, enabling requests, stopping/starting descrambling, loading ECM, filtering, and returning data. + +**Figure Y.1 – Basic call time sequence of DCAS application interface** + +### Y.3.2 JSDCAS.CASDescriptor object + +This object is used to express the CA descriptor in PMT or CAT. + +#### Y.3.2.1 Method + +##### Y.3.2.1.1 getCasId + +Prototype: number getCasId() + +Description: This method is provided by the terminal software platform and returns the CASID in the CA descriptor. + +Parameter: None. + +Return: number type, indicating CASID. + +##### Y.3.2.1.2 getPid + +Prototype: number getPid() + +Description: Returning PID in the CA descriptor. If the descriptor comes from CAT, it indicates EMM PID. If the descriptor comes from PMT, it indicates ECM PID. + +Parameter: None. + +Return: number type, return ECMPID. + +##### Y.3.2.1.3 getPrivateData + +Prototype: Uint8Array getPrivateData() + +Description: Returning the private data in the CA descriptor, and the private data is returned in the form of Uint8Array. + +Parameter: None. + +Return: Uint8Array type, indicating private data. + +### **Y.3.3 JSDCAS.CASEcmEvent object** + +This object contains information about ECM events, which are passed to the JS DCAS application through CASModule.onEcmEvent or CASModuleManager.onStartDescrambling. It can express that ECM packet is received, or timed out, or an internal error in the filter. + +#### **Y.3.3.1 Method** + +##### **Y.3.3.1.1 getEcmData** + +Prototype: Uint8Array getEcmData() + +Description: Returning complete ECM data. If it is a timeout or an internal error for the event, null is returned. + +Parameter: None. + +Return: Uint8Array type, indicating ECM data. + +##### **Y.3.3.1.2 getError** + +Prototype: number getError() + +Description: Error when returning the internal Section Filter filter. Only used for debugging. This method can only be called when the event does not provide any other information. + +Parameter: None. + +Return: number type, error message. + +##### **Y.3.3.1.3 getTableId** + +Prototype: number getTableId() + +Description: Table ID when returning the ECM packet. This method can only be called when the event provides ECM data. + +Parameter: None. + +Return: number type, indicating TableID. + +##### **Y.3.3.1.4 isTimeout** + +Prototype: boolean isTimeout() + +Description: Whether it is timed out when returning the getting of the first ECM packet. The timeout period can be set in CASModuleManager.enableDescramblingRequests. This method can only be called when the event does not provide ECM data. + +Parameter: None. + +Return: boolean type, true-timeout; false-no timeout. + +### **Y.3.4 JSDCAS.CASEmmEvent object** + +This object contains information about EMM events, which are passed to the JS DCAS application through CASModule.onInBandEmmEvent. This event may be received because of the receiving of CAT or any EMM packet, or an internal filter error. + +#### **Y.3.4.1 Method** + +##### **Y.3.4.1.1 getEmmData** + +Prototype: Uint8Array getEmmData() + +Description: Returning complete EMM data. If the event is caused by CAT update, or caused by an internal error, null is returned. + +Parameter: None. + +Return: Uint8Array type, EMM data. + +##### **Y.3.4.1.2 getError** + +Prototype: number getError() + +Description: Error when returning the internal Section Filter filter. Only used for debugging. This method can only be called when the event does not provide any other information. + +Parameter: None. + +Return: number type, error message. + +##### **Y.3.4.1.3 getTableId** + +Prototype: number getTableId() + +Description: Table ID when returning the EMM packet. + +Parameter: None. + +Return: number type, indicating TableID. + +##### **Y.3.4.1.4 isCatUpdateNotification** + +Prototype: boolean isCatUpdateNotification() + +Description: Whether the return event is caused by CAT update, if it is caused by CAT update, the EMM data should be empty. + +Parameter: None. + +Return: boolean type. + +–true – the event is caused by a CAT update; + +–false – the event is caused by any EMM packet, or caused by an internal error. + +#### **Y.3.5 JSDCAS.CASFilter object** + +This object is used to express the Section Filter filter conditions required when filtering in-band or out-of-band EMM. The platform should only call the CAS Module when the data packet matches the filter conditions. For those data packets that do not meet the conditions, they should be discarded by the platform, and the JS DCAS application should not be called. CASFilter objects (or object arrays) can be set to the platform through CASModuleManager.startCasPacketLoading and CASModuleManager.startInbandEmmLoading. Filter conditions include: + +1. Offset in bytes. The data before the offset will be ignored and will not participate in the comparison. +2. Value used to compare with the data received by the platform, expressed in Bitmap. +3. It is used to express which bits need to participate in the comparison. For the bits set to 0 in the Bitmap, no comparison is required. + +### **Y.3.5.1 Method** + +#### **Y.3.5.1.1 getBitmapMask** + +Prototype: Uint8Array getBitmapMask() + +Description: Returning the filter mask. + +Parameter: None. + +Return: Uint8Array type, return the filter mask. + +#### **Y.3.5.1.2 getBitmapValue** + +Prototype: Uint8Array getBitmapValue() + +Description: Returning bitmap value used for comparison. + +Parameter: None. + +Return: Uint8Array type, return the bitmap value. + +#### **Y.3.5.1.3 getOffset** + +Prototype: number getOffset() + +Description: Returning offset (in bytes). + +Parameter: None. + +Return: number type, indicating the offset. + +### **Y.3.6 JSDCAS.CASM object** + +CASM is a global object, from which all CAS Manager and Controller objects can be accessed. + +#### **Y.3.6.1 Method** + +##### **Y.3.6.1.1 getCASModuleManager** + +Prototype: JSDCAS.CASModuleManager getCASModuleManager() + +Description: Returning CASModuleManager object instance. + +Parameter: None. + +Return: CASModuleManager object. + +##### **Y.3.6.1.2 getTeeController** + +Prototype: JSDCAS.TeeController getTeeController() + +Description: Returning TeeController object instance. + +Parameter: None. + +Return: TeeController object. + +### **Y.3.7 JSDCAS.CASModule object** + +CASModule is an interface of CAS module objects, which should be implemented by JS DCAS application and registered in the CAS Module Manager of the platform to receive descrambling requests, ECM, EMM or any metadata that the JS DCAS application cares about. EMM can be obtained in-band or out-of-band. Determined by the end-to-end design and the capabilities of the platform and equipment. + +### **Y.3.7.1 Method** + +#### **Y.3.7.1.1 getCasId** + +Prototype: number getCasId() + +Description: Returning the unique CASID of the CAS module. This method must be implemented before calling CASModuleManager.registerCASModule. The returned value is the value expected to appear in CA descriptor in CAT or PMT. + +Parameter: None. + +Return: number type, indicating CASID. + +#### **Y.3.7.1.2 onCasPacketEvent** + +Prototype: onCasPacketEvent(casPacketEvent) + +Description: The platform calls this method when it receives out-of-band EMM (or other out-of-band CAS data packets), refer to CASModuleManager.startCasPacketLoading. + +Parameter: casPacketEvent – CASPacketEvent object, which contains the CASPacketEvent object instance of the out-of-band EMM or other out-of-band CAS data packets. + +#### **Y.3.7.1.3 onEcmEvent** + +Prototype: onEcmEvent(casSession,ecmEvent) + +Description: After the platform filters the new ECM packet, call this method of the JS DCAS application. In fast mode, the platform calls this method after setting CW in ECM to K-LAD. + +Parameter: casSession – CASSession object, CAS Session object obtained from CASModule.onStartDescrambling. + +CASEcmEvent ecmEvent-ECM event object. + +#### **Y.3.7.1.4 onInbandEmmEvent** + +Prototype: onInbandEmmEvent(casSessionForEMM,emmEvent) + +Description: The platform calls this method when it receives a CAT update or in-band EMM. Refer to CASModuleManager.startInbandEmmLoading. + +Parameter: casSessionForEMM – A CASSession object, a special CAS Session, this session is related to the TS where the CAT is located, and it also contains the CA descriptor in the CAT (not the CA descriptor in the PMT). The platform should create a CAS Session specifically for this purpose. Note that this CAS Session object may only have some fields valid. Note: If the CA descriptor of the CAS is not specified in the CAT, or the terminal leaves the current frequency point, the CAT update event will still be sent JS DCAS application, but CAS Session is null. + +emmEvent – CASEmmEvent object, which contains CAT update or EMM, or other wrong CASEmmEvent object instances. + +#### **Y.3.7.1.5 onStartDescrambling** + +Prototype: onStartDescrambling(casSession,firstEcmEvent) + +Description: This method is called by the platform when there is a new descrambling request. It usually happens when the platform starts playing a new scrambled channel. JS DCAS application will receive this descrambling request only upon CASModuleManager.enableDescramblingRequests being called. In the auto-load mode, the platform will automatically start filtering the first ECM, and call this method after receiving the ECM. In this case, the JS DCAS application does not need to call CASModuleManager.startEcmLoading. If the device has multiple Tuners, this method may be called multiple times at the same time, each time corresponding to a playback descrambling request. Each + +request will have a different CAS Session. In addition, if the basic stream scrambling method of the service that needs to be descrambled is different, this method may also be called multiple times. Similarly, each call also has a different CAS Session. + +Parameter: `casSession` – A `CASSession` object, CAS Session object generated by the platform for a specific descrambling request. Each object has a unique session ID, and all information about the service and the basic stream. It also contains the CA descriptor corresponding to this CAS module in the PMT. + +`firstEcmEvent` – A `CASEcmEvent` object, in auto-load mode, the first ECM packet received by the platform (or timeout, error). If it is not in auto-load mode, it is empty. + +#### **Y.3.7.1.6 onStopDescrambling** + +Prototype: `onStopDescrambling(casSession)` + +Description: The platform calls this method when it stops playing the current channel to notify the JS DCAS application to stop descrambling. + +Parameter: `casSession` – A `CASSession` object, CAS Session obtained in `CASModule.onStartDescrambling`. + +### **Y.3.8 JSDCAS.CASModuleManager object** + +JS DCAS application uses this CAS Module Manager object to receive descrambling requests, ECM, EMM, and report CAS descrambling status. The JS DCAS application should implement the CAS Module object, and then register it to the CAS Module Manager. + +#### **Y.3.8.1 Method** + +##### **Y.3.8.1.1 disableDescramblingRequests** + +Prototype: `number disableDescramblingRequests(casModule)` + +Description: This method is called by a JSDCAS application to stop receiving descrambling requests. This method rarely has a chance to be called. For example, when the application needs to reconfigure the descrambling request parameters, it needs to call this method to suspend the receiving, and then restart the receiving. Or the application wishes to close itself. Recall `CASManager.enableDescramblingRequests` to restart receiving. + +Parameter: `casModule` – `CASModule` object, CAS module instance. + +Return: number type. + +`success` – `CASModuleManager.ACTION_OK`. + +`failure` – Returning the following error values: +`CASModuleManager.ACTION_ERROR_INVALID_PARAMETERS` – invalid parameter; +`CASModuleManager.ACTION_ERROR_DRIVER` – low-level error. + +##### **Y.3.8.1.2 enableDescramblingRequests** + +Prototype: `number enableDescramblingRequests(casModule, firstEcmTimeout, autoLoadFirstEcm, isFastMode, ecmTableIds)` + +Description: JS DCAS application starts to receive descrambling requests by calling this method. Through different parameters, different working modes between the platform CAS Manager and the CAS module can be configured. This method is usually only called after the CAS module is registered, because usually the JS DCAS application will not change this way of working. If the JS DCAS application wants to change this working mode, it needs to call `CASModuleManager.disableDescramblingRequests` first, and then call this method again. + +Parameter: `casModule` – A `CASModule` object, CAS module instance; + +`firstEcmTimeout` – number type, in milliseconds, the longest time the platform waits for the first ECM. If it times out, the CAS module will receive the `CASEcmEvent` through the `onEcmEvent` call or the `onStartDescrambling` call; + +`autoLoadFirstEcm` – boolean type, specify whether it is auto-load mode or not. Auto-load mode indicates that the platform automatically starts to filter the first ECM after the JS DCAS application calls this method, without waiting for the JS DCAS application to call `startEcmLoading`. + +`isFastMode` – boolean type, fast mode (temporarily only a placeholder, and has no practical meaning); + +`ecmTableIds` – Array type, if the JS DCAS application wants to specify `tableID` of ECM. + +Return: number type. + +`success` – `CASModuleManager.ACTION_OK`. + +`failure` – Returning the following error values: + +`CASModuleManager.ACTION_ERROR_INVALID_PARAMETERS` – invalid parameter; + +`CASModuleManager.ACTION_ERROR_ACTION_NOT_SUPPORTED` – the platform does not implement a specific mode; + +`CASModuleManager.ACTION_ERROR_DRIVER` – low-level error. + +#### **Y.3.8.1.3 fetchDataFromCasHeadend** + +Prototype: number `fetchDataFromCasHeadend(casModule,inputData,casHeURI)` + +Description: This method is called by JS DCAS application to obtain data from the headend, via the platform, via GPRS, or other possible means in the future. + +Parameter: `casModule` – A `CASModule` object, CAS module instance. + +`inputData` – `Uint8Array` type, data to be sent to the headend. + +`casHeURI` – String type, URI of the headend service. + +Return: number type. + +`success` – Data returned by the headend. + +`failure` – Returning the following error values: + +`CASModuleManager.ACTION_ERROR_INVALID_PARAMETERS` – invalid parameter; + +`CASModuleManager.ACTION_ERROR_DRIVER` – low-level error; + +`CASModuleManager.ACTION_ERROR_ACTION_NOT_SUPPORTED` – Method not supported; + +`CASModuleManager.ACTION_ERROR_NETWORK` – Network error. + +#### **Y.3.8.1.4 registerCASModule** + +Prototype: number `registerCASModule(vendorId,casModule,networkPriority,applicationContext)` + +Description: A JS DCAS application, registering itself in the CAS Module Manager of the platform by calling this method. + +Parameter: `vendorId` – number type, Vendor Id of CAS. Each CAS manufacturer has a unique special ID. + +`casModule` – `CASModule` object, CAS module instance to be registered. + +`networkPriority` – number type, if `CASModuleManager` allows registration of more than one CAS module, this optional parameter expresses the priority between multiple modules, and the specific + +value is determined by the operator. The greater the absolute value, the higher the priority, for example, the priority of 3 is higher than 2. After knowing the priority, when the platform encounters a situation where there are multiple CA descriptors in the PMT, it should send a descrambling request to the CAS module with the highest priority according to the priority. If the operator does not set the priority, each JS DCAS application must use 0 as a parameter. In this case, which CAS module can receive the descrambling request is determined by the implementation of the platform. + +applicationContext – Platform-related application parameters. Usually this parameter is told to the application by the platform when it is initialized. The usage of this parameter is project-dependent. + +Return: number type. + +success – CASModuleManager.ACTION\_OK. + +failure – Returning the following error values: + +CASModuleManager.ACTION\_ERROR\_SECURITY – the caller does not have permission to access CASModuleManager; + +CASModuleManager.ACTION\_ERROR\_INVALID\_PARAMETERS – invalid parameter. + +#### **Y.3.8.1.5 removeCASModule** + +Prototype: number removeCASModule(vendorId,casModule,applicationContext) + +Description: This method is called by a JS DCAS application to delete a CAS module from the CAS Module Manager. This method is rarely called, for example, before the application wants to change a CAS ID or before the application closes itself. + +Parameter: vendorId – number type, VendorId of CAS. Each CAS manufacturer has a unique special ID. + +casModule – CASModule object, CAS module instance to be registered. + +applicationContext – Platform-related application parameters. Usually this parameter is told to the application by the platform when it is initialized. The usage of this parameter is project-dependent. + +Return: number type. + +success – CASModuleManager.ACTION\_OK. + +failure – Returning the following error values: + +CASModuleManager.ACTION\_ERROR\_INVALID\_PARAMETERS – invalid parameter; + +CASModuleManager.ACTION\_ERROR\_DRIVER – low-level error; + +CASModuleManager.ACTION\_ERROR\_SECURITY – the caller does not have permission. + +#### **Y.3.8.1.6 sendCommandToSTB** + +Prototype: number sendCommandToSTB(casModule,inputData) + +Description:A Data channel function. This method is called by a JS DCAS application to send data to DCAS Manager, DCAS Manager forwards commands to the corresponding module for processing, these commands include OSD, upgrade trigger, fingerprint, emergency broadcast, ratings survey, etc., these commands are sent by BOSS, DCAS is only responsible for forwarding and is used as a data channel. + +Parameter: casModule – CASModule object, CAS module instance to be registered. + +inputData – Uint8Array type, data to be sent to the DCAS manager. + +Return: number type. + +success – CASModuleManager.ACTION\_OK. + +failure – Returning the following error values: + +CASModuleManager.ACTION\_ERROR\_INVALID\_PARAMETERS – invalid parameter; + +CASModuleManager.ACTION\_ERROR\_DRIVER – low-level error; + +CASModuleManager.ACTION\_ERROR\_ACTION\_NOT\_SUPPORTED – Method not supported; + +CASModuleManager.ACTION\_ERROR\_NETWORK – Network error. + +#### **Y.3.8.1.7 sendDataToHeadend** + +Prototype: number sendDataToHeadend(casModule,inputData) + +Description: This method is called by JS DCAS application to send data to the headend via the platform, via GPRS, or other possible means in the future. + +Parameter: casModule – CASModule object, CAS module instance to be registered. + +inputData – Uint8Array type, data to be sent to the headend. + +Return: number type. + +success – CASModuleManager.ACTION\_OK. + +failure – Returning the following error values: + +CASModuleManager.ACTION\_ERROR\_INVALID\_PARAMETERS – invalid parameter; + +CASModuleManager.ACTION\_ERROR\_DRIVER – low-level error; + +CASModuleManager.ACTION\_ERROR\_ACTION\_NOT\_SUPPORTED – Method not supported; + +CASModuleManager.ACTION\_ERROR\_NETWORK – Network error. + +#### **Y.3.8.1.8 sendDescramblingEvent** + +Prototype: number sendDescramblingEvent(casModule,casSession,casStatus) + +Description: This method is called by a JS DCAS application to report CAS status. CAS status includes the success or failure of descrambling. Every time the status changes, JS DCAS should report the status. + +Parameter: casModule – CASModule object, CAS module instance. + +casSession – CASSession object, CASSession obtained from CASModule.onStartDescrambling. + +casStatus – CASStatus object, CASStatus object generated by JSDCAS application. + +Return: number type. + +success – CASModuleManager.ACTION\_OK. + +failure – Returning the following error values: + +CASModuleManager.ACTION\_ERROR\_INVALID\_PARAMETERS – invalid parameter; + +CASModuleManager.ACTION\_ERROR\_ACTION\_NOT\_SUPPORTED – Method not supported. + +#### **Y.3.8.1.9 sendFreeTextOSD** + +Prototype: number sendFreeTextOSD(casModule,inputData,flags) + +Description: JS DCAS application forwards the received text information to the platform by calling this method. The platform may forward this text information to the UI application or process it by itself. + +Parameter: casModule – CASModule object, CAS module instance. + +inputData – Uint8Array type, text information. + +flags – ArrayBuffer type, used to display additional information such as format, project-related. + +Return: number type. + +success – CASModuleManager.ACTION\_OK. + +failure – Returning the following error values: + +CASModuleManager.ACTION\_ERROR\_INVALID\_PARAMETERS – invalid parameter; + +CASModuleManager.ACTION\_ERROR\_ACTION\_NOT\_SUPPORTED – Method not supported. + +#### **Y.3.8.1.10 setCCIBits** + +Prototype: number setCCIBits(casModule,casSession,cciBits) + +Description: Setting CCI (Copy Control Information) data bit. + +Parameter: casModule – CASModule object, CAS module instance. + +casSession – CASSession object, CAS Session obtained from CASModule.onSTartDescrambling. + +cciBits – number type, CCI data bit. + +Return: number type. + +success – CASModuleManager.ACTION\_OK. + +failure – Returning the following error values: + +CASModuleManager.ACTION\_ERROR\_INVALID\_PARAMETERS – invalid parameter; + +CASModuleManager.ACTION\_ERROR\_DRIVER – low-level error; + +CASModuleManager.ACTION\_ERROR\_ACTION\_NOT\_SUPPORTED – Method not supported. + +#### **Y.3.8.1.11 setData** + +Prototype: number setData(casModule, propertyId, propertyType, propertyValue) + +Description: DCAS APP sets property values for the platform, including BouquetID, activation status, CAS information, Beidou information, ChipID, HSMID, CASVendorID, area code, CA version, etc. + +Parameter: casModule – CASModule object, CAS module instance; + +propertyId – number type, property ID, see JSDCAS.CASModuleManager.PROP\_ID\_xxx; + +propertyType – number type, property type, see JSDCAS.CASModuleManager.PROP\_TYPE\_xxx; + +propertyValue – number type, property value. + +Return: number type. + +success – CASModuleManager.ACTION\_OK. + +failure – Returning the following error values: + +CASModuleManager.ACTION\_ERROR\_INVALID\_PARAMETERS – invalid parameter ; + +CASModuleManager.ACTION\_ERROR\_ACTION\_NOT\_SUPPORTED – Method not supported. + +#### **Y.3.8.1.12 setPinCode** + +Prototype: number setPinCode(casModule, pinCode) + +Description: Notifying the platform to reset PIN. + +Parameter: casModule – CASModule object, CAS module instance. + +pinCode – number type, PIN code. + +Return: number type. + +success – CASModuleManager.ACTION\_OK. + +failure – Returning the following error values: + +CASModuleManager.ACTION\_ERROR\_INVALID\_PARAMETERS – invalid parameter; + +CASModuleManager.ACTION\_ERROR\_DRIVER – low-level error; + +CASModuleManager.ACTION\_ERROR\_ACTION\_NOT\_SUPPORTED – Method not supported. + +#### **Y.3.8.1.13 setServiceListFilter** + +Prototype: number setServiceListFilter(casModule,filterData) + +Description: Setting the filter conditions of the service list. The definitions of the filter conditions are platform-dependent. + +Parameter: casModule – A CASModule object, CAS module instance. + +filterData – number type, filter condition. + +Return: number type. + +success – CASModuleManager.ACTION\_OK. + +failure – Returning the following error values: + +CASModuleManager.ACTION\_ERROR\_INVALID\_PARAMETERS – invalid parameter; + +CASModuleManager.ACTION\_ERROR\_ACTION\_NOT\_SUPPORTED – Method not supported. + +#### **Y.3.8.1.14 startCasPacketLoading** + +Prototype: number startCasPacketLoading(casModule,cableModemFilter,sourceURL,casFilter) + +Description: This method is called by a JS DCAS application to start receiving out-of-band CAS data packets. CAS data packets can be EMM or other out-of-band metadata. The receiving method is determined by the device hardware, platform, network, etc. For device with Cable Modem, it can be received under ADSG or BDSG protocol, and it can also be received by adding a multicast address through IP over Cable. For IP television (IPTV) device, it can be received by adding a multicast address via Ethernet or Wifi. It can also be received via a local UDP socket. In either case, JS DCAS applications can perform processing through CASModule.onCasPacketEvent when receiving CAS data packets. + +NOTE – The platform may implement receiving of data packets from multiple different sources at the same time. In this case, this method may be called multiple times from different URLs. + +Parameter: casModule – CASModule object, CAS module instance. + +cableModemFilter – number type, in the case of Cable Modem and DSG tunnelID, a filter must be provided. In the case of non-DSG, this parameter should be null. + +sourceURL – String type, if data packets are received from UDP, this parameter needs to be provided. "udp://@127.0.0.1:4444" or "udp://@localhost:4444" is received from local UDP port. + +casFilter – CASFilter object, filter condition, it can be a CASFilter array. + +Return: number type. + +success – CASModuleManager.ACTION\_OK. + +failure – Returning the following error values: + +CASModuleManager.ACTION\_ERROR\_INVALID\_PARAMETERS – invalid parameter; + +CASModuleManager.ACTION\_ERROR\_DRIVER – low-level error; + +CASModuleManager.ACTION\_ERROR\_ACTION\_NOT\_SUPPORTED – Method not supported. + +#### **Y.3.8.1.15 startEcmLoading** + +Prototype: number startEcmLoading(casModule,casSession) + +Description: JS DCAS application initiates the receiving of ECM of a specific scrambled program by calling this method and calls it after receiving the scramble request. + +NOTE – In auto-load mode, there is no need to call this method. + +Parameter: casModule – A CASModule object, CAS module instance. + +casSession – CASSession object, CASSession obtained from CASModule.onSTartDescrambling. + +Return: number type. + +success – CASModuleManager.ACTION\_OK. + +failure – Returning the following error values: + +CASModuleManager.ACTION\_ERROR\_INVALID\_PARAMETERS – invalid parameter; + +CASModuleManager.ACTION\_ERROR\_DRIVER – low-level error. + +#### **Y.3.8.1.16 startInbandEmmLoading** + +Prototype: number startInbandEmmLoading(casModule,emmTableIds,casFilter, includeCatNotifications) + +Description: This method is called by a JS DCAS application to start receiving in-band EMM. If required by JS DCAS application, it can also be used to receive CAT. When there is EMM or CAT update, the JS DCAS application receives data through CASModule.onInbandEmmEvent. + +Parameter: casModule – CASModule object, CAS module instance. + +emmTableIds – Array type, EMM Table Id array. + +casFilter – CASFilter|Array type, CAS filter. Only the data that meets the conditions will be notified to the application by the platform, and it is also possible to pass a Filter array. + +includeCatNotifications – boolean type, specify whether CAT update notification is expected to be received. + +Return: number type. + +success – CASModuleManager.ACTION\_OK. + +failure – Returning the following error values: + +CASModuleManager.ACTION\_ERROR\_INVALID\_PARAMETERS – invalid parameter; + +CASModuleManager.ACTION\_ERROR\_DRIVER – low-level error; + +CASModuleManager.ACTION\_ERROR\_ACTION\_NOT\_SUPPORTED – Method not supported. + +#### **Y.3.8.1.17 stopCasPacketLoading** + +Prototype: number stopCasPacketLoading(casModule,cableModemFilter,sourceURL) + +Description: This method is called by a JS DCAS application to stop receiving out-of-band CAS data packets. + +Parameter: casModule – CASModule object, CAS module instance. + +cableModemFilter – number|string type, required by Cable Modem. + +sourceURL – String type, required when receiving via UDP. + +Return: number type. + +success – CASModuleManager.ACTION\_OK. + +failure – Returning the following error values: + +CASModuleManager.ACTION\_ERROR\_INVALID\_PARAMETERS – invalid parameter; + +CASModuleManager.ACTION\_ERROR\_DRIVER – low-level error. + +#### **Y.3.8.1.18 stopEcmLoading** + +Prototype: number stopEcmLoading(casModule,casSession) + +Description: JS DCAS application stops receiving ECM by calling this method. JS DCAS applications rarely have the opportunity to call this method. If ECM receiving is expected to be restarted, CASManager.startEcmLoading needs to be recalled again. + +Parameter: casModule – CASModule object, CAS module instance. + +casSession – CASession object, CASession obtained from CASModule.onSTartDescrambling. + +Return: number type. + +success – CASModuleManager.ACTION\_OK. + +failure – Returning the following error values: + +CASModuleManager.ACTION\_ERROR\_INVALID\_PARAMETERS – invalid parameter; + +CASModuleManager.ACTION\_ERROR\_DRIVER – low-level error. + +#### **Y.3.8.1.19 stopInbandEmmLoading** + +Prototype: number stopInbandEmmLoading(casModule) + +Description: JS DCAS application stops receiving in-band EMM by calling this method. This method rarely needs to be called. Recall CASManager.startInbandEmmLoading to restart receiving. + +Parameter: casModule – CASModule object, CAS module instance. + +Return: number type. + +success – CASModuleManager.ACTION\_OK. + +failure – Returning the following error values: + +CASModuleManager.ACTION\_ERROR\_INVALID\_PARAMETERS – invalid parameter; + +CASModuleManager.ACTION\_ERROR\_DRIVER – low-level error. + +### **Y.3.9 JSDCAS.CASPacketEvent object** + +It is used to notify the JS DCAS application of out-of-band CAS data packet events. + +#### **Y.3.9.1 Method** + +##### **Y.3.9.1.1 getCableModemFilter** + +Prototype: number|string getCableModemFilter() + +Description: Returning cableModemFilter used to filter this packet. If Cable Modem DSG is not used, it returns empty. + +Parameter: None. + +Return: number|string type. + +ADSG mode – return CAS Tunner ID, number type. + +BDSG mode – Returning virtual MAC address. + +#### **Y.3.9.1.2 getPacketData** + +Prototype: Uint8Array getPacketData() + +Description: Returning the data in the data packet. + +Parameter: None. + +Return: Uint8Array type. + +#### **Y.3.9.1.3 getPacketHeader** + +Prototype: Uint8Array getPacketHeader() + +Description: Returning the header of the data packet. The header contains the IP address and UDP header. + +Parameter: None. + +Return: Uint8Array type. + +#### **Y.3.9.1.4 getSourceURL** + +Prototype: string getSourceURL() + +Description: Returning the source address of the CAS packet received via UDP. + +Parameter: None. + +Return: string type, source address character string. + +### **Y.3.10 JSDCAS.CASSession object** + +The platform generates a CAS Session object for each descrambling request. It contains the unique session ID, and all the information about the broadcast program, and also contains the CA descriptor related to this descrambling in the PMT. For each descrambling request, the JS DCAS application obtains the CAS Session through CASModule.onStartDescrambling. The CASSession object can also be used in the scenario of receiving CAT update messages. In this scenario, only some fields of the CASSession object are valid. + +#### **Y.3.10.1 Method** + +##### **Y.3.10.1.1 GetCasDescriptor** + +Prototype: CASDescriptor getCasDescriptor() + +Description: Returning CA descriptor, which may be from PMT or CAT. + +Parameter: None. + +Return: CASDescriptor object, CA descriptor object instance. + +##### **Y.3.10.1.2 getChannelNumber** + +Prototype: number getChannelNumber() + +Description: Returning channel number. This method is optional, especially for those platforms that cannot determine the channel number, it can return 0. + +Parameter: None. + +Return: number type, channel number. + +##### **Y.3.10.1.3 getNetworkId** + +Prototype: number getNetworkId() + +Description: Returning original network ID. This method is optional, if the platform is not available, it can return 0. + +Parameter: None. + +Return: number type, original network ID. + +#### **Y.3.10.1.4 getOperationType** + +Prototype: number GetOperationType() + +Description: Returning operation type. + +Parameter: None., + +Return: number type, operation type value: + +CASSession.OPERATION\_TYPE\_PRESENTATION ; + +CASSession.OPERATION\_TYPE\_RECORDING ; + +CASSession.OPERATION\_TYPE\_BUFFERING ; + +CASSession.OPERATION\_TYPE\_SECOND\_DEVICE. + +#### **Y.3.10.1.5 getProgramNumber** + +Prototype: number getProgramNumber() + +Description: Returning program number. + +Parameter: None. + +Return: number type, program number. + +#### **Y.3.10.1.6 getServiceIdentifier** + +Prototype: number getServiceIdentifier() + +Description: Returning identifier of the service being descrambled, which is a value or an object; + +Parameter: None. + +Return: number type, identifier of service. + +#### **Y.3.10.1.7 getSessionId** + +Prototype: number getSessionId() + +Description: Returning SessionID. + +Parameter: None. + +Return: number type, indicating SessionID. + +#### **Y.3.10.1.8 getStreamPath** + +Prototype: Uint8Array getStreamPath() + +Description: Returning StreamPath data. + +Parameter: None. + +Return: Uint8Array type, indicating StreamPath data. + +#### **Y.3.10.1.9 getStreamPIDs** + +Prototype: Array getStreamPIDs() + +Description: Returning Stream PIDs list. + +Parameter: None. + +Return: Array type, PID list. + +#### **Y.3.10.1.10 getStreamTypes** + +Prototype: Array getStreamTypes() + +Description: Returning StreamTypes list. + +Parameter: None. + +Return: Array type, Streamtypes list. + +#### **Y.3.10.1.11 getTransmitterScramblingMode** + +Prototype: number getTransmitterScramblingMode() + +Description: Returning scrambling mode value. + +Parameter: None. + +Return: number type, scrambling mode. + +#### **Y.3.10.1.12 getTransportStreamId** + +Prototype: number getTransportStreamId() + +Description: Returning TSID being descrambled. + +Parameter: None. + +Return: number type, indicating TSID. + +#### **Y.3.10.1.13 getTunerId** + +Prototype: number getTunerId() + +Description: Returning TunerID used by the program being descrambled. + +Parameter: None. + +Return: number type, indicating TunerID. + +### **Y.3.11 JSDCAS.CASStatus object** + +#### **Y.3.11.1 Overview of the JSDCAS.CASStatus object** + +JS DCAS application transmits the descrambling state to the platform through this object. Every time there is a change in the descrambling state, the JS DCAS application should call CASModuleManager.sendDescramblingEvent to notify the platform. After the platform receives this status change, it can handle it by itself or forward it to the UI application. The UI application can simply pop up the OSD to notify the user of the success or failure of the descrambling, and can also parse the additional information in the CASStatus object to show the specific reason for the failure. These additional information formats are project-related. If the JS DCAS application does not have additional information, the UI application obtains the Token in the CASStatus object and can also use this Token to communicate with the JS DCAS application through the means provided by IPC or other platforms to obtain more information. + +#### **Y.3.11.2 Method** + +##### **Y.3.11.2.1 getCasToken** + +Prototype: number getCasToken() + +Description: Returning CAS Token. If the platform forwards the CASStatus information to the UI application, the UI application can use this Token to initiate a request to the JS DCAS application to + +obtain more detailed status information. The method of request is determined by the platform, such as IPC. + +Parameter: None. + +Return: number type, return Token. + +#### **Y.3.11.2.2 getMajorContentProblem** + +Prototype: number getMajorContentProblem() + +Description: Returning main error value where the program cannot be watched. + +Parameter: None. + +Return: number type, error message. + +#### **Y.3.11.2.3 getStatusData** + +Prototype: ArrayBuffer getStatusData() + +Description: Returning extended data in descrambling state. With extended data, the UI application can display more detailed information about the descrambling state. + +Parameter: None. + +Return: ArrayBuffer type, indicating extended data. If there is no extended data available, null should be returned. + +#### **Y.3.11.2.4 isSuccess** + +Prototype: boolean isSuccess() + +Description: Returning whether descrambling is successful or not. + +Parameter: None. + +Return: boolean type, true-success, false-failure. + +### **Y.3.12 JSDCAS.TeeController object** + +Controller for JS DCAS and TEE communication. + +#### **Y.3.12.1 Method** + +##### **Y.3.12.1.1 sendCommandToTEE** + +Prototype: TeeRetVal + +sendCommandToTEE(teeAppUUID,commandId,inputData,applicationContext) + +Description: JS DCAS application uses this method to send commands to TA running in TEE. + +Parameter: + +teeAppUUID – Uint8Array type, UUID of TA, 16 bytes. Each CA manufacturer has a different ID. + +commandId – number type, Command ID in TEE communication. Defined by each CA manufacturer. + +inputData – Uint8Array type, data sent to TA. + +applicationContext – Application context, platform related. It is usually provided to the application by the platform during initialization. + +Return: TeeRetVal object, this object contains information such as data and errors returned from TA. + +### **Y.3.13 JSDCAS.TeeRetVal class** + +This object is returned by TeeController.sendCommandToTEE. The object contains information such as data and errors returned from the TEE. + +### **Y.3.13.1 Method** + +#### **Y.3.13.1.1 getOriginCode** + +Prototype: number getOriginCode() + +Description: Returning origin code. + +Parameter: None. + +Return: number type, indicating origincode. + +#### **Y.3.13.1.2 getResponseData** + +Prototype: Uint8Array getResponseData() + +Description: Getting data returned from TA. + +Parameter: None. + +Return: Uint8Array type, data returned from TA. It can be null for some commands. If there is an error in the call or communication, null is also returned. + +#### **Y.3.13.1.3 getReturnCode** + +Prototype: number getReturnCode() + +Description: Returning code. + +Parameter: None. + +Return: number type, indicating the return code. + +## Bibliography + +- [b-ITU-T J.205] Recommendation ITU-T J.205 (2012), *Requirements for an application control framework using integrated broadcast and broadband digital television.* +- [b-ITU-T J.1033] Recommendation ITU-T J.1033 (2020), *Downloadable conditional access system for bidirectional networks – The terminal.* +- [b-ITU-T J.1203] Recommendation ITU-T J.1203 (2022), *Smart television operating system – Specification.* +- [b-ITU-T J.1204] Recommendation ITU-T J.1204 (2022), *Smart television operating system – Security framework.* +- [b-ITU-T J.1205] Recommendation ITU-T J.1205 (2022), *Smart television operating system – Hardware abstract layer application programming interface.* + + + +## SERIES OF ITU-T RECOMMENDATIONS + +| | | +|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Series A | Organization of the work of ITU-T | +| Series D | Tariff and accounting principles and international telecommunication/ICT economic and policy issues | +| Series E | Overall network operation, telephone service, service operation and human factors | +| Series F | Non-telephone telecommunication services | +| Series G | Transmission systems and media, digital systems and networks | +| Series H | Audiovisual and multimedia systems | +| Series I | Integrated services digital network | +| Series J | Cable networks and transmission of television, sound programme and other multimedia signals | +| Series K | Protection against interference | +| Series L | Environment and ICTs, climate change, e-waste, energy efficiency; construction, installation and protection of cables and other elements of outside plant | +| Series M | Telecommunication management, including TMN and network maintenance | +| Series N | Maintenance: international sound programme and television transmission circuits | +| Series O | Specifications of measuring equipment | +| Series P | Telephone transmission quality, telephone installations, local line networks | +| Series Q | Switching and signalling, and associated measurements and tests | +| Series R | Telegraph transmission | +| Series S | Telegraph services terminal equipment | +| Series T | Terminals for telematic services | +| Series U | Telegraph switching | +| Series V | Data communication over the telephone network | +| Series X | Data networks, open system communications and security | +| Series Y | Global information infrastructure, Internet protocol aspects, next-generation networks, Internet of Things and smart cities | +| Series Z | Languages and general software aspects for telecommunication systems | \ No newline at end of file diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/04f51626e2e10a16e3eb2c4b33cb2742_img.jpg b/marked/J/T-REC-J.1207-202410-I_PDF-E/04f51626e2e10a16e3eb2c4b33cb2742_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1bd5370f7ea1f8861fe3cc6f35655927bdfc1e53 --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/04f51626e2e10a16e3eb2c4b33cb2742_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:30213fc9e7c3304a43ca1ece2ea753b5337ed4da7a70be5fc4adfa0fc4277a33 +size 30999 diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/0538daaa5583c23e17db3a12f2281a55_img.jpg b/marked/J/T-REC-J.1207-202410-I_PDF-E/0538daaa5583c23e17db3a12f2281a55_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ec5afb8b4480ce7e9c5be3846e619565b90e0e43 --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/0538daaa5583c23e17db3a12f2281a55_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f7bb6bb227e627e87d9003b540c6331523019eb2622bdc8a919764c77c42a6f3 +size 7205 diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/16152cf1d84aea10848758f51a91ff6a_img.jpg b/marked/J/T-REC-J.1207-202410-I_PDF-E/16152cf1d84aea10848758f51a91ff6a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ec6308485532e4db4906046cae13153a01424ce9 --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/16152cf1d84aea10848758f51a91ff6a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:477793b8612d8057de061ecf72a591a8de63a255f5ae13cf989ea837c7858263 +size 19128 diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/18722c46c9e8475524e634dedd08bac2_img.jpg b/marked/J/T-REC-J.1207-202410-I_PDF-E/18722c46c9e8475524e634dedd08bac2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a8201a0a8a093040df9f666b26a315a04b9859ff --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/18722c46c9e8475524e634dedd08bac2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7b966e204bfc6da120befb58d138cdf3d27a493016d715af1c0ba07be4e44db6 +size 23801 diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/29f586959675cafdf81cf934954908eb_img.jpg b/marked/J/T-REC-J.1207-202410-I_PDF-E/29f586959675cafdf81cf934954908eb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fe3d07f03874a8a5dcf27e7d376fbd73bc8c0431 --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/29f586959675cafdf81cf934954908eb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c704d7af7268ea621abc454af3752b2d0e753a44a23c978522fc55aec08abc41 +size 23462 diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/51db757d054ce1ce83c436a3578b56ca_img.jpg b/marked/J/T-REC-J.1207-202410-I_PDF-E/51db757d054ce1ce83c436a3578b56ca_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0ced80a7eb252a80aacdbbea3724b0738fa2ece4 --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/51db757d054ce1ce83c436a3578b56ca_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5e8d80d198e4d7eb5c09eceecde9e813ea68e192f0ddba09e70a14980bed8411 +size 23165 diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/5b8a756d9a71c35f17db8bcb90b438a3_img.jpg b/marked/J/T-REC-J.1207-202410-I_PDF-E/5b8a756d9a71c35f17db8bcb90b438a3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ebfd0816212febf3e8918a4fbb7296d8855adfce --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/5b8a756d9a71c35f17db8bcb90b438a3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:56c8837538a08e4d7f16808c036e89f744c136c4cc40a705ee3c3b9118007d6d +size 53103 diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg b/marked/J/T-REC-J.1207-202410-I_PDF-E/75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bcf7961a300e361503b2ff5bcf112bc77a9867fa --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3d8ea851356489aba4a1c3621b6ecb69c5c9deb3582647bc37c1124cc0d1e482 +size 34864 diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/76b0cd79baaedd942af4dc42f2e764b8_img.jpg b/marked/J/T-REC-J.1207-202410-I_PDF-E/76b0cd79baaedd942af4dc42f2e764b8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ff4c725ca806eb8ce6c3a68fb0982d9a6fb33fe1 --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/76b0cd79baaedd942af4dc42f2e764b8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ec712823699c59f9b22d33023c0df7c6f5e3dc75f63348ee76a49f1b0b7833dd +size 30425 diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/898fb89a50d9ec1dfb4e425c816976a7_img.jpg b/marked/J/T-REC-J.1207-202410-I_PDF-E/898fb89a50d9ec1dfb4e425c816976a7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..39685f4f011d29c8562f7a5f81e9e0e2de9e3609 --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/898fb89a50d9ec1dfb4e425c816976a7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bbc39118f670ed0a6ce0f6420f69a37478df56c7fab22997b769a9076a75c4d0 +size 11419 diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/8fbdfc3d17fb1dae7b2d8f5a287fa9fc_img.jpg b/marked/J/T-REC-J.1207-202410-I_PDF-E/8fbdfc3d17fb1dae7b2d8f5a287fa9fc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..df450dcb6d1446112f4ba607bde3fc7b80b4618c --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/8fbdfc3d17fb1dae7b2d8f5a287fa9fc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9be04bb855ee39d7317b060f734a54957c0119036f2dca3b363197e84a03cd96 +size 18797 diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/9b9d2abd741ed4bafe7f78f89961c663_img.jpg b/marked/J/T-REC-J.1207-202410-I_PDF-E/9b9d2abd741ed4bafe7f78f89961c663_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cfaf71df8c41c526e55b0141eed968fa4e0ccf28 --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/9b9d2abd741ed4bafe7f78f89961c663_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2d4b195335a758861f64e587d07cb914c2a5312d30ae2a13cd536c4933d4c62c +size 37620 diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/9c6461e1e94afae4dec455e69a2ce152_img.jpg b/marked/J/T-REC-J.1207-202410-I_PDF-E/9c6461e1e94afae4dec455e69a2ce152_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ec279406ce9ff157eecc66ed7bcd21350ef1e2b5 --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/9c6461e1e94afae4dec455e69a2ce152_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b9190fbf343af5b674a63a6b60dd1b7ff4693ad5767144ab795e568e4e70c156 +size 23554 diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/b6671cfafda3820aafe9a24fa7a4d8c7_img.jpg b/marked/J/T-REC-J.1207-202410-I_PDF-E/b6671cfafda3820aafe9a24fa7a4d8c7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2f1af79681489d2c06ec6bf7d73e4946b9ad511b --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/b6671cfafda3820aafe9a24fa7a4d8c7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7c8bd533da69050edda1a254f45ca2597b4fd7ab78950292a670441c8cf430de +size 99024 diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/b90144cfbb81a2d610d920240fda689d_img.jpg b/marked/J/T-REC-J.1207-202410-I_PDF-E/b90144cfbb81a2d610d920240fda689d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c38db06a7287e1e5b6794f454ebd6ecd7cb09fcb --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/b90144cfbb81a2d610d920240fda689d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:580451a6149b8f834d1f185d8b90645679fab292d9c37a630710248dca45509e +size 18881 diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/c67d21fb3d9042e88cdc669f071b4e7c_img.jpg b/marked/J/T-REC-J.1207-202410-I_PDF-E/c67d21fb3d9042e88cdc669f071b4e7c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..10fe927e5f6da4a4579845c30781fae2be64f2c1 --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/c67d21fb3d9042e88cdc669f071b4e7c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:215ecef7929b325852e667ea1a036aadfa90b1c03b8f6890b2e50d2c33fea93b +size 24161 diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/df1d0e45191302de72176e4390224c16_img.jpg b/marked/J/T-REC-J.1207-202410-I_PDF-E/df1d0e45191302de72176e4390224c16_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..51d4481c5057531bb230b5e3730315e688998e57 --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/df1d0e45191302de72176e4390224c16_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e03240b591857fe35231b186808d1b072ccc74015992141290fb2bbe817cb6de +size 31644 diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/df82d77a0d2637cbf2da9ea920a554fa_img.jpg b/marked/J/T-REC-J.1207-202410-I_PDF-E/df82d77a0d2637cbf2da9ea920a554fa_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a1da9c9f7d548d73840a720168e45abd3a84648b --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/df82d77a0d2637cbf2da9ea920a554fa_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a481f1c6db3c33e67da3dba524d0b83f2bc18cb8557c772181ddff22bc878be5 +size 44319 diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/fa859e4e468bfb2710a94527f2c504af_img.jpg b/marked/J/T-REC-J.1207-202410-I_PDF-E/fa859e4e468bfb2710a94527f2c504af_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..20127efaf55031db9309fe2e3d56ddb6c0549f5b --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/fa859e4e468bfb2710a94527f2c504af_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b39a1f1af068e6b6dc5ed0dd9c2614e59f4ba2a5c14f1702aa5ea5a75d98a961 +size 23498 diff --git a/marked/J/T-REC-J.1207-202410-I_PDF-E/raw.md b/marked/J/T-REC-J.1207-202410-I_PDF-E/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..0ba5a0e1ea1bfb628883069a23f9a92e14b6ab9d --- /dev/null +++ b/marked/J/T-REC-J.1207-202410-I_PDF-E/raw.md @@ -0,0 +1,4991 @@ + + +# Recommendation**ITU-T J.1207 (10/2024)** + +SERIES J: Cable networks and transmission of television, +sound programme and other multimedia signals + +Smart TV operating system + +--- + +# **Smart television operating system – Conformance test** + + + +The logo of the International Telecommunication Union (ITU), featuring the letters 'ITU' in blue inside a circle with a globe-like grid pattern. + +ITU logo + +## ITU-T J-SERIES RECOMMENDATIONS + +## Cable networks and transmission of television, sound programme and other multimedia signals + +| | | +|-------------------------------------------------------------------------------------------------|----------------------| +| GENERAL RECOMMENDATIONS | J.1-J.9 | +| GENERAL SPECIFICATIONS FOR ANALOGUE SOUND-PROGRAMME TRANSMISSION | J.10-J.19 | +| PERFORMANCE CHARACTERISTICS OF ANALOGUE SOUND-PROGRAMME CIRCUITS | J.20-J.29 | +| EQUIPMENT AND LINES USED FOR ANALOGUE SOUND-PROGRAMME CIRCUITS | J.30-J.39 | +| DIGITAL ENCODERS FOR ANALOGUE SOUND-PROGRAMME SIGNALS - PART 1 | J.40-J.49 | +| DIGITAL TRANSMISSION OF SOUND-PROGRAMME SIGNALS | J.50-J.59 | +| CIRCUITS FOR ANALOGUE TELEVISION TRANSMISSION | J.60-J.69 | +| ANALOGUE TELEVISION TRANSMISSION OVER METALLIC LINES AND INTERCONNECTION WITH RADIO-RELAY LINKS | J.70-J.79 | +| DIGITAL TRANSMISSION OF TELEVISION SIGNALS | J.80-J.89 | +| ANCILLARY DIGITAL SERVICES FOR TELEVISION TRANSMISSION | J.90-J.99 | +| OPERATIONAL REQUIREMENTS AND METHODS FOR TELEVISION TRANSMISSION | J.100-J.109 | +| INTERACTIVE SYSTEMS FOR DIGITAL TELEVISION DISTRIBUTION (DOCSIS FIRST AND SECOND GENERATIONS) | J.110-J.129 | +| TRANSPORT OF MPEG-2 SIGNALS ON PACKETIZED NETWORKS | J.130-J.139 | +| MEASUREMENT OF THE QUALITY OF SERVICE - PART 1 | J.140-J.149 | +| DIGITAL TELEVISION DISTRIBUTION THROUGH LOCAL SUBSCRIBER NETWORKS | J.150-J.159 | +| IPCABLECOM (MGCP-BASED) - PART 1 | J.160-J.179 | +| DIGITAL TRANSMISSION OF TELEVISION SIGNALS - PART 1 | J.180-J.189 | +| CABLE MODEMS AND HOME NETWORKING | J.190-J.199 | +| APPLICATION FOR INTERACTIVE DIGITAL TELEVISION - PART 1 | J.200-J.209 | +| INTERACTIVE SYSTEMS FOR DIGITAL TELEVISION DISTRIBUTION (DOCSIS THIRD TO FIFTH GENERATIONS) | J.210-J.229 | +| MULTI-DEVICE SYSTEMS FOR CABLE TELEVISION | J.230-J.239 | +| MEASUREMENT OF THE QUALITY OF SERVICE - PART 2 | J.240-J.249 | +| DIGITAL TELEVISION DISTRIBUTION THROUGH LOCAL SUBSCRIBER NETWORKS | J.250-J.259 | +| IPCABLECOM (MGCP-BASED) - PART 2 | J.260-J.279 | +| DIGITAL TRANSMISSION OF TELEVISION SIGNALS - PART 2 | J.280-J.289 | +| CABLE SET-TOP BOX | J.290-J.299 | +| APPLICATION FOR INTERACTIVE DIGITAL TELEVISION - PART 2 | J.300-J.309 | +| MEASUREMENT OF THE QUALITY OF SERVICE - PART 3 | J.340-J.349 | +| IPCABLECOM2 (SIP-BASED) - PART 1 | J.360-J.379 | +| DIGITAL TRANSMISSION OF TELEVISION SIGNALS - PART 3 | J.380-J.389 | +| MEASUREMENT OF THE QUALITY OF SERVICE - PART 4 | J.440-J.449 | +| IPCABLECOM2 (SIP-BASED) - PART 2 | J.460-J.479 | +| DIGITAL TRANSMISSION OF TELEVISION SIGNALS - PART 4 | J.480-J.489 | +| TRANSPORT OF LARGE SCREEN DIGITAL IMAGERY | J.600-J.699 | +| SECONDARY DISTRIBUTION OF IPTV SERVICES | J.700-J.799 | +| MULTIMEDIA OVER IP IN CABLE | J.800-J.899 | +| TRANSMISSION OF 3-D TV SERVICES | J.900-J.999 | +| CONDITIONAL ACCESS AND PROTECTION | J.1000-J.1099 | +| SWITCHED DIGITAL VIDEO OVER CABLE NETWORKS | J.1100-J.1119 | +| SMART TV OPERATING SYSTEM | J.1200-J.1209 | +| IP VIDEO BROADCAST | J.1210-J.1219 | +| CABLE SET-TOP BOX - PART 2 | J.1290-J.1299 | +| CLOUD-BASED CONVERGED MEDIA SERVICES FOR IP AND BROADCAST CABLE TELEVISION | J.1300-J.1309 | +| CLOUD-BASED SERVICES FOR IP DELIVERY OVER INTEGRATED BROADBAND CABLE NETWORK | J.1310-J.1319 | +| TELEVISION TRANSPORT NETWORK AND SYSTEM DEPLOYMENT IN DEVELOPING COUNTRIES | J.1400-J.1409 | +| ARTIFICIAL INTELLIGENCE (AI) ASSISTED CABLE NETWORKS | J.1600-J.1649 | + +For further details, please refer to the list of ITU-T Recommendations. + +# Recommendation ITU-T J.1207 + +# Smart television operating system – Conformance test + +## Summary + +Recommendation ITU-T J.1207 specifies the conformance test for a smart TV operating system over integrated broadcast and broadband cable networks. A smart TV operating system is intended to be installed in an integrated broadcast and broadband (IBB)-capable cable set-top box (STB) and TV, enabling both broadcasting and IP-based interactive services provided by cable television operators and third-party providers. By running a smart TV operating system, the IBB-capable cable STB and TV will be able to intelligently provide subscribers with advanced and personalized services. This is achieved through download and installation of advanced and personalized apps from both cable operators' platforms and third-party platforms, which are interconnected with the related cable operators' platforms. + +Conformance to the smart TV operating system means adherence to the relevant requirements of ITU-T J.1201, ITU-T J.1202, ITU-T J.1203, ITU-T J.1204, ITU-T J.1205 and ITU-T J.1206. + +The TVOS platform should meet the conformity requirements for functionality and architecture, security, performance, and interfaces as described in this Recommendation. + +## History\* + +| Edition | Recommendation | Approval | Study Group | Unique ID | +|---------|----------------|------------|-------------|--------------------| +| 1.0 | ITU-T J.1207 | 2024-10-29 | 9 | 11.1002/1000/16193 | + +## Keywords + +Conformance test, smart TV operating system, TVOS. + +--- + +\* To access the Recommendation, type the URL
interface ..... | 368 | +| B.12 | Conformance test of multi-screen interactive unit interface ..... | 375 | +| B.13 | Conformance test of DRM management unit interface..... | 385 | +| B.14 | Conformance test of DCAS management unit interface ..... | 387 | +| Annex C – | Conformance test of hardware abstraction interfaces..... | 408 | +| C.1 | Conformance test of specialized hardware abstraction interfaces for
media processing ..... | 408 | + +# Recommendation ITU-T J.1207 + +## Smart television operating system – Conformance test + +# 1 Scope + +This Recommendation specifies the conformance test for a smart TV operating system over integrated broadcast and broadband cable networks. The smart TV operating system is intended to be installed in an integrated broadcast and broadband (IBB)-capable cable set-top box (STB) and TV, enabling both broadcasting and IP-based interactive services provided by cable television operators and third-party providers. By running the smart TV operating system, the IBB-capable cable STB and TV will be able to intelligently provide subscribers with advanced and personalized services. This is achieved through the downloading and installation of a range of innovative apps from both cable operators' platforms and third-party platforms, which are interconnected with the related cable operators' platforms. + +# 2 References + +The following ITU-T Recommendations and other references contain provisions which, through reference in this text, constitute provisions of this Recommendation. At the time of publication, the editions indicated were valid. All Recommendations and other references are subject to revision; users of this Recommendation are therefore encouraged to investigate the possibility of applying the most recent edition of the Recommendations and other references listed below. A list of the currently valid ITU-T Recommendations is regularly published. The reference to a document within this Recommendation does not give it, as a stand-alone document, the status of a Recommendation. + +- [ITU-T J.205] Recommendation ITU-T J.205 (2012), *Requirements for an application control framework using integrated broadcast and broadband digital television*. +- [ITU-T J.1201] Recommendation ITU-T J.1201 (2022), *Smart television operating system – Functional requirements*. +- [ITU-T J.1202] Recommendation ITU-T J.1202 (2022), *Smart television operating system – Architecture*. +- [ITU-T J.1203] Recommendation ITU-T J.1203 (2022), *Smart television operating system – Specification*. +- [ITU-T J.1204] Recommendation ITU-T J.1204 (2022), *Smart television operating system – Security framework*. +- [ITU-T J.1205] Recommendation ITU-T J.1205 (2022), *Smart television operating system – Hardware abstract layer application programming interface*. +- [ITU-T J.1206] Recommendation ITU-T J.1206 (2024), *Smart television operating system – Application programming interface*. +- [ISO 639] ISO 639:2023, *Code for individual languages and language groups*. + +# 3 Definitions + +## 3.1 Terms defined elsewhere + +This Recommendation uses the following terms defined elsewhere: + +**3.1.1 integrated broadcast and broadband (IBB) DTV service** [ITU-T J.205]: A service that simultaneously provides an integrated experience of broadcasting and interactivity relating to media + +content, data and applications from multiple sources, where the interactivity is sometimes associated with broadcasting programmes. + +**3.1.2 smart television operating system (TVOS)** [ITU-T J.1201]: A system software running on an integrated broadcast and broadband-capable (IBB-capable) cable set top box (STB) and television (TV) that is capable of managing hardware, software and data resources of the IBB-capable cable STB and TV, supporting and controlling the application software execution. + +## **3.2 Terms defined in this Recommendation** + +None. + +# **4 Abbreviations and acronyms** + +This Recommendation uses the following abbreviations and acronyms: + +| | | +|--------|-----------------------------------------------------| +| AV | Audio Video | +| AVI | Audio Video Interleave | +| BSSID | Basic Service Set Identifier | +| CA | Conditional Access | +| CAS | Conditional Access System | +| CAT | Conditional Access Table | +| CPU | Central Processing Unit | +| CW | Control Word | +| DCAS | Downloadable Conditional Access System | +| DHCP | Dynamic Host Configuration Protocol | +| DNS | Domain Name System | +| DTV | Digital Television | +| DRM | Digital Rights Management | +| DSM-CC | Digital Storage Media/Command and Control | +| DTMB | Digital Television Terrestrial Multimedia Broadcast | +| DVB | Digital Video Broadcasting | +| DVB-C | Digital Video Broadcasting – Cable | +| ECM | Entitlement Control Message | +| EIT | Event Information Table | +| EMM | Entitlement Management Message | +| EPG | Electronic Programme Guide | +| ES | Elementary Stream | +| FLV | Flash Video | +| HDMI | High-Definition Multimedia Interface | +| HDR | High Dynamic Range | +| HLS | HTTP Live Streaming | +| HTML5 | Hyper Text Markup Language 5.0 | + +| | | +|-----------|--------------------------------------------------------------| +| HTTP | Hyper Text Transfer Protocol | +| HTTPS | Hypertext Transfer Protocol Secure | +| ID | Identifier | +| IP | Internet Protocol | +| IPQAM | Internet Protocol Quadrature Amplitude Modulation | +| IPTV | IP Television | +| LAN | Local Area Network | +| M3UA | MTP 3 User Adaptation layer | +| MAC | Media Access Control | +| MP3 | MPEG-1 Audio Layer 3 | +| MP4 | MPEG-4 Part 14 | +| MPEG | Moving Picture Experts Group | +| MPEG-DASH | MPEG Dynamic Adaptive Streaming over HTTP | +| NIT | Network Information Table | +| NVM | Non-Volatile Memory | +| OSD | On-Screen Display | +| OTA | Over The Air | +| PAT | Programme Association Table | +| PID | Packet Identifier | +| PMT | Programme Mapping Table | +| PPPOE | Point-to-Point Protocol over Ethernet | +| PSI | Programme Service Information | +| QAM | Quadrature Amplitude Modulation | +| RAM | Random Access Memory | +| REE | Rich Execution Environment | +| SD card | Secure Digital Memory Card | +| SDT | Service Description Table | +| SI | Service Information | +| SPDIF | Sony/Philips Digital Interconnect Format | +| SSID | Service Set Identifier | +| TA | Trusted Application | +| TDT | Time Date Table | +| TEE | Trusted Execution Environment | +| TS | Transport Stream | +| TOT | Time of Transmission | +| TVOS | Television Operating System | +| TVOS-C | Dual-Platform Version of a Smart Television Operating System | + +| | | +|--------|----------------------------------------------------------------| +| TVOS-H | Single-Platform Version of a Smart Television Operating System | +| URL | Uniform Resource Locator | +| USB | Universal Serial Bus | +| UTC | Coordinated Universal Time | +| W3C | World Wide Web Consortium | +| WiFi | Wireless Fidelity | + +# 5 Conventions + +In this Recommendation: + +The phrase "is required to" indicates a requirement which must be strictly followed and from which no deviation is permitted if conformance with this document is to be claimed. + +The phrase "is recommended" indicates a requirement that is advised but not absolutely necessary. Thus this requirement does not need to be present to claim conformance. + +The phrase "is prohibited from" indicates a requirement which must be strictly followed, with no deviation permitted if conformance with this document is to be claimed. + +The phrase "can optionally" indicates an optional requirement that is permissible, without implying any sense of being recommended. This term does not imply that the vendor's implementation must include the option and that the feature can be optionally enabled by the network operator/service provider. Rather, it means the vendor may optionally provide the feature and still claim conformance with this Recommendation. + +In the body of this document and its annexes, the words *shall*, *shall not*, *should*, and *may* sometimes appear. When they do, they shall be interpreted, respectively, as *is required to*, *is prohibited from*, *is recommended*, and *can optionally*. The appearance of such phrases or keywords in an appendix or in material explicitly marked as *informative* are to be interpreted as having no normative intent. + +# 6 Conformance approach in this Recommendation + +Conformance of the smart TV operating system means that smart TV operating system conforms to relevant requirements of [ITU-T J.1201], [ITU-T J.1202], [ITU-T J.1203], [ITU-T J.1204], and [ITU-T J.1205]. + +The smart television operating system (TVOS) platform should conform to the conformity requirements for functionality and architecture, security, performance , and interfaces according to clauses 7 and 8 of this Recommendation. + +# 7 Conformity requirements + +## 7.1 Function and architecture conformity requirements + +#### 7.1.1 Live TV conformity requirements + +| S/N | Requirement | +|-----|------------------------------------------------------------------------| +| 1 | Support tuning of system frequency | +| 2 | Support system channel search | +| 3 | Support channel change | +| 4 | Support the system to get electronic programme guide (EPG) information | +| 5 | Support the system to get EPG P/F information | + +| S/N | Requirement | +|-----|---------------------------------------------------| +| 6 | Support live audio video synchronization | +| 7 | Support the system to display channel information | + +#### 7.1.2 Video-on-demand conformity requirements + +| S/N | Requirement | +|-----|------------------------------------------------------| +| 1 | Support the system to play the programme on demand | +| 2 | Support the system to pause the programme on demand | +| 3 | Support the system to resume the programme on demand | +| 4 | Support the system to stop the programme on demand | +| 5 | Support the system to seek the programme on demand | + +#### 7.1.3 IP television (IPTV) conformity requirements + +| S/N | Requirement | +|-----|--------------------------------------------| +| 1 | Support the system to play network video | +| 2 | Support the system to pause network video | +| 3 | Support the system to resume network video | +| 4 | Support the system to stop network video | +| 5 | Support the system to seek network video | + +#### 7.1.4 Conformity requirements for local audio video file playing + +| S/N | Requirement | +|-----|--------------------------------------------------------------------------------------------------| +| 1 | Support the system to normally play audio video files required in clause 6.1.5 of [ITU-T J.1201] | +| 2 | Support the system to pause local audio video files | +| 3 | Support the system to resume local audio video files | +| 4 | Support the system to stop local audio video files | +| 5 | Support the system to seek local audio video files | + +#### 7.1.5 Human-machine interaction conformity requirements + +| S/N | Requirement | +|-----|----------------------------------------------| +| 1 | Support three-button mouse input interaction | +| 2 | Support keyboard input interaction | +| 3 | Support remote controller input interaction | +| 4 | Support voice input interaction | +| 5 | Support mobile phone input interaction | + +#### 7.1.6 HTML5 support conformity requirements + +| S/N | Requirement | +|-----|------------------------------------------------| +| 1 | Support Hyper Text Markup Language 5.0 (HTML5) | + +#### 7.1.7 System setting conformity requirements + +| S/N | Requirement | +|-----|--------------------------------------------| +| 1 | Support to restore system factory settings | +| 2 | Support standby/awaking | +| 3 | Support volume up/down | +| 4 | Support mute/unmute setting | + +#### 7.1.8 Conformity requirements of application software support + +| S/N | Requirement | +|-----|---------------------------------------| +| 1 | Support JAVA application installation | +| 2 | Support JAVA application running | +| 3 | Support WEB application installation | +| 4 | Support WEB application running | + +#### 7.1.9 Architecture conformity requirements + +| S/N | Requirement | +|-----|-----------------------------------------------------------------------------------------------------------------| +| 1 | The system needs to contain two parts: trusted execution environment (TEE) and rich execution environment (REE) | +| 2 | Media functions are processed by media engine of smart operating system | +| 3 | WEB application is processed by HTML5 engine of smart TV operating system | +| 4 | WEB application running is independent of JAVA environment | + +### 7.2 Security conformity requirements + +#### 7.2.1 Secure boot conformity requirements + +| S/N | Requirement | +|-----|--------------------------------------------------------------------------------------------------------------------------------| +| 1 | When BL_KEY1, BOOT, kernel and system mirror signed by legal BL_KEY0 are used and recorded, the system can be started normally | +| 2 | When the mirror containing tampered BL_KEY1 is used and recorded, the system cannot be started normally | +| 3 | When the mirror containing wrong BL_KEY1 and signature is used and recorded, the system cannot be started normally | +| 4 | When the mirror containing tampered Bootloader is used and recorded, the system cannot be started normally | +| 5 | When the mirror containing wrong Bootloader is used and recorded, the system cannot be started normally | +| 6 | When the mirror containing tampered kernel is used and recorded, the system cannot be started normally | +| 7 | When the data containing wrong kernel and signature are used and recorded, the system cannot be started normally | +| 8 | When the mirror containing tampered system is used and recorded, the system cannot be started normally | +| 9 | When the data containing wrong system mirror and signature are used and recorded, the system cannot be started normally | + +#### 7.2.2 Conformity requirements of application security + +| S/N | Requirement | +|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | When the application installation package signed with correct operator certificate and correct personal certificate is used, the system can be successfully installed | +| 2 | When the application installation package signed with wrong operator certificate and correct personal certificate is used, the system cannot be successfully installed | +| 3 | When the application installation package signed with correct operator certificate and wrong personal certificate is used, the system cannot be successfully installed | +| 4 | When the tampered application installation package is used, the system cannot be successfully installed | +| 5 | When the application installation package without operator certificate signature is used, the system cannot be successfully installed | +| 6 | When the application installation package without personal certificate signature is used, the system cannot be successfully installed | + +#### 7.2.3 Conformity requirements of service security + +| S/N | Security type | Requirement | +|-----|---------------|-----------------------------------------------------------------------------------------------------------------------------| +| 1 | DCAS | Use downloadable conditional access system (DCAS) front end and DCAS application, and support the system to search channels | +| 2 | | Use DCAS front end and DCAS application, and support the system to play programs | +| 3 | | Use DCAS front end and DCAS application, and support the system to display EPG | +| 4 | | Use DCAS front end and DCAS application, and support the system to change channels | +| 5 | Integrated CA | Use integrated conditional access (CA) front end and integrated CA application, and support the system to search channels | +| 6 | | Use integrated CA front end and integrated CA application, and support the system to play programs | +| 7 | | Use integrated CA front end and integrated CA application, and support the system to display EPG | +| 8 | | Use integrated CA front end and integrated CA application, and support the system to change channels | + +#### 7.2.4 Conformity requirements of content security + +| S/N | Requirement | +|-----|------------------------------------------------------------------------------------------------------------------------| +| 1 | Use digital rights management (DRM) front end and DRM application, and support the system to register terminal devices | +| 2 | Use DRM front end and DRM application, and support the system to authorize terminal devices | +| 3 | Use DRM front end and DRM application, and support the system to cancel authorization of terminal devices | +| 4 | Use DRM front end and DRM application, and support the system to play programs | +| 5 | Use DRM front end and DRM application, and support the system to pause programs | +| 6 | Use DRM front end and DRM application, and support the system to resume programs | +| 7 | Use DRM front end and DRM application, and support the system to stop programs | +| 8 | Use DRM front end and DRM application, and support the system to seek programs | + +#### 7.2.5 Conformity requirements of security upgrade + +| S/N | Upgrade mode | Requirement | +|-----|--------------------------------|---------------------------------------------------------------------------------------------| +| 1 | Over the air (OTA) upgrade | Support high version detection | +| 2 | | Support forced upgrade | +| 3 | | Support the system to start securely in case of signal interruption in the upgrade process | +| 4 | | Support the system to start securely in case of sudden power failure in the upgrade process | +| 5 | Internet protocol (IP) upgrade | Support high version detection | +| 6 | | Support forced upgrade | +| 7 | | Support the system to start securely in case of sudden power failure in the upgrade process | + +## 7.3 Performance conformity requirements + +#### 7.3.1 Boot time conformity requirements + +| S/N | Requirement | +|-----|-------------------------------------------------------------------------------------| +| 1 | Support the time from power on to the first startup picture is not greater than 5 s | +| 2 | Support the time from power on to the homepage is not greater than 50 s | + +### 7.3.2 Conformity requirements of channel change time + +| S/N | Requirement | +|-----|-------------------------------------------------------------------------------------| +| 1 | Support the switching time between high-definition channels is not greater than 2 s | + +## 7.4 Interface conformity requirements + +### 7.4.1 Conformity requirements of application programming interface + +It conforms to the relevant interface requirements stipulated in [ITU-T J.1206], including Annex A Conformity Test of TVOS JAVA Application Programming Interface and Annex B Conformity Test of TVOS WEB Application Programming Interface. + +#### 7.4.2 Conformity requirements of hardware abstract interface + +It conforms to the relevant interface requirements stipulated in [ITU-T J.1205], including Annex C Conformity Test of Hardware Abstract Interface. + +# 8 Test methods + +## 8.1 Test environment + +### 8.1.1 Hardware platform + +Hardware configuration requirements of dual-platform version of a smart television operating system (TVOS-C): storage capacity configuration of flash at the terminal to be tested should not be lower than 1 GB, and random access memory (RAM) storage capacity configuration should not be lower than 1 GB; central processing unit (CPU) should be configured with double kernel or above; dominant frequency should be not lower than 1 GHz. + +Hardware configuration requirements of single-platform version of a smart television operating system (TVOS-H): storage capacity configuration of flash at the terminal to be tested should not be + +lower than 256 MB, and RAM storage capacity configuration should not be lower than 512 MB; CPU dominant frequency should be not lower than 600 MHz. + +#### 8.1.2 Function and architecture test environment + +#### 8.1.2.1 Live TV test + +See Figure 1 for the block diagram of live TV test. + + + +The diagram shows a 'Code stream server' and an 'SI management server' connected to a 'Multiplexer'. The 'Multiplexer' is connected to a 'Modem' and a 'Remote controller'. The 'Modem' is connected to a 'Mixer', which is also connected to the 'Remote controller'. The 'Mixer' is connected to a 'Terminal'. The 'Terminal' is connected to a 'Display terminal' and a 'Controller' (indicated by a zigzag line). The text 'J.1207(24)' is in the bottom right corner. + +Block diagram of live TV test + +Figure 1 – Block diagram of live TV test + +##### 8.1.2.2 Video-on-demand test + +See Figure 2 for the block diagram of video-on-demand test. + + + +The diagram shows a 'Front end of video-on-demand' connected to an 'IPQAM modulator' and a 'Two-way network' (represented by a cloud). The 'IPQAM modulator' is connected to a 'Terminal'. The 'Two-way network' is also connected to the 'Terminal'. The 'Terminal' is connected to a 'Display terminal' and a 'Controller' (indicated by a zigzag line). The text 'J.1207(24)' is in the bottom right corner. + +Block diagram of video-on-demand test + +Figure 2 – Block diagram of video-on-demand test + +#### 8.1.2.3 IPTV test + +See Figure 3 for the block diagram of IPTV test. + + + +The diagram shows a 'Front end of application shop' and a 'Front end service platform of IPTV' connected to a 'Two-way' network (represented by a cloud). The 'Two-way' network is connected to a 'Terminal'. The 'Terminal' is connected to a 'Display terminal' and a 'Controller' (indicated by a zigzag line). The text 'J.1207(24)' is in the bottom right corner. + +Block diagram of IPTV test + +Figure 3 – Block diagram of IPTV test + +#### 8.1.2.4 Local audio video playing test + +See Figure 4 for the block diagram of local audio video playing test. + + + +``` + +graph LR + A[Front end of application shop] --- B((Two-way)) + B --- C[Terminal] + C --- D[Display terminal] + C --- E[Local storage device] + C -.-> F[Controller] + J120724[J.1207(24)] + +``` + +Block diagram of local audio video playing test. A 'Front end of application shop' connects to a 'Two-way' cloud, which connects to a 'Terminal'. The 'Terminal' is connected to a 'Display terminal' above it, a 'Local storage device' below it, and a 'Controller' to its right via a zigzag line. The label J.1207(24) is at the bottom right. + +**Figure 4 – Block diagram of local audio video playing test** + +##### **8.1.2.5 Human-machine test** + +See Figure 5 for the block diagram of human-machine test. + + + +``` + +graph LR + A[Front end of voice] --- B((Two-way)) + B --- C[Terminal] + C --- D[Display terminal] + C -.-> E[USB/bluetooth] + J120724[J.1207(24)] + +``` + +Block diagram of human-machine test. A 'Front end of voice' connects to a 'Two-way' cloud, which connects to a 'Terminal'. The 'Terminal' is connected to a 'Display terminal' above it and a 'USB/bluetooth' device to its right via a zigzag line. The label J.1207(24) is at the bottom right. + +**Figure 5 – Block diagram of human-machine test** + +#### **8.1.2.6 HTML5 support test** + +See Figure 6 for the block diagram of HTML5 support test. + + + +``` + +graph LR + A[HTML5 test website] --- B((Two-way)) + B --- C[Terminal] + C --- D[Display terminal] + C -.-> E[Controller] + J120724[J.1207(24)] + +``` + +Block diagram of HTML5 support test. An 'HTML5 test website' connects to a 'Two-way' cloud, which connects to a 'Terminal'. The 'Terminal' is connected to a 'Display terminal' above it and a 'Controller' to its right via a zigzag line. The label J.1207(24) is at the bottom right. + +**Figure 6 – Block diagram of HTML5 support test** + +#### **8.1.2.7 System setting test** + +See Figure 7 for the block diagram of system setting test. + + + +``` + +graph LR + A1[Code stream server] --- B[Multiplexer] + A2[Code stream server] --- B + B --- C1[Modem] + B --- C2[Modem] + C1 --- D[Mixer] + C2 --- D + D --- E[Terminal] + E --- F[Display terminal] + E -.-> G[Controller] + J120724[J.1207(24)] + +``` + +Block diagram of system setting test. Two 'Code stream server' blocks connect to a 'Multiplexer'. The 'Multiplexer' connects to two 'Modem' blocks. The top 'Modem' connects to a 'Mixer', and the bottom 'Modem' also connects to the 'Mixer'. The 'Mixer' connects to a 'Terminal'. The 'Terminal' is connected to a 'Display terminal' above it and a 'Controller' to its right via a zigzag line. The label J.1207(24) is at the bottom right. + +**Figure 7 – Block diagram of system setting test** + +#### **8.1.2.8 Application software support test** + +See Figure 8 for the block diagram of application software test. + + + +``` + +graph LR + FEA[Front end of application shop] --- TW((Two-way)) + TW --- T[Terminal] + T --- DT[Display terminal] + T --- C[Controller] + J120724[J.1207(24)] + +``` + +Block diagram of application software test. A 'Front end of application shop' block is connected to a 'Two-way' cloud, which is connected to a 'Terminal' block. The 'Terminal' block is connected to a 'Display terminal' block above it and a 'Controller' block to its right via a zigzag line. The label 'J.1207(24)' is at the bottom right. + +**Figure 8 – Block diagram of application software test** + +#### **8.1.2.9 Architecture test** + +See Figure 9 for the block diagram of system architecture test. + + + +``` + +graph LR + CSS1[Code stream server] --- M[Multiplexer] + SMS[SI management server] --- M + CSS2[Code stream server] --- M + WFE[WEB front end] --- TW((Two-way)) + TW --- T[Terminal] + M --- Modem1[Modem] + M --- Modem2[Modem] + Modem1 --- Mixer[Mixer] + Modem2 --- Mixer + Mixer --- T + T --- DT[Display terminal] + T --- C[Controller] + J120724[J.1207(24)] + +``` + +Block diagram of system architecture test. On the left, four blocks ('Code stream server', 'SI management server', 'Code stream server', and 'WEB front end') are connected to a 'Multiplexer' block. The 'WEB front end' is connected via a 'Two-way' cloud. The 'Multiplexer' is connected to two 'Modem' blocks, which are connected to a 'Mixer' block. The 'Mixer' is connected to a 'Terminal' block. The 'Terminal' block is connected to a 'Display terminal' block above it and a 'Controller' block to its right via a zigzag line. The label 'J.1207(24)' is at the bottom right. + +**Figure 9 – Block diagram of system architecture test** + +#### **8.1.3 Security test environment** + +##### **8.1.3.1 Secure boot test** + +See Figure 10 for the block diagram of secure boot test. + + + +``` + +graph LR + SBIMS[Secure boot image management system] --- T[Terminal] + subgraph SBIMS [ ] + IET[Image editing tool] + IST[Image signature tool] + TRT[Terminal recording tool] + end + T --- DT[Display terminal] + J120724[J.1207(24)] + style SBIMS fill:none,stroke:none + +``` + +Block diagram of secure boot test. A large block labeled 'Secure boot image management system' contains three sub-blocks: 'Image editing tool', 'Image signature tool', and 'Terminal recording tool'. This large block is connected to a 'Terminal' block. The 'Terminal' block is connected to a 'Display terminal' block above it. The label 'J.1207(24)' is at the bottom right. + +**Figure 10 – Block diagram of secure boot test** + +#### **8.1.3.2 Application security test** + +See Figure 11 for the block diagram of application security test. + + + +``` + +graph LR + subgraph Front_end_of_App_shop [Front end of App shop] + Signature[Signature] + Packaging[Packaging] + Certificate[Certificate] + end + Front_end_of_App_shop --- Two_way((Two-way)) + Two_way --- Terminal[Terminal] + Terminal --- Display_terminal[Display terminal] + Terminal -.- Controller[Controller] + J1207_24[J.1207(24)] + +``` + +Block diagram of application security test. A 'Front end of App shop' containing 'Signature', 'Packaging', and 'Certificate' is connected via a 'Two-way' cloud to a 'Terminal'. The 'Terminal' is connected to a 'Display terminal' and a 'Controller' via a zigzag line. Reference J.1207(24) is shown in the bottom right. + +**Figure 11 – Block diagram of application security test** + +#### **8.1.3.3 Service security test** + +See Figure 12 for the block diagram of service security test. + + + +``` + +graph LR + Integrated_CA[Integrated CA] --> Multiplexer[Multiplexer] + Code_stream1[Code stream] --> Multiplexer + SI_management_server[SI management server] --> Multiplexer + Code_stream2[Code stream] --> Multiplexer + DCAS_front_end[DCAS front end] --> Multiplexer + Multiplexer --> Modem1[Modem] + Multiplexer --> Modem2[Modem] + Modem1 --> Mixer[Mixer] + Modem2 --> Mixer + Mixer --> Terminal[Terminal] + Terminal --- Display_terminal[Display terminal] + J1207_24[J.1207(24)] + +``` + +Block diagram of service security test. Inputs include 'Integrated CA', 'Code stream', 'SI management server', 'Code stream', and 'DCAS front end' entering a 'Multiplexer'. The 'Multiplexer' output goes to two 'Modem' blocks, which then connect to a 'Mixer'. The 'Mixer' output goes to a 'Terminal', which is connected to a 'Display terminal'. Reference J.1207(24) is shown in the bottom right. + +**Figure 12 – Block diagram of service security test** + +#### **8.1.3.4 Content security test** + +See Figure 13 for the block diagram of content security test. + + + +``` + +graph LR + DRM_front_end[DRM front end] --- Two_way((Two-way)) + Stream_media_system[Stream media system] --- Two_way + Two_way --- Terminal[Terminal] + Terminal --- Display_terminal[Display terminal] + Terminal -.- Controller[Controller] + J1207_24[J.1207(24)] + +``` + +Block diagram of content security test. 'DRM front end' and 'Stream media system' are connected via a 'Two-way' cloud to a 'Terminal'. The 'Terminal' is connected to a 'Display terminal' and a 'Controller' via a zigzag line. Reference J.1207(24) is shown in the bottom right. + +**Figure 13 – Block diagram of content security test** + +#### **8.1.3.5 Security upgrade test** + +See Figure 14 for the block diagram of upgrade support test. + + + +This block diagram illustrates the upgrade test environment. A central grey box labeled 'Terminal' is connected to a 'Display terminal' above it. To the left of the 'Terminal', two boxes labeled 'Front end of OTA upgrade' and 'Front end of IP upgrade' are connected to a cloud-shaped 'Two-way' component, which in turn connects to the 'Terminal'. To the right of the 'Terminal', a 'Controller' is connected via a zigzag line representing a wireless link. The reference 'J.1207(24)' is located at the bottom right. + +Block diagram of upgrade test (Figure 14). + +**Figure 14 – Block diagram of upgrade test** + +### 8.1.4 Performance test environment + +#### 8.1.4.1 Boot time test + +See Figure 15 for the block diagram of boot time test. + + + +This block diagram shows the boot time test environment. A central grey box labeled 'Terminal' is connected to a 'Display terminal' above it. To the right of the 'Terminal', a 'Controller' is connected via a zigzag line representing a wireless link. The reference 'J.1207(24)' is located at the bottom right. + +Block diagram of boot time test (Figure 15). + +**Figure 15 – Block diagram of boot time test** + +#### 8.1.4.2 Channel change time test + +See Figure 16 for the block diagram of channel change time test. + + + +This block diagram depicts the channel change time test environment. Two boxes labeled 'Code stream server' are on the left, both connected to a 'Multiplexer'. The 'Multiplexer' is connected to two 'Modem' boxes. The top 'Modem' is connected to a 'Mixer', and the bottom 'Modem' is also connected to the same 'Mixer'. The 'Mixer' is connected to a central grey box labeled 'Terminal'. The 'Terminal' is connected to a 'Display terminal' above it and a 'Controller' to its right via a zigzag line representing a wireless link. The reference 'J.1207(24)' is located at the bottom right. + +Block diagram of channel change time test (Figure 16). + +**Figure 16 – Block diagram of channel change time test** + +### 8.1.5 Interface test environment + +#### 8.1.5.1 Test of application programming interface + +See Figure 17 for the block diagram of TVOS application programming interface test. + + + +``` + +graph TD + DCAS[DCAS] --> Multiplexer[Multiplexer] + CS1[Code stream] --> Multiplexer + SI[SI management] --> Multiplexer + CS2[Code stream] --> Multiplexer + FrontEnd[Front end] --> IPQAM[IPQAM] + FrontEnd --> TwoWay((Two-way)) + API[Application programming interface test] --> TwoWay + DRM[DRM] --> TwoWay + WEB[WEB front end] --> TwoWay + AppShop[Application shop] --> TwoWay + IPTV[IPTV] --> TwoWay + MultiScreen[Multi-screen interaction] --> TwoWay + MultiScreen --> MobileInternet((Mobile Internet)) + Multiplexer --> Modem[Modem] + Modem --> Terminal[Terminal] + IPQAM --> Terminal + TwoWay --> Terminal + TwoWay --> WiFi[Wi-Fi routing] + MobileInternet --> Mobile[Mobile] + Terminal --> Display[Display terminal] + Terminal --> Remote[Remote controller] + Terminal --> USB[USB peripheral] + Terminal -.-> BT[Bluetooth peripheral] + WiFi --> Mobile + Mobile -.-> BT + +``` + +Block diagram of TVOS application programming interface test. The diagram shows various input components (DCAS, Code stream, SI management, Front end, Application programming interface test, DRM, WEB front end, Application shop, IPTV, Multi-screen interaction) connected to a central 'Two-way' cloud. This cloud is connected to a 'Terminal' and a 'Mobile Internet' cloud. The 'Terminal' is connected to a 'Modem' and 'IPQAM' (which receive signals from a 'Multiplexer' and 'Front end'). The 'Terminal' is also connected to a 'Wi-Fi routing' unit, which is connected to a 'Mobile' device via a dashed line with a Wi-Fi symbol. The 'Terminal' is also connected to a 'Display terminal', 'Remote controller', 'USB peripheral', and 'Bluetooth peripheral' (via a dashed line with a Bluetooth symbol). The 'Mobile Internet' cloud is connected to a 'Mobile' device via a dashed line with a signal strength icon. The 'Mobile' device is also connected to the 'Wi-Fi routing' unit. + +J.1207(24) + +**Figure 17 – Block diagram of TVOS application programming interface test** + +#### 8.1.5.2 Hardware abstract interface test + +See Figure 18 for the block diagram of hardware abstract interface test. + + + +``` + +graph LR + CSS1[Code stream server] --> M[Multiplexer] + SI[SI server] --> M + CSS2[Code stream server] --> M + M --> Modem[Modem] + Modem --> Terminal[Terminal] + Terminal --> DT[Display terminal] + Terminal --> RC[Remote controller] + Terminal --> USB[USB Mouse, keyboard] + Terminal --> T((Two-way)) + T --> HAL[Hardware abstract layer interface test] + T --> WFE[WEB front end] + T --> FEI[Front end of IPTV] + +``` + +Block diagram of hardware abstract interface test. The diagram shows a flow from left to right: three boxes (Code stream server, SI server, Code stream server) point to a 'Multiplexer' box. The 'Multiplexer' box points to a 'Modem' box. The 'Modem' box points to a 'Terminal' box. The 'Terminal' box is connected to three boxes: 'Display terminal', 'Remote controller', and 'USB (Mouse, keyboard)'. Below the 'Terminal' box, a 'Two-way' cloud is connected to three boxes: 'Hardware abstract layer interface test', 'WEB front end', and 'Front end of IPTV'. + +J.1207(24) + +**Figure 18 – Block diagram of hardware abstract interface test** + +## 8.2 Test devices + +| S/N | Device name | Function description | +|-----|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Code stream server | Code stream sending server, used to output TS code stream to the multiplexer, provide system signal source and support ASI signal output. | +| 2 | SI management server | Code stream server in which programme specific information (PSI) / service information (SI) editing software is preassembled, used to output TS code stream containing SI information to the multiplexer. Support editing of programme association table (PAT), conditional access table (CAT), programme mapping table (PMT), service description table (SDT), event information table (EIT) and other tables, and have the functions of programme scheduling, programme search, user management and parameter configuration, etc. | +| 3 | Multiplexer | TS code stream multiplexer, used to multiplex multichannel TS code stream, support code stream multiplexing, demultiplexing and remultiplexing, support packet identifier (PID) remapping, and support filtering capability of PID code stream. | +| 4 | Modem | Cable/ territorial/ satellite modulator, used to modulate TS code stream to the specified frequency point. Support digital video broadcasting – cable (DVB-C) and digital television terrestrial multimedia broadcast (DTMB) modulation standards. Output radio-frequency signals; port requirements: F, 75 Ω. | +| 5 | Mixer | Channel mixer, used to mix signals at multiple frequency points and complete the output. Requirements for radio frequency input and output port: F, 75 Ω. | +| 6 | Front end of video-on-demand | Support hyper text transfer protocol (HTTP) / HTTP Live Streaming (HLS) stream media transport protocol, advanced video coding (ITU-T H.264 and MPEG-2) coded formats. Support stream media on-demand services such as audio video interleave (AVI), flash video (FLV), MPEG-1 audio layer 3 (MP3), MPEG-4 part 14 (MP4), MTP 3 user adaptation layer (M3UA) and moving picture experts group (MPEG). Be able to complete service distribution and scheduling such as media on-demand, time shift and playback. | + +| S/N | Device name | Function description | +|-----|-----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 7 | Internet protocol quadrature amplitude modulation (IPQAM) modem | Used to implement quadrature amplitude modulation (QAM) digital modulation for TS stream data from IP network. Support IP interface of gigabit Ethernet; support multiplexing, modulation and up-conversion functions. Complete QAM modulation and output of multichannel TS stream; requirements of radio frequency output interface: F, 75 Ω. | +| 8 | Front end of application shop | Implement application presentation, application classification, application search, download, and upgrade, etc. | +| 9 | Local storage device | Device with local storage function, including universal serial bus (USB) flash disk and secure digital memory card (SD card). | +| 10 | HTML5 test website | Used to test the browser's support of HTML5. | +| 11 | WEB front end | Used to support hypertext transfer protocol (HTTP) / hypertext transfer protocol secure (HTTPS) transport protocols and provide WEB services. | +| 12 | Secure boot mirror management system | Used to manage device mirror, provide binary editing, signature and recording functions of mirror. | +| 13 | Integrated CA front end | Integrated CA front end server, used to output TS code stream scrambled by integrated CA with entitlement message to the multiplexer. Have entitlement management message (EMM) and entitlement control message (ECM) message generation and sending functions. | +| 14 | DCAS front end | DCAS front end server, used to output TS code stream scrambled by DCAS with entitlement message to the multiplexer. Have EMM and ECM message generation and sending functions. | +| 15 | DRM front end | DRM front end, used to provide entitlement message and DRM encrypted code stream. Support mainstream coding formats such as MPEG-2, ITU-T H.264 and AVS+, and support mainstream transport formats such as HLS and MPEG dynamic adaptive streaming over HTTP (MPEG-DASH). | +| 16 | Stream media system | Stream media server matched with DRM front-end system, used to provide stream media services. | +| 17 | Front end of OTA upgrade | Insert upgrade descriptor in network information table (NIT), convert update software to TS file, and adopt one-way data broadcasting for terminal software upgrade. | +| 18 | Front end of IP upgrade | The front end of IP upgrade is configured with upgrade file. After the terminal starts, the monitor of IPLoader in the backend will start automatically. It regularly and periodically requests to download server configuration files and detects update. Terminal software is upgraded by applying IP two-way channel. | +| 19 | Front end of IPTV | Support HTTP/HLS stream media transport protocol, ITU-T H.264 and MPEG-2 coded formats. Support stream media on-demand services such as AVI, FLV, MP4 and MPEG. Be able to complete service distribution and scheduling such as media on-demand, time shift and playback. | +| 20 | Front end of application programming interface test | The test system providing storage and push functions for test cases of TVOS application programming interface. | +| 21 | Front end of hardware abstract interface test | The test system providing storage and push functions for test cases of TVOS hardware abstract interface. | +| 22 | Front end of function component interface test | The test system providing storage and push functions for test cases of TVOS function component interface. | + +| S/N | Device name | Function description | +|-----|-----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 23 | Front end of trusted execution environment (TEE) interface test | The test system providing storage and push functions for test cases of TVOS trusted execution environment interface. | +| 24 | Cloud control terminal of multi-screen interaction | Front end server of internet multi-screen interaction, supporting multimedia resource sharing among smartphone, tablet PC and smart television and mutual playing push. | +| 25 | Front end pf voice engine | Implement connection with voice cloud, and ensure voice data interaction, semantic match and search. | +| 26 | Display terminal | Have the television with high-definition multimedia interface (HDMI) input. | +| 27 | USB peripheral | USB interface peripheral, including USB keyboard and USB mouse, etc. | +| 28 | Bluetooth peripheral | Bluetooth interface peripheral, including voice-based remote controller, mobile phone and gamepad, etc. | + +## 8.3 Test process + +### 8.3.1 Function and architecture conformance test + +#### 8.3.1.1 Live TV test + +| S/N | Test requirement | Process description | +|-----|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Support tuning of system frequency. |
Preconditions:
Set up the test environment as shown in Figure 1, start the front end of live digital television such as code stream server and multiplexer, and open the terminal to be tested.
Test methods:
a) Enter system tuning interface.
b) Set corresponding frequency point according to situations of front-end frequency points.
Conformity result requirements:
Be able to tune to corresponding frequency point.
Preconditions:
Set up the test environment as shown in Figure 1, start the front end of live digital television such as code stream server and multiplexer, and open the terminal to be tested; the system can be tuned.
Test methods:
a) Enter system search interface.
b) Select auto search and observe search situations.
c) Select manual search and observe search situations.
d) Select range search and observe search situations.
Conformity result requirements:
a) Auto search succeeds.
b) Manual search succeeds.
c) Range search succeeds.
Preconditions:
Set up the test environment as shown in Figure 1, start the front end of live digital television such as code stream server and multiplexer, open the terminal to be tested, and ensure live programme is played normally.
Test methods:
Switch different programs with the remote controller.
Conformity result requirements:
Be able to switch programs normally.
Preconditions:
Set up the test environment as shown in Figure 1, start the front end of live digital television such as code stream server, SI server and multiplexer, and open the terminal to be tested.
Test methods:
Check the EPG information list in the system.
Conformity result requirements:
Be able to normally display the EPG information list.
Preconditions:
Set up the test environment as shown in Figure 1, start the front end of live digital television such as code stream server, SI server and multiplexer, and open the terminal to be tested.
Test methods:
a) Select EPG forward programme information list in the system.
b) Select EPG backward programme information list in the system.
Conformity result requirements:
Be able to normally display EPG forward and backward information lists.
Preconditions:
Set up the test system as shown in Figure 1, start the front end of live digital television such as code stream server and multiplexer, and open the terminal to be tested.
Test methods:
Open live audio video and measure whether audio video synchronization conforms to requirements.
Conformity result requirements:
The system can normally synchronize audio video.
Preconditions:
Set up the test system as shown in Figure 1, start the front end of live digital television such as code stream server and multiplexer, open the terminal to be tested, and ensure live stream is normal.
Test methods:
a) Check names of corresponding channels.
b) Check frequency points of corresponding channels.
c) Check programme identifier (ID) of corresponding channels.
Conformity result requirements:
Be able to normally display channel information.
Preconditions:
Set up the test environment as shown in Figure 2, start video-on-demand front end and IPQAM modulator, and open the terminal to be tested.
Test methods:
a) Enter the video-on-demand interface.
b) Select corresponding programme according to the programme list and play it.
Conformity result requirements:
Be able to play the programme on demand normally.
Preconditions:
Set up the test environment as shown in Figure 2, start video-on-demand front end and IPQAM modulator, open the terminal to be tested and successfully play the programme on demand.
Test methods:
Select pause key to pause programme playing.
Conformity result requirements:
Be able to pause playing of the programme on demand.
Preconditions:
Set up the test environment as shown in Figure 2, start video-on-demand front end and IPQAM modulator, open the terminal to be tested, successfully play the programme on demand and pause the program.
Test methods:
Select resume key to resume programme playing.
Conformity result requirements:
Be able to resume playing of the programme on demand.
Preconditions:
Set up the test environment as shown in Figure 2, start video-on-demand front end and IPQAM modulator, open the terminal to be tested and successfully play the programme on demand.
Test methods:
Select stop key to stop programme playing.
Conformity result requirements:
Be able to stop playing of the programme on demand.
Preconditions:
Set up the test environment as shown in Figure 2, start video-on-demand front end and IPQAM modulator, open the terminal to be tested and successfully play the programme on demand.
Test methods:
Select seek key to control programme playing.
Conformity result requirements:
Be able to control the programme on demand normally.
Preconditions:
Set up the test environment as shown in Figure 3 and open the terminal to be tested.
Test methods:
Enter the application store and select IPTV application.
Select relevant programs in IPTV application and play them.
Conformity result requirements:
Be able to successfully play
Preconditions:
Set up the test environment as shown in Figure 3, open the terminal to be tested, and ensure IPTV programme is in the status of normal playing.
Test methods:
Click "pause" button for the programme which is being played.
Conformity result requirements:
Be able to successfully pause corresponding program.
Preconditions:
Set up the test environment as shown in Figure 3, open the terminal to be tested, and ensure IPTV programme is in the pause status.
Test methods:
Click "resume" button for the programme which is in the pause status.
Conformity result requirements:
Be able to successfully resume corresponding program.
Preconditions:
Set up the test environment as shown in Figure 3, open the terminal to be tested, and ensure IPTV programme is in the status of normal playing.
Test methods:
Click "stop" button for the programme which is being played.
Conformity result requirements:
Be able to successfully stop corresponding program.
Preconditions:
Set up the test environment as shown in Figure 3, open the terminal to be tested, and ensure IPTV programme is in the status of normal playing.
Test methods:
Control programme progress through seek button for the programme which is being played.
Conformity result requirements:
Be able to successfully drag and drop the corresponding programme to the corresponding position.
Preconditions:
Set up the test environment as shown in Figure 4, open the terminal to be tested, and copy the audio video files required in clause 6.1.5 of [ITU-T J.1201] to a local storage device.
Test methods:
a) Insert the system device to be tested into the local storage device.
b) Select audio video files in the local storage device and play them.
Conformity result requirements:
Be able to successfully play corresponding audio video files.
Preconditions:
Set up the test environment as shown in Figure 4, open the terminal to be tested, copy the audio video files to a local storage device and ensure audio video files are played normally.
Test methods:
Click "pause" button for the audio video files which are played normally.
Conformity result requirements:
Be able to successfully pause corresponding audio video files.
Preconditions:
Set up the test environment as shown in Figure 4, open the terminal to be tested, copy the audio video files to a local storage device and ensure audio video files are in the pause status.
Test methods:
Click "resume" button for the audio video file which is in the pause status.
Conformity result requirements:
Be able to successfully resume corresponding audio video files.
Preconditions:
Set up the test environment as shown in Figure 4, open the terminal to be tested, copy the audio video files to a local storage device and ensure audio video files are played normally.
Test methods:
Click "stop" button for the audio video files.
Conformity result requirements:
Be able to successfully stop corresponding audio video files.
Preconditions:
Set up the test environment as shown in Figure 4, open the terminal to be tested, copy the audio video files to a local storage device and ensure audio video files are played normally.
Test methods:
Control programme progress through drag and drop button for the programme which is being played.
Conformity result requirements:
Be able to successfully drag and drop the corresponding programme to the corresponding position.
Preconditions: set up the test environment as shown in Figure 5. Connect the mouse to the system device to be tested via USB interface.
Test methods:
a) Move the mouse.
b) Click the left mouse button.
c) Click the right mouse button.
d) Roll the mouse wheel.
Conformity result requirements:
The system device to be tested can correctly respond to mouse actions.
Preconditions: set up the test environment as shown in Figure 5. Connect the keyboard to the system device to be tested via USB interface.
Test methods:
a) Input any character on the keyboard.
b) Input direction key on the keyboard.
Conformity result requirements:
The system device to be tested can correctly respond to keyboard operation.
Preconditions: set up the test environment as shown in Figure 5.
Test methods:
Press any key on the remote controller, including character key, direction key, HOME, and backspace key, etc.
Conformity result requirements:
The system device to be tested can correctly respond to remote controller operation.
Test methods:
Send voice command to the terminal.
Conformity result requirements:
The system device to be tested can correctly respond to voice and make corresponding operation. | +| 5 | Support mobile phone input interaction. | Preconditions: set up the test environment as shown in Figure 5.
Test methods:
Press any key on the mobile phone, including character key, direction key, HOME, and backspace key, etc.
Conformity result requirements:
The system device to be tested can correctly respond to mobile phone operation. | + +#### 8.3.1.6 HTML5 support test + +| S/N | Test requirement | Process description | +|-----|-----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Test HTML5 support by the system. | Preconditions:
Set up the test system as shown in Figure 6, and keep network signal connection.
Test methods:
Open the browser and input HTML5 test website recommended by World Wide Web Consortium (W3C).
Conformity result requirements:
Test scores conform to requirements. | + +#### 8.3.1.7 System setting test + +| S/N | Test requirement | Process description | +|-----|---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Support to restore system factory settings. | Preconditions:
Set up the test system as shown in Figure 7, and keep network signal connection. Live programs have been searched and played successfully.
Test methods:
Enter system setting interface and select factory setting reset.
Conformity result requirements:
After factory setting reset, original configuration and TV programs searched are all cleared. | + +| | | | +|---|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 2 | Support standby/awaking. |
Preconditions:
Set up the test system as shown in Figure 7, and keep network signal connection.
Test methods:
a) Press the remote controller to make the system standby.
b) Press the remote controller to awake the system.
Conformity result requirements:
System standby/awakening function is normal.
Preconditions:
Set up the test system as shown in Figure 7, start the front end of live digital television such as code stream server and multiplexer, open the terminal to be tested, and ensure live stream is normal.
Test methods:
a) Use volume "+" key on the remote controller to increase system volume.
b) Use volume "-" key on the remote controller to decrease system volume.
Conformity result requirements:
Be able to normally regulate system volume.
Preconditions:
Set up the test system as shown in Figure 7, start the front end of live digital television such as code stream server and multiplexer, open the terminal to be tested, and ensure live stream is normal.
Test methods:
a) Press "mute" button on the remote controller.
b) Press "mute" button on the remote controller again.
Conformity result requirements:
Mute the system when pressing "mute" button the first time, and cancel system mute when pressing "mute" button the second time.
Preconditions:
Set up the test environment as shown in Figure 8.
Test methods:
a) Enter application store interface and select legal and valid JAVA application.
b) Download JAVA application and install it.
Conformity result requirements:
Be able to successfully install JAVA application.
Successfully and correctly install JAVA application.
Test methods:
Run JAVA application.
Conformity result requirements:
Be able to successfully run JAVA application. | +| 3 | Support WEB application installation. | Preconditions:
Set up the test environment as shown in Figure 8.
Test methods:
a) Enter application store interface and select legal and valid WEB application.
b) Download WEB application and install it.
Conformity result requirements:
Be able to successfully install WEB application. | +| 4 | Support WEB application running. | Preconditions:
Set up the test environment as shown in Figure 8.
Test methods:
Run legal and valid WEB application.
Conformity result requirements:
Be able to successfully run WEB application. | + +#### 8.3.1.9 Architecture conformance test + +| S/N | Test requirement | Process description | +|-----|--------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | The system needs to contain two parts: TEE and REE. | Preconditions:
Set up the test environment as shown in Figure 9.
Test methods:
a) Download test TA.
b) Send test command through REE side.
Conformity result requirements:
REE side can receive the expected result fed back by test TA. | +| 2 | Media functions are processed by media engine of smart operating system. | Preconditions:
Set up the test environment as shown in Figure 9.
Test methods:
a) Open media engine log.
b) Play a video.
c) Close the log.
Conformity result requirements:
The log content can confirm the invocation of media engine by the player application. | + +| S/N | Test requirement | Process description | +|-----|----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3 | WEB application is processed by HTML5 engine of smart TV operating system. |
Preconditions:
Set up the test environment as shown in Figure 9.
Test methods:
a) Open HTML5 engine log.
b) Run WEB application.
c) Close the log.
Conformity result requirements:
The log content can confirm the invocation of HTML5 engine by WEB application.
Preconditions:
Set up the test environment as shown in Figure 9.
Test methods:
a) Open media engine log and HTML5 engine log.
b) Run WEB video player application.
c) Close the log.
Conformity result requirements:
The log content can confirm code execution is independent of JAVA execution environment.
Preconditions:
Set up the test environment as shown in Figure 10, and get BL_KEY1, Bootloader mirror, kernel mirror and system mirror without signature of the device to be tested.
Test methods:
a) Use correct BL_KEY0 to sign BL_KEY1 without signature, and use BL_KEY1 to sign Bootloader mirror, kernel mirror and system mirror without signature.
b) Use recording tools to record the above signed mirrors and other mirrors to the device to be tested.
c) After the completion of recording, power off and restart the device to be tested.
Conformity result requirements:
The device to be tested can be started normally, and finally enters the interface.
Preconditions:
Set up the test environment as shown in Figure 10, and get correctly signed BL_KEY1 mirror of the device to be tested.
Test methods:
- a) Use mirror editing tools to tamper any position of signed BL_KEY1 mirror.
- b) Use recording tools to record the above tampered mirrors and other mirrors to the device to be tested.
- c) After the completion of recording, power off and restart the device to be tested.
Conformity result requirements:
The device to be tested cannot be started.
Preconditions:
Set up the test environment as shown in Figure 10, and prepare a wrongly signed BL_KEY1 mirror.
Test methods:
- a) Use correct BL_KEY0 to sign the above BL_KEY1 mirror.
- b) Use recording tools to record the above BL_KEY1 mirror and other mirrors to the device to be tested.
- c) After the completion of recording, power off and restart the device to be tested.
Conformity result requirements:
The device to be tested cannot be started.
Preconditions:
Set up the test environment as shown in Figure 10, and get correctly signed Bootloader mirror of the device to be tested from the device manufacturer.
Test methods:
- a) Use mirror editing tools to tamper any position of signed Bootloader mirror.
- b) Use recording tools to record the above tampered mirrors and other mirrors to the device to be tested.
- c) After the completion of recording, power off and restart the device to be tested.
Conformity result requirements:
The device to be tested cannot be started.
Preconditions:
Set up the test environment as shown in Figure 10, and get Bootloader mirror without signature of the device to be tested. Prepare a wrong BL_KEY1.
Test methods:
- a) Use wrong BL_KEY1 to sign Bootload mirror without signature.
- b) Use recording tools to record the above mirror wrongly signed by BL_KEY1 and other mirrors to the device to be tested.
- c) After the completion of recording, power off and restart the device to be tested.
Conformity result requirements:
The device to be tested cannot be started.
Preconditions:
Set up the test environment as shown in Figure 10, and get correctly signed kernel mirror of the device to be tested.
Test methods:
- a) Use mirror editing tools to tamper any position of signed kernel mirror.
- b) Use recording tools to record the above tampered mirrors and other mirrors to the device to be tested.
- c) After the completion of recording, power off and restart the device to be tested.
Conformity result requirements:
The device to be tested cannot be started.
Preconditions:
Set up the test environment as shown in Figure 10, and get the kernel mirror without signature of the device to be tested. Prepare a wrong BL_KEY1.
Test methods:
- a) Use wrong BL_KEY1 to sign the kernel mirror without signature.
- b) Use recording tools to record the above mirror wrongly signed by BL_KEY1 and other mirrors to the device to be tested.
- c) After the completion of recording, power off and restart the device to be tested.
Conformity result requirements:
The device to be tested cannot be started.
Preconditions:
Set up the test environment as shown in Figure 10, and get correctly signed system mirror of the device to be tested.
Test methods:
a) Use mirror editing tools to tamper any position of signed system mirror.
b) Use recording tools to record the above tampered mirrors and other mirrors to the device to be tested.
c) After the completion of recording, power off and restart the device to be tested.
Conformity result requirements:
The device to be tested cannot be started.
Preconditions:
Set up the test environment as shown in Figure 10, and get the system mirror without signature of the device to be tested. Prepare a wrong BL_KEY1.
Test methods:
a) Use wrong BL_KEY1 to sign the system mirror without signature.
b) Use recording tools to record the above mirror wrongly signed by BL_KEY1 and other mirrors to the device to be tested.
c) After the completion of recording, power off and restart the device to be tested.
Conformity result requirements:
The device to be tested cannot be started.
Preconditions:
Set up the test environment as shown in Figure 11, and get the application installation package without signature.
Test methods:
a) Use correct operator certificate and personal certificate to sign the installation package without signature, and place it at the front end of application store.
b) Download the above signed installation package from the application store and install it.
c) Complete the installation and start the application.
The application is normally installed and started. | +| 2 | When the application installation package signed with wrong operator certificate and correct personal certificate is used, the system cannot be successfully installed. | Preconditions:
Set up the test environment as shown in Figure 11, and get the application installation package without signature.
Prepare a wrong operator certificate.
Test methods:
a) Use wrong operator certificate and correct personal certificate to sign the installation package without signature. And place it at the front end of application shop.
b) Download the above signed installation package from the application store and install it.
Conformity result requirements:
Installation fails. | +| 3 | When the application installation package signed with correct operator certificate and wrong personal certificate is used, the system cannot be successfully installed.
When the application installation package signed with correct operator certificate and wrong personal certificate is used, the system cannot be successfully installed. | Preconditions:
Set up the test environment as shown in Figure 11, and get the application installation package without signature.
Prepare a wrong personal certificate.
Test methods:
a) Use correct operator certificate and wrong personal certificate to sign the installation package without signature. And place it at the front end of application shop.
b) Download the above signed installation package from the application store and install it.
Conformity result requirements:
Installation fails. | +| 4 | When the tampered application installation package is used, the system cannot be successfully installed. | Preconditions:
Set up the test environment as shown in Figure 11, and get the application installation package with correct signature.
Test methods:
a) Use binary editing tools to tamper any position of installation package with correct signature. And place it at the front end of application shop.
b) Download the above tampered installation package from the application store and install it.
Conformity result requirements:
Installation fails. | + +| S/N | Test requirement | Process description | +|-----|----------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5 | When the application installation package without operator certificate signature is used, the system cannot be successfully installed. |
Preconditions:
Set up the test environment as shown in Figure 11, and get the application installation package without signature.
Test methods:
a) Use only personal certificate to sign the installation package without signature. And place it at the front end of application shop.
b) Download the above signed installation package from the application store and install it.
Conformity result requirements:
Installation fails.
Preconditions:
Set up the test environment as shown in Figure 11, and get the application installation package without signature.
Test methods:
a) Directly use operator certificate to sign the installation package without signature. And place it at the front end of application shop.
b) Download the above signed installation package from the application store and install it.
Conformity result requirements:
Installation fails.
Preconditions:
Set up the test environment as shown in Figure 12 and start DCAS front-end system.
Test methods:
a) Start DCAS application.
b) Start auto search, manual search and range search respectively one after another.
Conformity result requirements:
The search test in the three modes succeeds, and the programme list searched every time is consistent with the configuration of front end system.
Preconditions:
Set up the test environment as shown in Figure 12 and start DCAS front-end system. The device to be tested successfully completes one auto search.
Test methods:
a) Start DCAS application.
b) Play corresponding programs.
The programs are played normally. | +| 3 | | Use DCAS front end and DCAS application, and support the system to display EPG. | Preconditions:
Set up the test environment as shown in Figure 12 and start DCAS front-end system. The device to be tested successfully completes one auto search.
Test methods:
a) Start DCAS application.
b) Check the EPG information list in the system.
Conformity result requirements:
Be able to normally display the EPG information list. | +| 4 | | Use DCAS front end and DCAS application, and support the system to change channels. | Preconditions:
Set up the test environment as shown in Figure 12 and start DCAS front-end system. The device to be tested successfully completes one auto search.
Test methods:
a) Start DCAS application.
b) Change channels.
Conformity result requirements:
Channel change function is normal. | +| 5 | Integrated CA | Use integrated CA front end and integrated CA application, and support the system to search channels. | Preconditions:
Set up the test environment as shown in Figure 12 and start integrated CA front-end system.
Test methods:
a) Start integrated CA application.
b) Start auto search, manual search and range search respectively one after another.
Conformity result requirements:
The search test in the three modes succeeds, and the programme list searched every time is consistent with the configuration of front end system. | +| 6 | Integrated CA | Use integrated CA front end and integrated CA application, and support the system to play programs. | Preconditions:
Set up the test environment as shown in Figure 12 and start integrated CA front-end system. The device to be tested successfully completes one auto search.
Test methods:
a) Start integrated CA application.
b) Play corresponding programs.
Conformity result requirements: programs are played normally. | +| 7 | | Use integrated CA front end and integrated CA application, and support the system to display EPG. | Preconditions:
Set up the test environment as shown in Figure 12 and start integrated CA front-end system. The device to be tested successfully completes one auto search.
Test methods:
a) Start integrated CA application.
b) Check the EPG information list in the system.
Conformity result requirements:
Be able to normally display the EPG information list. | + +| S/N | Security mode | Test requirement | Process description | +|-----|---------------|-------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 8 | | Use integrated CA front end and integrated CA application, and support the system to change channels. | Preconditions:
Set up the test environment as shown in Figure 12 and start integrated CA front-end system. The device to be tested successfully completes one auto search.
Test methods:
a) Start integrated CA application.
b) Change channels.
Conformity result requirements:
Channel change function is normal. | + +#### 8.3.2.4 Content security + +| S/N | Test requirement | Process description | +|-----|------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Use DRM front end and DRM application, and support the system to register terminal devices. | Preconditions:
Set up the test environment as shown in Figure 13. DRM application has not be registered yet.
Test methods:
a) Start DRM application.
b) Click register.
Conformity result requirements:
Register succeeds. | +| 2 | Use DRM front end and DRM application, and support the system to authorize terminal devices. | Preconditions:
Set up the test environment as shown in Figure 13. DRM application has been registered, and DRM front end has not entitled the device to be tested.
Test methods:
a) Add the device to be tested at DRM front end for entitlement.
b) Start DRM application.
c) Select a protected video and play it.
Conformity result requirements:
It is played successfully. | +| 3 | Use DRM front end and DRM application, and support the system to cancel authorization of terminal devices. | Preconditions:
Set up the test environment as shown in Figure 13. DRM application has been registered, and DRM front end has entitled the device to be tested.
Test methods:
a) Delete the device to be tested at DRM front end to cancel the entitlement.
b) Start DRM application.
c) Select a protected video and play it.
Conformity result requirements:
It fails to be played. | +| 4 | Use DRM front end and DRM application, and support the system to play programs. | Preconditions:
Set up the test system as shown in Figure 13. DRM application has been registered, and DRM front end has entitled the device to be tested.
Test methods:
a) Start DRM application. | + +| S/N | Test requirement | Process description | +|-----|-----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | b) Select a protected video and play it.
Conformity result requirements:
It is played normally. | +| 5 | Use DRM front end and DRM application, and support the system to pause programs. | Preconditions:
Set up the test environment as shown in Figure 13. DRM application has been registered, and DRM front end has entitled the device to be tested.
Test methods:
a) Start DRM application.
b) Select a protected video and play it.
c) Press the pause key.
Conformity result requirements:
It is played and paused normally. | +| 6 | Use DRM front end and DRM application, and support the system to resume programs. | Preconditions:
Set up the test environment as shown in Figure 13. DRM application has been registered, and DRM front end has entitled the device to be tested.
Test methods:
a) Start DRM application.
b) Select a protected video and play it. c) Press the pause key.
d) Press the resume key.
Conformity result requirements:
It is played, paused and resumed normally. | +| 7 | Use DRM front end and DRM application, and support the system to stop programs. | Preconditions:
Set up the test environment as shown in Figure 13. DRM application has been registered, and DRM front end has entitled the device to be tested.
Test methods:
a) Start DRM application.
b) Select a protected video and play it.
c) Press the stop key.
Conformity result requirements:
It is played and stopped normally. | +| 8 | Use DRM front end and DRM application, and support the system to seek programs. | Preconditions:
Set up the test environment as shown in Figure 13. DRM application has been registered, and DRM front end has entitled the device to be tested.
Test methods:
a) Start DRM application.
b) Select a protected video and play it.
c) Control programme progress through drag and drop button for the programme which is being played.
Conformity result requirements:
Press the direction key to successfully drag and drop the corresponding programme to the corresponding position. | + +#### 8.3.2.5 Security upgrade + +| S/N | Upgrade mode | Test requirement | Process description | +|-----|--------------|-------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | OTA Upgrade | High version detection |
Preconditions:
Set up the test environment as shown in Figure 14.
Prepare a transport stream (TS) containing signed high-version mirror. Start front end of OTA upgrade.
Test methods:
a) Broadcast the transport stream containing a high version at the front end of the trusted application (TA) upgrade.
b) Enter the upgrade interface of the device to be tested.
c) Detect the version.
Conformity result requirements:
Detect a high version.
Preconditions:
Set up the test environment as shown in Figure 14.
Prepare a transport stream containing signed high-version mirror. Start front end of OTA upgrade.
Test methods:
a) Broadcast the transport stream containing the signed high-version mirror at the front end of OTA upgrade.
b) The device to be tested detects a high version, and prompts it is about to upgrade.
c) Automatically restart after upgrading.
Conformity result requirements:
The system is upgraded normally; the system is restarted normally after system upgrade; the version number is a new one after the system is restarted.
Preconditions:
Set up the test environment as shown in Figure 14.
Prepare a transport stream containing signed high-version mirror. Start front end of OTA upgrade.
Test methods:
a) Broadcast the transport stream containing the signed high-version mirror at the front end of OTA upgrade.
b) The device to be tested detects a high version, and prompts it is about to upgrade.
c) Pull up the live signal line in the upgrading process.
d) Resume the live signal line after the system is over time and restarted.
Conformity result requirements:
The system is over time and restarted, and the system will be upgraded again after restart.
Preconditions:
Set up the test environment as shown in Figure 14.
Prepare a transport stream containing signed high-version mirror. Start front end of OTA upgrade.
Test methods:
a) Broadcast the transport stream containing the signed high-version mirror at the front end of OTA upgrade.
b) The device to be tested detects a high version, and prompts it is about to upgrade.
c) Cut off the power supply in the upgrading process.
d) Electrify the device again.
Conformity result requirements:
The system will be upgraded again after restart.
Preconditions:
Set up the test environment as shown in Figure 14. Place a signed high-version mirror at the front end of IP upgrade, and start the front end of IP upgrade.
Test methods:
a) Enter the upgrade interface of the device to be tested.
b) Detect the version.
Conformity result requirements:
Detect a high version.
Preconditions:
Set up the test environment as shown in Figure 14. Place a signed high-version mirror at the front end of IP upgrade, and start the front end of IP upgrade.
Test methods:
a) The device to be tested detects a high version, and prompts it is about to upgrade.
b) Automatically restart after upgrading.
Conformity result requirements: the system is upgraded normally; the system is restarted normally after system upgrade; the version number is a new one after the system is restarted.
| +| 7 | | The system can be started securely in case of sudden power failure in the upgrade process. |Preconditions:
Set up the test environment as shown in Figure 14. Place a signed high-version mirror at the front end of IP upgrade, and start the front end of IP upgrade.
Test methods:
a) The device to be tested detects a high version, and prompts it is about to upgrade.
b) Cut off the power supply in the upgrading process.
c) Electrify the device again.
Conformity result requirements:
The system will be upgraded again after restart.
Preconditions:
Set up the test environment as shown in Figure 15.
Test methods:
a) Start the terminal to be tested and start timekeeping simultaneously.
b) Stop timekeeping when the startup picture is displayed and calculate the time.
Conformity result requirements:
The appearance time of startup picture conforms to the standard, not more than 5 s.
Preconditions:
Set up the test environment as shown in Figure 15.
Test methods:
a) Start the terminal to be tested and start timekeeping simultaneously.
b) Stop timekeeping when the main interface of the system appears and calculate the time for startup.
Conformity result requirements:
The startup time conforms to the standard, not more than 50 s.
Preconditions:
Set up the test environment as shown in Figure 16, start the front end of live digital television such as code stream server and multiplexer, open the terminal to be tested and finish channel search.
Test methods:
Switch among multiple channels, count time and test the channel change time.
Conformity result requirements: the channel change time conforms to the standard, not more than 2 s.
| + +### **8.3.4 Interface conformance test** + +#### **8.3.4.1 Conformance test of application programming interface** + +The test steps are as follows: + +- a) Set up the test system for the application programming interface of smart TV operating system as shown in Figure 17, and keep the connection between radio and television signals and internet signals; +- b) Push the test cases which conform to the application programming interface requirements in the front end system of test cases to the terminal to be tested; +- c) Operate test cases of the application programming interface of smart TV operating system and test the conformity of application programming interface. See Annex A and Annex B for the conformance test of application programming interface. + +#### **8.3.4.2 Conformance test of hardware abstract interface** + +The test steps are as follows: + +- a) Set up the test system for the hardware abstract interface of smart TV operating system as shown in Figure 18, and keep the connection between radio and television signals and internet signals; +- b) Push the test cases which conform to the hardware abstract interface requirements in the front end system of test cases to the terminal to be tested; +- c) Operate test cases of the hardware abstract layer interface of smart TV operating system and test the conformity of hardware abstract interface. See Annex C for the conformance test of hardware abstract interface. + +# Annex A + +## Conformance test of TVOS JAVA application programming interface + +(This annex forms an integral part of this Recommendation.) + +### A.1 Conformance test of unidirectional broadcast network access unit interface + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|----------------------|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | TuningParameters | getDeliverySystemType() | Conformity Requirements:Precondition: None.
Test method: Call getDeliverySystemType() method.
Conformity result: The return value is the correct current system type. | +| 2 | TuningListener | receiveNIEvent
(TunerEvent anEvent) | Conformity Requirements:
Precondition:
addNetworkInterfaceListener(TuningListener listener) registers the listener correctly.
Test method: Call tune(TuningParameters tuningParameters) to start frequency locking and wait for listener messages until frequency locking ends.
Conformity result:
The anEvent type received by receiveNIEvent(TunerEvent anEvent) is:
a) TunerTuningEvent object indicates the start of frequency locking.
b) TunerTuningOverEvent object indicates the end of frequency locking. | +| 3 | DvbcTuningParameters | DVB_C_MOD_UNDEFINED | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 0. | +| 4 | | DVB_C_MOD_QAM16 | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 1. | +| 5 | | DVB_C_MOD_QAM32 | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 2. | +| 6 | | DVB_C_MOD_QAM64 | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 3. | +| 7 | | DVB_C_MOD_QAM128 | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 4. | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|-------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 8 | | DVB_C_MOD_QAM256 | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 5. | +| 9 | | DvbcTuningParameters() | Conformity requirements:
Precondition: None.
Test method: Call DvbcTuningParameters(), call getModulation(), getFrequency(), getSymbolRate() to obtain the parameters.
Conformity results:
The return obtained from getFrequency() and getSymbolRate() is -1, and the value obtained from getModulation() is DVB_C_MOD_UNDEFINED. | +| 10 | | DvbcTuningParameters(
int frequency,
int modulation,
int symbolRate) | Conformity requirements:
Precondition: None.
Test method: Call DvbcTuningParameters (int frequency, int modulation, int symbolRate) to input the correct parameters, and call getModulation(), getFrequency(), getSymbolRate() to obtain the parameters.
Conformity results: The values obtained from getModulation(), getFrequency(), and getSymbolRate() are the same as the set values. | +| 11 | | setFrequency(int frequency) | Conformity requirements:
Precondition: None.
Test method: setFrequency() calls getFrequency() after setting parameters.
Conformity result: getFrequency() obtains the same result as setting parameters. | +| 12 | | getFrequency() | Conformity requirements:
Precondition: setFrequency(int frequency) passes in a valid parameter.
Test method: getFrequency().
Conformity result: The return value is the same as the set parameter. | +| 13 | | setModulation(int modulation) | Conformity requirements:
Precondition: None.
Test method: Call setModulation(int modulation) and input valid parameters. Call getModulation() to get the value.
Conformity result: The return value is the same as the set parameter. | +| 14 | | getModulation() | Conformity requirements:
Precondition: None.
Test method: Call setModulation(int modulation) and input valid parameters. Call getModulation() to get the value.
Conformity result: The return value is the same as the set parameter. | +| 15 | | setSymbolRate(int symbolRate) | Conformity requirements:
Precondition: None.
Test method: Call setSymbolRate(int | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------------|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | symbolRate) to input valid parameters. Call getSymbolRate() to get the value.
Conformity result: The return value is the same as the set parameter. | +| 16 | | getSymbolRate() | Conformity requirements:
Precondition: None.
Test method: Call setSymbolRate(int symbolRate) to input valid parameters. Call getSymbolRate() to get the value.
Conformity result: The return value is the same as the set parameter. | +| 17 | | ABS_SS_POLAR_LINEAR_H | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 0. | +| 18 | | ABS_SS_POLAR_LINEAR_V | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 1. | +| 19 | | ABS_SS_POLAR_CIRCULAR_L | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 2. | +| 20 | | ABS_SS_POLAR_CIRCULAR_R | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 3. | +| 21 | AbsssTuningParameters | AbsssTuningParameters() | Conformity requirements:
Precondition: None.
Test method:
Call AbsssTuningParameters() to create the object.
Conformity result: The object is successfully created. | +| 22 | | setFrequency(int freq) | Conformity requirements:
Precondition: None.
Test method: setFrequency(int freq) calls getFrequency() after setting parameters.
Conformity result: getFrequency() obtains the same result as setting parameters. | +| 23 | | getFrequency() | Conformity requirements:
Precondition: setFrequency(int frequency) passes in a valid parameter.
Test method: Call getFrequency().
Conformity result: The return value is the same as the set parameter. | +| 24 | | setPolarization(int polarization) | Conformity requirements:
Precondition: None.
Test method: Call SetPolarization(int polarization) to input valid parameters. Call getPolarization() to obtain the value. | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|----------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Conformity result: The return value is the same as the set parameter. | +| 25 | | getPolarization() | Conformity requirements:
Precondition: None.
Test method: Call SetPolarization(int polarization) to input valid parameters. Call getPolarization() to obtain the value.
Conformity result: The return value is the same as the set parameter. | +| 26 | | setSymbolRate(int symbolRate) | Conformity requirements:
Precondition: None.
Test method: Call SetSymbolRate(int symbolRate) to input valid parameters. Call getSymbolRate() to obtain the value.
Conformity result: The return value is the same as the set parameter. | +| 27 | | getSymbolRate() | Conformity requirements:
Precondition: None
Test method: Call SetSymbolRate(int symbolRate) to input valid parameters. Call getSymbolRate() to obtain the value.
Conformity result: The return value is the same as the set parameter. | +| 28 | DtmbTuningParameters | DTMB_MOD_UNDEFINED | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 0. | +| 29 | | DTMB_MOD_QAM4 | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 1. | +| 30 | | DTMB_MOD_QAM4_NR | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 2. | +| 31 | | DTMB_MOD_QAM16 | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 3. | +| 32 | | DTMB_MOD_QAM32 | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 4. | +| 33 | | DTMB_MOD_QAM64 | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 5. | +| 34 | | DTMB_MOD_QAM128 | Conformity requirements:
Precondition: None.
Test method: Determine the constant value. | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|----------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DtmbTuningParameters | | Conformity result: The constant value is 6. | +| 35 | | DTMB_MOD_QAM256 | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 7. | +| 36 | | DTMB_MOD_QAM512 | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 8. | +| 37 | | DTMB_BANDWIDTH_6M | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 6000. | +| 38 | | DTMB_BANDWIDTH_7M | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 7000. | +| 39 | | DTMB_BANDWIDTH_8M | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 8000. | +| 40 | | DtmbTuningParameters() | Conformity requirements:
Precondition: None.
Test method: Call DtmbTuningParameters() to create an object.
Conformity result: The object is successfully created. | +| 41 | | setFrequency(int frequency) | Conformity requirements:
Precondition: None.
Test method: Call setFrequency(int frequency) to input valid parameters, and call getFrequency().
Conformity result: Get the same value as the input parameter. | +| 42 | | getFrequency() | Conformity requirements:
Precondition: None.
Test method: Call setFrequency(int frequency) to input valid parameters, and call getFrequency().
Conformity result: Get the same value as the input parameter. | +| 43 | | setModulation(int bandWidth) | Conformity requirements:
Precondition: None.
Test method: Call setModulation(int modulation) to input valid parameters and call getModulation().
Conformity result: Get the same value as the input parameter. | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|----------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 44 | DtmbTuningParameters | getModulation() | Conformity requirements:
Precondition: None.
Test method: Call setModulation(int modulation) to input valid parameters, and call getModulation() to get the value.
Conformity result: Get the same value as the input parameter. | +| 45 | | setBandWidth(int bandWidth) | Conformity requirements:
Precondition: None.
Test method: Call setBandWidth(int bandWidth) to input valid parameters, and call getBandWidth() to get the value.
Conformity result: Get the same value as the input parameter. | +| 46 | | getBandWidth() | Conformity requirements:
Precondition: None.
Test method: Call setBandWidth(int bandWidth) to input valid parameters, and call getBandWidth() to get in the value.
Conformity result: Get the same value as the input parameter. | +| 47 | | getCodingRatio() | Conformity requirements:
Precondition: After successful tuning and demodulation, obtain the DTMB signal.
Test method: Call getCodingRatio().
Conformity result: Return 0.4, 0.6, or 0.8. | +| 48 | | getPNMode() | Conformity requirements:
Precondition: After successful tuning and demodulation, obtain the DTMB signal.
Test method: Call getPNMode().
Conformity result: Return a string, for example "PN945". | +| 49 | TunerEvent | getSource() | Conformity requirements:
Precondition: None.
Test method: Call getSource().
Conformity result: Return a tuner object. | +| 50 | | TunerEvent(Object Tuner) | Conformity requirements:
Precondition: None.
Test method: Call TunerEvent(Object Tuner) to input the correct parameters.
Conformity result: Create a TunerEvent object. | +| 51 | TunerTuningEvent | TunerTuningEvent (Object Tuner) | Conformity requirements:
Precondition: None.
Test method: Call TunerTuningEvent (Object Tuner) to input the correct parameters.
Conformity result: Successfully create a TunerTuningEvent object. | +| 52 | TunerTuningOverEvent | SUCCEEDED | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 0. | +| 53 | | FAILED | Conformity requirements: | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 54 | Tuner | | Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 1. | +| 55 | | TunerTuningOverEvent
(Object tuner, int status) | Conformity requirements:
Precondition: None.
Test method: Call the TunerTuningOverEvent (Object Tuner, int status) method to input the Tuner object and lock frequency status.
Conformity result: Successfully create a TunerTuningOverEvent object. | +| 56 | | getStatus() | Conformity requirement 1:
Precondition: Successfully call the tune() method and lock the frequency successfully.
Test method: Call the getStatus() method.
Conformity result: The method call succeeds and the return value is SUCCEEDED.
Conformity requirement 2:
Precondition: Successfully call the tune() method, but fail to lock the frequency.
Test method: Call the getStatus() method.
Conformity result: The method call succeeds and the return value is FAILED. | +| 57 | | tune(TuningParameters tuningParameters) | Conformity requirement 1:
Precondition: None.
Test method: Call tune(TuningParameters tuningParameters) and input the correct parameters.
Conformity result: The method call succeeds with no return values and no exceptions.
Conformity requirement 2:
Precondition: None.
Test method: Call the tune(TuningParameters tuningParameters) method and input invalid parameters.
Conformity result: Throw IllegalArgumentException exception. | +| 58 | | getSignalIntensity() | Conformity requirement 1:
Precondition: Successfully call the tune() method and lock the frequency successfully.
Test method: Call the getSignalIntensity() method and input valid parameters.
Conformity result: The method call is successful, and returns 0~100. | +| 59 | | getSignalQuality() | Conformity requirement 1:
Precondition: Successfully call the tune() method and lock the frequency successfully.
Test method: Call the getSignalQuality() method and input valid parameters.
Conformity result: The method call is successful, and returns 0~100. | +| | | getCurrentTunningParam() | Conformity requirement 1:
Precondition: It's in the process of locking. | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|-------------------|------------------------|---------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 60 | Tuner | | Test method:
Call the getCurrentTunningParam() method.
Conformity result: The method call is successful and returns NULL.
Conformity requirement 2:
Precondition: Successfully call the tune() method and lock the frequency successfully.
Test method:
Call getCurrentTunningParam().
Conformity result: Return the current lock frequency parameter. | +| 61 | | addNetworkInterfaceListener (TuningListener listener) | Conformity requirements:
Precondition: None.
Test method: AddNetworkInterfaceListener (TuningListener listener) passes in valid parameters.
Conformity result: The registered listener can receive messages. | +| 62 | | removeNetworkInterfaceListener(TuningListener listener) | Conformity Requirements:
Precondition: none.
Test method:
removeNetworkInterfaceListener (TuningListener listener) input an already registered listener object.
Conformity result: The passed-in listener object will no longer receive messages. | +| 63 | | getCurrentTransportStream() | Conformity requirement 1:
Precondition: The current network interface has been tuned to the transport stream.
Test method: getCurrentTransportStream().
Conformity result: Obtain the transport stream tuned to the current network interface.
Conformity requirement 2:
Precondition: The current network interface has not been tuned to the transport stream.
Test method: Call getCurrentTransportStream().
Conformity result: Return NULL. | +| 64 | | getDeliverySystemType() | Conformity Requirements:
Precondition: None.
Test method:
Call getDeliverySystemType().
Conformity result: Get the current network interface delivery type. | +| 65 | TunerManager | getInstance() | Conformity requirements:
Precondition: None.
Test method: Call getInstance() to obtain the TunerManager instance.
Conformity result: Successfully obtain the instance. | +| | | getNetworkInterfaces() | Conformity requirements:
Precondition: None.
Test method: Call getNetworkInterfaces() to obtain the Tuner object array.
Conformity result: Successfully obtain | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|---------------------| +| | | | Tuner object array. | + +### A.2 Conformance test of broadcasting protocol processing unit interface + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | NotAuthorized Interface | POSSIBLE_UNDER_CONDITIONS | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 0. | +| 2 | | NOT_POSSIBLE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 1. | +| 3 | | COMMERCIAL_DIALOG | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 1. | +| 4 | | MATURITY_RATING_DIALOG | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 2. | +| 5 | | TECHNICAL_DIALOG | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 3. | +| 6 | | FREE_PREVIEW_DIALOG | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 4. | +| 7 | | NO_ENTITLEMENT | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 1. | +| 8 | | MATURITY_RATING | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 2. | +| 9 | | TECHNICAL | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 3. | + +| Serial No. | Class/
Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 10 | | GEOGRAPHICAL_BLACKOUT | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 4. | +| 11 | | OTHER | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 5. | +| 12 | | SERVICE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 0. | +| 13 | | ELEMENTARY_STREAM | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 1. | +| 14 | | getType() | Conformity requirements:
Precondition: Get a subclass object of NotAuthorizedInterface.
Test method: Call the getType method.
Conformity result: The method return value is of type int, indicating the type of MPEG-2 object in which the unauthorized error occurred, and takes the value of 0 or 1. | +| 15 | | getService() | Conformity requirements:
Precondition: Obtain a subclass object of NotAuthorizedInterface.
Test method: Call the getService method.
Conformity result: The method return value is Service type, indicating the service object that cannot be descrambled. | +| 16 | | getElementaryStreams() | Conformity requirements:
Precondition: Obtain a subclass object of NotAuthorizedInterface.
Test method: Call the getElementaryStreams method.
Conformity result: The method return value is an ElementaryStream array, indicating the elementary stream object that cannot be descrambled. | +| 17 | | getReason(int index) | Conformity requirement 1:
Precondition: Obtain a subclass object of NotAuthorizedInterface.
Test method: Call the getReason method and input valid parameters.
Conformity result: The method returns an int array with a length of 2, where int [0] represents the main reason with values ranging from 0 to 1; Int [1] represents the secondary reason with values ranging from 1 to 5.
Conformity requirement 2:
Precondition: Obtain a subclass object of NotAuthorizedInterface. | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|------------------|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Test method: Call the getReason method and input invalid parameters.
Conformity result: The function throws a java.lang.IndexOutOfBoundsException exception during execution. | +| 18 | ElementaryStream | getPID() | Conformity requirements:
Precondition: Obtain the Service through the TransportStream class, and then obtain the ElementaryStream object through the Service.
Test method: Call the getPID method.
Conformity result: The method return value is of type int, and indicates the PID value of the transport packet carrying the elementary stream (ES). | +| 19 | | getAssociationTag() | Conformity requirements:
Precondition: Obtain the Service through the TransportStream class, and then obtain the ElementaryStream object through the Service.
Test method: Call the getAssociationTag method;
Conformity result: The method return value is of type Integer, indicating the digital storage media/command and control (DSM-CC) association identifier of the base stream, or NULL if there is no association identifier. | +| 20 | | getService() | Conformity requirements:
Precondition: Obtain the ElementaryStream object through the TransportStream class.
Test method: Call the getService method.
Conformity result: The method return value is Service type, indicating the service to which the ES stream belongs. | +| 21 | Service | getServiceId() | Conformity requirements:
Precondition: Obtain the Service object through the TransportStream class.
Test method: Call the getServiceId method.
Conformity result: The return value is an int type, indicating the identifier of the service (i.e. obtaining the program_number field information in PMT). | +| 22 | | getTransportStream() | Conformity requirements:
Precondition: Obtain Service object.
Test method: Call the getTransportStream method.
Conformity result: The method returns a value of TransportStream type, indicating the transport stream object that carries the service. | +| 23 | | retrieveElementaryStream(int pid) | Conformity requirement 1:
Precondition: Obtain the Service object through the TransportStream class.
Test method: Call the retrieveElementaryStream method and input valid parameters.
Conformity result: The return value is ElementaryStream type, indicating the corresponding elementary stream objects included in the service. | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 24 | TransportStream | retrieveElementaryStreams() | Conformity requirement 2:
Precondition: Obtain the Service object through the TransportStream class.
Test method: Call the retrieveElementaryStream method and input invalid parameters.
Conformity result: The method return value is empty. | +| 25 | | getTransportStreamId() | Conformity requirements:
Precondition: Obtain the TransportStream object.
Test method: Call the getTransportStreamId method.
Conformity result: The method return value is an int type, indicating the transport stream identifier (i.e. obtaining information from the transport_stream_id field in PAT). | +| 26 | | retrieveService(int serviceId) | Conformity requirement 1:
Precondition: Obtain the TransportStream object.
Test method: Call the retrieveService method and input valid parameters.
Conformity result: The method returns a Service object, indicating the corresponding service object carried in the transport stream.
Conformity requirement 2:
Precondition: Obtain the TransportStream object.
Test method: Call the retrieveService method and input invalid parameters.
Conformity result: The method return value is empty. | +| 27 | | retrieveServices() | Conformity requirements:
Precondition: Obtain the TransportStream object.
Test method: Call the retrieveServices method.
Conformity result: The method return value is a Service array, indicating all service objects carried in the transport stream. | +| 28 | DvbElementaryStream | getComponentTag() | Conformity requirements:
Precondition: Obtain DvbElementaryStream object.
Test method: Call the getComponentTag method.
Conformity result: The method return value is an Integer type, indicating the component label of the DVB elementary stream (i.e. the value of the component_tag field of the stream identifier descriptor carried by the ES stream loop in the PMT). | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 29 | DvbService | retrieveDvbElementaryStream | Conformity requirements:
Precondition: Obtain DvbService object.
Test method: Call the retrieveDvbElementaryStream method.
Conformity result: The method return value is of DvbElementaryStream type, indicating the DVB elementary stream included in the DVB service. | +| 30 | DvbTransport Stream | getNetworkId() | Conformity requirements:
Precondition: Obtain DvbTransportStream object.
Test method: Call the getNetworkId method.
Conformity result: The method return value is an int type, indicating the network identifier of the network where the DVB transport stream is located. | +| 31 | | getOriginalNetworkId() | Conformity requirements:
Precondition: Obtain DvbTransportStream object.
Test method: Call the getOriginalNetworkId method.
Conformity result: The method return value is an int type, indicating the original network identifier of the DVB transport stream. | +| 32 | SectionFilterListener | sectionFilterUpdate() | Conformity requirement 1:
Precondition: The effective frequency point has been tuned and locked.
Test method:
a) Construct and implement the SectionFilterListener object;
b) Call the newSimpleSectionFilter method of the SectionFilterGroup to create a pair of SectionFilter objects, call setTimeout to set a timeout, and call addSectionFilterListener to bind listeners;
c) Call the attach method of SectionFilterGroup;
d) Call the startFiltering method of SectionFilter and input valid parameters;
e) Wait for callback sectionFilterUpdate.
Conformity result: The sectionFilterUpdate callback is successful, and the parameter event value is an instance of sectionAvailableEvent.
Conformity requirement 2:
Precondition: The effective frequency point has been tuned and locked.
Test method:
a) Construct and implement the SectionFilterListener object;
b) Call the newSimpleSectionFilter method of the SectionFilterGroup to create a pair of SectionFilter objects, call setTimeout to set a timeout, and call addSectionFilterListener to bind listeners; | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
c) Call the attach method of SectionFilterGroup;
d) Call the startFiltering method of SectionFilter and input parameters that do not exist in the current locked frequency point;
e) Wait for callback sectionFilterUpdate.
Conformity result: The sectionFilterUpdate callback is successful, with the parameter event being a TimeOutEvent instance.
| +| 33 | Section | clone() |Conformity requirement 1:
Precondition: Obtain Section object.
Test method: Call the clone method.
Conformity result: The method return value is Object type, indicating the copied Section object.
Conformity requirement 2:
Precondition: Obtain Section object.
Test method: First call the setEmpty method and then call the clone method.
Conformity result: Throw the exception of NoDataAvailableException during function execution.
Conformity requirement 1:
Precondition: Obtain Section object.
Test method: Call the current_next_indicator method.
Conformity result: The method return value is a boolean type, indicating the value of the current next_indicator field in the segment header.
Conformity requirement 2:
Precondition: Obtain Section object.
Test method: First call the setEmpty method, and then call the current_next_indicator method.
Conformity result: Throw the exception of NoDataAvailableException during function execution.
Conformity requirement 1:
Precondition: Get Section object.
Test method: Call the getByteAt method and input valid parameters.
Conformity result: The method returns a byte value, indicating the specified byte of segment data filtered from the object.
Conformity requirement 2:
Precondition: Get Section object.
Test method: First call the setEmpty method, then call the getByteAt method, and input valid parameters.
Conformity result: Throw the exception of NoDataAvailableException during function execution.
Conformity requirement 3:
Precondition: Obtain Section object.
Test method: Call the getByteAt method and
Conformity result: A java.lang.IndexOutOfBoundsException is thrown during method execution. | +| 36 | | getData() | Conformity requirement 1:
Precondition: Obtain Section object.
Test method: Call the getData method.
Conformity result: The method return value is a byte array, indicating that the filtered segment data includes the segment header.
Conformity requirement 2:
Precondition: Obtain Section object.
Test method: first call the setEmpty method, then call the getData method.
Conformity result: Throw the exception of NoDataAvailableException during function execution. | +| 37 | | getFullStatus() | Conformity requirement 1:
Precondition: Get Section object.
Test method: Call the getFullStatus method.
Conformity result: The method return value is Boolean with a value of true.
Conformity requirement 2:
Precondition: Get Section object.
Test method: First call the setEmpty method, and then call the getFullStatus method.
Conformity result: The method return value is Boolean with a value of false. | +| 38 | | last_section_number() | Conformity requirement 1:
Precondition: Get Section object.
Test method: Call the last_section_number method.
Conformity result: The method return value is an int, indicating the value of the last_section_number field in the segment header.
Conformity requirement 2:
Precondition: Get Section object.
Test method: first call the setEmpty method, and then call the last_section_number method.
Conformity result: Throw the exception of NoDataAvailableException during function execution. | +| 39 | | private_indicator() | Conformity requirement 1:
Precondition: Get Section object.
Test method: Call the private_indicator method.
Conformity result: The method returns an int value that indicates the value of the private_indicator field in the segment header.
Conformity requirement 2:
Precondition: Get Section object.
Test method:
First call the setEmpty method, and then call the | + +| Serial No. | Class/
Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Section | | private_indicator method.
Conformity result: Throw the exception of NoDataAvailableException during function execution. | +| 40 | | section_length() | Conformity requirement 1:
Precondition: Get Section object.
Test method: Call the section_length method.
Conformity result: The method return value is an int type, indicating the value of the section_length field in the segment header.
Conformity requirement 2:
Precondition: Get Section object.
Test method: First call the setEmpty method, then call the section_length method.
Conformity result: Throw the exception of NoDataAvailableException during function execution. | +| 41 | | section_number() | Conformity requirement 1:
Precondition: Get Section object.
Test method: Call the section_number method.
Conformity result: The method return value is an int type, indicating the value of the section_number field in the segment header.
Conformity requirement 2:
Precondition: Get Section object.
Test method: First call the setEmpty method, then call the section_number method.
Conformity result: Throw the exception of NoDataAvailableException during function execution. | +| 42 | | section_syntax_indicator() | Conformity requirement 1:
Precondition: Get Section object.
Test method: Call the section_syntax_indicator method.
Conformity result: The method return value is Boolean, indicating the value of the section_syntax_indicator field in the segment header.
Conformity requirement 2:
Precondition: Get Section object.
Test method: First call the setEmpty method, then call the section_syntax_indicator method.
Conformity result: Throw the exception of NoDataAvailableException during function execution. | +| 43 | | setEmpty() | Conformity requirements:
Precondition: Get Section object.
Test method: Call the setEmpty method.
Conformity result: The method execution is successful. | +| 44 | | table_id_extension() | Conformity requirement 1:
Precondition: Get Section object.
Test method: Call the table_id_extension method.
Conformity result: The method returns an int | + +| Serial No. | Class/
Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Section | | value, indicating the value of the table_id_extension field.
Conformity requirement 2:
Precondition: Get Section object.
Test method: First call the setEmpty method, and then call the table_id_extension method.
Conformity result: Throw the exception of NoDataAvailableException during function execution. | +| 45 | | table_id() | Conformity requirement 1:
Precondition: Get Section object.
Test method: Call the table_id method.
Conformity result: The method return value is an int type, indicating the table_id field of the segment.
Conformity requirement 2:
Precondition: Get Section object.
Test method: First call the setEmpty method, then call the table_id method.
Conformity result: Throw the exception of NoDataAvailableException during function execution. | +| 46 | | version_number() | Conformity requirement 1:
Precondition: Get Section object.
Test method: Call the version_number method.
Conformity result: The method return value is short, indicating the value of the version number field.
Conformity requirement 2:
Precondition: Get Section object.
Test method: First call the setEmpty method, and then call the version_number method.
Conformity result: Throw the exception of NoDataAvailableException during function execution. | +| 47 | SectionFilterGroup | SectionFilterGroup() | Conformity requirement 1:
Precondition: None.
Test method: Call the SectionFilterGroup method and input valid parameters.
Conformity result: The method call succeeds and creates a section filter group object.
Conformity requirement 2:
Precondition: None.
Test method: Call the SectionFilterGroup method and input invalid parameters (less than 1).
Conformity result: The method throws an IllegalArgumentException exception. | +| 48 | | addResourceStatusEventListener() | Conformity requirements:
Precondition: The SectionFilterGroup object has been created.
Test method: Call the addResourceStatusEventListener method and input valid parameters.
Conformity result: The method call succeeds. | +| 49 | | removeResourceStatusEventListener() | Conformity requirements:
Precondition: The SectionFilterGroup object has been created. | + +| Serial No. | Class/
Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Test method: Call the
removeResourceStatusEventListener method and input valid parameters.Conformity result: The method call succeeds. | +| 50 | SectionFilterGroup |
attach() | Conformity requirement 1:Precondition: The effective frequency point has been tuned and locked, and the
SectionFilterGroup object has been created.Test method: Call the
attach method and input valid parameters.Conformity result: The method returns a value of true.
Conformity requirement 2:
Precondition: The effective frequency point has been tuned and locked, and the
SectionFilterGroup object has been created.Test method: Continuously call the
attach method and input valid parameters.Conformity result: The method returns a value of false. | +| 51 | |
detach() | Conformity Requirement 1.Preconditions: The effective frequency point has been tuned and locked, and the
SectionFilterGroup object has been created.Test method: Call the
attach method first, input valid parameters, and then call detach .Conformity result: The method return value is true. | +| 52 | |
getClient() | Conformity Requirements.Precondition:
SectionFilterGroup object has been created.Test method: Call the
attach method first, input valid parameters, and then call getClient .Conformity result: The method return value is the same as the input client parameter. | +| 53 | |
getSource() | Conformity Requirements.Precondition:
SectionFilterGroup object has been created.Test method: Call
attach method first, input valid parameters, then call getSource .Conformity result: The method return value is the same as the input stream parameter. | +| 54 | |
newRingSectionFilter(int ringSize) | Conformity Requirements.Precondition:
SectionFilterGroup object has been created.Test method: Call the
newRingSectionFilter(int ringSize) method.Conformity result: The method returns non-null. | +| 55 | |
newRingSectionFilter(int ringSize, int sectionSize) | Conformity Requirement 1.Precondition: The
SectionFilterGroup object has been created.Test method: Call
newRingSectionFilter(int ringSize, int sectionSize) method with valid parameters.Conformity result: The method returns a non-empty
TableSectionFilter object.Conformity Requirement 2.
Precondition: The
SectionFilterGroup object has |
+
+| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|-----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | SectionFilterGroup | | been created.
Test method: Call newRingSectionFilter(int ringSize, int sectionSize) method with invalid parameters.
Conformity result: Throw the exception of IllegalArgumentException during method execution. | +| 56 | | newSimpleSectionFilter() | Conformity requirements:
Precondition: The SectionFilterGroup object has been created.
Test method: Call the newSimpleSectionFilter() method.
Conformity result: The method returns non-null. | +| 57 | | newSimpleSectionFilter(int sectionSize) | Conformity requirement 1:
Precondition: The SectionFilterGroup object has been created.
Test method: Call the newSimpleSectionFilter (int sectionSize) method and input valid parameters.
Conformity result: The method returns a non empty TableSectionFilter object.
Conformity requirement 2:
Precondition: The SectionFilterGroup object has been created.
Test method: Call the newSimpleSectionFilter (int sectionSize) method and input invalid parameters.
Conformity result: Throw the exception of IllegalArgumentException during method execution. | +| 58 | | newTableSectionFilter() | Conformity Requirement.
Precondition: SectionFilterGroup object has been created.
Test method: Call newTableSectionFilter() method.
Conformity result: The method returns non-null. | +| 59 | | newTableSectionFilter(int sectionSize) | Conformity requirement 1:
Precondition: The SectionFilterGroup object has been created.
Test method: Call the newTableSectionFilter(int sectionSize) method and input valid parameters.
Conformity result: The method returns a non empty TableSectionFilter object.
Conformity requirement 2:
Precondition: The SectionFilterGroup object has been created.
Test method: Call the newTableSectionFilter(int sectionSize) method and input invalid parameters.
Conformity result: Throw the exception of IllegalArgumentException during method execution. | + +| Serial No. | Class/
Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 60 | SectionFilter | addSectionFilterListener() | Conformity requirements:
Precondition: The SectionFilterGroup object has been created, and newRingSectionFilter(int ringSize) is called to get the SectionFilter object.
Test method: Call the addSectionFilterListener method.
Conformity result: The method execution is successful. | +| 61 | | removeSectionFilterListener() | Conformity requirements:
Precondition: The SectionFilterGroup object has been created, and newRingSectionFilter(int ringSize) is called to get the SectionFilter object.
Test method: Call the removeSectionFilterListener method.
Conformity result: The method execution is successful. | +| 62 | | setTimeout() | Conformity requirement 1:
Precondition: The SectionFilterGroup object has been created, and newSimpleSectionFilter() is called to get the SectionFilter object.
Test method: Call the setTimeout method and input valid parameters.
Conformity result: The method execution is successful.
Conformity requirement 2:
Precondition: The SectionFilterGroup object has been created, and newSimpleSectionFilter() is called to obtain the SectionFilter object.
Test method: Call the setTimeout method and input invalid parameters.
Conformity results: Throw the exception of IllegalArgumentException during method execution. | +| 63 | | startFiltering() | Conformity requirement 1:
Precondition: The effective frequency point has been tuned and locked, a SectionFilterGroup object has been created, and newSimpleSectionFilter() has been called to get the SectionFilter object.
Test method: Call the startFiltering method and input valid parameters.
Conformity result: The method returns a value of true.
Conformity requirement 2:
Precondition: The effective frequency point has been tuned and locked, a SectionFilterGroup object has been created, and newSimpleSectionFilter() has been called to obtain the SectionFilter object.
Test method: Call the startFiltering method twice in a row and input valid parameters.
Conformity result: The method returns a value of false. | + +| Serial No. | Class/
Interface | Constant field/Attribute/Method | Process description | +|------------|----------------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 64 | | stopFiltering() |
Conformity requirement 1:
Precondition: The effective frequency point has been tuned and locked, a SectionFilterGroup object has been created, and newSimpleSectionFilter() has been called to obtain the SectionFilter object.
Test method: Call the stopFiltering method and input valid parameters.
Conformity result: The method returns a value of false.
Conformity requirement 2:
Precondition: The effective frequency point has been tuned and locked, a SectionFilterGroup object has been created, and newSimpleSectionFilter() has been called to obtain the SectionFilter object.
Test method: First call the startFiltering method, input valid parameters, and then call stopFiltering.
Conformity result: The method returns a value of true.
Conformity requirement 1:
Preconditions: Effective frequency points have been tuned and locked, a SectionFilterGroup object has been created, newSimpleSectionFilter() has been called to get the SectionFilter object, and timeouts and listeners have been set.
Test method: Call the startFiltering method, input valid parameters, wait for the callback SectionAvailableEvent message, and then call the getSection method.
Conformity result: The method return value is a non empty object.
Conformity requirement 2:
Preconditions: Effective frequency points have been tuned and locked, a SectionFilterGroup object has been created, newSimpleSectionFilter() has been called to get the SimpleSectionFilter object, and timeouts and listeners have been set.
Test method: First call the startFiltering method, input valid parameters, and then call the getSection method before the listener receives the SectionAvailableEvent message.
Conformity result: The method return value is empty.
Conformity requirement 1:
Preconditions: Effective frequency points have been tuned and locked, a SectionFilterGroup object has been created, newTableSectionFilter() has been called to get the TableSectionFilter object, and timeouts and listeners have been set.
Test method: Call the startFiltering method, input valid parameters, wait for the callback EndOfFilteringEvent message, and then call the getSections method.
Conformity result: The method return value is a non empty object.
Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
Conformity requirement 2:
Preconditions: Effective frequency points have been tuned and locked, a SectionFilterGroup object has been created, newTableSectionFilter() has been called to obtain the TableSectionFilter object, and timeouts and listeners have been set.
Test method: First call the startFiltering method, input valid parameters, and then call the getSections method before the listener receives the EndOfFilteringEvent message.
Conformity result: The method return value is empty.
Conformity requirement 1:
Preconditions: Effective frequency points have been tuned and locked, a Section Filter Group object has been created, newRingSectionFilter (int ringSize) is called to get the RingSectionFilter object, and timeouts and listeners are set.
Test method: Call the startFiltering method, input valid parameters, wait for the callback SectionAvailableEvent message, and then call the getSections method.
Conformity result: The method return value is a non empty object.
Conformity requirement 2:
Preconditions: Effective frequency points have been tuned and locked, a Section Filter Group object has been created, newRingSectionFilter (int ringSize) is called to get the RingSectionFilter object, and timeouts and listeners are set.
Test method: First call the startFiltering method, input valid parameters, and then call the getSections method before the listener receives the SectionAvailableEvent message.
Conformity result: The method return value is empty.
Conformity requirements:
Precondition: The effective frequency point has been tuned and locked.
Test method:
- a) Construct and implement the SectionFilterListener object;
- b) Call the newSimpleSectionFilter method of the SectionFilterGroup to create a pair of SectionFilter objects, call setTimeout to set a timeout, and call addSectionFilterListener to bind listeners;
- c) Call the attach method of SectionFilterGroup;
- d) Call the startFiltering method of SectionFilter and input valid parameters;
- e) Wait for the callback sectionFilterUpdate to obtain the sectionFilterEvent object;
- f) Call the getSource method.
Interface | Constant field/Attribute/Method | Process description | +|------------|----------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Conformity result: The return value is the filter object created in step b). | +| 69 | | getAppData() |
Conformity requirements:
Precondition: The effective frequency point has been tuned and locked.
Test method:
a) Construct and implement the SectionFilterListener object;
b) Call the newSimpleSectionFilter method of the SectionFilterGroup to create a pair of SectionFilter objects, call setTimeout to set a timeout, and call addSectionFilterListener to bind listeners;
c) Call the attach method of SectionFilterGroup;
d) Call the startFiltering method of SectionFilter and input valid parameters;
e) Wait for the callback sectionFilterUpdate to obtain the sectionFilterEvent object;
f) Call the getAppData method.
Conformity result: The return value is consistent with the input appData parameter values in step d.
| +| 70 | VersionChangeDetectedEvent | getOriginalVersion() |Conformity requirements:
Precondition: By obtaining the time of the SectionFilterEvent, obtain the event that the Section has changed, which is the VersionChangeDetectedEvent object.
Test method: Call the getOriginalVersion method.
Conformity result: The method returns an int type value, indicating the old version number of the segment data.
Conformity requirements:
Precondition: By obtaining the SectionFilterEvent event, obtain the event that the Section has changed, which is the VersionChangeDetectedEvent object.
Test method: Call the getNewVersion method.
Conformity result: The method returns an int value, indicating the new version number of the segment data.
Conformity requirements:
Precondition: Get the ForcedDisconnectedEvent object.
Test method: Call the getSource method.
Conformity result: The method return value is the corresponding filter.
Conformity requirement 1:
Precondition: None.
Test method: Call the Locator method.
Conformity result: The method return value is a non empty Locator object.
Conformity requirement 2:
Precondition: None.
Test method: Call the Locator method and input
Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Locator | | parameters.
Conformity result: The method return value is a non empty Locator object. | +| 74 | | hasMultipleTransformations() | Conformity requirements:
Precondition: The Locator object has been created.
Test method: Call the hasMultipleTransformations method.
Conformity result: The method return value is a value of false. | +| 75 | | toExternalForm() | Conformity requirement 1:
Precondition: None.
Test method: Call Locator, input string parameters, and then call toExternalForm method.
Conformity result: The method return value is consistent with the input string. | +| 76 | | toString() | Conformity requirement 1:
Precondition: None.
Test method: Call Locator, and then call the toString method.
Conformity result: The method return value is NULL.
Conformity requirement 2:
Precondition: None.
Test method: Call Locator, input string parameters, and then call toString method.
Conformity result: The method return value is consistent with the input string. | +| 77 | | equals() | Conformity requirement 1:
Precondition: None.
Test method: Call the Locator method, input the same parameters, construct two objects, and then call The equals method.
Conformity result: The method return value is a value of true.
Conformity requirement 2:
Precondition: None.
Test method: Call the Locator method to input different string parameters, and then call the equals method.
Conformity result: The method return value is a value of false. | +| 78 | DvbLocator | DvbLocator() | Conformity requirement 1:
Precondition: None.
Test method: Call the Locator method and enter invalid parameters.
Conformity result: Thrown the exception of an InvalidLocatorException during method execution.
Conformity requirement 2:
Precondition: None.
Test method: Call the Locator method, input validparameters in the format "dvb://original_network_id.transport_stream_id". | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DvbLocator | |
Conformity result: The method returns a DvbLocator object.
Conformity requirement 3:
Precondition: None.
Test method: Call the Locator method, input validparameters in the format "dvb://original_network_id.transport_stream_id.service_id.component_tag{&component_tag};event_id/filepath".
Conformity result: The method returns a DvbLocator object.
Conformity requirement 4:
Precondition: None.
Test method: Call the method of DvbLocator(int onid, int tsid, int serviceid, int eventid,int[] componenttags, String filePath), and input validparameters.
Conformity result: The method returns a DvbLocator object.
| +| 79 | | getComponentTags() |Conformity requirement 1:
Precondition: Construct a DvbLocator object using a uniform resource locator (URL) without component_tag.
Test method: Call the getComponentTags method.
Conformity result: The method returns an empty object.
Conformity requirement 2:
Precondition: Construct a DvbLocator object using a URL with component_tag.
Test method: Call the getComponentTags method.
Conformity result: The method returns a non empty object.
| +| 80 | | getEventId() |Conformity requirement 1:
Precondition: Construct a DvbLocator object using a URL without event_id.
Test method: Call the getEventId method.
Conformity result: The method returns a null value of -1.
Conformity requirement 2:
Precondition: Construct a DvbLocator object using a URL with event_id.
Test method: Call the getEventId method.
Conformity result: The method returns he same decimal value as the input event_id.
| +| 81 | | getFilePath() |Conformity requirement 1:
Precondition: Construct a DvbLocator object using a URL without a filepath.
Test method: Call the getFilePath method.
Conformity result: The method returns an empty object.
Conformity requirement 2:
Precondition: Construct a DvbLocator object
| + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|------------------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DvbLocator | | using a URL with event_id.Test method: Call the getFilePath method.
Conformity result: The method returns the input filepath value. | +| 82 | | getOriginalNetworkId() | Conformity requirements:
Precondition: The DvbLocator object has been constructed.
Test method: Call the getOriginalNetworkId method.
Conformity result: The method returns the same decimal value as the original_network_id. | +| 83 | | getTransportStreamId() | Conformity requirements:
Precondition: The DvbLocator object has been constructed.
Test method: Call the getTransportStreamId method.
Conformity result: The method returns the same decimal value as the transport_stream_id. | +| 84 | | getServiceId() | Conformity requirements:
Precondition: The DvbLocator object has been constructed.
Test method: Call the getServiceId method.
Conformity result: The method returns the same decimal value as the service_id. | +| 85 | | toExternalForm() | Conformity requirement 1:
Precondition: None.
Test method: Call the Locator method, input a valid parameter in the format of "dvb://original_network_id.transport_stream_id.service_id.component_tag{&component_tag};event_id/filepath", call the toExternalForm method.
Conformity result: The method returns a string that matches the input parameter.
Conformity requirement 2:
Precondition: None.
Test method: Call the DvbLocator(int onid, int tsid, int serviceid, int eventid, int[] componenttags, String filePath) method with input valid parameters and then call the toExternalForm method.
Conformity result: The method returns a string starting with dvb://. | +| 86 | DvbNetworkBoundLocator | DvbNetworkBoundLocator() | Conformity requirement 1:
Precondition: None.
Test method: Call the DvbNetworkBoundLocator method and input valid parameters.
Conformity result: The method returns the DvbNetworkBoundLocator object.
Conformity requirement 2:
Precondition: None.
Test method: Call the DvbNetworkBoundLocator method and input | + +| Serial No. | Class/
Interface | Constant field/Attribute/Method | Process description | +|------------|-------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | invalid parameters.
Conformity result: Throw
InvalidLocatorExceptionEx exception during
method execution. | +| 87 | | getNetworkId() | Conformity requirements:
Precondition: None.
Test method: Call the
DvbNetworkBoundLocator method, input valid
parameters, and call the getNetworkId method.
Conformity result: The method return value is
the same as the input parameter value. | +| 88 | | SI_BOUQUET | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 0. | +| 89 | | SI_NETWORK | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 1. | +| 90 | | SI_SERVICE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 2. | +| 91 | | SI_TS | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 3. | +| 92 | | SI_ES | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 4. | +| 93 | SICommonInf
ormation | SI_EVENT | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 5. | +| 94 | | SI_TIME | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 6. | +| 95 | | getType() | Conformity requirements:
Precondition: Get SICommonInformation
instance.
Test method: Call the getType method.
Conformity result: The method returns an int
value with a range of 0 to 6. | +| 96 | | getSIDatabase() | Conformity requirements:
Precondition: Get SICommonInformation
instance.
Test method: Call the getSIDatabase method.
Conformity result: The method returns a value
of SIDatabase type, indicating the PSI/SI
database to which the SI object of this interface
belongs. | +| 97 | SINetwork | getNetworkID() | Conformity requirements:
Precondition: Get the SINetwork instance.
Test method: Call the getNetworkID method.
Conformity result: The method returns an int
value, indicating the acquisition of the network | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 98 | SINetwork | getNetworkName() | identifier (i.e., the network_id field of NIT).
Conformity requirements:
Precondition: Get the SINetwork instance.
Test method: Call the getNetworkName method.
Conformity result: The method returns a String value, indicating the acquisition of the network identifier (i.e., the network_id field of NIT). | +| 99 | | getShortNetworkName() | Conformity requirements:
Precondition: Get the SINetwork instance.
Test method: Call the getShortNetworkName method.
Conformity result: The method return value is a String type, indicating the abbreviation of the network name. | +| 100 | | getServicesLocators() | Conformity requirements:
Precondition: Get the SINetwork instance.
Test method: Call the getServicesLocators method.
Conformity result: The method returns an array of objects with a value of org.davic.net.dvb.DvbLocator, indicating the locators for all services in the network. | +| 101 | | getService(DvbLocator locator) | Conformity requirement 1:
Precondition: Get the SINetwork instance.
Test method: Call the getService method and input valid parameters.
Conformity result: The method returns a non empty SIService object.
Conformity requirement 2:
Precondition: Obtain the SINetwork instance.
Test method: Call the getService method and input invalid parameters.
Conformity result: The method returns an empty object. | +| 102 | | getNetwork() | Conformity requirements:
Precondition: Get SIBouquet instance.
Test method: Call the getNetwork method.
Conformity result: The method return value is of type SINetwork, indicating the network object. | +| 103 | SIBouquet | getNetworkID() | Conformity requirements:
Precondition: Get SIBouquet instance.
Test method: Call the getNetworkID method.
Conformity result: The method return value is of type int, indicating the network identity. | +| 104 | | getBouquetID() | Conformity requirements:
Precondition: Get SIBouquet instance.
Test method: Call the getBouquetID method.
Conformity result: The method return value is of type int , indicating the Bouquet identifier (i.e., the bouquet_id field in the BAT table). | +| 105 | | getBouquetName() | Conformity requirements:
Precondition: Get SIBouquet instance. | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | SIBouquet | | Test method: Call the getBouquetName method.
Conformity result: The method return value is of type String, indicating the full name of the Bouquet group. | +| 106 | | getShortBouquetName() | Conformity requirements:
Precondition: Get SIBouquet instance.
Test method: Call the getShortBouquetName method.
Conformity result: The method return value is of type String, indicating the abbreviation of the bouquet name obtained. | +| 107 | | getService() | Conformity requirements:
Precondition: Get SIBouquet instance.
Test method: Call the getService method.
Conformity result: The method return value is the SIService object. | +| 108 | | getServicesLocators() | Conformity requirements:
Precondition: Get SIBouquet instance.
Test method: Call the getServicesLocators method.
Conformity result: Method return value is an org.davic.net.dvb.DvbNetworkBoundLocator array. | +| 109 | SIService | getServiceName() | Conformity requirements:
Precondition: Get SIService instance.
Test method: Call the getServiceName method.
Conformity result: Method return value is a java.lang.String object, indicating the full name of the Service. | +| 110 | | getShortServiceName() | Conformity requirements:
Precondition: Get SIService instance.
Test method: Call the getShortServiceName method.
Conformity result: The method return value is a java.lang.String object, indicating the abbreviation of the Service name. | +| 111 | | getServiceProviderName() | Conformity requirements:
Precondition: Get SIService instance.
Test method: Call the getServiceProviderName method.
Conformity result: The method return value is a Java.lang.String object, indicating the full name of the Service provider. | +| 112 | | getShortServiceProviderName() | Conformity requirements:
Precondition: Get SIService instance.
Test method: Call the getShortServiceProviderName method.
Conformity result: The method return value is a java.lang.String object, indicating the abbreviation of the Service provider. | +| 113 | | getServiceType() | Conformity requirements: | + +| Serial No. | Class/
Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Precondition: Get SIService instance.
Test method: Call the getServiceType method.
Conformity result: The method return value is to obtain the service type (service_type), with a value range of 0 to 12. | +| 114 | | getChannelNumber() | Conformity requirements:
Precondition: Get SIService instance.
Test method: Call the getChannelNumber method.
Conformity result: The method return value is of type int, indicating the logical channel number of the service. | +| 115 | | getDvbLocator() | Conformity requirements:
Precondition: Get SIService instance.
Test method: Call the getDvbLocator method.
Conformity result: The method return value is org.davic.net.dvb.DvbLocator object, indicating the locator of the service object. | +| 116 | | getNetworkID() | Conformity requirements:
Precondition: Get SIService instance.
Test method: Call the getNetworkID method.
Conformity result: The method return value is of type int, indicating the identification of the network to which the transport stream belongs. | +| 117 | SIService | getOriginalNetworkID() | Conformity requirements:
Precondition: Get SIService instance.
Test method: Call the getOriginalNetworkID method.
Conformity result: The method return value is of type int, indicating the original network identifier to which the service object belongs. | +| 118 | | getTransportStreamID() | Conformity requirements:
Precondition: Get SIService instance.
Test method: Call the getTransportStreamID method.
Conformity result: The method return value is of type int, indicating the transport stream identifier to which the service object belongs. | +| 119 | | getServiceID() | Conformity requirements:
Precondition: Get SIService instance.
Test method: Call the getServiceID method.
Conformity result: The method return value is of type int, indicating the service identifier. | +| 120 | | getNetwork() | Conformity requirements:
Precondition: Get SIService instance.
Test method: Call the getNetwork method.
Conformity result: The method return value is the SINetwork object. | +| 121 | | getTransportStream() | Conformity requirements:
Precondition: Get SIService instance.
Test method: Call the getTransportStream method.
Conformity result: The method return value is | + +| Serial No. | Class/
Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | the SITransportStream object. | +| 122 | SIService | getBouquets() | Conformity requirements:
Precondition: Get SIService instance.
Test method: Call the getBouquets method.
Conformity result: The method return value is a SIBouquet array. | +| 123 | | getFreeCAMode() | Conformity requirements:
Precondition: Get SIService instance.
Test method: Call the getFreeCAMode method.
Conformity result: The method return value is Boolean, true indicates that the service is scrambled, and reception is controlled by CA; False indicates that the service has not been scrambled and can be freely received. | +| 124 | | getPcrPID() | Conformity requirements:
Precondition: Get SIService instance.
Test method: Call the getPcrPID method.
Conformity result: The method return value is of type int, indicating the TS_PID of the PCR referenced by the service. | +| 125 | | getEITPresentFollowingFlag() | Conformity requirements:
Precondition: Get SIService instance.
Test method: Call the getEITPresentFollowingFlag method.
Conformity result: The method return value is Boolean. True indicates that the service has current/subsequent EIT information, while false indicates that the service has no current/subsequent EIT information. | +| 126 | | getEITScheduleFlag() | Conformity requirements:
Precondition: Get SIService instance.
Test method: Call the getEITScheduleFlag method.
Conformity result: The method return value is Boolean, true indicates that the service has EIT schedule information, and false indicates that the service does not have EIT schedule information. | +| 127 | | retrieveElementaryStreams() | Conformity requirements:
Precondition: Get SIService instance.
Test method: Call the retrieveElementaryStreams method.
Conformity result: The method return value is the SIRequest object. | +| 128 | SITransportStream | getNetworkID() | Conformity requirements:
Precondition: Get the SITransportStream instance.
Test method: Call the getNetworkID method.
Conformity result: The method return value is of type int, indicating the identification of the network to which the transport stream belongs. | +| 129 | | getOriginalNetworkID() | Conformity requirements:
Precondition: Get the SITransportStream instance.
Test method: Call the getOriginalNetworkID | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|--------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | SITransportStream | | method.
Conformity result: The method return value is of type int, indicating the original network identifier to which the transport stream object belongs. | +| 130 | | getTransportStreamID() | Conformity requirements:
Precondition: Get the SITransportStream instance.
Test method: Call the getTransportStreamID method.
Conformity result: The method return value is of type int, indicating the transport stream identifier of the transport stream object. | +| 131 | | getNetwork() | Conformity requirements:
Precondition: Get the SITransportStream instance.
Test method: Call the getNetwork method.
Conformity result: The method return value is the SINetwork object. | +| 132 | SIElementaryStream | getComponentTag() | Conformity requirements:
Precondition: Get SIElementaryStream instance.
Test method: Call the getComponentTag method.
Conformity result: The method return value is byte, indicating the label of the elementary stream component. If the elementary stream does not carry stream_identifier_descriptor, its component label value defaults to -2. | +| 133 | | getElementaryPID() | Conformity requirements:
Precondition: Get SIElementaryStream instance.
Test method: Call the getElementaryPID method.
Conformity result: The method return value is of type short, indicating the identification of the transport stream packet carrying the elementary stream. | +| 134 | | getNetworkID() | Conformity requirements:
Precondition: Get SIElementaryStream instance.
Test method: Call the getNetworkID method.
Conformity result: The method return value is of type int, indicating the identification of the network to which the transport stream belongs. | +| 135 | | getOriginalNetworkID() | Conformity requirements:
Precondition: Get SIElementaryStream instance.
Test method: Call the getOriginalNetworkID method.
Conformity result: The method return value is of type int, indicating the original network identifier of the elementary stream object that implements the interface. | +| 136 | | getTransportStreamID() | Conformity requirements:
Precondition: Get SIElementaryStream instance.
Test method: Call the getTransportStreamID method.
Conformity result: The method return value is of type int, indicating the transport stream | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | identifier to which the elementary stream object belongs. | +| 137 | SIElementary Stream | getServiceID() | Conformity requirements:
Precondition: Get SIElementaryStream instance.
Test method: Call the getServiceID method.
Conformity result: The method return value is of type int, indicating the service identifier to which the elementary stream object belongs. | +| 138 | | getStreamType() | Conformity requirements:
Precondition: Get SIElementaryStream instance.
Test method: Call the getStreamType method.
Conformity result: The method return value is of type byte, indicating the elementary stream type. | +| 139 | | getService() | Conformity requirements:
Precondition: Get SIElementaryStream instance.
Test method: Call the getService method.
Conformity result: The method return value is SIService object. | +| 140 | SIEvent | getNetworkID() | Conformity requirements:
Precondition: Get SIEvent instance.
Test method: Call the getNetworkID method.
Conformity result: The method return value is of type int, indicating the identification of the network to which the transport stream belongs. | +| 141 | | getOriginalNetworkID() | Conformity requirements:
Precondition: Get SIEvent instance.
Test method: Call the getOriginalNetworkID method.
Conformity result: The method return value is of type int, indicating the original network identifier to which the event object belongs. | +| 142 | | getTransportStreamID() | Conformity requirements:
Precondition: Get SIEvent instance.
Test method: Call the getTransportStreamID method.
Conformity result: The method return value is of type int, indicating the transport stream identifier to which the event object belongs. | +| 143 | | getServiceID() | Conformity requirements:
Precondition: Get SIEvent instance.
Test method: Call the getServiceID method.
Conformity result: The method return value is of type int, indicating the service identifier to which the event object belongs. | +| 144 | | getEventID() | Conformity requirements:
Precondition: Get SIEvent instance.
Test method: Call the getEventID method.
Conformity result: The method return value is of type int, indicating the event identifier. | +| 145 | | getDvbLocator() | Conformity requirements:
Precondition: Get SIEvent instance.
Test method: Call the getDvbLocator method.
Conformity result: The method return value is | + +| Serial No. | Class/
Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | SIEvent | | org.davic.net.dvb.DvbLocator object, indicating the locator of the event object. | +| 146 | | getService() | Conformity requirements:
Precondition: Get SIEvent instance.
Test method: Call the getService method.
Conformity result: The method return value is SIService object. | +| 147 | | getNibbles() | Conformity requirements:
Precondition: Get SIEvent instance.
Test method: Call the getNibbles method.
Conformity result: The method return value is a byte array. | +| 148 | | getStartTime() | Conformity requirements:
Precondition: Get SIEvent instance.
Test method: Call the getStartTime method.
Conformity result: The method return value is java.util.Date object, indicating the start time of the event. | +| 149 | | getDuration() | Conformity requirements:
Precondition: Get SIEvent instance.
Test method: Call the getDuration method.
Conformity result: The method return value is of type long, indicating the duration of the event. | +| 150 | | getEndTime() | Conformity requirements:
Precondition: Get SIEvent instance.
Test method: Call the getEndTime method.
Conformity result: The method return value is java.util.Date object, indicating the end time of the event. | +| 151 | | getEventName() | Conformity requirements:
Precondition: Get SIEvent instance.
Test method: Call the getEventName method.
Conformity result: The method return value is of type String , indicating that the full name of the event (eventname) is obtained. | +| 152 | | getShortEventName() | Conformity requirements:
Precondition: Get SIEvent instance.
Test method: Call the getShortEventName method.
Conformity result: The method return value is java.lang.String object, indicating the abbreviation of the event name. If there is no abbreviation information, it should return NULL. | +| 153 | | getEventDescription() | Conformity requirements:
Precondition: Get SIEvent instance.
Test method: Call the getEventDescription method.
Conformity result: The method return value is java.lang.String object, indicating the description of the event. | +| 154 | | getFreeCAMode() | Conformity requirements: | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | SIEvent | | Precondition: Get SIEvent instance.
Test method: Call the getFreeCAMode method.
Conformity result: The method return value is Boolean, true indicates that the event is scrambled, and reception is controlled by CA; False indicates no scrambling and free reception. | +| 155 | | getRunningStatus() | Conformity requirements:
Precondition: Get SIEvent instance.
Test method: Call the getRunningStatus method.
Conformity result: The method return value is of type byte, indicating the running status of the event. | +| 156 | SITime | getUTCTime() | Conformity requirements:
Precondition: Get the SITime instance.
Test method: Call the getUTCTime method.
Conformity result: The method return value is java.util.Date object, indicating coordinated universal time (UTC) and retrieving information from time date table (TDT) or time of transmission (TOT). | +| 157 | SIDescriptor | getByteAt(int index) | Conformity requirement 1:
Precondition: Get SIDescriptor instance.
Test method: Call the getByteAt method and input valid parameters.
Conformity result: The method return value is of type byte, indicating the content of a byte at the specified position.
Conformity requirement 2:
Precondition: Get SIDescriptor instance.
Test method: Call the getByteAt method and input invalid parameters.
Conformity result: Throw a java.lang.IndexOutOfBoundsException during method execution. | +| 158 | | getContent() | Conformity requirements:
Precondition: Get SIDescriptor instance.
Test method: Call the getContent method.
Conformity result: The method return value is a byte array, indicating the content part of the descriptor. | +| 159 | | getContentLength() | Conformity requirements:
Precondition: Get SIDescriptor instance.
Test method: Call the getContentLength method.
Conformity result: The method return value is of type short, indicating the length of the descriptor content part, in bytes. | +| 160 | | getTag() | Conformity requirements:
Precondition: Get SIDescriptor instance.
Test method: Call the getTag method.
Conformity result: The method return value is short, indicating the descriptor label field value. | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|--------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 161 | SIRequest | cancelRequest() | Conformity requirements:
Precondition: Get SIRequest instance.
Test method: Call the cancelRequest method.
Conformity result: The method execution is successful. | +| 162 | SIRetrieveListener | postEvent() | Conformity requirements:
Precondition: Construct SIRetrieveListener instance.
Test method: Call the postEvent method.
Conformity result: The method execution is successful. | +| 163 | SIUpdateListener | postEvent() | Conformity requirements:
Precondition: The effective frequency point has been locked, and the SIDatabase instance is obtained through the getDatabase method of the SIDatabase. The SIRetrieveListener instance constructed by binding the addNITUpdateListener is called.
Test method: Call back the postEvent method when there is a change in the NIT table in the waiting flow.
Conformity result: The method execution is successful. | +| 164 | SIDatabase | getDatabase() | Conformity requirements:
Precondition: None.
Test method: Call the getDatabase method.
Conformity result: The method returns a SIDatabase array with a length greater than 0. | +| 165 | | getID() | Conformity requirements:
Precondition: SIDatabase object already exists.
Test method: Call the getID method.
Conformity result: The method return value is valid. | +| 166 | | addNITUpdateListener() | Conformity requirements:
Precondition: The effective frequency point has been locked, and the SIDatabase instance is obtained through the getDatabase method of the SIDatabase. The SIRetrieveListener instance constructed by binding the addNITUpdateListener is called.
Test method: Call back the postEvent method when there is a change in the NIT table in the waiting flow.
Conformity result: The method execution is successful. | +| 167 | | removeNITUpdateListener() | Conformity requirements:
Precondition: The effective frequency point has been locked, and the SIDatabase instance is obtained through the getDatabase method of the SIDatabase. The SIRetrieveListener instance constructed by binding the addNITUpdateListener is called.
Test method: Call the removeNITUpdateListener method.
Conformity result: The method execution is successful. | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 168 | SIDatabase | addBATUpdateListener() |
Conformity requirements:
Precondition: The effective frequency point has been locked, and the SIDatabase instance is obtained through the getDatabase method of the SIDatabase. The SIRetrieveListener instance constructed by binding the addBATUpdateListener is called.
Test method: Call back the postEvent method when there is a change in the BAT table in the waiting flow.
Conformity result: The method execution is successful.
Conformity requirements:
Precondition: The effective frequency point has been locked, and the SIDatabase instance is obtained through the getDatabase method of the SIDatabase. The SIRetrieveListener instance constructed by binding the addBATUpdateListener is called.
Test method: Call the removeBATUpdateListener method.
Conformity result: The method execution is successful.
Conformity requirements:
Precondition: The effective frequency point has been locked, and the SIDatabase instance is obtained through the getDatabase method of the SIDatabase. The SIRetrieveListener instance constructed by binding the addPATUpdateListener is called.
Test method: Call back the postEvent method when there is a change in the PAT table in the waiting flow.
Conformity result: The method execution is successful.
Conformity requirements:
Precondition: The effective frequency point has been locked, and the SIDatabase instance is obtained through the getDatabase method of the SIDatabase. The SIRetrieveListener instance constructed by binding the addPATUpdateListener is called.
Test method: Call the removePATUpdateListener method.
Conformity result: The method execution is successful.
Conformity requirements:
Precondition: The effective frequency point has been locked, and the SIDatabase instance is obtained through the getDatabase method of the SIDatabase. The SIRetrieveListener instance constructed by binding the addPMTUpdateListener is called.
Test method: Call back the postEvent method when there is a change in the PMT table in the waiting flow.
Conformity result: The method execution is successful.
Precondition: The effective frequency point has been locked, and the SIDatabase instance is obtained through the getDatabase method of the SIDatabase. The SIRetrieveListener instance constructed by binding the addPMTUpdateListener is called.
Test method: Call the removePMTUpdateListener method.
Conformity result: The method execution is successful. | +| 174 | | addSDTUpdateListener() | Conformity requirements:
Precondition: The effective frequency point has been locked, and the SIDatabase instance is obtained through the getDatabase method of the SIDatabase. The SIRetrieveListener instance constructed by binding the addSDTUpdateListener is called.
Test method: Call back the postEvent method when there is a change in the SDT table in the waiting flow.
Conformity result: The method execution is successful. | +| 175 | | removeSDTUpdateListener() | Conformity requirements:
Precondition: The effective frequency point has been locked, and the SIDatabase instance is obtained through the getDatabase method of the SIDatabase. The SIRetrieveListener instance constructed by binding the addSDTUpdateListener is called.
Test method: Call the removeSDTUpdateListener method.
Conformity result: The method execution is successful. | +| 176 | | getAllNetworks() | Conformity requirements:
Precondition: Already searched (automatic search, manual search, interval search, etc.), obtained SIDatabase instance through the getDatabase method of SIDatabase.
Test method: Call the getAllNetworks method.
Conformity result: The method returns a SINetwork array with a length greater than 0. | +| 177 | | getAllServices() | Conformity requirements:
Precondition: Already searched (automatic search, manual search, interval search, etc.), obtained SIDatabase instance through the getDatabase method of SIDatabase.
Test method: Call the getAllServices method.
Conformity result: The method returns a SIService array with a length greater than 0. | +| 178 | | getAllTransportStreams() | Conformity requirements:
Precondition: Already searched (automatic search, manual search, interval search, etc.), obtained SIDatabase instance through the getDatabase method of SIDatabase.
Test method: Call the getAllTransportStreams method. | + +| Serial No. | Class/
Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Conformity result: The method returns a SITransportStream array with a length greater than 0. | +| 179 | SIDatabase | getSIBouquets() |
Conformity requirement 1:
Precondition: Already searched (automatic search, manual search, interval search, etc.), obtained SIDatabase instance through the getDatabase method of SIDatabase.
Test method: Call the getSIBouquets method and input invalid parameters.
Conformity result: The method returns a SIBouquet array with a length of 0.
Conformity requirement 2:
Precondition: Already searched (automatic search, manual search, interval search, etc.), obtained SIDatabase instance through the getDatabase method of SIDatabase.
Test method: Call the getSIBouquets method and input valid parameters.
Conformity result: The method returns a SIBouquet array with a length greater than 0.
Conformity requirement 3:
Precondition: Already searched (automatic search, manual search, interval search, etc.), obtained SIDatabase instance through the getDatabase method of SIDatabase.
Test method: Call the getSIBouquets method and input valid parameters, where service_id is -1.
Conformity result: The method returns a SIBouquet array with a length greater than 0.
Conformity requirement 1:
Precondition: Already searched (automatic search, manual search, interval search, etc.), obtained SIDatabase instance through the getDatabase method of SIDatabase.
Test method: Call the getSIElementStreams method and input invalid parameters.
Conformity result: The method returns a SIElementStream array with a length of 0.
Conformity requirement 2:
Precondition: Already searched (automatic search, manual search, interval search, etc.), obtained SIDatabase instance through the getDatabase method of SIDatabase.
Test method: Call the getSIElementStreams method and input valid parameters.
Conformity result: The method returns a SIElementStream array with a length greater than 0.
Conformity requirement 3:
Precondition: Already searched (automatic search, manual search, interval search, etc.), obtained SIDatabase instance through the getDatabase method of SIDatabase.
Test method: Call the getSIElementStreams method and input valid parameters, where service_id is -1.
Interface | Constant field/Attribute/Method | Process description | +|------------|----------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Conformity result: The method returns a SIElementStream array with a length greater than 0. | +| 181 | SIDatabase | getSIServices() |
Conformity requirement 1:
Precondition: Already searched (automatic search, manual search, interval search, etc.), obtained SIDatabase instance through the getDatabase method of SIDatabase.
Test method: Call the getSIServices method and input invalid parameters.
Conformity result: The method returns a SIService array with a length of 0.
Conformity requirement 2:
Precondition: Already searched (automatic search, manual search, interval search, etc.), obtained SIDatabase instance through the getDatabase method of SIDatabase.
Test method: Call the getSIServices method and input valid parameters.
Conformity result: The method returns a SIService array with a length greater than 0.
Conformity requirement 3:
Precondition: Already searched (automatic search, manual search, interval search, etc.), obtained SIDatabase instance through the getDatabase method of SIDatabase.
Test method: Call the getSIServices method and input valid parameters, where service_id is -1.
Conformity result: The method returns a SIService array with a length greater than 0.
Conformity requirement 1:
Precondition: SIDatabase object already exists.
Test method: First call the setPreferredLanguage method, input valid parameters, and then call the getPreferredLanguage method.
Conformity result: The method return value is consistent with the input.
Conformity requirements:
Precondition: SIDatabase object already exists.
Test method: Call the setPreferredLanguage method.
Conformity result: The method execution is successful.
Conformity requirements:
Precondition: Get SIRequestFailureType instance.
Test method: Call the getCode method.
Conformity result: The method returns an int value with a range of 0 to 3.
Conformity requirements:
Precondition: Get SIRequestFailureType instance.
Test method: Call the toString method.
Conformity result: The method return value is valid.
Precondition: Get SIRetrieveEvent instance.
Test method: Call the getSource method.
Conformity result: The method return value is an Object object, indicating the SIRequest object that generated the event. | +| 187 | | getAppData() | Conformity requirements:
Precondition: Get SIRetrieveEvent instance.
Test method: Call the getAppData method.
Conformity result: The method return value is a java.lang.Object object, indicating additional application data. | +| 188 | SISuccessRetrieveEvent | getResult() | Conformity requirements:
Precondition: Get the SISuccessRetrieveEvent instance.
Test method: Call the getResult method.
Conformity result: The method return value is valid. | +| 189 | SIFailureRetrieveEvent | getReason() | Conformity requirements:
Precondition: Get the SIFailureRetrieveEvent instance.
Test method: Call the getReason method.
Conformity result: The method return value is SIRequestFailureType object, indicating the reason for PSI/SI information retrieval failure. | +| 190 | SIUpdateEvent | getTableID() | Conformity requirements:
Precondition: The effective frequency point has been locked, and the SIDatabase instance is obtained through the getDatabase method of the SIDatabase. The SIRetrieveListener instance constructed by binding the addNITUpdateListener is called.
Test method: Call the postEvent method when the NIT table in the flow changes, retrieve the SIUpdateEvent object, and call the getTableID method.
Conformity result: The method return value is of type int, indicating the PSI/SI table identifier (table_id) where the update occurred. | +| 191 | | getBouquetID() | Conformity requirements:
Precondition: The effective frequency point has been locked, and the SIDatabase instance is obtained through the getDatabase method of the SIDatabase. The SIRetrieveListener instance constructed by binding the addBATUpdateListener is called.
Test method: Call the postEvent method when the BAT table in the flow changes, retrieve the SIUpdateEvent object, and call the getBouquetID method.
Conformity result: The method return value is of type int, indicating the identification of the service bouquet. | +| 192 | | getNetworkID() | Conformity requirements:
Precondition: The effective frequency point has been locked, and the SIDatabase instance is obtained through the getDatabase method of the SIDatabase. The SIRetrieveListener instance constructed by binding the | + +| Serial No. | Class/
Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | SIUpdateEvent | | addNITUpdateListener is called.
Test method: Call the postEvent method when the NIT table in the flow changes, retrieve the SIUpdateEvent object, and call the getNetworkID method.
Conformity result: The method return value is of type int, indicating the network identity. | +| 193 | | getOriginalNetworkID() | Conformity requirements:
Precondition: The effective frequency point has been locked, and the SIDatabase instance is obtained through the getDatabase method of the SIDatabase. The SIRetrieveListener instance constructed by binding the addNITUpdateListener is called.
Test method: Call the postEvent method when the NIT table in the flow changes, retrieve the SIUpdateEvent object, and call the getOriginalNetworkID method.
Conformity result: The method return value is of type int, indicating the original network identifier. | +| 194 | | getServiceID() | Conformity requirements:
Precondition: The effective frequency point has been locked, and the SIDatabase instance is obtained through the getDatabase method of the SIDatabase. The SIRetrieveListener instance constructed by binding the addPMTUpdateListener is called.
Test method: Call the postEvent method when the PMT table in the flow changes, retrieve the SIUpdateEvent object, and call the getServiceID method.
Conformity result: The method return value is of type int, indicating the service identifier. | +| 195 | | getTransportStreamID() | Conformity requirements:
Precondition: The effective frequency point has been locked, and the SIDatabase instance is obtained through the getDatabase method of the SIDatabase. The SIRetrieveListener instance constructed by binding the addSDTUpdateListener is called.
Test method: Call the postEvent method when the SDT table in the flow changes, retrieve the SIUpdateEvent object, and call the getTransportStreamID method.
Conformity result: The method return value is of type int, indicating the transport stream identifier. | + +### A.3 Conformance test of access unit interfaces for two-way broadband networks + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Listener | onAvailabilityChanged() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package.
Test method: In the testing program, create the EthernetManager object, call the addListener() method to register the callback function, and change the network status by plugging and unplugging the network cable.
Conformity result: The callback function is called when the network state changes. | +| 2 | DhcpInfo | ipAddress | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package.
Test method: In the testing program, create an EthernetManager object and call the getDhcpInfo() method.
Conformity result: The returned DhcpInfo object is not empty. | +| 3 | | Gateway | | +| 4 | | dns1 | | +| 5 | | dns2 | | +| 6 | | serverAddress | | +| 7 | EthernetManager | ETHERNET_STATE_DISABLED | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package.
Test method: In the testing program, create an EthernetManager object, access the getNetLinkStatus() method in EthernetManager, and change the network status by plugging and unplugging the network cable.
Conformity result: The getNetLinkStatus() method returns the status of ETHERNET_STATE_DISABLED. | +| 8 | | ETHERNET_STATE_ENABLED | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package.
Test method: In the testing program, create an EthernetManager object, access the getNetLinkStatus() method in EthernetManager, and change the network status by plugging and unplugging the network cable.
Conformity result: The getNetLinkStatus() method returns the status of ETHERNET_STATE_ENABLED. | +| 9 | | ETHERNET_STATE_UNKNOWN | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package.
Test method: In the testing program, create an EthernetManager object, access the getNetLinkStatus() method in EthernetManager, and change the network status by plugging and unplugging the network cable.
Conformity result: The getNetLinkStatus() method returns the status of ETHERNET_STATE_UNKNOWN. | + +| Serial No. | Class/
Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 10 | EthernetManager | EVENT_DHCP_CONNECT_SUCCESS
ED | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package.
Test method: In the testing program, create an EthernetManager object, access the getNetLinkStatus() method in EthernetManager, and connect to the network through DHCP in the settings.
Conformity result: The getNetLinkStatus() method returns the status of
EVENT_DHCP_CONNECT_SUCESSED | +| 11 | | EVENT_DHCP_CONNECT_FAILED | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package.
Test method: In the testing program, Create an EthernetManager object, access the getNetLinkStatus() method in EthernetManager, and disable DHCP in settings.
Conformity result: The getNetLinkStatus() method returns the status of
EVENT_DHCP_CONNECT_FAILED. | +| 12 | | isAvailable() | Conformity requirement 1:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: Create an EthernetManager object in the test programme and call the isAvailable() method.
Conformity result: Method returns true.
Conformity Requirement 2:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device is not initialized.
Test method: Create an EthernetManager object in the test programme and call the isAvailable() method.
Conformity result: Method returns false. | +| 13 | | addListener() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, create an EthernetManager object, call the addListener() method to register a callback function, and change the network status by plugging and unplugging the network cable.
Conformity result: The callback function will be called. | +| 14 | | removeListener() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized. | + +| Serial No. | Class/
Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | EthernetManager | | Test method: In the testing program, Create an EthernetManager object, call the removeListener() method to delete the callback function, and change the network status by plugging and unplugging the network cable.
Conformity result: The callback function will not be called. | +| 15 | | getConfiguration() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the getConfiguration() method.
Conformity result: The method returns the configuration information of the IP. | +| 16 | | setConfiguration() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the setConfiguration() method and getConfiguration() method.
Conformity result: The information obtained by getConfiguration() is consistent with the information set by setConfiguration(). | +| 17 | | setEthernetEnabled() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the setEthernetEnabled() method with a parameter of true.
Conformity result: Ethernet is enabled. | +| 18 | | getEthernetState() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the getEthernetState() method.
Conformity result: Return the ethernet status. | +| 19 | | getDhcpInfo() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized. | + +| Serial No. | Class/
Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | EthernetManager | | Test method: In the testing program, Create an EthernetManager object and call the getDhcpInfo() method.
Conformity result: Return the status of DHCP. | +| 20 | | getNetLinkStatus() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the getNetLinkStatus() method.
Conformity result: Return the status of the physical connection. | +| 21 | | getInterfaceName() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the getInterfaceName() method.
Conformity result: Return the ethernet interface name. | +| 22 | | setEthernetMode() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the setEthernetMode() method.
Conformity result: Set the Ethernet connection mode, such as dynamic host configuration protocol (DHCP), point-to-point protocol over Ethernet (PPPOE), etc. | +| 232 | | getEthernetMode() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the setEthernetMode() method and getEthernetMode() method.
Conformity result: The information obtained by getEthernetMode() is consistent with the information set by setEthernetMode(). | +| 24 | | getDeviceNameList() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | EthernetManager | | an EthernetManager object and call the getDeviceNameList() method.
Conformity result: Return a list of Ethernet ports. | +| 25 | | getTotalInterface() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the getTotalInterface() method.
Conformity result: Return the number of available physical ethernet interface. | +| 26 | | enableEthernet() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the enableEthernet() method.
Conformity result: Ethernet is enabled, and the tested device can be connected to the ethernet. | +| 27 | | setInterfaceName() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the setInterfaceName() method.
Conformity result: Set Ethernet name. | +| 28 | | getDhcpOption60State() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the getDhcpOption60State() method.
Conformity result: Return the status of Dhcp Option60/Option61. | +| 29 | | getDhcpOption60Login() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the getDhcpOption60Login() method.
Conformity result: Return the username of Dhcp Option61. | +| 30 | | getDhcpOption60Password() | Conformity requirements: | + +| Serial No. | Class/
Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | EthernetManager | | Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the getDhcpOption60Password() method.
Conformity result: Return the password for Dhcp Option60. | +| 31 | | setDhcpOption60() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the setDhcpOption60() method.
Conformity result: Set the username and password for Dhcp Option60. | +| 32 | | getDhcpOption125State() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the getDhcpOption125State() method.
Conformity result: Return the status of DHCP Option125. | +| 33 | | getDhcpOption125Info() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the getDhcpOption125Info() method.
Conformity result: Return information for DHCP Option125. | +| 34 | | setDhcpOption125() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the setDhcpOption125() method.
Conformity result: Set information for DHCP Option125. | +| 35 | | enableIpv6() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing programme | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | EthernetManager | | Create an EthernetManager object and call the enableIpv6() method.
Conformity result: Enable IPv6 ethernet. | +| 36 | | getIpv6PersistedState() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the getIpv6PersistedState() method.
Conformity result: Return the status of DHCPv6. | +| 37 | | setEthernetMode6() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create an EthernetManager object and call the setEthernetMode6() method.
Conformity result: Set the mode for obtaining IPv6 addresses. | +| 38 | ActionListener | onSuccess() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, An object implements this interface class, calling the onSuccess() method in the object.
Conformity result: The test programme can be compiled and passed. | +| 39 | | onFailure() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, An object implements this interface class, calling the onFailure() method in the object.
Conformity result: The test programme can be compiled and passed. | +| 40 | WifiInfo | getMacAddress() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WifiInfo object and call the getMacAddress() method.
Conformity result: Return the media access control (MAC) address of the hotspot route. | +| 41 | | getSSID() | Conformity requirements: | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | WifiInfo | |
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WifiInfo object and call the getSSID() method.
Conformity result: Return the service set identifier (SSID) of the current network connection.
| +| 42 | | getLinkSpeed() |Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WifiInfo object and call the getLinkSpeed() method.
Conformity result: Return the speed of the ethernet connection.
| +| 43 | | getNetworkId() |Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WifiInfo object and call the getNetworkId() method.
Conformity result: Return the identification number of the current network connection.
| +| 44 | | getBSSID() |Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WifiInfo object and call the getBSSID() method.
Conformity result: Return the basic service set identifier (BSSID) of the access point.
| +| 45 | | getIpAddress() |Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WifiInfo object and call the getIpAddress() method.
Conformity result: Return the IP address of the current connection.
| +| 46 | WifiInfo | getFrequency() |Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create
| + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | a WifiInfo object and call the getFrequency() method.Conformity result: Return the transmission frequency of the current connection. | +| 47 | WifiManager | ERROR_AUTHENTICATING | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WiFi Manager object and access the constant ERROR_AUTHENTICATING.
Conformity result: The test programme can be compiled and passed. | +| 48 | | WIFI_STATE_DISABLING | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WifiManager object and access the constant WIFI_STATE_DISABLING.
Conformity result: The test programme can be compiled and passed. | +| 49 | | WIFI_STATE_DISABLED | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WifiManager object and access the constant WIFI_STATE_DISABLED.
Conformity result: The test programme can be compiled and passed. | +| 50 | | WIFI_STATE_ENABLING | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WifiManager object and access the constant WIFI_STATE_ENABLING.
Conformity result: The test programme can be compiled and passed. | +| 51 | | WIFI_STATE_ENABLED | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WifiManager object and access the constant WIFI_STATE_ENABLED.
Conformity result: The test programme can be compiled and passed. | +| 52 | | WIFI_STATE_UNKNOWN | Conformity requirements: | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 53 | WifiManager | WifiManager() | Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WifiManager object and access the constant WIFI_STATE_UNKNOWN.
Conformity result: The test programme can be compiled and passed. | +| 54 | | getConfiguredNetworks() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WifiManager object and call the getconfiguredNetworks() method.
Conformity result: Return the current available WiFi network connection configuration. | +| 55 | | addNetwork() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WiFiManager object and call the addNetwork() method.
Conformity result: Add a network configuration. | +| 56 | | removeNetwork() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WiFiManager object and call the removeNetwork() method.
Conformity result: Remove a specified network configuration. | +| 57 | | enableNetwork() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WiFiManager object and call the | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | WifiManager | | enableNetwork() method.
Conformity result: Enable a certain network connection. | +| 58 | | disableNetwork() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WiFiManager object and call the disableNetwork() method.
Conformity result: Disabled a certain network connection. | +| 59 | | getConnectionInfo() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WiFiManager object and call the getConnectionInfo() method.
Conformity result: Return the current connection information. | +| 60 | | isWifiEnabled() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WiFiManager object and call the isWifiEnabled() method.
Conformity result: Check if WiFi is enabled. | +| 61 | | setWifiEnabled() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WiFiManager object and call the setWifiEnabled() method.
Conformity result: Set WiFi to on or off. | +| 62 | | saveConfiguration() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WiFi Manager object and call the saveConfiguration() method.
Conformity result: Successfully saved network configuration. | +| 63 | | getScanResults() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WiFiManager object and call the | + +| Serial No. | Class/
Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | WifiManager | | getScanResults() method.
Conformity results: Obtain scan results. | +| 64 | | startScan() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WifiManager object and call the startScan() method.
Conformity result: Start scanning. | +| 65 | | disconnect() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WiFiManager object and call the disconnect() method.
Conformity result: Disconnect from the current network connection point. | +| 66 | | reassociate() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WiFiManager object and call the reassociate() method.
Conformity result: Reassociate the current network connection point. | +| 67 | | reconnect() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WiFiManager object and call the reconnect() method.
Conformity result: Reconnect to the current network. | +| 68 | | getDhcpInfo() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WifiManager object and call the getDhcpInfo() method.
Conformity result: Return the result information of the previous DHCP request. | + +| Serial No. | Class/
Interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 69 | | getWifiState() | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a WifiManager object and call the getWifiState() method.
Conformity result: Return the status of WiFi. | +| 70 | ScanResult | SSID | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a ScanResult object to access SSID members.
Conformity result: The test programme can be compiled and passed. | +| 71 | | BSSID | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a ScanResult object and access BSSID members.
Conformity result: The test programme can be compiled and passed. | +| 72 | | capabilities | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a ScanResult object and access the capabilities member.
Conformity result: The test programme can be compiled and passed. | +| 73 | | Frequency | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a ScanResult object and access frequency members.
Conformity result: The test programme can be compiled and passed. | +| 74 | | level | Conformity requirements:
Precondition: Test the programme for importing the org.tvos.net package and the Ethernet of the tested device has been initialized.
Test method: In the testing program, Create a ScanResult object and access level members.
Conformity result: The test programme can be compiled and passed. | + +### A.4 Conformance test of HCI unit interface + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | NgbKeyListener | notifyKeyEvent() | Conformity requirements:
Precondition: Keyboard input conditions are required.
Test method: Call notifyKeyEvent() to register a key event to notify the use of the key input device, and trigger the button pressing and popping process.
Conformity result: notifyKeyEvent returns success, a key event notification occurs, and the notification emits a key event that matches the actual trigger key. | +| 2 | NgbMouseListener | notifyMouseEvent() | Conformity requirements:
Precondition: Mouse input conditions are required.
Test method: Call notifyMouseEvent() to register for button event notifications; Use a mouse input device to trigger the button pressing and popping process.
Conformity result: notifyMouseEvent returns success, a key event notification occurs, and the key event sent by the notification matches the actual trigger key. | +| 3 | FrontPanel | ALIGN_CENTER | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 0. | +| 4 | | ALIGN_LEFT | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 1. | +| 5 | | ALIGN_RIGHT | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 2. | +| 6 | | STATUS_OFF | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 0. | +| 7 | | STATUS_ON | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 1. | +| 8 | | STATUS_UNKNOWN | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 2. | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 9 | FrontPanel | TYPE_MAIL | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 0. | +| 10 | | TYPE_SIGNAL | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 1. | +| 11 | | TYPE_POWER | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 2. | +| 12 | | TYPE_RADIO | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 3. | +| 13 | | getInstance() | Conformity requirements:
Precondition: A front panel device is required.
Test method: Call getInstance() to obtain the front panel instance.
Conformity result: getInstance returns success to get an instance of the system implementation of the front panel. | +| 14 | | clear() | Conformity requirements:
Precondition: A front panel device is required, and display the string.
Test method: Call clear() to clear all displayed information on the front panel.
Conformity result: Clear returns success, clear succeeds, the content displayed on the front panel is cleared. | +| 15 | | displayDate(Date date) | Conformity requirements:
Precondition: A front panel device is required.
Test method: Call displayDate() to write the current time and date information.
Conformity result: DisplayDate returns success, displays success, and the front panel displays the current time. | +| 16 | | displayText(String str) | Conformity requirements:
Precondition: A front panel device is required.
Test method: Call displayText() to write the string information.
Conformity result: DisplayText returns success, displays success, and the front panel displays the currently written string. | +| 17 | | getStatus(int type) | Conformity requirements: | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Precondition: A front panel device is required.
Test method: Call getStatus() to obtain the status of a specific type of indicator light on the front panel.
Conformity result: getStatus returns success, obtains status successfully and the obtained status matches the actual situation. | +| 18 | | setStatus(int type, int value) | Conformity requirements:
Precondition: A front panel device is required.
Test method: Call setStatus() to set the status of specific types of indicator lights on the front panel.
Conformity result: setStatus returns successful, set successfully, and check if the indicator light status matches the set situation. | +| 19 | | getMaxChars() | Conformity requirements:
Precondition: A front panel device is required.
Test method: Call getMaxChars() to obtain the maximum number of strings that can be displayed on the front panel; Call displayText() to write a string of the corresponding length.
Conformity result: getMaxChars returns success, get success, display correctly after filling in the string according to the requirements of the display. | +| 20 | NgbInputManager | getInstance() | Conformity requirements:
Precondition: Keyboard input device is required.
Test method: Call getInstance() to obtain the input control management instance implemented by the system.
Conformity result: getInstance returns success and gets success. | +| 21 | | addKeyEventListener() | Conformity requirements:
Precondition: Keyboard input device is required.
Test method: Call addKeyEventListener() to register the specified key event listener with the system.
Conformity result: Register Successfully. | +| 22 | | removeKeyEventListener() | Conformity requirements:
Precondition: Keyboard input device is required.
Test method: Call removeKeyEventListener() to remove the specified key event listener from the | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | system.
Conformity result: Remove Successful. | +| 23 | | injectKeyEvent() | Conformity requirements:
Precondition: Keyboard input device is required.
Test method: Call injectKeyEvent() to inject a specified key event into the system.
Conformance result: InjectKeyEvent returns success, injection is successful, and the key event listener can listen to the event. | +| 24 | | addMouseListener() | Conformity requirements:
Precondition: Mouse input device is required.
Test method: Call addMouseListener() to register the specified mouse event listener with the system.
Conformity result: Register Successfully. | +| 25 | | removeMouseListener() | Conformity requirements:
Precondition: Mouse input device is required.
Test method: Call removeMouseListener() to remove the specified mouse event listener from the system.
Conformity result: Remove Successful. | +| 26 | | injectMouseEvent() | Conformity requirements:
Precondition: Mouse input device is required.
Test method: Call injectMouseEvent() to inject a specified mouse event into the system.
Conformity result: InjectMouseEvent returns success, injection is successful, and the mouse event listener can listen to the event. | +| 27 | NgbInputEvent | getEventTime() | Conformity requirements:
Precondition: Input device is required.
Test method: The input device triggers an input event and calls getEventTime() to obtain the generation time value of the input event.
Conformity result: GetEventTime returns the time value, and the obtained input event | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | generation time matches the actual time. | +| 28 | | getSource() | Conformity requirements:
Precondition: Input device is required.
Test method: The input device triggers an input event and calls getSource() to retrieve the source of the input event.
Conformity result: GetSource returns the generation source, and the obtained input event generation source matches the actual one. | +| 29 | | getAction() | Conformity requirements:
Precondition: Keyboard input device is required.
Test method: The key input device triggers an input event and calls getAction() to obtain the status of the input event.
Conformity result: getAction returns the event status, and the obtained button input event status matches the actual situation. | +| 30 | KeyEvent | getCode() | Conformity requirements:
Precondition: Keyboard input device is required.
Test method: The key input device triggers an input event and calls getCode() to obtain the key value code of the input event.
Conformity result: GetCode returns the key value code, and the obtained key value code for the key input event matches the actual situation. | +| 31 | | getAction() | Conformity requirements:
Precondition: Mouse input device is required.
Test method: The mouse input device triggers an input event and calls getAction() to obtain the status of the input event.
Conformity result: getAction returns the event status, and the obtained mouse input event status is successful and matches the actual situation. | +| 32 | | getCode() | Conformity requirements:
Precondition: Mouse input device is required.
Test method: The mouse input device triggers an input event and calls getCode() to obtain the key value code of the input event.
Conformity result: getCode returns the key code, and the obtained key value code for the mouse input event is successful and matches the actual value. | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 33 | MouseEvent | getButton() | Conformity requirements:
Precondition: Mouse input device is required.
Test method: The mouse input device triggers an input event and calls getButton() to obtain the mouse button of the input event.
Conformity result: getButton returns the mouse button, and the obtained mouse input events for mouse buttons is successful and matches the actual value. | +| 34 | | getX() | Conformity requirements:
Precondition: Mouse input device is required.
Test method: The mouse input device moves the mouse to trigger an input event, and calls getX() to obtain the mouse focus X-axis position for the input event.
Conformity result: getX returns the position value, and the obtained mouse focus X-axis position for mouse input event is successful and matches the actual value. | +| 35 | | getY() | Conformity requirements:
Precondition: Mouse input device is required.
Test method: The mouse input device moves the mouse to trigger an input event, and calls getY() to obtain the mouse focus Y-axis position for the input event.
Conformity result: getY returns the position value, and the obtained mouse focus Y-axis position for mouse input event is successful and matches the actual value. | +| 36 | NgbVoiceListener | onVoiceStart() | Conformity requirements:
Precondition: A voice input device is required.
Test method: Call the onVoiceStart() function to start voice input.
Conformity result: Function call succeeds, beginning the voice input. | +| 37 | | onVoiceEnd() | Conformity requirements:
Precondition: A voice input device is required, voice input has started.
Test method: Call the onVoiceEnd() function to end language input.
Conformity result: Function call succeeds, ending the voice input. | +| 38 | | onVoiceResult() | Conformity requirements:
Precondition: A voice input device is required, voice input has started and ended. | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | NgbVoiceManager | | Test method: Call the onVoiceResult() function.
Conformity result: Function call succeeds, obtaining the results of voice recognition. | +| 39 | | onError() | Conformity requirements:
Precondition: A voice input device is required, voice input has started and ended.
Test method: Call the onError() function.
Conformity result: Function call succeeds, obtaining the error code in the voice process. | +| 40 | | getInstance() | Conformity requirements:
Precondition: A voice input device is required.
Test method: Call the getInstance() function.
Conformity result: The function call succeeds, obtaining the instance successfully. | +| 41 | | startListening() | Conformity requirements:
Precondition: A voice input device is required, the instance is successfully got.
Test method: Call the startListening() function.
Conformity result: The function call is successful. | +| 42 | | stopListening() | Precondition: A voice input device is required, the instance is successfully got, Voice monitoring begins.
Test method: Call the stopListening() function.
Conformity result: The function call is successful. | +| 43 | | cancel() | Precondition: A voice input device is required, the instance is successfully got, Voice monitoring begins.
Test method: Call the cancel() function.
Conformity result: The function call is successful. | +| 44 | | setVoiceListener() | Precondition: A voice input device is required, the instance is successfully got.
Test method: Call the setVoiceListener() function.
Conformity result: The function call is successful. | +| 45 | | release() | Precondition: A voice input device is required, the instance is successfully got.
Test method: Call the release() function.
Conformity result: The function call is successful. | + +### A.5 Conformance test of audio video (AV) setting unit interface + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | AudioSetting | CHANNEL_STEREO | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 0. | +| 2 | | CHANNEL_LEFT | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 1. | +| 3 | | CHANNEL_RIGHT | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 2. | +| 4 | | CHANNEL_MIXED_MONO | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 3. | +| 5 | | getOutputInterfaceList() | Conformity requirements:
Precondition: All audio video (AV) ports are connected to the TV normally, and the system starts successfully.
Test method: Call the getOutputInterfaceList method.
Conformity result: The method call succeeds, obtaining the available audio output port names for the system. | +| 6 | | getOutputInterfaceStatus(String port) | Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the getOutputInterfaceList method is successfully called.
Test method: Call the getOutputInterfaceStatus method with the parameters returned by the getOutputInterfaceList method call.
Conformity result: The method call succeeds, obtaining the status of the system audio output port specified by the parameter.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the getOutputInterfaceList method is successfully called.
Test method: Call the getOutputInterfaceStatus method with parameters other than those returned by the getOutputInterfaceList method.
Conformity result: The return value of the method call is false. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 7 | AudioSetting | disableOutputInterface(String port) |
Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the getOutputInterfaceList method is successfully called.
Test method: Call the disableOutputInterface method with the parameters returned by the getOutputInterfaceList method call.
Conformity result: The method call succeeds, the system audio output interface specified by the parameter is disabled successfully.
Conformity requirement 2:
Precondition: All AV interfaces are connected to the TV normally, the system is successfully started, and the getOutputInterfaceList method is successfully called.
Test method: Call the disableOutputInterface method with parameters other than those returned by the getOutputInterfaceList method.
Conformity result: Method call fails, and the state of the system audio output interface remains unchanged.
Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the getOutputInterfaceList method is successfully called.
Test method: Call the enableOutputInterface method with the parameters returned by the getOutputInterfaceList method call.
Conformity result: Method call succeeds, and the system audio output interface specified by the parameter is enabled successfully.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the getOutputInterfaceList method is successfully called.
Test method: Call the enableOutputInterface method with parameters other than those returned by the getOutputInterfaceList method.
Conformity result: Method call fails, and system audio output interface status remains unchanged.
Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the audio output port is in an
Test method: Call the getOutputVolume method.
Conformity result: The method call succeeds, and the obtained system volume value is within the range defined by the interface standard. | +| 10 | | setOutputVolume(int volume) | Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the audio output interface is in an enabled state.
Test method: Call the setOutputVolume method with parameters within the scope defined by the interface standard.
Conformity result: Method call succeeds, and the system volume value is set according to the parameter value, which actually works.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the audio output interface is in an enabled state.
Test method: Call the setOutputVolume method, with parameters other than the scope defined by the interface standard.
Conformity result: The method call succeeds, and system volume is set to the value closest to the set parameter within the valid range. | +| 11 | | getOutputChannelMode() | Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the audio output channel is in an enabled state.
Test method: Call the getOutputChannelMode method.
Conformity result: The method call succeeds, and the system output channel type is obtained. | +| 12 | | setOutputChannelMode(int type) | Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the audio output channel is in an enabled state.
Test method: Call the setOutputChannelMode method, with parameters within the scope defined by the interface standard.
Conformity result: Method call succeeds, and the system output channel type is set according to parameter values, which | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|---------------------------|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
actually works.
Conformity requirement 2:
Precondition: All HDMI ports are connected to the TV normally, the system is successfully started, and the audio output channel is in an enabled state.
Test method: Call the setOutputChannelMode method, with parameters within the range defined by the interface standard.
Conformity result: Method call fails, and system output channel type remains unchanged.
getOutputSPDIFMode() | Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, the audio output port is enabled, and the Sony/Philips digital interconnect format (SPDIF) interface is connected to the AV amplifier.
Test method: Call the getOutputSPDIFMode method.
Conformity result: Method call succeeds, obtaining the data format of the system SPDIF output interface.
AudioSetting | setOutputSPDIFMode(int mode) | Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, the audio output port is enabled, and the SPDIF interface is connected to the AV amplifier.
Test method: Call the setOutputSPDIFMode method with parameters within the range defined by the interface standard.
Conformity results: The method is called successfully, and the system output sound format is set according to the parameter value, which is consistent with the sound format displayed by the AV amplifier.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, the audio output port is enabled, and the SPDIF interface is connected to the AV amplifier.
Test method: Call the setOutputSPDIFMode method, with parameters other than the scope defined by the interface standard.
Conformity result: Method call fails, and system output sound format remains unchanged.
Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, the audio output port is enabled, and the mute interface is called.
Test method: Call the isMute method.
Conformity result: The method call is successful, and the status of whether the system is silent is true, which matches the actual effect.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system starts successfully, the audio output port is enabled, and the unmute interface is called to unmute.
Test method: Call the isMute method.
Conformity result: The method call succeeds, and the status of whether the system is muted is false, which matches the actual effect.
Conformity requirements:
Precondition: All AV ports are connected to the TV normally, and the system starts successfully.
Test method: Call the mute method.
Conformity result: Method call succeeds, and system is muted.
Conformity requirements:
Precondition: All AV ports are connected to the TV normally, and the system starts successfully.
Test method: Call the unMute method.
Conformity result: Method call succeeds, and system is unmuted.
Conformity requirements:
Precondition: HDMI port is connected to AV amplifier input, AV amplifier HDMI output is connected to TV, and the system starts successfully, HDMI audio output port is in enabled state.
Test method: Call the getOutputHDMIIFMode method.
Conformity result: Method call succeeds, obtaining the data format of the system HDMI output interface.
Conformity requirements:
Precondition: HDMI port is connected to AV amplifier input, AV amplifier HDMI output is connected to TV, and the system starts successfully, HDMI audio output port is in enabled state.
Test method: Call the setOutputHDMIMode method with parameters within the range defined by the interface standard.
Conformity results: The method is called successfully, and the type of system HDMI output sound is set according to the parameter value, which is consistent with the actual displayed value of AV Amplifier.
Conformity requirement 2.
Preconditions: HDMI port is normally connected to the AV amplifier, the HDMI output of the AV amplifier is connected to the TV, the system is successfully started, and the audio output port is enabled.
Test Method: Call setOutputHDMIMode method, the parameter is other than the range of interface standard definition.
Conformity results: Method call fails, and the type of system HDMI output sound is unchanged.
| +| 20 | VideoSetting |getOutputInterfaceList() | Conformity requirements:
Precondition: All AV ports are connected to the TV normally, and the system starts successfully.
Test method: Call the getOutputInterfaceList method.
Conformity result: The call succeeds, obtaining the name of the available video output port.
| +| 21 | |getOutputInterfaceStatus(String port) | Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the getOutputInterfaceList method is successfully called.
Test method: Call the getOutputInterfaceStatus method with the parameters returned by the getOutputInterfaceList method.
Conformity result: The call succeeds, obtaining the status of the system video output port specified by the parameter.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the getOutputInterfaceList method is successfully called.
Test method: Call the getOutputInterfaceStatus method with parameters other than those returned by the getOutputInterfaceList method.
Conformity result: The return value of the
| + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 22 | VideoSetting | | method call is false. | +| | | disableOutputInterface(String port) |Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the getOutputInterfaceList method is successfully called.
Test method: Call the disableOutputInterface method with the parameters returned by the getOutputInterfaceList method.
The method is called successfully, and the system video output port specified by the parameter is closed successfully.
Conformity result: The method call succeeds, and the system video output port specified by the parameter is disabled successfully.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the getOutputInterfaceList method is successfully called.
Test method: Call the disableOutputInterface method with parameters other than those returned by the getOutputInterfaceList method.
Conformity result: Method call fails, the status of the system video output port remains unchanged.
Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the getOutputInterfaceList method is successfully called.
Test method: Call the enableOutputInterface method with the parameters returned by the getOutputInterfaceList method.
Conformity result: The method call succeeds, and the system video output port specified by the parameter is enabled successfully.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the getOutputInterfaceList method is successfully called.
Test method: Call the enableOutputInterface method with parameters other than those returned by the getOutputInterfaceList method.
Conformity result: Method call fails, the status of system video output port remains unchanged.
Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the getOutputMatchMethod method.
Conformity result: The method call succeeds, and the aspect ratio adaptation mode value for system video outputs is within the range defined by the interface standard.
Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the getOutputBrightness method.
Conformity result: The method call succeeds, and the value of the system brightness is within the range defined by the interface standard.
Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the getOutputContrast method.
Conformity result: The method call succeeds, and the value of system contrast size is within the range defined by the interface standard.
Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the getOutputSaturation method.
Conformity result: The method call succeeds, and the obtained value of system saturation size is within the range defined by the interface standard.
Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: For the getOutputStandard method called by the high-definition system,
the parameter is the VOUT_HD defined by the interface standard.
Conformity result: The method call succeeds, and the obtained value of system model format is within the range defined by the interface standard.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: For the getOutputStandard method called by the standard definition system, the parameter is the VOUT_SD defined by the interface standard.
Conformity result: The method call succeeds, and the obtained value of system model format is within the range defined by the interface standard.
| +| 29 | | getOutputStandards(int device) |Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: For the getOutputStandards method called by the standard definition system, the parameter is the VOUT_SD defined by the interface standard.
Conformity result: The method call succeeds, and the obtained values of all system model format are within the range defined by the interface standard.
| +| 30 | | getOutputTransparency() |Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the getOutputTransparency method.
Conformity result: The method call succeeds, and the obtained values of system transparency size is within the interface standard definition.
| +| 31 | | setOutputMatchMethod(int matchMethod) |Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the setOutputMatchMethod method with parameters within the standard definition of
| + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |the interface.
Conformity result: The method call succeeds, and the aspect ratio adaptation mode value for system video outputs is within the range of the interface standard definition, which actually works.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the setOutputMatchMethod method with parameters other than the scope of the interface standard definition.
Conformity result: Method call fails, and the aspect ratio adaptation mode of the set-top video output box remains unchanged.
| +| 32 | |setOutputBrightness(int value) | Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the setOutputBrightness method with parameters within the standard definition of the interface.
Conformity result: The method call succeeds, and the value of the system brightness is set according to the parameter value, which actually works.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the setOutputBrightness method with parameters other than the scope of the interface standard definition.
Conformity result: The method call succeeds, and the system volume is set to the value closest to the set parameter within the valid range.
| +| 33 | |setOutputContrast(int value) | Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the setOutputContrast method with parameters within the standard definition of the interface.
Conformity result: The method call succeeds,
| + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |and the value of system contrast size is set according to the parameter value, which actually works.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the setOutputContrast method with parameters other than the scope of the interface standard definition.
Conformity result: Method call succeeds, and the system contrast is set to the value closest to the set parameter within the valid range.
| +| 34 | | setOutputSaturation(int value) |Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the setOutputSaturation method with parameters within the standard definition of the interface.
Conformity result: The method call succeeds, and the saturation (chromaticity) of the video output is set according to the parameter values, which actually works.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the setOutputSaturation method with parameters other than the scope of the interface standard definition.
Conformity result: Method call succeeds, and the saturation (chromaticity) of the video output is set to the value closest to the set parameter within the valid range.
| +| 35 | | |Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: For HD system call setOutputStandard method, device parameter is VOUT_HD, standard parameter is within the interface standard definition.
Conformity result: The method call succeeds, and the format value of the system video signal is set according to the parameter value, which actually works.
| + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | setOutputStandard() |Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: For SD system call setOutputStandard method, device parameter is VOUT_SD, standard parameter is within the interface standard definition.
Conformity result: The method call succeeds, and the format value of the system video signal is set according to the parameter value, which actually works.
Conformity requirement 3:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: For HD system call setOutputStandard method, device parameter is VOUT_HD, standard parameter is within the interface standard definition.
Conformity result: Method call fails, and the system video signal format value remains unchanged.
Conformity requirement 4:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: For SD system call setOutputStandard method, device parameter is VOUT_SD, standard parameter is within the interface standard definition.
Conformity result: Method call fails, and the system video signal format value remains unchanged.
Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the setOutputTransparency method, with parameters within the standard definition of the interface.
Conformity result: The method call succeeds, and the system transparency size value is set according to the parameter value, which actually works.
Conformity requirement 2:
Precondition: All AV ports are connected to
the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the setOutputTransparency method with parameters other than the scope of the interface standard definition.
Conformity result: The method call succeeds, and the system transparency is set to the value closest to the set parameter within the valid range.
| +| 37 | |getOutputAspectRatio() | Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the getOutputAspectRatio method.
Conformity result: The method call succeeds, and the obtained aspect ratio of the system video output is within the range defined by the interface standard.
| +| 38 | |setOutputAspectRatio() | Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the setOutputAspectRatio method with parameters within the standard definition of the interface.
Conformity result: The method call succeeds, and the aspect ratio mode value of system video output is set according to the parameter value, which actually works.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the setOutputAspectRatio method with parameters other than the scope of the interface standard definition.
Conformity result: Method call fails, and the aspect ratio adaptation mode of the set-top video output box remains unchanged.
| +| 39 | |GetColorSpaceMode() | Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Calls the GetColorSpaceMode method.
Conformity result: The method call succeeds, and the obtained color space mode value of the system video output is within the range defined by the interface standard.
Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the GetDeepColorMode method.
Conformity result: The method call succeeds, and the obtained color depth mode value of the system's video output is within the range defined by the interface standard.
Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the SetColorSpaceAndDeepColor method with parameters within the standard definition of the interface.
Conformity result: The method call succeeds, and the color space and color depth mode values for the system video output are set according to the parameter values, which actually work.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Calls the SetColorSpaceAndDeepColor method with parameters other than the scope of the interface standard definition.
Conformity result: Method call fails, the color space and color depth mode values of the set-top video output remain unchanged.
Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the GetHDRType method.
Conformity result: The method call succeeds, and the current correct high dynamic range (HDR) mode is obtained.
Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the SetHDRType method with parameters within the standard definition of the interface.
Conformity result: The method call succeeds, and the HDR mode value of the system's video output is set according to the parameter value, which actually works.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the SetHDRType method with parameters outside the scope of the interface standard definition.
Conformity result: Method call fails, and the HDR mode value of the set-top video output remains unchanged.
Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the GetStereoOutMode method.
Conformity result: The method call succeeds, and the obtained stereo mode value of the system's video output is within the range defined by the interface standard.
Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the SetStereoOutMode method with a number within the standard definition of the interface.
Conformity result: The method call succeeds, and the stereo R mode value of the system video output is set according to the parameter value, which actually works.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Conformity result: Method call fails, and the stereo mode value of the set-top video output remains unchanged. | +| 46 | | GetRightEyeFirst() | Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the GetRightEyeFirst method.
Conformity result: The method call succeeds, and gets whether the right eye in front value of the stereo mode of the system's video output is within the range defined by the interface standard. | +| 47 | | SetRightEyeFirst() | Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the SetRightEyeFirst method with parameters within the standard definition of the interface.
Conformity result: The method call succeeds, and Stereoscopic right eye in front mode value of the system video output is set according to the parameter values, which actually works.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the SetRightEyeFirst method with parameters other than the scope of the interface standard definition.
Conformity result: Method call fails, and Stereoscopic right eye in front mode value of the system video output remains unchanged. | +| 48 | | GetStereoDepth() | Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the GetStereoDepth method.
Conformity result: The method call succeeds, and the obtained stereo mode depth value of | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | the system's video output is within the range defined by the interface standard. | +| 49 | | SetStereoDepth(int depth) |
Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the SetStereoDepth method with parameters within the standard definition of the interface.
Conformity result: The method call succeeds, and the stereo mode depth value of the system's video output is set according to parameter values, which actually works.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the SetStereoDepth method with parameters other than the standard definition of the interface.
Conformity result: The method call succeeds, and the stereo mode depth value of the system's video output is set to the value closest to the set parameter within the valid range.
Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the getPictureMode method.
Conformity result: The method call succeeds, and the obtained image mode value of the system video output is within the range defined by the interface standard.
Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the setPictureMode method with parameters within the standard definition of the interface.
Conformity result: The method call succeeds, and the obtained image mode value of the system video output is set according to the parameter value, which actually works.
Conformity requirement 2:
| + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the setPictureMode method with parameters other than the standard definition of the interface.
Conformity result: Method call fails, and the image value of set-top video output remains unchanged.
| +| 52 | | getDisplayHue() |Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the getDisplayHue method.
Conformity result: Method call succeeds, and the hue value of system video output is within the range defined by the interface standard.
| +| 53 | | setDisplayHue(int hue) |Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the setDisplayHue method, with parameters within the standard definition of the interface.
Conformity result: Method call succeeds, and the hue value of system video output is set according to the parameter value, which actually work.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the setDisplayHue method with parameters other than the scope of the interface standard definition.
Conformity result: Method call succeeds, and the hue value of system video output is set to the value closest to the set parameter within the valid range.
| +| 54 | | SaveDisplayFmt() |Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call SaveDisplayFmt method.
| + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Conformity result: Method call succeeds, and the system saves the video output parameter configurations, and the video output parameter configurations can be maintained and not lost after the system is powered down and restarted. | +| 55 | | setOptimalFormatEnable() | Conformity requirements:Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the setOptimalFormatEnable method.
Conformity result: Method call succeeds, and returns TRUE. | +| 56 | | getOptimalFormatEnable() | Conformity requirements:
Precondition: All AV ports are connected to the TV normally, the system is successfully started, and the video output port is in an enabled state.
Test method: Call the getOptimalFormatEnable method.
Conformity result: Method call succeeds, and obtains the enable status of the current correct automated video output format. | + +### A.6 Conformance test of media processing unit interface + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | | MEDIA_ERROR_UNKNOWN | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1. | +| 2 | | MEDIA_ERROR_SERVER_DIED | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 100. | +| 3 | | MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 200. | +| 4 | | TVOS_MEDIA_ERROR_START_FAILED | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1000. | +| 5 | | TVOS_MEDIA_ERROR_SETPACE_FAILED | Conformity requirements:
Precondition: None.
Test method: Determine constant values. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| | MediaPlayer | | Conformity result: Constant value is 1001. | +| 6 | | TVOS_MEDIA_ERROR_SEEK_FAILED | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1002. | +| 7 | | TVOS_MEDIA_ERROR_PAUSE_FAILED | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1003. | +| 8 | | TVOS_MEDIA_ERROR_RESUME_FAILED | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1004. | +| 9 | | TVOS_MEDIA_ERROR_STOP_FAILED | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1005. | +| 10 | | TVOS_MEDIA_ERROR_URL_INVALID | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1006. | +| 11 | | TVOS_MEDIA_ERROR_RESOURCE_UNAVAILABLE | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1007. | +| 12 | | TVOS_MEDIA_ERROR_AUDIO_DECODE_ERROR | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1008. | +| 13 | | TVOS_MEDIA_ERROR_VIDEO_DECODE_ERROR | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1009. | +| 14 | | TVOS_MEDIA_ERROR_UNSUPPORTED_VIDEO_DEC | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1010. | +| 15 | | TVOS_MEDIA_ERROR_UNSUPPORTED_AUDIO_DEC | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1011. | +| 16 | | TVOS_MEDIA_ERROR_CONNECT_FAILED | Conformity requirements:
Precondition: None.
Test method: Determine constant values. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| | MediaPlayer | | Conformity result: Constant value is 1012. | +| 17 | | TVOS_MEDIA_ERROR_VOD_SEARCH_FAILED | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1300. | +| 18 | | TVOS_MEDIA_ERROR_VOD_OUT_OF_RANGE | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1301. | +| 19 | | MEDIA_INFO_UNKNOWN | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1. | +| 20 | | MEDIA_INFO_STARTED_AS_NEXT | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 2. | +| 21 | | MEDIA_INFO_RENDERING_START | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 3. | +| 22 | | MEDIA_INFO_VIDEO_TRACK_LAGGING | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 700. | +| 23 | | MEDIA_INFO_BUFFERING_START | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 701. | +| 24 | | MEDIA_INFO_BUFFERING_END | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 702. | +| 25 | | MEDIA_INFO_NETWORK_BANDWIDTH | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 703. | +| 26 | | MEDIA_INFO_BAD_INTERLEAVING | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 800. | +| 27 | | MEDIA_INFO_NOT_SEEKABLE | Conformity requirements:
Precondition: None.
Test method: Determine constant values. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|--------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 28 | MediaPlayer | MEDIA_INFO_METADATA_UPDATE | Conformity result: Constant value is 801.
Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 802. | +| 29 | | MEDIA_INFO_EXTERNAL_METADATA_UPDATE | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 803. | +| 30 | | MEDIA_INFO_TIMED_TEXT_ERROR | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 900. | +| 31 | | MEDIA_INFO_UNSUPPORTED_SUBTITLE | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 901. | +| 32 | | MEDIA_INFO_SUBTITLE_TIMED_OUT | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 902. | +| 33 | | TVOS_MEDIA_INFO_START_SUCCESS | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1000. | +| 34 | | TVOS_MEDIA_INFO_TUNE_LOCK_SUCCESS | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1001. | +| 35 | | TVOS_MEDIA_INFO_TUNE_LOCK_LOST | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1002. | +| 36 | | TVOS_MEDIA_INFO_NO_STREAM | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1003. | +| 37 | | TVOS_MEDIA_INFO_STREAM_RECOVER | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1004. | +| 38 | | TVOS_MEDIA_INFO_AUDIO_DECODE_SUCCESS | Conformity requirements:
Precondition: None.
Test method: Determine constant values. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 39 | MediaPlayer | TVOS_MEDIA_INFO_VIDEO_DECODE_SUCCESS | Conformity result: Constant value is 1005.
Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1006. | +| 40 | | TVOS_MEDIA_INFO_PACE_CHANGE | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1007. | +| 41 | | TVOS_MEDIA_INFO_DVB_C_A_READY | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1100. | +| 42 | | TVOS_MEDIA_INFO_DVB_C_A_NOT_READY | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1101. | +| 43 | | TVOS_MEDIA_INFO_VOD_END_OF_STREAM | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1300. | +| 44 | | TVOS_MEDIA_INFO_VOD_BEGIN_OF_STREAM | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1301. | +| 45 | | MediaPlayer() | Conformity Requirements.
Precondition:None.
Test Method:Create a MediaPlayer object.
Conformity Result:MediaPlayer object created successfully. | +| 46 | | setDataSource() | Conformity Requirements.
Precondition:Successfully create a MediaPlayer object.
Test Method:Call setDataSource() with valid input parameters.
Conformity Result:No return value, no error message is reported. | +| 47 | | prepareAsync() | Conformity Requirements.
Precondition:Successfully create a MediaPlayer object, listen to setOnPreparedListener, and setDataSource() succeeds.
Test method:call prepareAsync() interface.
Conformity result: No return value; receive MEDIA_PREPARED message | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 48 | MediaPlayer | prepare() | after prepare succeeds.
Conformity Requirements.
Precondition: Create a MediaPlayer object successfully, and setDataSource() succeeds.
Test method: call prepare() interface.
Conformity result: no return value, synchronization waiting for preparation is completed. | +| 49 | | start() | Conformity requirements:
Precondition: Successfully create a MediaPlayer object, After a successful call to prepare() or a call to prepareAsync(), setOnPreparedListener() receives listening.
Test method: Call the start() interface.
Conformity result: No return value, play successfully, can receive MEDIA_STARTED message on first playback. | +| 50 | | pause() | Conformity requirements:
Precondition: The player plays normally.
Test method: Call the pause() interface.
Conformity result: No return value, playback is paused. | +| 51 | | getDuration() | Conformity requirements:
Precondition: The player plays normally.
Test method: Call the getDuration() interface.
Conformity result: Return the length of the file, or -1 if not supported by the resource or service. | +| 52 | | getCurrentPosition() | Conformity requirements:
Precondition: The player plays normally.
Test method: Call the getCurrentPosition() interface.
Conformity result: Return the current location of the file. | +| 53 | | setVolume() | Conformity Requirements.
Precondition: The player is playing normally.
Test Method: Call setVolume() interface with valid input parameter.
Conformity result: Volume set successfully with no return value. | +| 54 | | seekTo() | Conformity requirements:
Precondition: The player is playing normally.
Test method: Call the seekTo() interface | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | MediaPlayer | | with valid input parameters.
Conformity result: No return value, and jump to the specified location for playback. | +| 55 | | reset() | Conformity requirements:
Precondition: Successfully create a MediaPlayer object.
Test method: Call the reset() interface.
Conformity result: No return value; player returns to initialized state. | +| 56 | | release() | Conformity requirements:
Precondition: Successfully create a MediaPlayer object.
Test method: Call the release() interface.
Conformity result: No return value, player is destroyed. | +| 57 | | setOnInfoListener() | Conformity requirements:
Precondition: Successfully create a MediaPlayer object.
Test method: Call the setOnInfoListener() interface.
Conformity result: No return value, register for message listening, and receive messages when information messages arrive. | +| 58 | | setOnErrorListener() | Conformity requirements:
Precondition: Successfully create a MediaPlayer object.
Test method: Call the setOnErrorListener() interface.
Conformity result: No return value, register an error listener to receive an error when it arrives. | +| 59 | | setOnCompleteListener() | Conformity requirements:
Precondition: Successfully create a MediaPlayer object.
Test method: Call the setOnCompleteListener() interface.
Conformity result: No return value, Register the playback completion listener to receive the playback completion event when the playback is finished. | +| 60 | | setOnPreparedListener() | Conformity requirements:
Precondition: Successfully create a MediaPlayer object.
Test method: Call the setOnPreparedListener() interface.
Conformity result: No return value, Register the ready listener to receive the | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | ready event when the player is ready. | +| 61 | | setOnBufferingUpdateListener() | Conformity requirements:
Precondition: Successfully create a MediaPlayer object.
Test method: Call the setOnBufferingUpdateListener() interface.
Conformity result: No return value, Register the buffer update listener to receive buffer update messages when they arrive. | +| 62 | | setDisplay() | SurfaceHolder.
Conformity requirements:
Precondition: Successfully create a MediaPlayer object.
Test method: Call the setDisplay() interface with valid input parameters.
Conformity result: No return value, Set the SurfaceHolder for media video playback. | +| 63 | | setAudioStreamType() | Conformity requirements:
Precondition: Successfully create a MediaPlayer object.
Test method: Call the setAudioStreamType() interface with valid input parameters.
Conformity result: No return value, set audio stream type. | +| 64 | | setStopMode() | Conformity requirement 1:
Precondition: Successfully create a MediaPlayer object.
Test method: Call the setStopMode() interface with valid input parameters of 0.
Conformity result: Return successful, set black screen mode.
Conformity requirement 2:
Precondition: Successfully create a MediaPlayer object and prepare it.
Test method: Call the setStopMode() interface with a valid input parameter of 1.
Conformity result: Return successful, set stop mode. | +| 65 | | getStopMode() | Conformity requirements:
Precondition: Successfully create a MediaPlayer object and start playing.
Test method: Call the getStopMode() interface.
Conformity result: The return value is the value of the corresponding set stop mode. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 66 | | getStartTime() | Conformity requirements:
Precondition: Successfully create a MediaPlayer object and prepare it.
Test method: Call the getStartTime() interface.
Conformity result: The return value indicates the start time of the time-shifted (or look-back) program. | +| 67 | | getPace() | Conformity requirements:
Precondition: Successfully create a MediaPlayer object and start playing.
Test method: Call the getPace() interface.
Conformity result: The return value indicates the speed of fast forward or fast reverse. | +| 68 | | setPace() | Conformity requirements:
Precondition: Successfully create a MediaPlayer object and start playing.
Test method: Call the setPace() interface with valid input parameters.
Conformity result: No return value, playback shows the correct multiplier playback effect. | +| 69 | | setClip() | Conformity requirements:
Precondition: Successfully create a MediaPlayer object and start playing.
Test method: Call the setClip() interface with valid input parameters.
Conformity result: No return value, indicating the display of the specified area of the media source. | +| 70 | | getClip() | Conformity requirements:
Precondition: Successfully create a MediaPlayer object and start playing.
Test method: Call the getClip() interface with valid input parameters.
Conformity result: The return value indicates the display area of the media source screen. | +| 71 | | clearVideo() | Conformity requirements:
Precondition: Successfully create a MediaPlayer object and start playing.
Test method: Call the clearVideo() interface.
Conformity result: A return value of 0 indicates successful screen cleaning, while a failure value of -1 is returned. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 72 | | setVideoDisplay() | Conformity requirements:
Precondition: Successfully create a MediaPlayer object and start playing.
Test method: Call the setVideoDisplay() interface with the parameter TVOS_VIDEO_DISPLAY_CLOSE. Then call the setVideoDisplay() interface again, with the parameter TVOS_VIDEO_DISPLAY_OPEN.
Conformity result: Both calls return TRUE successfully, and the video output is first turned off and then turned back on. | +| 73 | | getVideoDisplay() | Conformity requirements:
Precondition: Successfully create a MediaPlayer object and start playing.
Test method: Call the getVideoDisplay() interface.
Conformity result: The call succeeds, putting back the current correct video display state. | +| 74 | TrackInfo | MEDIA_TRACK_TYPE_UNKNOWN | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 0. | +| 75 | | MEDIA_TRACK_TYPE_VIDEO | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 1. | +| 76 | | MEDIA_TRACK_TYPE_AUDIO | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 2. | +| 77 | | MEDIA_TRACK_TYPE_TIME_TEXT | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 3. | +| 78 | | MEDIA_TRACK_TYPE_SUBTITLE | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: Constant value is 4. | +| 79 | | getTrackInfo() | Conformity requirements:
Precondition: Successfully create org.tvos.media.TrackInfo object.
Test method: Call the getTrackInfo() interface.
Conformity result: Get all actionable audio stream information of the currently | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | TrackInfo | | playing program, including audio, video, subtitle, synchronized subtitle, etc., and return org.tvos.media.TrackInfo data | +| 80 | | selectTrack() | Conformity requirements:
Precondition: Successfully created. org.tvos.media.TrackInfo object
Test method: Call the selectTrack() interface with a valid track index as the input parameter.
Conformity result: No return value, indicating the selection of a certain track. | +| 81 | | getSelectedTrack() | Conformity requirements:
Precondition: Successfully create org.tvos.media.TrackInfo object.
Test method: Call the getSelectedTrack() interface with a valid track type as the input parameter.
Conformity result: Get the index of the audio, video or subtitle track currently selected for playback. The return value indicates the index of the audio, video or subtitle selected for playback. | +| 82 | MediaFormat | MIMETYPE_VIDEO_VP8 | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "video/x-vnd.on2.vp8". | +| 83 | | MIMETYPE_VIDEO_VP9 | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "video/x-vnd.on2.vp9". | +| 84 | | MIMETYPE_VIDEO_AVC | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "video/avc". | +| 85 | | MIMETYPE_VIDEO_HEVC | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "video/hevc". | +| 86 | | MIMETYPE_VIDEO_MPEG4 | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "video/mp4v-es". | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| 87 | | MIMETYPE_VIDEO_H263 | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "video/3gpp". | +| 88 | | MIMETYPE_VIDEO_MPEG2 | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "video/mpeg2". | +| 89 | | MIMETYPE_VIDEO_RAW | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "video/raw". | +| 90 | | MIMETYPE_AUDIO_AMR_N
B | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "audio/amr-nb". | +| 91 | | MIMETYPE_AUDIO_AMR_W
B | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "audio/amr-wb". | +| 92 | | MIMETYPE_AUDIO_MPEG | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "audio/mpeg". | +| 93 | | MIMETYPE_AUDIO_AAC | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "audio/mp4a-latm". | +| 94 | | MIMETYPE_AUDIO_QCELP | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "audio/qcelp". | +| 95 | | MIMETYPE_AUDIO_VORBIS | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "audio/vorbis". | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| 96 | | MIMETYPE_AUDIO_OPUS | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "audio/opus". | +| 97 | | MIMETYPE_AUDIO_G711_A_LAW | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "audio/g711-alaw". | +| 98 | | MIMETYPE_AUDIO_G711_M_LAW | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "audio/g711-mlaw". | +| 99 | | MIMETYPE_AUDIO_RAW | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "audio/raw". | +| 100 | | MIMETYPE_AUDIO_FLAC | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "audio/flac". | +| 101 | | MIMETYPE_AUDIO_MSGSM | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "audio/gsm". | +| 102 | | MIMETYPE_AUDIO_AC3 | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "audio/ac3". | +| 103 | | MIMETYPE_TEXT_VTT | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "text/vtt". | +| 104 | | MIMETYPE_TEXT_CEA_608 | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "text/cea-608". | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| 105 | | KEY_MIME | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "mime". | +| 106 | | KEY_LANGUAGE | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "language". | +| 107 | | KEY_SAMPLE_RATE | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "sample-rate". | +| 108 | | KEY_CHANNEL_COUNT | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "channel-count". | +| 109 | | KEY_WIDTH | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "width". | +| 110 | | KEY_HEIGHT | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "height". | +| 111 | | KEY_MAX_WIDTH | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "max-width". | +| 112 | | KEY_MAX_HEIGHT | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "max-height". | +| 113 | | KEY_MAX_INPUT_SIZE | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "max-input-size". | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 114 | | KEY_BIT_RATE | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "bitrate". | +| 115 | | KEY_STREAM_PID | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "stream-pid". | +| 116 | | KEY_COLOR_FORMAT | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "color-format". | +| 117 | | KEY_CAPTURE_RATE | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "capture-rate". | +| 118 | | KEY_I_FRAME_INTERVAL | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "i-frame-interval". | +| 119 | | KEY_TEMPORAL_LAYERING | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "ts-schema". | +| 120 | | KEY_REPEAT_PREVIOUS_FRAME_AFTER | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "repeat-previous-frame-after". | +| 121 | | KEY_PUSH_BLANK_BUFFERS_ON_STOP | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "push-blank-buffers-on-shutdown". | +| 122 | | KEY_DURATION | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "durationUs". | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 123 | | KEY_IS_ADTS | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "is-adts". | +| 124 | | KEY_CHANNEL_MASK | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "channel-mask". | +| 125 | | KEY_AAC_PROFILE | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "aac-profile". | +| 126 | | KEY_AAC_SBR_MODE | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "aac-sbr-mode". | +| 127 | | KEY_AAC_MAX_OUTPUT_C HANNEL_COUNT | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "aac-max-output-channel_count". | +| 128 | | KEY_AAC_DRC_TARGET_R EREFERENCE_LEVEL | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "aac-target-ref-level". | +| 129 | | KEY_AAC_ENCODED_TARG ET_LEVEL | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "aac-encoded-target-level". | +| 130 | | KEY_AAC_DRC_BOOST_FA CTOR | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "aac-drc-boost-level". | +| 131 | | KEY_AAC_DRC_ATTENUAT ION_FACTOR | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "aac-drc-cut-level". | +| 132 | | KEY_AAC_DRC_HEAVY_CO MPRESSION | Conformity requirements: | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "aac-drc-heavy-compression". | +| 133 | | KEY_FLAC_COMPRESSION_LEVEL | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "flac-compression-level". | +| 134 | | KEY_COMPLEXITY | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "complexity". | +| 135 | | KEY_PROFILE | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "profile". | +| 136 | | KEY_BITRATE_MODE | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "bitrate-mode". | +| 137 | | KEY_AUDIO_SESSION_ID | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "audio-session-id". | +| 138 | | KEY_IS_AUTOSELECT | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "is-autoselect". | +| 139 | | KEY_IS_DEFAULT | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "is-default". | +| 140 | | KEY_IS_FORCED_SUBTITLE | Conformity requirements:
Precondition: None.
Test method: Determine constant values.
Conformity result: The constant value is "is-forced-subtitle". | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 141 | | MediaFormat() | Conformity requirements:
Precondition: None.
Test method: Create a MediaFormat object.
Conformity result: Constructor. | +| 142 | | containsKey() | Conformity requirements:
Precondition: Successfully create a MediaFormat object.
Test method: Call the containsKey() interface and legally input parameters.
Conformity result: Boolean type, Returns true if there is a message with a key value of name, otherwise returns false. | +| 143 | | getInteger() | Conformity requirements:
Precondition: Successfully create a MediaFormat object.
Test method: Call the getInteger() interface and legally input parameters.
Conformity result: int type, indicating that the key value corresponds to the integer attribute value of name. If the key does not exist, or the corresponding attribute value is not an integer, an exception is thrown. | +| 144 | | getLong() | Conformity requirements:
Precondition: Successfully create a MediaFormat object.
Test method: Call the getLong() interface and legally input parameters.
Conformity result: Long type, indicating that the key value corresponds to the long integer attribute value of name. If the key does not exist or the corresponding property value is not a long integer, an exception is thrown. | +| 145 | | getFloat() | Conformity requirements:
Precondition: Successfully create a MediaFormat object.
Test method: Call the getFloat() interface and legally input parameters.
Conformity result: float type, indicating the floating-point attribute value corresponding to the key value of name. If the key does not exist, or if the corresponding attribute value is not a floating-point form, an exception is thrown. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 146 | | getString() | Conformity requirements:
Precondition: Successfully create a MediaFormat object.
Test method: Call the getString() interface and legally input parameters.
Conformity result: String object, representing the string attribute value corresponding to the key value of name. If the key does not exist, or the corresponding attribute value is not a String object, an exception is thrown. | +| 147 | | getByteBuffer() | Conformity requirements:
Precondition: Successfully create a MediaFormat object.
Test method: Call the getByteBuffer() interface and legally input parameters.
Conformity result: Java.nio ByteBuffer object, representing the attribute value corresponding to the key value of name. If the key does not exist, or the corresponding attribute value is not a ByteBuffer object, an exception is thrown. | + +### A.7 Conformance test of system management unit interface + +| Serial No. | Test item | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------------|--------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Peripheral management | PeripheralType interface | PERIPHERAL_ALL | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "all". | +| 2 | | | PERIPHERAL_MOUSE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "mouse". | +| 3 | | | PERIPHERAL_PC_KEYBOARD | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "keyboard". | + +| Serial No. | Test item | Class/
interface | Constant
field/Attribute/Method | Process description | +|------------|-----------|-------------------------|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 4 | | Peripheral
interface | getType() |
Conformity requirement 1:
Precondition: Insert the mouse and successfully obtain an instance of the Peripheral class.
Test method: Call the getType() method and input valid parameters.
Conformity result: The method call succeeds and returns the peripheral type PERIPHERAL_MOUSE("mouse").
Conformity requirement 2:
Precondition: Insert the mouse and successfully obtain an instance of the Peripheral class.
Test method: Call the getType() method and input valid parameters.
Conformity result: The method call succeeds and returns the peripheral type PERIPHERAL_PC_KEYBOARD("keyboard").
Conformity requirement 3:
Precondition: Insert the mouse and successfully obtain an instance of the Peripheral class.
Test method: Call the getType() method and input valid parameters.
Conformity result: The method call succeeds and returns the peripheral type PERIPHERAL_ALL("all").
interface | getID() |
Conformity requirements:
Precondition: Insert peripheral and successfully obtain an instance of the Peripheral class.
Test method: Call the getID() method.
Conformity result: The method call succeeds and returns the peripheral global unique identifier not 0.
interface | getName() |
Conformity requirements:
Precondition: Insert peripheral and successfully obtain an instance of the Peripheral class.
Test method: Call the getName() method.
Conformity result: The method call succeeds and the returned peripheral name is not NULL.
interface | Constant
field/Attribute/Method | Process description | +|------------|-----------|--------------------------------|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 7 | | | getStatus() | Conformity requirements:
Precondition: Insert peripheral and successfully obtain an instance of the Peripheral class.
Test method: Call the getStatus() method.
Conformity result: The method call succeeds. Return an int type, indicating the status of the peripheral, with values related to the specific type of peripheral. | +| 8 | | | getInstance() | Conformity requirements:
Precondition: None.
Test method: Call the getInstance() method.
Conformity result: The method call succeeds, returning a unique instance of the PeripheralManager class implemented by the system that is not NULL. | +| 9 | | Peripheral
Manager
class | addPeripheralEventListener() | Conformity requirement 1:
Precondition: Successfully obtain an instance of the PeripheralManager class and insert the peripheral device.
Test method: Call the addPeripheralEventListener() method and input valid parameters.
Conformity result: The method call succeeds, triggering the peripheral information callback, and the callback event type is 0~3 respectively.
Conformity requirement 2:
Precondition: Successfully obtain an instance of the PeripheralManager class and insert the peripheral device.
Test method: Call the addPeripheralEventListener() method and input invalid parameters.
Conformity result: No callback is triggered. | +| 10 | | | removePeripheralListener() | Conformity requirement 1:
Precondition: Successfully obtain the instance of the PeripheralManager class, insert the peripheral, call the addPeripheralEventListener() method, and register the peripheral event listener successfully.
Test method: Call the removePeripheralListener() method and input valid parameters.
Conformity result: The method call succeeds, the peripheral information callback is not triggered, and the callback | + +| Serial No. | Test item | Class/
interface | Constant
field/Attribute/Method | Process description | +|------------|-----------|--------------------------------|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Peripheral
Manager
class | | message is not received.
Conformity requirement 2:
Precondition: Successfully obtain the instance of the PeripheralManager class, insert the peripheral, call the addPeripheralEventListener() method, and register the peripheral event listener successfully.
Test method: Call the removePeripheralListener() method and input invalid parameters.
Conformity result: The method call fails, triggering a peripheral information callback with the message TYPE_FOUND (0). | +| 11 | | | getAllPeripheralsByType() | Conformity requirement 1:
Precondition: Successfully obtain an instance of the PeripheralManager class and insert the peripheral device.
Test method: Call the getAllPeripheralsByType() method and input valid parameters.
Conformity result: Method call succeeds, the returned length of the array of Peripheral objects is not zero.
Conformity requirement 2:
Precondition: Successfully obtain an instance of the PeripheralManager class and insert the peripheral device.
Test method: Call the getAllPeripheralsByType() method and input invalid parameters.
Conformity result: The method call fails, the returned length of the array of Peripheral objects is zero. | +| 12 | | | getPeripheralsByID() | Conformity requirement 1:
Precondition: Successfully obtain the instance of the PeripheralManager class, insert the peripheral, and obtain the peripheral ID.
Test method: Call the getPeripheralsByID() method and input valid parameters.
Conformity result: The method call succeeds and the Peripheral object is returned.
Conformity requirement 2:
Precondition: Successfully obtain the instance of the PeripheralManager class, insert the peripheral, and obtain the peripheral ID. | + +| Serial No. | Test item | Class/
interface | Constant
field/Attribute/Method | Process description | +|------------|-----------|---------------------|------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | Test method: Call the getPeripheralsByID() method and input invalid parameters.
Conformity result: The method call fails and returns NULL. | +| 13 | | | uninstallPeripheralByID() | Conformity requirement 1:
Precondition: Successfully obtain the instance of the PeripheralManager class, insert the peripheral, and obtain the peripheral ID.
Test method: Call the uninstallPeripheralByID() method and input valid parameters.
Conformity result: The method call succeeds and returns true.
Conformity requirement 2:
Precondition: Successfully obtain the instance of the PeripheralManager class, insert the peripheral, and obtain the peripheral ID.
Test method: Call the uninstallPeripheralByID() method and input valid parameters.
Conformity result: The method call fails and returns false. | +| 14 | | PeripheralListener | processPeripheralEvent() | Conformity requirements:
Precondition: Successfully obtain an instance of the PeripheralManager class and call the addPeripheralEventListener() method successfully.
Test method: Insert peripherals.
Conformity result: The method is successfully called. | +| 15 | | | TYPE_FOUND | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 0. | +| 16 | | | TYPE_READY | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 1. | +| 17 | | PeripheralEvent | TYPE_ERROR | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 2. | + +| Serial No. | Test item | Class/
interface | Constant
field/Attribute/Method | Process description | +|------------|-----------|---------------------|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 18 | | | TYPE_PLUGOUT | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 3. | +| 19 | | | getPeripheral() | Conformity requirements:
Precondition: Successfully obtain an instance of the PeripheralManager class, insert the peripheral, call the addPeripheralEventListener() method to register for peripheral listening, and obtain the PeripheralEvent instance when the callback is triggered.
Test method: Call the getPeripheral() method.
Conformity result: The method call succeeds and the returned Peripheral object is not NULL. | +| 20 | | | getType() | Conformity requirement 1:
Precondition: Successfully obtain an instance of the PeripheralManager class, insert the peripheral, call the addPeripheralEventListener() method to register for peripheral listening, and obtain the PeripheralEvent instance when the callback is triggered.
Test method: Call the getType() method.
Conformity result: The method call succeeds and returns a peripheral event type of TYPE_FOUND (0) and TYPE_READY (1).
Conformity requirement 2:
Precondition: Successfully obtaining an instance of the PeripheralManager class, inserting a peripheral. The peripheral has an unrecoverable error and cannot be accessed. Call the addPeripheralEventListener() method to register for peripheral listening, and when the callback is triggered, obtain the PeripheralEvent instance.
Test method: Call the getType() method.
Conformity result: The method call succeeds and the error message TYPE_ERROR(2) is returned.
Conformity requirement 3:
Precondition: Successfully obtain an instance of the PeripheralManager class, insert the peripheral, call the addPeripheralEventListener() method to | + +| Serial No. | Test item | Class/
interface | Constant
field/Attribute/Method | Process description | +|------------|-------------------------|---------------------|------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | register for peripheral listening, and obtain the PeripheralEvent instance when the callback is triggered.
Test method: Remove the peripheral and call the getType() method.
Conformity result: The method call succeeds and the error message TYPE_PLUGOUT(3) is returned. | +| 21 | Data access and storage | DataConfigs class | getInstance() | Conformity requirements:
Precondition: None.
Test method: Call the getInstance() method
Conformity result: The method call succeeds, and the unique instance of the DataAccess class implemented by the system is returned as non null. | +| 22 | | | getProperty() | Conformity requirement 1:
Precondition: Call the getInstance() method to successfully obtain an instance of the DataAccess class.
Test method: Call the getProperty() method and input valid parameters.
Conformity result: The method call succeeds and the returned data item value that is not NULL.
Conformity requirement 2:
Precondition: Call the getInstance() method to successfully obtain an instance of the DataAccess class.
Test method: Call the getProperty() method and input valid parameters.
Conformity result: The method call fails and the returned data item value is NULL. | +| 23 | | | setProperty() | Conformity requirement 1:
Precondition: Call the getInstance() method to successfully obtain an instance of the DataAccess class.
Test method: Call the setProperty() method, set the value of the data item, and input valid parameters.
Conformity result: The method call succeeds and returns the modified result as greater than 0.
Conformity requirement 2:
Precondition: Call the getInstance() method to successfully obtain an instance of the DataAccess class.
Test method: Call the setProperty() method, set the value of the data item, and input invalid parameters. | + +| Serial No. | Test item | Class/
interface | Constant
field/Attribute/Method | Process description | +|------------|-------------------------|---------------------|------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Data access and storage | DataAccess class | | Conformity result: The method call fails and returns a modification result of 0.
Conformity requirement 3:
Precondition: Call the
getInstance() method to successfully obtain an instance of the DataAccess class.Test method: Call the
setProperty() method to set the value of the data item, which does not exist.Conformity result: The method call fails and returns a modification result of -1. | +| 24 | | |
restoreDefault() | Conformity requirement:Precondition: Call the
getInstance() method to successfully obtain an instance of the DataAccess class.Test method: Call the
restoreDefault() method and input valid parameters.Conformity result: The method call succeeds and returns true. | +| 25 | | |
restoreFromNvm() | Conformity requirement:Precondition: Call the
getInstance() method to successfully obtain an instance of the DataAccess class.Test method: Call the
restoreFromNvm() method and input valid parameters.Conformity result: The method call succeeds and returns true. | +| 26 | | |
saveToNvm() | Conformity requirement 1:Precondition: Call the
getInstance() method to successfully obtain an instance of the DataAccess class.Test method: Call the
saveToNvm() method and input valid parameters.Conformity result: The method call succeeds and returns true.
Conformity requirement 2:
Precondition: Call the
getInstance() method to successfully obtain an instance of the DataAccess class.Test method: Call the
saveToNvm() method and input invalid parameters.Conformity result: Method call fails and returns false. | + +| Serial No. | Test item | Class/
interface | Constant
field/Attribute/Method | Process description | +|------------|---------------------------------|---------------------|------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 27 | View
Hardware
Information | HardwareInfo class | FLASH_SIZE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "flash_size". | +| 28 | | | RAM_SIZE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "ram_size". | +| 29 | | | RAM_TYPE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "ram_type". | +| 30 | | | SOC_MODEL | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "soc_model". | +| 31 | | | SOC_FREQUENCY | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "soc_frequency". | +| 32 | | | SOC_PROVIDER | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "soc_provider". | +| 33 | | | DEFINITION_TYPE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "definition_type". | +| 34 | | | HW_VERSION | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "hw_version". | + +| Serial No. | Test item | Class/
interface | Constant
field/Attribute/Method | Process description | +|------------|---------------------------------|---------------------|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 35 | View
Hardware
Information | HardwareInfo class | STB_BRAND | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "stb_brand". | +| 36 | | | STB_MODEL | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "stb_model". | +| 37 | | | STB_PROVIDER | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "stb_provider". | +| 38 | | | STB_SERIAL_NUMBER | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "stb_serial_number". | +| 39 | | | TRANSPORT_TYPE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "transport_type". | +| 40 | | | getProperty() | Conformity requirement 1:
Precondition: None.
Test method: Call the getProperty() method and input valid parameters.
Conformity result: The method call succeeds and the returned String object is not NULL.
Conformity requirement 2:
Precondition: None.
Test method: Call the getProperty() method, input invalid parameters, hardware configuration item keywords are illegal.
Conformity result: The method call fails, throwing an IllegalArgumentException. | + +| Serial No. | Test item | Class/
interface | Constant
field/Attribute/Method | Process description | +|------------|---------------------------------|---------------------|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| 41 | View
Software
Information | SoftwareInfo class | OS_NAME | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "os_name". | +| 42 | | | OS_PROVIDER | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "os_provider". | +| 43 | | | OS_VERSION | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "os_version". | +| 44 | | | MW_NAME | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "mw_name". | +| 45 | | | MW_VERSION | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "mw_version". | +| 46 | | | MW_PROVIDER | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "mw_provider". | +| 47 | View
Software
Information | SoftwareInfo class | MW_RAM_SIZE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "mw_ram_size". | +| 48 | | | MW_NVM_SIZE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "mw_nvm_size". | + +| Serial No. | Test item | Class/
interface | Constant
field/Attribute/Method | Process description | +|------------|---------------------------------|---------------------|------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 49 | View
Software
Information | SoftwareInfo class | MW_RELEASE_DATE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "mw_release_date". | +| 50 | | | MW_COPYRIGHT | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "mw_copyright". | +| 51 | | | MW_PLATFORM_LEVEL | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "mw_platform_level". | +| 52 | | | MW_PLATFORM_PROFILE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "mw_platform_profile". | +| 53 | | | CA_NAME | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "ca_name". | +| 54 | | | CA_VERSION | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "ca_version". | +| 55 | | | CA_PROVIDER | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "ca_provider". | +| 56 | | | LOADER_NAME | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "loader_name". | + +| Serial No. | Test item | Class/
interface | Constant
field/Attribute/Method | Process description | +|------------|-------------|---------------------|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 57 | | | LOADER_VERSION | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "loader_version". | +| 58 | | | LOADER_PROVIDER | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "loader_provider". | +| 59 | | | LOADER_SIZE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "loader_size". | +| 60 | | | DRIVER_VERSION | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is "driver_version". | +| 61 | | | getProperty() | Conformity requirement 1:
Precondition: None.
Test method: Call the getProperty() method and input valid parameters.
Conformity result: The method call succeeds and the returned String object is not NULL.
Conformity requirement 2:
Precondition: None.
Test method: Call the getProperty() method, input invalid parameters, hardware configuration item keywords are illegal.
Conformity result: The method call fails, throwing an IllegalArgumentException. | +| 62 | System tool | SysTool class | getInstance() | Conformity requirements:
Precondition: None.
Test method: Call the getInstance() method.
Conformity result: The method call succeeds, and the unique instance of the SysTool class implemented by the system is returned as non null. | + +| Serial No. | Test item | Class/
interface | Constant
field/Attribute/Method | Process description | +|------------|-----------|---------------------|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 63 | | | getStandByStatus() |
Conformity requirement 1:
Precondition: Call the getInstance() method to successfully obtain an instance of the SysTool class.
Test method: Call the getStandByStatus() method to enter standby mode.
Conformity result: The method call succeeds and returns true.
Conformity requirement 2:
Precondition: Call the getInstance() method to successfully obtain an instance of the SysTool class.
Test method: Call the getStandByStatus() method to exit standby mode (i.e. working mode).
Conformity result: The method call succeeds and returns false.
Conformity requirements:
Precondition: Call the getInstance() method to successfully obtain an instance of the SysTool class.
Test method: Call the standby() method.
Conformity result: The method call is successful and the receiver is restarted.
Conformity requirements:
Precondition: Call the getInstance() method to successfully obtain an instance of the SysTool class.
Test method: Call the Sleep() method.
Conformity result: The method call succeeds, the receiver goes to sleep and the CPU will power down and stop working.
Conformity requirements:
Precondition: Call the getInstance() method to successfully obtain an instance of the SysTool class.
Test method: Call the reboot() method.
Conformity result: The method call succeeds and the WaleUpSrc object returned is not NULL.
Conformity requirements:
Precondition: Call the getInstance() method to successfully obtain an instance of the SysTool class, and call Sleep() to enter sleep mode.
Test method: Call the wakeUp() method.
Conformity result: The method call succeeds and the receiver enters the operating state.
interface | Constant
field/Attribute/Method | Process description | +|------------|-------------------------------------|--------------------------|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 68 | Storage
Device
Managem
ent | StorageMa
nager class | getInstance() | Conformity requirements:
Precondition: None.
Test method: Call the getInstance() method.
Conformity result: The method call succeeds, and the unique instance of the StorageManager class implemented by the system is returned as non null. | +| 69 | | | addStorageEventListener() | Conformity requirement 1:
Precondition: Call the getInstance() method to successfully retrieve an instance of the StorageManager class.
Test method: Call the addStorageEventListener() method and input valid parameters.
Conformity result: The method call succeeds, and the callback has a message.
Conformity requirement 2:
Precondition: Call the getInstance() method to successfully retrieve an instance of the StorageManager class.
Test method: Call the addStorageEventListener() method and input invalid parameters.
Conformity result: The method call fails and does not trigger a callback for peripheral information. | +| 70 | Storage
Device
Managem
ent | StorageMa
nager class | removeStorageEventListener() | Conformity requirement 1:
Precondition: Call the getInstance() method to obtain an instance of the StorageManager class successfully, call the addStorageEventListener() method, and register for listening successfully.
Test method: Call the removeStorageEventListener() method and input valid parameters.
Conformity result: The method call succeeds, no peripheral information callback is triggered, and no callback message is received.
Conformity requirement 2:
Precondition: Call the getInstance() method to obtain an instance of the StorageManager class successfully, call the addStorageEventListener() method, and register for listening successfully.
Test method: Call the removeStorageEventListener() method and input invalid parameters.
Conformity result: The method call fails, and callback has message. | + +| Serial No. | Test item | Class/
interface | Constant
field/Attribute/Method | Process description | +|------------|---------------------------|--------------------------------|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 71 | | StorageManager class | getAllStorages() |
Conformity requirement 1:
Precondition: Call the getInstance() method to successfully retrieve an instance of the StorageManager class.
Test method: Call the getAllStorages() method and input valid parameters.
Conformity result: The method call succeeds and returns the Storage object.
Conformity requirement 2:
Precondition: Call the getInstance() method to successfully retrieve an instance of the StorageManager class.
Test method: Call the getAllStorages() method and input invalid parameters.
Conformity result: The method call succeeds and returns NULL.
Conformity requirement 1:
Precondition: Call the getInstance() method to successfully retrieve an instance of the StorageManager class.
Test method: Call the uninstallStorage() method and input valid parameters.
Conformity result: The method call succeeds, and returns true.
Conformity requirement 2:
Precondition: Call the getInstance() method to successfully retrieve an instance of the StorageManager class.
Test method: Call the uninstallStorage() method and input invalid parameters.
Conformity result: Method call fails, and returns false.
Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 22.
Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 23.
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 24. | +| 77 | | | TYPE_PARTITION_UNINSTALL | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 25. | +| 78 | | | TYPE_INSUFFICIENT_SPACE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 32. | +| 79 | | | getType() | Conformity requirement 1:
Precondition: Insert the storage device, call the getInstance() method, successfully obtain the instance of the StorageManager class, call the addStorageEventListener() method, and obtain the StorageEvent object when the callback is triggered.
Test method: Call the getType() method.
Conformity result: The method call succeeds, returning a message of type TYPE_PARTITION_FOUND(22), TYPE_PARTITION_MOUNTED(23).
Conformity requirement 2:
Precondition: Insert a storage device with insufficient space, call the getInstance() method to obtain an instance of the StorageManager class successfully, call the addStorageEventListener() method, and when the callback is triggered, obtain the StorageEvent object.
Test method: Call the getType() method.
Conformity result: The method call succeeds, returning a message of type TYPE_INSUFFICIENT_SPACE(32). | +| | | | getType() | Conformity requirement 3:
Precondition: Insert a storage device that cannot be mounted, call the getInstance() method, successfully obtain an instance of the StorageManager class, call the addStorageEventListener() method, and when the callback is triggered, obtain the StorageEvent object. | + +154 Rec. ITU-T J.1207 (10/2024) + +| Serial No. | Test item | Class/
interface | Constant
field/Attribute/Method | Process description | +|------------|-----------|---------------------|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | |
Test method: Call the getType() method.
Conformity result: The method call succeeds, returning a message of type TYPE_PARTITION_MOUNT_FAILED(24).
Conformity requirement 4:
Precondition: Insert the storage device, call the getInstance() method, successfully obtain the instance of the StorageManager class, call the addStorageEventListener() method, and obtain the StorageEvent object when the callback is triggered.
Test method: Call the uninstallStorage() method to uninstall the storage device, and call the getType() method.
Conformity result: The method call succeeds, returning a message of type TYPE_PARTITION_UNINSTALL(25).
getStorage() | Conformity requirement 1:
Precondition: Insert the storage device, call the getInstance() method, successfully obtain the instance of the StorageManager class, call the addStorageEventListener() method, and obtain the StorageEvent object when the callback is triggered.
Test method: Call the getStorage() method.
Conformity result: The method call succeeds, and the returned Storage object is not NULL.
Conformity requirement 2:
Precondition: Insert the storage device, call the getInstance() method, successfully obtain the instance of the StorageManager class, call the addStorageEventListener() method, and obtain the StorageEvent object when the callback is triggered.
Test method: Call the getStorage() method.
Conformity result: The method call fails, and the returned Storage object is NULL.
getStoragePartition() | Conformity requirement 1:
Precondition: Insert the storage device, call the getInstance() method, successfully obtain the instance of the StorageManager class, call the addStorageEventListener() method, and obtain the StorageEvent object when the callback is triggered.
Test method: Call the getStoragePartition() method.
Conformity result: The method call
Conformity requirement 2:
Precondition: Insert the storage device, call the getInstance() method, successfully obtain the instance of the StorageManager class, call the addStorageEventListener() method, and obtain the StorageEvent object when the callback is triggered.
Test method: Call the getStoragePartition() method.
Conformity result: The method call fails, and the returned StoragePartition object is NULL. | +| 82 | | StoragePart
ition
interface | getName() | Conformity requirement 1:
Precondition: Call the getInstance() method to successfully obtain an instance of the StorageManager class, call the getAllStorages() method to obtain the Storage object, and call getAllPartitions() to obtain the StoragePartition object.
Test method: Call the getName() method and input valid parameters.
Conformity result: The method call succeeds and the returned String object is not NULL.
Conformity requirement 2:
Precondition: Call the getInstance() method to successfully obtain an instance of the StorageManager class, call the getAllStorages() method to obtain the Storage object, and call getAllPartitions() to obtain the StoragePartition object.
Test method: Call the getName() method and input invalid parameters.
Conformity result: The method call fails and returns NULL. | +| 83 | | | getID() | Conformity requirement 1:
Precondition: Call the getInstance() method to successfully obtain an instance of the StorageManager class, call the getAllStorages() method to obtain the Storage object, and call getAllPartitions() to obtain the StoragePartition object.
Test method: Call the getID() method and input valid parameters.
Conformity result: The method call succeeds and returns a globally unique identifier (ID) greater than 0.
Conformity requirement 2:
Precondition: Call the getInstance() | + +| Serial No. | Test item | Class/
interface | Constant
field/Attribute/Method | Process description | +|-------------------|------------------|-----------------------------|--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 84 | | StoragePartition interface | | method to successfully obtain an instance of the StorageManager class, call the getAllStorages() method to obtain the Storage object, and call getAllPartitions() to obtain the StoragePartition object.
Test method: Call the getID() method and input invalid parameters.
Conformity result: The method call fails, and returns a globally unique ID less than 0. | +| | | | getPath() | Conformity requirement 1:
Precondition: Call the getInstance() method to successfully obtain an instance of the StorageManager class, call the getAllStorages() method to obtain the Storage object, and call getAllPartitions() to obtain the StoragePartition object.
Test method: Call the getPath() method and input valid parameters.
Conformity result: The method call succeeds and the returned String object is not NULL.
Conformity requirement 2:
Precondition: Call the getInstance() method to successfully obtain an instance of the StorageManager class, call the getAllStorages() method to obtain the Storage object, and call getAllPartitions() to obtain the StoragePartition object.
Test method: Call the getPath() method and input invalid parameters.
Conformity result: The method call fails and returns NULL. | +| | | | getStatus() | Conformity requirement 1:
Precondition: Call the getInstance() method to successfully obtain an instance of the StorageManager class, call the getAllStorages() method to obtain the Storage object, and call getAllPartitions() to obtain the StoragePartition object.
Test method: Call the getStatus() method and input validparameters.
Conformity result: The method call succeeds and the returned String object is not NULL.
Conformity requirement 2:
Precondition: Call the getInstance() method to successfully obtain an instance of the StorageManager class, call the getAllStorages() method to obtain the Storage object, and call getAllPartitions() | +| 85 | | StoragePartition | | | + +| Serial No. | Test item | Class/
interface | Constant
field/Attribute/Method | Process description | +|------------|-----------|---------------------|------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | interface | | to obtain the StoragePartition object.
Test method: Call the getStatus() method and input invalid parameters.
Conformity result: The method call fails and returns NULL. | +| 86 | | | getFreeSize() | Conformity requirement 1:
Precondition: Call the getInstance() method to successfully obtain an instance of the StorageManager class, call the getAllStorages() method to obtain the Storage object, and call getAllPartitions() to obtain the StoragePartition object.
Test method: Call the getFreeSize() method and input valid parameters.
Conformity result: The method call succeeds and the value returned is of type LONG and greater than 0.
Conformity requirement 2:
Precondition: Call the getInstance() method to successfully obtain an instance of the StorageManager class, call the getAllStorages() method to obtain the Storage object, and call getAllPartitions() to obtain the StoragePartition object.
Test method: Call the getFreeSize() method and input invalid parameters.
Conformity result: The method call succeeds and the value returned is of type LONG and not greater than 0. | +| 87 | | | getTotalSize() | Conformity requirement 1:
Precondition: Call the getInstance() method to successfully obtain an instance of the StorageManager class, call the getAllStorages() method to obtain the Storage object, and call getAllPartitions() to obtain the StoragePartition object.
Test method: Call the getTotalSize() method and input valid parameters.
Conformity result: The method call succeeds and the value returned is of type LONG and greater than 0.
Conformity requirement 2:
Precondition: Call the getInstance() method to successfully obtain an instance of the StorageManager class, call the getAllStorages() method to obtain the Storage object, and call getAllPartitions() to obtain the StoragePartition object.
Test method: Call the getTotalSize() method and input invalid parameters.
Conformity result: The method call succeeds and the value returned is of type LONG and not greater than 0. | + +| Serial No. | Test item | Class/
interface | Constant
field/Attribute/Method | Process description | +|------------|-----------|----------------------|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 88 | | Storage
interface | getSerialNumber() | Conformity requirement 1:
Precondition: Call the getInstance() method to successfully obtain an instance of the StorageManager class, and call the getAllStorages() method to obtain the Storage object.
Test method: Call the getSerialNumber() method and input valid parameters.
Conformity result: The method call succeeds and an array of StoragePartition objects is returned.
Conformity requirement 2:
Precondition: Call the getInstance() method to successfully obtain an instance of the StorageManager class, and call the getAllStorages() method to obtain the Storage object.
Test method: Call the getSerialNumber() method and input invalid parameters.
Conformity result: The method call fails and returns NULL. | +| 89 | | | getAllPartitions() | Conformity requirement 1:
Precondition: Call the getInstance() method to successfully obtain an instance of the StorageManager class, and call the getAllStorages() method to obtain the Storage object.
Test method: Call the getAllPartitions() method and input valid parameters.
Conformity result: The method call succeeds and an array of StoragePartition objects is returned.
Conformity requirement 2:
Precondition: Call the getInstance() method to successfully obtain an instance of the StorageManager class, and call the getAllStorages() method to obtain the Storage object.
Test method: Call the getAllPartitions() method and input invalid parameters.
Conformity result: The method call fails and returns NULL. | +| 90 | | | getInstance() | Conformity requirements:
Precondition: None.
Test method: Call the getInstance() method.
Conformity result: The method call succeeds, and returns a unique instance of the OTAManager class implemented by the system that is not NULL. | + +| Serial No. | Test item | Class/
interface | Constant
field/Attribute/Method | Process description | +|------------|----------------|---------------------|------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 91 | OTA Management | OTAManager class | checkOTA() |
Conformity requirement 1:
Precondition: Call the getInstance() method to successfully obtain an instance of the OTAManager class.
Test method: Call the checkOTA() method and start the upgrade by calling startOTA().
Conformity result: The method call succeeds and returns true.
Conformity requirement 2:
Precondition: Successfully call the tune() method and lock the frequency successfully.
Test method: Call the checkOTA() method.
Conformity result: The method call succeeds and returns false.
Conformity requirement 1:
Precondition: Call the getInstance() method to successfully obtain an instance of the OTAManager class.
Test method: Call the getOTAName() method, call startOTA() to start the upgrade, and provide the name of the upgrade event.
Conformity result: The method call succeeds and the returned String object is not NULL.
Conformity requirement 2:
Precondition: Call the getInstance() method to successfully obtain an instance of the OTAManager class.
Test method: Call the getOTAName() method, call startOTA() to start the upgrade, and no upgrade event name was provided.
Conformity result: Return NULL.
Conformity requirement 1:
Precondition: Call the getInstance() method to successfully obtain an instance of the OTAManager class.
Test method: Call startOTA() to start the upgrade.
Conformity result: The method call succeeds and returns true.
Conformity requirement 2:
Precondition: Call the getInstance() method to successfully obtain an instance of the OTAManager class.
Test method: Call the startOTA() method
interface | Constant
field/Attribute/Method | Process description | +|------------|----------------|---------------------|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 94 | OTA Management | OTAManager class | | to start the upgrade.
Conformity result: The method call fails and returns false. | +| | | | addOTAEVENTListener() |
Conformity requirement 1:
Precondition: Call the getInstance() method to successfully obtain an instance of the OTAManager class.
Test method: Call the addOTAEVENTListener() method, input valid parameters, do not prompt the user, and directly call the startOTA() method to start the upgrade.
Conformity result: The method call succeeds, triggering an external OTA upgrade callback with a callback event type of 0.
Conformity requirement 2:
Precondition: Call the getInstance() method to successfully obtain an instance of the OTAManager class.
Test method: Call the addOTAEVENTListener() method, input valid parameters, prompt the user, and call the startOTA() method to start the upgrade.
Conformity result: The method call succeeds, triggering an external OTA upgrade callback with a callback event type of 1.
Conformity requirement 1:
Precondition: Call the getInstance() method to obtain an instance of the OTAManager class successfully, call the addOTAEVENTListener() method, and register the peripheral event listener successfully.
Test method: Call the removeOTAEVENTListener() method, input valid parameters, and call the startOTA() method to start the upgrade.
Conformity result: The method call succeeds, no peripheral information callback is triggered, and no callback message is received.
Conformity requirement 2:
Precondition: Call the getInstance() method to obtain an instance of the OTAManager class successfully, call the addOTAEVENTListener() method, and register the peripheral event listener successfully.
interface | Constant
field/Attribute/Method | Process description | +|------------|-----------|-------------------------------|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | Test method: Call the
removeOTAEventListener() method, input invalid parameters, and call the startOTA() method to start the upgrade. Conformity result: The method call fails, triggering a peripheral information callback with a callback message of 0. |
+| 96 | | OTAEventListenerinterface |
processEvent() | OTA event listener, implemented by the application program, does not require testing. |
+| 97 | | | OTA_NORMAL | Conformity requirements:Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 1. | +| 98 | | |
OTA_FORCE | Conformity requirements:Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 0. | +| 99 | | OTAEvent
event |
getType() | Conformity requirement 1:Precondition: Call the
getInstance() method to successfully obtain an instance of the OTAManager class, call the addOTAEventListener() method, and directly call the startOTA() method to trigger a callback to obtain the OTAEvent instance.Test method: Call the
getType() method.Conformity result: The method call succeeds, and the return upgrade type is
OTA_FORCE(0) .Conformity requirement 2:
Precondition: Call the
getInstance() method to obtain an instance of the OTAManager class. Call the addOTAEventListener() method. After the user confirms, call the startOTA() method to trigger a callback to obtain an OTAEvent instance.Test method: Call the
getType() method.Conformity result: The method call succeeds, and the return upgrade type is
OTA_NORMAL(1) . |
+
+### A.8 Conformance test of application engine unit interface
+
+| Serial No. | Class/interface | Constant field/Attribute/Method | Process description |
+|------------|-----------------------------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 1 | org.ngb.toolkit.channelscan.ChannelScanListener | processEvent() |
Conformity requirements:
Precondition: The application programme implements the interface, and the application further determines the prototype of the event object through the IsInstanceOf() method.
Test method: When searching for channels, the class that implements this interface is called and the listener is registered.
Conformity result: Can correctly monitor the status of successful or failed channel search.
Conformity requirements:
Precondition: None.
Test method: The class name directly calls ChannelScanEngine.CHANNELSCAN_TYPE_MANUAL.
Conformity requirements: The corresponding values are consistent with the standards.
Conformity requirements:
Precondition: None.
Test method: The class name directly calls ChannelScanEngine.CHANNELSCAN_TYPE_NIT.
Conformity requirements: The corresponding values are consistent with the standards.
ChannelScanEngine | CHANNELSCAN_TYPE_ZONE |
Conformity requirements:
Precondition: None.
Test method: The class name directly calls ChannelScanEngine.CHANNELSCAN_TYPE_ZONE.
Conformity requirements: The corresponding values are consistent with the standards.
Conformity requirements:
Precondition: None.
Test method: The class name directly calls ChannelScanEngine.CHANNELSCAN_TYPE_JSON.
Conformity requirements: The corresponding values are consistent with the standards.
Conformity requirement 1:
Precondition: None.
Test method: Calling the createInstance() parameter is valid.
Conformity result: The method call succeeds and returns the org.ngb.toolkit.channelscan.ChannelScanEngine object, representing the search engine.
Conformity requirement 2:
Precondition: None.
Test method: Call createInstance(), the TunerID parameter is invalid.
Conformity result: Throw org.davic.mpeg.ResourceException indicating that the underlying resource is insufficient.
Conformity requirement 1:
Precondition: Successfully call the createInstance() method and return a valid search engine.
Test method: Call the addChannelScanListener() method with the parameter org.ngb.toolkit.channelscan.ChannelScanListener object.
Conformity result: The registered listener can listen to the search status.
Conformity requirement 1:
Precondition: Successfully call the createInstance() method and return a valid search engine.
Test method: Call the removeChannelScanListener() method with an parameter of the org.ngb.toolkit.channelscan.ChannelScanListener object to be logged out.
Conformity result: Listener logout succeeds, no search status is detected.
Conformity requirement 1:
Precondition: Successfully call the createInstance() method and return a valid search engine; Successfully call addChannelScanListener().
Test method: Call startScan() and ensure that the parameters are valid.
Conformity result: The org.ngb.toolkit.channelscan.ChannelScanListener object registered by addChannelScanListener() will listen
to the following four types of events:
a) Listen to the org.ngb.toolkit.channelscan.ChannelScanNITSuccessEvent event when the search for the NIT is complete.
b) Listen to the org.ngb.toolkit.channelscan.ChannelScanSuccessEvent event when the search for a frequency is complete.
c) Listen to the org.ngb.toolkit.channelscan.ChannelScanFinishEvent event when the search for a frequency is complete.
d) Listen to the org.ngb.toolkit.channelscan.ChannelScanFailureEvent event when the search fails.
Conformity requirement 2:
Precondition: Successfully call the createInstance() method and return a valid search engine; Successfully call addChannelScanListener().
Test method: Call startScan() with invalid parameters.
Conformity result: Throw a java.lang.IllegalArgumentException exception, indicating that the parameter is invalid.
Conformity requirement 1:
Precondition: Successfully call the createInstance() method and return a valid search engine; Successfully call addChannelScanListener().
Test method: Call the startScanExt() method with valid parameters.
Conformity result: The org.ngb.toolkit.channelscan.ChannelScanListener object registered by addChannelScanListener()will listen to the following two types of events:
- 1. Listen to the org.ngb.toolkit.channelscan.ChannelScanFinishEvent event when the search ends.
- 2. Listen to the org.ngb.toolkit.channelscan.ChannelScanFailureEvent event when the search fails.
Conformity requirement 2:
Precondition: Successfully call the createInstance() method and return a valid search engine; Successfully call
Test method: Call the startScanExt() method with invalid parameters.
Conformity result: Throw a Java.lang.IllegalArgumentException exception, indicating that the parameter is invalid. | +| 11 | | cancel() | Conformity requirement 1:
Precondition: Successfully call the createInstance() method and return a valid search engine; Successfully call addChannelScanListener(), and successfully call one of the search methods startScan() or startScanExt().
Test method: Call the cancel() method before the search fails or ends.
Conformity result: The org.ngb.toolkit.channelscan.ChannelScanListener object registered by addChannelScanListener() will monitor the org.ngb.toolkit.channelscan.ChannelScanFinishEvent event.
Conformity requirement 2:
Precondition: Successfully call the createInstance() method and return a valid search engine; Successfully call addChannelScanListener(), and successfully call one of the search methods startScan() or startScanExt().
Test method: Call the cancel() method after the search fails or ends.
Conformity result: The org.ngb.toolkit.channelscan.ChannelScanListener object will not monitor the org.ngb.toolkit.channelscan.ChannelScanFinishEvent event. | +| 12 | | release() | Conformity requirements:
Precondition: Successfully call the createInstance() method and return a valid search engine.
Test method: Call release().
Conformity result: Search engine usage resources are released. | +| 13 | | saveScanResult() | Conformity requirements:
Precondition: Successfully call the createInstance() method and return a | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-------------------------|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | valid search engine; Successfully call addChannelScanListener() and the startScan() method.
Test method: Call the saveScanResult() method after the search is complete.
Conformity result: Return true to indicate the success of saving the data, while return false to indicate the failure of saving the data. | +| 14 | | saveServicesInfo(String jsonSIInfo) | Conformity requirements:
Precondition: Successfully call the createInstance() method and return a valid search engine; Successfully call addChannelScanListener() and the startScanExt() method.
Test method: call the saveServicesInfo() method after the search is complete.
Conformity result: Return true to indicate the success of saving the data, while return false to indicate the failure of saving the data. | +| 15 | | REASON_UNKNOWN | Conformity requirements:
Precondition: None.
Test method: The class name directly calls ChannelScanFailureEvent.REASON_UNKNOWN.
Conformity requirements:
Corresponding values are consistent with the standard. | +| 16 | | REASON_TUNE_LOCK_FAILED | Conformity requirements:
Precondition: None.
Test method: The class name directly calls ChannelScanFailureEvent.REASON_TUNE_LOCK_FAILED.
Conformity requirements:
Corresponding values are consistent with the standard. | +| 17 | ChannelScanFailureEvent | REASON_NIT_SEARCH_FAILED | Conformity requirements:
Precondition: None.
Test method: The class name directly calls ChannelScanFailureEvent.REASON_NIT_SEARCH_FAILED.
Conformity requirements:
Corresponding values are consistent with the standard. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 18 | ChannelScanFailureEvent | REASON_BAT_SEARCH_FAILED | Conformity requirements:
Precondition: None.
Test method: The class name directly calls ChannelScanFailureEvent.REASON_BAT_SEARCH_FAILED.
Conformity requirements:
Corresponding values are consistent with the standard. | +| 19 | | REASON_PAT_SEARCH_FAILED | Conformity requirements:
Precondition: None.
Test method: The class name directly calls ChannelScanFailureEvent.REASON_PAT_SEARCH_FAILED.
Conformity requirements:
Corresponding values are consistent with the standard. | +| 20 | | REASON_PMT_SEARCH_FAILED | Conformity requirements:
Precondition: None.
Test method: The class name directly calls ChannelScanFailureEvent.REASON_PMT_SEARCH_FAILED.
Conformity requirements:
Corresponding values are consistent with the standard. | +| 21 | | getReason() | Conformity requirements:
Precondition: Successfully call the createInstance() method and return a valid search engine; Successfully call addChannelScanListener(), and successfully call one of the search methods startScan() or startScanExt().
Test method: Call getReason() when listening to ChannelScanFailureEvent.
Conformity result: The return value is the value taken from the org.ngb.toolkit.channelscan.ChannelScanFailureEvent constant field. | +| 22 | ChannelScanFinishEvent | getServiceCount() | Conformity requirements:
Precondition: Successfully call the createInstance() method and return a valid search engine; Successfully call addChannelScanListener(), and successfully call one of the search methods startScan() or startScanExt().
Test method: Call the | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|----------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 23 | | | getServiceCount() when listening to search completion.
Conformity result: Return value>=0 indicates the number of services. | +| | | getTransportStreamCount() | Conformity requirements:
Precondition: Successfully call the createInstance() method and return a valid search engine; Successfully call addChannelScanListener(), and successfully call one of the search methods startScan() or startScanExt().
Test method: Call getTransportStreamCount() when listening to ChannelScanFinishEvent.
Conformity result: Return value>=0 indicates the number of transport streams. | +| 24 | ChannelScanNITSuccessEvent | getTransportStream() | Conformity requirements:
Precondition: Successfully call the createInstance() method and return a valid search engine; Successfully call addChannelScanListener() and method startScan().
Test method: Call getTransportStream() when listening to ChannelScanNITSuccessEvent.
Conformity result: Return an array of org.ngb.broadcast.dvb.si.TransportStream objects, if the return value is not NULL, it means the frequency point is searched; if the return value is NULL, it means no frequency point is searched. | +| 25 | ChannelScanSuccessEvent | getResult() | Conformity requirements:
Precondition: Successfully call the createInstance() method and return a valid search engine; Successfully call addChannelScanListener() and method startScan().
Test method: Call getResult() when listening to the ChannelScanSuccessEvent.
Conformity result: Return an array of org.ngb.broadcast.dvb.si.SIService objects, if the return value is not NULL, it means the channel is searched; if the return value is NULL, it means no channel is searched. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 26 | ProgramEvent | getTitle() | Conformity requirement:
Precondition: The ProgramEvent object is correctly obtained.
Test method: Call the getTitle() method with no input parameters.
Conformity result: The method call succeeds and returns a String object indicating the programme's name. | +| 27 | | getShortDescription() | Conformity requirement 1:
Precondition: The ProgramEvent object is correctly obtained.
Test method: Call the getShortDescription() method with no input parameters.
Conformity result: The method call succeeds and returns a String object indicating the programme's short description. | +| 28 | | getBeginDate() | Conformity requirement:
Precondition: The ProgramEvent object is correctly obtained.
Test method: Call the getBeginDate() method with no input parameters.
Conformity result: The method call succeeds and returns a Date object indicating the programme's beginning time. | +| 29 | | getDuration() | Conformity requirement:
Precondition: The ProgramEvent object has been correctly obtained.
Test method: Call the getDuration() method with no input parameters.
Conformity result: The method call succeeds and returns a long type value indicating the programme's duration. | +| 30 | | getEndDate() | Conformity requirement:
Precondition: The ProgramEvent object is correctly obtained.
Test method: Call the getEndDate() method with no input parameters.
Conformity result: The method call succeeds and returns a Date object indicating the end time of the program. | +| 31 | | getLanguageCode() | Conformity requirement:
Precondition: The ProgramEvent object is correctly obtained.
Test method: Call the getLanguageCode() method with no | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | input parameters.
Conformity result: A successful method call returns a String object section indicating the programme's language code. | +| 32 | | getNibbles() | Conformity requirement:
Precondition: The ProgramEvent object is correctly obtained.
Test method: Call the getNibbles() method with no input parameters.
Conformity result: The method call succeeds and returns a byte array indicating the programme's classification information. | +| 33 | | getCALockMode() | Conformity requirement 1:
Precondition: The ProgramEvent object is correctly obtained.
Test method: Call the getCALockMode() method, the programme is an authorized program.
Conformity result: The method call succeeds and returns true.
Conformity requirement 2:
Precondition: The ProgramEvent object is correctly obtained.
Test method: Call the getCALockMode() method, the programme is an unauthorized program.
Conformity result: The method call succeeds and returned false. | +| 34 | | getDvbLocator() | Conformity requirement:
Precondition: The ProgramEvent object is correctly obtained.
Test method: Call the getDvbLocator() method with no input parameters.
Conformity result: The method call succeeds and returns a DvbNetworkBoundLocator object indicating the locator of the programme event. | +| 35 | | getProgramService() | Conformity requirement:
Precondition: The ProgramEvent object is correctly obtained.
Test method: Call the getProgramService() method with no input parameters.
Conformity result: The method call succeeds and returns a | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|--------------------|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | ProgramService object indicating the programme service object to which the programme event belongs. | +| 36 | ProgramEventFilter | accept(ProgramEvent programEvent) | Conformity requirement:
Precondition: The ProgramEvent object is correctly obtained.
Test method: Call the accept() method and input a programEvent that meets the filtering criteria.
Conformity result: The method call succeeds and returns true. | +| 37 | ProgramService | SERVICE_TYPE_RESERVED | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 0. | +| 38 | | SERVICE_TYPE_DIGITAL_TELEVISION | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 1. | +| 39 | | SERVICE_TYPE_DIGITAL_RADIO_SOUND | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 2. | +| 40 | | SERVICE_TYPE_TELETEXT | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 3. | +| 41 | | SERVICE_TYPE_NVOD_REFERENCE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 4. | +| 42 | | SERVICE_TYPE_NVOD_TIME_SHIFTED | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 5. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| 43 | | SERVICE_TYPE_MOSAI
C | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 6. | +| 44 | | SERVICE_TYPE_PAL | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 7. | +| 45 | | SERVICE_TYPE_SECAM | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 8. | +| 46 | | SERVICE_TYPE_D_D2_
MAC | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 9. | +| 47 | | SERVICE_TYPE_FM_RA
DIO | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 10. | +| 48 | | SERVICE_TYPE_NTSC | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 11. | +| 49 | | SERVICE_TYPE_DATA_
BROADCAST | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 12. | +| 50 | | SERVICE_TYPE_RESER
VED_FOR_CI | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 13. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 51 | | SERVICE_TYPE_RCS_M
AP | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 14. | +| 52 | | SERVICE_TYPE_RCS_FL
S | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 15. | +| 53 | | SERVICE_TYPE_DVB_M
HP | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 15. | +| 54 | | getDvbLocator() | Conformity requirement 1:
Precondition: The ProgramService object is correctly obtained.
Test method: Call the getDvbLocator() method with no input parameters.
Conformity result: The method call succeeds and returns a DvbNetworkBoundLocator object indicating the service locator. | +| 55 | | getNetworkID() | Conformity requirement:
Precondition: The ProgramService object is correctly obtained.
Test method: Call the getNetworkID() method with no input parameters.
Conformity result: The method call succeeds and returns an object of type int indicating the network ID of the network to which the service object belongs. | +| 56 | | getServiceName() | Conformity requirement:
Precondition: The ProgramService object is correctly obtained.
Test method: Call the getServiceName() method with no input parameters.
Conformity result: The method call succeeds and returns a String object indicating the name of the service. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 57 | | getServiceLogicNumber() | Conformity requirement:
Precondition: The ProgramService object is correctly obtained.
Test method: Call the getServiceLogicNumber() method with no input parameters.
Conformity result: The method call succeeds and returns an object of type int indicating the service logic number. | +| 58 | | getServiceType() | Conformity requirement:
Precondition: The ProgramService object is correctly obtained.
Test method: Call the getServiceType() method with no input parameters.
Conformity result: The method call succeeds and returns an object of type int indicating the type of service. | +| 59 | | getCAFreeMode() | Conformity requirement:
Precondition: The ProgramService object is correctly obtained.
Test method: Call the getCAFreeMode() method with no input parameters.
Conformity result: The method call succeeds and returns true (scrambled)/false (not scrambled). | +| 60 | | getPresentProgramEvent() | Conformity requirement:
Precondition: The ProgramService object is correctly obtained.
Test method: Call the getPresentProgramEvent() method with no input parameters.
Conformity result: The method call succeeds and returns a ProgramEvent object indicating the current programme information. | +| 61 | | getFollowingProgramEvent() | Conformity requirement:
Precondition: The ProgramService object is correctly obtained.
Test method: Call the getFollowingProgramEvent() method with no input parameters.
Conformity result: The method call succeeds and returns a ProgramEvent object indicating the subsequent programme information. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|----------------------|----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 62 | | getProgramEvents(Program EventFilter filter) |
Conformity requirement 1:
Precondition: The ProgramService object is correctly obtained.
Test method: Call the getProgramEvents() method and input valid parameters.
Conformity result: The method call succeeds and returns the ProgramEvent array object indicating the programme information of the filter.
Conformity requirement 2:
Precondition: The ProgramService object is correctly obtained.
Test method: Call the getProgramEvents() method and input invalid parameters.
Conformity result: The method call succeeds and returns null.
Conformity requirement:
Precondition: The ProgramService object is correctly obtained.
Test method: Call the getEPGManager() method with no input parameters.
Conformity result: The method call succeeds and returns an EPGManager object indicating the EPGManager instance to which this programme service object belongs.
Conformity requirement 1:
Precondition: The interface is implemented by the application, and the application has implemented filtering behavior.
Test method: Call the accept() method and input parameters that meet the filtering criteria.
Conformity result: The method call succeeds and returns true.
Conformity requirement 2:
Precondition: The interface is implemented by the application, and the application has implemented filtering behavior.
Test method: Call the accept() method and input parameters that do not meet the filtering criteria.
Conformity result: The method call succeeds and returns false.
Conformity requirement:
Precondition: The interface is implemented by the application and an event listener has been correctly added.
Test method: When there is an EPG information event update, call the onUpdate() method and input valid parameters.
Conformity result: The method call succeeds, and the exact logic is controlled by the application.
Conformity requirement:
Precondition: Received EPG information from the flow.
Test method: Call the getEPGManager() method with no input parameters.
Conformity result: The method call succeeds and returns an array of EPGManager objects indicating the EPG manager.
Conformity requirement:
Precondition: The EPGManager instance has been correctly obtained.
Test method: Call the getNetworkIDs() method with no input parameters.
Conformity result: The method call succeeds and returns an array of type Integer indicating the broadcast network identifier corresponding to the EPG manager instance.
Conformity requirement 1:
Precondition: The EPGManager instance has been correctly obtained.
Test method: Call the getNetworkName() method and input valid parameters.
Conformity result: The method call succeeds and returns a String object indicating the name of the broadcast network to which the EPG manager instance corresponds.
Conformity requirement 2:
Precondition: The EPGManager instance has been correctly obtained.
Test method: Call the getNetworkName() method and input invalid parameters.
Conformity result: The method call succeeds and returns NULL.
Conformity requirement 1:
Precondition: The EPGManager instance has been correctly obtained.
Test method: Call the addUpdateListener() method and input valid parameters.
Conformity result: The method call succeeds, and adds this event listener.
Conformity requirement 2:
Precondition: The EPGManager instance has been correctly obtained.
Test method: the method call succeeds without adding this event listener.
Conformity requirement:
Precondition: The EPGManager instance has been correctly obtained.
Test method: Call the removeUpdateListener() method and input valid parameters.
Conformity result: The method call succeeds, and removes the event listener.
Conformity requirement 1:
Precondition: The EPGManager instance has been correctly obtained.
Test method: Call the getService() method and input valid parameters.
Conformity result: The method call succeeds and returns the ProgramService object indicating the object that matches the conditions of the input parameters.
Conformity requirement 2:
Precondition: The EPGManager instance has been correctly obtained.
Test method: Call the getService() method and input invalid parameters.
Conformity result: The method call fails, throwing an InvalidParameterException.
Conformity requirement 1:
Precondition: The EPGManager instance has been correctly obtained.
Test method: Call the getServices() method and input valid parameters.
Conformity result: The method call succeeds and returns the ProgramService array object indicating the programme object that
matches the input parameter condition.
Conformity requirement 2:
Precondition: The EPGManager instance has been correctly obtained.
Test method: Call the getServices() method and input invalid parameters.
Conformity result: The method call fails, throwing an IllegalArgumentException.
Conformity requirement 1:
Precondition: The EPGManager instance has been correctly obtained.
Test method: Call the getPresentFollowingEvent() method and input valid parameters.
Conformity result: The method call succeeds and returns the ProgramService object indicating the programme information service object that matches the conditions.
Conformity requirement 2:
Precondition: The EPGManager instance has been correctly obtained.
Test method: Call the getPresentFollowingEvent() method and input invalid parameters.
Conformity result: The method call fails, throwing an IllegalArgumentException.
Conformity requirement 1:
Precondition: The EPGManager instance has been correctly obtained.
Test method: Call the getProgramService() method and input valid parameters.
Conformity result: The method call succeeds and returns a ProgramService object indicating programme information service object that matches the conditions.
Conformity requirement 2:
Precondition: The EPGManager instance has been correctly obtained.
Test method: Call the getProgramService() method and input invalid parameters.
Conformity result: The method call fails, throwing an IllegalArgumentException or InvalidPeriodException exception.
Conformity requirement 1:
Precondition: The EPGManager instance has been correctly obtained.
Test method: Call the getProgramServices() method and input valid parameters.
Conformity result: The method call succeeds and returns the ProgramService array object indicating the service object that matches the conditions.
Conformity requirement 2:
Precondition: The EPGManager instance has been correctly obtained.
Test method: Call the getProgramServices() method and input invalid parameters.
Conformity result: The method call fails, throwing an InvalidPeriodException.
Conformity requirement:
Precondition: The EPGUpdateEvent object has been correctly obtained.
Test method: Call the getResult() method with no input parameters.
Conformity result: The method call succeeds and returns the updated programme information service object.
Conformity requirement:
Precondition: None.
Test method: Call the EPGUpdateEvent() method with no input parameters.
Conformity result: The method call succeeds, creating an EPGUpdateEvent object.
Conformity requirement:
Precondition: SearchManager engine is initialized successfully, AutoCompleteSearchFiler object is instantiated, call getAutoCompleteSearchSession() to get AutoCompleteSearchSession object and call startSearch().
Test method: Call onAutoCompleteSearchStart().
Conformity result: Search engines pass a message to the application to start searching.
Conformity requirement:
Precondition: The SearchManager engine is successfully initialized, the AutoCompleteSearchFiler object is instantiated, getAutoCompleteSearchSession() is called to get the AutoCompleteSearchSession object, and startSearch() is called, and startSearch() and stopSearch() have been called.
Test method: Call onAutoCompleteSearchStop().
Conformity result: Search engines pass a message to the application to stop searching.
Conformity requirement 1:
Precondition: The SearchManager engine is successfully initialized, the AutoCompleteSearchFiler object is instantiated, getAutoCompleteSearchSession() is called to get the AutoCompleteSearchSession object, startSearch() is called, and startSearch() and stopSearch() have been called.
Test method: Call onAutoCompleteSearchDestroy().
Conformity result: The search engine passes a message to the application to destroy the search.
Conformity requirement 1:
Precondition: SearchManager engine initialization is successful, AutoCompleteSearchFiler object is instantiated, call getAutoCompleteSearchSession () to get AutoCompleteSearchSession object.
Test method: Call onAutoCompleteSearchError().
Conformity result: Search engines pass error messages to applications.
Conformity requirement:
Precondition: The searchManager engine is initialized successfully, the AutoCompleteSearchFiler object is instantiated, getAutoCompleteSearchSession() is called to get the AutoCompleteSearchSession object,
Test method: Call getSource().
Conformity result: Get the matching data sources. | +| | | getString() | Conformity requirement 1:
Precondition: The SearchManager engine is initialized successfully. After the AutoCompleteSearchFiler object is instantiated, call getAutoCompleteSearchSession() to get the AutoCompleteSearchSession object, and call startSearch(). The calls to startSearch(), stopSearch(), and dispose() has already been called.
Test method: Call the getString() method.
Conformity result: Get a string that matches the keyword provided by the user. | +| 84 | AutoCompleteSearchSession | startSearch() | Conformity requirement 1:
Precondition: SearchManager engine initialization is successful, AutoCompleteSearchFiler object is instantiated, call getAutoCompleteSearchSession(). AutoCompleteSearchSession object is instantiated.
Test method: Call the startSearch() method.
Conformity result: Start matching operation.
Conformity requirement 2:
Precondition: SearchManager engine is initialized successfully, AutoCompleteSearchFiler object is instantiated, call getAutoCompleteSearchSession(). AutoCompleteSearchSession object is instantiated.
Test method: Call the startSearch() method and input an illegal parameter of getAutoCompleteSearchSession().
Conformity result: The start session operation failed with an exception.
Conformity requirement 3:
Precondition: SearchManager engine initialization is successful, AutoCompleteSearchFiler object is | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|----------------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
instantiated, call getAutoCompleteSearchSession(). AutoCompleteSearchSession object is instantiated.
Test method: Call the startSearch() method and input an illegal parameter to startSearch().
Conformity result: The start session operation fails and throws an exception.
| +| 85 | |stopSearch() | Conformity requirement 1:
Precondition: SearchManager engine initialization is successful, AutoCompleteSearchFiler object is instantiated, call getAutoCompleteSearchSession(). AutoCompleteSearchSession object is instantiated.
Test method: Call the stopSearch() method.
Conformity result: Terminate this search.
Conformity requirement 2:
Precondition: SearchManager engine is initialized successfully, AutoCompleteSearchFiler object is instantiated, call getAutoCompleteSearchSession(). AutoCompleteSearchSession object is instantiated.
Test method: Call the stopSearch() method, StartSearch() was not called.
Conformity result: Stopping this search fails and throws an exception.
| +| 86 |AutoCompleteSearchSession | dispose() | Conformity requirement 1:
Precondition: SearchManager engine initialization is successful, AutoCompleteSearchFiler object is instantiated, getAutoCompleteSearchSession() is called, AutoCompleteSearchSession object is instantiated, and the calls startSearch() and stopSearch().
Test method: Call the dispose() method.
Conformity result: Dispose the closed searches.
Conformity requirement 2:
Precondition: SearchManager engine initialization is successful, AutoCompleteSearchFiler object is
getAutoCompleteSearchSession() is called and
AutoCompleteSearchSession object is instantiated.
Test method: Call the dispose() method, without calling startSearch() before.
Conformity result: Disposing fails and throws an exception. | +| | | getSearchResultList() | Conformity requirement 1:
Precondition: SearchManager engine is instantiated successfully,
AutoCompleteSearchFiler object is instantiated,
getAutoCompleteSearchSession() is called, the
AutoCompleteSearchSession object is instantiated, startSearch(),
stopSearch(), dispose() are called, and the listener receives a success status.
Test method: Call the getSearchResultList() method.
Conformity result: The call to the getSearchResultList() method succeeds and returns the AutoCompleteSearchResultList object.
Conformity requirement 2:
Precondition: SearchManager engine initialization is successful,
AutoCompleteSearchFiler object is instantiated, call
getAutoCompleteSearchSession(),
AutoCompleteSearchSession object is instantiated, call startSearch(),
stopSearch(), dispose().
Test method: When
AutoCompleteSearchListen does not hear the completed state, call the
getSearchResultList() method.
Conformity result: The call to the getSearchResultList() method fails and throws an exception. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|----------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 88 | GlobalSearchListener | onGlobalSearchStart() | Conformity requirement:
Precondition: The SearchManager engine is initialized successfully. the GlobalSearchFilter object is instantiated, Call getGlobalSearchSession() to get the GlobalSearchSession object successfully.
Test method: Call the onGlobalSearchStart() method.
Conformity result: Search engines transmit start search information to the application. | +| 89 | | onGlobalSearchStop() | Conformity requirement:
Precondition: The SearchManager engine is initialized successfully. the GlobalSearchFilter object is instantiated, call getGlobalSearchSession() to get the GlobalSearchSession object successfully, startSearch() and stopSearch() are called.
Test method: Call the onGlobalSearchStop() method.
Conformity result: Search engines transmit stop search information to applications. | +| 90 | | onGlobalSearchDestroy() | Conformity requirement 1:
Precondition: SearchManager engine initialization is successful, GlobalSearchFilter object is instantiated, call getGlobalSearchSession() to get the GlobalSearchSession object successfully, and startSearch(), stopSearch(), and dispose Search() are called.
Test method: Call the onGlobalSearchDestroy() method.
Conformity result: Search engines transmit destroy search information to applications. | +| 91 | | onGlobalSearchError() | Conformity requirement 1:
Precondition: SearchManager engine initialization is successful, GlobalSearchFilter object is instantiated and getGlobalSearchSession() is called to get the GlobalSearchSession object successfully, and called startSearch() | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 92 | GlobalSearchListener | | method.
Test method: Call the onGlobalSearchError() method.
Conformity result: Search engines transmit error information to applications. | +| | | onGlobalSearchRetrieval() | Conformity requirement 1:
Precondition: The searchManager engine is initialized successfully, the GlobalSearchFilter object is instantiated, and getGlobalSearchSession() is called to get the GlobalSearchSession object successfully, and startSearch(), stopSearch(), dispose() are called.
Test method: Call the onGlobalSearchRetrieval () method.
Conformity result: Search engines transmit search success information to applications. | +| 93 | GlobalSearchResultItem | getContent() | Conformity requirement 1:
Precondition: SearchManager engine initialization is successful, GlobalSearchFilter object is instantiated, call getGlobalSearchSession() to get the GlobalSearchSession object successfully, startSearch() and stopSearch() are called, and the listener listens to the completion of the search.
Test method: Call the getContent() method.
Conformity result: Associate this search result with other objects. | +| 94 | GlobalSearchSession | DEFAULT_PAGE_SIZE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 6. | +| 95 | | startSearch() | Conformity requirement 1:
Precondition: The SearchManager engine is initialized successfully. After the GlobalSearchFilter object is instantiated, call getGlobalSearchSession() to get GlobalSearchSession object.
Test method: Call the startSearch() method. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | GlobalSearchSession | |
Conformity result:
GlobalSearchSession starts launching searches.
Conformity requirement 2:
Precondition: The SearchManager engine is initialized successfully. After the GlobalSearchFilter object is instantiated, call getGlobalSearchSession() to get GlobalSearchSession object.
Test method: The parameter in getGlobalSearchSession() is illegal, call the startSearch() method.
Conformity result: The startup operation fails and throws an exception.
Conformity requirement 1:
Precondition: The SearchManager engine is initialized successfully. After the GlobalSearchFilter object is instantiated, call getGlobalSearchSession() to get GlobalSearchSession object and call startSearch().
Test method: Call the stopSearch() method.
Conformity result:
GlobalSearchSession starts to stop this search.
Conformity requirement 2:
Precondition: The SearchManager engine is initialized successfully. After the GlobalSearchFilter object is instantiated, call getGlobalSearchSession() to get GlobalSearchSession object.
Test method: No startSearch() is called, the stopSearch() method is called.
Conformity result: Stop operation fails, throws exception.
Conformity requirement 1:
Precondition: The SearchManager engine is initialized successfully. After the GlobalSearchFilter object is instantiated, call getGlobalSearchSession() to get GlobalSearchSession object, and call startSearch() and stopSearch().
Test method: Call the dispose() method.
Conformity result: Dispose useless GlobalSearchSession.
Conformity requirement 2:
Precondition: The SearchManager engine is initialized successfully. After the GlobalSearchFilter object is instantiated, call getGlobalSearchSession() to get GlobalSearchSession object.
Test method: The startSearch() method is not called, but the dispose() method is called.
Conformity result: The disposing operation fails and throws a exception.
Conformity requirement 1:
Precondition: The SearchManager engine is initialized successfully. After the GlobalSearchFilter object is instantiated, call getGlobalSearchSession() to get GlobalSearchSession object, and call startSearch(), stopSearch().
Test method: Call the getPageSize() method.
Conformity result: Get the number of entries per page.
Conformity requirement 1:
Precondition: The SearchManager engine is initialized successfully. After the GlobalSearchFilter object is instantiated, call getGlobalSearchSession() to get GlobalSearchSession object, and call startSearch(), stopSearch(), the listener listens to a successful search event.
Test method: Call the getResultCount() method.
Conformity result: Obtain the number of search results.
Conformity requirement 2:
Precondition: The SearchManager engine is initialized successfully. After the GlobalSearchFilter object is instantiated, call getGlobalSearchSession() to get GlobalSearchSession object.
Test method: Test: startSearch() is not called or completed status is not received, the getResultCount()
Conformity result: Throw an exception. | +| | | getSearchResultList() | Conformity requirement 1:
Precondition: The SearchManager engine is initialized successfully. After the GlobalSearchFilter object is instantiated, call getGlobalSearchSession() to get GlobalSearchSession object, and call startSearch() and stopSearch(), the listener receives a successful message.
Test method: Call the getSearchResultList() method.
Conformity results: Get the search result object.
Conformity requirement 2:
Precondition: The SearchManager engine is initialized successfully. After the GlobalSearchFilter object is instantiated, call getGlobalSearchSession() to get GlobalSearchSession object.
Test method: Test: startSearch() is not called or completed status is not received, the getResultCount() method is called. Call the getSearchResultList() method.
Conformity result: Throw an exception. | +| 101 | | retrievePage() | Conformity requirement 1:
Precondition: The SearchManager engine is initialized successfully. After the GlobalSearchFilter object is instantiated, call getGlobalSearchSession() to get GlobalSearchSession object. Call startSearch(), stopSearch(), and listen to the status of a successful search.
Test method: Call the retrievePage() method.
Conformity result: Initialize the current page, previous page, and next page of data.
Conformity requirement 2:
Precondition: The SearchManager engine is initialized successfully. After the GlobalSearchFilter object is instantiated, call | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
getGlobalSearchSession() to get GlobalSearchSession object.
Test method: StartSearch() is not called or a successful search status is not listened. Call the retrievePage() method.
Conformity result: Throw an exception.
| +| 102 | | saveRecentSearchQuery() |Conformity requirement:
Precondition: The SearchManager engine is initialized successfully. After the GlobalSearchFilter object is instantiated, call getGlobalSearchSession() to get GlobalSearchSession object. Call startSearch() which returns the search success status and is called before dispose().
Test method: Call the saveRecentSearchQuery() method.
Conformity result: Temporarily store the current matching result.
| +| 103 | | setPageSize() |Conformity requirement 1:
Precondition: The SearchManager engine is initialized successfully. After the GlobalSearchFilter object is instantiated, call getGlobalSearchSession() to get GlobalSearchSession object. Call startSearch(), which returns the search success status and is called before dispose().
Test method: Call the setPageSize() method.
Conformity result: Set the size of items displayed per page.
Conformity requirement 2:
Precondition: The SearchManager engine is initialized successfully. After the GlobalSearchFilter object is instantiated, call getGlobalSearchSession() to get GlobalSearchSession object, call StartSearch(), and return the search success status.
Test method: Set the size to be less than 0 or greater than the system's maximum value, and call the setPageSize() method.
Conformity result: Throw an exception.
| +| 104 | | | Conformity requirements: | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | SearchHistoryItem | getContentType() | Precondition: SearchManager engine initialization succeeds, search session returns results.Test method: Call the getContentType() method.
Conformity result: Get the search type for the search. | +| 105 | | getCriteriaFlags() | Conformity requirements:
Precondition: SearchManager engine initialization succeeds, search session returns results.
Test method: Call the getCriteriaFlags() method.
Conformity result: Get the indicator for the search. | +| 106 | | getSearchField() | Conformity requirements:
Precondition: SearchManager engine initialization succeeds, search session returns results.
Test method: Call the getSearchField() method.
Conformity result: Get the search field for the search. | +| 107 | | getSearchString() | Conformity requirements:
Precondition: SearchManager engine initialization succeeds, search session returns results.
Test method: Call the getSearchString() method.
Conformity result: Get the matching string for the search. | +| 108 | | getSortCriteria() | Conformity requirements:
Precondition: SearchManager engine initialization succeeds, search session returns results.
Test method: Call the getSortCriteria() method.
Conformity result: Get the sorting information of the search. | +| 109 | SearchHistoryItem | getSources() | Conformity requirements:
Precondition: SearchManager engine initialization succeeds, search session returns results.
Test method: Call the getSources() method.
Conformity result: Get the source information of the search. | +| 110 | | ALL | Conformity requirements:
Precondition: None. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|--------------------------|------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 111 | SourceType | | Test method: Determine the constant value.
Conformity result: The constant value is 0. | +| | | BROADCAST | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 1. | +| 112 | | RECORDED | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 2. | +| 113 | AutoCompleteSearchFilter | DEFAULT_MAX_AUTO_COMPLETE_SEARCH_RESULTS | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 10. | +| 114 | | getAutoCompleteSearchFilter() | Conformity requirements:
Precondition: SearchManager engine initialization succeeds.
Test method: Call the getAutoCompleteSearchFilter() method.
Conformity result: Return AutoCompleteSearchFilter object. | +| 115 | | getMaxResults() | Conformity requirements:
Precondition: The SearchManager engine has been successfully initialized, the AutoCompleteSearchFilter object has been instantiated, and setMaxResults() has been called before.
Test method: Call the getMaxResults() method.
Conformity result: Return the maximum value of the search result to be matched. | +| 116 | | getSearchField() | Conformity requirements:
Precondition: The SearchManager engine has been successfully initialized, the AutoCompleteSearchFilter object has been instantiated, and | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|--------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | AutoCompleteSearchFilter | | setSearchField() has been called before.
Test method: Call the setSearchField() method.
Conformity result: Return the fields that need to be matched for the match search. | +| 117 | | getSearchLanguage() | Conformity requirements:
Precondition: The SearchManager engine has been successfully initialized, the AutoCompleteSearchFilter object has been instantiated, and setSearchLanguage() has been called before.
Test method: Call the getSearchLanguage() method.
Conformity result: Return the language type that matches the search text information. | +| 118 | | getSource() | Conformity requirements:
Precondition: The SearchManager engine has been successfully initialized, the AutoCompleteSearchFilter object has been instantiated, and setSource() has been called before.
Test method: Call the getSource() method.
Conformity result: Return the search data source that matches the search. | +| 119 | | getTimeLimit() | Conformity requirements:
Precondition: The SearchManager engine has been successfully initialized, the AutoCompleteSearchFilter object has been instantiated, and setTimeLimit() has been called before.
Test method: Call the getTimeLimit() method.
Conformity result: Return the time limit for matching search timeout. | +| 120 | | setMaxResults() | Conformity requirement:
Precondition: ASearchManager engine has been successfully instantiated, AutoCompleteSearchFilter object has been instantiated.
Test method: Call the setMaxResults() method. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|--------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | AutoCompleteSearchFilter | |
Conformity result: Return the maximum number of results that can be returned from a match search.
Conformity requirement 2:
Precondition: The SearchManager engine has been successfully initialized and the AutoCompleteSearchFilter object has been instantiated.
Test method: If the set value is less than or equal to 0 or exceeds the maximum value supported by the system, call the setMaxResults() method.
Conformity result: Throw an exception.
Conformity requirement 1:
Precondition: The SearchManager engine has been successfully initialized and the AutoCompleteSearchFilter object has been instantiated.
Test method: Call the setSearchField() method.
Conformity results: Set up three searchable types, as title or keyword or profile.
Conformity requirement 2:
Precondition: The SearchManager engine has been successfully initialized and the AutoCompleteSearchFilter object has been instantiated.
Test method: Set non-title or keyword or introduction to one of three searchable types, and call the setSearchField() method.
Conformity result: Return an exception.
Conformity requirement 1:
Precondition: The SearchManager engine has been successfully initialized and the AutoCompleteSearchFilter object has been instantiated.
Test method: Call the setSearchLanguage() method.
Conformity result: Set the language type of the search text.
Conformity requirement 2:
Precondition: The SearchManager
engine has been successfully initialized and the AutoCompleteSearchFilter object has been instantiated.
Test method: If the input parameter iso639code does not comply with [ISO 639], call the setSearchLanguage() method.
Conformity result: Throw an exception.
| +| 123 | | setSource() |Conformity requirement 1:
Precondition: The SearchManager engine has been successfully initialized and the AutoCompleteSearchFilter object has been instantiated.
Test method: Call the setSource() method.
Conformity result: Set the search data source for matching searches.
Conformity requirement 2:
Precondition: The SearchManager engine has been successfully initialized and the AutoCompleteSearchFilter object has been instantiated.
Test method: If the matching search data source is not within the type defined by sourceType, call the setSource() method.
Conformity result: Throw an exception.
Conformity requirement 1:
Precondition: The SearchManager engine has been successfully initialized and the AutoCompleteSearchFilter object has been instantiated.
Test method: Call the setTimeout() method.
Conformity result: Set the matching search timeout.
Conformity requirement 2:
Precondition: SearchManager engine is initialized successfully, and AutoCompleteSearchFilter object has been instantiated.
Test method: Set the time to be less than 0 or exceed the maximum value supported by the system, and call the setTimeout() method.
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 50. | +| 126 | | getGlobalSearchFilter() | Conformity requirements:
Precondition: SearchManager engine is initialized successfully.
Test method: Call the getGlobalSearchFilter() method.
Conformity result: Return the object instantiated by GlobalSearchFilter. | +| 127 | | getContentNibble() | Conformity requirements:
Precondition: SearchManager engine is initialized successfully, and GlobalSearchFilter object has been instantiated.
Test method: Call the getContentNibble() method.
Conformity result: Return the category of the programme to be filtered. | +| 128 | | getContentType() | Conformity requirements:
Precondition: SearchManager engine is initialized successfully, and GlobalSearchFilter object has been instantiated.
Test method: Call the getContentType() method.
Conformity result: Return the programme type of the programme to be filtered. | +| 129 | | getCriteriaFlags() | Conformity requirements:
Precondition: SearchManager engine is initialized successfully, and GlobalSearchFilter object has been instantiated.
Test method: Call the getCriteriaFlags() method.
Conformity result: Return the flag of the searched filter condition. | +| 130 | | getMaxResults() | Conformity requirements
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated and setMaxResults() has | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|--------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | GlobalSearchFilter | | been called previously.
Test method: Call the getMaxResults() method.
Conformity result: Get the maximum search value returned by the global search. | +| 131 | | getSearchField() | Conformity requirements:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated and setSearchField() has been called previously.
Test method: Call the getSearchField() method.
Conformity result: Get the fields that need to be searched for in the global search. | +| 132 | | getSearchLanguage() | Conformity requirements:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated and setSearchLanguage()has been called previously.
Test method: Call the getSearchLanguage() method.
Conformity result: Get the language category of global search text information. | +| 133 | | getSource() | Conformity requirements:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated and setSource()has been called previously.
Test method: Call the getSource() method.
Conformity result: Get the data source for the global search. | +| 134 | | getThreshold() | Conformity requirements:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated and setThreshold()has been called previously.
Test method: Call the getThreshold() method.
Conformity result: Get the threshold for global search results. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 135 | | getTimeLimit() |
Conformity requirements:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated and setTimeLimit()has been called previously.
Test method: Call the getTimeLimit() method.
Conformity result: Get the time limit for the global search.
Conformity requirement 1:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated.
Test method: Call the setContentNibble() method.
Conformity result: Set the category of the global search for programs to be filtered.
Conformity requirement 2:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated.
Test method: Call the setContentNibble() method.
Conformity result: Throw an exception.
Conformity requirement 1:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated.
Test method: Call the setContentType() method.
Conformity result: Set the type of the global search for programs to be filtered.
Conformity requirement 2:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated.
Test method: The set parameter is not in the defined content type, call the setContentType() method.
Conformity result: Throw an exception.
Conformity requirement 1:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated.
Test method: Call the setCriteriaFlags() method.
Conformity result: Set the flag of the global search criteria.
Conformity requirement 2:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated.
Test method: The set parameter is not in the defined content type, call the setCriteriaFlags() method.
Conformity result: Throw an exception.
Conformity requirement 1:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated.
Test method: Call the setMaxResults() method.
Conformity result: Set the maximum value of the search returned by the global search.
Conformity requirement 2:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated.
Test method: The set parameter is less than 0 or exceeds the maximum value specified by the system, call the setMaxResults() method.
Conformity result: Throw an exception.
Conformity requirement 1:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated.
Test method: Call the setSearchField() method.
Conformity result: Set the search field for the global search.
Conformity requirement 2:
| + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated.
Test method: Set non-title or keyword or introduction to one of three searchable types, and call the setSearchField() method.
Conformity result: Throw an exception.
| +| 141 | | setSearchLanguage() |Conformity requirement 1:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated.
Test method: Call the setSearchLanguage() method.
Conformity result: Set the language category for global search text messages.
Conformity requirement 2:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated.
Test method: If the input parameter iso639code does not comply with [ISO 639], call the setSearchLanguage() method.
Conformity result: Throw an exception.
| +| 142 | | setSource() |Conformity requirement 1:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated.
Test method: Call the setSource() method.
Conformity result: Set the search data source for matching searches.
Conformity requirement 2:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated.
Test method: If the set parameter is not in the value specified by the data source., call the setSource() method.
Conformity result: Throw an exception.
| + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 143 | | setThreshold() |Conformity requirement 1:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated.
Test method: Call the setThreshold() method.
Conformity result: Set the threshold for global search.
Conformity requirement 2:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated.
Test method: If the set value is less than 0, call the setThreshold() method.
Conformity result: Throw an exception.
Conformity requirement 1:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated.
Test method: Call the setTimeLimit() method.
Conformity result: Set the maximum time limit of the search returned by the global search.
Conformity requirement 2:
Precondition: SearchManager engine is initialized successfully, the GlobalSearchFilter object has been instantiated.
Test method: The set value is less than 0 or exceeds the range of the system maximum value, call the setTimeLimit() method.
Conformity result: Throw an exception.
Conformity requirements:
Preconditions: None.
Test method: Call the getInstance() method.
Conformity result: Return an instance of SearchManager.
Conformity requirement 1:
Precondition: Instantiate the object of the SearchManager class.
Test method: Call the
Conformity result: Return AutoCompleteSearchSession object.
Conformity requirement 2:
Precondition: Instantiate the object of the SearchManager class.
Test method: Call the getAutoCompleteSearchSession() method with illegal input parameters.
Conformity result: Throw an exception. | +| 147 | | getGlobalSearchSession() | Conformity requirement 1:
Precondition: Instantiate the object of the SearchManager class.
Test method: Call the getGlobalSearchSession() method.
Conformity result: Return GlobalSearchSession object.
Conformity requirement 2:
Precondition: Instantiate the object of the SearchManager class.
Test method: Call the getGlobalSearchSession() method with illegal input parameters.
Conformity result: Throw an exception. | +| 148 | | getSearchHistory() | Conformity requirement 1:
Precondition: Before instantiating the SearchManager class object, there are sessions that successfully return search results.
Test method: Call the getSearchHistory() method.
Conformity result: Return the getSearchHistoryList object.
Conformity requirement 2:
Precondition: Instantiate the object of the SearchManager class.
Test method: StartSearch() has not been called before.
getSearchHistory() method is called.
Conformity result: Searching the history list returns a failure, and throws an exception. | +| 149 | | clearHistory() | Conformity requirement 1:
Precondition: Before instantiating the SearchManager class object, there are sessions that successfully return search results. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Test method: Call the clearHistory() method.
Conformity result: Clear search history.
Conformity requirement 2:
Precondition: Instantiate the object of the SearchManager class.
Test method: StartSearch() has not been called before.
getSearchHistory() method is called.
Conformity result: Throw an exception. | +| 150 | SortCriteria | SORT_ORDER_NONE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 0. | +| 151 | | SORT_ORDER_ASCENDING | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 1. | +| 152 | | SORT_ORDER_DESCENDING | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 2. | +| 153 | | SORT_TYPE_NONE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 0. | +| 154 | | SORT_TYPE_TITLE | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 1. | +| 155 | | SORT_TYPE_START_TIME | Conformity requirements:
Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 2. | +| 156 | | SORT_TYPE_CONTENT_NIBBLE | Conformity requirements: | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | SortCriteria | | Precondition: None.
Test method: Determine the constant value.
Conformity result: The constant value is 15. | +| 157 | | SortCriteria() | Conformity requirements:
Precondition: Instantiate SearchManager class object, the application needs a way to view the search results, there exists a list object of the search results.
Test method: Call the SortCriteria() method.
Conformity result: Create an object with sorting criteria. | +| 158 | | getOrder() | Conformity requirements:
Precondition: Instantiate Instantiate the SearchManager class object, the application needs a way to view the search results, there exists a list object of the search results, and setOrder() has been called before.
Test method: Call the getOrder() method.
Conformity result: Get the alignment method. | +| 159 | | setOrder() | Conformity requirement 1:
Precondition: Instantiate Instantiate the SearchManager class object, the application needs a way to view the search results, there exists a list object of the search results.
Test method: Call the setOrder() method.
Conformity result: Get alignment elements.
Conformity requirement 2:
Precondition: Instantiate Instantiate the SearchManager class object, the application needs a way to view the search results, there exists a list object of the search results.
Test method: The input parameter is not inside the type and the setOrder() method is called.
Conformity result: Throw an exception. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 160 | | getType() | Conformity requirements:
Precondition: Instantiate Instantiate the SearchManager class object, the application needs a way to view the search results, there exists a list object of the search results, and setType() has been called before.
Test method: Call the getType() method.
Conformity result: Get the alignment element. | +| 161 | | setType() | Conformity requirement 1:
Precondition: Instantiate Instantiate the SearchManager class object, the application needs a way to view the search results, there exists a list object of the search results.
Test method: Call the setType() method.
Conformity result: Set the alignment element.
Conformity requirement 2:
Precondition: The user calls the instantiated SearchManager class and the corresponding search callback is established.
Test method: Call the setType() method to set the parameter not to be in the constant field of the alignment element.
Conformity result: Throw an exception. | + +### A.9 Conformance test of multi-screen interactive unit interfaces + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ImultiScreenService | START_MULTISCREEN SERVER | Conformity requirements:
Precondition: None.
Test method: The class name directly calls ImultiScreenService.START_MULTISCREENSERVER.
Conformity requirements: The corresponding value is consistent with the requirements. | +| 2 | | STOP_MULTISCREEN SERVER | Conformity requirements:
Precondition: None.
Test method: The class name directly calls ImultiScreenService.STOP_MULTISCREENSERVER.
Conformity requirements: The corresponding value is consistent with the requirements. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3 | ImultiScreenService | START_MULTISCREENCLIENT | Conformity requirements:
Precondition: None.
Test method: The class name directly calls ImultiScreenService.START_MULTISCREENCLIENT.
Conformity requirements: The corresponding value is consistent with the requirements. | +| 4 | | STOP_MULTISCREENCLIENT | Conformity requirements:
Precondition: None.
Test method: The class name directly calls ImultiScreenService.STOP_MULTISCREENCLIENT.
Conformity requirements: The corresponding value is consistent with the requirements. | +| 5 | | FIND_SPS | Conformity requirements:
Precondition: None.
Test method: The class name directly calls ImultiScreenService.FIND_SPS.
Conformity requirements: The corresponding value is consistent with the requirements. | +| 6 | | CONNECT | Conformity requirements:
Precondition: None.
Test method: The class name directly calls ImultiScreenService.CONNECT.
Conformity requirements: The corresponding value is consistent with the requirements. | +| 7 | | SET_CALLBACK | Conformity requirements:
Precondition: None.
Test method: The class name directly calls ImultiScreenService.SET_CALLBACK.
Conformity requirements: The corresponding value is consistent with the requirements. | +| 8 | | QUERY_INFO | Conformity requirements:
Precondition: None.
Test method: The class name directly calls ImultiScreenService.QUERY_INFO.
Conformity requirements: The corresponding value is consistent with the requirements. | +| 9 | | EXEC_CMD | Conformity requirements:
Precondition: None.
Test method: The class name directly calls ImultiScreenService.EXEC_CMD.
Conformity requirements: The corresponding value is consistent with the requirements. | +| 10 | | INPUT_KEYCODE | Conformity requirements:
Precondition: None.
Test method: The class name directly calls ImultiScreenService.INPUT_KEYCODE. | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 11 | ImultiScreenService | NOTIFY_ALL_REMOTE | Conformity requirements: The corresponding value is consistent with the requirements.
Conformity requirements:
Precondition: None.
Test method: The class name directly calls ImultiScreenService.NOTIFY_ALL_REMOTE.
Conformity requirements: The corresponding value is consistent with the requirements. | +| 12 | | startMultiScreenServer() | Conformity requirement 1:
Precondition: The device and server are connected to the same local area network.
Test method: Call the startMultiScreenServer() method and input valid parameters to start the multi screen interactive component server.
The validity of the parameters is as follows:
a) SpName represents the server name, with sizes ranging from 1 to 20000 characters in length
b) SpVersion represents the server-side version, with sizes ranging from 1 to 20000 characters in length
c) SpDeviceType represents the type of server-side device, with sizes ranging from 1 to 20000 characters in length
d) Port represents the device port number, ranging from 0 to 65535
e) SpServiceInfo represents server-side service information, with a size ranging from 1 to 20000 characters in length
f) IpAddress represents the device's IP address, with a size of 32-bit IPv4 address
g) Hostname represents the device host name, with a size ranging from 1 to 20000 characters in length
Conformity result: The method returns OK.
Conformity requirement 2:
Precondition: The device and server are not connected to the same local area network.
Test method: Call the startMultiScreenServer() method and input valid parameters to start the multi screen interactive component server.
Conformity result: The method returns a non OK error code.
Conformity requirement 3:
Precondition: The device and server are connected to the same local area network.
Test method: Call the startMultiScreenServer() method and input invalid parameters.
Conformity result: The method returns a non OK error code. | +| 13 | | stopMultiScreenServer() | Conformity requirement 1:
Precondition: Call the startMultiScreenServer() method to successfully start the multi screen | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
interactive component server.
Test method: Call the stopMultiScreenServer() method.
Conformity result: The method returns OK.
Conformity requirement 2:
Precondition: The multi screen interactive component server has not been started.
Test method: Call the stopMultiScreenServer() method.
Conformity result: The method returns a non OK error code.
| +| 14 | | startMultiScreenClient() |Conformity requirement 1:
Precondition: The device and client have been already connected to the same local area network.
Test method: Call the startMultiScreenClient() method and enter valid parameters to start the multi screen interactive component client.
The validity of the parameters is as follows:
- 1. ClientName: indicates the client name, with a size ranging from 1 to 20000 characters in length
Conformity result: The method returns OK.
Conformity requirement 2:
Precondition: The device and client are not connected to the same local area network.
Test method: Call the startMultiScreenClient() method.
Conformity result: The method returns a non OK error code.
Conformity requirement 3:
Precondition: The device and client are already connected to the same local area network.
Test method: Call the startMultiScreenClient() method and input invalid parameters.
Conformity result: The method returns a non OK error code.
| +| 15 | | stopMultiScreenClient() |Conformity requirement 1:
Precondition: Call the startMultiScreenServer() method to successfully start the multi screen interactive component server.
Test method: Call the stopMultiScreenClient() method.
Conformity result: The method returns OK.
Conformity requirement 2:
Precondition: The multi screen interactive component client has not been successfully started.
Test method: Call the stopMultiScreenClient() method.
| + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|---------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 16 | ImultiScreenService | | Conformity result: The method returns a non OK error code. | +| | | findSPs() |Conformity requirement 1:
Precondition: The service component device is connected to the same local area network as the server and client, and the service component device can be discovered.
Test method: Call the findSPs() method.
Conformity result: The method returns OK.
Conformity requirement 2:
Precondition: The service component device cannot be discovered.
Test method: Call the findSPs() method.
Conformity result: The method returns a non OK error code.
Conformity requirement 1:
Precondition: local area network (LAN) server devices can be discovered.
Test method: Call the connect() method and input valid parameters.
The validity of the parameters is as follows:
- a) SpName represents the server name, with sizes ranging from 1 to 20000 characters in length
- b) SpVersion represents the server-side version, with sizes ranging from 1 to 20000 characters in length
- c) SpServiceInfo represents server-side service information, with a size ranging from 1 to 20000 characters in length
- d) SpDeviceType represents the type of server-side device, with sizes ranging from 1 to 20000 characters in length
- e) IpAddress represents the device's IP address, with a size of 32-bit IPv4 address
- f) Port represents the device port number, ranging from 0 to 65535
- g) Hostname represents the device host name, with a size ranging from 1 to 20000 characters in length
Conformity result: The method returns OK.
Conformity requirement 2:
Precondition: LAN server devices cannot be discovered.
Test method: Call the connect() method and input valid parameters.
Conformity result: The method returns a non OK error code.
Conformity requirement 3:
Precondition: LAN server devices can be
discovered.
Test method: Call the connect() method and input invalid parameters.
Conformity result: The method returns a non OK error code.
| +| | | setCallBack(IBinder ibinder) |Conformity requirement 1:
Precondition: The local area network is connected to the remote interface.
Test method: Call the setCallBack() method and input valid parameters to set the remote call callback interface.
The validity of the parameters is as follows:
1. Ibinder org.tvos.os.Ibinder object type.
Conformity result: The method returns OK.
Conformity requirement 2:
Precondition: The local area network is not connected to the remote interface.
Test method: Call the setCallBack() method and input valid parameters.
Conformity result: The method returns a non OK error code.
Conformity requirement 3:
Precondition: The local area network is connected to the remote interface.
Test method: Call the setCallBack() method and input invalid parameters.
Conformity result: The method returns a non OK error code.
| +| 19 | | queryInfo() |Conformity requirement 1:
Precondition: The LAN multi screen interactive client and server have established a connection through connect().
Test method: The client calls the queryInfo() method and inputs valid parameters.
The validity of the parameters is as follows:
- a) CMDID represents the instruction ID for requesting information, with sizes ranging from 1 to 20000 characters in length
- b) Attribute represents the instruction name for requesting information, with a size of 1-20000 characters in length
- c) Params represents the instruction parameters for requesting information, with sizes ranging from 1 to 20000 characters in length
- d) IpAddress represents the device's IP address, with a size of 32-bit IPv4 address
- e) Port represents the device port number, ranging from 0 to 65535
- f) Hostname represents the device host name, with a size ranging from 1 to 20000
characters in length
Conformity result: The method returns OK.
Conformity requirement 2:
Precondition: The LAN multi screen interactive client and server have not established a connection.
Test method: The client calls the queryInfo() method and inputs valid parameters.
Conformity result: The method returns a non OK error code.
Conformity requirement 3:
Precondition: The LAN multi screen interactive client and server have established a connection through connect().
Test method: The client calls the queryInfo() method and inputs invalid parameters.
Conformity result: The method returns a non OK error code.
| +| | | execCmd() |Conformity requirement 1:
Precondition: The LAN multi screen interactive client and server have established a connection through connect().
Test method: The client calls the execCmd() method and inputs valid parameters.
The validity of the parameters is as follows:
- a) Cmd represents key commands, with a size of 1-20000 characters in length
- b) Param represents the parameter attached to the key command, with a size of 1-20000 characters in length
- c) IpAddress represents the device's IP address, with a size of 32-bit IPv4 address
- d) Port represents the device port number, ranging from 0 to 65535
- e) Hostname represents the device host name, with a size ranging from 1 to 20000 characters in length
Conformity result: The method returns OK.
Conformity requirement 2:
Precondition: The LAN multi screen interactive client and server have not established a connection.
Test method: The client calls the execCmd() method and inputs valid parameters.
Conformity result: The method returns a non OK error code.
Conformity requirement 3:
Precondition: The LAN multi screen interactive client and server have established a connection through connect().
| + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |Test method: The client calls the execCmd() method and inputs invalid parameters.
Conformity result: The method returns a non OK error code.
| +| 21 | | inputKeyCode() |Conformity requirement 1:
Precondition: The LAN multi screen interactive client and server have established a connection through connect(), the multi screen interactive client successfully calls the execCmd() method, and the server successfully enters the command receiving state.
Test method: The client calls the inputKeyCode() method and inputs valid parameters.
The validity of the parameters is as follows:
a) Action represents a key command, with a size ranging from 1 to 20000 characters in length
b) Param represents the parameter attached to the key command, with a size of 1-20000 characters in length
c) IpAddress represents the device's IP address, with a size of 32-bit IPv4 address
d) Port represents the device port number, ranging from 0 to 65535
e) Hostname represents the device host name, with a size ranging from 1 to 20000 characters in length
Conformity result: The method returns OK.
Conformity requirement 2:
Precondition: The server fails to successfully enter the command receiving state.
Test method: The client calls the inputKeyCode() method and input valid parameters.
Conformity result: The method returns a non OK error code.
Conformity requirement 3:
Precondition: The LAN multi screen interactive client and server have established a connection through connect(), the multi screen interactive client successfully calls the execCmd() method, and the server successfully enters the command receiving state.
Test method: The client calls the inputKeyCode() method and inputs invalid parameters.
Conformity result: The method returns a non OK error code.
Conformity requirement 1:
Precondition: The client and server of the local area network have successfully connected.
Test method: The multi screen interactive component server calls the boardCastAllDevice()
method and inputs valid parameters.
The validity of the parameters is as follows:
a) Cmd represents a broadcast instruction, with a size of 1-20000 characters in length
b) Param represents the parameter attached to the broadcast command, with a size of 1-20000 characters in length
Conformity result: The method returns OK.
Conformity requirement 2:
Precondition: The client and server of the local area network have not established a connection.
Test method: The multi screen interactive component server calls the boardCastAllDevice() method and inputs valid parameters.
Conformity result: The method returns a non OK error code.
Conformity requirement 3:
Precondition: The client and server of the local area network have successfully connected.
Test method: The multi screen interactive component server calls the boardCastAllDevice() method and inputs invalid parameters.
Conformity result: The method returns a non OK error code.
Conformity requirements:
Precondition: None.
Test method: The class name directly calls IMultiScreenCallBack.ON_SP_FOUNDED.
Conformity requirements: The corresponding value is consistent with the requirements.
Conformity requirements:
Precondition: None.
Test method: The class name directly calls IMultiScreenCallBack.ON_CONNECTED.
Conformity requirements: The corresponding value is consistent with the requirements.
Conformity requirements:
Precondition: None.
Test method: The class name directly calls IMultiScreenCallBack.ON_CONNECTEDREFUSED.
Conformity requirements: The corresponding value is consistent with the requirements.
Conformity requirements:
Precondition: None.
Test method: The class name directly calls IMultiScreenCallBack.ON_DISCONNECTED.
Conformity requirements: The corresponding value is consistent with the requirements.
Precondition: None.
Test method: The class name directly calls IMultiScreenCallBack.ON_SERVICE_ACTIVATED.
Conformity requirements: The corresponding value is consistent with the requirements. | +| 28 | | ON_SERVICE_DEACTIVATED | Conformity requirements:
Precondition: None.
Test method: The class name directly calls IMultiScreenCallBack.ON_SERVICE_DEACTIVATED.
Conformity requirements: The corresponding value is consistent with the requirements. | +| 29 | | ON_QUERY_INFO | Conformity requirements:
Precondition: None.
Test method: The class name directly calls IMultiScreenCallBack.ON_QUERY_INFO.
Conformity requirements: The corresponding value is consistent with the requirements. | +| 30 | | ON_QUERY_RESPONSE | Conformity requirements:
Precondition: None.
Test method: The class name directly calls IMultiScreenCallBack.ON_QUERY_RESPONSE.
Conformity requirements: The corresponding value is consistent with the requirements. | +| 31 | | ON_EXECUTE | Conformity requirements:
Precondition: None.
Test method: The class name directly calls IMultiScreenCallBack.ON_EXECUTE.
Conformity requirements: The corresponding value is consistent with the requirements. | +| 32 | | ON_INPUT | Conformity requirements:
Precondition: None.
Test method: The class name directly calls IMultiScreenCallBack.ON_INPUT.
Conformity requirements: The corresponding value is consistent with the requirements. | +| 33 | | ON_NOTIFY | Conformity requirements:
Precondition: None.
Test method: The class name directly calls IMultiScreenCallBack.ON_NOTIFY.
Conformity requirements: The corresponding value is consistent with the requirements. | +| 34 | | onSpFounded() | Conformity requirement 1:
Precondition: The LAN MultiScreen Interactive Component service can be discovered through the findSPs() method. The service starts and | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|----------------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 35 | ImultiScreenCallback | |
creates an instance of the IMultiScreenCallback object, and registers this callback instance through the setCallBack method.
Test method: Call the findSp() method.
Conformity result: The onSpFounded() method is called in the instance.
Conformity requirement 2:
Precondition: The LAN multi-screen interactive component service cannot be connected. the service starts and creates an instance of the IMultiScreenCallback object and registers this callback instance through the setCallBack method.
Test method: Call the findSp() method.
Conformity result: The onSpFounded() method is not called in the instance.
| +| | | onConnected() |Conformity requirement 1:
Precondition: The LAN MultiScreen Interactive Component service can be discovered through the findSPs() method. The service starts and creates an instance of the IMultiScreenCallback object, and registers this callback instance through the setCallBack method.
Test method: Call the connect() method.
Conformity result: The onConnected() method is called in the instance.
Conformity requirement 2:
Precondition: The LAN multi-screen interactive component service cannot be connected. the service starts and creates an instance of the IMultiScreenCallback object and registers this callback instance through the setCallBack method.
Test method: Call the connect() method.
Conformity result: The onConnected() method is not called in the instance.
| +| | | onConnectRefused() |Conformity requirement 1:
Precondition: The LAN multi screen interactive service component is currently in a rejected connection state. the service starts and creates an instance of the IMultiScreenCallback object and registers this callback instance through the setCallBack method.
Test method: Call the connect() method.
Conformity result:The onConnectRefused() is called in the instance.
Conformity requirement 2:
Precondition: The LAN MultiScreen Interactive Service component is able to connect and is currently in the unconnected state. the service starts and creates an instance of the
| + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|----------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 37 | ImultiScreenCallback | | IMultiScreenCallBack object and registers an instance of this callback through the setCallBack method.Test method: Call the connect() method.
Conformity result: The onConnectRefused() is not called in the instance. | +| | | onDisconnected() | Conformity requirement 1:
Precondition: The LAN MultiScreen Interactive Service component is able to disconnect and is currently in the connected state. the service starts and creates an instance of the IMultiScreenCallBack object and registers an instance of this callback through the setCallBack method.
Test method: The connect() method is called, onConnected() is called, and then stopMultiScreenServer is called to disconnect.
Conformity result: The onDisconected() is called in the instance.
Conformity requirement 2:
Precondition: The LAN MultiScreen Interactive Service component is currently in the unconnected state. the service starts and creates an instance of the IMultiScreenCallBack object and registers this callback instance through the setCallBack method.
Test method: Call the connect() method, onConnected() is called and then stopMultiScreenServer is called to disconnect the connection.
Conformity result: The onDisconected() is not called in the instance. | +| 38 | | onServiceActivated() | Conformity requirement 1:
Precondition: The LAN MultiScreen Interactive Component service can be activated via the startMultiScreenServer() method and is currently in the inactive state. The service starts and creates an IMultiScreenCallBack object instance and registers this callback instance via the setCallBack method.
Test method: call startMultiScreenServer() method.
Conformity result: onServiceActivated() is called in the instance.
Conformity requirement 2:
Precondition: The LAN MultiScreen Interactive Component service cannot be activated by the startMultiScreenServer() method and is currently in the inactive state. the service starts and creates an instance of the IMultiScreenCallBack object and registers this callback instance with the | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|----------------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | ImultiScreenCallBack | |
setCallBack method.
Test method: call startMultiScreenServer() method.
Conformity result: onServiceActivated() is not called in the instance.
| +| 39 | | onServiceDeactivated() |Conformity requirement 1:
Precondition: LAN MultiScreen Interactive Service can be shut down and is currently in the startup state; create an instance of the IMultiScreenCallBack object and register this callback instance through the setCallBack method.
Test method: Call the stopMultiScreenServer() method.
Conformity result: The onServiceDeactivated() is called in the instance.
Conformity requirement 2:
Precondition: LAN MultiScreen Interactive Service is currently in an unstarted state; create an instance of the IMultiScreenCallBack object and register the callback instance via the setCallBack method.
Test method: Call the stopMultiScreenServer() method.
Conformity result: The onServiceDeactivated() is not called in the instance.
| +| 40 | | onQueryInfo() |Conformity requirement 1:
Precondition: The LAN MultiScreen Interactive Component service and the client are connected, the service starts and creates an instance of the IMultiScreenCallBack object, and registers the callback instance via the setCallBack method.
Test method: Call the queryInfo() method.
Conformity result: onQueryInfo() is called in the instance.
Conformity requirement 2:
Precondition: The LAN MultiScreen Interactive
| + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|----------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | ImultiScreenCallBack | | Component service is not connected to the client, the service starts and creates an instance of the IMultiScreenCallBack object, and registers the callback instance via the setCallBack method.Test method: Call the queryInfo() method.
Conformity result: onQueryInfo() is not called in the instance. | +| 41 | | onQueryResponse() | Conformity requirement1:
Precondition: The LAN MultiScreen Interactive Server can respond to client data requests. the service starts and creates an instance of the IMultiScreenCallBack object and registers this callback instance through the setCallBack method.
Test method: Call the onQueryInfo() method.
Conformity result: onQueryResponse() is called in the instance.
Conformity requirement 2:
Precondition: The LAN MultiScreen Interactive Service cannot respond to client data requests, the service starts and creates an instance of the IMultiScreenCallBack object, and registers this callback instance through the setCallBack method.
Test method: Call the onQueryInfo() method.
Conformity result: onQueryResponse() is not called in the instance. | +| 42 | | onExecute() | Conformity requirement1:
Precondition: Preconditions: The LAN multi-screen interactive client can send commands to the server to execute the request, currently in the connection state, the service starts and creates an IMultiScreenCallBack object instance, and registers the callback instance through the setCallBack method.
Test method: Call execCmd() method.
Conformity result: onExecute() is called in the instance.
Conformity requirement 2:
Precondition: The LAN multi-screen interactive client and the server are not connected, the server cannot receive the command to execute the request, the service starts and creates an instance of the IMultiScreenCallBack object, and registers this callback instance through the setCallBack method.
Test method: Call execCmd() method.
Conformity result: onExecute() is not called in the instance. | +| 43 | | onInputKeyCode() | Conformity requirement1:
Precondition: The LAN multi-screen interactive | + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
client can send key injection execution request to the server, the service starts and creates an instance of IMultiScreenCallBack object, and registers the callback instance through setCallBack method.
Test method: call inputkeyCode() method.
Conformity result: onInputKeyCode() is called in the instance.
Conformity requirement 2:
Precondition: The LAN multi-screen interactive client and the server are not connected, the server cannot receive the key injection execution request, the service starts and creates an instance of IMultiScreenCallBack object, and registers this callback instance through the setCallBack method.
Test method: Call inputkeyCode() method.
Conformity result: onInputKeyCode() is not called in the instance.
| +| 44 | | onNotify() |Conformity requirement1:
Precondition: The LAN MultiScreen Interactive Client can receive broadcast notifications sent by the server, start and create an instance of the IMultiScreenCallBack object, and register this callback instance through the setCallBack method.
Test method: call boardCastAllDevice() method.
Conformity result: onNotify() is called in the instance.
Conformity requirement 2:
Precondition: The LAN MultiScreen Interactive server is not connected to the client, the client is unable to receive broadcasts, the service starts and creates an instance of the IMultiScreenCallBack object, and registers this callback instance through the setCallBack method.
Test method: Call boardCastAllDevice() method.
Conformity result: onNotify() is not called in the instance.
| +| 45 | | onTransact() |Conformity requirement1:
Precondition: The multi-screen interactive component service can be accessed across processes., the service starts and creates an instance of the IMultiScreenCallBack object, and registers the callback instance via the setCallBack method.
Test method: Call any of the methods.
Conformity result: onTransact() is called in the instance.
Conformity requirement 2:
| + +| Serial No. | Class/interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Precondition: Multi screen interactive component services do not experience cross process access. The service starts and creates an instance of the IMultiScreenCallBack object, and registers the callback instance via the setCallBack method. Test method: Call any of the methods. Conformity result: onTransact() is not called in the instance. | + +### A.10 Conformance test of DRM management unit interface + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|--------------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | org.ngb.drm.services.ChinaDrmManager | setOnMessageListener() | Conformity requirements:Precondition: After successfully calling registerApp(), register the DRM APP.
Test method: Call the setOnMessageListener() method and set valid parameters.
Conformity result: When playing a DRM programme protected by a DRM system identified as a registered drmId, the message notification callback function is called to get the notification message. | +| 2 | | setOnLicenseListener() | Conformity requirements:
Precondition: After setting licensereq_commandId to 0 and calling registerApp(), the DRM APP is successfully registered.
Test method: Call the setOnLicenseListener() method and set valid parameters.
Conformance test result: When playing a DRM programme protected by a DRM system identified as a registered drmId, the Get License callback function is called to get a license request message. | +| 3 | | setOnDecryptListener() | Conformity requirements:
Precondition: After setting licensereq_commandId to 0 and calling registerApp(), the DRM APP is successfully registered.
Test method: Call the setOnDecryptListener() method and set valid parameters.
Conformance test result: When playing a DRM programme protected by a DRM system identified as a registered drmId, the callback function for data decryption is called to get the decryption request message. | +| 4 | | registerApp() | Conformity requirement 1:
Precondition: The DRM component is working properly.
Test method: Call the registerApp() method and | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|--------------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5 | org.ngb.drm.services.ChinaDrmManager | | input valid parameters.
Conformity result: Method returns 0.
Conformity requirement 2:
Precondition: The DRM component is working properly.
Test method: Call the registerApp() method and set invalid parameters.
Conformity result: Method returns non-zero. | +| | | unRegisterApp() | Conformity requirement 1:
Precondition: After successfully calling registerApp(), register the DRM APP.
Test method: Call the unRegisterApp() method.
Conformity result: Method returns 0.
Conformity requirement 2:
Precondition: Do not call registerApp(), do not register DRM APP.
Test method: Call the unRegisterApp() method.
Conformity result: Method returns non-zero. | +| 6 | | sendCommandToTEE() | Conformity requirement 1:
Precondition: After successfully calling registerApp(), register the DRM APP.
Test method: Call the sendCommandToTEE() method and set valid parameters.
Conformity result: The method returns the ChinaDrmTeeRetVal object and calls the getReturnCode() method of the ChinaDrmTeeRetVal object to get a return value of 0.
Conformity requirement 2:
Precondition: After successfully calling registerApp(), register the DRM APP.
Test method: Call the sendCommandToTEE() method and set invalid parameters.
Conformity result: The method returns the ChinaDrmTeeRetVal object and calls the getReturnCode() method of the ChinaDrmTeeRetVal object to get a return value of non-zero. | +| 7 | | sendMessageToPlayer() | Conformity requirement 1:
Precondition: After successfully calling registerApp(), register the DRM APP.
Test method: Call the sendMessageToPlayer() method and set valid parameters.
Conformity result: Method returns 0.
Conformity requirement 2:
Precondition: After successfully calling registerApp(), register the DRM APP.
Test method: Call the sendMessageToPlayer() method and set invalid parameters. | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|----------------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Conformity result: Method returns non-zero. | +| 8 | org.ngb.drm.services.ChinaDrmTeeRetVal | getData() |
Conformity requirement 1:
Precondition: After calling sendCommandToTEE(), call the getDataLen() method of ChinaDrmTeeRetVal to return an integer greater than zero.
Test method: Call the getData() method.
Conformity result: The method returns the data returned by DRM Tapp.
Conformity requirement 2:
Precondition: After calling sendCommandToTEE(), call the getDataLen() method of ChinaDrmTeeRetVal to return zero.
Test method: Call the getData() method.
Conformity result: Method returns NULL.
Conformity requirement 1:
Precondition: After calling sendCommandToTEE(), call the getReturnCode() method of ChinaDrmTeeRetVal to return 0.
Test method: Call the getDataLen() method.
Conformity result: The method returns an integer greater than or equal to 0.
Conformity requirement 2:
Precondition: After calling sendCommandToTEE(), call the getReturnCode() method of ChinaDrmTeeRetVal to return non-zero.
Test method: Call the getDataLen() method.
Conformity result: Method returns 0.
Conformity requirement 1:
Precondition: After calling sendCommandToTEE(), call the getReturnCode() method of ChinaDrmTeeRetVal to return 0.
Test method: Call the getOriginCode() method.
Conformity result: Method returns 0.
Conformity requirement 2:
Precondition: After calling sendCommandToTEE(), call the getReturnCode() method of ChinaDrmTeeRetVal to return non-zero.
Test method: Call the getOriginCode() method.
Conformity result: Method returns non-zero.
Conformity requirement 1:
Precondition: Successfully call sendCommandToTEE() and return the ChinaDrmTeeRetVal object.
Test method: Call the getReturnCode() method.
Conformity requirement 2:
Precondition: Call sendCommandToTEE(), set invalid parameters, and return the ChinaDrmTeeRetVal object.
Test method: Call getReturnCode().
Conformity result: Method returns non-zero. | + +### A.11 Conformance test of DCAS unit interface + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | | startDescrambling() | Conformity requirements:
Precondition: Based on the testing environment conditions, the DCAS software successfully calls CASModuleManager.registerCASModule(). Pass the CASModule to the platform.
Test method: Platform calls startDescrambling().
Conformity result: Start descrambling the program. | +| 2 | | updateDescrambling() | Conformity requirements:
Precondition: Based on the testing environment conditions, the DCAS software successfully calls CASModuleManager.registerCASModule(). Pass the CASModule to the platform.
Test method: Platform calls updateDescrambling().
Conformity result: Descramble program. | +| 3 | | stopDescrambling() | Conformity requirements:
Precondition: Based on the testing environment conditions, the DCAS software successfully calls CASModuleManager.registerCASModule(). Pass the CASModule to the platform, after the platform successfully calls startDescrambling().
Test method: Call updateDescrambling().
Conformity result: Stop descrambling program. | +| 4 | | getCAInfo() | Conformity requirements:
Precondition: Based on the testing environment conditions, the DCAS software successfully calls | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5 | CASModule | | CASModuleManager.registerCASModule().Pass the CASModule to the platform, platform successfully calls setCAInfo().
Test method: Call getCAInfo().
Conformity result: Get CA information. | +| | CASModule | setCAInfo() | Conformity requirement 1:
Precondition: DCAS software successfully calls CASModuleManager.registerCASModule(). Pass the CASModule to the platform.
Test method: Call setCAInfo() and input valid parameters.
Conformity result: Set successfully and return 0.
Conformity requirement 2:
Precondition: DCAS software successfully calls CASModuleManager.registerCASModule(). Pass the CASModule to the platform.
Test method: Call setCAInfo() and input invalid parameters.
Conformity result: Return an error value. | +| 6 | | | Conformity requirements:
Precondition: Successfully call setCAInfo() based on the testing environment conditions.
Test method: Call getCAInfo().
Conformity result: Get CA information. | +| | CASDataUtils | getCAInfo() | | +| 7 | CASDataUtils | setCAInfo() | Conformity requirement 1:
Precondition: Based on the testing environment conditions, DCASAPP has been registered.
Test method: Call setCAInfo() and input valid parameters.
Conformity result: Set successfully and return 0.
Conformity requirement 2:
Precondition: Successfully call setCAInfo() based on the testing environment conditions.
Test method: Call setCAInfo() and input invalid parameters.
Conformity result: Return an error value. | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 8 | CADescriptor | getData() | Conformity requirements:
Precondition: Based on the testing environment conditions, successfully call setData().
Test method: Call getData().
Conformity result: Get the specified type of data. | +| 9 | | setData() | Conformity requirement 1:
Precondition: Based on the testing environment conditions, DCASAPP has been registered.
Test method: Call setData() and input valid parameters.
Conformity result: Set successfully and return 0.
Conformity requirement 2:
Precondition: Based on the testing environment conditions, DCASAPP has been registered.
Test method: Call setData() and input invalid parameters.
Conformity result: Return an error value. | +| 10 | | getCASystemId() | Conformity requirements:
Precondition: Based on the testing environment conditions, successfully call getCADescriptor().
Test method: Call getCASystemId().
Conformity result: Get CASystemId. | +| 11 | | getPid() | Conformity requirements:
Precondition: Based on the testing environment conditions, successfully call getCADescriptor().
Test method: Call getPid().
Conformity result: Get the PID in the CA description. | +| 12 | | getPrivateData() | Conformity requirements:
Precondition: Based on the testing environment conditions, successfully call getCADescriptor().
Test method: Call getPrivateData().
Conformity result: Get the private data array in the CA description. | +| 13 | | getDescramblerContext() | Conformity requirements:
Precondition: The platform successfully calls startDescrambling().
Test method: DCASAPP calls | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | CAServiceComponentInfo | | getDescramblerContext().
Conformity result: Get the DescramblerContext object for DCAS application loading CW. | +| 14 | | getCAdescriptor() | Conformity requirements:
Precondition: The platform successfully calls startDescrambling().
Test method: DCASAPP calls getCAdescriptor().
Conformity result: Get CA description. | +| 15 | | getComponentStreamPIDs() | Conformity requirements:
Precondition: The platform successfully calls startDescrambling().
Test method: DCASAPP calls getComponentStreamPIDs().
Conformity result: Get the private data array in the CA description. | +| 16 | | getComponentStreamTypes() | Conformity requirements:
Precondition: The platform successfully calls startDescrambling().
Test method: DCASAPP calls getComponentStreamTypes().
Conformity result: Get the ES PID array. | +| 17 | | getServiceIdentifiers() | Conformity requirements:
Precondition: The platform successfully calls startDescrambling().
Test method: DCASAPP calls getServiceIdentifiers().
Conformity result: Get an array of ES stream types. | +| 18 | CASPacketListener | casPacketArrived() | Compliance requirements:
Precondition:
RegisterCASPacketListener() has been called.
Test method: Call casPacketArrived().
Compliance result: Obtain conditional access system (CAS) package. | +| 19 | CASSession | getType() | Conformity requirements:
Precondition:
RegisterCASPacketListener() has been called. | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|--------------------------|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | CASStatus | | Test method: Call
casPacketArrived() .Conformity result: Get CAS package.
Conformity requirements:
Precondition: Successfully call
startDescrambling() based on the testing environment conditions.Test method: Call
getType() .Conformity result: Return the type of operation. | +| 20 | |
getNetworkInterface() | Conformity requirements:Precondition: The platform has called
startDescrambling() .Test method: Call
getNetworkInterface() .Conformity result: Return the NetworkInterface object. | +| 21 | |
getAssociatedService() | Conformity requirements:Precondition: The platform has called
startDescrambling() .Test method: Call
getAssociatedService() .Conformity result: Return the Service object. | +| 22 | |
getServiceContext() | Conformity requirements:Precondition: The platform has called
startDescrambling() .Test method: Call
getServiceContext() .Conformity result: Return the ServiceContext object. | +| 23 | CASStatus |
isSuccess() | Conformity requirements:Precondition:
StartDescrambling has been called and the result of the descrambling is known.Test method: Call
isSuccess() .Conformity result: Set the descrambling result. | +| 24 | |
getCAToken() | Conformity requirements:Precondition: The
CATListener has been registered by calling registerCATListener .Test method: Call
getCAToken() .Conformity result: Can receive update notifications. | +| 25 |
CATListener | catUpdate() | Conformity requirements:Precondition: The
CATListener has been registered by calling |
+
+| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description |
+|------------|------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| | | | registerCATListener.Test method: Call catUpdate().
Conformity result: Can receive update notifications. | +| 26 | CATNotifier | registerCATListener() | Conformity requirements:
Precondition: The CATNotify object has been obtained.
Test method: Call registerCATListener().
Conformity result: Register a CATListener. | +| 27 | | unregisterCATListener() | Conformity requirements:
Precondition: The CATNotify object has been obtained and the registerCATListener() has been called.
Test method: Call unregisterCATListener().
Conformity result: Unregister CATListener. | +| 28 | CASModuleManager | getInstance() | Conformity requirement 1:
Precondition: The security policy is activated and the DCASAPP has invocation privileges.
Test method: Call getInstance().
Conformity result: Get CASModuleManager instance.
Conformity requirement 2:
Precondition: The security policy is activated and the DCASAPP has no invocation privileges.
Test method: Call getInstance().
Conformity result: Throw an exception of java.lang.SecurityException. | +| 29 | | registerCASModule() | Conformity requirement 1:
Precondition: Based on the testing environment conditions, successfully call getInstance().
Test method: Call registerCASModule().
Conformity result: No exception is thrown.
Conformity requirement 2:
Precondition: Based on the testing environment conditions, successfully call getInstance().
Test method: Call registerCASModule() again. | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 30 | CASModuleManager | | Conformity result: Throw an exception of java.lang.IllegalArgumentException. | +| | | updateCASystemId() |
Conformity requirement 1:
Precondition: Successfully call registerCASModule().
Test method: Call updateCASystemId().
Conformity result: No exception is thrown.
Conformity requirement 2:
Precondition: RegisterCASModule() is not called.
Test method: Call updateCASystemId().
Conformity result: Throw an exception of java.lang.IllegalArgumentException .
Conformity requirement 1:
Precondition: Successfully call registerCASModule().
Test method: Call sendDescramblingEvent().
Conformity result: No exception is thrown.
Conformity requirement 2:
Precondition: RegisterCASModule() is not called.
Test method: Call sendDescramblingEvent().
Conformity result: Throw an exception of java.lang.IllegalArgumentException.
Conformity requirement 1:
Precondition: Successfully call registerCASModule().
Test method: Call unregisterCASModule().
Conformity result: No exception is thrown.
Conformity requirement 2:
Precondition: RegisterCASModule() is not called.
Test method: Call unregisterCASModule().
Conformity result: Throw an exception of java.lang.IllegalArgumentException.
Precondition: DCASAPP runs normally.
Test method: Call getChipControllers().
Conformity result: Return an array of chip controllers. | +| 34 | | setcurrentController() | Conformity requirement 1:
Precondition: Successfully call registerCASModule().
Test method: Call setcurrentController().
Conformity result: No exception is thrown.
Conformity requirement 2:
Precondition: RegisterCASModule() is not called.
Test method: Call setcurrentController().
Conformity result: Throw an exception of java.lang.IllegalArgumentException. | +| 35 | | setCCIBits() | Conformity requirements:
Precondition: Successfully call getInstance().
Test method: Call setCCIBits().
Conformity result: CCI bit information is set to the platform. | +| 36 | | setServiceListFilter() | Conformity requirements:
Precondition: Successfully call getInstance().
Test method: Call setServiceListFilter().
Conformity result: Filter parameters are set to the platform. | +| 37 | | registerCASPacketListener() | Conformity requirement 1:
Precondition: Successfully call registerCASModule().
Test method: Call registerCASPacketListener().
Conformity result: No exception is thrown.
Conformity requirement 2:
Precondition: Call registerCASModule().
Test method: Call registerCASPacketListener() again.
Conformity result: Throw an exception of | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 38 | CASModuleManager | unregisterCASPacketListener() | java.lang.IllegalArgumentException.
Conformity requirement 1:
Precondition: Successfully call registerCASPacketListener().
Test method: Call unregisterCASPacketListener().
Conformity result: No exception is thrown.
Conformity requirement 2:
Precondition: RegisterCASPacketListener() is not called.
Test method: Call unregisterCASPacketListener().
Conformity result: Throw an exception of java.lang.IllegalArgumentException. | +| 39 | | getDetachableSecurityDevices() | Conformity requirement:
Precondition: Successfully call getInstance().
Test method: Call getDetachableSecurityDevices().
Conformity result: Return an array of DetachableSecurityDevice object. | +| 40 | | receiveOsdMsg() | Conformity requirement:
Precondition: Successfully call getInstance().
Test method: Call receiveOsdMsg().
Conformity result: Send on-screen display (OSD) to the platform. | +| 41 | | showFingerMsg() | Conformity requirement:
Precondition: Successfully call getInstance().
Test method: Call showFingerMsg().
Conformity result: Send the fingerprint to the platform. | +| 42 | | receiveTuningAlert() | Conformity requirement:
Precondition: Successfully call getInstance().
Test method: Call receiveTuningAlert().
Conformity result: Send emergency broadcast to the platform. | +| 43 | | getCATNotifier() | Conformity Requirement 1:
Precondition: successfully call getInstance().
Test method: Call getCATNotifier().
Conformance result: Get the | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|--------------------|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | CATNotifier object. | +| 44 | CASPermission | CASPermission() | Conformity requirement 1:
Precondition: None.
Test method: Call CASPermission().
Conformity result: Create a CASPermission. | +| 45 | | CASPermission(String name, String actions) | Conformity requirement:
Precondition: None.
Test method: Call CASPermission().
Conformity result: The java.security.Policy object instantiates a new Permission object. | +| 46 | DescramblerContext | loadCW() | Conformity requirement 1:
Precondition: Successfully call getDescramblerContext().
Test method: Call loadCW() and input valid parameters.
Conformity result: loading succeeds, the programme can be watched.
Conformity requirement 2:
Precondition: Successfully call getDescramblerContext().
Test method: Call loadCW() and input invalid parameters.
Conformity result: Loading fails, throw this exception. | +| 47 | | overrideChipController() | Conformity requirement 1:
Precondition: Successfully call getDescramblerContext().
Test method: Call overrideChipController() and input valid parameters.
Conformity result: loading succeeds, the programme can be watched.
Conformity requirement 2:
Precondition: Successfully call getDescramblerContext().
Test method: Call overrideChipController() and input invalid parameters.
Conformity result: Fail to load, exception is thrown. | +| 48 | ChipController | SCHEME_TDES | Conformity requirement 1:
Precondition: Successfully call getChipControllers().
Test method: Call authenticate() and input the parameters as SCHEME_TDES.
Conformity result: Return an array | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 49 | ChipController | | of handshake responses.
Conformity requirement 2:
Precondition: Successfully call getChipControllers().
Test method: Call loadCW() and input the parameters as SCHEME_TDES.
Conformity result: Loading succeeds. | +| | | SCHEME_AES | Conformity requirement 1:
Precondition: Successfully call getChipControllers().
Test method: Call authenticate() and input the parameters as SCHEME_AES.
Conformity result: Return an array of handshake responses.
Conformity requirement 2:
Precondition: Successfully call getChipControllers().
Test method: Call loadCW() and input the parameters as SCHEME_AES.
Conformity result: Loading succeeds. | +| 50 | | PROCESSING_MODE_REGULAR | Conformity requirements:
Precondition: Successfully call getChipControllers().
Test method: Call authenticate() with PROCESSING_MODE_REGULAR as the parameter.
Conformity result: Return an array of handshake responses. | +| 51 | | PROCESSING_MODE_POST_PROCESSING | Conformity requirements:
Precondition: Successfully call getChipControllers().
Test method: Call authenticate() with PROCESSING_MODE_POST_PROCESSING as the parameter.
Conformity result: Return an array of handshake responses. | +| 52 | | getPublicId() | Conformity requirement 1:
Precondition: Successfully call getChipControllers().
Test method: Call getPublicId().
Conformity result: Return ChipID.
Conformity requirement 2: | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | ChipController | |
Precondition: Successfully call getChipControllers().
Test method: Call getPublicId(), and driver communication error occurs.
Conformity result: Throw an exception.
| +| 53 | | getChipType() |Conformity requirement 1:
Precondition: Successfully call getChipControllers().
Test method: Call getChipType().
Conformity result: Return the chip type.
Conformity requirement 2:
Precondition: Successfully call getChipControllers().
Test method: Call getChipType(), and driver communication error occurs.
Conformity result: Throw an exception.
| +| 54 | | getChipControllerProperty() |Conformity requirement 1:
Precondition: Successfully call getChipControllers().
Test method: Call getChipControllerProperty().
Conformity result: Return the property value.
Conformity requirement 2:
Precondition: Successfully call getChipControllers().
Test method: Call getChipControllerProperty(), and driver communication error occurs.
Conformity result: Throw an exception.
| +| 55 | | authenticate() |Conformity requirement 1:
Precondition: Successfully call getChipControllers().
Test method: Call authenticate().
Conformity result: Return response data.
Conformity requirement 2:
Precondition: Successfully call getChipControllers().
Test method: Call authenticate(), and driver communication error occurs.
Conformity result: Throw an exception.
| + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 56 | | encryptData() |Conformity requirement 1:
Precondition: Successfully call getChipControllers().
Test method: Call encryptData().
Conformity result: Get encrypted data.
Conformity requirement 2:
Precondition: Successfully call getChipControllers().
Test method: Call encryptData(), and driver communication error occurs.
Conformity result: Throw an exception.
Conformity requirement 1:
Precondition: Successfully call getChipControllers().
Test method: Call decryptData().
Conformity result: Get decrypted data.
Conformity requirement 2:
Precondition: Successfully call getChipControllers().
Test method: Call decryptData(), and driver communication error occurs.
Conformity result: Throw an exception.
Conformity requirements:
Precondition: None.
Test method: Call Key().
Conformity result: Construct Key.
Conformity requirements:
Precondition: Successfully call key().
Test method: Call getKeyValue ().
Conformity result: Return the key value.
Conformity requirement 1:
Precondition: A successful call to key() with an unencrypted key value for the argument.
Test method: Call isEncrypted().
Conformity result: Return an unencrypted key.
Conformity requirement 2:
Precondition: A successful call to key() with an encrypted key value for the argument.
Test method: Call isEncrypted().
Conformity result: Return the encrypted key.
Conformity requirements:
Precondition: Successfully call CWKey(), the control word (CW) value of the parameter is even.
Test method: Call getParity().
Conformity result: Return PARITY_EVEN.
Conformity requirements:
Precondition: Successfully call CWKey(), the CW value of the parameter is odd.
Test method: Call getParity().
Conformity result: Return PARITY_ODD.
Conformity requirements:
Precondition: None.
Test method: Call CWKey().
Conformity result: Construct CWKey.
Conformity requirement 1:
Precondition: Successfully call CWKey(), the CW value of the parameter is odd.
Test method: Call getParity().
Conformity result: Return PARITY_ODD.
Conformity requirement 2:
Precondition: Successfully call CWKey(), the CW value of the parameter is even.
Test method: Call getParity().
Conformity result: Return PARITY_EVEN.
Conformity requirement 1:
Precondition: DCASAPP registers
Test method: Call sendCommandToTEE().
Conformity result: Get the data returned by TEE
Conformity requirement 2:
Precondition: DCASAPP registers successfully.
Test method: Call sendCommandToTEE(), and driver communication error occurs.
Conformity result: Throw an exception. | +| 66 | CASEventListener | receiveCASEvent() | Conformity requirements:
Precondition: DCASAPP implements this function.
Test method: The platform calls receiveCASEvent().
Conformity result: Get CAS events. | +| 67 | | receiveCASOSDEvent() | Conformity requirements:
Precondition: DCASAPP implements this function.
Test method: The platform calls receiveCASOSDEvent().
Conformity result: Get OSD event. | +| 68 | | receiveCASFingerEvent() | Conformity requirements:
Precondition: DCASAPP implements this function.
Test method: The platform calls receiveCASFingerEvent().
Conformity result: Get fingerprint events. | +| 69 | CASAppInfo | getAID() | Conformity requirements:
Precondition: The platform successfully calls receiveCASEvent().
Test method: Platform calls getAID().
Conformity result: Get DCASAPP ID. | +| 70 | | getOID() | Conformity requirements:
Precondition: The platform successfully calls receiveCASEvent().
Test method: Platform calls getOID().
Conformity result: Get the DCAS manufacturer ID. | +| 71 | | TYPE_PRESENTATION | Conformity requirements: | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|-----------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | CASEventInfo | | Precondition: The platform successfully calls receiveCASEvent(), and passes the DCASAPP parameter TYPE_PRESENTATION.
Test method: Platform calls getType().
Conformity result: Get the TYPE_PRESENTATION type. | +| 72 | | TYPE_RECORDING | Conformity requirements:
Precondition: The platform successfully calls receiveCASEvent(), and passes the DCASAPP parameter TYPE_RECORDING.
Test method: Platform calls getType().
Conformity result: Get Type_Recording type. | +| 73 | | TYPE_BUFFERING | Conformity requirements:
Precondition: The platform successfully calls receiveCASEvent(), and passes the DCASAPP parameter TYPE_BUFFERING.
Test method: Platform calls getType().
Conformity result: Get TYPE_BUFFERING type. | +| 74 | | getType() | Conformity requirements:
Precondition: The platform successfully calls receiveCASEvent().
Test method: Platform calls getType().
Conformity result: Get the event type. | +| 75 | | getNetworkInterface() | Conformity requirements:
Precondition: The platform successfully calls receiveCASEvent().
Test method: Platform calls getNetworkInterface().
Conformity result: Get NetworkInterface object. | +| 76 | | getAssociatedService() | Conformity requirements:
Precondition: The platform successfully calls receiveCASEvent().
Test method: The platform calls | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|----------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 77 | | | getAssociatedService().
Conformity result: Get the Service object. | +| | | getServiceContext() | Conformity requirements:
Precondition: The platform successfully calls receiveCASEvent().
Test method: Platform calls getServiceContext().
Conformity result: Get the ServiceContext object. | +| 78 | CASEventManager | getInstance() | Conformity requirements:
Precondition: DCASAPP implements this function.
Test method: Platform calls getInstance().
Conformity result: Get a CASEventManager instance. | +| 79 | | addListener() | Conformity requirements:
Precondition: DCASAPP implements this function.
Test method: The platform calls addListener().
Conformity result: DCASAPP get a CASEventListener for transmitting data. | +| 80 | | removeListener() | Conformity requirements:
Precondition: DCASAPP implements this function, and the platform successfully calls addListener.
Test method: Platform calls removeListener().
Conformity result: Unregister the listener. | +| 81 | DetachabableSecurityDevice | open() | Conformity requirement 1:
Precondition: Smart card insertion.
Test method: Call open().
Conformity result: No exception is thrown.
Conformity requirement 2:
Precondition: Smart card is inserted, and driver error occurs.
Test method: Call open().
Conformity result: Throw an exception. | +| 82 | | close() | Conformity requirement 1:
Precondition: Smart card is inserted.
Test method: Call close(). | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|------------|--------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DetachableSecurityDevice | | Conformity result: No exception is thrown.
Conformity requirement 2:
Precondition: Smart card is inserted, and driver error occurs.
Test method: Call close().
Conformity result: Throw an exception. | +| | | | 83 | +| 84 | | sendData() | Conformity requirement 1:
Pr condition: Smart card is inserted.
Test method: Call sendData().
Conformity result: No exception is thrown.
Conformity requirement 2:
Precondition: Smart card is inserted, and driver error occurs.
Test method: Call sendData().
Conformity result: Throw an exception. | +| 85 | | registerListener() | Conformity requirements:
Precondition: None.
Test method: Call registerListener().
Conformity result: Register the listener. | +| 86 | | removeListener() | Conformity requirements:
Precondition: None.
Test method: Call removeListener().
Conformity result: Remove the listener. | +| 87 | | DEVICE_IN | Conformity requirements:
Precondition: Smart card is inserted.
Test method: Call receiveDeviceStatus().
Conformity result: Status is DEVICE_IN. | +| 88 | | DEVICE_OUT | Conformity requirements:
Precondition: Remove the smart | + +| Serial No. | Class/Interface | Constant field/Attribute/Method | Process description | +|-------------------|----------------------------------|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DetachableSecurityDeviceListener | | card.
Test method: Call receiveDeviceStatus().
Conformity result: Status is DEVICE_OUT. | +| 89 | | DEVICE_ERROR | Conformity requirements:
Precondition: Insert Bad smart card.
Test method: Call receiveDeviceStatus().
Conformity result: Status is DEVICE_ERROR. | +| 90 | | receiveDeviceStatus() | Conformity requirements:
Precondition: None.
Test method: Call receiveDeviceStatus().
Conformity result: Get the status of the device. | +| 91 | | receiveData() | Conformity requirements:
Precondition: Call receiveDeviceStatus to get the DEVICE_IN status.
Test method: Call receiveData().
Conformity result: Get the data returned by the smart card. | + +# Annex B + +## Conformance test of TVOS WEB application programming interface + +(This annex forms an integral part of this Recommendation.) + +### B.1 Conformance test of one-way broadcast network access unit interface + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|-----------------------|---------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | DvbcTuningParameters | frequency | Conformity requirement:
Precondition: Successfully create DvbcTuningParameters object based on testing environment conditions.
Test method: Read and write frequency.
Conformity result: Read/write frequency successfully in kHz. | +| 2 | | symbol_rate | Conformity requirement:
Precondition: Successfully create DvbcTuningParameters object based on testing environment conditions.
Test method: Read and write symbol_rate.
Conformity result: Read/write symbol_rate successfully in KSymbol/s. | +| 3 | | Modulation | Conformity requirement:
Precondition: Successfully create DvbcTuningParameters object based on testing environment conditions.
Test method: Read and write Modulation.
Conformity result: Read/write Modulation successfully with "QAM" suffix (with space), e.g., 64 QAM. | +| 4 | | DvbcTuningParameters() | Conformity requirements:
Precondition: None.
Test method: Call newDvbcTuningParameters().
Conformity result: Return the DvbcTuningParameters object. | +| 5 | | DvbcTuningParameters(frequency, symbolRate, modulation) | Conformity requirements:
Precondition: None.
Test method: Call DvbcTuningParameters (frequency, symbolRate, modulation).
Conformity result: Return the DvbcTuningParameters object, with frequency as the frequency, symbolRate as the symbol rate, and modulation as the modulation method. | +| 6 | AbsssTuningParameters | frequency | Conformity requirement:
Precondition: Successfully create AbsssTuningParameters object based on testing environment conditions. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|-----------------------|--------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | AbsssTuningParameters | | Test method: Read and write frequency.
Conformity result: Read/write frequency successfully in kHz. | +| 7 | | symbol_rate | Conformity requirement:
Precondition: Successfully create AbsssTuningParameters object based on testing environment conditions.
Test method: Read and write symbol_rate.
Conformity result: Read/write symbol_rate successfully in KSymbol/s. | +| 8 | | polarization | Conformity requirement:
Precondition: Successfully create AbsssTuningParameters object based on testing environment conditions.
Test method: Read and write polarization.
Conformity result: Read/write polarization method successfully. | +| 9 | | AbsssTuningParameters()
( ) | Conformity requirement 1:
Precondition: None.
Test method: Call new AbsssTuningParameters().
Conformity result: Return the AbsssTuningParameters object. | +| 10 | | AbsssTuningParameters (frequency, symbol_rate, polarization) | Conformity requirement 1:
Precondition: None.
Test method: Call AbsssTuningParameters (frequency, symbolRate, modulation).
Conformity result: Return the specified AbsssTuningParameters object with frequency as frequency, symbol rate as symbolRate, and polarization method as polarization. | +| | DtmbTuningParameters | | Conformity requirement:
Precondition: Successfully create DtmbTuningParameters object based on testing environment conditions.
Test method: Read and write frequency.
Conformity result: Read/write frequency successfully in kHz. | +| 11 | | frequency | | +| 12 | | modulation | Conformity requirement:
Precondition: Successfully create DtmbTuningParameters object based on testing environment conditions.
Test method: Read and write Modulation.
Conformity result: Read/write Modulation successfully with "QAM" suffix (with space), e.g., 64 QAM. | +| 13 | | codingRatio | Conformity requirement:
Precondition: Successfully create | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|----------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DtmbTuningParameters | | DtmbTuningParameters object based on testing environment conditions.
Test method: Read and write codingRatio.
Conformity result: Read successfully, value is one of "0.4", "0.6", "0.8". | +| 14 | | PNMode | Conformity requirement:
Precondition: Successfully create DtmbTuningParameters object based on testing environment conditions.
Test method: Read and write PNMode.
Conformity result: Read successfully, get frame header pattern. | +| 15 | | DtmbTuningParameters() | Conformity requirement:
Precondition: None.
Test method: Call new DtmbTuningParameters().
Conformity result: Return the DtmbTuningParameters object. | +| 16 | | DtmbTuningParameters(frequency) | Conformity requirement:
Precondition: None.
Test method: Call DtmbTuningParameters(frequency).
Conformity result: Return the specified AbsssTuningParameters object with frequency as frequency. | +| 17 | DvbTune | tune(deliveryType, paramsObj) | Conformity requirement 1:
Precondition: DeliveryType, paramsObj parameters conform to the current environment.
Test method: Call tune(deliveryType, paramsObj).
Conformity result: Frequency lock successful, sending 10001 (MSG_DVB_TUNE_SUCCESS) message to the page. | +| 18 | | getTunerSignalInfo() | Conformity requirement:
Precondition: Call tune(deliveryType, paramsObj) and return lock frequency successful.
Test method: Call getTunerSignalInfo().
Conformity result: The returned string is Tuner information containing signal quality, signal strength, BER, signal level, signal_to_noise ratio. The format is: {signalQuality:XXX,signalStrength:XXX,errorRate:XXX,signalLevel:XXX,signalNoiseRatio:XXX}. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------------|---------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 19 | | getAllTunerInfos() | Conformity requirement:
Precondition: None.
Test method: Call getAllTunerInfos().
Conformity result: Return an array of DvbTunerInfo objects containing all DvbTunerInfo. | +| 20 | DvbTunerInfo | tunerId | Conformity requirement:
Precondition: Successfully create DvbTunerInfo object based on testing environment conditions.
Test method: Read and write tunerId.
Conformity result: Read/write is successful, and parameter type is integer. | +| 21 | | tunerType | Conformity requirement:
Precondition: Successfully create DvbTunerInfo object based on testing environment conditions.
Test method: Read and write tunerType.
Conformity result: Read/write is successful, and parameter type is integer. | +| 22 | DvbScan | startScan(scanType, deliveryType, objArray[]) | Conformity requirement 1:
Precondition: Successfully create DvbCTuningParameters() based on the testing environment conditions.
Test method: Call startScan(scanType, deliveryType, objArray []).
Conformity result: Send a message to the page;
The search will begin and a message MSG_DVB_SCAN_START will be sent to the page;
The current frequency search is complete, If any service is found, send the message MSG_DVB_SCAN_FIND_SERVICES to the page;
If all channels have been searched, send the message MSG_DVB_SCAN_FINISHED to the page;
If no channel is found, send the message MSG_DVB_SCAN_FAILED to the page. | +| 23 | | startScan(pid, tableId, deliveryType, objArray[]) | Conformity requirement 1:
Precondition: Successfully create DvbCTuningParameters() based on the testing environment conditions.
Test method: Call startScan(pid, tableId, deliveryType, objArray []).
Conformity result: Send a message to the page;
The search will begin and a message | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|---------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DvbScan | | MSG_DVB_SCAN_START will be sent to the page;
If all channels have been searched, send the message MSG_DVB_SCAN_FINISHED to the page;
If no channel is found, send the message MSG_DVB_SCAN_FAILED to the page. | +| 24 | | startScan(jsonSIInfo) | Conformity requirement 1:
Precondition: Based on the testing environment conditions, the jsonSIInfo data format is correct.
Test method: Call startScan(jsonSIInfo).
Conformity result: Return 0 and send a message.
The search will begin and a message MSG_DVB_SCAN_START will be sent to the page;
The current frequency search is complete, If any service is found. Send the message MSG_DVB_SCAN_FIND_SERVICES to the page;
If all channels have been searched, send the message MSG_DVB_SCAN_FINISHED to the page;
If no channel is found, send the message MSG_DVB_SCAN_FAILED to the page.
Conformity requirement 2:
Precondition: Based on the testing environment conditions, the jsonSIInfo data format is incorrect.
Test method: Call startScan(jsonSIInfo).
Conformity result: Return -1. | +| 25 | | stopScan() | Conformity requirement 1:
Precondition: Successfully call startScan() based on the testing environment conditions.
Test method: Call stopScan().
Conformity result: Send a message of 10029(MSG_DVB_SCAN_STOP_SUCCESS) to the page.
Conformity requirement 2:
Precondition: Based on the testing environment conditions, startScan() was not successfully called.
Test method: Call stopScan().
Conformity result: Send a message of 10030(MSG_DVB_SCAN_STOP_FAILED) to the page. | +| 26 | | update() | Conformity requirement 1:
Precondition: Receive a message of | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|---------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DvbScan | | 10028(MSG_DVB_SCAN_FIND_SERVICES).
Test method: Call update().
Conformity result: Update the channel list and return the Number type, where 1 indicates update successfully and 0 indicates failed update. | +| 27 | | save() | Conformity requirement 1:
Precondition: Successfully call startScan() based on the testing environment conditions.
Test method: Call save().
Conformity result: Send message of 10101(MSG_DVB_SCAN_SAVE_SUCCESS) or 10102(MSG_DVB_SCAN_SAVE_FAILED) to the page.
Conformity requirement 2:
Precondition: Successfully call update() based on the testing environment conditions.
Test method: Call save().
Conformity result: Send message of 10101(MSG_DVB_SCAN_SAVE_SUCCESS) or 10102(MSG_DVB_SCAN_SAVE_FAILED) to the page. | +| 28 | | revert() | Conformity requirement:
Precondition: None.
Test method: Call revert().
Conformity result: Send message of 10103(MSG_DVB_SCAN_REVERT_SUCCESS) or 10104(MSG_DVB_SCAN_REVERT_FAILED) to the page. | +| 29 | | deleteAll() | Conformity requirement:
Precondition: None.
Test method: Call deleteAll().
Conformity result: Send message of 10105(MSG_DVB_SCAN_DELETE_SUCCESS) or 10106(MSG_DVB_SCAN_DELETE_FAILED) to the page. | + +### B.2 Conformance test of broadcast protocol processing unit interface + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | DvbBroadcast | currentDvbNetwork |
Conformity requirement 1:
Precondition: A one-way live programme is currently playing.
Test method: Read the currentDvbNetwork property interface.
Conformity result: Return the DvbNetwork object corresponding to the current playback channel.
Conformity requirement 2:
Precondition: Have not called to play one-way channel or fail to play one-way channel.
Test method: Read the currentDvbNetwork property interface.
Conformity result: Return NULL.
Conformity requirement 1:
Precondition: A one-way live programme is currently playing.
Test method: Read the currentDvbBouquets property interface.
Conformity result: Return an array of DvbBouquet objects corresponding to the current playback channel.
Conformity requirement 2:
Precondition: Have not called to play one-way channel or fail to play one-way channel.
Test method: Read the currentDvbBouquets property interface.
Conformity result: Return NULL.
Conformity requirement 1:
Precondition: A one-way live programme is currently playing.
Test method: Read the currentDvbTS attribute interface.
Conformity result: Return the DvbTS object corresponding to the current playback channel.
Conformity requirement 2:
Precondition: Have not called to play one-way channel or fail to play one-way channel.
Test method: Read the currentDvbTS attribute interface.
Conformity result: Return NULL.
Conformity requirement 1:
Precondition: A one-way live programme is currently playing.
Test method: Read the currentDvbService property interface.
Conformity result: Return the DvbService object
Conformity requirement 2:
Precondition: Have not called to play one-way channel or fail to play one-way channel.
Test method: Read the currentDvbService property interface.
Conformity result: Return NULL. | +| 5 | | currentDvbMosaic | Conformity requirement 1:
Precondition: A one-way live programme is currently playing.
Test method: Read the currentDvbMosaic property interface.
Conformity result: Return the DvbMosaic object corresponding to the current playback channel.
Conformity requirement 2:
Precondition: Have not called to play one-way channel or fail to play one-way channel.
Test method: Read the currentDvbMosaic property interface.
Conformity result: Return NULL. | +| 6 | | getAllNetworks() | Conformity requirement 1:
Precondition: An automatic search has been performed and successful.
Test method: Call the getAllNetworks() method.
Conformity result: Return an array of DvbNetwork objects with a length greater than 0.
Conformity requirement 2:
Precondition: No automatic search has been performed, or automatic search has failed.
Test method: Call the getAllNetworks() method.
Conformity result: The length of the returned array is 0. | +| 7 | | getAllNetworks(sortOrder) | Conformity requirement 1:
Precondition: An automatic search has been performed and successful.
Test method: Call the getAllNetworks(sortOrder) method to input the specified sorted sortOrder type.
Conformity result: Return an array of DvbNetwork objects of length greater than 0, sorted by the specified method.
Conformity requirement 2:
Precondition: No automatic search has been performed, or automatic search has failed.
Test method: Call the getAllNetworks(sortOrder) method to input the specified sorted sortOrder type.
Conformity result: The length of the returned array is 0. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------------|---------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 8 | DvbBroadcast | getNetwork(network_id) |
Conformity requirement 1:
Precondition: An automatic search has been performed and successful.
Test method: Call the getNetwork(network_id) method to input the specified sorted sortOrder type.
Conformity result: Return the DvbNetwork object with the specified network_id.
Conformity requirement 2:
Precondition: No automatic search has been performed.
Test method: Call the getNetwork(network_id) method to input the specified network_id.
Conformity result: Return NULL.
Conformity requirement 1:
Precondition: An automatic search has been performed and successful.
Test method: Call the getAllBouquets() method.
Conformity result: Return an array of DvbBouquet objects. If no service group object exists (e.g., no BAT table is found in the stream), the returned array has a length of zero.
Conformity requirement 2:
Precondition: No automatic search has been performed.
Test method: Call the getAllBouquets() method.
Conformity result: The length of the returned array is 0.
Conformity requirement 1:
Precondition: The search has been performed successfully.
Test method: Call the getAllBouquets(sortTypeArray[], sortOrderArray[]) method passes in the specified sort type and a specific value number type array.
Conformity result: Return an array of the specified sorted DvbBouquet objects. If no service group object exists (e.g., no BAT table is found in the stream), the returned array is of length zero.
Conformity requirement 2:
Precondition: No search has been performed, or the search has failed.
Test method: Call the getAllBouquets(sortTypeArray[], sortOrderArray[]) method passes in the specified sort type and specific value number array.
Conformity result: The length of the returned array is 0.
Precondition: The live stream should contain Bouquet information, have perform search, and succeed.
Test method: Call the getBouquet(network_id, bouquet_id) method to input the specified value.
Conformity result: Return the DvbBouquet object.
Conformity requirement 2:
Precondition: No search has been performed.
Test method: Call the getBouquet(network_id, bouquet_id) method to input the specified value.
Conformity result: Return NULL.
| +| 12 | | getAllTSs() |Conformity requirement 1:
Precondition: The search has been performed successfully.
Test method: Call the getAllTSs() method.
Conformity result: Return an array of DvbTS objects with a length greater than 0.
Conformity requirement 2:
Precondition: No search has been performed.
Test method: Call the getAllTSs() method.
Conformity result: The length of the returned array is 0.
| +| 13 | | getAllTSs(sortTypeArray[], sortOrderArray[]) |Conformity requirement 1:
Precondition: The search has been performed successfully.
Test method: Call the getAllTSs(sortTypeArray[], sortOrderArray[]) method passes in the specified sort type and specific value number array.
Conformity result: Return the specified sorted DvbTS object array.
Conformity requirement 2:
Precondition: No search has been performed, or search has failed.
Test method: Call the getAllTSs(sortTypeArray[], sortOrderArray[]) method passes in the specified sort type and specific value number array.
Conformity result: The length of the returned array is 0.
| +| 14 | | getTS(network_id, original_network_id, transport_stream_id) |Conformity requirement 1:
Precondition: The search has been performed successfully.
Test method: Call the getTS(network_id, original_network_id, transport_stream_id) method to input the specified value.
Conformity result: Return a DvbTS object. If the specified transport stream object does not exist,
| + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------------|------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DvbBroadcast | | NULL is returned.Conformity requirement 2:
Precondition: No search has been performed.
Test method: Call the getTS(network_id, original_network_id, transport_stream_id) method to input the specified value.
Conformity result: Return NULL. | +| 15 | | getAllServices() | Conformity requirement 1:
Precondition: The search has been performed successfully.
Test method: Call the getAllServices() method.
Conformity result: Return an array of DvbService objects with a length greater than 0.
Conformity requirement 2:
Precondition: The search has not been executed, or it may have failed.
Test method: Call the getAllServices() method.
Conformity result: The length of the returned array is 0. | +| 16 | | getAllServices(sortTypeArray[], sortOrderArray[]) | Conformity requirement 1:
Precondition: The search has been performed successfully.
Test method: Call the getAllServices(sortTypeArray[], sortOrderArray[]) method passes in the specified sort type and specific value number array.
Conformity result: Return an array of DvbService objects that match the specified sort.
Conformity requirement 2:
Precondition: No search has been performed, or automatic search has failed.
Test method: Call the getAllServices(sortTypeArray[], sortOrderArray[]) method passes in the specified sort type and specific value number array.
Conformity result: The length of the returned array is 0. | +| 17 | | getAllMosaics() | Conformity requirement:
Precondition: The search has been performed successfully.
Test method: Call the getAllMosaics() method.
Conformity result: Return all DvbMosaic objects. If there is no mosaic object, NULL is returned. | +| 18 | | getService(network_id, original_network_id, transport_stream_id, service_id) | Conformity requirement:
Precondition: The search has been performed successfully.
Test method: Call the getService(network_id, original_network_id, transport_stream_id, service_id) | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DvbBroadcast | | service_id) method to input the specified values.
Conformity result: Return the DvbTS object. If the specified transport stream object does not exist, NULL is returned.
Conformity requirement 2:
Precondition: No search has been performed.
Test method: Call the getService (network_id, original_network_id, transport_stream_id, service_id) method to input the specified value.
Conformity result: Return NULL. | +| 19 | | getEntryMosaic(network_id) | Conformity requirement:
Precondition: The search has been performed successfully.
Test method: Call the getEntryMosaic (network_id) method to input the specified value.
Conformity result: Return the DvbMosaic object. If there is no mosaic object, NULL is returned.
Conformity requirement 2:
Precondition: No search has been performed.
Test method: Call the getEntryMosaic (network_id) method to input the specified value.
Conformity result: Return NULL. | +| 20 | DvbNetwork | network_id | Conformity requirement:
Precondition: Successfully get DvbNetwork object.
Test method: Read the network_id attribute.
Conformity result: Return the correct value which is the network identifier of a one-way broadcast network of type number. | +| 21 | | network_name | Conformity requirement:
Precondition: The DvbNetwork object is not undefined or NULL.
Test method: Read the network_name attribute.
Conformity result: Return the correct value which is the network name of a one-way broadcast network of type string. | +| 22 | | network_type | Conformity requirement:
Precondition: The DvbNetwork object is not undefined or NULL.
Test method: Read the network_type attribute.
Conformity result: Return the correct value which is the transmission type of a one-way broadcast network of type number. | +| 23 | | getNetworkName() | Conformity requirement:
Precondition: The DvbNetwork object is not undefined or NULL.
Test method: Call the getNetworkName() method.
Conformity result: Return the correct value | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|---------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DvbNetwork | | which is the full name of the network name of type string. | +| 24 | | getShortNetworkName() | Conformity requirement:
Precondition: The DvbNetwork object is not undefined or NULL.
Test method: Call the getShortNetworkName() method.
Conformity result: Return the correct value which is a string type, indicating the network name abbreviation. If there is no network name abbreviation, undefined is returned. | +| 25 | | getAllTSs() | Conformity requirement:
Precondition: The DvbNetwork object is not undefined or NULL.
Test method: Call the getAllTSs() method.
Conformity result: Return an unsorted array of DvbTS objects with a length greater than 0. | +| 26 | | getAllTSs(sortTypeArray[], sortOrderArray[]) | Conformity requirement:
Precondition: The DvbNetwork object is not undefined or NULL.
Test method: Call the getAllTSs (sortTypeArray[], sortOrderArray[]) method passes in the specified sort type and specific value number array.
Conformity result: Return an array of DvbTS objects that match the specified sorting. | +| 27 | | getTS(original_network_id, transport_stream_id) | Conformity requirement:
Precondition: The DvbNetwork object is not undefined or NULL.
Test method: Call the getTS(original_network_id, transport_stream_id) method to input the specified value.
Conformity result: DvbTS object. If the specified transport stream object does not exist, NULL is returned. | +| 28 | | getAllServices() | Conformity requirement:
Precondition: The DvbNetwork object is not undefined or NULL.
Test method: Call the getAllServices() method to input the specified value.
Conformity result: DvbService object array. | +| 29 | | getAllServices(sortTypeArray[], sortOrderArray[]) | Conformity requirement:
Precondition: The DvbNetwork object is not undefined or NULL.
Test method: Call the getAllServices (sortTypeArray[], sortOrderArray[]) method passes in the specified sort type and specific value number array.
Conformity result: Return an array of | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | DvbService objects that match the specified sorting. | +| 30 | | getService(original_network_id, transport_stream_id, service_id) | Conformity requirement:
Precondition: The DvbNetwork object is not undefined or NULL.
Test method: Call the getService(original_network_id, transport_stream_id, service_id) method to input the specified value.
Conformity result: DvbService object. If the specified transport stream object does not exist, NULL is returned. | +| 31 | | network_id | Conformity requirement:
Precondition: DvbBouquet object is not undefined or NULL.
Test method: Read the network_id attribute.
Conformity result: Return the correct value and is a one-way broadcast network identifier of type number. | +| 32 | | bouquet_id | Conformity requirement:
Precondition: DvbBouquet object is not undefined or NULL.
Test method: Read the bouquet_id attribute.
Conformity result: Return the correct value which is a one-way broadcast service group identifier of type number. | +| 33 | | bouquet_name | Conformity requirement:
Precondition: DvbBouquet object is not undefined or NULL.
Test method: Read the bouquet_name attribute.
Conformity result: Return the correct value which is a one-way broadcast service group name of type number. | +| 34 | DvbBouquet | getBouquetName() | Conformity requirement:
Precondition: DvbBouquet object is not undefined or NULL.
Test method: Call the getBouquetName() method.
Conformity result: Return the correct value which is the full name of the service group of type string. The full service group name is taken from the bouquet_name_descriptor descriptor or from the multilingual_bouquet_name_descriptor descriptor. If the language_encoded full name of the service group is not available from the bouquet_name_descriptor or multilingual_bouquet_name_descriptor descriptor, the full name of the service group carried in the bouquet_name_descriptor is returned by default. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|---------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 35 | DvbBouquet | getShortBouquetName() | Conformity requirement:
Precondition: DvbBouquet object is not undefined or NULL.
Test method: Call the getShortBouquetName() method.
Conformity result: Return the correct value which is a service group name abbreviation of type string. If the service group name abbreviation does not exist, undefined is returned. | +| 36 | | getAllTSs() | Conformity requirement:
Precondition: DvbBouquet object is not undefined or NULL.
Test method: Call the getAllTSs() method.
Conformity result: Return all DvbTS objects in the current service group object, without sorting an array of DvbTS objects. | +| 37 | | getAllTSs(sortTypeArray[], sortOrderArray[]) | Conformity requirement:
Precondition: DvbBouquet object is not undefined or NULL.
Test method: Call the getAllTSs (sortTypeArray[], sortOrderArray[]) method passes in the specified sort type and specific value number array.
Conformity result: Return an array of DvbTS objects that match the specified sorting. | +| 38 | | getTS(original_network_id, transport_stream_id) | Conformity requirement:
Precondition: The DvbBouquet object is not undefined or NULL, and the passed parameters exist under the Bouquet.
Test method: Call getTS(original_network_id, transport_stream_id).
Conformity result: Return DvbTS objects that match the set value. | +| 39 | | getAllServices() | Conformity requirement:
Precondition: The DvbBouquet object is not undefined or NULL, and there is a channel list described under this object.
Test method: Call the getAllServices() method.
Conformity result: Get an array of DvbService objects in the current service group that are not sorted. | +| 40 | | getAllServices(sortTypeArray[], sortOrderArray[]) | Conformity requirement:
Precondition: The DvbBouquet object is not undefined or NULL, and there is a channel list described under this object.
Test method: Call getAllServices (sortTypeArray[], sortOrderArray[]).
Conformity result: Return DvbTS objects that | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | match the set value. | +| 41 | DvbBouquet | getService(original_network_id, transport_stream_id, service_id) | Conformity requirement:
Precondition: The DvbBouquet object is not undefined or NULL, and this passed in parameter describes a channel under the object.
Test method: Call getService (original_network_id, transport_stream_id, service_id).
Conformity result: Return DvbTS objects that match the set value. | +| 42 | | network_id | Conformity requirements:
Precondition: DvbTS object is not undefined or NULL.
Test method: Read the network_id attribute.
Conformity result: Return the network ID of the transport stream, which is of type number. | +| 43 | DvbTS | original_network_id | Conformity requirements:
Precondition: DvbTS object is not undefined or NULL.
Test method: Read the original_network_id attribute.
Conformity result: Return the network ID of the transport stream, which is of type number. | +| 44 | | transport_stream_id | Conformity requirements:
Precondition: DvbTS object is not undefined or NULL.
Test method: Read the transport_stream_id attribute.
Conformity result: Return the ID of the transport stream, which is of type number. | +| 45 | | deliveryType | Conformity requirements:
Precondition: DvbTS object is not undefined or NULL.
Test method: Read the deliveryType attribute.
Conformity result: Return the type of transmission system, with values defined in the constant "DVB Transmission System Type", which is of type number. | +| 46 | | dvbsTuningParams | Conformity requirements:
Precondition: DvbTS object is not undefined or NULL.
Test method: Read the dvbsTuningParams attribute.
Conformity result: Indicate the DVB_S tuning demodulation parameter. Note: This attribute is valid when deliveryType is DVB_DELIVERY_TYPE_DVB_S. which is of type dvbsTuningParams, and dvbsTuningParam object of return value. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 47 | DvbTS | dvbtTuningParams |
Conformity requirements:
Precondition: DvbTS object is not undefined or NULL.
Test method: Read the dvbtTuningParams attribute.
Conformity results: Indicate the DVB_T tuning demodulation parameter. Note: This attribute is valid when deliveryType is DVB_DELIVERY_TYPE_DVB_T. which is of type dvbtTuningParams, and dvbtTuningParams object of return value.
Conformity requirements:
Precondition: DvbTS object is not undefined or NULL.
Test method: Read the dvbcTuningParams attribute.
Conformity results: Indicate the DVB_C tuning demodulation parameter. Note: This attribute is valid when deliveryType is DVB_DELIVERY_TYPE_DVB_C. which is of type dvbcTuningParams, and dvbcTuningParams object of return value.
Conformity requirements:
Precondition: DvbTS object is not undefined or NULL.
Test method: Read the absssTuningParams attribute.
Conformity results: Indicate the ABS_SS tuning demodulation parameter. Note: This attribute is valid when deliveryType is DVB_DELIVERY_TYPE_ABS_SS. which is of type absssTuningParams, and absssTuningParams object of return value.
Conformity requirements:
Precondition: DvbTS object is not undefined or NULL.
Test method: Read the dtmbTuningParams attribute.
Conformity results: Indicate the DTMB tuning demodulation parameter. Note: This attribute is valid when deliveryType is DVB_DELIVERY_TYPE_DTMB. which is of type dtmbTuningParams, and dtmbTuningParams object of return value.
Conformity requirement 1:
Precondition: DvbTS object is not undefined or NULL. The frequency of the current DvbTS has been locked.
Test method: Read the signalQuality attribute.
Conformity result: The value range of the signal
Conformity requirement 2:
Precondition: DvbTS object is not undefined or NULL. The current frequency of DvbTS is not locked.
Test method: Read the signalQuality attribute.
Conformity result: The return value is 0. | +| 52 | | signalStrength | Conformity requirement 1:
Precondition: DvbTS object is not undefined or NULL. The frequency of the current DvbTS has been locked.
Test method: Read the signalStrength attribute.
Conformity result: Return the signal strength of the frequency where the transmission stream is located, the value range is 0 to 100 and 0 means the worst signal, 100 means the best signal.
Conformity requirement 2:
Precondition: DvbTS object is not undefined or NULL. The current frequency of DvbTS is not locked.
Test method: Read the signalStrength attribute.
Conformity result: The return value is 0. | +| 53 | | errorRate | Conformity requirement 1:
Precondition: DvbTS object is not undefined or NULL. The frequency of the current DvbTS has been locked.
Test method: Read the errorRate attribute.
Conformity result: Return the error rate of the frequency where the transport stream is located.
Conformity requirement 2:
Precondition: DvbTS object is not undefined or NULL. The current frequency of DvbTS is not locked.
Test method: Read the errorRate attribute.
Conformity result: The return value is 0. | +| 54 | DvbTS | signalLevel | Conformity requirement 1:
Precondition: DvbTS object is not undefined or NULL. The frequency of the current DvbTS has been locked.
Test method: Read the signalLevel attribute.
Conformity result: Return the signal level at the frequency where the transport stream is located.
Conformity requirement 2:
Precondition: DvbTS object is not undefined or NULL. The current frequency of DvbTS is not locked.
Test method: Read the signalLevel attribute. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|---------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 55 | | signalNoiseRatio |
Conformity result: The return value is 0.
Conformity requirement 1:
Precondition: DvbTS object is not undefined or NULL. The frequency of the current DvbTS has been locked.
Test method: Read the signalNoiseRatio attribute.
Conformity result: Return the signal_to_noise ratio of the frequency where the transport stream is located.
Conformity requirement 2:
Precondition: The DvbTS object is not undefined or NULL, and the frequency of the current DvbTS is not locked.
Test method: Read the signalNoiseRatio attribute.
Conformity result: The return value is 0.
Conformity requirement 1:
Precondition: DvbTS object is not undefined or NULL.
Test method: Call the getAllServices() method.
Conformity result: Return an unsorted array of all DvbService objects in the current transport stream.
Conformity requirement 1:
Precondition: DvbTS object is not undefined or NULL.
Test method: Call getAllServices(sortTypeArray[], sortOrderArray[]).
Conformity result: Return an array of DvbTS objects that match the set sorting rules.
Conformity requirement 1:
Precondition: The DvbTS object is not undefined or NULL. Fill in the correct service_id under that DvbTS.
Test method: Call getServiceByID (service_id).
Conformity result: Return the DvbService object.
Conformity requirement 2:
Precondition: DvbTS object is not undefined or NULL. Fill in a service_id that is not under the DvbTS.
Test method: Call getServiceByID (service_id).
Conformity result: The return value is null.
Conformity requirement 1:
Precondition: DvbTS object is not undefined or NULL. Fill in the service_type that belongs to the channel under this DvbTS.
Test method: Call getServicesByType
Conformity result: Return an array of DvbService objects.
Conformity requirement 2:
Precondition: If the DvbTS object is not undefined or NULL, fill in the service_type that does not belong to the channel list under that DvbTS.
Test method: Call getServicesByType (service_type).
Conformity result: The returned array length is 0 | +| 60 | DvbService | network_id | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Read the network_id attribute.
Conformity result: Return the network ID of the service which is of type: number. | +| 61 | | original_network_id | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Read the original_network_id attribute.
Conformity result: Return the network ID of the service which is of type: number. | +| 62 | | transport_stream_id | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Read the transport_stream_id attribute.
Conformity result: Return the transport stream ID of the service, which is of type number. | +| 63 | | service_id | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Read the service_id attribute.
Conformity result: Return the service ID of type: number. | +| 64 | | service_name | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Read the service_name attribute.
Conformity result: Return the service name which is of type: string. | +| 65 | | service_type | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Read the service_type attribute
Conformity result: Return the value of the | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DvbService | | service type, see the definition of the "service type" constant, which is of type number. | +| 66 | | service_provider_name | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Read the service_provider_name attribute.
Conformity result: The name of the service provider, which is of type string. | +| 67 | | running_status | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Read the running_status attribute.
Conformity result: Return any of the following service operation status, with a value:
– 0 is undefined;
– 1 is not running;
– 2 Start after a few seconds (such as recording);
– 3. Pause;
– 4 Operation;
– 5.7 reserved for use.
Note– For NVOD service, running_status equal to 0. | +| 68 | | EIT_present_following_flag | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Read the EIT_present_following_flag attribute.
Conformity result: Return whether the current/subsequent information of the service exists in the current transport stream, with a value of:
– True indicates that the current/subsequent information of the service's EIT exists in the current transport stream;
– False indicates that the current/subsequent information of the service's EIT is not in the current transport stream. The type is: boolean. | +| 69 | | EIT_schedule_flag | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Read the EIT_schedule_flag attribute.
Conformity result: Return whether the EIT schedule information of the service exists in the current transport stream, with a value of:
– True indicates that the EIT schedule information of the service exists in the current | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DvbService | | transmission.
– False indicates that the EIT schedule information of the service is not in the current transport stream. The type is: boolean. | +| 70 | | free_CA_mode | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Read the free_CA_mode attribute.
Conformity result: Return whether the service has been tampered with, with a value of:
– True indicates that the reception of one or more true code streams is controlled by the CA system;
– False indicates that the all components of the false service have not been scrambled. The type is: boolean. | +| 71 | | bouquetIDs | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Read the bouquetIDs attribute.
Conformity result: Return an array of the IDs of all the service groups to which the service belongs, sorted in ascending order by bouquet_id. The type is number Array. | +| 72 | | referServiceIDs | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Read the referServiceIDs attribute.
Conformity result: Return the service_id of the service reference service. if service_type equal to SERVICE_TYPE_NVOD_SHIFT, the service_id of the corresponding reference service can be obtained by using this attribute, otherwise this attribute returns undefined. The type is number | +| 73 | | timeShiftServiceIDs | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Read the timeShiftServiceIDs attribute.
Conformity result: Return the service_id of all time_shifted services corresponding to the service. if service_type equal to SERVICE_TYPE_NVOD_REF, the service_id of all time_shifted services corresponding to the service can be obtained by this attribute; otherwise, this attribute returns undefined. The type is numberArray. | +| 74 | | curVideoObj | Conformity requirements:
Precondition: The DvbService object is not | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DvbService | | undefined or NULL, and this channel is being played.
Test method: Read the curVideoObj attribute.
Conformity result: Return the video ES currently being played by the service. The type is DvbVideoES object. | +| 75 | | curAudioObj | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL, and this channel is being played.
Test method: Read curAudioObj Properties.
Conformity result: Return the audio ES currently being played by the service. The type is DvbAudioES object. | +| 76 | | PCRPID | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Read the PCRPID attribute.
Conformity result: Return the PCR PID of the service reference. The type is: number. | +| 77 | | getServiceName() | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL, and this channel is being played.
Test method: Call the getServiceName() method.
Sex result: Return the full name of the service. The type is: string type. | +| 78 | | getShortServiceName() | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Call the getShortServiceName() method.
Conformity result: Return the abbreviation of the service name, with a type of string. If the service name abbreviation does not exist, return undefined. | +| 79 | | getLocation() | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Call the getLocation() method.
Conformity result: Return the service location described by the three elements of original_network_id, transport_stream_id, and service_id. | +| 80 | | getEvents(start, end) | Conformity requirements:
Precondition: DvbService object is not undefined or NULL, and the passed in start,end can cover the time period.
Test method: Call the getEvents(start, end) | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | method.
Conformity result: Return an array of DvbEvent objects. If the specified object does not exist, the returned array length is 0. | +| 81 | | getVideoESs() | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Call the getVideoESs() method.
Conformity result: Return an array of DvbVideoES objects for all video streams (of any video format type) contained in this service. If there is no such object, the length of the returned array is 0. | +| 82 | | getAudioESs() | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Call the getAudioESs() method.
Conformity result: Return an array of (with any audio format type) DvbAudioES objects for all audio streams contained in this service. If there is no such object, the returned array is of length 0. | +| 83 | | getOtherESs() | Conformity requirements:
Precondition: The DvbService object is not undefined or NULL.
Test method: Call the getOtherESs() method.
Conformity result: Return an array of DvbOtherES objects for all non_audio/video streams contained in this service. If there is no such object, the length of the returned array is 0. | +| 84 | | stream_type | Conformity requirements:
Precondition: DvbVideoES object is not undefined or NULL.
Test method: Read the stream_type attribute.
Conformity result: Return the type of the elementary stream of the video, with a value of:
– 0x01
– 0x02
The type is: number. | +| 85 | DvbVideoES | elementary_PID | Conformity requirements:
Precondition: DvbVideoES object is not undefined or NULL.
Test method: Read the elementary_PID attribute.
Conformity result: Return the PID transport stream that carries the elementary stream of the video. The type is number. | +| 86 | | component_tag | Conformity requirements:
Precondition: DvbVideoES object is not undefined or NULL.
Test method: Read the component_tag attribute. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Conformity result: Return the identification of the video stream component. The system shall obtain information from the stream_identifier_descriptor associated with this elementary stream, or set to -1 by default if there is no information available. The type is number. | +| 87 | DvbAudioES | stream_type | Conformity requirements:
Precondition: DvbAudioES object is not undefined or NULL.
Test method: Read the stream_type attribute.
Conformity result: Return the type of the audio elementary stream, with a value of:
– 0x03
– 0x04
The type is number. | +| 88 | | elementary_PID | Conformity requirements:
Precondition: DvbAudioES object is not undefined or NULL.
Test method: Read the elementary_PID attribute.
Conformity result: Return the PID transport stream that carries the audio elementary stream. The type is number. | +| 89 | | component_tag | Conformity requirements:
Precondition: DvbAudioES object is not undefined or NULL.
Test method: Read the component_tag attribute.
Conformity result: Return the identification of the audio component.
The system shall obtain information from the stream_identifier_descriptor associated with this elementary stream, and if no information is available, the default is set to -1. The type is number. | +| 90 | | lingual | Conformity requirements:
Precondition: DvbAudioES object is not undefined or NULL.
Test method: Read the lingual attribute.
Conformity result: Return the audio language, and the three_letter code for languages follows the [ISO 639]. The type is: string. | +| 91 | DvbOtherES | stream_type | Conformity requirements:
Precondition: DvbOtherES object is not undefined or NULL.
Test method: Read the stream_type attribute.
Conformity result: Return the type of this elementary stream, with values other than 0x01, 0x02, 0x03, and 0x04 that are allowed. The type is number. | +| 92 | | elementary_PID | Conformity requirements: | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|----------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 93 | | | Precondition: DvbOtherES object is not undefined or NULL.
Test method: Read the elementary_PID attribute.
Conformity result: Return the PID transport stream carrying the elementary stream. The type is number. | +| | | component_tag | Conformity requirements:
Precondition: DvbOtherES object is not undefined or NULL.
Test method: Read the component_tag attribute.
Conformity result: Return the component identification. The system should obtain information from the stream_identifier_descriptor associated with the elementary stream. If there is no available information, it is set to -1 by default. The type is number. | +| 94 | DvbEvent | network_id | Conformity requirements:
Precondition: The DvbEvent object is not undefined or NULL.
Test method: Read the network_id attribute.
Conformity result: Return the network ID to which the programme event belongs. The type is number. | +| 95 | | original_network_id | Conformity requirements:
Precondition: The DvbEvent object is not undefined or NULL.
Test method: Read the original_network_id attribute.
Conformity result: Return the original network ID to which the programme event belongs. The type is number. | +| 96 | | transport_stream_id | Conformity requirements:
Precondition: The DvbEvent object is not undefined or NULL.
Test method: Read the transport_stream_id attribute.
Conformity result: Return the transport stream ID to which the programme event belongs. The type is: number. | +| 97 | | service_id | Conformity requirements:
Precondition: The DvbEvent object is not undefined or NULL.
Test method: Read the service_id attribute.
Conformity result: Return the business ID to which the programme event belongs. The type is number. | +| 98 | | event_id | Conformity requirements:
Precondition: The DvbEvent object is not | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|----------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DvbEvent | | undefined or NULL.
Test method: Read the event_id attribute.
Conformity result: Return the business ID to which the programme event belongs. The type is number. | +| 99 | | event_name | Conformity requirements:
Precondition: The DvbEvent object is not undefined or NULL.
Test method: Read the event_name attribute.
Conformity result: Return the name of the programme event. The type is string. | +| 100 | | event_description | Conformity requirements:
Precondition: The DvbEvent object is not undefined or NULL.
Test method: Read the event_description attribute.
Conformity result: Programme event description, which is of type string. | +| 101 | | running_status | Conformity requirements:
Precondition: The DvbEvent object is not undefined or NULL.
Test method: Read the running_status attribute.
Conformity result: Return the running status of the programme event, with a value of:
– 0 is undefined;
– 1 is not running;
– 2 Start after a few seconds (such as recording);
– 3. Pause;
– 4 Operation;
– 5_7 reserved for use.
Note – For NVOD reference programme events, running_status equal to 0. The type is number. | +| 102 | | startDate | Conformity requirements:
Precondition: The DvbEvent object is not undefined or NULL.
Test method: Read the startDate attribute.
Conformity result: Return the start date of the event playback in the format "YYYY_MM_DD". The type is string. | +| 103 | | startTime | Conformity requirements:
Precondition: The DvbEvent object is not undefined or NULL.
Test method: Read the startTime property.
Conformity result: Return the start time of the event playback in the format "hh: mm: ss". The type is string. | +| 104 | | duration | Conformity requirements: | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|----------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DvbEvent | | Precondition: The DvbEvent object is not undefined or NULL.
Test method: Read the duration attribute.
Conformity result: Return the duration of the event playback in seconds. The type is number. | +| 105 | | endDate | Conformity requirements:
Precondition: The DvbEvent object is not undefined or NULL.
Test method: Read the endDate attribute.
Conformity result: Return the end date of the event playback in the format of "YYYY_MM_DD". The type is string. | +| 106 | | endTime | Conformity requirements:
Precondition: The DvbEvent object is not undefined or NULL.
Test method: Read the endTime attribute.
Conformity result: Return the end time of the event playback in the format "hh: mm: ss". The type is string. | +| 107 | | content_nibble | Conformity requirements:
Precondition: The DvbEvent object is not undefined or NULL.
Test method: Read the content_nibble attribute.
Conformity result: Return the event classification value (8 bits), of which the upper 4 bits are the primary programme content classification value (content_nibble_level_1) and the lower 4 bits are the secondary programme content classification value (content_nibble_level_2). The type is number. | +| 108 | | user_nibble | Conformity requirements:
Precondition: The DvbEvent object is not undefined or NULL.
Test method: Read the content_nibble attribute.
Conformity result: Return the classification value (8 bits), of which the upper 4 bits are the first_level programme content classification value (content_nibble_level_1) and the lower 4 bits are the second_level programme content classification value (content_nibble_level_2). The type is number.
Conformity requirements:
Precondition: The DvbEvent object is not undefined or NULL.
Test method: Read the user_nibble attribute.
Conformity result: Return the classification value (8 bits) defined by the operator of the event, of which the upper 4 bits are the first_level programme content classification value (content_nibble_level_1) and the lower 4 bits are | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | the second_level programme content classification value (content_nibble_level_2). The type is number. | +| 109 | | minAge | Conformity requirements:
Precondition: The DvbEvent object is not undefined or NULL.
Test method: Read the minAge attribute.
Conformity result: Return the minimum age at which the event can be watched. The type is number. | +| 110 | | free_CA_mode | Conformity requirements:
Precondition: The DvbEvent object is not undefined or NULL.
Test method: Read the free_CA_mode attribute.
Conformity result: Return whether the event has been scrambled , with a value of:
– True scrambled;
– False not scrambled.
The type is number. | +| 111 | | getEventName() | Conformity requirements:
Precondition: The DvbEvent object is not undefined or NULL.
Test method: Call the getEventName() method.
Conformity result: Return the full name of the programme event that represents the event. The type is string. | +| 112 | | getShortEventName() | Conformity requirements:
Precondition: The DvbEvent object is not undefined or NULL.
Test method: Call the getShortEventName() method.
Conformity result: Return the abbreviated name of the event programme that represents the event. The type is string. If the event name abbreviation does not exist, return undefined. | +| 113 | | getEventDescription() | Conformity requirements:
Precondition: The DvbEvent object is not undefined or NULL.
Test method: Call the getEventDescription() method.
Conformity result: Return the description information indicating the event of the program. The programme event description information is obtained from the short_event_descriptor description, and this method shall return programme event description information that matches the user's preferred language. The type is string. | +| 114 | | getLocation() | Conformity Requirement. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Precondition: the DvbEvent object is not undefined or NULL.
Test method: call getLocation() method.
Conformance result: Return an event locator indicating that the programme is described by the four elements original_network_id, transport_stream_id, service_id, and event_id. The type is string. | + +### B.3 Conformance test of two-way broadband network access unit interface + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|-----------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Broadband | getAllEthernets() | Conformity requirement 1:
Precondition: Receiving terminal access to two-way broadband network.
Test method: Call the getAllEthernets() interface
Conformity result: Return an array of Ethernet objects, where the receiving terminal successfully gets all Ethernet objects, and the number matches the actual number. | +| 2 | | ping(address, parameter) | Conformity requirement 1:
Precondition: Receiving terminal access to two-way broadband network.
Test method: Call the ping(address, parameter) interface, where address is assigned to the correct IP address or domain name, and parameter is the ping parameter.
Conformity result: Every once in a while (without stopping), a response message can be received and a successful ping message description string can be obtained.
Conformity requirement 2:
Precondition: Receiving terminal access to two-way broadband network.
Test method: Call ping(address, parameter) interface, where address is assigned to the correct IP address or domain name, and parameter is the parameter of ping.
Every once in a while (without stopping), a response message can be received and a failed ping message description string can be obtained. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|-----------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3 | Broadband | cancelPing() |
Conformity requirement 1:
Precondition: The receiving terminal is connected to a two-way broadband network; The ping method has not been called yet.
Test method: Call the cancelPing() function.
Conformity result: CancelPing returns 0, indicating that the current ping operation has ended or there is currently no ping operation.
Conformity requirement 2:
Precondition: The receiving terminal is connected to a two-way broadband network; The ping method has been called.
Test method: Call the cancelPing() function.
Conformity result: CancelPing returns 1, indicating that the executing ping operation has been stopped.
Conformity requirement 1:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Use the correct target network address (IPv4 or IPv6 type address) to call the queryNetworkState(targetAddress) function.
Conformity result: Be able to receive MSG_BROADBAND_GET_NETWORK_STATE message, and get the message description string through Utility.getEventInfo(id) which describes the connection status between the current network and the target network.
Conformity requirement 2:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Call the queryNetworkState(targetAddress) function with the wrong target network address (IPv4 or IPv6 type address).
Conformity result: Be able to receive the MSG_BROADBAND_GET_NETWORK_STATE message, and get the message description string through Utility.getEventInfo(id), which describes the current network disconnection status.
Conformity requirement 1:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Select the correct device type and call the getDeviceState(device) function.
Conformity result: getDeviceState returns a status value that matches the actual state of the current device.
Conformity requirement 2:
Precondition: The receiving terminal is
connected to a two-way broadband network.
Test method: Select a device type that does not exist and call the getDeviceState(device) function.
Conformity result: getDeviceState returns a status value that matches the actual state of the current device.
NTPUpdate() | Conformity requirement 1:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Modify the system display time forward and call the NTPUpdate() function.
Conformity result: NTPUpdate returns success, and application receives a message that synchronization of network time is successful, and the system time is displayed as the correct time.
Conformity requirement 2:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Modify the display time backwards and call the NTPUpdate() function.
Conformity result: NTPUpdate returns success, and the application receives a message that synchronization network time is successful, and the system time is displayed as the correct time.
save() | Conformity requirement 1:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Modify the IP settings parameters and call the save() function.
Conformity result: The application receives the SAVE success message, and after restarting, the modified parameters match the actual modified values.
Conformity requirement 2:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Modify other related settings and parameters, and call the save() function.
Conformity result: The application receives the SAVE success message, and after restarting, the modified parameters match the actual modified values.
Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network and there is a portal server in the network environment.
Test method: Get the IP address of the portal server Broadband.portalIP variable.
Conformity result: Be able to get the portal server address portalIP successfully which matches the actual value.
Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network and there is a portal server in the network environment.
Test method: Get the service port number of the portal server Broadband.portalPort variable.
Conformity result: Be able to get portal server service port portalPort property successfully which matches the actual value
Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network and there is an application download server in the network environment.
Test method: Obtain the IP address Broadband.appServerIP variable of the application download server.
Conformity result: Be able to get the application server IP address appServerIP property successfully which matches the actual value.
Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network and there is an application download server in the network environment.
Test method: Obtain the Broadband.appServerPort variable from the application download server service port.
Conformity result: Be able to get the appServerPort property of the application download server service port successfully which matches the actual value.
Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the terminal device identification hostname Broadband.host variable.
Conformity result: The terminal device
Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Obtain the Boradband.workGroup variable that the network belongs to.
Conformity result: The workGroup attribute to which the network belongs can be successfully obtained and matches the actual value.
Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the Ethernet.enableFlag variable for whether the network card is available or not.
Conformity result: The network card status variable enableFlag is successfully obtained and matches the actual value.
Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the Ethernet.DHCPflag variable for the DHCP status of the network card.
Conformity result: The DHCP status variable DHCPflag of the network card is successfully obtained and matches the actual value.
Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the Ethernet.DHCPAutoGetDNS variable for network card to automatically get the status of the DNS.
Conformity result: The variable DHCPAutoGetDNS for the network card to automatically get domain name system (DNS) status is obtained successfully and matches the actual value.
Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the Ethernet.description variable for the network card description information.
Conformity result: The description attribute of the network card description information is successfully obtained, and its attribute value matches the actual network card information.
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the physical address of the network card Ethernet.MACAddress variable.
Conformity result: The MACAddress attribute of the physical address of the network card is successfully read, and the attribute value matches the actual physical address of the network card. | +| 19 | | IPs | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the Ethernet.Ips variable for the network IP address group.
Conformity result: The IPs attribute of the network card address group is successfully read, and its attribute value matches the actual IP address group. | +| 20 | | DNSs | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the Ethernet.DNSs variable for the DNS server address group of the network card.
Conformity result: The DNSs attribute of the DNS server address group is obtained successfully, and both the number of DNS server IP address arrays are obtained and their IP addresses match the actual ones. | +| 21 | | DHCPip | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the Ethernet.DHCPip variable of the IP object to which the network card is dynamically assigned.
Conformity result: The DHCPip attribute of the dynamically assigned to IP object is successfully read, and its attribute value matches the actual value. | +| 22 | | communicateWay | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the Ethernet.communicateWay variable that indicates the network bandwidth and communication method.
Conformity result: The communicateWay attribute, which indicates the network bandwidth and communication method, is read successfully | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|----------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | and matches the actual value. | +| 23 | | LANStatus | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the Ethernet.LANStatus variable for the status of the network connection.
Conformity result: When the network is connected normally, the value of LANStatus is 1; When the network is not connected, the value of LANStatus is 0. | +| 24 | | sentPackages | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the Ethernet.sentPackages variable for the number of network packets sent by the network card.
Conformity result: The network card successfully read the sendPackets attribute when sending network packets, and its attribute value matches the actual number of packets sent. | +| 25 | Ethernet | receivedPackages | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the Ethernet.receivedPackages variable for the number of network packets received by the network card.
Conformity result: The receivedPackages property of the network packets received by the NIC is read successfully, and its attribute value matches the actual number of received packets. | +| 26 | | currentConnectionType | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the Ethernet.currentConnectionType variable for the current network card network connection type.
Conformity result: The currentConnectionType attribute of network connection type is successfully read, and its attribute value matches the actual value. | +| 27 | | addIP(ip) | Conformity requirement 1:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Fill in the correct address, mask, and gateway, and call the addIP(ip) function.
Conformity result: addIP returns success, and the IP object is successfully added to the network card.
Conformity requirement 2: | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|----------|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Fill in incorrect address, mask, gateway, and call the addIP (ip) function.
Conformity result: addIP returns failure, IP object fails to be added. | +| 28 | Ethernet | setDNS(index, dns) | Conformity requirement 1:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Select the DNS server index, fill in the correct DNS IP address dns, and call the setDNS(index, dns) function.
Conformity result: The DNS server address in the DNS IP array that corresponds to the one that was modified is the same as the one that is filled in.
Conformity requirement 2:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Select the DNS server index, fill in the incorrect DNS IP address dns, and call the setDNS(index, dns) function.
Conformity result: The DNS server address in the DNS IP array that corresponds to the modified DNS server remains the same as it was before the modification. | +| 29 | | deleteIPByIndex(index) | Conformity requirement 1:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Fill in the correct IP array index and call the deleteIPByIndex(index) function.
Conformity result: deleteIPByIndex returns success, and the IP object can be deleted successfully.
Conformity requirement 2:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Fill in the wrong IP array index and call the deleteIPByIndex(index) function.
Conformity result: deleteIPByIndex returns failure, IP object fails to be deleted. | +| 30 | | deleteIPByAddress(address) | Conformity requirement 1:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Fill in the correct IP address and call the deleteIPByAddress(address) function.
Conformity result: deleteIPByAddress returns success, and the IP object can be deleted successfully.
Conformity requirement 2: | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|----------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Ethernet | | Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Fill in the wrong IP address and call the deleteIPByAddress(address) function.
Conformity result: deleteIPByAddress returns a failure, the IP object fails to be deleted. | +| 31 | | submitParameters() | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Modify the network settings parameters and call the submitParameters() function.
Conformity result: Be able to receive the message of successful submission of configuration parameters, and the network parameters read out are consistent with the parameters submitted for modification. | +| 32 | | DHCPLeaseObtained | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network and there is a DHCP server in the network.
Test method: Enable DHCP mode on the network card and obtain the start time for renting IP addresses via Ethernet.DHCPLeaseObtained variable.
Conformity result: The DHCPLeaseObtained string for DHCP lease IP address start time is successfully read, and its attribute value matches the actual value. | +| 33 | | DHCPLeaseExpires | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network and there is a DHCP server in the network.
Test method: Enable DHCP mode on the network card and obtain the end time of the leased IP address via Ethernet.DHCPLeaseExpires variable.
Conformity result: Successfully read the DHCPLeaseExpires attribute for the end time of the leased IP address, and its attribute value matches the actual one. | +| 34 | | DHCPServer | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network and there is a DHCP server in the network.
Test method: Get the IP address or domain name Ethernet of the DHCP server from the Ethernet.DHCPServer variable.
Conformity result: The DHCPServer attribute of the DHCP server address in the network is read successfully and its attribute value matches the | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | actual. | +| 35 | | DHCPPort |
Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network and there is a DHCP server in the network.
Test method: Get the Ethernet.DHCPPort variable for the port number on the network where the DHCP server is providing service.
Conformity result: The DHCP attribute for the work net port number where the DHCP server is providing service is successfully read, and its attribute value matches the actual value.
Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the Ethernet.HTTPProxy variable of the web proxy service object.
Conformity result: The HTTPProxy property of the web proxy object is successfully read, and its property value matches the actual value.
Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the Ethernet.HTTPSProxy variable of the web proxy service object.
Conformity result: The HTTPSProxy property of the web proxy object is successfully read, and its property value matches the actual value.
Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the Ethernet.FTPProxy variable of the FTP proxy service object.
Conformity result: The FTPProxy attribute of the FTP proxy server object is successfully obtained, and its attribute value matches the actual value.
Conformity requirements:
Precondition: The receiving terminal is in a wireless network environment.
Test method: Call the getAPs() function.
Conformity result: The getAPs returns an array of actual AP information that matches the actual one.
Conformity requirements:
Precondition: The receiving terminal is in a wireless network environment.
Test method: Fill in the maximum scan count and scan timeout, call
Conformity result: Get the maximum number of surrounding AP information within the specified time, which is consistent with the actual situation. | +| 41 | | connectAP(essId, keyType, key) | Conformity requirement 1:
Precondition: The receiving terminal is in a wireless network environment.
Test method: Use the AP information to be connected, call the connectAP(essId, keyType, key) function.
Conformity result: Receive a successful connection message, connect to the AP successfully, and be able to communicate in both directions.
Conformity requirement 2:
Precondition: The receiving terminal is in a wireless network environment.
Test method: Use incorrect information, call the connectAP(essId, keyType, key) function.
Conformity result: Receive connection failure message, fail to connect to AP, be unable to communicate in both directions. | +| 42 | | disconnectAP() | Conformity requirements:
Precondition: The receiving terminal is connected to the wireless network environment.
Test method: Call the disconnectAP() function.
Conformity result: The disconnectAP returns success, network connection disconnects successfully. | +| 43 | | getConnectedAP() | Conformity requirements:
Precondition: The receiving terminal is connected to the wireless network environment.
Test method: Call the getConnectedAP() function to obtain the connection AP information.
Conformity result: The getConnectedAP returns the AP object, and gets information about the connected APs that match the actual situation. | +| 44 | AP | essId | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network and a wireless network.
Test method: Get the AP.essId variable of the connected hotspot.
Conformity result: The essID attribute of the AP is successfully obtained and matches the actual value. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 45 | | signalStrength | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network and a wireless network.
Test method: Get the AP.signalStrength variable for the hotspot signal strength.
Conformity result: The signalStrength variable for signal strength is successfully obtained and is consistent with the actual value. | +| 46 | | linkQuality | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network and a wireless network.
Test method: Get the AP.linkQuality variable for hotspot connection quality.
Conformity result: The linkQuality variable for link quality is successfully obtained and matches the actual value. | +| 47 | | encType | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network and a wireless network.
Test method: Get the AP.encType variable for the hotspot authentication encryption type.
Conformity result: The encType variable for hotspot authentication encryption type is successfully read and matches the actual situation. | +| 48 | IP | address | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the IP.address variable and print it.
Conformity result: Be able to read the property address for the IP object, which is the same as the actual IP address of the system. | +| 49 | | mask | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the IP.mask variable and print it.
Conformity result: Be able to read the attribute mask for the IP object, which is the same as the actual network mask value of the system. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 50 | IP | gateway | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Get the IP.gateway variable and print it.
Conformity result: The gateway attribute for the IP object can be read and retrieved, which is the same as the actual gateway address value of the system. | +| 51 | | IP(address, mask, gateway) | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network.
Test method: Use address, mask, gateway values, and call the IP(address, mask, gateway) function to construct an IP object.
Conformity result: The IP object can be Successfully create and its properties match the values used. | +| 52 | proxy | userName | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network and a proxy server.
Test method: Get the proxy.userName username variable for the current proxy server access method and print it.
Conformity result: Be able to read the attribute userName for the proxy object, which is the same as the actual value of the current access proxy server username. | +| 53 | | password | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network and a proxy server.
Test method: Get the username proxy.password variable of the current proxy server access method and print it.
Conformity result: The attribute password for the proxy object can be read and retrieved, which is the same as the actual value of the current access proxy server password. | +| 54 | | enable | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network and a proxy server.
Test method: Get the proxy.enable variable for whether the current proxy server is active or not and print it.
Conformity result: Be able to read out the enable attribute of a Proxy with the same value as the actual value of whether the current proxy is in | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 55 | proxy | unusedProxyURLs | effect or not.
Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network and a proxy server.
Test method: Get the proxy.unusedProxyURLs variable group for network connections that do not use a proxy and print it.
Conformity result: The string set of unused ProxyURLs that can read and retrieve the properties of the proxy object, is the same as the URL address group that the system actually does not need to proxy. | +| 56 | | Server | Conformity requirements:
Precondition: The receiving terminal is connected to a two-way broadband network and a proxy server.
Test method: Get the proxy.server variable for the IP address or domain address of the proxy server and print it.
Conformity result: Be able to read and retrieve the proxy.server string, which is the same as the actual proxy server network address or domain name used. | +| 57 | | port | Conformity requirement 1:
Precondition: The receiving terminal is connected to a two-way broadband network and a proxy server.
Test method: Get the proxy.port variable for the port number on which the proxy server is providing proxy services and print it.
Conformity result: Be able to read and retrieve the port string for the proxy service port, which is the same as the actual port of the proxy server proxy service. | + +### B.4 Conformance test of HCI unit interfaces + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | FrontPanel | displayText(str) | Conformity requirements:
Precondition: Display device with front panel.
Test method: Call the displayText(str) method with the string to be displayed as an input parameter.
Conformity result: The DisplayText returns success, and the front panel displays the input string in a horizontally centered manner. | +| 2 | | displayText(str,align) | Conformity requirements: | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | FrontPanel | |
Precondition: Display device with front panel.
Test method: Fill in the string str to be displayed, select the align of specified alignment method, and call the displayText(str, align) method.
Conformity result: DisplayText returns success, and the front panel displays the input string in the specified alignment. If the terminal does not support the selected alignment, it defaults to being displayed horizontally centered.
setStatus(type, status) | Conformity requirements:
Precondition: Indicator lights with front panel.
Test method: Select the indicator type and indicator status, and call the setStatus(type, status) method.
Conformity result: The setStatus returns success, and can be set to turn on and off normally, with indicator lights on and off accordingly.
getStatus(type) | Conformity requirements:
Precondition: Indicator lights on the front panel.
Test method: Select the indicator type and call the getStatus(type) method.
Conformity result: The getStatus returns the correct indicator status (valid types return closed/open, invalid types return unknown).
displayDate(date) | Conformity requirements:
Precondition: Display device with front panel.
Test method: Call the displayDate(date) method to display the current time.
Conformity result: If the terminal supports it, the displayDate returns success, and the front panel displays the corresponding time; If the terminal does not support it, the displayDate will return a failure and there will be no display on the front panel.
clear() | Conformity requirements:
Precondition: Display device with front panel.
Test method: When the front panel is in an information display state, call the clear() method.
Conformity result: The clear returns success, all displayed content on the front panel is cleared.
getMaxChars() | Conformity requirements:
Precondition: Display device with front panel.
Test method: Call the getMaxChars() method to obtain the number of strings displayed on the front panel.
Conformity result: The getMaxChars returns the maximum number of characters that the terminal can support for display.
Precondition: Input device triggers input event.
Test method: After capturing the input event, obtain the event.type variable.
Conformity result: The event.type matches the actual input event type. | +| 9 | | event.source | Conformity requirements:
Precondition: Input device triggers input event.
Test method: After capturing the input event, obtain the event.source variable.
Conformity result: The event source for event.source matches the actual input event device type. | +| 10 | | event.which | Conformity requirements:
Precondition: Input device triggers input event.
Test method: After capturing the input event, obtain the event key code value event.which variable.
Conformity result: The event.which event for key code value matches the actual input event device key code value. | +| 11 | | event.modifiers | Conformity requirements:
Precondition: Input device triggers input event.
Test method: After capturing the input event, obtain event.modifiers variable for the event extension attribute.
Conformity result: If the event.modifiers for the extended attribute is 0, it means the extended attribute is empty; if the extended attribute is number, the variable is a numeric value; If the extended attribute is a string, the variable is an ID value, which is generated by the internal definition of the system and is used as the index value of the string, Call Utility.GetEventInfo(ID) to get the corresponding string. | + +### B.5 Conformance test of AV setting unit interface + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | | getOutputInterfaceList() | Conformity requirement:
Precondition: All AV ports are connected to the TV normally, and the system starts successfully
Test method: Call the getOutputInterfaceList method.
Conformity result: The method call is successful, and the system gets an available | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------------|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | audio output port name. | +| 2 | | getOutputInterfaceStatus(port) |
Conformity requirement 1:
Precondition: All AV ports are connected to the TV, the system boots up successfully, and the getOutputInterfaceList method is called successfully.
Test method: Call the getOutputInterfaceStatus method with the parameters returned by the getOutputInterfaceList method.
Conformity result: The method is called successfully, get the status of the system audio output port specified by the parameter.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV, the system boots up successfully, and the getOutputInterfaceList method is called successfully.
Test method: Call the getOutputInterfaceStatus method with parameters other than those returned by the getOutputInterfaceList method.
Conformity result: The return value of the method call is false.
Conformity requirement 1:
Precondition: All AV ports are connected to the TV, the system boots up successfully, and the getOutputInterfaceList method is called successfully.
Test method: Call the disableOutputInterface method with the parameters returned by the getOutputInterfaceList method.
Conformity result: The method call is successful, and the system audio output port specified by the parameter is successfully disabled.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV, the system boots up successfully, and the getOutputInterfaceList method is called successfully.
Test method: Call the disableOutputInterface method with parameters other than those returned by the getOutputInterfaceList method.
Conformity result: Method call fails, the state of the system audio output port remains unchanged.
Conformity requirement 1:
Precondition: All AV ports are connected to the TV, the system boots up successfully, and the getOutputInterfaceList method is called successfully.
Test method: Call the enableOutputInterface
method with the parameters returned by the getOutputInterfaceList method.
Conformity result: The method is called successfully, and the system audio output port specified by the parameter is enabled successfully.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV, the system boots up successfully, and the getOutputInterfaceList method is called successfully.
Test method: Call the enableOutputInterface method with parameters other than those returned by the getOutputInterfaceList method.
Conformity result: The method call fails, and the status of the system audio output port remains unchanged.
| +| 5 | |getOutputVolume() | Conformity requirement:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the audio output ports are turned on.
Test method: Call the getOutputVolume method.
Conformity result: The method call is successful, and the obtained system volume value is within the range defined by the interface standard.
| +| 6 | |setOutputVolume(volume) | Conformity requirement 1:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the audio output ports are turned on.
Test method: Call the setOutputVolume method, with parameters within the scope defined by the interface standard.
Conformity result: The method call is successful, the system volume value is set according to the parameter values, and it actually works.
Conformity requirement 2:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the audio output ports are turned on.
Test method: Call the setOutputVolume method, with parameters outside the scope defined by the interface standard.
Conformity result: The method call is successful, and the system volume is set to the value closest to the set parameter within the
| + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------------|-------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 7 | AudioSetting | getOutputChannelMode() | valid range.Conformity requirement:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the audio output ports are turned on.
Test method: Call the getOutputChannelMode method.
Conformity result: Method call is successful, obtaining system output channel type. | +| 8 | | setOutputChannelMode(audio Channel) | Conformity requirement 1:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the audio output ports are turned on.
Test method: Call the setOutputChannelMode method, with parameters within the scope defined by the interface standard.
Conformity result: The method call is successful, the system output channel type is set according to the parameter values, and it actually works.
Conformity requirement 2:
Precondition: All HDMI ports are properly connected to the TV, the system boots up successfully, and the audio output ports are turned on.
Test method: Call the setOutputChannelMode method, with parameters other than the scope defined by the interface standard.
Conformity result: Method call fails, system output channel type remains unchanged. | +| 9 | | getOutputSPDIFMode() | Conformity requirement:
Precondition: All AV ports are normally connected to the TV, the system boots up successfully, the audio output ports are turned on, and the spdif connector is connected to the AV amplifier.
Test method: Call the getOutputSPDIFMode method.
Conformity result: Method call is successful, obtaining system SPDIF output interface data format. | +| 10 | | setOutputSPDIFMode(mode) | Conformity requirement 1:
Precondition: All AV ports are normally connected to the TV, the system boots up successfully, the audio output ports are turned on, and the spdif connector is connected to the AV amplifier.
Test method: Call the setOutputChannelMode | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | AudioSetting | |
method with parameters within the scope defined by the interface standard.
Conformity result: The method call is successful, and the system output sound format is set according to the parameter values, which is consistent with the sound format displayed by the AV amplifier.
Conformity requirement 2:
Precondition: All AV ports are normally connected to the TV, the system boots up successfully, the audio output ports are turned on, and the spdif connector is connected to the AV amplifier.
Test method: Call the setOutputChannelMode method, with parameters other than the scope defined by the interface standard.
Conformity result: Method call fails, system output sound format remains unchanged.
| +| 11 | | isMute() |Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system boots up successfully, the audio output ports are turned on, call the mute interface to mute the sound.
Test method: Call the isMute method.
Conformity result: The method is called successfully, and returns the status of whether the system is muted as true, which corresponds to the actual effect.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system boots up successfully, the audio output ports are turned on, call the unmute interface to unmute the TV.
Test method: Call the isMute method.
Conformity result: The method is called successfully, and returns the status of whether the system is muted as false, which corresponds to the actual effect.
| +| 12 | | mute() |Conformity requirement 1:
Precondition: All AV ports are properly connected to the TV, and the system boots up successfully.
Test method: Call the mute method.
Conformity result: Method call is successful, system is muted.
| +| 13 | | unMute() |Conformity requirement 1:
Precondition: All AV ports are properly connected to the TV, and the system boots up successfully.
| + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 14 | | getOutputHDMIIFMode() |Test method: Call the unMute method.
Conformity result: The method is called successfully and the system is unmuted.
Conformity requirement:
Precondition: HDMI port connects to AV amplifier input, HDMI output of AV amplifier connects to TV, system startup is successful, HDMI audio output port is on.
Test method: Call the getOutputHDMIIFMode method.
Conformity result: Method call is successful, obtaining system HDMI output interface data format.
Conformity requirement 1:
Precondition: HDMI port connects to AV amplifier input, HDMI output of AV amplifier connects to TV, system startup is successful, audio output port is on.
Test method: Call the setOutputHDMIIMode method, with parameters within the range defined by the interface standard.
Conformity result: The method is called successfully, and set the system HDMI output sound type according to the parameter value, which is consistent with the actual display value of the AV amplifier.
Conformity requirement 2:
Precondition: HDMI port connects to AV amplifier input, HDMI output of AV amplifier connects to TV, system startup is successful, audio output port is on.
Test method: Call the setOutputHDMIIMode method, with parameters other than the scope defined by the interface standard.
Conformity result: Method call fails, system HDMI output sound type remains unchanged.
Conformity requirement:
Precondition: All AV ports are connected to the TV normally, and the system starts successfully.
Test method: Call the getOutputInterfaceList method.
Conformity result: The method is called successfully, get the name of the available video output port of the system.
Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system boots up successfully, and the getOutputInterfaceList method is successfully called.
Test method: Call the getOutputInterfaceStatus method with the parameters returned by the getOutputInterfaceList method.
Conformity result: The method is called successfully, and get the status of the system video output port specified by the parameter.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system boots up successfully, and the getOutputInterfaceList method is successfully called.
Test method: Call the getOutputInterfaceStatus method with parameters other than those returned by the getOutputInterfaceList method.
Conformity result: The return value of the method call is false.
Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system boots up successfully, and the getOutputInterfaceList method is successfully called.
Test method: Call the disableOutputInterface method with the parameters returned by the getOutputInterfaceList method.
Conformity result: The method is called successfully, and the system video output port specified by the parameter is disabled successfully.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system boots up successfully, and the getOutputInterfaceList method is successfully called.
Test method: Call the disableOutputInterface method with parameters other than those returned by the getOutputInterfaceList method.
Conformity result: Method call fails, system video output port status remains unchanged.
Conformity requirement 1:
Precondition: All AV ports are connected to the TV normally, the system boots up successfully, and the getOutputInterfaceList method is successfully called.
Test method: Call the enableOutputInterface method with the parameters returned by the getOutputInterfaceList method.
Conformity result: The method call is successful, and the system video output port specified by the parameter is successfully enabled.
Conformity requirement 2:
Precondition: All AV ports are connected to the TV normally, the system boots up successfully, and the getOutputInterfaceList method is successfully called.
Test method: Call the enableOutputInterface method with parameters other than those returned by the getOutputInterfaceList method.
Conformity result: Method call fails, system video output port status remains unchanged.
getOutputBrightness() | Conformity requirement:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the getOutputBrightness method.
Conformity result: The method is called successfully, and the value of the system brightness is within the standard definition of the interface.
getOutputContrast() | Conformity requirement:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the getOutputContrast method.
Conformity result: The method is called successfully, and the value of the system contrast size is within the range defined by the interface standard.
getOutputSaturation() | Compliance requirement:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the getOutputSaturation method.
Conformity result: The method is called successfully, and the value of the system saturation is within the range defined by the interface standard.
getOutputStandard(device) | Conformity requirement 1:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are
turned on.
Test method: For high_definition(HD) systems, call the getOutputStandard method with the VOUT_HD parameter defined by the interface standard.
Conformity result: The method is called successfully, and the value of the system model format is within the definition of the interface standard.
Conformity requirement 2:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: For standard_definition(SD) systems, call the getOutputStandard method with the VOUT_SD parameter defined by the interface standard.
Conformity result: The method is called successfully, and the value of the system model format is within the definition of the interface standard.
| +| 24 | | getOutputTransparency() |Conformity requirement:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the getOutputTransparency method.
Conformity result: The method is called successfully, and the value of the system transparency size is within the standard definition of the interface.
| +| 25 | VideoSetting | setOutputBrightness(value) |Conformity requirement 1:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the setOutputBrightness method, with parameters within the scope defined by the interface standard.
Conformity result: The method call is successful, and the system brightness value is set according to the parameter values, which actually takes effect.
Conformity requirement 2:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the setOutputBrightness
| + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |method, with parameters other than the scope defined by the interface standard
Conformity result: The method is called successfully, and the system volume is set to the value closest to the set parameter within the valid range.
| +| 26 | | setOutputContrast(value) |Conformity requirement 1:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the setOutputContrast method, with parameters within the scope defined by the interface standard.
Conformity result: The method call is successful, and the system contrast size value is set according to the parameter values, which actually takes effect.
Conformity requirement 2:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the setOutputContrast method, with parameters other than the scope defined by the interface standard
Conformity result: The method call is successful, and the system contrast is set to the value closest to the set parameter within the valid range.
Conformity requirement 1:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the setOutputSaturation method, with parameters within the scope defined by the interface standard.
Conformity result: The method call is successful, and the system contrast size value
Conformity requirement 2:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the setOutputSaturation method, with parameters other than the scope defined by the interface standard.
Conformity result: The method call is successful, and the system contrast is set to the value closest to the set parameter within the valid range. | +| | | setOutputStandard(device, standard) | Conformity requirement 1:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: For HD systems, call the setOutputStandard method with the device parameter as VOUT_HD and the standard parameter as within the interface standard definition.
Conformity result: The method call is successful, the system video signal format value is set according to the parameter value, and it actually works.
Conformity requirement 2:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: For SD systems, call the setOutputStandard method with the device parameter as VOUT_SD and the standard parameter as within the interface standard definition.
Conformity result: The method call is successful, the system video signal format value is set according to the parameter value, and it actually works.
Conformity requirement 3:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: For HD systems, call the setOutputStandard method with the device parameter as VOUT_HD, and the standard parameter as other than the scope of the interface standard definition. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
Conformity result: Method call fails, system video signal format value remains unchanged.
Conformity requirement 4:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: For SD system, call setOutputStandard method with device parameter as VOUT_SD, and standard parameter as other than the scope of interface standard definition.
Conformity result: Method call fails, system video signal format value remains unchanged.
| +| 29 | |setOutputTransparency(value) | Conformity requirement 1:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the setOutputTransparency method, with parameters within the scope defined by the interface standard.
Conformity result: The method call is successful, the system transparency value is set according to the parameter value, and it actually takes effect.
Conformity requirement 2:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the setOutputTransparency method, with parameters other than the scope defined by the interface standard.
Conformity result: The method call is successful, and the system transparency is set to the value closest to the set parameter within the valid range.
| +| 30 | |setOutputMatchMethod(mode) | Conformity requirement 1:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the setOutputMatchMethod method, with parameters within the scope defined by the interface standard.
Conformity result: The method call is successful, and the system video output aspect ratio adaptation mode value is set according to the parameter value, and it actually takes effect.
| + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | VideoSetting | |Conformity requirement 2:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the setOutputMatchMethod method, with parameters other than the scope defined by the interface standard.
Conformity result: Method call fails, the aspect ratio adaptation mode of the set-top video output box remains unchanged.
Conformity requirement:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the getOutputMatchMethod method.
Conformity result: Successfully call the method, and get the aspect ratio fit mode value of the system video output, which is within the range defined by the interface standard.
Conformity requirement:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the getOutputAspectRatio method.
Conformity result: Successfully call the method, and get the aspect ratio of the system video output, which is within the range defined by the interface standard.
Conformity requirement 1:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the setOutputAspectRatio method, with parameters within the scope defined by the interface standard.
Conformity result: The method call is successful, and the system video output aspect ratio mode value is set according to the parameter values, and it actually works.
Conformity requirement 2:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the setOutputAspectRatio
Conformity result: Method call fails, and the aspect ratio mode of the set-top video output box remains unchanged. | +| 34 | | GetColorSpaceMode() | Conformity requirement:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the GetColorSpaceMode method.
Conformity result: The method is called successfully, and the value of the system video output color space mode is within the range defined by the interface standard. | +| 35 | | GetDeepColorMode() | Conformity requirement:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the GetDeepColorMode method.
Conformity result: The method is successfully called, and get the system video output color depth mode value which is within the interface standard definition. | +| 36 | | SetColorSpaceAndDeepColor(colorSpace, deepColor) | Conformity requirement 1:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the SetColorSpaceAndDeepColor method, with parameters within the scope defined by the interface standard.
Conformity result: The method call is successful, and the system video output color space and color depth mode values are set according to the parameter values, which actually take effect.
Conformity requirement 2:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the SetColorSpaceAndDeepColor method, with parameters other than the scope defined by the interface standard.
Conformity result: Method call fails, video | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | VideoSetting | | output color space, color depth mode value remains unchanged. | +| 37 | | GetHDRType() | Conformity requirement 1:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the GetHDRType method.
Conformity result: The method call is successful, and get the current correct HDR mode. | +| 38 | | SetHDRType(type) | Conformity requirement 1:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the SetHDRType method, with parameters within the range defined by the interface standard.
Conformity result: The method call is successful, the system video output HDR mode value is set according to the parameter values, and it actually takes effect.
Conformity requirement 2:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the SetHDRType method, with parameters other than the scope defined by the interface standard.
Conformity result: Method call fails, the HDR mode value of the set-top video output remains unchanged. | +| 39 | | GetStereoOutMode() | Conformity requirement:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the GetStereoOutMode method.
Conformity result: Successfully call the method, and get the system video output stereo mode value which is within the interface standard definition. | +| 40 | | SetStereoOutMode(mode, fps) | Conformity requirement 1:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------------|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | VideoSetting | |
Test method: Call the SetStereoOutMode method, with parameters within the range defined by the interface standard.
Conformity result: The method call is successful, and the system video output stereo R mode value is set according to the parameter values, and it actually takes effect.
Conformity requirement 2:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the SetStereoOutMode method with parameters other than the scope defined by the interface standard
Conformity result: Method call fails, video output stereo mode value remains unchanged.
| +| 41 | | GetRightEyeFirst() |Conformity requirement:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the GetRightEyeFirst method.
Conformity result: The method call is successful, and get the right eye in the stereoscopic mode of the system video output. The value is within the interface standard definition range
| +| 42 | | SetRightEyeFirst(Outpriority) |Conformity requirement 1:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the SetRightEyeFirst method, with parameters within the scope defined by the interface standard.
Conformity result: The method call is successful, and set the system video output stereo mode value to right eye in front according to the parameter values, which actually works.
Conformity requirement 2:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the SetRightEyeFirst method with parameters other than the scope defined by the interface standard.
Conformity result: Method call fails, and the
| + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | stereoscopic mode of video output is with the right eye in front, and its value remains unchanged. | +| 43 | | GetStereoDepth() | Conformity requirement:Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the GetStereoDepth method.
Conformity result: The method call is successful, the stereo mode depth value of the system video output is within the range defined by the interface standard. | +| 44 | | SetStereoDepth(depth) | Conformity requirement 1:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the SetStereoDepth method, with parameters within the scope defined by the interface standard.
Conformity result: The method call is successful, and the depth value of the system video output stereo mode is set according to the parameter values, which actually takes effect.
Conformity requirement 2:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the SetStereoDepth method, with parameters other than the scope defined by the interface standard.
Conformity result: The method is called successfully, and the stereo mode depth value of the system video output is set to the value closest to the set parameter within the valid range. | +| 45 | | getPictureMode() | Conformity requirement:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the getPictureMode method.
Conformity result: The method is called successfully, and the output image mode value of the system video is within the range defined by the interface standard. | +| 46 | | setPictureMode(mode) | Conformity requirement 1:
Precondition: All AV ports are properly | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the setPictureMode method, with parameters within the scope defined by the interface standard.
Conformity result: The method is called successfully, the system video output image mode value is set according to the parameter value, and it actually works.
Conformity requirement 2:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the setPictureMode method with parameters other than the scope defined by the interface standard.
Conformity result: Method call fails, video output image value remains unchanged.
| +| 47 | | getDisplayHue() |Conformity requirement:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the getDisplayHue method.
Conformity result: Successfully call the method, and get the output color tone value of the system video, which is within the definition of the interface standard.
| +| 48 | | setDisplayHue(hue) |Conformity requirement 1:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the setDisplayHue method, with parameters within the scope defined by the interface standard.
Conformity result: The method is called successfully, the color tone of the system video output is set according to the parameter value, and it actually works.
Conformity requirement 2:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the setDisplayHue method, with parameters outside the scope defined by the interface standard.
Conformity result: The method is called
| + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | successfully, and the output color tone value of the system video is set to the value closest to the set parameter within the valid range. | +| 49 | | SaveDisplayFmt() |Conformity requirement:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the SaveDisplayFmt method.
Conformity result: The method is called successfully, the system saves the video output parameter configurations, the video output parameter configurations can be maintained without loss after the system is powered down and restarted.
Conformity requirements:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the setOptimalFormatEnable method.
Conformity result: The method call is successful and returns True.
Conformity requirements:
Precondition: All AV ports are properly connected to the TV, the system boots up successfully, and the video output ports are turned on.
Test method: Call the getOptimalFormatEnable method.
Conformity result: The method call is successful, and the current enable state of the correct output format of the automation video is obtained.
Conformity requirement:
Precondition: Call the setMediaSource() function with a valid url.
Test method: Get messages through document.onsystemevent.
Conformity result: The web page receives the message MSG_MEDIA_URL_VALID.
Test method: Get messages through document.onsystemevent.
Conformity result: The web page receives a message of MSG_MEDIA_URL_INVALID. | +| 3 | | MSG_MEDIA_PLAY_SUCCESS | Conformity requirement:
Precondition: The play() function is called, and the playback is successful.
Test method: Get messages through document.onsystemevent.
Conformity result: The web page receives a message of MSG_MEDIA_PLAY_SUCCESS. | +| 4 | | MSG_MEDIA_PLAY_FAILED | Conformity requirement:
Precondition: Call play() function, playback fails.
Test method: Get messages through document.onsystemevent.
Conformity result: The web page receives a message of MSG_MEDIA_PLAY_FAILED. | +| 5 | | MSG_MEDIA_SETPACE_SUCCESS | Conformity requirement:
Precondition: The setPace() function is called and the setup is successful.
Test method: Get messages through document.onsystemevent.
Conformity result: The web page receives a message of MSG_MEDIA_SETPACE_SUCCESS. | +| 6 | | MSG_MEDIA_SETPACE_FAILED | Conformity requirement:
Precondition: The setPace() function is called and the setup fails.
Test method: Get messages through document.onsystemevent.
Conformity result: The web page receives a message of MSG_MEDIA_SETPACE_FAILED. | +| 7 | | MSG_MEDIA_SEEK_SUCCESS | Conformity requirement:
Precondition: Call the seek() function successfully.
Test method: Get messages through document.onsystemevent.
Conformity result: The web page receives a message of MSG_MEDIA_SEEK_SUCCESS. | +| 8 | | MSG_MEDIA_SEEK_FAILED | Conformity requirement:
Precondition: The seek() function is called, and the call fails.
Test method: Get messages through document.onsystemevent.
Conformity result: The web page receives a message of MSG_MEDIA_SEEK_FAILED. | +| 9 | | MSG_MEDIA_PAUSE_SUCCESS | Conformity requirement:
Precondition: Call the pause() function, and pause | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|-------------|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | MediaPlayer | | successfully.
Test method: Get messages through document.onsystemevent.
Conformity result: The web page receives a message of MSG_MEDIA_PAUSE_SUCCESS. | +| 10 | | MSG_MEDIA_PAUSE_FAILED | Conformity requirement:
Precondition: Call pause() function, and pause fails.
Test method: Get messages through document.onsystemevent.
Conformity result: The web page receives a message of MSG_MEDIA_PAUSE_FAILED | +| 11 | | MSG_MEDIA_RESUME_SUCCESS | Conformity requirement:
Precondition: The resume() function is called and playback is resumed successfully.
Test method: Get messages through document.onsystemevent.
Conformity result: The web page receives a message of MSG_MEDIA_RESUME_SUCCESS. | +| 12 | | MSG_MEDIA_RESUME_FAILED | Conformity requirement:
Precondition: The resume() function is called and resuming playback fails.
Test method: Get messages through document.onsystemevent.
Conformity result: The web page receives a message of MSG_MEDIA_RESUME_FAILED. | +| 13 | | MSG_MEDIA_STOP_SUCCESS | Conformity requirement:
Precondition: Call stop() function, and stop successfully
Test method: Get messages through document.onsystemevent.
Conformity result: The web page receives a message of MSG_MEDIA_STOP_SUCCESS. | +| 14 | | MSG_MEDIA_STOP_FAILED | Conformity requirement:
Precondition: The stop() function is called and stopping fails.
Test method: Get messages through document.onsystemevent.
Conformity result: The web page receives a message of MSG_MEDIA_STOP_FAILED. | +| 15 | | MediaPlayer() | Conformity requirement:
Precondition: window MediaPlayer exists.
Test method: Call MediaPlayer().
Conformity result: Generate media player object. | +| 16 | | getPlayerInstanceID() | Conformity requirement:
Precondition: There is already a media player object.
Test method: Call getPlayerInstanceID().
Conformity result: Get the locally available player | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|-------------|----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | instance ID of the receiving terminal, which is automatically assigned by the system internally. | +| 17 | MediaPlayer | bindPlayerInstance(playerInstanceID) |
Conformity requirement 1:
Precondition: Call getPlayerInstanceID() to obtain the ID.
Test method: Call bindPlayerInstance().
Conformity result: The MediaPlayer object is bound to the player instance and returns 0.
Conformity requirement 2:
Precondition: No call to getPlayerInstanceID() to get the id.
Test method: Call bindPlayerInstance().
Conformity result: MediaPlayer object cannot be bound to a player instance and returns 1.
Conformity requirement:
Precondition: Call bindPlayerInstance().
Test method: Call unbindPlayerInstance().
Conformity result: MediaPlayer object is unbound from the current player instance and returns 0.
Conformity requirement 1:
Precondition: URL is valid.
Test method: Call setMediaSource().
Conformity result: Send MSG_MEDIA_URL_VALID message to the page.
Conformity requirement 2:
Precondition: URL is illegal.
Test method: Call setMediaSource().
Conformity result: Send MSG_MEDIA_URL_INVALID message to the page.
Conformity requirement 1:
Precondition: URL has been set.
Test method: Read location.
Conformity result: Media file location.
Conformity requirement 2:
Precondition: URL has not been set.
Test method: Read location.
Conformity result: The value is null.
Conformity requirement 1:
Precondition: Call bindPlayerInstance().
Test method: Read playerInstanceID.
Conformity result: The player instance ID is bound to the current MediaPlayer object.
Conformity requirement 2:
Precondition: Before calling the bindPlayerInstance() method, or after calling the unbindPlayerInstance() method.
Test method: Read playerInstanceID.
Conformity requirement 1:
Precondition: After the page receives the MSG_MEDIA_URL_VALID message.
Test method: Call play().
Conformity result: Send MSG_MEDIA_PLAY_SUCCESS message to the page.
Conformity requirement 2:
Precondition: The page does not receive an MSG_MEDIA_URL_VALID message.
Test method: Call play().
Conformity result: Send MSG_MEDIA_PLAY_FAILED message to the page.
Conformity requirement 1:
Precondition: Video is playing.
Test method: Call pause().
Conformity result: Send MSG_MEDIA_PAUSE_SUCCESS message to the page.
Conformity requirement 2:
Precondition: The video has not been played.
Test method: Call pause().
Conformity result: Send MSG_MEDIA_PAUSE_FAILED message to the page.
Conformity requirement 1:
Precondition: Video pause playback.
Test method: Call resume().
Conformity result: Send MSG_MEDIA_RESUME_SUCCESS message to the page.
Conformity requirement 2:
Precondition: The video has not been paused.
Test method: Call resume().
Conformity result: Send MSG_MEDIA_RESUME_FAILED message to the page.
Conformity requirement 1:
Precondition: Video is playing.
Test method: Call stop().
Conformity result: Send MSG_MEDIA_STOP_SUCCESS message to the page.
Conformity requirement 2:
Precondition: The video has not been played.
Test method: Call stop().
Precondition: Media source supports trick mode.
Test method: Call enableTrickMode() and then call setPace().
Conformity result: There are trick effects.
Conformity requirement 2:
Precondition: Media source does not support trick mode.
Test method: Call enableTrickMode() and then call setPace().
Conformity result: No trick effects. | +| 27 | | getTrickModeFlag() | Conformity requirement:
Precondition: Exist media player object.
Test method: Call getTrickModeFlag().
Conformity result: Get the set value for the trick, which is consistent with the setting. | +| 28 | | setVideoDisplayMode(mode) | Conformity requirement 1:
Precondition: Exist media player object
Test method: Call setVideoDisplayMode(), then call refresh().
Conformity result: The video display mode is successfully set and takes effect after calling refresh().
Conformity requirement 2:
Precondition: Exist media player object.
Test method: Call setVideoDisplayMode() with invalid parameters.
Conformity result: Unable to change video display mode. | +| 29 | | getVideoDisplayMode() | Conformity requirement:
Precondition: Exist media player object.
Test method: Call getVideoDisplayMode().
Conformity result: The obtained video display mode is consistent with the actual playback. | +| 30 | | setVideoDisplayArea(rect) | Conformity requirement 1:
Precondition: Exist media player object
Test method: Call setVideoDisplayArea(), then call refresh().
Conformity result: Successfully set the video display area and take effect after calling refresh().
Conformity requirement 2:
Precondition: Exist media player object.
Test method: Call setVideoDisplayArea() with invalid parameters.
Conformity result: Unable to change the video | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|-------------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | MediaPlayer | | display area. | +| 31 | | getVideoDisplayArea() | Conformity requirement:
Precondition: Exist media player object.
Test method: Call getVideoDisplayArea().
Conformity result: Get video display area. | +| 32 | | setVolume(volume) | Conformity requirement 1:
Precondition: Exist media player object.
Test method: Call setVolume() with valid parameters.
Conformity result: Successfully set volume.
Conformity requirement 2:
Precondition: Exist media player object.
Test method: Call setVolume() with invalid parameters.
Conformity result: Fail to change volume. | +| 33 | | getVolume() | Conformity requirement:
Precondition: Exist media player object.
Test method: Call getVolume().
Conformity result: Get volume. | +| 34 | | getCurrentLanguage() | Conformity requirement:
Precondition: Media source is available.
Test method: Call getCurrentLanguage().
Conformity result: Get the current language, which corresponds to the one actually being played. | +| 35 | | listAvailableLanguages() | Conformity requirement:
Precondition: Media source is available.
Test method: Call listAvailableLanguages().
Conformity result: Get all currently available audio languages. | +| 36 | | getMediaDuration() | Conformity requirement:
Precondition: Media source is available.
Test method: Call getMediaDuration().
Conformity result: Get the total duration of the current playing media. | +| 37 | | getCurrentPlayTime() | Conformity requirement:
Precondition: Media source is available.
Test method: Call getCurrentPlayTime().
Conformity result: Get the current time point of media playback. | +| 38 | | getPlaybackMode() | Conformity requirement:
Precondition: Media source is available.
Test method: Call getPlaybackMode().
Conformity result: Get the current playback mode of the player. | +| 39 | | getServiceLocation(flag) | Conformity requirement:
Precondition: Media source is available. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|-------------|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | MediaPlayer | | Test method: Call
getServiceLocation() .Conformity result: Get the locator for the specified programme based on the programme logo object. | +| 40 | |
setPauseMode(mode) | Conformity requirement:Precondition: The video is currently playing.
Test method: Call
setPauseMode() and then Call the pause() method.Conformity result: The output mode of the video in pause state is set successfully. When
pause() is called, the video state is the corresponding setting mode. |
+| 41 | | getPauseMode() | Conformity requirement:Precondition: Exist media player object; Call
setPauseMode() to set the pause mode.Test method: Call
getPauseMode() .Conformity result: Get the output mode of the video in pause state, which is consistent with the previous call to the
setPauseMode method. |
+| 42 | | refresh() | Conformity requirement:Precondition: Call
setVideoDisplayMode() , setVideoDisplayArea() .Test method: Call
refresh() .Conformity results: Video mode and region are effective. | +| 43 | |
seek(type,timestamp) | Conformity requirement 1:Precondition: Media source is available.
Test method: Call
seek() .Conformity result: If the call is successful, send an
MSG_MEDIA_SEEK_SUCCESS message.Conformity requirement 2:
Precondition: Real time TV is broadcasting.
Test method: Call
seek() .Conformity result: If the call fails, an
MSG_MEDIA_SEEK_FAILED message will be sent. |
+| 44 | | setPace(pace) | Conformity requirement 1:Precondition: Play media sources that support fast playback.
Test method: Call
setPace() .Conformity result: If the setting is successful, send an
MSG_MEDIA_SET_PACE_SUCCESS message to the page.Conformity requirement 2:
Precondition: Real time TV is broadcasting.
Test method: Call
setPace() .Conformity result: If the setting fails, send an
MSG_MEDIA_SET_PACE_FAILED message to the page. |
+
+| Serial No. | Object | Message/Interface/Attribute | Process description |
+|------------|-------------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 45 | MediaPlayer | selectDefaultLanguage() | Conformity requirement:Precondition: Exist media player object.
Test method: Call selectDefaultLanguage().
Conformity result: Set the audio language as the default language. | +| 46 | | selectLanguage(language) | Conformity requirement:
Precondition: Exist media player object
Test method: Call selectLanguage().
Conformity result: Set the language used for the current audio. | + +### B.7 Conformance test of application management unit interface + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | widget | author | Conformity requirements:
Precondition: The application has been installed.
Test method: Read the author.
Conformity result: Get the name of the application developer. | +| 2 | | description | Conformity requirements:
Precondition: The application has been installed.
Test method: Read the description.
Conformity result: Get detailed information about the application. | +| 3 | | name | Conformity requirements:
Precondition: The application has been installed.
Test method: Read name.
Conformity result: Get the application name. | +| 4 | | shortName | Conformity requirements:
Precondition: The application has been installed.
Test method: Read shortName.
Conformity result: Get the application's short name. | +| 5 | | version | Conformity requirements:
Precondition: The application has been installed.
Test method: Read version.
Conformity result: Get the application version number. | +| 6 | | id | Conformity requirements:
Precondition: The application has been installed.
Test method: Read the ID.
Conformity result: Get the unique identification number of the application. | +| 7 | | authorEmail | Conformity requirements:
Precondition: The application has been installed.
Test method: Read authorEmail. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | widget | | Conformity result: Get the application developer's email. | +| 8 | | authorHref | Conformity requirements:
Precondition: The application has been installed.
Test method: Read authorHref.
Conformity result: Get the location of application developer information. | +| 9 | | preferences | Conformity requirements:
Precondition: The application has been installed.
Test method: Read preferences.
Conformity result: Get application references. | +| 10 | | height | Conformity requirements:
Precondition: The application has been installed.
Test method: Read height.
Conformity result: Get application height. | +| 11 | | width | Conformity requirements:
Precondition: The application has been installed.
Test method: Read width.
Conformity result: Get application width. | +| 12 | | launchWidget(DOMString widgetname, DOMString src, DOMString type) | Conformity requirements:
Precondition: The application has been installed.
Test method: Call launchWidget().
Conformity result: Launch to the specified application.
Conformity requirement 2:
Precondition: The application is not installed.
Test method: Call launchWidget().
Conformity result: The specified application cannot be launched. | +| 13 | | installWidget(DOMString widgetname, DOMString id, DOMString url) | Conformity requirement 1:
Precondition: The app store server is ready for the application.
Test method: Call installWidget().
Conformity result: Trigger the page of ondownloadsize for download progress callback function, and the page of ondownloadsuccess for download success callback function.
Conformity requirement 2:
Precondition: The app store server is not ready for the application.
Test method: Call installWidget().
Conformity result: Trigger the page of ondownloadfail for download failure callback function. | +| 14 | | updateWidget(DOMString widgetname, DOMString id, | Conformity requirement 1:
Precondition: The app store server is ready for the application, and the application needs to be | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | widget | DOMString url) | upgraded.
Test method: Call updateWidget().
Conformity result: The application upgrade is successful.
Conformity requirement 2:
Precondition: The app store server is not ready for the application.
Test method: Call updateWidget().
Conformity result: The application cannot be upgraded. | +| 15 | | checkWidget(DOMString widgetname, DOMString id, DOMString url) | Conformity requirement 1:
Precondition: The application has been successfully installed.
Test method: Call checkWidget().
Conformity result: The page retrieves the installed application version number.
Conformity requirement 2:
Precondition: The application is not installed.
Test method: Call checkWidget().
Conformity result: The page cannot get the installed application version number. | +| 16 | | uninstallWidget(DOMString widgetname, DOMString id) | Conformity requirement 1:
Precondition: The application has been successfully installed.
Test method: Call uninstallWidget().
Conformity result: Trigger the page of onuninstallsuccess for the unload success callback function.
Conformity requirement 2:
Precondition: The application is not installed.
Test method: Call uninstallWidget().
Conformity result: Trigger the page of onuninstallfail for Uninstall Failure Callback Functions. | +| 17 | | deletePackage(DOMString widgetname, DOMString id) | Conformity requirement 1:
Precondition: The application has been successfully installed.
Test method: Call deletePackage().
Conformity result: Delete user cached data.
Conformity requirement 2:
Precondition: The application is not installed.
Test method: Call deletePackage().
Conformity result: User cached data is not deleted. | + +### B.8 Conformance test of message management unit interface + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | event | event.source | Conformity requirements:
Precondition: The event object is a built-in object.
Test method: Press any remote control button or front panel button.
Conformity result: Able to capture the message of a key press and event.source is 1002 if it is a remote control key press, 1003 if it is a front panel key press, and 1001 if it is a system message. | +| 2 | | event.which | Conformity requirements:
Precondition: The event object is a built-in object.
Test method: Press any remote control button or front panel button, then call the event.which property.
Conformity result: Return the code value of the message. | +| 3 | | event.modifiers | Conformity requirements:
Precondition: The event object is a built-in object.
Test method: Press the remote control button or the front panel button, and then call the read-only event.modifiers attribute.
Conformity result: Return the extended properties of the message. If the extension attribute of the message is null, modifiers return 0; If the extended attribute of the message is of type number, the modifiers return this value; If the extended property of the message is a string, the modifiers return an ID value, which is generated internally by the system. As a pointer to the contents of a specific string, the application can call the Utility.getEventInfo(ID) method to retrieve the contents of the string. | +| 4 | | event.type | Conformity requirements:
Precondition: The event object is a built-in object.
Test method: Press the remote control button or the front panel button, and then call the event.type attribute.
Conformity result: Return the type of the event, i.e., the name of the event represented by the current event object, which is the same name as the registered event handle, such as "onclick"; or the event handle attribute with the prefix "on" is removed, such as "click", which is same as W3C definition. | + +### B.9 Conformance test of system management unit interface + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|--------|---------------------------|---------------------------| +| 1 | | createUserPropertyTable() | Conformity requirement 1: | + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|------------|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
Precondition: No user data table has been created.
Test method: Call createUserPropertyTable().
Conformity result: The return value is greater than 0, indicating successful creation of the user data table.
Conformity requirement 2:
Precondition: Call createUserPropertyTable() to create a user data table.
Test method: Call createUserPropertyTable().
Conformity result: The return value is 1, indicating that the user data table to be created already exists.
Conformity requirement 3:
Precondition: No user data table has been created.
Test method: Call createUserPropertyTable() and pass in a string with null or empty parameters.
Conformity result: The return value is 2, indicating that the user data table name to be created is invalid.
getUserPropertyTable() | Conformity requirement 1:
Precondition: Call createUserPropertyTable() to create a user data table.
Test method: Call getUserPropertyTable().
Conformity result: Return a value greater than 0 to indicate a globally unique data table identifier.
Conformity requirement 2:
Precondition: The deleteUserPropertyTable() method delete the data table.
Test method: Call getUserPropertyTable().
Conformity result: The return value is 1, indicating a failure to get the user data table.
Conformity requirement 3:
Precondition: No user data table has been created.
Test method: Call getUserPropertyTable() and pass in a string with null or empty parameters.
Conformity result: The return value is 2, indicating that the user data table name to be fetched is not valid.
deleteUserPropertyTable() | Conformity requirement 1:
Precondition: Call getUserPropertyTable().
Test method: Call deleteUserPropertyTable().
Conformity result: The return value is greater than 0, indicating the user data table is deleted successfully.
Conformity requirement 2:
Precondition: No user data table has been created.
Test method: Call deleteUserPropertyTable() and pass in a non-existent data table identifier as the parameter.
Conformity result: The return value is 1, indicating
Conformity requirement 3:
Precondition: No user data table has been created.
Test method: Call deleteUserPropertyTable() and pass in a string with null or empty parameters.
Conformity result: The return value is 2, indicating that the name of the data table to be deleted is invalid. | +| 4 | | getSystemPropertyTable() | Conformity requirement 1:
Precondition: /data/app/data_access_default.json file does not exist.
Test method: Call getSystemPropertyTable().
Conformity result: The return value is 1, indicating that the acquired system data table does not exist.
Conformity requirement 2:
Precondition: This file needs to exist as follows:/data/app/data_access_default.json.
Test method: Call getSystemPropertyTable().
Conformity result: The return value is greater than 0, indicating the success of getting the system data table. | +| 5 | | createItem() | Conformity requirement 1:
Precondition: Call createUserPropertyTable().
Test method: Call createItem().
Conformity result: The return value is greater than 0, indicating successful creation of the data item.
Conformity requirement 2:
Precondition: No user data table has been created.
Test method: Call createItem().
Conformity result: The return value is 1, indicating a failure to create data table.
Conformity requirement 3:
Precondition: Call createUserPropertyTable() and createItem() in sequence.
Test method: Call createItem().
Conformity result: The return value is 2, indicating that the data item name already exists in the data table.
Conformity requirement 4:
Precondition: No user data table has been created.
Test method: Call createItem() to pass in a string with a parameter data item name of NULL or empty.
Conformity result: The return value is 3, indicating invalid data item name. | +| 6 | | deleteItem() | Conformity requirement 1:
Precondition: Call createUserPropertyTable() and createItem() in sequence.
Test method: Call deleteItem(). | + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|------------|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DataConfig | |
Conformity result: The return value is greater than 0, indicating successful deletion.
Conformity requirement 2:
Precondition: No user data table has been created.
Test method: Call the deleteItem() parameter to pass in a non-existent data table identifier.
Conformity result: The return value is 0, indicating that the deletion of the data item fails for unknown reasons.
Conformity requirement 3:
Precondition: No user data table has been created.
Test method: Call the deleteItem() parameter to pass in a non-existent data item name.
Conformity result: The return value is 1, indicating that data item does not exist.
| +| 7 | | getProperty() |Conformity requirement 1:
Precondition: Call createUserPropertyTable() and createItem() in sequence.
Test method: Call getProperty().
Conformity result: Return a string, the value of the data item is success.
Conformity requirement 2:
Precondition: No user data table has been created.
Test method: Call the getProperty() parameter to pass in a non-existent data item name.
Conformity result: Return NULL, indicating that the obtained data item does not exist.
| +| 8 | | setProperty() |Conformity requirement 1:
Precondition: Call createUserPropertyTable() and createItem() in sequence.
Test method: Call setProperty().
Conformity result: The return value is greater than 0, indicating successful modification.
Conformity requirement 2:
Precondition: No user data table has been created.
Test method: Call the setProperty() parameter to pass in a non-existent data item name.
Conformity result: The return value is 0, indicating the modification of the content fails due to unknown reasons.
Conformity requirement 3:
Precondition: No user data table has been created.
Test method: Call the setProperty() parameter to pass in a non-existent data item name.
Conformity result: The return value is 1, indicating that data item does not exist.
| +| 9 | | saveToNvm() |Conformity requirement 1:
Precondition: Call createUserPropertyTable(), folder:/data/db exists.
Test method: Call saveToNvm().
Conformity result: Return true to indicate the start of execution. If executed successfully, the message MSG_SAVE_DATA_SUCCESS can be captured, indicating successful data writing.
Conformity requirement 2:
Precondition: No user data table has been created.
Test method: The call to saveToNvm() passes in a parameter that is a non-existent data table identifier.
Conformity result: Return false to indicate that it has not been executed, and unsuccessful execution can capture an MSG_SAVE_DATA_FAILED message indicating that the data write has failed.
removeFromNvm() | Conformity requirement 1:
Precondition: Call createUserPropertyTable() and saveToNvm() in sequence.
Test method: Call removeFromNvm().
Conformity result: Return true to indicate the start of execution. If executed successfully, the message MSG_REMOVED_DATA_SUCCESS can be captured, indicating that the data table has been successfully deleted.
Conformity requirement 2:
Precondition: No user data table has been created.
Test method: Call removeFromNvm() and pass in a non-existent data table identifier as the parameter.
Conformity result: Return false to indicate that the data table is not executed. If the execution is unsuccessful, the MSG_REMOVE_DATA_FAILED message can be captured, indicating that the data table deletion has failed.
revertFromNvm() | Conformity requirement 1:
Precondition: Call createUserPropertyTable() and saveToNvm() in sequence.
Test method: Call revertFromNvm().
Conformity result: Return true to indicate the start of execution, and successful execution can capture the message MSG_REVERT_DATA_SUCCESS, indicating successful data coverage.
Conformity requirement 2:
Precondition: No user data table has been created.
Test method: Call revertFromNvm().
Conformity result: Return false to indicate that the execution is not successful. If the execution is unsuccessful, the MSG_REVERT_DATA_FAILED message can be captured, indicating that the data coverage has failed.
Conformity requirement 1:
Precondition: No user data table has been created.
Test method: Call restoreDefault().
Conformity result: Return true to indicate the start of execution. If the execution is successful, the MSG_RESTORE_TO_DEFAULT_SUCCESS message can be captured, indicating that the data recovery is successful.
Conformity requirement 2:
Precondition: The system has no default data.
Test method: Call restoreDefault().
Conformity result: Return false to indicate that the execution is not successful. If the execution is unsuccessful, the MSG_RESTORE_TO_DEFAULT_FAILED message can be captured, indicating that the data recovery has failed.
Conformity requirement:
Precondition: Call uninstallDeviceByID function with valid URL.
Test method: Get event message events.
Conformity result: The web page receives a message of MSG_DEVICE_UNINSTALL_SUCCESS.
Conformity requirement:
Precondition: Call uninstallDeviceByID function with invalid URL.
Test method: Get event message events.
Conformity result: The web page receives a message of MSG_DEVICE_UNINSTALL_FAILED.
Conformity requirements:
Precondition: None.
Test method: Call getAllStorageDevices().
Conformity result: Return an array of Storage Device objects.
Conformity requirement 1:
Precondition: Call getAllStorageDevices().
Test method: Call uninstallDeviceByID().
Conformity result: Return true to indicate the start of execution. If the execution is successful, the MSG_UNINSTALL_DEVICE_SUCCESS message can be captured, indicating that the uninstallation is successful.
Conformity requirement 2:
Precondition: None.
Test method: Call uninstallDeviceByID().
Conformity result: Return false to indicate that it is not executed. If the execution is unsuccessful, the MSG_UNINSTALL_DEVICE_FAILED message can be captured, indicating that the uninstallation has failed.
Conformity requirements:
Precondition: Call getAllStorageDevices().
Test method: Determine storageDevice.id.
Conformity result: The value is defined, and the storage device unique identifier is successfully obtained.
Conformity requirements:
Precondition: Call getAllStorageDevices().
Test method: Determine storageDevice.name.
Conformity result: The value is not empty, and the storage device name is successfully obtained.
Conformity requirements:
Precondition: Call getAllStorageDevices().
Test method: Determine storageDevice.status.
Conformity result: The value is defined, and the status information of the storage device is successfully obtained.
Conformity requirements:
Precondition: Call getAllStorageDevices().
Test method: Determine the storageDevice.serialNumber.
Conformity result: The value is defined and the storage device serial number is successfully obtained.
Conformity requirements:
Precondition: None.
Test method: Call getAllPartitions().
Conformity result: Return an array of Storage Partition objects.
Conformity requirements:
Precondition: Call getAllStorageDevices().
Test method: Call getPartitionByID().
ition | id | Conformity requirements:
Precondition: Call getAllPartitions().
Test method: Determine the StoragePartition.id.
Conformity result: If there is a value assigned, then the partition ID is obtained successfully. | +| 24 | | name | Conformity requirements:
Precondition: Call getAllPartitions().
Test method: Determine the StoragePartition.name.
Conformity result: If there is a value assigned, the storage device partition name is obtained successfully. | +| 25 | | totalSize | Conformity requirements:
Precondition: Call getAllPartitions().
Test method: Determine the StoragePartition.totalSize.
Conformity result: If there is a value assigned, the storage device partition space size is successfully obtained. | +| 26 | | freeSize | Conformity requirements:
Precondition: Call getAllPartitions().
Test method: Determine the StoragePartition.freeSize.
Conformity result: If there is a value assigned, the free space size of the storage device partition is successfully obtained. | +| 27 | | path | Conformity requirements:
Precondition: Call getAllPartitions().
Test method: Determine the StoragePartition.path.
Conformity result: If there is a value assigned, the access path to the storage device partition is successfully obtained. | +| 28 | | fsType | Conformity requirements:
Precondition: Call getAllPartitions().
Test method: Determine the StoragePartition.fsType.
Conformity result: If there is a value assigned, the partition file system type is successfully obtained. | +| 29 | | fsStatus | Conformity requirements:
Precondition: Call getAllPartitions().
Test method: Determine StoragePartition.fsStatus.
Conformity result: If there is a value assigned, the storage device partition status is successfully obtained. | +| 30 | | MSG_COPYFILE_SUCC
ESS | Conformity requirement:
Precondition: Call the copyFile function with valid parameters. | + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|-------------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 31 | FileManager | | Test method: Get event message events.
Conformity result: The web page receives a message of MSG_COPYFILE_SUCCESS. | +| 32 | | MSG_FILE_NOT_EXIST | Conformity requirement:
Precondition: Call the copyFile function, source file does not exist.
Test method: Get event message events.
Conformity result: The web page receives a message of MSG_FILE_NOT_EXIST. | +| 33 | | MSG_MOVEFILE_SUCCESS | Conformity requirement:
Precondition: Call the moveFile function with valid URL.
Test method: Get event message events.
Conformity result: The web page receives a message of MSG_MOVEFILE_SUCCESS. | +| 34 | | MSG_DELETEFILE_SUCCESS | Conformity requirement:
Precondition: Call deleteFile function with valid URL.
Test method: Get event message events.
Conformity result: The web page receives a message of MSG_DELETEFILE_SUCCESS. | +| 35 | | MSG_COPYDIRECTORY_SUCCESS | Conformity requirement:
Precondition: Call the copyDirectory function with valid URL.
Test method: Get event message events.
Conformity result: The web page receives a message of MSG_COPYDIRECTORY_SUCCESS. | +| 36 | | MSG_MOVEDIRECTORY_SUCCESS | Conformity requirement:
Precondition: Call the moveDirectory function with valid URL.
Test method: Get event message events.
Conformity result: The web page receives a message of MSG_MOVEDIRECTORY_SUCCESS. | +| 37 | | MSG_DELETEDIRECTORY_SUCCESS | Conformity requirement:
Precondition: Call the deleteDirectory function with valid URL.
Test method: Get event message events.
Conformity result: The web page receives a message of MSG_DELETEDIRECTORY_SUCCESS. | +| | | MSG_COPYFILE_FAILED | Conformity requirement:
Precondition: Calling the copyFile function, the target path does not exist.
Test method: Get event message events.
Conformity result: The web page receives a message of MSG_COPYFILE_FAILED. | + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|--------|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 38 | | MSG_SPACE_SHORTAGE | Conformity requirement:
Precondition: Call the copyFile function, the target file system is full of storage.
Test method: Get event message events.
Conformity result: The web page receives a message as MSG_SPACE_SHORTAGE. | +| 39 | | MSG_MOVEFILE_FAILED | Conformity requirement:
Precondition: Call the moveFile function, source file is read-only.
Test method: Get event message events.
Conformity result: The web page receives a message as MSG_MOVEFILE_FAILED. | +| 40 | | MSG_CANNOT_DELETE_FILE | Conformity requirement:
Precondition: Call deleteFile function, source file is read-only.
Test method: Get event message events.
Conformity result: The web page receives a message of MSG_CANNOT_DELETE_FILE. | +| 41 | | MSG_DELETEFILE_FAILED | Conformity requirement:
Precondition: Call deleteFile function, source file is read-only.
Test method: Get event message events.
Conformity result: The web page receives a message of MSG_DELETEFILE_FAILED. | +| 42 | | MSG_COPYDIRECTORY_FAILED | Conformity requirement:
Precondition: Call the copyDirectory function, the target directory does not exist.
Test method: Get event message events.
Conformity result: The web page receives a message of MSG_COPYDIRECTORY_FAILED. | +| 43 | | MSG_DIRECTORY_NOT_EXIST | Conformity requirement:
Precondition: Call the copyDirectory function, source directory does not exist.
Test method: Get event message events.
Conformity result: The web page receives a message of MSG_DIRECTORY_NOT_EXIST. | +| 44 | | MSG_MOVEDIRECTORY_FAILED | Conformity requirement:
Precondition: Call the moveDirectory function, source directory does not exist.
Test method: Get event message events.
Conformity result: The web page receives a message of MSG_MOVEDIRECTORY_FAILED. | +| 45 | | MSG_DELETEDIRECTORY_FAILED | Conformity requirement:
Precondition: Call deleteDirectory function, source directory does not exist.
Test method: Get event message events.
Conformity result: The web page receives a | + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|--------|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | message of
MSG_DELETEDIRECTORY_FAILED. | +| 46 | | MSG_CANNOT_DELETE_DIRECTORY | Conformity requirement:
Precondition: Call deleteDirectory function, source directory is read-only.
Test method: Get event message events.
Conformity result: The web page receives a message of
MSG_CANNOT_DELETE_DIRECTORY. | +| 47 | | copyFile(path1, path2) | Conformity requirement 1:
Precondition: None.
Test method: Call copyFile().
Conformity result: Return true to indicate the start of execution, and capture the message
MSG_COPYFILE_SUCCESS, indicating successful replication.
Conformity requirement 2:
Precondition: The source file does not exist.
Test method: Call copyFile().
Conformity result: Return true to indicate the start of execution, and capture message
MSG_FILE_NOT_EXIST, indicating that the source file does not exist.
Conformity requirement 3:
Precondition: The target file system storage is full.
Test method: Call copyFile().
Conformity result: Return true to indicate the start of execution, and capture the message
MSG_SPACESHORTAGE, indicating that the storage space of the target path is insufficient. | +| 48 | | moveFile(path1, path2) | Conformity requirement 1:
Precondition: None.
Test method: Call moveFile().
Conformity result: Return true to indicate the start of execution, and capture the message
MSG_MOVEFILE_SUCCESS, indicating a successful move.
Conformity requirement 2:
Precondition: The source file does not exist.
Test method: Call moveFile().
Conformity result: Return false to indicate that it is not executed, and capture message
MSG_FILE_NOT_EXIST, indicating that the source file does not exist.
Conformity requirement 3:
Precondition: The target file system storage is full.
Test method: Call moveFile().
Conformity result: Return false to indicate that it is not executed, and capture message | + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|--------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | MSG_SPACESHORTAGE, indicating that the storage space of the target path is insufficient. | +| 49 | | deleteFile(path) |
Conformity requirement 1:
Precondition: None.
Test method: Call deleteFile().
Conformity result: Return true to indicate the start of execution, and capture the message MSG_DELETEFILE_SUCCESS to indicate successful deletion.
Conformity requirement 2:
Precondition: The source file does not exist.
Test method: Call deleteFile().
Conformity result: Return false to indicate that it is not executed, and capture message MSG_DELETE_FAILED to indicate deletion failure.
Conformity requirement 1:
Precondition: None.
Test method: Call existLocalFile().
Conformity result: Return true to indicate the existence of the file.
Conformity requirement 2:
Precondition: The source file does not exist.
Test method: Call existLocalFile().
Conformity result: Return false to indicate that the file does not exist.
Conformity requirement 1:
Precondition: None.
Test method: Call copyDirectory().
Conformity result: Return true to indicate the start of execution, captures message MSG_COPYDIRECTORY_SUCCESS, indicating successful replication.
Conformity requirement 2:
Precondition: The source directory does not exist.
Test method: Call copyDirectory().
Conformity result: Return false to indicate that the file is not executed, and captures message MSG_DIRECTORY_NOT_EXIST, indicating that the source file does not exist.
Conformity requirement 3:
Precondition: The target file system storage is full.
Test method: Call copyDirectory().
Conformity result: Return false to indicate that it is not executed, capture message MSG_SPACESHORTAGE, indicating that the storage space of the target path is insufficient.
Conformity requirement 1:
Precondition: None.
Test method: Call moveDirectory().
Conformity result: Return true to indicate the start of execution, and capture message MSG_MOVEDIRECTORY_SUCCESS, indicating successful move.
Conformity requirement 2:
Precondition: The source directory does not exist
Test method: Call moveDirectory().
Conformity result: Return false to indicate that the file is not executed, and capture message MSG_DIRECTORY_NOT_EXIST to indicate that the source file does not exist.
Conformity requirement 3:
Precondition: The target file system storage is full.
Test method: Call moveDirectory().
Conformity result: Return false to indicate that it is not executed, and captures message MSG_SPACESHORTAGE, indicating that the storage space of the target path is insufficient.
Conformity requirement 4:
Precondition: Source directory is read-only.
Test method: Call moveDirectory().
Conformity result: Return false to indicate that it has not been executed, and capture message MSG_CANNOT_DELETE_DIRECTORY to indicate that the source file cannot be deleted.
Conformity requirement 1:
Precondition: None.
Test method: Call deleteDirectory().
Conformity result: Return true to indicate the start of execution, and capture the message MSG_DELETEDIRECTORY_SUCCESS to indicate successful deletion.
Conformity requirement 2:
Precondition: Source directory is read-only.
Test method: Call deleteDirectory().
Conformity result: Return false to indicate that the deletion is not executed, and capture message MSG_DELETEDIRECTORY_FAILED to indicate that the deletion has failed.
Conformity requirement 1:
Precondition: None.
Test method: Call existDirectory().
Conformity result: Return true to indicate that the directory exists.
Conformity requirement 2:
Precondition: The source directory does not exist.
Test method: Call existDirectory().
Conformity result: Return false to indicate that the
Conformity requirement 1:
Precondition: None.
Test method: Call downloadremoteFile().
Conformity result: Capture message MSG_DOWNLOAD_REMOTE_FILE_SUCCESS to indicate successful download.
Conformity requirement 2:
Precondition: None.
Test method: Call downloadremoteFile() to pass in exception parameters.
Conformity result: Capture message MSG_DOWNLOAD_REMOTEFILE_NOT_EXISTS to indicate that there are no files to download on the front end.
Conformity requirement 3:
Precondition: None.
Test method: Call downloadremoteFile() to pass in exception parameters.
Conformity result: Capture message MSG_DOWNLOAD_REMOTE_FILEFAILED to indicate download failure.
Conformity requirement 4:
Precondition: None.
Test method: Call downloadremoteFile().
Conformity result: Capture message MSG_DOWNLOAD_FILE_TIMEOUT to indicate that the specified time for endureTime has passed and the file download has not yet been completed.
Conformity requirement:
Precondition: Call downloadRemoteFile() and receive message MSG_DOWNLOAD_REMOTE_FILE_SUCCESS.
Test method: Call getremoteFile().
Conformity result: Return a file object of type FileObj.
Conformity requirement 1:
Precondition: Call downloadRemoteFile() to receive the message MSG_DOWNLOAD_REMOTE_FILE_SUCCESS and then call getRemoteFile().
Test method: Call killObject().
Conformity result: The return value of 1 indicates successful removal.
Conformity requirement 2:
Precondition: Call downloadRemoteFile() to receive the message MSG_DOWNLOAD_REMOTE_FILE_SUCCESS and then call getRemoteFile().
killObject () .Conformity result: The return value of 0 indicates that removal has failed. | +| 58 | Directory |
name | Conformity requirements:Precondition: Call
Directory() and getDirList() in sequence.Test method: Determine
directory.name .Conformity result: If there is a value assigned, the directory name is successfully obtained. | +| 59 | |
path | Conformity requirements:Precondition: Call
Directory() and getDirList() in sequence.Test method: Determine
directory.path .Conformity result: If there is a value assigned, the directory is successfully obtained. | +| 60 | |
Directory(path) | Conformity requirements:Precondition: None.
Test method: Call
Directory() .Conformity result: Return the
Directory object. |
+| 61 | | getFileList() | Conformity requirements:Precondition: Call
Directory() .Test method: Call
getFileList() .Conformity result: File object array. If the directory does not contain any files, the returned array length is 0. | +| 62 | |
getDirList() | Conformity requirements:Precondition: Call
Directory() sequentially.Test method: Call
getDirList() .Conformity result: Return directory object array, if the directory does not contain any subdirectories, the returned array length is 0. | +| 63 | |
size | Conformity requirements:Precondition: Call
FileObj() to retrieve the object.Test method: Determine
fileobj.size .Conformity result: If there is a value assigned, the file size is successfully obtained. | +| 64 | FileObj |
name | Conformity requirements:Precondition: Call
FileObj() to retrieve the object.Test method: Determine
fileobj.name .Conformity result: If there is a value assigned, the file name is successfully obtained. | +| 65 | |
path | Conformity requirements:Precondition: Call
FileObj() to retrieve the object.Test method: Determine
fileobj.path .Conformity result: If there is a value assigned, the absolute path where the file is located is successfully obtained. | + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|--------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 66 | | FileObj(locator) | Conformity requirements:
Precondition: None.
Test method: Call FileObj().
Conformity result: Return the FileObj object. | +| 67 | | open(mode) | Conformity requirement 1:
Precondition: Call FileObj().
Test method: Call open().
Conformity result: The return value of 1 indicates successful opening.
Conformity requirement 2:
Precondition: Call FileObj().
Test method: Call open() to pass in exception parameters.
Conformity result: The return value of 0 indicates an open failure. | +| 68 | | close() | Conformity requirement 1:
Precondition: Call FileObj() and open() in sequence.
Test method: Call close().
Conformity result: The return value of 1 indicates successful closure.
Conformity requirement 2:
Precondition: Call FileObj().
Test method: Call close().
Conformity result: The return value of 0 indicates a failure to close. | +| 69 | | readFile(len) | Conformity requirements:
Precondition: Call FileObj() and open() in sequence.
Test method: Call readFile().
Conformity result: Return string, which returns the readings as a string. | +| 70 | | readAllFile() | Conformity requirements:
Precondition: Call FileObj() and open() in sequence.
Test method: Call readAllFile().
Conformity result: Return string, which returns the readings as a string. | +| 71 | | type | Conformity requirements:
Precondition: Call AudioFile() to retrieve the object.
Test method: Determine the audioFile.type.
Conformity result: If there is a value assigned, the audio file type is successfully obtained. | +| 72 | | fileName | Conformity requirements:
Precondition: Call AudioFile() to retrieve the object. | + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|-----------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | AudioFile | | Test method: Determine audioFile.fileName.
Conformity result: If there is a value assigned, the audio locator is successfully obtained. | +| 73 | | location | Conformity requirements:
Precondition: Call AudioFile() to retrieve the object.
Test method: Determine audioFile.location.
Conformity result: If there is a value assigned, the audio file name is successfully obtained. | +| 74 | | fileSize | Conformity requirements:
Precondition: Call AudioFile() to retrieve the object.
Test method: Determine the audioFile.fileSize.
Conformity result: If there is a value assigned, the audio file is successfully obtained. | +| 75 | | sampleRate | Conformity requirements:
Precondition: Call AudioFile() to retrieve the object.
Test method: Determine the audioFile.sampleRate.
Conformity result: If there is a value assigned, the sampling rate is successfully obtained. | +| 76 | | numberOfChannels | Conformity requirements:
Precondition: Call AudioFile() to retrieve the object.
Test method: Determine audioFile.numberOfChannels.
Conformity result: If there is a value assigned, the number of channels is successfully obtained. | +| 77 | | Duration | Conformity requirements:
Precondition: Call AudioFile() to retrieve the object.
Test method: Determine audioFile.duration.
Conformity result: If there is a value assigned, the playback time of the audio file is successfully obtained. | +| 78 | | AudioFile(path) | Conformity requirements:
Precondition: None.
Test method: Call AudioFile().
Conformity result: Return the AudioFile object. | +| 79 | | Date | Conformity requirements:
Precondition: Call AudioFile() to retrieve the object.
Test method: Determine audioFile.date.
Conformity result: If there is a value assigned, the audio release date is successfully obtained. | + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|-----------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 80 | | title | Conformity requirements:
Precondition: Call AudioFile() to retrieve the object.
Test method: Determine audioFile.title.
Conformity result: If there is a value assigned, the audio title is successfully obtained. | +| 81 | | artist | Conformity requirements:
Precondition: Call AudioFile() to retrieve the object.
Test method: Determine audioFile.artist.
Conformity result: If there is a value assigned, the artist/performer is successfully obtained. | +| 82 | | album | Conformity requirements:
Precondition: Call AudioFile() to retrieve the object.
Test method: Determine audioFile.album.
Conformity result: If there is a value assigned, the album name is successfully obtained. | +| 83 | VideoFile | VideoFile(path) | Conformity requirements:
Precondition: None.
Test method: Call VideoFile().
Conformity result: Return the VideoFile object. | +| 84 | | typeContainer | Conformity requirements:
Precondition: Call VideoFile() to retrieve the object.
Test method: Determine the videoFile.typeContainer.
Conformity result: If there is a value assigned, the encapsulation format is successfully obtained. | +| 85 | | typeVideo | Conformity requirements:
Precondition: Call VideoFile() to retrieve the object.
Test method: Determine videoFile.typeVideo.
Conformity result: If there is a value assigned, the video type is successfully obtained. | +| 86 | | typeAudio | Conformity requirements:
Precondition: Call VideoFile() to retrieve the object.
Test method: Determine videoFile.typeAudio.
Conformity result: If there is a value assigned, the accompanying audio type is successfully obtained. | +| 87 | | location | Conformity requirements:
Precondition: Call VideoFile() to retrieve the object.
Test method: Determine videoFile.location.
Conformity result: If there is a value assigned, the video file locator is successfully obtained. | + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|-----------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 88 | VideoFile | fileName | Conformity requirements:
Precondition: Call VideoFile() to retrieve the object.
Test method: Determine videoFile.fileName.
Conformity result: If there is a value assigned, the video file name is successfully obtained. | +| 89 | | fileSize | Conformity requirements:
Precondition: Call VideoFile() to retrieve the object.
Test method: Determine the videoFile.fileSize.
Conformity result: If there is a value assigned, the video file size is successfully obtained. | +| 90 | | bitRate | Conformity requirements:
Precondition: Call VideoFile() to retrieve the object.
Test method: Determine the videoFile.bitRate.
Conformity result: If there is a value assigned, the playback rate is successfully obtained. | +| 91 | | duration | Conformity requirements:
Precondition: Call VideoFile() to retrieve the object.
Test method: Determine videoFile.duration.
Conformity result: If there is a value assigned, the file playback time is successfully obtained. | +| 92 | | width | Conformity requirements:
Precondition: Call VideoFile() to retrieve the object.
Test method: Determine videoFile.width.
Conformity result: If there is a value assigned, the video width is successfully obtained. | +| 93 | | height | Conformity requirements:
Precondition: Call VideoFile() to retrieve the object.
Test method: Determine videoFile.height.
Conformity result: If there is a value assigned, the video heigth is successfully obtained. | +| 94 | | aspectRatio | Conformity requirements:
Precondition: Call VideoFile() to retrieve the object.
Test method: Determine the videoFile.aspectRatio.
Conformity result: If there is a value assigned, the video aspect ratio is successfully obtained. | +| 95 | | Fps | Conformity requirements:
Precondition: Call VideoFile() to retrieve the object.
Test method: Determine videoFile.fps.
Conformity result: If there is a value assigned, the video frame rate is successfully obtained. | + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|-----------|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 96 | | sampleRate | Conformity requirements:
Precondition: Call VideoFile() to retrieve the object.
Test method: Determine the videoFile.sampleRate.
Conformity result: If there is a value assigned, the sampling rate of the accompanying audio is successfully obtained. | +| 97 | | numberOfChannels | Conformity requirements:
Precondition: Call VideoFile() to retrieve the object.
Test method: Determine videoFile.numberOfChannel.
Conformity result: If there is a value assigned, the number of channels is successfully obtained. | +| 98 | ImageFile | ImageFile(path) | Conformity requirements:
Precondition: None.
Test method: Call ImageFile().
Conformity result: Return the ImageFile object. | +| 99 | | type | Conformity requirements:
Precondition: Call ImageFile() to retrieve the object.
Test method: Determine imageFile.type.
Conformity result: If there is a value assigned, the type of the image file is successfully obtained. | +| 100 | | Location | Conformity requirements:
Precondition: Call ImageFile() to retrieve the object.
Test method: Determine imageFile.location.
Conformity result: If there is a value assigned, the locator for the image file is successfully obtained. | +| 101 | | filename | Conformity requirements:
Precondition: Call ImageFile() to retrieve the object.
Test method: Determine imageFile.fileName.
Conformity result: If there is a value assigned, the name of the image file is successfully obtained. | +| 102 | | width | Conformity requirements:
Precondition: Call ImageFile() to retrieve the object.
Test method: Determine imageFile.width.
Conformity result: If there is a value assigned, the width of the image file is successfully obtained. | +| 103 | | height | Conformity requirements:
Precondition: Call ImageFile() to retrieve the object.
Test method: Determine imageFile.height.
Conformity result: If there is a value assigned, the height of the image file is obtained successfully. | + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|-------------------|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 104 | Utility | getEventInfo(id) | Conformity requirements:
Precondition: None.
Test method: Call getEventInfo().
Conformity result: Return a string type, indicating detailed description information of the message. | +| 105 | | println(str) | Conformity requirements:
Precondition: None.
Test method: Call println().
Conformity result: No return. | +| 106 | GlobalVar Manager | setItemValue(key, value) | Conformity requirements:
Precondition: None.
Test method: Call setItemValue().
Conformity result: The return value of getItemValue() is compared with the value of the global variable parameter set by setItemValue(), if it is the same, then it succeeds. | +| 107 | | getItemValue(key) | Conformity requirements:
Precondition: Call setItemValue().
Test method: Call getItemValue().
Conformity result: If the return value is the same as the global variable parameter value set by setItemValue(), the comparison is successful. | +| 108 | | setItemStr(key, str) | Conformity requirements:
Precondition: None.
Test method: Call setItemStr().
Conformity result: If the return value of calling getItemStr() is compared with the global variable parameter value set by setItemStr(), if it is the same, then it succeeds. | +| 109 | | getItemStr(key) | Conformity requirements:
Precondition: Call setItemStr().
Test method: Call getItemStr().
Conformity result: If the return value is the same as the global variable parameter value set by setItemStr(), then it succeeds. | +| 110 | | removeItem(key) | Conformity requirements:
Precondition: Call setItemStr().
Test method: Call removeItem().
Conformity result: If the return value of calling getItemStr() is null, it is successful. | +| 111 | | clearAll() | Conformity requirements:
Precondition: Call setItemStr().
Test method: Call clearAll().
Conformity result: If the return value of the call to getItemStr() is null, it is successful. | + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|-----------|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 112 | Rectangle | left | Conformity requirements:
Precondition: None.
Test method: Determine Rectangle.left.
Conformity result: If there is a value assigned, the X_axis coordinate of the upper left corner of the Rectangle object is successfully obtained. | +| 113 | | top | Conformity requirements:
Precondition: None.
Test method: Determine Rectangle.top.
Conformity result: If there is a value assigned, the Y_axis coordinate of the upper left corner of the Rectangle object is successfully obtained. | +| 114 | | width | Conformity requirements:
Precondition: None.
Test method: Determine Rectangle.width.
Conformity result: If there is a value assigned, the Rectangle object width is successfully obtained. | +| 115 | | height | Conformity requirements:
Precondition: None.
Test method: Determine Rectangle.height.
Conformity result: If there is a value assigned, the height of the Rectangle object is obtained successfully. | +| 116 | | Rectangle(left, top, width, height) | Conformity requirements:
Precondition: None.
Test method: Call Rectangle().
Conformity result: No return value. | +| 117 | SysTool | standBy() | Conformity requirements:
Precondition: None.
Test method: Call standBy().
Conformity result: The device inputs standby mode. | +| 118 | | sleep() | Conformity requirements:
Precondition: None.
Test method: Call sleep().
Conformity result: The device inputs sleep mode. | +| 119 | | wakeUp() | Conformity requirements:
Precondition: sleep().
Test method: Call wakeUp().
Conformity result: Wake up the device. | +| 120 | | getStandByState() | Conformity requirement 1:
Precondition: None.
Test method: Call getStandByState().
Conformity result: The return value of 3 indicates that the device is working properly.
Conformity requirement 2:
Precondition: Call sleep(). | + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|--------------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | HardwareInfo | | Test method: Call getStandByState().
Conformity result: The return value of 1 indicates that the device is truly on standby.
Conformity requirement 3:
Precondition: Call standBy().
Test method: Call getStandByState().
Conformity result: The return value of 2 indicates that the device is in false standby. | +| 121 | | reboot() | Conformity requirements:
Precondition: None.
Test method: Call reboot().
Conformity result: Restart the device. | +| 122 | | Flash.size | Conformity requirements:
Precondition: None.
Test method: Determine HardwareInfo.Flash.size.
Conformity result: If there is a value assigned, the size of the receiving terminal's flash memory is successfully obtained. | +| 123 | | RAM.size | Conformity requirements:
Precondition: None.
Test method: Determine HardwareInfo.RAM.size.
Conformity result: If there is a value assigned, the size of the receiving terminal memory is successfully obtained. | +| 124 | | RAM.type | Conformity requirements:
Precondition: None.
Test method: Determine HardwareInfo.RAM.type.
Conformity result: If there is a value assigned, the type of receiving terminal memory is successfully obtained. | +| 125 | | SOC.model | Conformity requirements:
Precondition: None.
Test method: Determine HardwareInfo.SOC.model.
Conformity result: If there is a value assigned, the model of the receiving terminal's main chip is successfully obtained. | +| 126 | | SOC.frequency | Conformity requirements:
Precondition: None.
Test method: Determine HardwareInfo.SOC.frequency.
Conformity result: If there is a value assigned, the working frequency of the receiving terminal's main chip is successfully obtained. | +| 127 | | SOC.provider | Conformity requirements:
Precondition: None.
Test method: Determine HardwareInfo.SOC.provider.
Conformity result: If there is a value assigned, the | + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|--------------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | HardwareInfo | | provider name of the receiving terminal's main chip is successfully obtained. | +| 128 | | HW.version | Conformity requirements:
Precondition: None.
Test method: Determine HardwareInfo.HW.version.
Conformity result: If there is a value assigned, obtaining the hardware version number of the receiving terminal is successful. | +| 129 | | STB.TPtype | Conformity requirements:
Precondition: None.
Test method: Determine HardwareInfo.STB.TPtype.
Conformity result: If there is a value assigned, the transmission mode type of the receiving terminal is successfully obtained. | +| 130 | | STB.definition | Conformity requirements:
Precondition: None.
Test method: Determine HardwareInfo.STB.definition.
Conformity result: If there is a value assigned, the clarity type of the receiving terminal is successfully obtained. | +| 131 | | STB.provider | Conformity requirements:
Precondition: None.
Test method: Determine HardwareInfo.STB.provider.
Conformity result: If there is a value assigned, the provider name of the receiving terminal is successfully obtained. | +| 132 | | STB.brand | Conformity requirements:
Precondition: None.
Test method: Determine HardwareInfo.STB.brand.
Conformity result: If there is a value assigned, the brand name of the receiving terminal is successfully obtained. | +| 133 | | STB.model | Conformity requirements:
Precondition: None.
Test method: Determine HardwareInfo.STB.model.
Conformity result: If there is a value assigned, the model of the receiving terminal is successfully obtained. | +| 134 | | STB.serialnumber | Conformity requirements:
Precondition: None.
Test method: Determine HardwareInfo.STB.serialnumber.
Conformity result: If there is a value assigned, the serial number of the receiving terminal is | + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|--------------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | successfully obtained. | +| 135 | HardwareInfo | STB.returnPath | Conformity requirements:
Precondition: None.
Test method: Determine HardwareInfo.STB.returnPath.
Conformity result: If there is a value assigned, the return channel attribute of the receiving terminal is successfully obtained. | +| 136 | | OS.name | Conformity requirements:
Precondition: None.
Test method: Determine SoftwareInfo.OS.name.
Conformity result: If there is a value assigned, the name of the operating system software is successfully obtained. | +| 137 | | OS.version | Conformity requirements:
Precondition: None.
Test method: Determine SoftwareInfo.OS.version.
Conformity result: If there is a value assigned, the version number of the operating system software is successfully obtained. | +| 138 | SoftwareInfo | OS.provider | Conformity requirements:
Precondition: None.
Test method: Determine SoftwareInfo.OS.provider.
Conformity result: If there is a value assigned, the provider name of the operating system software is successfully obtained. | +| 139 | | middleware.name | Conformity requirements:
Precondition: None.
Test method: Determine SoftwareInfo.middleware.name.
Conformity result: If there is a value assigned, the name of the system software is successfully obtained. | +| 140 | | middleware.version | Conformity requirements:
Precondition: None.
Test method: Determine SoftwareInfo.middleware.version.
Conformity result: If there is a value assigned, the version number of the system software is successfully obtained. | +| 141 | | middleware.provider | Conformity requirements:
Precondition: None.
Test method:
DetermineSoftwareInfo.middleware.provider.
Conformity result: If there is a value assigned, the provider name of the system software is successfully obtained. | + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|--------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 142 | | middleware.releaseDate | Conformity requirements:
Precondition: None.
Test method: Determine SoftwareInfo.middleware.releaseDate.
Conformity result: If there is a value assigned, the release date of the system software is successfully obtained. | +| 143 | | middleware.copyright | Conformity requirements:
Precondition: None.
Test method: Determine SoftwareInfo.middleware.copyright.
Conformity result: If there is a value assigned, the copyright information of the system software is successfully obtained. | +| 144 | | middleware.RAMSize | Conformity requirements:
Precondition: None.
Test method: Determine SoftwareInfo.middleware.RAMSize.
Conformity result: If there is a value assigned, the memory size occupied by the system software is successfully obtained. | +| 145 | | middleware.NVMSize | Conformity requirements:
Precondition: None.
Test method: Determine SoftwareInfo.middleware.NVMSize.
Conformity result: If there is a value assigned, the non-volatile memory (NVM) size occupied by the system software is successfully obtained. | +| 146 | | middleware.platform_profile | Conformity requirements:
Precondition: None.
Test method: Determine SoftwareInfo.middleware.platform_profile.
Conformity result: If there is a value assigned, the platform level supported by the system software is successfully obtained. | +| 147 | | loader.name | Conformity requirements:
Precondition: None.
Test method: Determine SoftwareInfo.loader.name.
Conformity result: If there is a value assigned, the name of the software update loader is successfully obtained. | +| 148 | | loader.version | Conformity requirements:
Precondition: None.
Test method: Determine SoftwareInfo.loader.version.
Conformity result: If there is a value assigned, the version number of the software update loader is successfully obtained. | + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|---------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 149 | | loader.provider | Conformity requirements:
Precondition: None.
Test method: Determine SoftwareInfo.loader.provider.
Conformity result: If there is a value assigned, the provider of the software update loader is successfully obtained. | +| 150 | | loader.size | Conformity requirements:
Precondition: None.
Test method: Determine SoftwareInfo.loader.size.
Conformity result: If there is a value assigned, the size of the software update loader is successfully obtained. | +| 151 | | CA.name | Conformity requirements:
Precondition: None.
Test method: Determine SoftwareInfo.CA.name.
Conformity result: If there is a value assigned, the name of the CA software is successfully obtained. | +| 152 | | CA.version | Conformity requirements:
Precondition: None.
Test method: Determine SoftwareInfo.CA.version.
Conformity result: If there is a value assigned, the version number of the CA software is successfully obtained. | +| 153 | | CA.provider | Conformity requirements:
Precondition: None.
Test method: Determine SoftwareInfo.CA.provider.
Conformity result: If there is a value assigned, the provider of CA software is successfully obtained. | +| 154 | | Driver.vision | Conformity requirements:
Precondition: None.
Test method: Determine SoftwareInfo.Driver.vision.
Conformity result: If there is a value assigned, the driver version of the receiving terminal is successful. | +| 155 | Upgrade | checkOTA() | Conformity requirement 1:
Precondition: Deploy new OTA upgrade packages for front-end upgrade services.
Test method: Call checkOTA().
Conformity result: Return true to indicate OTA upgrade.
Conformity requirement 2:
Precondition: The front-end upgrade service has not deployed a new OTA upgrade package.
Test method: Call checkOTA().
Conformity result: Return false to indicate no OTA upgrade. | + +| Serial No. | Object | Interface and Attribute | Process description | +|------------|--------|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 156 | | startOTA() | Conformity requirements:
Precondition: Deploy new OTA upgrade packages for front-end upgrade services.
Test method: Call startOTA().
Conformity result: Start OTA upgrade. | +| 157 | | getOTAName() | Conformity requirements:
Precondition: None.
Test method: Call getOTAName().
Conformity result: Return string type, indicating the name of the OTA upgrade event. | + +### B.10 Conformance test of application engine unit interfaces + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|---------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | EPGManager | MSG_EPG_SEARCH_SUCCESS | Conformity requirements:
Precondition: The system is connected to a cable and there is EIT data at the network frequency.
Test method: Call searchProgramEvent(tsList, mask, endureTime) and search successfully.
Conformity result: The web page received a message of MSG_EPG_SEARCH_SUCCESS. | +| 2 | | searchProgramEvent(tsList, mask, endureTime) | Conformity requirements:
Precondition: None.
Test method: Call searchProgramEvent(tsList, mask, endureTime).
Conformity result: The MSG_EPG_SEARCH_SUCCESS message is sent when the search is complete, the MSG_EPG_SEARCH_REFRESH message is sent when data is searched, and the search timeout message stops the search and sends the MSG_EPG_SEARCH_TIMEOUT message. Return an integer indicating the unique identifier (maskId) that is assigned by the system to the asynchronous process. | +| 3 | | searchProgramEventByService(serviceLocator, mask, endureTime) | Conformity requirements:
Precondition: None.
Test method: Call searchProgramEventByService(serviceLocator, mask, endureTime).
Conformity result: The MSG_EPG_SEARCH_SUCCESS message is sent when the search is complete, the MSG_EPG_SEARCH_REFRESH message is sent when data is found, and the MSG_EPG_SEARCH_TIMEOUT message is sent when the search times out. Return an integer indicating the unique identifier (maskId) assigned by the system to the asynchronous process. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 4 | | getPresentProgram(serviceLocator) |
Conformity requirement 1:
Precondition: Based on the testing environment conditions, the specified operations of serviceLocator can be obtained.
Test method: Call getPresentProgram (serviceLocator).
Conformity result: Return a ProgramEvent object that indicates the current ProgramEvent of the service described by serviceLocator.
Conformity requirement 2:
Precondition: Based on the testing environment conditions, the specified operations of serviceLocator cannot be obtained.
Test method: Call getPresentProgram (serviceLocator).
Conformity result: Return null.
Conformity requirement 1:
Precondition: None.
Test method: Call getPresentProgramsByContentType (contentType).
Conformity result: Return a ProgramEvent array containing all current ProgramEvents with a classification type of contentType.
Conformity requirement 2:
Precondition: Based on the testing environment conditions, the specified business for contentType cannot be obtained.
Test method: Call getPresentProgramsByContentType (contentType).
Conformity result: Return an array with a length of 0.
Conformity requirement 1:
Precondition: After calling the search interface of EPG and returning success, the str keyword is passed in and exists in the EIT list.
Test method: Call the getPresentProgramsByName (str) method.
Conformity result: Return the ProgramEvent array, which contains an array of all current ProgramEvent objects with the programme name str.
Conformity requirement 2:
Precondition: After calling the search interface of EPG and returning success, the str keyword passed in does not exist in the EIT list.
Test method: Call the getPresentProgramsByName (str) method.
Conformity result: Return an array of length 0.
Conformity requirement 1:
Precondition: After already calling the EPG's
search interface and returning success, pass in the correct address for serviceLocator.
Test method: Call getFollowingProgram(serviceLocator).
Conformity result: Return the subsequent programs to the array of ProgramEventd objects indicating the operations specified by serviceLocator.
Conformity requirement 2:
Precondition: After calling the search interface of EPG and returning success, the serviceLocator address passed in is incorrect.
Test method: Call getFollowingProgram(serviceLocator).
Conformity result: Return an array of length 0.
| +| 8 | | getFollowingProgramsByContentType(contentType) |Conformity requirement 1:
Precondition: After calling the search interface of EPG and returning success, the contentType passed in exists in the EIT list.
Test method: Call getFollowingProgramsByContentType(contentType).
Conformity result: Return an array of ProgramEvents containing all subsequent ProgramEvents classified as contentType.
Conformity requirement 2:
Precondition: After calling the search interface of EPG and returning success, the contentType passed in does not exist in the EIT list.
Test method: Call getFollowingProgramsByContentType(contentType).
Conformity result: Return an array of length 0.
| +| 9 | | getFollowingProgramsByName(str) |Conformity requirement 1:
Precondition: The str keyword passed in exists in the following programs of EIT.
Test method: Call getFollowingProgramsByName(str).
Conformity result: Return an array of ProgramEvents containing all subsequent ProgramEvents with the programme name str.
Conformity requirement 2:
Precondition: The str keyword passed in does not exist in the following programs of EIT.
Test method: Call getFollowingProgramsByName(str).
Conformity result: Return an array of length 0.
| +| 10 | | getProgramsByService(serviceLocator) |Conformity requirement 1:
Precondition: The serviceLocator locator passed in exists in the EIT.
Test method: Call getProgramsByService
| + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|---------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | EPGManager | | (serviceLocator).Conformity result: Return the ProgramEvent array, indicating all programs of the service specified by serviceLocator.
Conformity requirement 2:
Precondition: The serviceLocator locator passed in does not exist in EIT.
Test method: Call getProgramsByService (serviceLocator).
Conformity result: Return an array of length 0. | +| 11 | | getProgramsByDate(serviceLocator, beginDate, endDate) | Conformity requirement 1:
Precondition: The parameters passed in can be found in the EIT programme table.
Test method: Call getProgramsByDate (serviceLocator, beginDate, endDate).
Conformity result: Return the ProgramEvent array, indicating all programs in the serviceLocator's specified service that match the specified times.
Conformity requirement 2:
Precondition: The parameters passed in cannot be found in the EIT programme table.
Test method: Call getProgramsByDate (serviceLocator, beginDate, endDate).
Conformity result: Return an array of length 0. | +| 12 | | getProgramsByDirection(serviceLocator, beginDate, count, isForward) | Conformity requirement 1:
Precondition: The parameters passed in can be found in the EIT programme table.
Test method: Call getProgramsByDirection (serviceLocator, beginDate, count, isForward).
Conformity result: Return a ProgramEvent array with a length of count, indicating the programme information specified by serviceLocator for the specified start date and retrieval direction in the service
Conformity requirement 2:
Precondition: The parameters passed in cannot be found in the EIT programme table.
Test method: Call getProgramsByDirection (serviceLocator, beginDate, count, isForward). | +| 13 | | getProgramsByContentType(contentType) | Conformity requirement 1:
Precondition: The parameters passed in can be found in the EIT programme table.
Test method: Call getProgramsByContentType (contentType).
Conformity result: Return an array of ProgramEvents containing all ProgramEvents classified as contentType.
Conformity requirement 2:
Precondition: The parameters passed in cannot be | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | EPGManager | | found in the EIT programme table.
Test method: Call getProgramsByContentType(contentType).
Conformity result: Return an array of length 0. | +| 14 | | getProgramsByName(str) | Conformity requirement 1:
Precondition: The parameters passed in can find the programme in the EIT table.
Test method: Call getProgramsByName (str).
Conformity result: Return an array of ProgramEvents containing all ProgramEvents with programme name str.
Conformity requirement 2:
Precondition: The parameters passed in cannot be found in the EIT programme table.
Test method: Call getProgramsByName (str).
Conformity result: Return an array of length 0. | +| 15 | | MSG_EPG_SEARCH_EXCEED_MAX_COUNT | Conformity requirements:
Precondition: System frequency lock is normal.
Test method: In the data management module EPGSetting.program_event_maxcount is specified. Call the EPG search interface.
Conformity result: When the search results reach the maximum value, the search stops automatically and the web page receives the message MSG_EPG_SEARCH_EXCEED_MAX_COUNT. | +| 16 | | MSG_EPG_SEARCH_REFRESH | Conformity requirements:
Precondition: System frequency lock is normal.
Test method: Call the searchProgramEvent (tsList, mask, endureTime) interface to pass in the corresponding parameters for searching.
Conformity result: When EPG searches for partial data, the web page receives the message MSG_EPG_SEARCH_REFRESH. | +| 17 | | MSG_EPG_SEARCH_TIMEOUT | Conformity requirements:
Precondition: System frequency lock is normal.
Test method: Call searchProgramEvent (tsList, mask, endureTime) and exceed the specified time.
Conformity result: When no programme information is searched within the time period specified by the interface, the web page receives the message MSG_EPG_SEARCH_TIMEOUT. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 18 | | MSG_EPG_RECEIVE_N
VODREFERENCE_SUC
CESS | Conformity requirements:
Precondition: System frequency lock is normal.
Test method: Call searchProgramEvent (tsList, mask, endureTime) and receive NVOD data.
Conformity result: Send NVOD reference event success message to the page. The web page receives a message as MSG_EPG_RECEIVE_NVODREFERENCE_SU CCESS. | +| 19 | | MSG_EPG_RECEIVE_A
LL_NVODREFERENCE
_SUCCESS | Conformity requirements:
Precondition: System frequency lock is normal.
Test method: Call searchProgramEvent (tsList, mask, endureTime) and collect NVOD data.
Conformity result: Send a message to the page that all NVOD frequency data has been received. The web page receives the message MSG_EPG_RECEIVE_ALL_NVODREFERENC E_SUCCESS. | +| 20 | | MSG_EPG_RECEIVE_N
VODREFERENCE_TIM
EOUT | Conformity requirements:
Precondition: None.
Test method: Call searchProgramEvent(tsList, mask, endureTime) and NVOD reference data is received beyond the time limit.
Conformity result: Send a search timeout message to the page for NVOD reference events. The web page receives a message as MSG_EPG_RECEIVE_NVODREFERENCE_TIM EOUT. | +| 21 | | MSG_EPG_RECEIVE_N
VODTIMESHIFT_SUCC
ESS | Conformity requirements:
Precondition: The system can successfully lock the frequency.
Test method: Call searchProgramEvent (tsList, mask, endureTime) and receive time shifted event data.
Conformity result: Send a successful message to the page to receive a time shift event under a certain reference event. The web page receives the message MSG_EPG_RECEIVE_NVODTIMESHIFT_SUC CESS. | +| 22 | | MSG_EPG_RECEIVE_N
VODTIMESHIFT_TIME
OUT | Conformity requirements:
Precondition: None.
Test method: Call searchProgramEvent (tsList, mask, endureTime) and the data reception of time shift event exceeds the time limit.
Conformity result: Send the timeout message to the page for VOD time shift event. The web page receives a message as MSG_EPG_RECEIVE_NVODTIMESHIFT_TIM EOUT. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 23 | | searchNVODRefEvents(endureTime) |
Conformity requirements:
Precondition: None.
Test method: Call searchNVODRefEvents(endureTime).
Conformity result: Return an integer indicating the unique identifier (maskId) assigned by the system for this asynchronous process and sends a message to the page, where
MSG_EPG_RECEIVE_NVODREFERENCE_SUCCESS message indicates that the search for NVOD data on a frequency is successful.
MSG_EPG_RECEIVE_ALL_NVODREFERENCE_SUCCESS message indicates that the data of all NVOD frequencies have been received, and the MSG_EPG_RECEIVE_NVODREFERENCE_TIMEOUT message indicates that the searching time has reached endureTime.
Conformity requirements:
Precondition: None.
Test method: Call searchNVODRefEvents(tsArray, endureTime).
Conformity result: Return an integer indicating the unique identifier (maskId) assigned by the system to this asynchronous process and sends a message to the page, where
MSG_EPG_RECEIVE_NVODREFERENCE_SUCCESS message indicates that the search for NVOD data on a frequency is successful.
MSG_EPG_RECEIVE_ALL_NVODREFERENCE_SUCCESS message indicates that the data of all NVOD frequencies have been received, and the MSG_EPG_RECEIVE_NVODREFERENCE_TIMEOUT message indicates that the searching time has reached endureTime.
Conformity requirement 1:
Precondition: The serviceLocator passed in is correct and the corresponding channel has reference programs.
Test method: Call getReferencePrograms(serviceLocator).
Conformity result: Return an array of ReferenceEvent objects containing all the reference programs on the serviceLocator's specified service.
Conformity requirement 2:
Precondition: The serviceLocator passed in is incorrect, or the corresponding channel has reference programs.
Test method: Call getReferencePrograms(serviceLocator).
Conformity result: Return an array with a length of 0.
Conformity requirement 1:
Precondition: The passed in parameters are normal and there is a reference event present.
Test method: Call getReferenceEvents(sortType, sortOrder).
Conformity result: Return an array of ReferenceEvent objects containing all the ReferenceEvent objects that have been searched after sorting in the specified way.
Conformity requirement 2:
Precondition: The passed in parameter is abnormal or there is no reference event present.
Test method: Call getReferenceEvents(sortType, sortOrder).
Conformity result: Return an array with a length of 0.
Conformity requirements:
Precondition:
SearchNVODRefEvents(endureTime) or searchNVODRefEvents(tsArray, endureTime) are called.
Test method: Call exitNVODMode().
Conformity result: None.
Conformity requirement:
Precondition: Successfully create ProgramEvent object.
Test method: Read channelObj.
Conformity result: Successfully read, return the corresponding Channel object.
Conformity requirement:
Precondition: Successfully create ProgramEvent object.
Test method: Read eventObj.
Conformity result: Read successfully, return the corresponding DvbEvent object.
Conformity requirement:
Precondition: Successfully create ProgramEvent object.
Test method: Read and write eventObj.
Conformity result: Read and write successfully, 0 indicates unsubscribed, and 1 indicates subscribed.
Conformity requirement:
Precondition: Successfully create ReferenceEvent object.
Test method: Read channelObj.
Conformity result: Successfully read, return the corresponding Channel object.
Conformity requirement:
| + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|----------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | ReferenceEvent | |Precondition: Successfully create ReferenceEvent object.
Test method: Read eventObj.
Conformity result: Read successfully, return the corresponding DvbEvent object.
| +| 33 | | searchSchedules(endureTime) |Conformity requirements:
Precondition: Successfully create ReferenceEvent object.
Test method: Call searchSchedule(endureTime).
Conformity result: Return an integer where:
1 - Indicates that there is no data in the cache, the bottom layer will automatically go to lock the frequency, if receive data successfully, then issue a message MSG_EPG_RECEIVE_NVODTIMESHIFT_SUCCESS; when the search time reaches endureTime, the system automatically stops searching and sends out the message MSG_EPG_RECEIVE_NVODTIMESHIFT_TIMEOUT.
2 - Indicates that the NVOD time shift event information to be collected already exists in the cache and is complete, and can be directly obtained. At this point, no more messages will be returned to the page.
| +| 34 | | getSchedules() |Conformity requirement 1:
Precondition: There is a time shift business under this reference service.
Test method: Call getSchedules().
Conformity result: An array of TimeShiftEvent objects containing a list of all time-shift events within a number of days from this point in time for this reference event.
Conformity requirement 2:
Precondition: There is no time shift service under this reference business.
Test method: Call getSchedules().
Conformity result: Return an array of length 0.
| + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|----------------|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 35 | | getPresentSchedules() |Conformity requirement 1:
Precondition: There is a normal time shift service playing under the current reference service.
Test method: Call getPresentSchedules().
Conformity result: An array of TimeShiftEvent objects containing all the time-shift event objects that are currently being played to get the reference event, with the elements in the array sorted by playback start time.
Conformity requirement 2:
Precondition: There is no normal time shift service playing under the current reference service.
Test method: Call getPresentSchedules().
Conformity result: Return an array of length 0.
Conformity requirement 1:
Precondition: Exist time-shifted services to be played under the current reference service.
Test method: Call getFollowingSchedules().
Conformity result: An array of TimeShiftEvent objects containing all the time shift event objects carried by this reference event for the next playback, with the elements in the array sorted by playback start time.
Conformity requirement 2:
Precondition: There is no time-shift service to be played under the current reference service.
Test method: Call getFollowingSchedules().
Conformity result: Return an array of length 0.
Conformity requirement:
Precondition: Successfully create TimeShiftEvent object.
Test method: Read channelObj.
Conformity result: Successfully read, return the corresponding Channel object.
Conformity requirement:
Precondition: Successfully create TimeShiftEvent object.
Test method: Read refChannelObj.
Conformity result: Successfully read and return the corresponding reference service Channel object.
Conformity requirement:
Precondition: Successfully create TimeShiftEvent object.
Test method: Read eventObj.
Conformity result: Read successfully, return the corresponding DvbEvent object.
Precondition: Successfully create TimeShiftEvent object.
Test method: Read refEventObj.
Conformity result: Successfully read and return the corresponding reference service DvbEvent object. | +| 41 | | status | Conformity requirements:
Precondition: Successfully create TimeShiftEvent object.
Test method: Read the status.
Conformity result: Return an integer, read successfully, where -1 means it is been played, 0 means it is being played, and 1 means it has not been played yet. | +| 42 | | orderIndex | Conformity requirements:
Precondition: Successfully create TimeShiftEvent object.
Test method: Read orderIndex.
Conformity result: Return an integer, read successfully, where 1 indicates that it has not been booked, and the remaining positive integers indicate the position in the rebooking list. | +| 43 | | preEvent | Conformity requirement:
Precondition: Successfully create TimeShiftEvent object.
Test method: Read preEvent.
Conformity result: TimeShiftEvent object is of read-only type and represents the previous time shift object for this time shift event | +| 44 | | nextEvent | Conformity requirement:
Precondition: Successfully create TimeShiftEvent object.
Test method: Read nextEvent.
Conformity result: TimeShiftEvent object is of read-only type and represents the next time shift object for this time shift event. | +| 45 | ChannelManager | MSG_CHANNEL_RAM_TO_NVM_SUCCESS | Conformity requirements:
Precondition: Call save() and write successfully.
Test method: Get through the page document.onsystemevent.
Conformity result: The web page receives a message of MSG_CHANNEL_RAM_TO_NVM_SUCCESS. | +| 46 | | MSG_CHANNEL_NVM_TO_RAM_SUCCESS | Conformity requirements:
Precondition: Call restore() and successfully recover.
Test method: Get through the page document.onsystemevent.
Conformity result: The web page receives a | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|----------------|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | ChannelManager | | message of MSG_CHANNEL_NVM_TO_RAM_SUCCESS. | +| 47 | | getChannelByChannelID(channelId) | Conformity requirements:
Precondition: Successfully search for channel.
Test method: Call getChannelByChannelID (channelId).
Conformity result: Return the Channel object with the specified channel number, and return NULL if it does not exist. | +| 48 | | getChannelByServiceID(serviceId) | Conformity requirements:
Precondition: Successfully search for channel.
Test method: Call getChannelByServiceID (serviceId).
Conformity result: Return the Channel object with the specified service number. If the channel cannot be found with the specified serviceid, return NULL. | +| 49 | | getChannelByLogicalID(logicalId) | Conformity requirements:
Precondition: Successfully search for channel.
Test method: Call getChannelByLogicalID (logicalId).
Conformity result: Return the Channel object with the specified logical channel number, or NULL if the channel corresponding to the specified logicalId does not exist. | +| 50 | | getLastChannel() | Conformity requirements:
Precondition: Successfully search for channels that have been played in one way.
Test method: Call getLastChannel().
Conformity result: Return the Channel object, which is the previous channel opened for playback. | +| 51 | | getLastChannel(serviceType) | Conformity requirements:
Precondition: Successfully search for channels that have been played in one way.
Test method: Call getLastChannel(serviceType).
Conformity result: Return the Channel object, which is the previous opened channel of the specified type. If the specified service_type cannot be found, return NULL. | +| 52 | | getShutDownChannel() | Conformity requirements:
Precondition: Successfully search for channels that have been played in one way.
Test method: Call getShutDownChannel().
Conformity result: Return the Channel object, which is a shutdown channel. If there is no shutdown channel, return NULL. | +| 53 | | getShutDownChannel(serviceType) | Conformity requirements:
Precondition: Successfully search for channels that have been played in one way.
Test method: Call getShutDownChannel | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|----------------|-----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | ChannelManager | | (serviceType).
Conformity result: Return the Channel object for the specified type of shutdown channel, or NULL if there is no shutdown channel of the specified type. | +| 54 | | filter(filterTypeArray[], valueArray[]) | Conformity requirement 1:
Precondition: Successfully search for channel.
Test method: Call filter(filterTypeArray[], valueArray[]).
Conformity result: Return an array of Channel objects, which is a filtered list of channels. If there is an exception, return an empty array. | +| 55 | | delChannel(obj) | Conformity requirements:
Precondition: Successfully search for channel.
Test method: Call delChannel(obj).
Conformity result: Return an integer, where 1 indicates successful deletion and 0 indicates failed deletion (Note – This deletion action is specific to RAM operations). | +| 56 | | deleteAll() | Conformity requirements:
Precondition: Successfully search for channel.
Test method: Call deleteAll().
Conformity result: Return an integer, where 1 indicates successful deletion and 0 indicates failed deletion. All channels are deleted (Note – This deletion action is specific to RAM operations). | +| 57 | | deleteAllDelMarked() | Conformity requirements:
Precondition: Successfully search for channel.
Test method: Call deleteAllDelMarked().
Conformity result: Return an integer, where 1 indicates successful deletion and 0 indicates failed deletion. All marked channels are deleted (Note – This deletion action is specific to RAM operations). | +| 58 | | deleteAllFavorites() | Conformity requirements:
Precondition: Successfully search for channel.
Test method: Call deleteAllFavorites().
Conformity result: Return an integer, where 1 indicates successful deletion and 0 indicates failed deletion. All favorite channels are deleted (Note – This deletion action is specific to RAM operations). | +| 59 | | resetProperties() | Conformity requirements:
Precondition: Successfully search for channel.
Test method: Call resetProperties().
Conformity result: Return an integer with 1 indicating success and 0 indicating failure. Reset all channels to non favorite, non locked, and non hidden (Note – This deletion action is specific to RAM operations). | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 60 | | swap(obj1,obj2) | Conformity requirements:
Precondition: Successfully search for channel.
Test method: Call swap(obj1, obj2).
Conformity result: No return value, check the position of swapping two channels in the channel list. | +| 61 | | sort(sortTypeArray[], sortOrderArray[]) | Conformity requirements:
Precondition: Successfully search for channel.
Test method: Call sort(sortTypeArray[], sortOrderArray[]).
Conformity result: No return, sort the channel list according to the specified method. | +| 62 | | save() | Conformity requirements:
Precondition: Successfully search for channel.
Test method: Call save().
Conformity result: No return, save the number of channels of RAM to the NVM, and send the message MSG_CHANNEL_RAM_TO_NVM_SUCCESS if it succeeds; if it fails, send the message MSG_CHANNEL_RAM_TO_NVM_FAILED. | +| 63 | | restore() | Conformity requirements:
Precondition: Successfully search for channel.
Test method: Call restore().
Conformity result: No return, import the number of channels of the NVM into RAM, and send the message MSG_CHANNEL_NVM_TO_RAM_SUCCESS if it succeeds; if it fails, send the message MSG_CHANNEL_NVM_TO_RAM_FAILED. | +| 64 | | MSG_CHANNEL_RAM_TO_NVM_FAILED | Conformity requirements:
Precondition: Call save() and fail to write.
Test method: Get through the page document.onsystemevent.
Conformity result: The web page receives a message of MSG_CHANNEL_RAM_TO_NVM_FAILED. | +| 65 | | MSG_CHANNEL_NVM_TO_RAM_FAILED | Conformity requirements:
Precondition: Call restore() and fail.
Test method: Get through the page document.onsystemevent.
Conformity result: The web page receives a message as MSG_CHANNEL_NVM_TO_RAM_FAILED. | +| 66 | | logicalId | Conformity requirements:
Precondition: Successfully create Channel object.
Test method: Read and write logicalId.
Conformity result: Return integer, read/write | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|---------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Channel | | successfully, indicating logical channel number. | +| 67 | | supportPlayback | Conformity requirements:
Precondition: Successfully create Channel object.
Test method: Read and write supportPlayback.
Conformity result: Return Boolean, read/write successfully, indicating whether retrospective is supported or not. True indicates support, false indicates not support. | +| 68 | | channelId | Conformity requirements:
Precondition: Successfully create Channel object.
Test method: Read and write channelId.
Conformity result: Return integer, read/write successfully, indicating channel number. | +| 69 | | isDeleted | Conformity requirements:
Precondition: Successfully create Channel object.
Test method: Read and write isDelete.
Conformity result: Return integer, read/write successfully, indicating the deletion mark of the channel where 0 indicates no settings, 1 indicates settings. | +| 70 | | isFavorite | Conformity requirements:
Precondition: Successfully create Channel object.
Test method: Read and write isFavorite.
Conformity result: Return an integer, read/write successfully, indicating the channel's favorite flag, where 0 means not set and 1 means set. | +| 71 | | isLocked | Conformity requirements:
Precondition: Successfully create Channel object.
Test method: Read and write isLocked.
Conformity result: Return integer, read/write successfully, indicating the channel's lock flag where 0 indicates no settings, 1 indicates settings. | +| 72 | | isHidden | Conformity requirements:
Precondition: Successfully create Channel object.
Test method: Read and write isHidden.
Conformity result: Return integer, read/write successfully, indicating the hidden marker of the channel where 0 indicates no settings, 1 indicates settings. | +| 73 | | deltVolume | Conformity requirements:
Precondition: Successfully create Channel object.
Test method: Read and write deltVolume.
Conformity result: Return integer, read/write successfully, indicating the volume offset of the channel relative to the global volume. | +| 74 | | getService() | Conformity requirements:
Precondition: Successfully create Channel object.
Test method: Call getService(). | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------------|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Channel | | Conformity result: Return the DvbService object, indicating the DvbService corresponding to the channel. | +| 75 | OrderManager | MSG_REMIND_RAM_TO_NVM_SUCCESS | Conformity requirements:
Precondition: Call save() and succeed.
Test method: Get through document.onsystemevent.
Conformity result: The web page receives a message of MSG_REMIND_RAM_TO_NVM_SUCCESS. | +| 76 | | MSG_REMIND_RAM_TO_NVM_FAILED | Conformity requirements:
Precondition: Call save() and fail.
Test method: Get through document.onsystemevent.
Conformity result: The web page receives a message as MSG_REMIND_RAM_TO_NVM_FAILED. | +| 77 | | MSG_REMIND_NVM_TO_RAM_SUCCESS | Conformity requirements:
Precondition: Call restore() and fail.
Test method: Get through document.onsystemevent.
Conformity result: The web page receives a message of MSG_REMIND_NVM_TO_RAM_SUCCESS. | +| 78 | | MSG_REMIND_NVM_TO_RAM_FAILED | Conformity requirements:
Precondition: Call restore() and fail.
Test method: Get through document.onsystemevent.
Conformity result: The web page receives a message as MSG_REMIND_NVM_TO_RAM_FAILED. | +| 79 | | advanceRemind | Conformity requirements:
Precondition: Successfully create Channel object.
Test method: Read and write advanceRemind.
Conformity result: Integer, read and write successful, indicating the time of the popup reminder for the booking program. | +| 80 | | conflictInterval | Conformity requirements:
Precondition: Successfully create Channel object.
Test method: Read and write conflictInterval.
Conformity result: Return an integer, read/write successfully, indicating the threshold for booking programme conflicts. | +| 81 | | remindType | Conformity requirements:
Precondition: Successfully create Channel object.
Test method: Read and write isLocked.
Conformity result: Return integer, read/write successfully, indicates the conflict mode, where 0 | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | OrderManager | | indicates conflictInterval as the conflict judgment condition; 1 indicates programme playback duration as the conflict judgment condition. | +| 82 | | addEvent(type, eventObj) | Conformity requirements:
Precondition: Successfully create OrderManager object.
Test method: Call addEvent(type, eventObj).
Conformity result: Return an integer where:
1: Indicates successful addition;
0: indicates that the programme has been broadcasted;
-1: Indicates adding conflicts;
-2: Indicates that there is no corresponding business;
-3: Indicates that the reserved space is full. | +| 83 | | getPlayingList() | Conformity requirements:
Precondition: Successfully create OrderManager object.
Test method: Call getPlayingList().
Conformity result: Return an array of Order objects, indicating all currently playing Order objects. | +| 84 | | getRemindList() | Conformity requirements:
Precondition: Successfully create OrderManager object.
Test method: Call getRemindList().
Conformity result: Return an array of Order objects, indicating all Order objects that will be played. | +| 85 | | getOrders(type) | Conformity requirements:
Precondition: Successfully create OrderManager object.
Test method: Call getOrders(type).
Conformity result: Return an array of Order objects, indicating all Order objects of the specified type. | +| 86 | | getOrderByID(orderID) | Conformity requirements:
Precondition: Successfully create OrderManager object.
Test method: Call getOrderByID(orderID).
Conformity result: Return the Order object with the specified identifier. | +| 87 | | getOrderByEvent(type, eventObj) | Conformity requirements:
Precondition: Successfully create OrderManager object.
Test method: Call getOrderByEvent(type, eventObj).
Conformity result: Return the Order object, which | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | OrderManager | | corresponds to the specified event, or returns NULL. | +| 88 | | getConflictOrders() | Conformity requirements:
Precondition: Successfully create OrderManager object.
Test method: Call getConflictOrders().
Conformity result: Return an array of Order objects, which is a list of all orders with conflicts. | +| 89 | | getDelMarkedList() | Conformity requirements:
Precondition: Successfully create OrderManager object.
Test method: Call getDelMarkedList().
Conformity result: Return an array of Order objects, which is a list of all Orders with deletion marks. | +| 90 | | deleteOrder(orderObj) | Conformity requirements:
Precondition: Successfully create OrderManager object.
Test method: Call deleteOrder(orderObj).
Conformity result: Return an integer, indicating to delete the specified Order object, where 1 indicates successful deletion and 0 indicates failed deletion. | +| 91 | | deleteAll() | Conformity requirements:
Precondition: Successfully create OrderManager object.
Test method: Call deleteAll().
Conformity result: Return an integer, indicating to delete all Order objects, where 1 indicates successful deletion and 0 indicates failed deletion. | +| 92 | | deleteAllDelMarked() | Conformity requirements:
Precondition: Successfully create OrderManager object.
Test method: Call deleteAllDelMarked().
Conformity result: Return an integer, indicating to delete all Order objects marked for deletion, where 1 indicates successful deletion and 0 indicates failed deletion. | +| 93 | | delConflictOrders() | Conformity requirements:
Precondition: Successfully create OrderManager object.
Test method: Call delConflictOrders().
Conformity result: Return an integer, indicating to delete all conflicting Order objects, where 1 indicates successful deletion and 0 indicates failed deletion. | +| 94 | | save() | Conformity requirements:
Precondition: Successfully create OrderManager object. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|---------------|-------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | OrderManager | | Test method: Call save().
Conformity result: No return, save RAM data to NVM. | +| 95 | | restore() | Conformity requirements:
Precondition: Successfully create OrderManager object.
Test method: Call restore().
Conformity result: Return an integer indicating that the data in NVM is recovered into RAM, where 1 indicates successful recovery and 0 indicates recovery failure. | +| 96 | Order | orderID | Conformity requirements:
Precondition: Successfully create Order object.
Test method: Read the orderID.
Conformity result: Return integer, read successfully, indicating the identifier of the reserved program. | +| 97 | | channelObj | Conformity requirements:
Precondition: Successfully create Order object.
Test method: Read channelObj.
Conformity result: Channel object, read successfully, indicating the channel corresponding to the current reserved program. | +| 98 | | deleteFlag | Conformity requirements:
Precondition: Successfully create Order object.
Test method: Read and write deleteFlag.
Conformity result: Return an integer, read and write successfully, indicating the the deletion of a marker, where 0 indicates no marker and 1 indicates a marker. | +| 99 | | type | Conformity requirements:
Precondition: Successfully create Order object.
Test method: Read type.
Conformity result: Return an integer, read successfully, indicating the eventObj object type, where 0 indicates ProgramEvent and 1 indicates TimeShiftEvent. | +| 100 | | eventObj | Conformity requirements:
Precondition: Successfully create Order object.
Test method: Read eventObj.
Conformity result: Read successfully, the type is specified by type, indicating the event object corresponding to the reservation. | +| 101 | SearchManager | getAutoCompleteSearchSession(autoCompleteFiter) | Conformity requirements:
Precondition: None.
Test method: Call getAutoCompleteSearchSession(autoCompleteFilter).
Conformity result: Return the | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|---------------------|---------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | GlobalSearchSession | | AutoCompleteSearchSession object, matching the search filter with autoCompleteFilter. | +| 102 | | getGlobalSearchSession(globalFilter,sortCriteria) | Conformity requirements:
Precondition: None.
Test method: Call GetGlobalSearchSession (globalFilter, sortCriteria).
Conformity result: Return the GlobalSearchSession object, indicating the global callback object, with filters and sorting criteria as globalFilter and sortCriteria respectively. | +| 103 | | getSearchHistory() | Conformity requirements:
Precondition: None.
Test method: Call getSearchHistory()
Conformity result: Return an array of SearchHistoryItem objects, indicating the history of search records. | +| 104 | | clearSearchHistory() | Conformity requirements:
Precondition: None.
Test method: Call clearSearchHistory().
Conformity result: No return, clear all history records. | +| 105 | | pageSize | Conformity requirements:
Precondition: Successfully create GlobalSearchSession object.
Test method: Read and write pageSize.
Conformity result: Return integer, read/write successfully, return the number of results contained per page when searching for results. | +| 106 | | onGlobalSearchStart | Conformity requirements:
Precondition: Call startSearch(searchStr) and start the search.
Test method: Read and write onGlobalSearchStart.
Conformity result: Return a function pointer, reads or writes successfully, indicating event handling at the beginning of global search session. | +| 107 | | onGlobalSearchStop | Conformity requirements:
Precondition: Call stopSearch().
Test method: Read and write onGlobalSearchStop.
Conformity result: Return a function pointer, read or write successfully, indicating event handling when global search session stops. | +| 108 | | onGlobalSearchDestroy | Conformity requirements:
Precondition: Call dispose().
Test method: Read and write onGlobalSearchDestroy.
Conformity result: Return a function pointer, read or write successfully, indicating event handling | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|---------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | when global search session is destroyed. | +| 109 | GlobalSearchSession | onGlobalSearchRetrieval | Conformity requirements:
Precondition: Call startSearch(searchStr) and obtain the search results.
Test method: Read and write onGlobalSearchRetrieval.
Conformity result: Return function pointer, read and write successfully, indicating event handling when the global search session obtains the result. | +| 110 | | onGlobalSearchError | Conformity requirements:
Precondition: Call startSearch(searchStr) and search for exceptions.
Test method: Read and write onGlobalSearchError.
Conformity results: Return a function pointer, reads or writes successfully, indicating the event handling in the event of an error in the global search session. | +| 111 | | startSearch(searchStr) | Conformity requirements:
Precondition: None.
Test method: Call startSearch(searchStr).
Conformity result: No return, initiate global session search and trigger onGlobalSearchStart to notify the start. | +| 112 | | stopSearch() | Conformity requirements:
Precondition: Call startSearch(searchStr).
Test method: Call stopSearch().
Conformity result: No return, terminate global session search, and trigger onGlobalSearchStop to notify the termination. | +| 113 | | getSearchResultList() | Conformity requirements:
Precondition: Wait for the event to trigger.
Test method: Call getSearchResultList().
Conformity result: Return an array of GlobalSearchResultItem objects, indicating the global search results, or return a length of 0. | +| 114 | | getResultCount() | Conformity requirements:
Precondition: Wait for the event to trigger.
Test method: Call getResultCount().
Conformity result: Return an integer indicating the length of the search result. | +| 115 | | dispose() | Conformity requirements:
Precondition: Wait for the event to trigger.
Test method: Call dispose().
Conformity result: No return, destroy the global session object, and trigger the event onGlobalSearchDestroy. | +| 116 | | retrievePage(retrieveDirection) | Conformity requirements:
Precondition: None.
Test method: retrievePage(retrieveDirection). | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|---------------------------|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Conformity result: No return, retrieve data from search results and wait for event processing. | +| 117 | | saveRecentSearchQuery() | Conformity requirements:
Precondition: None.
Test method: saveRecentSearchQuery().
Conformity result: No return, save the latest search result to the history record. | +| 118 | | onAutoCompleteSearchStart | Conformity requirements:
Precondition: Call startSearch(searchStr) and start the search.
Test method: Read and write onAutoCompleteSearchStart.
Conformity result: Return function pointer, read/write successfully, matching event handling at the beginning of the search session. | +| 119 | | onAutoCompleteSearchStop | Conformity requirements:
Precondition: Call stopSearch().
Test method: Read and write onAutoCompleteSearchStop.
Conformity result: Return function pointer, read/write successfully, matching event handling when the search session stops. | +| 120 | | onAutoCompleteSearchDestroy | Conformity requirements:
Precondition: Call dispose().
Test method: Read and write onAutoCompleteSearchDestroy.
Conformity result: Return function pointer, read/write successfully, matching event handling when search session is destroyed. | +| 121 | AutoCompleteSearchSession | onAutoCompleteSearchRetrieval | Conformity requirements:
Precondition: Call startSearch(searchStr) and obtain the search results.
Test method: Read and write onAutoCompleteSearchRetrieval.
Conformity result: Return function pointer, read/write successfully, matching event handling when the search session obtains the result. | +| 122 | | onAutoCompleteSearchError | Conformity requirements:
Precondition: Call startSearch(searchStr) and search for exceptions.
Test method: Read and write onAutoCompleteSearchError.
Conformity result: Return a pointer to a function, read or write successfully, and match the event handling in case of an error in the search session. | +| 123 | | startSearch(searchStr) | Conformity requirement:
Precondition: None.
Test method: Call startSearch(searchStr). | + +| Serial No. | Object | Message/Interface/
Attribute | Process description | +|------------|---------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | AutoCompleteSearchSession | | Conformity result: No return, start matching session search, and trigger onAutoCompleteSearchStart to notify the start. | +| 124 | | stopSearch() | Conformity requirements:
Precondition: Call startSearch(searchStr).
Test method: Call stopSearch().
Conformity result: No return, terminate matching session search, and trigger onAutoCompleteSearchStop to notify the termination. | +| 125 | | dispose() | Conformity requirements:
Precondition: Wait for the event to trigger.
Test method: Call dispose().
Conformity result: No return, destroy the matching session object, and triggers onAutoCompleteSearchStop to notify the termination. | +| 126 | | getSearchResultList() | Conformity requirements:
Precondition: Wait for the event to trigger.
Test method: Call getSearchResultList().
Conformity result: Return a string array that indicates the search results that match the user's input string. | +| 127 | GlobalSearchFilter | GlobalSearchFilter() | Conformity requirements:
Precondition: None.
Test method: Call GlobalSearchFilter().
Conformity result: Return the GlobalSearchFilter object as constructor. | +| 128 | | source | Conformity requirements:
Precondition: Call GlobalSearchFilter().
Test method: Read and write source.
Conformity result: Return integer, read/write successfully, indicating search source, which defaults to Source Type ALL. | +| 129 | | contentType | Conformity requirements:
Precondition: Call GlobalSearchFilter().
Test method: Read and write contentType.
Conformity result: Return integer, read/write successfully, indicating content type, which defaults to SearchContentType ALL. | +| 130 | | contentNibble | Conformity requirements:
Precondition: Call GlobalSearchFilter().
Test method: Read and write contentNibble.
Conformity result: Return integer, read/write successfully, indicating the classification of filtered programs. | +| 131 | | searchField | Conformity requirements:
Precondition: Call GlobalSearchFilter(). | + +| Serial No. | Object | Message/Interface/
Attribute | Process description | +|------------|--------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | GlobalSearchFilter | | Test method: Read and write searchField.
Conformity result: Return integer, read/write successfully, indicating search field, which defaults to SearchFields.ALL_STRING_FIELDS. | +| 132 | | searchLanauage | Conformity requirements:
Precondition: Call GlobalSearchFilter().
Test method: Read and write searchLanguage.
Conformity result: Return String type, read and write successfully, indicating the system language, which defaults to "zho". | +| 133 | | criteriaFlags | Conformity requirements:
Precondition: Call GlobalSearchFilter().
Test method: Read and write criteriaFlags.
Conformity result: Return integer, read/write successfully, indicating filtering conditions. | +| 134 | | maxResults | Conformity requirements:
Precondition: Call GlobalSearchFilter().
Test method: Read and write maxResults.
Conformity result: Return integer, read/write successfully, indicating the maximum number of results, which defaults to GlobalSearchFilter.DEFAULT_MAX_GLOBAL_SEARCH_RESULTS. | +| 135 | | threshold | Conformity requirements:
Precondition: Call GlobalSearchFilter().
Test method: Read write threshold.
Conformity result: Return integer, read/write successfully, indicating the threshold for search query results, which defaults to 0. | +| 136 | | timeLimit | Conformity requirements:
Precondition: Call GlobalSearchFilter().
Test method: Read and write timeLimit.
Conformity result: Return integer, read/write successfully, indicating timeout time, which defaults to 0 in seconds. | +| 137 | AutoCompleteSearchFilter | AutoCompleteSearchFilter() | Conformity requirements:
Precondition: None.
Test method: Call AutoCompleteSearchFilter().
Conformity result: Return AutoCompleteSearchFilter object as constructor. | +| 138 | | source | Conformity requirements:
Precondition: Call AutoCompleteSearchFilter().
Test method: Read and write source.
Conformity result: Return integer, read/write successfully, indicating search source, which defaults to Source Type ALL. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 139 | | searchField | Conformity requirements:
Precondition: Call AutoCompleteSearchFilter().
Test method: Read and write searchField.
Conformity result: Return integer, read/write successfully, indicating search field, which defaults to SearchFields.ALL_STRING_FIELDS. | +| 140 | | searchLanauage | Conformity requirements:
Precondition: Call AutoCompleteSearchFilter().
Test method: Read and write searchLanguage.
Conformity result: Return string type, read and write successfully, indicating the system language which defaults to "zho". | +| 141 | | maxResults | Conformity requirements:
Precondition: Call AutoCompleteSearchFilter().
Test method: Read and write maxResults.
Conformity result: Return an integer, read or write successfully, indicating the maximum number of results, which defaults to AutoCompleteSearchFilter.DEFAULT_MAX_AUTO_COMPLETE_SEARCH_RESULTS. | +| 142 | | timeLimit | Conformity requirements:
Precondition: Call AutoCompleteSearchFilter().
Test method: Read and write timeLimit.
Conformity result: Return an integer, read or write successfully, indicating the timeout period, which defaults to 0 and is in seconds. | +| 143 | SortCriteria | SortCriteria() | Conformity requirements:
Precondition: None.
Test method: Call SortCriteria().
Conformity result: Return SortCriteria object as constructor. | +| 144 | | SortCriteria(field, order) | Conformity requirements:
Precondition: None.
Test method: Call SortCriteria(field, order).
Conformity result: Return SortCriteria object as constructor. | +| 145 | | sortOrder | Conformity requirements:
Precondition: Successfully build SortCriteria.
Test method: Read and write sortOrder.
Conformity result: Return integer, read/write successful, indicating sorting method. | +| 146 | | sortType | Conformity requirements:
Precondition: Successfully build SortCriteria.
Test method: Read and write sortType.
Conformity result: Return integer, read/write successful, indicating sorting basis. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------------------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 147 | GlobalSearchResultItem | getContent() | Conformity requirements:
Precondition: Successfully build GlobalSearchResultItem.
Test method: Call getContent().
Conformity result: Return an object with the object type specified by contentType, which can be a DvbEvent object or a PVRevent object. | +| 148 | | contentType | Conformity requirements:
Precondition: Successfully build GlobalSearchResultItem.
Test method: Read contentType.
Conformity result: Return integer, read successfully, and can take the values of CONTENT_DVBEVENT or CONTENT_PVREVENT. | +| 149 | SearchHistoryItem | getContentType() | Conformity requirements:
Precondition: Successfully build SearchHistoryItem.
Test method: Call getContentType().
Conformity result: Return an integer that gets the content type of the history. | +| 150 | | getCriteriaFlags() | Conformity requirements:
Precondition: Successfully build SearchHistoryItem.
Test method: Call getCriteriaFlags().
Conformity result: Return an integer that gets the filter operator for the history record. | +| 151 | | getSearchField() | Conformity requirements:
Precondition: Successfully build SearchHistoryItem.
Test method: Call getSearchField().
Conformity result: Return an integer that gets the search field for the history record. | +| 152 | | getSearchString() | Conformity requirements:
Precondition: Successfully build SearchHistoryItem.
Test method: Call getSearchString().
Conformity result: Return an integer that gets the search keyword string for this history record. | +| 153 | | getSortCriteria() | Conformity requirements:
Precondition: Successfully build SearchHistoryItem.
Test method: Call getSortCriteria().
Conformity result: Return an integer that gets the sorting information of the history record. | +| 154 | | getSource() | Conformity requirements:
Precondition: Successfully build SearchHistoryItem. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------|---------------------------------------------------------------------------------------------------------------------| +| | | | Test method: Call getSource().
Conformity result: Return an integer that gets the search source for the history. | + +### B.11 Conformance test of the broadcast information service management unit interface + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | DthManager | startServer() | Conformity requirements:
Precondition: The test stream contains broadcast information service services, and the system is frequency-locked.
Test method: Call startServer().
Conformity result: The function return value is 0. | +| 2 | | stopServer() | Conformity requirements:
Precondition: The test stream contains a broadcast information service service, the system is frequency locked and startServer() has been called.
Test method: Call stopServer().
Conformity result: The function return value is 0. | +| 3 | | getADFinishStatus() | Conformity requirements:
Precondition: The test stream contains the power-on advertisement service, the system is frequency-locked, and startServer() is called for the first time at power-on.
Test method: Loop call getADFinishStatus().
Conformity result: The return value changes from 0 to 1. | +| 4 | | getAllAds(epgInfoType,serviceid) | Conformity requirement 1:
Precondition: The test stream contains the power-on advertisement service, the system is frequency-locked, calls startServer(), and then calls getADFinishStatus() to wait for its return value to change from 0 to 1.
Test method: Call getAllAds(epgInfoType, serviceid) based on the advertising space and the service ID of the current program.
Conformity result: The return value returns the advertisement information of the current advertisement position in the code stream.
Conformity requirement 2:
Precondition: The test stream does not include power-on advertisements.
Test method: Call getAllAds(epgInfoType, serviceid) based on the advertising space | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DthManager | | and the service ID of the current program.
Conformity result: The return value does not contain advertising information. | +| 5 | | getOsdXmlFile() | Conformity requirement 1:
Precondition: Test stream contains osd text prompt message service, the system is frequency-locked, call startServer().
Test method: Call getOsdXmlFile().
Conformity result: The return value returns the path where the OSD text is stored.
Conformity requirement 2:
Precondition: The test stream does not contain OSD text prompt information.
Test method: Call getOsdXmlFile().
Conformity result: The return value returns that the OSD text storage path is empty. | +| 6 | | getOsdInfo(tag) | Conformity requirement 1:
Precondition: Test the code stream contains OSD text prompt information service, the system is frequency-locked, and call startServer().
Test method: Select different tag values and call getOsdInfo(tag).
Conformity result: The return value returns the OSD text prompt information corresponding to the tag broadcasted in the test stream.
Conformity requirement 2:
Precondition: The test stream does not include OSD text prompt information services.
Test method: Select different tag values and call getOsdInfo(tag).
Conformity result: The return value returns the default OSD text prompt information. | +| 7 | | startAdPCT(transport_stream_id) | Conformity requirements:
Precondition: The test stream contains real-time advertising services and calls startServer().
Test method: Call startAdPCT(transport_stream_id) based on the current programm's tsid.
Conformity result: Return value returns 0. | +| 8 | | stopEMBDAction() | Conformity requirement 1:
Precondition: The test stream contains the emergency broadcast trigger service, call startServer(), at which time the DTH_EVENT_EMBD_TRIG message should be continuously reported.
Test method: Call stopEMBDAction(). | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DthManager | | Conformity result: No more DTH_EVENT_EMBD_TRIG messages are received.
Conformity requirement 2:
Precondition: The test stream contains the emergency broadcast cancel service, call startServer(), at which time the DTH_EVENT_EMBD_CANCEL message should be continuously reported.
Test method: Call stopEMBDAction().
Conformity result: No more DTH_EVENT_EMBD_CANCEL messages are received. | +| 9 | | recordAVBEvent(event_id, event_param) | Conformity requirements:
Precondition: The test stream includes ratings service and call startServer().
Test method: Call recordAVBEvent(event_id, event_param) based on the viewing type.
Conformity result: The function return value is 0. | +| 10 | | dataBDStart(file_path) | Precondition: The test stream includes information service services and call startServer().
Test method: Call dataBDStart(file_path).
Conformity result: The return value is 0, and the download progress (0-100) can be obtained by calling getDATABDFinishPercent(). | +| 11 | | dataBDStop() | Conformity requirements:
Precondition: The test stream includes information service services and call startServer().
Test method: Call dataBDStop().
Conformity result: Return value returns 0. | +| 12 | | getDATABDFinishPercent() | Conformity requirement 1:
Precondition: The test stream includes information service services, call startServer(), and call dataBDStart(file_path).
Test method: Loop call getDATABDFinishPercent().
Conformity result: The return value ranges from 0 to 100.
Conformity requirement 2:
Precondition: The test stream does not include information services.
Test method: Loop call getDATABDFinishPercent().
Conformity result: The return value of the | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|-----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 13 | DthManager | getDataBDXmlFileData(file_name) | function remains constant at 0.
Conformity requirement 1:
Precondition: The test stream includes information service services, call startServer(), and call dataBDStart(file_path).
Test method: Call getDataBDXmlFileData (filename).
Conformity result: Return text information of the information service.
Conformity requirement 2:
Precondition: The test stream does not include information service services.
Test method: Call getDataBDXmlFileData (filename).
Conformity result: The return information service text information is null. | +| 14 | | GPRSTransmit(conn_type, addr, port, data, timeout, retry_count) | Conformity requirement 1:
Precondition: USB is inserted into GPRS module, GPRS module is inserted into SIM card.
Test method: Select the correct IP address and port, call GPRSTransmit(conn_type, addr, port, data, timeout, retry_count) to send test data.
Conformity result: A DTH_EVENT_GPRS_SEND_STATUS message is received with a carry parameter of 1 to indicate successful transmission.
Conformity requirement 2:
Precondition: USB is inserted into GPRS module, GPRS module not be inserted into SIM card.
Test method: Select the wrong IP address and port, call GPRSTransmit(conn_type, addr, port, data, timeout, retry_count) to send test data.
Conformity result: A DTH_EVENT_GPRS_SEND_STATUS message is received with a carry parameter of 0 to indicate a transmission failure. | +| 15 | | getGPRSStatus() | Conformity requirement 1:
Precondition: USB is inserted into GPRS module, GPRS module is inserted into SIM card.
Test method: Call getGPRSStatus().
Conformity result: Receive DTH_EVENT_GPRS STATUS message with parameter 0 to indicate that GPRS is working properly. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DthManager | | Conformity requirement 2:
Precondition: USB is inserted into GPRS module, GPRS module not be inserted into SIM card.
Test method: Call getGPRSStatus().
Conformity result: Receive DTH_EVENT_GPRS STATUS message with parameter non-zero to indicate abnormal GPRS operation. | +| 16 | | getGprsBaseStationInfo() | Conformity requirement 1:
Precondition: USB is inserted into GPRS module
Test method: Call getGprsBaseStationInfo().
Conformity result: A DTH_EVENT_GPRS_BASE_STATION message is received with a parameter carrying base station information whose value is not null.
Conformity requirement 2:
Precondition: USB is not inserted into GPRS module.
Test method: Call getGprsBaseStationInfo().
Conformity result: Receive DTH_EVENT_GPRS BASE_STATION message with parameter carrying base station information whose value is not null. | +| 17 | | SaveNITServiceUpdateVersion() | Conformity requirements:
Precondition: The test stream contains programme update descriptors and call startServer().
Test method: Call SaveNITServiceUpdateVersion ().
Conformity result: The return value is 0. | +| 18 | | GetBouquetId() | Conformity requirements:
Precondition: The test stream broadcast packet contains the code stream for the bouquet id service.
Test method: Call GetBouquetId().
Conformity result: Return the value of the bouquet id currently being broadcast by the system. | +| 19 | | SaveNITServiceUpdateVersion() | Conformity requirements:
Precondition: The test stream contains programme update descriptors and calls startServer().
Test method: Call SaveNITServiceUpdateVersion ().
Conformity result: The return value is 0. | +| 20 | | dataBDdeleteFiles() | Conformity requirements: | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
Precondition: The test stream includes information services and can be downloaded normally.
Test method: Call dataBDdeleteFiles().
Conformity result: Delete the downloaded information service file.
| +| 21 | Ad | adPath |Conformity requirements:
Precondition: The test stream contains a power-on advertisement and can be downloaded normally. Call the getAllAds(epgInfoType, serviceid) function based on the advertising location to obtain the advertising object.
Test method: Get the adPath property.
Conformity result: Get the path where the advertisement is located.
| +| 22 | | startDate |Conformity requirements:
Precondition: The test stream contains a power-on advertisement and can be downloaded normally. Call the getAllAds(epgInfoType, serviceid) function based on the advertising location to obtain the advertising object.
Test method: Get the startDate property.
Conformity result: Get the start date required by the advertisement.
| +| 23 | | startTime |Conformity requirements:
Precondition: The test stream contains a power-on advertisement and can be downloaded normally. Call the getAllAds(epgInfoType, serviceid) function based on the advertising location to obtain the advertising object.
Test method: Get the startTime property.
Conformity result: Get the start time required by the advertisement.
| +| 24 | | endDate |Conformity requirements:
Precondition: The test stream contains a power-on advertisement and can be downloaded normally. Call the getAllAds(epgInfoType, serviceid) function based on the advertising location to obtain the advertising object.
Test method: Get the endDate property.
Conformity result: Get the end date required by the advertisement.
| +| 25 | | endTime |Conformity requirements:
Precondition: The test stream contains a power-on advertisement and can be downloaded normally. Call the
| + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|-----------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Ad | | getAllAds(epgInfoType, serviceid) function based on the advertising location to obtain the advertising object.Test method: Get the endTime property.
Conformity result: Get the end date required by the advertisement. | +| 26 | | duration | Conformity requirements:
Precondition: The test stream contains a power-on advertisement and can be downloaded normally. Call the getAllAds(epgInfoType, serviceid) function based on the advertising location to obtain the advertising object.
Test method: Get the duration attribute.
Conformity result: Get the duration of display required by the advertisement (in seconds). | +| 27 | | tableExtId | Conformity requirements:
Precondition: The test stream contains a power-on advertisement and can be downloaded normally. Call the getAllAds(epgInfoType, serviceid) function based on the advertising location to obtain the advertising object.
Test method: Get the tableExtId attribute.
Conformity result: Get the extension ID required by the advertisement (when multiple advertisements are received, display the advertisement images in order of size based on this ID). | +| 28 | | getAllAdServices() | Conformity requirements:
Precondition: The test stream contains a power-on advertisement and can be downloaded normally. Call the getAllAds(epgInfoType, serviceid) function based on the advertising location to obtain the advertising object.
Test method: Call getAllAdServices().
Conformity result: Get the AdService array that currently contains the advertisement. | +| 29 | AdService | onId | Conformity requirements:
Precondition: The test stream contains a power-on advertisement and can be downloaded normally. Call the getAllAds(epgInfoType, serviceid) function based on the advertising location to obtain the advertising object, and call getAllAdServices() to obtain the AdService object.
Test method: Get the onId attribute. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|-----------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 30 | AdService | tdId | Conformity result: Get the current tdId.
Conformity requirements:
Precondition: The test stream contains a power-on advertisement and can be downloaded normally. Call the getAllAds(epgInfoType, serviceId) function based on the advertising location to obtain the advertising object, and call getAllAdServices() to obtain the AdService object.
Test method: Get the tdId attribute.
Conformity result: Get the current tdId. | +| 31 | | serviceId | Conformity requirements:
Precondition: The test stream contains a power-on advertisement and can be downloaded normally. Call the getAllAds(epgInfoType, serviceId) function based on the advertising location to obtain the advertising object, and call getAllAdServices() to obtain the AdService object.
Test method: Get the serviceId attribute.
Conformity result: Get the current serviceId. | +| 32 | | associateType | Conformity requirements:
Precondition: The test stream contains a power-on advertisement and can be downloaded normally. Call the getAllAds(epgInfoType, serviceId) function based on the advertising location to obtain the advertising object, and call getAllAdServices() to obtain the AdService object.
Test method: Get the associateType attribute.
Conformity result: Get the current associated type. | + +### B.12 Conformance test of multi-screen interactive unit interface + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | | startMultiScreenServer(String spName, String spDeviceType, String spServiceInfo, String spVersion, String ipAddress, int port, String hostname) | Conformity requirement 1:
Precondition: The device and server are connected to the same local area network.
Test method: Call the startMultiScreenServer() method and input valid parameters to start the multi screen interactive component server.
The validity of the parameters is as follows:
a) SpName represents the server name, with sizes ranging from 1 to 20000 characters in | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | MultiScreen | startMultiScreenServer(String spName, String spDeviceType, String spServiceInfo, String spVersion, String ipAddress, int port, String hostname) | length
b) SpVersion represents the server_side version, with sizes ranging from 1 to 20000 characters in length
c) SpDeviceType represents the type of server_side device, with sizes ranging from 1 to 20000 characters in length
d) Port represents the device port number, ranging from 0 to 65535
e) SpServiceInfo represents server_side service information, with a size ranging from 1 to 20000 characters in length
f) IpAddress represents the device's IP address, with a size of 32-bit IPv4 address
g) Hostname represents the device host name, with a size ranging from 1 to 20000 characters in length
Conformity result: The method returns OK.
Conformity requirement 2:
Precondition: The device and server are connected to the same local area network.
Test method: Call the startMultiScreenServer() method and input invalid parameters.
Conformity result: The method returns a non OK error code. | +| 2 | | stopMultiScreenServer() | Conformity requirement 1:
Precondition: Call the startMultiScreenServer() method to successfully start the multi screen interactive component server.
Test method: Call the stopMultiScreenServer() method.
Conformity result: The method returns OK.
Conformity requirement 2:
Precondition: The multi screen interactive component server has not been started.
Test method: Call the stopMultiScreenServer() method.
Conformity result: The method returns a non OK error code. | +| 3 | | startMultiScreenClient(String clientName) | Conformity requirement 1:
Precondition: The device and client are already connected to the same local area network.
Test method: Call the startMultiScreenClient() method and input valid parameters to start the multi screen interactive component client.
The validity of the parameters is as follows:
1) ClientName: indicates the client name, with a size ranging from 1 to 20000 characters in length.
Conformity result: The method returns OK. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|-------------|----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | MultiScreen | | Conformity requirement 2:
Precondition: The device and client are already connected to the same local area network.
Test method: Call the startMultiScreenClient() method and input invalid parameters.
Conformity result: The method returns a non OK error code. | +| 4 | | stopMultiScreenClient() | Conformity requirement 1:
Precondition: Call the startMultiScreenClient() method to successfully start the multi screen interactive component client.
Test method: Call the stopMultiScreenClient() method.
Conformity result: The method returns OK.
Conformity requirement 2:
Precondition: The multi screen interactive component client is not ,successfully start.
Test method: Call the stopMultiScreenClient() method.
Conformity result: The method returns a non OK error code. | +| 5 | | findSPs() | Conformity requirement:
Precondition: The service component device is connected to the same local area network as the server and client, and the service component device can be discovered.
Test method: Call the findSPs() method.
Conformity result: The method returns OK. | +| 6 | | connect(String spName, String spDeviceType, String spServiceInfo, String spVersion, String ipAddress, int port, String hostname) | Conformity requirement 1:
Precondition: LAN server devices can be discovered.
Test method: Call the connect() method and input valid parameters.
The validity of the parameters is as follows:
a) SpName represents the server name, with sizes ranging from 1 to 20000 characters in length
b) SpVersion represents the server-side version, with sizes ranging from 1 to 20000 characters in length
c) SpServiceInfo represents server-side service information, with a size ranging from 1 to 20000 characters in length
d) SpDeviceType represents the type of server-side device, with sizes ranging from 1 to 20000 characters in length
e) IpAddress represents the device's IP address, with a size of 32-bit IPv4 address
f) Port represents the device port number, ranging from 0 to 65535 | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|-------------|--------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | MultiScreen | |
g) Hostname represents the device host name, with a size ranging from 1 to 20000 characters in length
Conformity result: The method returns OK.
Conformity requirement 2:
Precondition: LAN server devices cannot be discovered.
Test method: Call the connect() method and input valid parameters.
Conformity result: The method returns a non OK error code.
Conformity requirement 3:
Precondition: LAN server devices can be discovered.
Test method: Call the connect() method and input invalid parameters.
Conformity result: The method returns a non OK error code.
queryInfo(String ipAddress, int port, String hostname, String cmdid, String attribute, String params)
|Conformity requirement 1:
Precondition: The LAN multi screen interactive client and server have established a connection through connect().
Test method: The client calls the queryInfo() method and inputs valid parameters.
The validity of the parameters is as follows:
- a) CMDID represents the instruction ID for requesting information, with sizes ranging from 1 to 20000 characters in length
- b) Attribute represents the instruction name for requesting information, with a size of 1-20000 characters in length
- c) Params represents the instruction parameters for requesting information, with sizes ranging from 1 to 20000 characters in length
- d) IpAddress represents the device's IP address, with a size of 32-bit IPv4 address
- e) Port represents the device port number, ranging from 0 to 65535
- f) Hostname: The device host name, with a size of 1-20000 characters in length
Conformity result: The method returns OK.
Conformity requirement 2:
Precondition: The LAN multi screen interactive client and server have not established a connection.
Test method: The client calls the queryInfo() method and inputs valid parameters.
Conformity result: The method returns a non OK error code.
Conformity requirement 3:
Precondition: The LAN multi screen interactive client and server have established a connection through connect().
Test method: The client calls the queryInfo() method and inputs invalid parameters.
Conformity result: The method returns a non OK error code.
Conformity requirement 1:
Precondition: The LAN multi screen interactive client and server have established a connection through connect().
Test method: The client calls the execCmd() method and inputs valid parameters.
The validity of the parameters is as follows:
a) Cmd represents key commands, with a size of 1-20000 characters in length
b) Param represents the parameter attached to the key command, with a size of 1-20000 characters in length
c) IpAddress represents the device's IP address, with a size of 32-bit IPv4 address
d) Port represents the device port number, ranging from 0 to 65535
e) Hostname represents the device host name, with a size ranging from 1 to 20000 characters in length
Conformity result: The method returns OK.
Conformity requirement 2:
Precondition: The LAN multi screen interactive client and server have not established a connection.
Test method: The client calls the execCmd() method and inputs valid parameters.
Conformity result: The method returns a non OK error code.
Conformity requirement 3:
Precondition: The LAN multi screen interactive client and server have established a connection through connect().
Test method: The client calls the execCmd() method and inputs invalid parameters.
Conformity result: The method returns a non OK error code.
Conformity requirement 1:
Precondition: The multi screen interactive client successfully calls the execCmd() method, and the server successfully inputs the instruction receiving state.
Test method: The client calls the
inputKeyCode() method and inputs valid parameters.
The validity of the parameters is as follows:
a) Action represents a key command, with a size ranging from 1 to 20000 characters in length.
b) Param represents the parameter attached to the key command, with a size of 1-20000 characters in length.
c) IpAddress represents the device's IP address, with a size of 32-bit IPv4 address.
d) Port represents the device port number, ranging from 0 to 65535.
e) Hostname represents the device host name, with a size ranging from 1 to 20000 characters in length.
Conformity result: The method returns OK.
Conformity requirement 2:
Precondition: The server fails to successfully enter the instruction receiving state.
Test method: The client calls the inputKeyCode() method and inputs valid parameters.
Conformity result: The method returns a non OK error code.
Conformity requirement 3:
Precondition: The multi screen interactive client successfully calls the execCmd() method, and the server successfully inputs the instruction receiving state.
Test method: The client calls the inputKeyCode() method and inputs invalid parameters.
Conformity result: The method returns a non OK error code.
Conformity requirement 1:
Precondition: The client and server of the local area network have successfully connected.
Test method: The multi screen interactive component server calls the boardCastAllDevice() method and inputs valid parameters. The validity of the parameters is as follows:
a) Cmd represents a broadcast instruction, with a size of 1-20000 characters in length
b) Param represents the parameter attached to the broadcast command, with a size of 1-20000 characters in length
Conformity result: The method returns OK.
Conformity requirement 2:
Precondition: The client and server of the local area network are not connected.
Test method: The multi screen interactive component server calls the boardCastAllDevice() method and inputs valid parameters.
Conformity result: The method returns a non OK error code.
Conformity requirement 3:
Precondition: The client and server of the local area network have successfully connected.
Test method: The multi screen interactive component server calls the boardCastAllDevice() method and inputs invalid parameters.
Conformity result: The method returns a non OK error code.
| +| 11 | EventHandler | onSpFounded() |Conformity requirement 1:
Precondition: The LAN multi screen interactive component service can be discovered through the findSPs() method, the service starts and creates an EventHandler object instance, and registers the callback instance through Event.
Test method: Call the findSp() method.
Conformity result: onSpFounded() is called in the instance.
Conformity requirement 2:
Precondition: If the local area network is unable to discover the multi screen interactive component service, the service will start and create an EventHandler object instance. Register the callback instance through Event.
Test method: Call the findSp() method.
Conformity result: The onSpFounded() method in the instance is not called.
| +| 12 | | onConnected() |Conformity requirement 1:
Precondition: The LAN multi screen interactive component service can be connected through the connect() method, and currently is in an unconnected state. The service starts and creates an EventHandler object instance, which is registered through the Event callback instance.
Test method: Call the connect() method.
Conformity result: onConnected() is called in the instance.
Conformity requirement 2:
Precondition: The LAN multi screen interactive component service cannot be connected, the service starts and creates an
| + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | EventHandler | | EventHandler object instance, and registers the callback instance through Event.Test method: Call the connect() method.
Conformity result: onConnected() in the instance is not called. | +| 13 | | onConnectRefused() | Conformity requirement 1:
Precondition: The local area network multi screen interactive service component is currently in a rejected connection state. The service starts and creates an EventHandler object instance, which is registered through the Event callback instance.
Test method: Call the connect() method.
Conformity result: onConnectRefused() is called in the instance.
Conformity requirement 2:
Precondition: The LAN multi screen interactive service component can connect and is currently in an unconnected state. The service starts and creates an EventHandler object instance, and registers the callback instance through Event.
Test method: Call the connect() method.
Conformity result: onConnectRefused() is not called in the instance. | +| 14 | | onDisconnected() | Conformity requirement 1:
Precondition: The LAN multi screen interactive service component can be disconnected, and currently is in a connected state, the service starts and creates an EventHandler object instance, and registers the callback instance through Event.
Test method: Call the connect() method.
Conformity result: onDisconnected() is called in the instance.
Conformity requirement 2:
Precondition: The local area network multi screen interactive service component is currently in an unconnected state, the service starts and creates an EventHandler object instance, and registers the callback instance through Event.
Test method: Call the connect() method.
Conformity result: onDisconnected() is not called in the instance. | +| 15 | | onServiceActivated() | Conformity requirement 1:
Precondition: The LAN multi screen interactive component service can be connected through the connect() method, and currently is in an unconnected state. The | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | EventHandler | |
service starts and creates an EventHandler object instance, which is registered through the Event callback instance.
Test method: Call the connect() method.
Conformity result: onServiceActivated() is called in the instance.
Conformity requirement 2:
Precondition: The LAN multi screen interactive component service cannot be connected, the service starts and creates an EventHandler object instance, and registers the callback instance through Event.
Test method: Call the connect() method.
Conformity result: onServiceActivated() is not called in the instance.
| +| 16 | | onServiceDeactivated() |Conformity requirement 1:
Precondition: The multi screen interactive service on the local area network can be turned off and is currently in a startup state; Create an EventHandler object instance and register the callback instance through Event.
Test method: Call the stopMultiScreenServer() method.
Conformity result: onServiceDeactivated() is called in the instance.
Conformity requirement 2:
Precondition: The LAN multi screen interactive service is currently in an inactive state; Create an EventHandler object instance and register the callback instance through Event.
Test method: Call the stopMultiScreenServer() method.
Conformity result: onServiceDeactivated() is not called in the instance.
| +| 17 | | onQueryInfo() |Conformity requirement 1:
Precondition: The LAN multi screen interactive component service is connected to the client, the service starts and creates an EventHandler object instance, and registers the callback instance through Event.
Test method: Call the queryInfo() method.
Conformity result: onQueryInfo() is called in the instance.
Conformity requirement 2:
Precondition: If the LAN multi screen interactive component service is not connected to the client, the service will start and create an EventHandler object instance. Register the callback instance through Event.
| + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|-------------------|------------------|------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 18 | EventHandler | | Test method: Call the queryInfo() method.
Conformity result: onQueryInfo() is not called in the instance. | +| | | onQueryResponse() | Conformity requirement 1:
Precondition: The LAN multi screen interactive server can respond to client data requests, start the service, create an EventHandler object instance, and register the callback instance through Event.
Test method: Call the queryResult() method.
Conformity result: onQueryResponse() is called in the instance.
Conformity requirement 2:
Precondition: The LAN multi screen interactive server cannot respond to client data requests. The service starts and creates an EventHandler object instance, and registers the callback instance through Event.
Test method: Call the queryResult() method.
Conformity result: onQueryResponse() is not called in the instance. | +| 19 | | onExecute() | Conformity requirement 1:
Precondition: The LAN multi screen interactive client can send instructions to the server to execute requests, and is currently in a connected state, the service starts and creates an EventHandler object instance, and registers the callback instance through Event.
Test method: Call the execCmd() method.
Conformity result: onExecute() is called in the instance.
Conformity requirement 2:
Precondition: The LAN multi screen interactive client is not connected to the server, and the server cannot receive command execution requests. The service starts and creates an EventHandler object instance, and registers the callback instance through Event.
Test method: Call the execCmd() method.
Conformity result: onExecute() is not called in the instance. | +| 20 | | onInputKeyCode() | Conformity requirement 1:
Precondition: The LAN multi screen interactive client can send button injection execution requests to the server, start the service and create an EventHandler object instance, and register the callback instance through Event.
Test method: Call the inputkeyCode() method.
Conformity result: onInputKeyCode() is called | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | in the instance.
Conformity requirement 2:
Precondition: The LAN multi screen interactive client is not connected to the server, and the server cannot receive button injection execution requests. The service starts and creates an EventHandler object instance, which is registered through Event.
Test method: Call the inputkeyCode() method.
Conformity result: onInputKeyCode() is not called in the instance. | +| 21 | | onNotify() | Conformity requirement 1:
Precondition: The LAN multi screen interactive client can receive broadcast notifications sent by the server, start and create an EventHandler object instance, and register the callback instance through Event.
Test method: Call the boardCastAllDevice() method.
Conformity result: onNotify() is called in the instance.
Conformity requirement 2:
Precondition: The LAN multi screen interactive server is not connected to the client, and the client cannot receive broadcasts. The service starts and creates an EventHandler object instance, and registers the callback instance through Event.
Test method: Call the boardCastAllDevice() method.
Conformity result: onNotify() is not called in the instance. | + +### B.13 Conformance test of DRM management unit interface + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------------|----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ChinaDrm Manager | ChinaDrm_RegisterApp (DrmSystemID, TAUUID register_commandId, register_pridata, enflag, licensereq_commandId, decrypt_commandId) | Conformity requirement 1:
Precondition: The DRM component is working properly.
Test method: Call the ChinaDrm_RegisterApp() method and input valid parameters.
Conformity result: The method call is successful and returns 0.
Conformity requirement 2:
Precondition: The DRM component is working properly.
Test method: Call the ChinaDrm_RegisterApp() method and input | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------------|------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | ChinaDrm Manager | | invalid parameters.
Conformity result: Method returns non_0. | +| 2 | | ChinaDrm_UnRegisterApp() | Conformity requirement 1:
Precondition: Successfully call the ChinaDrm_RegisterApp() method and register the DRM APP.
Test method: Call the ChinaDrm_UnRegisterApp() method.
Conformity result: The method call is successful and returns 0.
Conformity requirement 2:
Precondition: ChinaDrm_RegisterApp() method is not called successfully, DRM APP is not registered successfully.
Test method: Call the ChinaDrm_UnRegisterApp() method.
Conformity result: Method returns non-zero. | +| 3 | | ChinaDrm_SendCommandToTA (commandId, sendData) | Conformity requirement 1:
Precondition: Successfully call the ChinaDrm_RegisterApp() method and register the DRM APP.
Test method: Call the ChinaDrm_SendCommandToTA() method and input valid parameters.
Conformity result: The method call succeeds, returning the TEE processing result in JSON format, describing the processing success.
Conformity requirement 2:
Precondition: Successfully call the ChinaDrm_RegisterApp() method and register the DRM APP.
Test method: Call the ChinaDrm_SendCommandToTA() method and input invalid parameters.
Conformity result: Return the TEE processing result in JSON format, describing the call failure. | +| 4 | | ChinaDrm_SendMessageToPlayer(type,message) | Conformity requirement 1:
Precondition: Successfully call the ChinaDrm_RegisterApp() method and register the DRM APP.
Test method: Call the ChinaDrm_SendMessageToPlayer() method and input valid parameters.
Conformity result: The method call is successful and returns 0.
Conformity requirement 2:
Precondition: Successfully call the ChinaDrm_RegisterApp() method and register the DRM APP. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Test method: Call the ChinaDrm_SendMessageToPlayer() method and input invalid parameters.
Conformity result: Method call fails with a non zero return. | + +### B.14 Conformance test of DCAS management unit interface + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|----------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | EPG_DCAS | getActivationStatus() | Conformity requirement 1:
Precondition: The terminal has been activated.
Test method: Call getActivationStatus().
Conformity result: Return 0.
Conformity requirement 2:
Precondition: The terminal is not activated.
Test method: Call getActivationStatus().
Conformity result: Return non zero. | +| 2 | | getBeidouInfo() | Conformity requirements:
Precondition: The terminal has been activated.
Test method: Call getBeidouInfo().
Conformity result: Return Beidou information. | +| 3 | | getCASVersion() | Conformity requirements:
Precondition: CA is present.
Test method: Call getCASVersion().
Conformity result: Return the CAS version.
Conformity requirement 2:
Precondition: No CA.
Test method: Call getCASVersion().
Conformity result: Return null. | +| 4 | | getCASVendorId() | Conformity requirement 1:
Precondition: CA is present.
Test method: Call getCASVendorId().
Conformity result: Return the CAS vendor ID.
Conformity requirement 2:
Precondition: No CA.
Test method: Call getCASVendorId().
Conformity result: Return 0. | +| 5 | | getChipID() | Conformity requirement 1:
Precondition: Chipid is present in the chip.
Test method: Call getChipID().
Conformity result: Return CHIPID.
Conformity requirement 2:
Precondition: No chip present in the chip.
Test method: Call getChipID().
Conformity result: Return null. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------------------------|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 6 | EPG_DCAS | getHSMID() | Conformity requirement 1:
Precondition: HSM is present.
Test method: Call getHSMID().
Conformity result: Return HSMID.
Conformity requirement 2:
Precondition: No HSM.
Test method: Call getHSMID().
Conformity result: Return null. | +| 7 | | getValidPosition() | Conformity requirement 1:
Precondition: Activation.
Test method: Call getValidPosition().
Conformity result: Return a valid location.
Conformity requirement 2:
Precondition: Not activated.
Test method: Call getValidPosition().
Conformity result: Return null. | +| 8 | | getPersonalBits() | Conformity requirement 1:
Precondition: The terminal has PersonalBits.
Test method: Call getPersonalBits().
Conformity result: Return PersonalBits.
Conformity requirement 2:
Precondition: The terminal has no PersonalBits.
Test method: Call getPersonalBits().
Conformity result: Return 0. | +| 9 | | getZipCode() | Conformity requirement 1:
Precondition: The terminal has set ZipCode.
Test method: Call getZipCode().
Conformity result: Return zipcode.
Conformity requirement 2:
Precondition: The terminal has not set ZipCode.
Test method: Call getZipCode().
Conformity result: Return null. | +| 10 | JSDCAS.C
ASDescriptor | getCasId() | Conformity requirements:
Precondition: Successfully call CASSession.GetCasDescriptor.
Test method: Call getCasId().
Conformity result: Return CASID. | +| 11 | | getPid() | Conformity requirements:
Precondition: Successfully call CASSession.GetCasDescriptor.
Test method: Call getPid().
Conformity result: Return PID. | +| 12 | | getPrivateData() | Conformity requirements:
Precondition: Successfully call | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------------------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | CASSession.GetCasDescriptor.
Test method: Call getPrivateData().
Conformity result: Return CA private data. | +| 13 | JSDCAS.C
ASEcmEvent | getEcmData() | Conformity requirement 1:
Precondition: The platform calls onEcmEvent, and DCAS obtains the ECM event object.
Test method: DCAS calls getEcmData().
Conformity result: Return ECM data.
Conformity requirement 2:
Precondition: The platform calls onEcmEvent and passes a null ECM event object.
Test method: DCAS calls getEcmData().
Conformity result: Return NULL. | +| 14 | | getError() | Conformity requirements:
Precondition: The platform calls onEcmEvent, and DCAS obtains a null ECM event object.
Test method: DCAS calls getError().
Conformity result: Return the error value of the filter. | +| 15 | | getTableId() | Conformity requirements:
Precondition: The platform calls onEcmEvent, and DCAS obtains the ECM event object.
Test method: DCAS calls getTableId().
Conformity result: Return tableID. | +| 16 | | isTimeout() | Conformity requirement 1:
Precondition: DCAS calls enableDescramblingRequests with a set timeout duration, DCAS calls onEcmEvent, but no ECM data is obtained during the timeout.
Test method: DCAS calls isTimeout().
Conformity result: Return true.
Conformity requirement 2:
Preconditions: DCAS calls enableDescramblingRequests with a set timeout, DCAS calls onEcmEvent, and other errors do not receive ECM data.
Test method: DCAS calls isTimeout().
Conformity result: Return false. | +| 17 | JSDCAS.C
ASEmmEvent | getEmmData() | Conformity requirement 1:
Precondition: The platform calls onInBandEmmEvent, and DCAS obtains the EMM event object.
Test method: DCAS calls getEmmData().
Conformity result: Return EMM data.
Conformity requirement 2:
Precondition: The platform calls onInBandEmmEvent and passes a null EMM | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------------------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | event object.
Test method: DCAS calls getEmmData().
Conformity result: Return NULL. | +| 18 | | getError() | Conformity requirements:
Precondition: The platform calls onInBandEmmEvent, and DCAS obtains a null EMM event object.
Test method: DCAS calls getError().
Conformity result: Return the error value of the filter. | +| 19 | JSDCAS.C
ASEmmEvent | getTableId() | Conformity requirements:
Precondition: The platform calls onInBandEmmEvent, and DCAS obtains the EMM event object.
Test method: DCAS calls getTableId().
Conformity result: Return tableID. | +| 20 | | isCatUpdateNotification() | Conformity requirement 1:
Precondition: The platform calls onInBandEmmEvent, DCAS obtains a null EMM event object, and CAT updates result in null.
Test method: DCAS calls isCatUpdateNotification().
Conformity result: Return true.
Conformity requirement 2:
Precondition: The platform calls onInBandEmmEvent, DCAS obtains a null EMM event object, which is caused by an internal error.
Test method: DCAS calls isCatUpdateNotification().
Conformity result: Return false. | +| 21 | JSDCAS.C
ASFilter | getBitmapMask() | Conformity requirement 1:
Precondition: DCAS calls startCasPacketLoading, and the platform obtains the CASFilter object.
Test method: Platform calls getBitmapMask().
Conformity result: Return the filter mask.
Conformity requirement 2:
Precondition: The platform calls startInbandLoading to obtain the CASFilter object.
Test method: Platform calls getBitmapMask().
Conformity result: Return the filter mask. | +| 22 | | getBitmapValue() | Conformity requirement 1:
Precondition: The platform calls startCasPacketLoading to obtain the CASFilter object.
Test method: The platform calls | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|----------------------|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | JSDCAS.C
ASFilter | | getBitmapValue().
Conformity result: Return the bitmap value.
Conformity requirement 2:
Precondition: The platform calls startInbandLoading to obtain the CASFilter object.
Test method: The platform calls getBitmapValue().
Conformity result: Return the bitmap value. | +| 23 | | getOffset() | Conformity requirement 1:
Precondition: The platform calls startCasPacketLoading to obtain the CASFilter object.
Test method: Platform calls getOffset().
Conformity result: Return offset.
Conformity requirement 2:
Precondition: The platform calls startInbandLoading to obtain the CASFilter object.
Test method: Platform calls getOffset().
Conformity result: Return offset. | +| 24 | JSDCAS.C
ASM | getCASModuleManager() | Conformity requirements:
Precondition: None.
Test method: Call getCASModuleManager().
Conformity result: Return the CASModuleManager object. | +| 25 | | getTeeController() | Conformity requirements:
Precondition: None.
Test method: Call getTeeController().
Conformity result: Return the TeeController object. | +| 26 | JSDCAS.C
ASModule | getCasId() | Conformity requirements:
Precondition: Successfully register RegisterCASModule(), the platform obtains CASModule.
Test method: Call getCasId().
Conformity result: Return CASID. | +| 27 | | onCasPacketEvent(casPacketEvent) | Conformity requirements:
Precondition: DCAS successfully calls startCasPacketLoading(), and the platform receives the CAS packet.
Test method: Call onCasPacketEvent().
Conformity result: The platform provides the data to DCAS. | +| 28 | | onEcmEvent(casSession,ecmEvent) | Conformity requirements:
Precondition: DCAS successfully calls startEcmLoading, and the platform receives a new ECM package. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|---------------------------|------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 29 | JSDCAS.C ASModule | | Test method: Call onEcmEvent().
Conformity result: The platform provides ECM related information to DCAS. | +| | | onInbandEmmEvent(casSessionForEMM,emmEvent) | Conformity requirements:
Precondition: DCAS successfully calls startInbandEmmLoading, and the platform receives a new EMM package.
Test method: Platform calls onInbandEmmEvent().
Conformity result: The platform provides EMM related information to DCAS. | +| | | onStartDescrambling(casSession, firstEcmEvent) | Conformity requirements:
Precondition: After Successfully call enableDescramblingRequests(), the platform receives the ECM package.
Test method: Call onStartDescrambling().
Conformity result: The platform sends the received ECM to DCAS. | +| | | onStopDescrambling(casSession) | Conformity requirements:
Precondition: Successfully call onStartDescrambling().
Test method: Call onStopDescrambling().
Conformity result: The platform notifies DCAS to stop descrambling. | +| 32 | JSDCAS.C ASModule Manager | disableDescramblingRequests(casModule) | Conformity requirement 1:
Precondition: Successfully call enableDescramblingRequests.
Test method: Call disableDescramblingRequests() and input valid parameters.
Conformity result: Registration is successful, return ACTION_OK.
Conformity requirement 2:
Precondition: Successfully call enableDescramblingRequests.
Test method: Call disableDescramblingRequests() and input invalid parameters.
Conformity result: Return ACTION_ERROR_INVALID_PARAMETERS.
Conformity requirement 3:
Precondition: Successfully call enableDescramblingRequests, underlying driver error.
Test method: Call disableDescramblingRequests() and input valid parameters.
Conformity result: Return | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------------------------|-----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | ACTION_ERROR_DRIVER. | +| 33 | JSDCAS.CASModule Manager | enableDescramblingRequests(casModule,firstEcmTimeout,autoLoadFirstEcm,isFastMode,ecmTableIds) |
Conformity requirement 1:
Precondition: Successfully call registerCASModule().
Test method: Call enableDescramblingRequests() and input valid parameters.
Conformity result: Return ACTION_OK.
Conformity requirement 2:
Precondition: Successfully call registerCASModule().
Test method: Call enableDescramblingRequests() and input invalid parameters.
Conformity result: Return ACTION_ERROR_INVALID_PARAMETERS.
Conformity requirement 3:
Precondition: Successfully call registerCASModule(), underlying driver error.
Test method: Call enableDescramblingRequests() and input valid parameters.
Conformity result: Return ACTION_ERROR_DRIVER.
Conformity requirement 4:
Precondition: Successfully call registerCASModule().
Test method: Call enableDescramblingRequests(), and the input parameter command is not within the defined range.
Conformity result: Return ACTION_ERROR_ACTION_NOT_SUPPORTED.
Conformity requirement 1:
Precondition: Successfully call registerCASModule().
Test method: Call fetchDataFromCasHeadend() and input valid parameters.
Conformity result: Return ACTION_OK.
Conformity requirement 2:
Precondition: Successfully call registerCASModule().
Test method: Call fetchDataFromCasHeadend() and input invalid
ASModule
Manager | | parameters.
Conformity result: Return ACTION_ERROR_INVALID_PARAMETERS.
Conformity requirement 3:
Precondition: Successfully call registerCASModule(), underlying driver error.
Test method: Call fetchDataFromCasHeadend() and input valid parameters.
Conformity result: Return ACTION_ERROR_DRIVER.
Conformity requirement 4:
Precondition: Successfully call registerCASModule().
Test method: Call fetchDataFromCasHeadend(), and the input parameter command is not within the defined range.
Conformity result: Return ACTION_ERROR_ACTION_NOT_SUPPORTED.
Conformity requirement 5:
Precondition: Successfully call registerCASModule().
Test method: Call fetchDataFromCasHeadend(), with network error.
Conformity result: Return ACTION_ERROR_NETWORK. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|---------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 35 | | registerCASModule(vendorId,ca sModule,networkPriority,applicationContext) |
Precondition: getCasId() has been implemented, and DCASAPP has permission.
Test method: Call registerCASModule() and input valid parameters.
Conformity result: Registration is successful, and return ACTION_OK.
Conformity requirement 2:
Precondition: getCasId() has been implemented, and DCASAPP has permission.
Test method: Call registerCASModule() and input invalid parameters.
Conformity result: Return ACTION_ERROR_INVALID_PARAMETERS.
Conformity requirement 3:
Precondition: getCasId() is implemented, DCASAPP has no permissions.
Test method: Call registerCASModule() and input valid parameters.
Conformity result: Return ACTION_ERROR_SECURITY.
Conformity requirement 1:
Precondition: DCASAPP has permission.
Test method: Call removeCASModule() and input valid parameters.
Conformity result: Return ACTION_OK.
Conformity requirement 2:
Precondition: DCASAPP has permission.
Test method: Call removeCASModule() and input invalid parameters.
Conformity result: Return ACTION_ERROR_INVALID_PARAMETERS.
Conformity requirement 3:
Precondition: DCASAPP has no permissions.
Test method: Call removeCASModule() and input valid parameters.
Conformity result: Return ACTION_ERROR_SECURITY.
Conformity requirement 4:
Precondition: DCASAPP has permission, underlying driver error.
Test method: Call removeCASModule() and input valid parameters.
Conformity result: Return ACTION_ERROR_DRIVER.
Conformity requirement 1:
Precondition: Successfully call registerCASModule().
Test method: Call sendCommandToSTB() and input valid parameters.
Conformity result: Return ACTION_OK.
Conformity requirement 2:
Precondition: Successfully call registerCASModule().
Test method: Call sendCommandToSTB() and input invalid parameters.
Conformity result: Return ACTION_ERROR_INVALID_PARAMETERS.
Conformity requirement 3:
Precondition: Successfully call registerCASModule(), underlying driver error.
Test method: Call sendCommandToSTB() and input valid parameters.
Conformity result: Return ACTION_ERROR_DRIVER.
Conformity requirement 4:
Precondition: Successfully call registerCASModule().
Test method: Call sendCommandToSTB(), and the input parameter command is not within the defined range.
Conformity result: Return ACTION_ERROR_ACTION_NOT_SUPPORTED.
Conformity requirement 5:
Precondition: Successfully call registerCASModule().
Test method: Call sendDataToHeadend(),with network error.
Conformity result: Return ACTION_ERROR_NETWORK.
Conformity requirement 1:
Precondition: Successfully call registerCASModule().
Test method: Call sendDataToHeadend() and input valid parameters.
Conformity result: Return ACTION_OK.
Conformity requirement 2:
Precondition: Successfully call registerCASModule().
Test method: Call sendDataToHeadend() and input invalid parameters.
Conformity result:
Return ACTION_ERROR_INVALID_PARAMETERS.
Conformity requirement 3:
Precondition: Successfully call registerCASModule(), underlying driver error.
Test method: Call sendDataToHeadend() and input valid parameters.
Conformity result:
Return: ACTION_ERROR_DRIVER.
Conformity requirement 4:
Precondition: Successfully call registerCASModule().
Test method: Call sendDataToHeadend(), and the input parameter command is not within the defined range.
Conformity result:
Return ACTION_ERROR_ACTION_NOT_SUPPORTED.
Conformity requirement 5:
Precondition: Successfully call registerCASModule().
Test method: Call sendDataToHeadend(), with network error.
Conformity result:
Return ACTION_ERROR_NETWORK.
Conformity requirement 1:
Precondition: Successfully call onStartDescrambling().
Test method: Call sendDescramblingEvent() and input valid parameters.
Conformity result: Return ACTION_OK.
Conformity requirement 2:
Precondition: Successfully call onStartDescrambling().
Test method: Call sendDescramblingEvent() and input invalid parameters.
Conformity result: Return ACTION_ERROR_INVALID_PARAMETERS.
Conformity requirement 3:
Precondition: Successfully call onStartDescrambling().
Test method: Call sendDescramblingEvent(), and the input parameter command is not within the defined range.
Conformity requirement 1:
Precondition: Successfully call registerCASModule().
Test method: Call sendFreeTextOSD() and input valid parameters.
Conformity result: Return ACTION_OK.
Conformity requirement 2:
Precondition: Successfully call registerCASModule().
Test method: Call sendFreeTextOSD() and input invalid parameters.
Conformity result: Return ACTION_ERROR_INVALID_PARAMETERS.
Conformity requirement 3:
Precondition: Successfully call registerCASModule().
Test method: Call sendFreeTextOSD(), and the input parameter command is not within the defined range.
Conformity result: Return ACTION_ERROR_ACTION_NOT_SUPPORTED.
Conformity requirement 1:
Precondition: Successfully call registerCASModule().
Test method: Call setCCIBits() and input valid parameters.
Conformity result: Return ACTION_OK.
Conformity requirement 2:
Precondition: Successfully call registerCASModule().
Test method: Call setCCIBits() and input invalid parameters.
Conformity result: Return ACTION_ERROR_INVALID_PARAMETERS.
Conformity requirement 3:
Precondition: Successfully call registerCASModule().
Test method: Call setCCIBits() resulted in underlying driver error.
Conformity result: Return ACTION_ERROR_DRIVER.
Conformity requirement 4:
Precondition: Successfully call
Test method: Call setCCIBits(), and the input parameter command is not within the defined range.
Conformity result: Return ACTION_ERROR_ACTION_NOT_SUPPORTED. | +| 42 | | setData(casModule, propertyId, propertyType, propertyValue) | Conformity requirement 1:
Precondition: Successfully call registerCASModule().
Test method: Call setData() and input valid parameters.
Conformity result: Return ACTION_OK.
Conformity requirement 2:
Precondition: Successfully call registerCASModule().
Test method: Call setData() and input invalid parameters.
Conformity result: Return ACTION_ERROR_INVALID_PARAMETERS.
Conformity requirement 3:
Precondition: Successfully call registerCASModule().
Test method: Call setData(), the input parameter command is not within the defined range.
Conformity result: Return ACTION_ERROR_ACTION_NOT_SUPPORTED. | +| 43 | | setPinCode(casModule, pinCode) | Conformity requirement 1:
Precondition: Successfully call registerCASModule().
Test method: Call setPinCode() and input valid parameters.
Conformity result: Return ACTION_OK.
Conformity requirement 2:
Precondition: Successfully call registerCASModule().
Test method: Call setPinCode() and input invalid parameters.
Conformity result: Return ACTION_ERROR_INVALID_PARAMETERS.
Conformity requirement 3:
Precondition: Successfully call registerCASModule().
Test method: Call setPinCode(), underlying driver error.
Conformity result: Return | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|-----------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 44 | | | ACTION_ERROR_DRIVER.
Conformity requirement 4:
Precondition: Successfully call registerCASModule().
Test method: Call setPinCode(), and the input parameter command is not within the defined range.
Conformity result: Return ACTION_ERROR_ACTION_NOT_SUPPORTED. | +| | | setServiceListFilter(casModule,filterData) | Conformity requirement 1:
Precondition: Successfully call registerCASModule().
Test method: Call setServiceListFilter() and input valid parameters.
Conformity result: Return ACTION_OK.
Conformity requirement 2:
Precondition: Successfully call registerCASModule().
Test method: Call setServiceListFilter() and input invalid parameters.
Conformity result: Return ACTION_ERROR_INVALID_PARAMETERS.
Conformity requirement 3:
Precondition: Successfully call registerCASModule().
Test method: Call setServiceListFilter(), and the input parameter command is not within the defined range.
Conformity result: Return ACTION_ERROR_ACTION_NOT_SUPPORTED. | +| 45 | | startCasPacketLoading(casModule,cableModemFilter,sourceURL,casFilter) | Conformity requirement 1:
Precondition: Successfully call registerCASModule().
Test method: Call startCasPacketLoading() and input valid parameters.
Conformity result: Return ACTION_OK.
Conformity requirement 2:
Precondition: Successfully call registerCASModule().
Test method: Call startCasPacketLoading() and input invalid parameters.
Conformity result: Return ACTION_ERROR_INVALID_PARAMETERS.
Conformity requirement 3:
Precondition: Successfully call registerCASModule(). | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|--------|--------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
Test method: Call startCasPacketLoading(), underlying driver error.
Conformity result: Return ACTION_ERROR_DRIVER.
Conformity requirement 4:
Precondition: Successfully call registerCASModule().
Test method: Call startCasPacketLoading(), and the input parameter command is not within the defined range.
Conformity result: Return ACTION_ERROR_ACTION_NOT_SUPPORTED.
| +| 46 | | startEcmLoading(casModule,cas Session) |Conformity requirement 1:
Precondition: Successfully call onStartDescrambling().
Test method: Call startEcmLoading() and input valid parameters.
Conformity result: Return ACTION_OK.
Conformity requirement 2:
Precondition: Successfully call onStartDescrambling().
Test method: Call startEcmLoading() and input invalid parameters.
Conformity result: Return ACTION_ERROR_INVALID_PARAMETERS.
Conformity requirement 3:
Precondition: Successfully call onStartDescrambling().
Test method: Call startEcmLoading(), underlying driver error.
Conformity result: Return ACTION_ERROR_DRIVER.
| +| 47 | | startInbandEmmLoading(casModule,emmTableIds,casFilter,includeCatNotifications) |Conformity requirement 1:
Precondition: Successfully call registerCASModule().
Test method: Call startInbandEmmLoading() and input valid parameters.
Conformity result: Return ACTION_OK.
Conformity requirement 2:
Precondition: Successfully call registerCASModule().
Test method: Call startInbandEmmLoading() and input invalid parameters.
Conformity result: Return ACTION_ERROR_INVALID_PARAMETERS.
Conformity requirement 3:
Precondition: Successfully call
registerCASModule().
Test method: Call startInbandEmmLoading(), underlying driver error.
Conformity result: Return ACTION_ERROR_DRIVER.
Conformity requirement 4:
Precondition: Successfully call registerCASModule().
Test method: Call startInbandEmmLoading(), and the input parameter command is not within the defined range.
Conformity result: Return ACTION_ERROR_ACTION_NOT_SUPPORTED.
| +| 48 | | stopCasPacketLoading(casModule,cableModemFilter,sourceURL) |Conformity requirement 1:
Precondition: Successfully call startCasPacketLoading().
Test method: Call stopCasPacketLoading() and input valid parameters.
Conformity result: Return ACTION_OK.
Conformity requirement 2:
Precondition: Successfully call startCasPacketLoading().
Test method: Call stopCasPacketLoading() and input invalid parameters.
Conformity result: Return ACTION_ERROR_INVALID_PARAMETERS.
Conformity requirement 3:
Precondition: Successfully call startCasPacketLoading().
Test method: Call stopCasPacketLoading(), underlying driver error.
Conformity result: Return ACTION_ERROR_DRIVER.
| +| 49 | | stopEcmLoading(casModule,casSession) |Conformity requirement 1:
Precondition: Successfully call startEcmLoading().
Test method: Call stopEcmLoading() and input valid parameters.
Conformity result: Return ACTION_OK.
Conformity requirement 2:
Precondition: Successfully call startEcmLoading().
Test method: Call stopEcmLoading() and input invalid parameters.
Conformity result: Return ACTION_ERROR_INVALID_PARAMETERS.
| + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|-----------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Conformity requirement 3:Precondition: Successfully call startEcmLoading().
Test method: Call stopEcmLoading(), underlying driver error.
Conformity result: Return ACTION_ERROR_DRIVER. | +| 50 | | stopInbandEmmLoading(casModule) | Conformity requirement 1:
Precondition: Successfully call startInbandEmmLoading().
Test method: Call stopInbandEmmLoading() and input valid parameters.
Conformity result: Return ACTION_OK.
Conformity requirement 2:
Precondition: Successfully call startInbandEmmLoading().
Test method: Call stopInbandEmmLoading() and input invalid parameters.
Conformity result: Return ACTION_ERROR_INVALID_PARAMETERS.
Conformity requirement 3:
Precondition: Successfully call startInbandEmmLoading().
Test method: Call stopInbandEmmLoading(), underlying driver error.
Conformity result: Return ACTION_ERROR_DRIVER. | +| 51 | JSDCAS.CASPacketEvent | getCableModemFilter() | Conformity requirement 1:
Precondition: The platform calls onCasPacketEvent without using Cable mode.
Test method: DCAS calls getCableModemFilter().
Conformity result: Return null.
Conformity requirement 2:
Precondition: The platform calls onCasPacketEvent and uses Cable mode.
Test method: DCAS calls getCableModemFilter().
Conformity result: Return TunnerID.
Conformity requirement 3:
Precondition: The platform calls onCasPacketEvent and uses BDSG mode.
Test method: DCAS calls getCableModemFilter().
Conformity result: Return the virtual MAC address. | +| 52 | | getPacketData() | Conformity requirements:
Precondition: Platform calls | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|-------------------|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | onCasPacketEvent.
Test method: DCAS calls getPacketData().
Conformity result: Return the data in the packet. | +| 53 | | getPacketHeader() | Conformity requirements:
Precondition: Platform calls onCasPacketEvent.
Test method: DCAS calls getPacketHeader().
Conformity result: Return the header of the packet. | +| 54 | | getSourceURL() | Conformity requirements:
Precondition: Platform calls onCasPacketEvent.
Test method: DCAS calls getSourceURL().
Conformity result: Return the source address of the packet. | +| 55 | JSDCAS.CASSession | getCasDescriptor() | Conformity requirements:
Precondition: The platform calls onStartDescrambling, and DCAS obtains the CASSession object.
Test method: DCAS calls getCasDescriptor().
Conformity result: Return a CasDescriptor instance. | +| 56 | | getChannelNumber() | Conformity requirements:
Precondition: The platform calls onStartDescrambling, and DCAS obtains the CASSession object.
Test method: DCAS calls getChannelNumber().
Conformity result: Return channel number. | +| 57 | | getNetworkId() | Conformity requirements:
Precondition: The platform calls onStartDescrambling, and DCAS obtains the CASSession object.
Test method: DCAS calls getNetworkId().
Conformity result: Return NetworkId. | +| 58 | | GetOperationType() | Conformity requirements:
Precondition: The platform calls onStartDescrambling, and DCAS obtains the CASSession object.
Test method: DCAS calls GetOperationType().
Conformity result: Return the value of the operation type. | +| 59 | JSDCAS.CASSession | getProgramNumber() | Conformity requirements:
Precondition: The platform calls onStartDescrambling, and DCAS obtains the CASSession object.
Test method: DCAS calls | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|----------------------|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | JSDCAS.C
ASession | | getProgramNumber().
Conformity result: Return the programme number. | +| 60 | | getServiceIdentifier() | Conformity requirements:
Precondition: The platform calls onStartDescrambling, and DCAS obtains the CASSession object.
Test method: DCAS calls getServiceIdentifier().
Conformity result: Return the service identifier. | +| 61 | | getSessionId() | Conformity requirements:
Precondition: The platform calls onStartDescrambling, and DCAS obtains the CASSession object.
Test method: DCAS calls getSessionId().
Conformity result: Return SessionId. | +| 62 | | getStreamPath() | Conformity requirements:
Precondition: The platform calls onStartDescrambling, and DCAS obtains the CASSession object.
Test method: DCAS calls getStreamPath().
Conformity result: Return StreamPath. | +| 63 | | getStreamPIDs() | Conformity requirements:
Precondition: The platform calls onStartDescrambling, and DCAS obtains the CASSession object.
Test method: DCAS calls getStreamPIDs().
Conformity result: Return a list of Stream PIDs. | +| 64 | | getStreamTypes() | Conformity requirements:
Precondition: The platform calls onStartDescrambling, and DCAS obtains the CASSession object.
Test method: DCAS calls getStreamTypes().
Conformity result: Return a list of Stream Types. | +| 65 | | getTransmitterScramblingMode() | Conformity requirements:
Precondition: The platform calls onStartDescrambling, and DCAS obtains the CASSession object.
Test method: DCAS calls getTransmitterScramblingMode().
Conformity result: Return scrambling mode. | +| 66 | | getTransportStreamId() | Conformity requirements:
Precondition: The platform calls onStartDescrambling, and DCAS obtains the CASSession object. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|---------------------|--------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Test method: DCAS calls getTransportStreamId().
Conformity result: Return TS ID. | +| 67 | | getTunerId() | Conformity requirements:
Precondition: The platform calls onStartDescrambling, and DCAS obtains the CASession object.
Test method: DCAS calls getTunerId().
Conformity result: Return the current TunerID. | +| 68 | | getCasToken() | Conformity requirements:
Precondition: DCAS calls sendDescramblingEvent, and the platform obtains the CASStatus object.
Test method: Platform calls getCasToken().
Conformity result: Return the CAS token. | +| 69 | | getMajorContentProblem() | Conformity requirements:
Precondition: DCAS calls sendDescramblingEvent, and the platform obtains the CASStatus object.
Test method: The platform calls getMajorContentProblem().
Conformity result: Return the main error that cannot be viewed. | +| 70 | JSDCAS.CASStatus | getStatusData() | Conformity requirements:
Precondition: DCAS calls sendDescramblingEvent, and the platform obtains the CASStatus object.
Test method: Platform calls getStatusData().
Conformity result: Return the extended data of the descrambling state. | +| 71 | JSDCAS.CASStatus | isSuccess() | Conformity requirement 1:
Precondition: DCAS calls sendDescramblingEvent, the platform obtains the CASStatus object, and the programme descrambles normally.
Test method: Platform calls isSuccess().
Conformity result: Return true.
Conformity requirement 2:
Precondition: DCAS calls sendDescramblingEvent, platform obtains CASStatus object, programme descrambling fails.
Test method: Platform calls isSuccess().
Conformity result: Return false. | +| 72 | JSDCAS.TeController | sendCommandToTEE(teeAppUID,commandId,inputData,applicationContext) | Conformity requirements:
Precondition: None.
Test method: DCAS calls sendCommandToTEE() with parameters. | + +| Serial No. | Object | Message/Interface/Attribute | Process description | +|------------|------------------|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Conformity result: Return the TeeRetVal object. | +| 73 | JSDCAS.TeeRetVal | getOriginCode() | Conformity requirements:
Precondition: DCAS successfully calls sendCommandToTEE and returns the TeeRetVal object.
Test method: DCAS calls getOriginCode().
Conformity result: Return Origin code. | +| | | getResponseData() | Conformity requirements:
Precondition: DCAS successfully calls sendCommandToTEE and returns the TeeRetVal object.
Test method: DCAS calls getResponseData().
Conformity result: Get TA return data. | +| | | getReturnCode() | Conformity requirements:
Precondition: DCAS successfully calls sendCommandToTEE and returns the TeeRetVal object.
Test method: DCAS calls getReturnCode().
Conformity result: Return the return code. | + +# Annex C + +## Conformance test of hardware abstraction interfaces + +(This annex forms an integral part of this Recommendation.) + +### C.1 Conformance test of specialized hardware abstraction interfaces for media processing + +| Serial No. | Module | API | Process description | +|------------|--------|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Aout | aout_close() |
Conformity requirement 1:
Precondition: Aout_open has been called to open the audio output module.
Test method: Call the aout_close function and input valid parameters.
Conformity result: The function call is successful and returns 0.
Conformity requirement 2:
Precondition: Aout_open is not called to open the audio output module.
Test method: Call the aout_close function and input invalid parameters.
Conformity result: The function returns non-zero.
Conformity requirements:
Precondition: The system under test contains audio output hardware.
Test method: Call the aout_open function and input valid parameters.
Conformity result: The function call is successful, and returns 0, the audio output hardware handle is obtained.
Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and an audio output instance has been opened.
Test method: Call the aout_close function and input valid parameters.
Conformity result: The function call is successful, and returns 0, the audio output instance has been closed.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but no audio output instance has been opened.
Test method: Call the aout_close function and input invalid parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and an audio output instance
Test method: Call the aout_get_capability function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the audio output capability of the audio output instance.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio output instance has not been opened.
Test method: Call the aout_get_capability function and input invalid parameters.
Conformity result: The function returns non-zero. | +| 5 | | *aout_get_channel_mode() | Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and an audio output instance has been opened.
Test method: Call the aout_get_channel_mode function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the audio channel mode.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained and an audio output instance has been opened.
Test method: Call the aout_get_channel_mode function and fill in invalid values for the device type input parameters.
Conformity result: The function returns non-zero. | +| 6 | | *aout_get_digital_mode() | Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and an audio output instance has been opened.
Test method: Call the aout_get_digital_mode function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns audio output mode.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio output instance has not been opened.
Test method: Call the aout_get_digital_mode function and input invalid parameters.
Conformity result: The function returns non-zero. | + +| Serial No. | Module | API | Process description | +|------------|--------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 7 | | *aout_get_mute() |
Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and an audio output instance has been opened.
Test method: Call the aout_get_mute function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns whether the current tested device is muted.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio output instance has not been opened.
Test method: Call the aout_get_mute function and input invalid parameter values.
Conformity result: The function returned an invalid value.
Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and an audio output instance has been opened.
Test method: Call the aout_get_volume function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the system volume of the current tested device.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio output instance has not been opened.
Test method: Call the aout_get_volume function and input invalid parameter values.
Conformity result: The function returns non-zero.
Conformity requirements:
Precondition: Get audio output hardware handle.
Test method: Call the aout_init function and input valid parameters.
Conformity result: The function call is successful, and returns 0, the audio output module completes initialization.
Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained, and the initialization of the audio output module has been completed.
Test method: Call the aout_open function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns a handle to an audio output instance.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the initialization of the audio output module has not been completed.
Test method: Call the aout_open function and input valid parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and an audio output instance has been opened.
Test method: Call the aout_set_channel_mode function and input valid parameters.
Conformity result: The function call is successful, and returns 0, the channel mode is correctly set.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio output instance has not been opened.
Test method: Call the aout_set_channel_mode function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and an audio output instance has been opened.
Test method: Call the aout_set_digital_mode function and input valid parameters.
Conformity result: The function call is successful, and returns 0, the digital output mode is correctly set.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio output instance has not been opened.
Test method: Call the aout_set_digital_mode function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and an audio output instance has been opened.
Test method: Call the aout_set_mute function and input valid parameters.
Conformity result: The function call is successful and returns 0. Check if it has been muted based on the mute.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio output instance has not been opened.
Test method: Call the aout_set_mute function and input invalid parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and an audio output instance has been opened.
Test method: Call the aout_set_volume function and input valid parameters.
Conformity result: The function call is successful and returns 0. Check if the system volume has changed.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio output instance has not been opened.
Test method: Call the aout_set_volume function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and an audio output instance has been opened.
Test method: Call the aout_term function and input valid parameters.
Conformity result: The function call is successful, returns 0, and all audio output instances are closed.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained and an audio output instance has been opened.
Test method: Repeatedly call the aout_term function and input valid parameters.
Conformity result: The function call is
Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and an audio output instance has been opened.
Test method: Call the track_create function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter obtains a non empty track output handle.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained and an audio output instance has been opened.
Test method: Call the track_create function multiple times and input valid parameters.
Conformity result: The function call is successful, and returns 0. Multiple non empty track output handles are obtained, and multiple tracks are mixed before being output.
Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the track_destroy function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the corresponding audio track output handle is destroyed.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Test method: Call the track_destroy function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the track_get_buf_avail function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the remaining available cache space size.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output
handle has not been created.
Test method: Call the track_get_buf_avail function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 19 | |*track_get_latency() | Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the track_get_latency function and input valid parameters.
Conformity result: The function call is successful, returns 0, and outputs the duration for which the cached audio data can be played.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Test method: Call the track_get_latency function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 20 | |*track_get_mix_params() | Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the track_get_mix_params function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the track mixing parameter.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Test method: Call the track_get_mix_params function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 21 | |*track_get_params() | Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the track_get_params function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter
| + +| Serial No. | Module | API | Process description | +|------------|--------|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | returns the properties of the current audio track.Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Test method: Call the
track_get_params function and take invalid values for the input parameters.Conformity result: The function returns non-zero. | +| 22 | |
*track_set_mix_params() | Conformity requirement 1:Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the
track_set_mix_params function and input valid parameters.Conformity result: The function call is successful and returns 0.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Test method: Call the
track_set_mix_params function and take invalid values for the input parameters.Conformity result: The function returns non-zero. | +| 23 | |
*track_set_params() | Conformity requirement 1:Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the
track_set_params function and input valid parameters.Conformity result: The function call is successful and returns 0.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Test method: Call the
track_set_params function and take invalid values for the input parameters.Conformity result: The function returns non-zero. | +| 24 | |
*track_start() | Conformity requirement 1:Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the
track_start function and input valid parameters.Conformity result: The function call is | + +| Serial No. | Module | API | Process description | +|------------|--------|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | successful, returns 0, and the audio starts outputting hardware output from the audio.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Test method: Call the track_start function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 25 | | *track_stop() | Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the track_stop function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the audio stops outputting from the audio hardware.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Test method: Call the track_stop function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 26 | | *track_flush() | Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained, and a track output handle has been created, and the output of that track has started.
Test method: Call the track_flush function and input valid parameters.
Conformity result: The function call is successful, and returns 0, the audio output is resumed after clearing the cache.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Test method: Call the track_flush function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 27 | | *track_set_mute() | Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the track_set_mute function | + +| Serial No. | Module | API | Process description | +|------------|--------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
and input valid parameters.
Conformity result: The function call is successful, returns 0, and complete the setting of whether or not to mute the track.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Test method: Call the track_set_mute function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 28 | | *track_get_mute() |Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the track_get_mute function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns whether the track is muted. This value needs to be consistent with the setting in the track_set_mute() interface.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Test method: Call the track_get_mute function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 29 | | *track_set_channel_mode() |Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the track_set_channel_mode function and input valid parameters.
Conformity result: The function call is successful and returns 0, completes the setting of the channel output mode for the track.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Test method: Call the track_set_channel_mode function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| + +| Serial No. | Module | API | Process description | +|------------|--------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 30 | | *track_get_channel_mode() |Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the track_get_channel_mode function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the channel output mode of the track.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Test method: Call the track_get_channel_mode function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the track_set_weight function and input valid parameters.
Conformity result: The function call is successful and returns 0, indicating the weight of the completed output of the track in the total output.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Test method: Call the track_set_weight function and take invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the track_get_weight function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the weight of the output of the track in the total output.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Conformity result: The function returns non-zero. | +| 33 | | *track_get_render_position() | Conformity requirement 1:
Precondition:
Test method: Call the track_get_render_position function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the the number of frames that have been output for the current track..
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Test method: Call the track_get_render_position function and take invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 34 | | *track_get_pts() | Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the track_get_pts function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the current PTS of the track.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Test method: Call the track_get_pts function and take invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 35 | | *track_adjust_speed() | Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the track_adjust_speed function and input valid parameters.
Conformity result: The function call is successful, returns 0, and adjusts the playback speed of the current track.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output | + +| Serial No. | Module | API | Process description | +|------------|--------|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
handle has not been created.
Test method: Call the track_adjust_speed function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 36 | | *track_write() |Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the track_write function and input valid parameters.
Conformity result: The function call is successful, returns 0, and writes audio data to the current track output handle.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Test method: Call the track_write function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 37 | | *track_pause() |Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the track_pause function and input valid parameters.
Conformity result: The function call is successful, returns 0, and pauses the output of the current track.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Test method: Call the track_pause function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 38 | | *track_resume() |Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the track_resume function and input valid parameters.
Conformity result: The function call is successful, returns 0, and resumes the output of the current audio track.
Conformity requirement 2:
| + +| Serial No. | Module | API | Process description | +|------------|--------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.Test method: Call the track_resume function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 39 | | *track_get_default_attr() | Conformity requirement 1:
Precondition: The audio output hardware handle has been obtained and a track output handle has been created.
Test method: Call the track_get_default_attr function and input valid parameters.
Conformity result: The function call is successful, returns 0, and gets the default properties of the current track output handle.
Conformity requirement 2:
Precondition: The audio output hardware handle has been obtained, but the audio track output handle has not been created.
Test method: Call the track_get_default_attr function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 40 | | av_close() | Conformity requirement 1:
Precondition: av_open has been called to open the audio and video module.
Test method: Call the av_close function and input valid parameters.
Conformity result: The function call is successful and returns 0.
Conformity requirement 2:
Precondition: No Precondition is set or av_open is not called to open the audio and video module.
Test method: Call the av_close function and input invalid parameters.
Conformity result: The function returns non-zero. | +| 41 | Av | av_open() | Conformity requirements:
Precondition: The tested system contains audio and video hardware.
Test method: Call the av_open function and input valid parameters.
Conformity result: The function call is successful, returns 0, and gets the hardware handle of the audio and video hardware. | +| 42 | | *av_clear_video() | Conformity requirement 1:
Precondition: The audio and video hardware | + +| Serial No. | Module | API | Process description | +|------------|--------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Av | |
handle has been obtained, and an audio and video playback instance has been created.
Test method: Call the av_clear_video function and input valid parameters.
Conformity result: The function call is successful, returns 0, and clears the cached data in the audio and video player.
Conformity requirement 2:
Precondition: The audio and video hardware handle has been obtained, and no audio and video playback instance has been created.
Test method: Call the av_clear_video function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 43 | |*av_create() | Conformity requirement 1:
Precondition: Get audio and video hardware handle.
Test method: Call the av_create function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the audio and video player instance.
Conformity requirement 2:
Precondition: Get audio and video hardware handle.
Test method: Call the av_create function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 44 | |*av_decode_iframe() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_decode_iframe function and input valid parameters.
Conformity result: The function call is successful, returns 0, and decodes one frame of I-frame video data.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_decode_iframe function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 45 | |*av_destroy() | Conformity requirement 1:
Precondition: The audio and video hardware
| + +| Serial No. | Module | API | Process description | +|------------|--------|-----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Av | |handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_destroy function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the player instance is destroyed.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_destroy function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 46 | |*av_evt_config() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_evt_config function and input valid parameters.
Conformity result: The function call is successful and returns 0. Configure the player's event notification callback function.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_evt_config function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 47 | |*av_freeze_video() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_freeze_video function and input valid parameters.
Conformity result: The function call succeeds and returns 0. The audio and video continue to be decoded, but the output is frozen.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_freeze_video function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 48 | |*av_get_capability() | Conformity requirement 1:
| + +| Serial No. | Module | API | Process description | +|------------|--------|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Av | |Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_get_capability function and input valid parameters.
Conformity result: The function call is successful, returns 0, and returns the ability of the audio and video player as an argument.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_get_capability function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 49 | |*av_get_config() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_get_config function and input valid parameters.
Conformity result: The function call is successful, returns 0, and returns the configuration of the audio and video player.
Conformity requirement 2:
Precondition: No audio and video hardware handle is obtained, no audio and video player instance is created.
Test method: Call the av_get_config function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 50 | |*av_get_evt_config() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_get_evt_config function and input valid parameters.
Conformity result: The function call is successful, returns 0, and returns the configuration of the event callback function for the audio and video player.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_get_evt_config function and take invalid values for the input
Conformity result: The function returns non-zero. | +| 51 | | *av_get_status() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_get_status function and input valid parameters.
Conformity result: The function call is successful, returns 0, and returns the status of the audio and video player with parameters.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_get_status function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 52 | | *av_init() | Conformity requirement 1:
Precondition: Get audio and video hardware handle.
Test method: Call the av_init function and input valid parameters.
Conformity result: The function call is successful, and returns 0, and the audio and video player is initialized.
Conformity requirement 2:
Precondition: Get audio and video hardware handle.
Test method: Call the av_init function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 53 | | *av_inject_abort() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_inject_abort function and input valid parameters.
Conformity result: The function call is successful, and returns 0, and the injection of data into the player is terminated.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_inject_abort function and take invalid values for the input parameters. | + +| Serial No. | Module | API | Process description | +|------------|--------|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 54 | Av | | Conformity result: The function returns non-zero. | +| 55 | | *av_inject_data() |
Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_inject_data function and input valid parameters.
Conformity result: The function call is successful and returns 0, injecting audio and video data into the player.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_inject_data function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_inject_es_data function and input valid parameters.
Conformity result: The function call is successful and returns 0, injecting ES audio and video data into the player.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_inject_es_data function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity result: The function returns non-zero. | +| | | *av_inject_get_freebuf() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_inject_get_freebuf function and input valid parameters.
Conformity result: The function call is successful, returns 0, and gets the remaining cache space of the player.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_inject_get_freebuf function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 58 | | *av_inject_reset_buf() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_inject_reset_buf function and input valid parameters.
Conformity result: The function call is successful, returns 0, and resets the player's current cache space.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_inject_reset_buf function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 59 | | *av_inject_set_es_params() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_inject_set_es_params function and input valid parameters.
Conformity result: The function call is successful, and returns 0, and ES player parameters are set. | + +| Serial No. | Module | API | Process description | +|------------|--------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 60 | Av | |
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_inject_set_es_params function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_inject_set_pcm_params function and input valid parameters.
Conformity result: The function call is successful, and returns 0, and PCM parameters are set.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_inject_set_pcm_params function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_inject_write_complete function and input valid parameters.
Conformity result: The function call is successful, returns 0, the data writing is completed, and the player decodes and plays the cached audio and video data.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_inject_write_complete function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_injecter_attach function and input valid parameters.
Conformity result: The function call is successful and returns 0, completes the association between the audio and video player and the audio and video injector.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_injecter_attach function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_injecter_close function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the audio and video injector is closed.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_injecter_close function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_injecter_detach function and input valid parameters.
Conformity result: The function call succeeds and returns 0, completing the unassociation of the audio/video player and the audio/video injector.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Conformity result: The function returns non-zero. | +| 65 | | *av_injecter_open() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_injecter_open function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns a handle to the audio and video injector.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_injecter_open function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 66 | | *av_pause_audio() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_pause_audio function and input valid parameters.
Conformity result: The function call is successful, and returns 0, and the player's audio playback is paused.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_pause_audio function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 67 | | *av_pause_video() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_pause_video function and input valid parameters.
Conformity result: The function call is successful, and returns 0, and the player's video playback is paused.
Conformity requirement 2:
Precondition: Get audio and video hardware | + +| Serial No. | Module | API | Process description | +|------------|--------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | handle, do not create an audio and video player instance.
Test method: Call the av_pause_video function and take invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 68 | | *av_resume_audio() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_resume_audio function and input valid parameters.
Conformity result: The function call is successful, and returns 0, and the player's audio playback is resumed.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_resume_audio function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 69 | | *av_resume_video() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_resume_video function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the player's video playback is resumed.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_resume_video function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 70 | | *av_set_config() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_set_config function and input valid parameters.
Conformity result: The function call is successful and returns 0. Set the player's | + +| Serial No. | Module | API | Process description | +|------------|--------|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | playback parameters.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_set_config function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 71 | | *av_start() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_start function and input valid parameters.
Conformity result: The function call is successful, and returns 0, and playback began.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_start function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 72 | | *av_start_audio() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_start_audio function and input valid parameters.
Conformity result: The function call is successful, returns 0, and audio playback begins.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_start_audio function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 73 | | *av_start_video() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_start_video function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the video playback | + +| Serial No. | Module | API | Process description | +|------------|--------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
begins.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_start_video function and take invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_stop function and input valid parameters.
Conformity result: The function call is successful, returns 0, and stops playing audio and video.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_stop function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_stop_audio function and input valid parameters.
Conformity result: The function call is successful, returns 0, and stops audio playback.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_stop_audio function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_stop_video function and input valid parameters.
Conformity result: The function call is successful, and returns 0, and the video
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_stop_video function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 77 | | *av_term() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_term function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the audio and video player is destroyed.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_term function and take invalid values for input parameters.
Conformity result: The function returns non-zero. | +| 78 | | *av_pause() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_pause function and input valid parameters.
Conformity result: The function call is successful, and returns 0, and audio and video playback is paused.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_pause function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 79 | | *av_resume() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_resume function and input valid parameters.
Conformity result: The function call is | + +| Serial No. | Module | API | Process description | +|------------|--------|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | successful and returns 0, resumed audio and video playback.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_resume function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 80 | | *av_reset() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_reset function and input valid parameters.
Conformity result: The function call is successful, and returns 0, and the audio and video playback is reset.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_reset function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 81 | | *av_release_iframe() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_release_iframe function and input valid parameters.
Conformity result: The function call is successful, returns 0, and releases an I frame.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_release_iframe function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 82 | | *av_inject_get_setting() | Conformity requirement 1:
Precondition: The audio and video hardware handle has been obtained, and an audio and video player instance has been created.
Test method: Call the av_inject_get_setting function and input valid parameters. | + +| Serial No. | Module | API | Process description | +|------------|--------|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
Conformity result: The function call is successful, returns 0, and the output parameter returns the set parameter of the audio and video injector.
Conformity requirement 2:
Precondition: Get audio and video hardware handle, do not create an audio and video player instance.
Test method: Call the av_inject_get_setting function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The tested system has called demux_close to obtain the demux hardware handle.
Test method: Call the demux_close function and input valid parameters.
Conformity result: The function call is successful and returns 0.
Conformity requirement 2:
Precondition: The demux hardware handle has been obtained.
Test method: Call the demux_close function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The tested system contains demux hardware.
Test method: Call the demux_open function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the demux hardware handle.
Conformity requirement 2:
Precondition: None.
Test method: Call the demux_open function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A demux hardware handle has been obtained and a filter has been created.
Test method: Call the dmx_avfilter_close function and input valid parameters.
Conformity result: The function call is successful, and returns 0, and the filter is closed.
Conformity requirement 2:
| + +| Serial No. | Module | API | Process description | +|------------|--------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Demux | | Precondition: Get Demux hardware handle, no filter is created.Test method: Call the dmx_avfilter_close function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 86 | | *dmx_avfilter_disable() | Conformity requirement 1:
Precondition: Get Demux hardware handle , filter is created.
Test method: Call the dmx_avfilter_disable function and input valid parameters.
Conformity result: The function call is successful, returns 0 to enable the filter.
Conformity requirement 2:
Precondition: Get Demux hardware handle , no filter is created.
Test method: Call the dmx_avfilter_disable function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 87 | | *dmx_avfilter_enable() | Conformity requirement 1:
Precondition: Get Demux hardware handle, filter is created.
Test method: Call the dmx_avfilter_enable function and input valid parameters.
Conformity result: The function call is successful, and return 0 to enable the filter.
Conformity requirement 2:
Precondition: Get Demux hardware handle , no filter is created.
Test method: Call the dmx_avfilter_enable function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 88 | | *dmx_avfilter_get_esframe() | Conformity requirement 1:
Precondition: Get Demux hardware handle , filter is created.
Test method: Call the dmx_avfilter_get_esframe function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter carries ES data.
Conformity requirement 2:
Precondition: Get Demux hardware handle, no filter is created.
Test method: Call the dmx_avfilter_get_esframe function, and take invalid values for the input | + +| Serial No. | Module | API | Process description | +|------------|--------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | parameters.
Conformity result: The function returns non-zero. | +| 89 | Demux | *dmx_avfilter_open() | Conformity requirement 1:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_avfilter_open function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter carries the filtered handle.
Conformity requirement 2:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_avfilter_open function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 90 | | *dmx_avfilter_release_esframe() | Conformity requirement 1:
Precondition: Get Demux hardware handle , filter is created.
Test method: Call the dmx_avfilter_release_esframe function and input valid parameters.
Conformity result: The function call is successful, returns 0, and releases one frame of ES data.
Conformity requirement 2:
Precondition: Get Demux hardware handle, no filter is created.
Test method: Call the dmx_avfilter_release_esframe function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 91 | | *dmx_channel_add_filter() | Conformity requirement 1:
Preconditions: Get Demux hardware handle, filter is created, data channel is created.
Test method: Call the dmx_channel_add_filter function and input valid parameters.
Conformity result: The function call is successful and returns 0, adds a filter to the data channel.
Conformity requirement 2:
Precondition: Get Demux hardware handle, no filter is created, no data channel is created.
Test method: Call the dmx_channel_add_filter function, and take invalid values for the input parameters. | + +| Serial No. | Module | API | Process description | +|------------|--------|--------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 92 | Demux | | Conformity result: The function returns non-zero. | +| 93 | | *dmx_channel_close() |
Conformity requirement 1:
Precondition: Get Demux hardware handle , data channel is created.
Test method: Call the dmx_channel_close function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the specified data channel is closed.
Conformity requirement 2:
Precondition: Get Demux hardware handle, no data channel is created.
Test method: Call the dmx_channel_close function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: Get Demux hardware handle, data channel is created.
Test method: Call the dmx_channel_config_callback function and input valid parameters.
Conformity result: The function call is successful and returns 0. Configure the callback function for the data channel.
Conformity requirement 2:
Precondition: Get Demux hardware handle, no data channel is created.
Test method: Call the dmx_channel_config_callback function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: Get Demux hardware handle, data channel is created.
Test method: Call the dmx_channel_destroy_filter function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the filter specific to the data channel is destroyed.
Conformity requirement 2:
Precondition: Get Demux hardware handle, no data channel is created.
Test method: Call the dmx_channel_destroy_filter function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 96 | | *dmx_channel_disable() | Conformity requirement 1:
Precondition: Get Demux hardware handle , data channel is created.
Test method: Call the dmx_channel_disable function and input valid parameters.
Conformity result: The function call is successful and returns 0 to enable the data channel.
Conformity requirement 2:
Precondition: Get Demux hardware handle, no data channel is created.
Test method: Call the dmx_channel_disable function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 97 | | *dmx_channel_disable_filter() | Conformity requirement 1:
Precondition: Get Demux hardware handle, data channel is created.
Test method: Call the dmx_channel_disable_filter function and input valid parameters.
Conformity result: The function call is successful and returns 0 to enable a certain filter of the data channel.
Conformity requirement 2:
Precondition: Get Demux hardware handle, no data channel is created.
Test method: Call the dmx_channel_disable_filter function, and take invalid values for the input parameters.
Conformity result: The function returns non- | + +| Serial No. | Module | API | Process description | +|------------|--------|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 98 | Demux | | zero. | +| 99 | | *dmx_channel_enable() |
Conformity requirement 1:
Precondition: Get Demux hardware handle , data channel is created.
Test method: Call the dmx_channel_enable function and input valid parameters.
Conformity result: The function call is successful and returns 0, enables the data channel.
Conformity requirement 2:
Precondition: Get Demux hardware handle, no data channel is created.
Test method: Call the dmx_channel_enable function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: Get Demux hardware handle, data channel is created.
Test method: Call the dmx_channel_enable_filter function and input valid parameters.
Conformity result: The function call is successful and returns 0. Configure a filter for this data channel.
Conformity requirement 2:
Precondition: Get Demux hardware handle, no data channel is created.
Test method: Call the dmx_channel_enable_filter function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: Get demux hardware handle, data channel is created.
Test method: Call the dmx_channel_get_buf function and input valid parameters.
Conformity result: The function call is successful, returns 0, and gets the data of the data channel.
Conformity requirement 2:
Precondition: Get demux hardware handle, no data channel is created.
Test method: Call the dmx_channel_get_buf function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: Get demux hardware handle, data channel is created.
Test method: Call the dmx_channel_get_filter function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the filtering condition of the filter.
Conformity requirement 2:
Precondition: Get demux hardware handle, no data channel is created.
Test method: Call the dmx_channel_get_filter function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: Get demux hardware handle, data channel is created.
Test method: Call the dmx_channel_get_info function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the configuration information of the data channel.
Conformity requirement 2:
Precondition: Get demux hardware handle, no data channel is created.
Test method: Call the dmx_channel_get_info function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_channel_open function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the handle of the data channel.
Conformity requirement 2:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_channel_open function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: Get demux hardware handle, data channel is created.
Test method: Call the dmx_channel_query function and input valid parameters.
Conformity result: The function call is successful, returns 0, and queries whether a certain PID has a data channel.
Conformity requirement 2:
Precondition: Get demux hardware handle, no data channel is created.
Test method: Call the dmx_channel_query function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: Get demux hardware handle, data channel is created.
Test method: Call the dmx_channel_query_filter_by_filter_data function and input valid parameters.
Conformity result: The function call is successful and returns 0. Query whether the filter exists based on the filtering criteria.
Conformity requirement 2:
Precondition: Get demux hardware handle, no data channel is created.
Test method: Call the dmx_channel_query_filter_by_filter_data function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: Get demux hardware handle, data channel is created.
Test method: Call the dmx_channel_query_filter_by_table_id function and input valid parameters.
Conformity result: The function call is successful and returns 0. Check if there is a matching filter based on the table ID.
Conformity requirement 2:
Precondition: Get demux hardware handle, no data channel is created.
Test method: Call the dmx_channel_query_filter_by_table_id function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: Get demux hardware handle, data channel is created.
Test method: Call the dmx_channel_register_callback function and input valid parameters.
Conformity result: The function call is successful and returns 0. Register a callback function for the data channel.
Conformity requirement 2:
Precondition: Get demux hardware handle, no data channel is created.
Test method: Call the dmx_channel_register_callback function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: Get demux hardware handle, data channel is created.
Test method: Call the dmx_channel_release_buf function and input valid parameters.
Conformity result: The function call is successful and returns 0, releases the cache space occupied by the data packet.
Conformity requirement 2:
Precondition: Get demux hardware handle, no data channel is created.
Test method: Call the dmx_channel_release_buf function, and take invalid values for the input parameters.
Conformity result: The function returns non-
Conformity requirement 1:
Precondition: Get demux hardware handle, data channel is created.
Test method: Call the dmx_channel_reset function and input valid parameters.
Conformity result: The function call is successful and returns 0, completes the reset of the data channel.
Conformity requirement 2:
Precondition: Get demux hardware handle, no data channel is created.
Test method: Call the dmx_channel_reset_function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: Get demux hardware handle, data channel is created.
Test method: Call the dmx_channel_set function and input valid parameters.
Conformity result: The function call is successful and returns 0. Configure the parameters of the data channel.
Conformity requirement 2:
Precondition: Get demux hardware handle, no data channel is created.
Test method: Call the dmx_channel_set function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: Get demux hardware handle, data channel is created.
Test method: Call the dmx_channel_set_filter function and input valid parameters.
Conformity result: The function call is successful, returns 0, and sets the filtering conditions for the data channel.
Conformity requirement 2:
Precondition: Get demux hardware handle, no data channel is created.
Test method: Call the dmx_channel_set_filter function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: Get demux hardware handle, data channel is created.
Test method: Call the dmx_channel_set_pid function and input valid parameters.
Conformity result: The function call is successful and returns 0. Configure the PID of the data channel.
Conformity requirement 2:
Precondition: Get demux hardware handle, no data channel is created.
Test method: Call the dmx_channel_set_pid function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The demux hardware handle has been obtained and a descrambling channel has been created.
Test method: Call the dmx_dcas_get_nonce function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the NONCE value.
Conformity requirement 2:
Precondition: Get demux hardware handle, no descrambling channel is created.
Test method: Call the dmx_dcas_get_nonce function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The demux hardware handle has been obtained and a descrambling channel has been created.
Test method: Call the dmx_dcas_keyladder_config function and input valid parameters.
Conformity result: The function call succeeds, returns 0, and configures the descrambling parameters.
Conformity requirement 2:
Precondition: Get demux hardware handle, no descrambling channel is created.
Test method: Call the dmx_dcas_keyladder_config function, and take invalid values for the input parameters.
Conformity result: The function returns non-
Conformity requirement 1:
Precondition: The demux hardware handle has been obtained and a descrambling channel has been created.
Test method: Call the dmx_descrambler_associate function and input valid parameters.
Conformity result: The function call is successful, returns 0, and is associated with a certain PID or data channel.
Conformity requirement 2:
Precondition: Get demux hardware handle, no descrambling channel is created.
Test method: Call the dmx_descrambler_associate function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The demux hardware handle has been obtained and a descrambling channel has been created.
Test method: Call the dmx_descrambler_close function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the specified descrambling channel is closed.
Conformity requirement 2:
Precondition: Get demux hardware handle, no descrambling channel is created.
Test method: Call the dmx_descrambler_close function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The demux hardware handle has been obtained and a descrambling channel has been created.
Test method: Call the dmx_descrambler_disable function and input valid parameters.
Conformity result: The function call is successful and returns 0 to enable the specified descrambling channel.
Conformity requirement 2:
Precondition: Get demux hardware handle, no descrambling channel is created.
Test method: Call the dmx_descrambler_disable function, and take invalid values for the input
Conformity result: The function returns non-zero. | +| 119 | | *dmx_descrambler_enable() | Conformity requirement 1:
Precondition: The demux hardware handle has been obtained and a descrambling channel has been created.
Test method: Call the dmx_descrambler_enable function and input valid parameters.
Conformity result: The function call is successful and returns 0, enables the specified descrambling channel.
Conformity requirement 2:
Precondition: Get demux hardware handle, no descrambling channel is created.
Test method: Call the dmx_descrambler_enable function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 120 | | *dmx_descrambler_get_associate_info() | Conformity requirement 1:
Precondition: The demux hardware handle has been obtained and a descrambling channel has been created.
Test method: Call the dmx_descrambler_get_associate_info function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the channel information associated with the descrambling channel.
Conformity requirement 2:
Precondition: Get demux hardware handle, no descrambling channel is created.
Test method: Call the dmx_descrambler_get_associate_info function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 121 | | *dmx_descrambler_open() | Conformity requirement 1:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_descrambler_open function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the descrambling channel handle.
Conformity requirement 2:
Precondition: Get demux hardware handle, no descrambling channel is created. | + +| Serial No. | Module | API | Process description | +|------------|--------|--------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Test method: Call the dmx_descrambler_open function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 122 | | *dmx_descrambler_open_ex() | Conformity requirement 1:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_descrambler_open_ex function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the descrambling channel handle.
Conformity requirement 2:
Precondition: Get demux hardware handle, no descrambling channel is created.
Test method: Call the dmx_descrambler_open_ex function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 123 | | *dmx_descrambler_set_even_iv() | Conformity requirement 1:
Precondition: The demux hardware handle has been obtained and a descrambling channel has been created.
Test method: Call the dmx_descrambler_set_even_iv function and input valid parameters.
Conformity result: The function call is successful, returns 0, and sets the initial vector corresponding to the even key to the descrambling channel.
Conformity requirement 2:
Precondition: Get demux hardware handle, no descrambling channel is created.
Test method: Call the dmx_descrambler_set_even_iv function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 124 | | *dmx_descrambler_set_even_key()
( | Conformity requirement 1:
Precondition: The demux hardware handle has been obtained and a descrambling channel has been created.
Test method: Call the dmx_descrambler_set_even_key function and input valid parameters.
Conformity result: The function call is successful, and returns 0, and the even key is | + +| Serial No. | Module | API | Process description | +|------------|--------|-------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | set.
Conformity requirement 2:
Precondition: Get demux hardware handle, no descrambling channel is created.
Test method: Call the dmx_descrambler_set_even_key function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 125 | | *dmx_descrambler_set_odd_iv() | Conformity requirement 1:
Precondition: The demux hardware handle has been obtained and a descrambling channel has been created.
Test method: Call the dmx_descrambler_set_odd_iv function and input valid parameters.
Conformity result: The function call is successful, returns 0, and sets the initial vector corresponding to the odd key to the descrambling channel.
Conformity requirement 2:
Precondition: Get demux hardware handle, no descrambling channel is created.
Test method: Call the dmx_descrambler_set_odd_iv function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 126 | | *dmx_descrambler_set_odd_key()
) | Conformity requirement 1:
Precondition: The demux hardware handle has been obtained and a descrambling channel has been created.
Test method: Call the dmx_descrambler_set_odd_key function and input valid parameters.
Conformity result: The function call is successful, returns 0, and sets an odd key to the descrambling channel.
Conformity requirement 2:
Precondition: Get demux hardware handle, no descrambling channel is created.
Test method: Call the dmx_descrambler_set_odd_key function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 127 | | *dmx_disconnect() | Conformity requirement 1:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_disconnect function | + +| Serial No. | Module | API | Process description | +|------------|--------|--------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
and input valid parameters.
Conformity result: The function call is successful, and returns 0, and the connection between the demux hardware and the data source is disconnected.
Conformity requirement 2:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_disconnect function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 128 | | *dmx_get_capability() |Conformity requirement 1:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_get_capability function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the hardware capability of demux.
Conformity requirement 2:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_get_capability function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 129 | | *dmx_get_descrambler_attribute() |
Conformity requirement 1:
Precondition: The demux hardware handle has been obtained, and the descrambling channel has been created.
Test method: Call the dmx_get_descrambler_attribute function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the properties of the descrambler.
Conformity requirement 2:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_get_descrambler_attribute function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| + +| Serial No. | Module | API | Process description | +|------------|--------|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 130 | | *dmx_get_source_params() |Conformity requirement 1:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_get_source_params function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the data source type of the demux hardware handle.
Conformity requirement 2:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_get_source_params function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_get_status function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the resource status of demux.
Conformity requirement 2:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_get_status function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_init function and input valid parameters.
Conformity result: The function call is successful and returns 0, completes the demux hardware initialization.
Conformity requirement 2:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_init function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The demux hardware handle has been obtained and the PCR channel has been created.
Test method: Call the dmx_pcr_close function and input valid parameters.
Conformity result: The function call is successful, and returns 0, and the PCR channel is closed.
Conformity requirement 2:
Precondition: Get demux hardware handle, PCR channel is not created.
Test method: Call the dmx_pcr_close function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The demux hardware handle has been obtained and the PCR channel has been created.
Test method: Call the dmx_pcr_get function and input valid parameters.
Conformity result: The function call is successful and returns 0.
Conformity requirement 2:
Precondition: Get demux hardware handle, PCR channel is not created.
Test method: Call the dmx_pcr_get function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_pcr_open function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the value of PCR.
Conformity requirement 2:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_pcr_open function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_reconnect function and input valid parameters.
Conformity result: The function call is successful, and returns 0, and the connection between demux and the data source is resumed.
Conformity requirement 2:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_reconnect function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The demux hardware handle has been obtained, and the descrambling channel has been created.
Test method: Call the dmx_set_descrambler_attribute function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the properties of the descrambling channel.
Conformity requirement 2:
Precondition: The demux hardware handle has been obtained, and the descrambling channel has not been created.
Test method: Call the dmx_set_descrambler_attribute function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_set_source_params function and input valid parameters.
Conformity result: The function call is successful and returns 0. Set the data source for demux.
Conformity requirement 2:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_set_source_params function, and take invalid values for the input parameters.
Conformity result: The function returns non-
Conformity requirement 1:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_term function and input valid parameters.
Conformity result: The function call is successful, and returns 0, terminates the demux module, and dmx_init() needs to be called again before it can be resumed to use.
Conformity requirement 2:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_term function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_tsbuff_create function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output channel returns a handle to a TS channel.
Conformity requirement 2:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_tsbuff_create function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: Get demux hardware handle, TS channel is created.
Test method: Call the dmx_tsbuff_destroy function and input valid parameters.
Conformity result: The function call is successful, and returns 0, and a TS channel handle is destroyed.
Conformity requirement 2:
Precondition: Get demux hardware handle, TS channel is not created.
Test method: Call the dmx_tsbuff_destroy function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: Get demux hardware handle, TS channel is created.
Test method: Call the dmx_tsbuff_get function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns a TS data.
Conformity requirement 2:
Precondition: Get demux hardware handle, TS channel not created.
Test method: Call the dmx_tsbuff_get function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: Get demux hardware handle, TS channel is created.
Test method: Call the dmx_tsbuff_put function and input valid parameters.
Conformity result: The function call is successful, returns 0, and returns a TS data to the TS channel.
Conformity requirement 2:
Precondition: Get demux hardware handle, TS channel not created.
Test method: Call the dmx_tsbuff_put function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_get_streampath_param function and input valid parameters.
Conformity result: The function call is successful, returns 0, and returns the channel information corresponding to the stream.
Conformity requirement 2:
Precondition: The demux hardware handle has been obtained.
Test method: Call the dmx_get_streampath_param function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Precondition: The tested system has Front hardware and has obtained the Front hardware handle.
Test method: Call the frontend_close function and input valid parameters.
Conformity result: Function call succeeds, and returns 0 | +| 146 | | frontend_open() | Conformity requirement 1:
Precondition: The tested system has Front hardware.
Test method: Call the frontend_open function and input valid parameters.
Conformity result: The function call is successful, returns 0 and the hardware handle of the Front.
Conformity requirement 2:
Precondition: None.
Test method: Call the frontend_open function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 147 | | *frontend_abort() | Conformity requirement 1:
Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the frontend_abort function and input valid parameters.
Conformity result: The function call is successful, returns 0, and terminates a series of operations on the Front hardware, such as Tuner frequency locking.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the frontend_abort function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 148 | | *frontend_atv_fineTune() | Conformity requirement 1:
Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the frontend_atv_fineTune function and input valid parameters.
Conformity result: The function call is successful, returns 0, and adjusts the frequency of the Tuner.
Conformity requirement 2: | + +| Serial No. | Module | API | Process description | +|------------|----------|----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Frontend | |
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the frontend_atv_fineTune function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 149 | |*frontend_atv_get_lock_status() | Conformity requirement 1:
Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the frontend_atv_get_lock_status function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the frequency locking situation of the Tuner.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the frontend_atv_get_lock_status function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 150 | |*frontend_close() | Conformity requirement 1:
Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the frontend_close function and input valid parameters.
Conformity result: The function call is successful, returns 0, and closes an instance of Front.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the frontend_close function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
| +| 151 | |*frontend_config_callback() | Conformity requirement 1:
Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the frontend_config_callback
Conformity result: The function call is successful and returns 0. Configure the callback function for the Front instance.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the frontend_config_callback function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 152 | | *frontend_config_channel() | Conformity requirement 1:
Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the frontend_config_channel function and input valid parameters.
Conformity result: The function call is successful and returns 0. Configure the properties of the Front.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the frontend_config_channel function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 153 | | *frontend_get_atvsignalinfo() | Conformity requirement 1:
Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the frontend_get_atvsignalinfo function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns signal information.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the frontend_get_atvsignalinfo function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | + +| Serial No. | Module | API | Process description | +|------------|----------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 154 | Frontend | *frontend_get_bert() |
Conformity requirement 1:
Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the frontend_get_bert function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the error rate.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the frontend_get_bert function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the frontend_get_capability function and input valid parameters.
Conformity result: The function call succeeds, returns 0, and the output parameter returns Frontend's capabilities.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the frontend_get_capability function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the frontend_get_channel_info function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the channel capability of Front.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
frontend_get_channel_info function, and take invalid values for the input parameters.Conformity result: The function returns non-zero. | +| 157 | |
*frontend_get_channel_num() | Conformity requirement 1:Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the
frontend_get_channel_num function and input valid parameters.Conformity result: The function call is successful, returns 0, and the output parameter returns the number of channels supported by the Front.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the
frontend_get_channel_num function, and take invalid values for the input parameters.Conformity result: The function returns non-zero. | +| 158 | |
*frontend_get_connect_status() | Conformity requirement 1:Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the
frontend_get_connect_status function and input valid parameters.Conformity result: The function call is successful, returns 0, and the output parameter returns the frequency lock information.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the
frontend_get_connect_status function, and take invalid values for the input parameters.Conformity result: The function returns non-zero. | +| 159 | |
*frontend_get_info() | Conformity requirement 1:Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the
frontend_get_info function and input valid parameters. |
+
+| Serial No. | Module | API | Process description |
+|------------|----------|---------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| | Frontend | | Conformity result: The function call is successful, returns 0, and the output parameter returns information from Front.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the frontend_get_info function and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
*frontend_get_lnb_pwr_status() | Conformity requirement 1:
Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the frontend_get_lnb_pwr_status function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the power supply status of the high-frequency head.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the frontend_get_lnb_pwr_status function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
*frontend_get_scan_info() | Conformity requirement 1:
Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the frontend_get_scan_info function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the current scanned state.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the frontend_get_scan_info function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the frontend_get_signal_quality function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the current signal quality.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the frontend_get_signal_quality function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the frontend_get_signal_strength function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the current signal strength.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the frontend_get_signal_strength function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: Get Front hardware handle.
Test method: Call the frontend_init function and input valid parameters.
Conformity result: The function call is successful and returns 0, completes the initialization of the Front hardware.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the frontend_init function and
Conformity result: The function returns non-zero. | +| 166 | | *frontend_lock() | Conformity requirement 1:
Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the frontend_lock function and input valid parameters.
Conformity result: The function call is successful, returns 0, and frequency locking is completed.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the frontend_lock function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 167 | | *frontend_open() | Conformity requirement 1:
Precondition: Get Front hardware handle.
Test method: Call the frontend_open function and input valid parameters.
Conformity result: The function call is successful, returns 0, and the output parameter returns the created Front instance.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the frontend_open function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | + +| Serial No. | Module | API | Process description | +|------------|--------|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | frontend_register_callback function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 168 | | *frontend_sat_config_lnb() | Conformity requirement 1:
Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the frontend_sat_config_lnb function and input valid parameters.
Conformity result: The function call is successful, and returns 0, and the high-frequency header is set.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the frontend_sat_config_lnb function, and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 169 | | *frontend_start_scan() | Conformity requirement 1:
Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the frontend_start_scan function and input valid parameters.
Conformity result: The function call is successful, and returns 0, and scanning begins.
Conformity requirement 2:
Precondition: The Front hardware handle has been obtained, but no Front instance has been created.
Test method: Call the frontend_start_scan function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 170 | | *frontend_term() | Conformity requirement 1:
Precondition: The Front hardware handle has been obtained and a Front instance has been created.
Test method: Call the frontend_term function and input valid parameters.
Conformity result: The function call is successful, returns 0, and an instance of Front is destroyed.
Conformity requirement 2:
Precondition: The Front hardware handle has | + +| Serial No. | Module | API | Process description | +|------------|--------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | been obtained, but no Front instance has been created.
Test method: Call the frontend_term function and take invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 171 | System | system_close() | Conformity requirements:
Precondition: System_open has been called to open the system module.
Test method: Call the system_close function, and transfer the pstDevice parameter effectively.
Conformity result: The function returns a success of 0. | +| 172 | | system_open() | Conformity requirements:
Precondition: The system module is not opened by calling system open.
Test method: Call the system_open function, and both the pstModule and ppstDevice parameters are valid.
Conformity result: The function call is successful and returns 0. The output module handle is valid. | +| 173 | | *system_get_chip_id() | Conformity requirement 1:
Precondition: System_open has been called to open the system module. The system init function has been called to initialize the module.
Test method: Call the system_get_chip_id function, and the parameters pstDev/pstChipId are all valid.
Conformity result: The function call is successful and returns 0. The content of pstChipId is correct.
Conformity requirement 2:
Precondition: System_open has been called to open the system module. The system init function is not called to initialize the module.
Test method: Call the system_get_chip_id function, and the parameters pstDev/pstChipId are all valid.
Conformity result: The function call fails and returns ERROR_NOT_INITED. | +| 174 | | *system_init() | Compliance requirement 1:
Precondition: System_open has been called to open the system module.
Test method: Call the system_init function, and the parameters pstDev/pstInitParams are valid.
Compliance result: The function call is successful and returns 0.
Compliance requirement 2: | + +| Serial No. | Module | API | Process description | +|------------|--------|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | System | |
Prerequisite: System_open has been called to open the system module.
Test method: Call the system_init function twice, and the parameters pstDev/pstInitParams are both valid.
Compliance result: Both function calls are successful and return 0.
| +| 175 | | *system_switch_standby() |Conformity requirement 1:
Precondition: System_open has been called to open the system module. The system init function has been called to initialize the module.
Test method: Call the system_switch_standby function, and the parameters pstDev/pstPara/pstWakeupInfo are all valid.
Conformity result: The function call is successful and returns 0.
Conformity requirement 2:
Precondition: System_open has been called to open the system module. The system init function is not called to initialize the module.
Test method: Call the system_switch_standby function, and the parameters pstDev/pstPara/pstWakeupInfo are all valid.
Conformity result: The function call fails and returns ERROR_NOT_INITED.
Conformity requirement 3:
Precondition: System_open has been called to open the system module. The system init function has been called to initialize the module.
Test method: Call the system_switch_standby function, with valid parameters pstDev/pstWakeupInfo and a null parameter pstPara.
Conformity result: The Function call fails, and returns ERROR_INVALID_PARAM.
Conformity requirement 4:
Precondition: System_open has been called to open the system module. The system init function has been called to initialize the module.
Test method: Call the system_switch_standby function, with valid parameters pstDev/pstPara and a null parameter pstWakeupInfo.
Conformity result: The Function call fails, and returns ERROR_INVALID_PARAM.
| +| 176 | | *system_sys_halt() |Conformity requirement 1:
Precondition: System_open has been called to open the system module. The system init function has been called to initialize the module.
Test method: Call the system_sys_halt function, the parameter pstDev is valid, and the parameter
| + +| Serial No. | Module | API | Process description | +|------------|--------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | System | |u32TimeMs is 3000.
Conformity result: The function call is successful and returns 0. The system will automatically shut down after 3 seconds.
Conformity requirement 2:
Precondition: System_open has been called to open the system module. The system init function is not called to initialize the module.
Test method: Call the system_sys_halt function, the parameter pstDev is valid, and the parameter u32TimeMs is 3000.
Conformity result: The function call fails and returns ERROR_NOT_INITED.
| +| 177 | | *system_sys_reboot() |Conformity requirement 1:
Precondition: System_open has been called to open the system module. The system init function has been called to initialize the module.
Test method: Call the system_sys_reboot function, with valid parameter pstDev and parameter u32TimeMs of 3000.
Conformity result: The function call is successful and returns 0. The system will automatically restart after 3 seconds.
Conformity requirement 2:
Precondition: System_open has been called to open the system module. The system init function is not called to initialize the module.
Test method: Call the system_sys_reboot function, with valid parameter pstDev and parameter u32TimeMs of 3000.
Conformity result: The function call failed and returned ERROR_NOT_INITED.
| +| 178 | | *system_term() |Conformity requirement 1:
Precondition: System_open has been called to open the system module. The system init function has been called to initialize the module.
Test method: Call the system_term function, and the parameters pstDev/pstTermParams are both valid.
Conformity result: The function call is successful and returns 0.
Conformity requirement 2:
Precondition: System_open has been called to open the system module. The system init function has been called to initialize the module.
Test method: Call the system_term function, the parameter pstDev is valid, and the parameter pstTermParams is NULL.
Conformity result: The function call is successful and returns 0.
| + +| Serial No. | Module | API | Process description | +|------------|--------|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 179 | Vout | vout_close() |Conformity requirement 1:
Precondition: A video output hardware handle has been created.
Test method: Call the vout_close function and input valid parameters.
Conformity result: The function call is successful and returns 0. Close the video output hardware handle.
Conformity requirement 2:
Precondition: A video output hardware handle has been created.
Test method: Call the vout_close function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: The tested system has video output hardware.
Test method: Call the vout_open function and input valid parameters.
Conformity result: The function call is successful and returns 0. Output parameters return the hardware handle for video output.
Conformity requirement 2:
Precondition: None.
Test method: Call the vout_open function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_autodetect3dformat function and input valid parameters.
Conformity result: The function call is successful and returns 0. Set automatic video output to automatically detect 3D mode.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_autodetect3dformat function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_close_channel function and input valid parameters.
Conformity result: The function call is successful and returns 0. Close the specified video output channel.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_close_channel function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_display_get function and input valid parameters.
Conformity result: The function call is successful and returns 0. Output parameters to return video display parameters.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_display_get function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_display_set function and input valid parameters.
Conformity result: The function call is successful and returns 0. Set video display parameters.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_display_set function and select invalid values as input parameters.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_evt_config function and input valid parameters.
Conformity result: The function call is successful and returns 0. Configure parameters for video output events.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_evt_config function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_get_3dmode function and input valid parameters.
Conformity result: The function call is successful and returns 0. Output parameters to return the 3D mode of video output.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_get_3dmode function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_get_bg_color function and input valid parameters.
Conformity result: The function call is successful and returns 0. The output parameter returns the background color of the video output.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance
Test method: Call the vout_get_bg_color function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 188 | | *vout_get_capability() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_get_capability function and input valid parameters.
Conformity result: The function call is successful and returns 0. The ability to output parameters and return video output.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_get_capability function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 189 | | *vout_get_edid() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_get_edid function and input valid parameters.
Conformity result: The function call is successful and returns 0. The ability to output parameters and return Extended Display Identification Data (EDID).
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_get_edid function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 190 | | *vout_get_evt_config() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_get_evt_config function and input valid parameters.
Conformity result: The function call is successful and returns 0. Output parameters to | + +| Serial No. | Module | API | Process description | +|------------|--------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
return configuration information for event callbacks.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_get_evt_config function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
| +| 191 | | *vout_get_hdcp_status() |Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_get_hdcp_status function and input valid parameters.
Conformity result: The function call is successful and returns 0. Output parameters returns the status of HDCP.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_get_hdcp_status function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
| +| 192 | | *vout_init() |Conformity requirement 1:
Precondition: A video output hardware handle has been created.
Test method: Call the vout_init function and input valid parameters.
Conformity result: The function call is successful and returns 0. Complete the initialization of video output hardware.
Conformity requirement 2:
Precondition: A video output hardware handle has been created.
Test method: Call the vout_init function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
| +| 193 | | *vout_open_channel() |Conformity requirement 1:
Precondition: A video output hardware handle has been created.
Test method: Call the vout_open_channel function and input valid parameters.
Conformity result: The function call is
| + +| Serial No. | Module | API | Process description | +|------------|--------|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | successful and returns 0. The output parameter returns the handle of the video output window instance.Conformity requirement 2:
Precondition: A video output hardware handle has been created.
Test method: Call the vout_open_channel function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 194 | | *vout_outputchannel_mute() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_outputchannel_mute function and input valid parameters.
Conformity result: The function call is successful and returns 0. Close the corresponding window output.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_outputchannel_mute function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 195 | | *vout_outputchannel_unmute() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_outputchannel_unmute function and input valid parameters.
Conformity result: The function call is successful and returns 0. Resume the video output of the corresponding video window.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_outputchannel_unmute function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | + +| Serial No. | Module | API | Process description | +|------------|--------|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 196 | | *vout_set_3d_lr_switch() |
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_set_3d_lr_switch function and input valid parameters.
Conformity result: The function call is successful and returns 0. Set 3D to swap left and right.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_set_3d_lr_switch function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_set_3dmode function and input valid parameters.
Conformity result: The function call is successful and returns 0. Set the output mode for 3D.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_set_3dmode function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_set_bg_color function and input valid parameters.
Conformity result: The function call is successful and returns 0. Set the background color of the output window.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_set_bg_color
Conformity result: The function returns non-zero. | +| 199 | | *vout_set_hdcp_params() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_set_hdcp_params function and input valid parameters.
Conformity result: The function call is successful and returns 0. Set the parameters of HDCP.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_set_hdcp_params function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 200 | | *vout_term() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_term function and input valid parameters.
Conformity result: The function call is successful and returns 0. Destroy the corresponding video output window.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_term function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 201 | | *vout_vbi_cgms_start() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_vbi_cgms_start function and input valid parameters.
Conformity result: The function call is successful and returns 0. Start window copying.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance | + +| Serial No. | Module | API | Process description | +|------------|--------|--------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | has been created.
Test method: Call the vout_vbi_cgms_start function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 202 | | *vout_vbi_cgms_stop() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_vbi_cgms_stop function and input valid parameters.
Conformity result: The function call is successful and returns 0. Stop window copying.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_vbi_cgms_stop function and select invalid values for the input parameters.
Conformity result: The function returns non-zero. | +| 203 | | *vout_vbi_microvision_enable() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_vbi_microvision_enable function and input valid parameters.
Conformity result: The function call is successful and returns 0. Enable macrovision.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_vbi_microvision_enable function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 204 | | *vout_vbi_microvision_setup() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_vbi_microvision_setup function and input valid parameters.
Conformity result: The function call is successful and returns 0. Create macrovision. | + +| Serial No. | Module | API | Process description | +|------------|--------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 205 | | |
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_vbi_microvision_setup function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_attach_input function and input valid parameters.
Conformity result: The function call is successful and returns 0. Associate the video output window with the data source.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_attach_input function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_create function and input valid parameters.
Conformity result: The function call is successful and returns 0. Output parameters to return a handle to a real window.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_create function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_dequeue_frame function and input valid parameters.
Conformity result: The function call is successful and returns 0. Retrieve one frame of the video output window.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_dequeue_frame function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_destroy function and input valid parameters.
Conformity result: The function call is successful and returns 0. Destroy the corresponding video output window.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_destroy function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_detach_input function and input valid parameters.
Conformity result: The function call is successful and returns 0. The video output window is unbound from the input source.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance
Test method: Call the vout_window_detach_input function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 210 | | *vout_window_enable_filmmode(
) | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_enable_filmmode function and input valid parameters.
Conformity result: The function call is successful and returns 0. Turn movie mode on or off.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_enable_filmmode function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 211 | | *vout_window_enable_panorama()
() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_enable_panorama function and input valid parameters.
Conformity result: The function call is successful and returns 0. Enable or disable panoramic mode.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_enable_panorama function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 212 | | *vout_window_freeze() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_freeze function and input valid parameters. | + +| Serial No. | Module | API | Process description | +|------------|--------|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
Conformity result: The function call is successful and returns 0. Pause the video output of this window.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_freeze function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_get function and input valid parameters.
Conformity result: The function call is successful and returns 0. Output parameters to return the configuration parameters of the video window.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_get function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_get_input_rect function and input valid parameters.
Conformity result: The function call is successful and returns 0. Output parameters return the size of the video input window.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_get_input_rect function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_get_output_rect function and input valid parameters.
Conformity result: The function call is successful and returns 0. The output parameter returns the size of the video output window.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_get_output_rect function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_get_playinfo function and input valid parameters.
Conformity result: The function call is successful and returns 0. Output parameters return the delay information of video output.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_get_playinfo function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_get_status function and input valid parameters.
Conformity result: The function call is successful and returns 0. Output parameters return the status of the video output window.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance
Test method: Call the vout_window_get_status function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 218 | | *vout_window_get_virtual_size() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_get_virtual_size function and input valid parameters.
Conformity result: The function call is successful and returns 0. Output parameters return the size of the virtual output window for the video.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_get_virtual_size function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 219 | | *vout_window_mute() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_mute function and input valid parameters.
Conformity result: The function call is successful and returns 0. Pause video output.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_mute function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 220 | | *vout_window_queue_frame() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_queue_frame function and input valid parameters. | + +| Serial No. | Module | API | Process description | +|------------|--------|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
Conformity result: The function call is successful and returns 0. Send a frame to the video output window.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_queue_frame function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_reset function and input valid parameters.
Conformity result: The function call is successful and returns 0. Reset the video output window.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_reset function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_set function and input valid parameters.
Conformity result: The function call is successful and returns 0. Set the output parameters of the video output window.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_set function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_set_colortemperature function and input valid parameters.
Conformity result: The function call is successful and returns 0. Set the color temperature of the video output window.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_set_colortemperature function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_set_input_rect function and input valid parameters.
Conformity result: The function call is successful and returns 0. Set the input size for this video window.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_set_input_rect function and select invalid values as input parameters.
Conformity result: The function returns non-zero.
Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_set_mute_color function and input valid parameters.
Conformity result: The function call is successful and returns 0. Set the background color after the output window is closed.
Conformity requirement 2:
Precondition: A video output hardware handle
Test method: Call the vout_window_set_mute_color function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 226 | | *vout_window_set_output_rect() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_set_output_rect function and input valid parameters.
Conformity result: The function call is successful and returns 0. Set the output size of the video window.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_set_output_rect function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 227 | | *vout_window_set_zorder() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_set_zorder function and input valid parameters.
Conformity result: The function call is successful and returns 0. Complete the Z-order setting of the video output window.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_set_zorder function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 228 | | *vout_window_unfreeze() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_unfreeze function and input valid parameters. | + +| Serial No. | Module | API | Process description | +|------------|--------|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Conformity result: The function call is successful and returns 0. Resume video output.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_unfreeze function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 229 | | *vout_window_unmute() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_unmute function and input valid parameters.
Conformity result: The function call successfully returns 0. Open video output.
Conformity requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_unmute function and select invalid values as input parameters.
Conformity result: The function returns non-zero. | +| 230 | Vout | *vout_window_set_video_rect() | Compliance requirement 1:
Precondition: Video output hardware handle has been created, video output instance has been created.
Test method: Call the vout_window_set_video_rect function and input valid parameters.
Compliance result: The function call is successful and returns 0.
Compliance requirement 2:
Precondition: A video output hardware handle has been created, but no video output instance has been created.
Test method: Call the vout_window_set_video_rect function and select an invalid value as the input parameter.
Compliance result: The function returns non-zero. | +| 231 | | *vout_window_get_video_rect() | Conformity requirement 1:
Precondition: A video output hardware handle has been created, and a video output instance has been created. | + +| Serial No. | Module | API | Process description | +|------------|--------|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
Test method: Call the vout_window_get_video_rect function and input valid parameters.
Conformity result: The function call is successful and returns 0. Get the current correct video output rectangle parameters.
fuConformity requirement 2:
Precondition: A video output hardware handle has been created, and a video output instance has been created.
Test method: Call the vout_window_get_video_rect function and input invalid parameters.
Conformity result: The function call fails with a non-zero error code.
| + + + +# SERIES OF ITU-T RECOMMENDATIONS + +| | | +|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Series A | Organization of the work of ITU-T | +| Series D | Tariff and accounting principles and international telecommunication/ICT economic and policy issues | +| Series E | Overall network operation, telephone service, service operation and human factors | +| Series F | Non-telephone telecommunication services | +| Series G | Transmission systems and media, digital systems and networks | +| Series H | Audiovisual and multimedia systems | +| Series I | Integrated services digital network | +| Series J | Cable networks and transmission of television, sound programme and other multimedia signals | +| Series K | Protection against interference | +| Series L | Environment and ICTs, climate change, e-waste, energy efficiency; construction, installation and protection of cables and other elements of outside plant | +| Series M | Telecommunication management, including TMN and network maintenance | +| Series N | Maintenance: international sound programme and television transmission circuits | +| Series O | Specifications of measuring equipment | +| Series P | Telephone transmission quality, telephone installations, local line networks | +| Series Q | Switching and signalling, and associated measurements and tests | +| Series R | Telegraph transmission | +| Series S | Telegraph services terminal equipment | +| Series T | Terminals for telematic services | +| Series U | Telegraph switching | +| Series V | Data communication over the telephone network | +| Series X | Data networks, open system communications and security | +| Series Y | Global information infrastructure, Internet protocol aspects, next-generation networks, Internet of Things and smart cities | +| Series Z | Languages and general software aspects for telecommunication systems | \ No newline at end of file diff --git a/marked/J/T-REC-J.1210-201907-I_PDF-E/14a22f23ced8ba1d63ece69861dbaacc_img.jpg b/marked/J/T-REC-J.1210-201907-I_PDF-E/14a22f23ced8ba1d63ece69861dbaacc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..529e4f72f14cdf7f41f56cfbfb26655bf8181c59 --- /dev/null +++ b/marked/J/T-REC-J.1210-201907-I_PDF-E/14a22f23ced8ba1d63ece69861dbaacc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:abb9e3ec6dfc8364cedc39a68cf796e9d3ff5529c79a1811eedeb12c6d6e7583 +size 3787 diff --git a/marked/J/T-REC-J.1210-201907-I_PDF-E/7f17c430b9598e4d748a8041457810b3_img.jpg b/marked/J/T-REC-J.1210-201907-I_PDF-E/7f17c430b9598e4d748a8041457810b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7526fae17caec7a9cf4b40d98662006a13be67c7 --- /dev/null +++ b/marked/J/T-REC-J.1210-201907-I_PDF-E/7f17c430b9598e4d748a8041457810b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dbfe482a3705f3d3113b17ee484758e1a3ba606af91c1f1af093b96fe224bd23 +size 51308 diff --git a/marked/J/T-REC-J.1210-201907-I_PDF-E/ebff22fb5dd6f50a90e44dca0f82f285_img.jpg b/marked/J/T-REC-J.1210-201907-I_PDF-E/ebff22fb5dd6f50a90e44dca0f82f285_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a4228ff5a1185cb1cc15e8f13f9b6d90eed30ccb --- /dev/null +++ b/marked/J/T-REC-J.1210-201907-I_PDF-E/ebff22fb5dd6f50a90e44dca0f82f285_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:23d4046b37a7198ce1d9ea0edccedf49c6c9749ce25811cae53a05b2291ec1f4 +size 60759 diff --git a/marked/J/T-REC-J.1210-201907-I_PDF-E/raw.md b/marked/J/T-REC-J.1210-201907-I_PDF-E/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..bb77647359680d513593e244e5b1006db19b75ea --- /dev/null +++ b/marked/J/T-REC-J.1210-201907-I_PDF-E/raw.md @@ -0,0 +1,297 @@ + + +**ITU-T** + +TELECOMMUNICATION +STANDARDIZATION SECTOR +OF ITU + +**J.1210** + +(07/2019) + +SERIES J: CABLE NETWORKS AND TRANSMISSION +OF TELEVISION, SOUND PROGRAMME AND OTHER +MULTIMEDIA SIGNALS + +IP Video Broadcast + +--- + +**Requirements of IP video broadcast (IPVB) for +cable TV networks** + +Recommendation ITU-T J.1210 + + + +# Recommendation ITU-T J.1210 + +# Requirements of IP video broadcast (IPVB) for cable TV networks + +## Summary + +In recent years, IP-based video services have been developed rapidly in cable television (CATV) networks, especially the highly asymmetric IP-based services with large bandwidth, such as 4K, 8K and virtual reality (VR), whose single programme bandwidth might easily exceed 35 Mbps or even go up to 100 Mbps. This requires huge downlink bandwidth of transmission channels and poses challenges to the existing CATV technologies. For this scenario, it is necessary to propose a solution with lower cost and less complexity for meeting the bandwidth requirements of the current asymmetric IP-based video service. + +Recommendation ITU-T J.1210 specifies an IP video broadcast (IPVB) technology, which simply adds a one-way IP-based video broadcast system to the existing low-cost bidirectional CATV networks, including both hybrid fibre coax (HFC) and optical networks. The IPVB can greatly increase the bandwidth of downlink programs when using an optical network and at the same time, have the characteristics of low cost and low complexity. The IPVB in downlink transmits IP-based video streams through broadcast channels which are identified by multicast IP addresses and user datagram protocol (UDP) port numbers and broadcasts all the IP-based video streams through the CATV networks to all subscribers. By cooperating with the uplink channel provided by the existing bidirectional access networks, it is capable of providing varieties of IP-based high bitrate video services in CATV networks. + +## History + +| Edition | Recommendation | Approval | Study Group | Unique ID* | +|---------|----------------|------------|-------------|---------------------------------------------------------------------------| +| 1.0 | ITU-T J.1210 | 2019-07-29 | 9 | 11.1002/1000/13976 | + +## Keywords + +Broadcast, CATV, IP video broadcast, IPVB. + +--- + +\* To access the Recommendation, type the URLuimsbf | +| udp_port | 16 | uimsbf | +| } | | | +| } | | | + +The semantics of the fields in the udp\_service\_list\_descriptor are defined as follows: + +**descriptor\_tag:** The descriptor\_tag of udp\_service\_list\_descriptor shall be set to 0xAE. + +**descriptor\_length:** This is an 8-bit field, indicating the number of bytes from the byte immediately after the descriptor\_length field to the last byte of the descriptor. + +**transport\_stream\_id:** This 16-bit field uniquely identifies the TS stream where the announcement resides. + +**service\_id:** This 16-bit field uniquely identifies the service where the announcement resides. + +**udp\_ipaddress:** In IPv4, it is a 32-bit field that indicates the multicast IP destination address allocated to the current service; In IPv6, it is a 128-bit field that indicates the multicast IP destination address allocated to the current service. + +**udp\_port:** This 16-bit field indicates the UDP port number allocated to the current service. + +#### 8.6.3 udp\_specific\_list\_descriptor + +This is used for describing the IP address and UDP port number of specific TS packets, such as the main channels, the upgrading streams, global EPG, etc., as shown in Table 11. + +**Table 11 – udp\_specific\_list\_descriptor** + +| Syntax | bit(s) | Mnemonic symbol | +|---------------------------------|-----------------------|------------------| +| udp_specific_list_descriptor () | | | +| { | | | +| descriptor_tag | 8 | uimsbf | +| descriptor_length | 8 | uimsbf | +| for (i=0;i
uimsbf | +| udp_port | 16 | uimsbf | +| } | | | +| } | | | + +The semantics of the fields in the udp\_specific\_list\_descriptor are defined as follows: + +**descriptor\_tag:** This 8-bit field of udp\_specific\_list\_descriptor shall be set to 0xAF. + +**descriptor\_length:** This 8-bit field, indicates the length of udp\_specific\_list\_descriptor from the byte immediately after the descriptor\_length field to the end of the descriptor. + +**info\_type:** This is an 8-bit field. The values of info\_type are listed in Table 12. + +**data\_format:** This 8-bit field indicates the data format of the service type currently indicated in the info\_type field. The values are listed in Table 13. + +**udp\_ipaddress:** In IPv4, it is a 32-bit field that indicates the multicast IP destination address allocated to the current service; In IPv6, it is a 128-bit field that indicates the multicast IP destination address allocated to the current service. + +**udp\_port:** This 16-bit field indicates the UDP port number allocated to the current service. + +**Table 12 – Values of info\_type of different services** + +| Service | Value of info_type | Description | +|------------------------|--------------------|--------------------------------------------------------------------------------------------------| +| | 0x00~0x0F | Reserved | +| EPG | 0x10 | Unique identification of EPG | +| Advertisement | 0x11 | Unified identification of all picture advertising, including power on, handover, main menu, etc. | +| Government information | 0x12 | Unique identification of the government information service. | +| Stock | 0x13 | Unique identification of stock service | +| CAT/EMM | 0x14 | The EMM information of CA. | +| Upgrading stream | 0x15 | Upgrading stream channel | +| | 0x16~0xFE | Defined by users | +| | 0xFF | Reserved | + +**Table 13 – Values of data\_format** + +| Data format | Value | Description | +|--------------------|--------------|----------------------------| +| | 0x0 | Reserved | +| XML | 0x1 | The data is in XML format | +| HTML | 0x2 | The data is in HTML format | +| TS | 0x3 | The data is in TS format | + +#### 8.6.4 udp\_ts\_list\_descriptor + +The udp\_ts\_list\_descriptor describes the multicast IP addresses and port numbers of the audio/video (such as MPTS or SPTS) broadcast channels, as shown in Table 14. + +**Table 14 – udp\_ts\_list descriptor** + +| Syntax | Bit(s) | Mnemonic symbol | +|---------------------------|-----------------------|------------------------| +| udp_ts_list_descriptor () | | | +| { | | | +| descriptor_tag | 8 | uimsbf | +| descriptor_length | 8 | uimsbf | +| for (i=0;i
uimsbf | +| udp_port | 16 | uimsbf | +| } | | | +| } | | | + +The semantics of the fields in the udp\_ts\_list\_descriptor are defined as follows: + +**descriptor\_tag:** This 8-bit descriptor-tag of udp\_ts\_list\_descriptor shall be set to 0xAC. + +**descriptor\_length:** This 8-bit field, indicates the length of udp\_ts\_list\_descriptor from the byte immediately after the descriptor\_length field to the end of the descriptor. + +**transport\_stream\_id:** This 16-bit field uniquely identifies the TS stream where the announcement resides. + +**udp\_ipaddress:** In IPv4, it is a 32-bit field that indicates the multicast IP destination address allocated to the current service; in IPv6, it is a 128-bit field that indicates the multicast IP destination address allocated to the current service. + +**udp\_port:** This 16-bit field indicates the UDP port number allocated to the current service. + +## SERIES OF ITU-T RECOMMENDATIONS + +| | | +|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Series A | Organization of the work of ITU-T | +| Series D | Tariff and accounting principles and international telecommunication/ICT economic and policy issues | +| Series E | Overall network operation, telephone service, service operation and human factors | +| Series F | Non-telephone telecommunication services | +| Series G | Transmission systems and media, digital systems and networks | +| Series H | Audiovisual and multimedia systems | +| Series I | Integrated services digital network | +| Series J | Cable networks and transmission of television, sound programme and other multimedia signals | +| Series K | Protection against interference | +| Series L | Environment and ICTs, climate change, e-waste, energy efficiency; construction, installation and protection of cables and other elements of outside plant | +| Series M | Telecommunication management, including TMN and network maintenance | +| Series N | Maintenance: international sound programme and television transmission circuits | +| Series O | Specifications of measuring equipment | +| Series P | Telephone transmission quality, telephone installations, local line networks | +| Series Q | Switching and signalling, and associated measurements and tests | +| Series R | Telegraph transmission | +| Series S | Telegraph services terminal equipment | +| Series T | Terminals for telematic services | +| Series U | Telegraph switching | +| Series V | Data communication over the telephone network | +| Series X | Data networks, open system communications and security | +| Series Y | Global information infrastructure, Internet protocol aspects, next-generation networks, Internet of Things and smart cities | +| Series Z | Languages and general software aspects for telecommunication systems | \ No newline at end of file diff --git a/marked/J/T-REC-J.124-200403-I_PDF-E/15e4a144a88176b71ea3eff2722253b0_img.jpg b/marked/J/T-REC-J.124-200403-I_PDF-E/15e4a144a88176b71ea3eff2722253b0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a0b0d482bad1b14bc65912c1484b83fe7921ecd9 --- /dev/null +++ b/marked/J/T-REC-J.124-200403-I_PDF-E/15e4a144a88176b71ea3eff2722253b0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7957ed24964979aebf993525862dab4b3c279faeb420b5807fb1ecb7469b20fd +size 62108 diff --git a/marked/J/T-REC-J.124-200403-I_PDF-E/18442e4e239480f0c3c95b547aa8fde2_img.jpg b/marked/J/T-REC-J.124-200403-I_PDF-E/18442e4e239480f0c3c95b547aa8fde2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c9d6473731268d02c9b737f896a69f7edbb28088 --- /dev/null +++ b/marked/J/T-REC-J.124-200403-I_PDF-E/18442e4e239480f0c3c95b547aa8fde2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c66ecfe086cf1f00260f991b1b6c51d6739e382f733214ea83ff4f430a88c54c +size 5326 diff --git a/marked/J/T-REC-J.124-200403-I_PDF-E/2dfa6ac3edfe874f68aa0cbccaa42322_img.jpg b/marked/J/T-REC-J.124-200403-I_PDF-E/2dfa6ac3edfe874f68aa0cbccaa42322_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..939eb6a57fac47a375526475ba6c31bf67e08b30 --- /dev/null +++ b/marked/J/T-REC-J.124-200403-I_PDF-E/2dfa6ac3edfe874f68aa0cbccaa42322_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:52a289bbb49d106b16f646b5050f62e5c7cbe1bb201f8c767547c3039abbf359 +size 8245 diff --git a/marked/J/T-REC-J.124-200403-I_PDF-E/55136bc716146672fc680fa05989f1d2_img.jpg b/marked/J/T-REC-J.124-200403-I_PDF-E/55136bc716146672fc680fa05989f1d2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7833f9b1cb088a396909ec31f5098cb91c14d5b3 --- /dev/null +++ b/marked/J/T-REC-J.124-200403-I_PDF-E/55136bc716146672fc680fa05989f1d2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:799afd0abe9cf87d4e941724430d354c0d507a40845965c1d97f29b7ec43bbc1 +size 79994 diff --git a/marked/J/T-REC-J.124-200403-I_PDF-E/5e92d9e8e9ce204e405bff2367f88176_img.jpg b/marked/J/T-REC-J.124-200403-I_PDF-E/5e92d9e8e9ce204e405bff2367f88176_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..76401bf310e8fdbebabcdc6b07cec81c510d8815 --- /dev/null +++ b/marked/J/T-REC-J.124-200403-I_PDF-E/5e92d9e8e9ce204e405bff2367f88176_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7249ea1ffbac21f857f9891540f4d6195474802ac868440dea4ca31f785d2612 +size 5234 diff --git a/marked/J/T-REC-J.124-200403-I_PDF-E/805c475f0859e607af0530ba43194bf1_img.jpg b/marked/J/T-REC-J.124-200403-I_PDF-E/805c475f0859e607af0530ba43194bf1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..19b213bb723d1a47990a9a4a6b4aa3d4ebf426af --- /dev/null +++ b/marked/J/T-REC-J.124-200403-I_PDF-E/805c475f0859e607af0530ba43194bf1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1b34dd066f1c3115994ccaf1998ffc1d7c327967ee5f1e1288596e5a5ad3765c +size 71454 diff --git a/marked/J/T-REC-J.124-200403-I_PDF-E/dbe553cf16dd14073b89a8263a428664_img.jpg b/marked/J/T-REC-J.124-200403-I_PDF-E/dbe553cf16dd14073b89a8263a428664_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9c879afa49afb8c8decb04579155259a53d68e79 --- /dev/null +++ b/marked/J/T-REC-J.124-200403-I_PDF-E/dbe553cf16dd14073b89a8263a428664_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d7fac17488c3ac5238fdd4f7b3713c13d857a6865206a0be82aa0c93ed3010d9 +size 106384 diff --git a/marked/J/T-REC-J.124-200403-I_PDF-E/ebff22fb5dd6f50a90e44dca0f82f285_img.jpg b/marked/J/T-REC-J.124-200403-I_PDF-E/ebff22fb5dd6f50a90e44dca0f82f285_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3a9fe5e58fa9faae652570573ef79effac9cf59d --- /dev/null +++ b/marked/J/T-REC-J.124-200403-I_PDF-E/ebff22fb5dd6f50a90e44dca0f82f285_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c722c3cc23ec103657d49db2f3b8c74b4d041a7c540df595fa11d43b619f8dea +size 68241 diff --git a/marked/J/T-REC-J.124-200403-I_PDF-E/f14e75bd1c6e2f234db4775dbf0dbf1a_img.jpg b/marked/J/T-REC-J.124-200403-I_PDF-E/f14e75bd1c6e2f234db4775dbf0dbf1a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..01b666e14cc671dbd4fe8bedcb7746d8c4dc908a --- /dev/null +++ b/marked/J/T-REC-J.124-200403-I_PDF-E/f14e75bd1c6e2f234db4775dbf0dbf1a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:89a54cd7aad8ef60e20d7f56f7524327c1ad64be8b6bade654c924644c6d0b7a +size 4631 diff --git a/marked/J/T-REC-J.124-200403-I_PDF-E/ff7ce44f3fdd51bae7b231f34df07c6a_img.jpg b/marked/J/T-REC-J.124-200403-I_PDF-E/ff7ce44f3fdd51bae7b231f34df07c6a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..902126ceb827bee2c71a012cf92f44cf2218d676 --- /dev/null +++ b/marked/J/T-REC-J.124-200403-I_PDF-E/ff7ce44f3fdd51bae7b231f34df07c6a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ef85d52f9964c9b39289331305b3d2742215d174d45701533f9f437896fe05af +size 165690 diff --git a/marked/J/T-REC-J.124-200403-I_PDF-E/raw.md b/marked/J/T-REC-J.124-200403-I_PDF-E/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..2c5a73ff5fc9b1ff45c2a05f26eeb0b3222267ef --- /dev/null +++ b/marked/J/T-REC-J.124-200403-I_PDF-E/raw.md @@ -0,0 +1,1091 @@ + + + + +The logo of the International Telecommunication Union (ITU) features the letters 'ITU' in a bold, sans-serif font, superimposed on a stylized globe with intersecting lines. + +ITU logo + +INTERNATIONAL TELECOMMUNICATION UNION + +**ITU-T** + +TELECOMMUNICATION +STANDARDIZATION SECTOR +OF ITU + +**J.124** + +(03/2004) + +SERIES J: CABLE NETWORKS AND TRANSMISSION +OF TELEVISION, SOUND PROGRAMME AND OTHER +MULTIMEDIA SIGNALS + +Interactive systems for digital television distribution + +--- + +**Multiplexing format for multimedia webcasting +over TCP/IP networks** + +ITU-T Recommendation J.124 + +--- + + + +# **ITU-T Recommendation J.124** + +# **Multiplexing format for multimedia webcasting over TCP/IP networks** + +# **Summary** + +This Recommendation provides an extended multiplexing format based on ITU-T Rec. J.123, which is appropriate for audio and video transmission by download-based protocol over TCP/IP without any session control protocols between server and client, a.k.a. "Progressive Download". Fragmented structure is newly introduced into this Recommendation. In the fragment structure, media data is divided into media fragments, and a movie header is also divided into movie fragment headers according to the fragmented media data. Each movie fragment header corresponds to each media fragment, and these elements constitute a movie fragment. By adapting the fragment structure to long duration content, a huge header, which causes initial delay of the progressive streaming, can be avoided. In addition, formatted text information is stored in the media data so that these can be interleaved with one another in a file. This format also carries metadata, digital rights management (DRM) information as well as audio, video and text bitstreams. + +Examples of use of this Recommendation are given in Appendices I, II and III. + +## **Source** + +ITU-T Recommendation J.124 was approved on 15 March 2004 by ITU-T Study Group 9 (2001-2004) under the ITU-T Recommendation A.8 procedure. + +# FOREWORD + +The International Telecommunication Union (ITU) is the United Nations specialized agency in the field of telecommunications. The ITU Telecommunication Standardization Sector (ITU-T) is a permanent organ of ITU. ITU-T is responsible for studying technical, operating and tariff questions and issuing Recommendations on them with a view to standardizing telecommunications on a worldwide basis. + +The World Telecommunication Standardization Assembly (WTSA), which meets every four years, establishes the topics for study by the ITU-T study groups which, in turn, produce Recommendations on these topics. + +The approval of ITU-T Recommendations is covered by the procedure laid down in WTSA Resolution 1. + +In some areas of information technology which fall within ITU-T's purview, the necessary standards are prepared on a collaborative basis with ISO and IEC. + +## NOTE + +In this Recommendation, the expression "Administration" is used for conciseness to indicate both a telecommunication administration and a recognized operating agency. + +Compliance with this Recommendation is voluntary. However, the Recommendation may contain certain mandatory provisions (to ensure e.g. interoperability or applicability) and compliance with the Recommendation is achieved when all of these mandatory provisions are met. The words "shall" or some other obligatory language such as "must" and the negative equivalents are used to express requirements. The use of such words does not suggest that compliance with the Recommendation is required of any party. + +# INTELLECTUAL PROPERTY RIGHTS + +ITU draws attention to the possibility that the practice or implementation of this Recommendation may involve the use of a claimed Intellectual Property Right. ITU takes no position concerning the evidence, validity or applicability of claimed Intellectual Property Rights, whether asserted by ITU members or others outside of the Recommendation development process. + +As of the date of approval of this Recommendation, ITU had not received notice of intellectual property, protected by patents, which may be required to implement this Recommendation. However, implementors are cautioned that this may not represent the latest information and are therefore strongly urged to consult the TSB patent database. + +© ITU 2004 + +All rights reserved. No part of this publication may be reproduced, by any means whatsoever, without the prior written permission of ITU. + +# CONTENTS + +###### Page + +| | | | +|------|------------------------------------------------|----| +| 1 | Scope ..... | 1 | +| 2 | References..... | 1 | +| 2.1 | Normative references..... | 1 | +| 2.2 | Informative references..... | 1 | +| 2.3 | Bibliography ..... | 1 | +| 3 | Terms and definitions ..... | 2 | +| 4 | Abbreviations..... | 2 | +| 5 | Reference architecture ..... | 2 | +| 6 | Multiplexing format..... | 3 | +| 6.1 | Basic structure ..... | 3 | +| 6.2 | Object structure ..... | 3 | +| 6.3 | Box order ..... | 5 | +| 6.4 | Track structure..... | 6 | +| 6.5 | Media data structure ..... | 6 | +| 6.6 | Other descriptions..... | 6 | +| 7 | Box definitions ..... | 6 | +| 7.1 | File type box..... | 6 | +| 7.2 | Other boxes..... | 7 | +| 8 | Digital Rights Management (DRM) box ..... | 7 | +| 8.1 | Syntax ..... | 8 | +| 8.2 | Semantics..... | 8 | +| 9 | Timed text format ..... | 8 | +| 9.1 | Unicode support..... | 8 | +| 9.2 | Bytes, characters, and glyphs ..... | 9 | +| 9.3 | Character set support ..... | 9 | +| 9.4 | Font support..... | 9 | +| 9.5 | Fonts and metrics..... | 10 | +| 9.6 | Colour support ..... | 10 | +| 9.7 | Text rendering position and composition ..... | 10 | +| 9.8 | Marquee scrolling..... | 12 | +| 9.9 | Language ..... | 13 | +| 9.10 | Writing direction ..... | 13 | +| 9.11 | Text wrap..... | 14 | +| 9.12 | Highlighting, Closed Caption, and Karaoke..... | 14 | +| 9.13 | Media handler ..... | 14 | +| 9.14 | Media handler header ..... | 14 | +| 9.15 | Style record..... | 14 | +| 9.16 | Sample description format..... | 15 | + +| | Page | +|--------------------------------------------------------------------|-------------| +| 9.17 Sample format ..... | 16 | +| 9.18 Combinations of features..... | 20 | +| Appendix I – Application example: Typical VOD transmission..... | 21 | +| Appendix II – Application example: Random access transmission..... | 22 | +| Appendix III – Application example: Live video transmission..... | 23 | + +# Multiplexing format for multimedia webcasting over TCP/IP networks + +# 1 Scope + +This Recommendation defines a multiplexing format appropriate for progressive download, audio and video transmission by download-based protocol over TCP/IP. In contrast to ITU-T Rec. J.123, this Recommendation supports fragmented structure for long duration content. In addition, formatted text information is stored in the media data so that these can be interleaved with one another in a file. Using this format, webcasting of long duration content and live programs is realized. + +# 2 References + +The following ITU-T Recommendations and other references contain provisions which, through reference in this text, constitute provisions of this Recommendation. At the time of publication, the editions indicated were valid. All Recommendations and other references are subject to revision; users of this Recommendation are therefore encouraged to investigate the possibility of applying the most recent edition of the Recommendations and other references listed below. A list of the currently valid ITU-T Recommendations is regularly published. The reference to a document within this Recommendation does not give it, as a stand-alone document, the status of a Recommendation. + +## 2.1 Normative references + +- [1] ITU-T Recommendation J.123 (2002), *Multiplexing format for webcasting on TCP/IP network*. +- [2] ISO/IEC 14496-12:2004, *Information technology – Coding of audio-visual objects – Part 12: ISO base media file format*. +- [3] ISO/IEC 14496-14:2003, *Information technology – Coding of audio-visual objects – Part 14: MP4 file format*. + +## 2.2 Informative references + +- [4] ITU-T Recommendation J.120 (2000), *Distribution of sound and television programs over the IP network*. +- [5] ISO/IEC 14496-2:2001, *Information technology – Coding of audio-visual objects – Part 2: Visual*. +- [6] ISO/IEC 14496-3:2001, *Information technology – Coding of audio-visual objects – Part 3: Audio*. +- [7] IETF RFC 2068 (1997), *Hypertext Transfer Protocol – HTTP/1.1*. + +## 2.3 Bibliography + +- [8] 3GPP TS 26.245:2003, *Transparent end-to-end streaming service; Timed text format*. + +# 3 Terms and definitions + +This Recommendation defines the following terms: + +- 3.1 **box:** An object-oriented building block defined by a unique type identifier and length [2]. +- 3.2 **chunk:** A contiguous set of samples for one track. +- 3.3 **container box:** A box whose sole purpose is to contain and group a set of related boxes. +- 3.4 **movie box:** A container box whose sub-boxes define the metadata for a presentation ('moov'). +- 3.5 **media data box:** A container box which can hold the actual media data for a presentation ('mdat'). +- 3.6 **presentation:** One or more motion sequences, possibly combined with audio. +- 3.7 **progressive download:** Streaming by download-based protocol over TCP/IP without any session control protocols. Client can start playing the media before the full file is downloaded. +- 3.8 **sample:** An individual frame of video, or a time-contiguous compressed section of audio. +- 3.9 **sample description:** A structure which defines and describes the format of some number of samples in a track. +- 3.10 **sample table:** A packed directory for the timing and physical layout of the samples in a track. +- 3.11 **track:** A collection of related samples, which corresponds to a sequence of images or sampled audio. +- 3.12 **webcasting:** Webcasting is defined in ITU-T Rec. J.120, "*Distribution of sound and television programs over the IP network*". + +# 4 Abbreviations + +This Recommendation uses the following abbreviations: + +| | | +|--------|-------------------------------------------------| +| DRM | Digital Rights Management | +| HTTP | HyperText Transport Protocol | +| IP | Internet Protocol | +| MP4 | MPEG-4 File Format | +| SMIL | Synchronized Multimedia Integration Language | +| TCP | Transmission Control Protocol | +| UTF-8 | Unicode Transformation Format (the 8-bit form) | +| UTF-16 | Unicode Transformation Format (the 16-bit form) | +| UUID | Universal Unique Identifier | + +# 5 Reference architecture + +This Recommendation assumes that download-based protocol (e.g., HTTP) should be used for multimedia webcasting because it does not require any complex server-client protocols. + +The reference architecture for multimedia webcasting on TCP/IP is shown in Figure 5-1. + + + +Architecture of multimedia webcasting on TCP/IP networks. A Webcasting server (HTTP server) sends a 'Contents flow' over 'HTTP/TCP/IP' to the 'Internet'. From the Internet, the flow branches to a 'Mobile IP network' (serving two 'Mobile terminal' devices) and an 'IP network (ISP, CATV)'. The IP network connects to a 'Home network' containing a 'PDA', 'STB', and 'PC'. + +J.124\_F5-1 + +Figure 5-1/J.124 – Architecture of multimedia webcasting on TCP/IP networks + +# 6 Multiplexing format + +## 6.1 Basic structure + +The format is structurally based on the ISO base media file format defined in [2]. Basic structure of the format is shown in Figure 6-1, which consists of extension data, contents header and media data. + + + +One file or one sequence + +1st fragment + +2nd fragment + +Chunk: consists of several frames + +'mdat' Box (media data) + +'moov' Box (movie information) + +'uuid' Box (private data: DRM) + +'ftyp' Box + +V Video track +A Audio track +T Timed text track + +J.124\_F6-2 + +Basic structure of a file format. The diagram shows a sequence of 'fragments' (1st and 2nd) within 'One file or one sequence'. Each fragment contains alternating 'V' (Video track), 'A' (Audio track), and 'T' (Timed text track) units. Below the fragments, 'Boxes' are identified: 'ftyp' Box, 'uuid' Box (private data: DRM), 'moov' Box (movie information), 'mdat' Box (media data), and 'moof' Box (movie fragments). A 'Chunk' is defined as consisting of several frames. + +Figure 6-1/J.124 – Basic structure of a file format + +## 6.2 Object structure + +The file is structured as a sequence of objects called "Box"; some of these objects may contain other objects. The sequence of objects in the file shall contain exactly one presentation metadata wrapper + +(the movie box 'moov'). It should be close to the beginning of the file. The other objects found at this level may be file type box 'ftyp', 'uuid' box, movie fragments 'moof', and media data boxes 'mdat'. + +All boxes defined in this Recommendation are listed in Table 6-1, and are indicated by grey shading. + +**Table 6-1/J.124 – Box types and structure** + +| | | | | | | | +|------|------|------|------|------|------|---------------------------------------------------------------| +| ftyp | | | | | | file type and compatibility | +| uuid | | | | | | uuid box for DRM (see clause 8) | +| moov | | | | | | container for all the information | +| | mvhd | | | | | movie header, overall declarations | +| | trak | | | | | container for an individual track or stream | +| | | tkhd | | | | track header, overall information about the track | +| | | tref | | | | track reference container | +| | | edts | | | | edit list container | +| | | | elst | | | an edit list | +| | | mdia | | | | container for the media information in a track | +| | | | mdhd | | | media header, overall information about the media | +| | | | hdlr | | | handler, declares the media (handler) type | +| | | | minf | | | media information container | +| | | | | vmhd | | video media header, overall information | +| | | | | smhd | | sound media header, overall information | +| | | | | hmhd | | hint media header, overall information | +| | | | | nmhd | | null media header, overall information | +| | | | | dinf | | data information box, container | +| | | | | | dref | data reference box, declares source(s) of media data in track | +| | | | | stbl | | sample table box, container for the time/space map | +| | | | | | stsd | sample descriptions (codec types, initialization etc.) | +| | | | | | stts | (decoding) time-to-sample | +| | | | | | ctts | (composition) time to sample | +| | | | | | stsc | sample-to-chunk, partial data-offset information | +| | | | | | stsz | sample sizes (framing) | +| | | | | | stz2 | compact sample sizes (framing) | +| | | | | | stco | chunk offset, partial data-offset information | +| | | | | | co64 | 64-bit chunk offset | +| | | | | | stss | sync sample table (random access points) | +| | | | | | stsh | shadow sync sample table | +| | | | | | padb | sample padding bits | +| | | | | | stdp | sample degradation priority | +| | mvex | | | | | movie extends box | +| | | mehd | | | | movie extends header box | +| | | trex | | | | track extends defaults | + +**Table 6-1/J.124 – Box types and structure** + +| | | | | | +|------|------|------|--|-----------------------------------------| +| moof | | | | movie fragment | +| | mfhd | | | movie fragment header | +| | traf | | | track fragment | +| | | tfhd | | track fragment header | +| | | trun | | track fragment run | +| mfra | | | | movie fragment random access (optional) | +| | tfra | | | track fragment random access | +| | mfro | | | movie fragment random access offset | +| mdat | | | | media data container | +| free | | | | free space | +| skip | | | | free space | +| | udta | | | user-data | +| | | cprt | | copyright, etc. | + +## 6.3 Box order + +This Recommendation defines box order as follows. Only the top-level boxes are indicated. + +### 6.3.1 Non-fragmented structure + +As shown in Figure 6-2, the boxes are transmitted or stored from left to right order. Exactly one file type box ('ftyp'), exactly one DRM UUID box ('uuid'), exactly one movie box ('moov') and exactly one media data box ('mdat') shall exist in the format. Other boxes not defined in this Recommendation may occur and decoders shall skip and ignore any unrecognized box. + + + +| | | | | +|------|-----------|------|------| +| ftyp | DRM(uuid) | moov | mdat | +|------|-----------|------|------| + +**Figure 6-2/J.124 – Non-fragmented structure** + +### 6.3.2 Fragmented structure + +Fragmented structure should be used for long duration content. The first fragment is the same as that of non-fragmented structure as shown in Figure 6-3. + + + +| | | | | +|------|-----------|------|------| +| ftyp | DRM(uuid) | moov | mdat | +|------|-----------|------|------| + +**Figure 6-3/J.124 – The first fragment** + +For the second and subsequent fragments, each fragment shall consist of exactly one movie fragment box ('moof') and exactly one media data box ('mdat'). The fragments shall be in sequence order as shown in Figure 6-4. + + + +| | | | | | +|------|------|-------|------|------| +| moof | mdat | ..... | moof | mdat | +|------|------|-------|------|------| + +**Figure 6-4/J.124 – The second fragment and subsequent fragments** + +## 6.4 Track structure + +This Recommendation defines the following track structure. + +- One video track; +- One audio track; +- One video track and one audio track; +- One video track and one text track; +- One audio track and one text track; +- One video track, one audio track and one text track. + +The maximum number of tracks shall be one for video, one for audio and one for text. Moreover, at least one video or one audio track shall exist. + +The maximum number of sample entries shall be one per track for video and audio, but unrestricted for text. + +## 6.5 Media data structure + +If the media data contains multiple tracks, it shall be interleaved inside the format as chunks. + +- The interleaving order shall correspond to the track storing order. +- Chunks corresponding to the track shall be in time order. +- One second interleaving length is recommended, and it shall be less than five seconds. + +## 6.6 Other descriptions + +This Recommendation applies the following descriptions to ISO base media file format [2]. + +- The fields in the objects are stored with the most significant byte first, commonly known as network byte order or big-endian format. +- There shall be no references to external media outside the format, i.e., a data shall be self-contained. +- Hint tracks are a mechanism that a server implementation may choose to use in preparation for the streaming of media content. However, it should be noted that the usage of hint tracks is an internal implementation matter for the server, and it falls outside the scope of this Recommendation. +- All index numbers used in the format start with the value one rather than zero, in particular, "first-chunk" in sample-to-chunk box, "sample-number" in sync sample box and "shadowed-sample-number", "sync-sample-number" in shadow sync sample box. +- For the storage of ISO/IEC MPEG-4 media-specific information, this Recommendation refers to MP4 file format [3], which is also based on the ISO base media file format [2]. However, tracks relative to MPEG-4 system architectural elements (e.g., BIFS, OD) are optional in this Recommendation and shall be ignored. The inclusion of MPEG-4 media does not imply the usage of MPEG-4 systems architecture. The decoder is not required to implement any of the specific MPEG-4 system architectural elements. + +# 7 Box definitions + +## 7.1 File type box + +### 7.1.1 Definition + +Box type: 'ftyp' + +Container: File + +Mandatory: Yes + +Quantity: Exactly one + +A media-file structured to this part of this specification may be compatible with more than one detailed specification, and it is, therefore, not always possible to speak of a single 'type' or 'brand' for the file. This means that the utility of the file name extension and mime type are somewhat reduced. + +This box must be placed as early as possible in the file (e.g., after any obligatory signature, but before any significant variable-size boxes such as the UUID box, movie box or media data box). It identifies which specification is the 'best use' of the file, and a minor version of that specification, and also a set of other specifications to which the file complies. Readers implementing this format should attempt to read files which are marked as compatible with any of the specifications which the reader implements. Any incompatible change in a specification should, therefore, register a new 'brand' identifier to identify files conformant to the new specification. + +The type 'sg92' is defined in this clause as identifying files which conform to the format in this Recommendation. More specific identifiers can be used to identify precise versions of specifications providing more detail. + +Files would normally be externally identified (e.g., with a file extension or mime type) that identifies the 'best use' (major brand), or the brand that the author believes will provide the greatest compatibility. + +### 7.1.2 Syntax + +``` +aligned(8) class FileTypeBox + extends Box('ftyp') { + unsigned int(32) major-brand; + unsigned int(32) minor-version; + unsigned int(32) compatible-brands[]; // to end of the box + } +``` + +### 7.1.3 Semantics + +This box identifies the specifications to which this file complies. + +Each brand is a printable four-character code that identifies a precise specification. Only one brand is defined here: 'sg92', identifies files structurally conformant to this media-independent part of this specification. + +major-brand – is a brand identifier; + +minor-version – is an informative integer for the minor version of the major brand; + +compatible-brands – is a list, to the end of the box, of brands. + +## 7.2 Other boxes + +Definitions of all other boxes are found in the reference [2]. + +# 8 Digital Rights Management (DRM) box + +DRM information is formatted in 'uuid' box. Functions for DRM are described as follows: + +- Copy prohibition; +- Expiration date; +- Validation period after downloading; +- Number of times play. + +Rights management information controls play and/or retransmission of the downloaded file. It is contained in 'uuid' box of this format. + +## 8.1 Syntax + +``` +aligned(8) class CopyGuardBox extends FullBox ('uuid', version = 0, flags){ + bit(32) copy-guard; + unsigned int(32) limit-date; + unsigned int(32) limit-period; + unsigned int(32) limit-count; +} +``` + +## 8.2 Semantics + +| Field | Type | Description | Parameters | +|--------------|-----------|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| type | uint32 | Type of box | 'uuid' is set | +| usertype | uint8[16] | ID | "cpgd"-A88C-11d4-8197-09027087703 | +| version | uint8 | Version | 0 is set | +| flags | bit24 | Management flags | 0: No limitation
1: Limitation by expiration date
2: Limitation by validated period
4: Limitation by playing number of times
Except in the case of No limitation, the following "never copy" flag shall be set to '1' | +| copy-guard | uint32 | Copy prohibition | 0: copy permitted
otherwise: copy prohibited | +| limit-date | uint32 | Expiration date | Specify the expiration date in seconds from 1904/1/1 0:00 GMT | +| limit-period | uint32 | Validated period | Specify the validated period in days after the file is downloaded | +| limit-count | uint32 | Playing number of times | '1' means that the file can be played only once | + +# 9 Timed text format + +This clause defines the format of timed text. All the text in this clause is incorporated from 3GPP Technical Specification, 3GPP TS 26.245 V0.1.7 (2003-11-25) Clause 5, Timed text format [8]. + +Operators may specify additional rules and restrictions when deploying terminals, in addition to this specification, and behaviour that is optional here may be mandatory for particular deployments. In particular, the required character set is almost certainly dependent on the geography of the deployment. + +## 9.1 Unicode support + +Text in this specification uses the Unicode 3.0 standard. Terminals shall correctly decode both UTF-8 and UTF-16 into the required characters. If a terminal receives a Unicode code, which it cannot display, it shall display a predictable result. It shall not treat multi-byte UTF-8 characters as a series of ASCII characters, for example. + +Authors should create fully-composed Unicode; terminals are not required to handle decomposed sequences for which there is a fully-composed equivalent. + +Terminals shall conform to the conformance statement in Unicode 3.0 section 3.1. + +Text strings for display and font names are uniformly coded in UTF-8, or start with a UTF-16 byte-order mark (`\uFEFF`) and by that, indicate that the string which starts with the byte-order mark is in UTF-16. Terminals shall recognize the byte-order mark in this byte order; they are not required to recognize byte-reversed UTF-16, indicated by a byte-reversed byte-order mark. + +## 9.2 Bytes, characters, and glyphs + +This clause uses these terms judiciously. Since multi-byte characters are permitted (i.e., 16-bit Unicode characters), the number of characters in a string may not be the number of bytes. Also, a byte-order-mark is not a character at all, though it occupies two bytes. So, for example, storage lengths are specified as byte-counts, whereas highlighting is specified using character offsets. + +It should also be noted that in some writing systems, the number of glyphs rendered might be different again. For example, in English, the characters 'fi' are sometimes rendered as a single ligature glyph. + +In this specification, the first character is at offset 0 in the string. In records specifying both a start and end offset, the end offset shall be greater than or equal to the start offset. In cases where several offset specifications occur in sequence, the start offset of an element shall be greater than or equal to the end offset of the preceding element. + +## 9.3 Character set support + +All terminals shall be able to render Unicode characters in these ranges: + +- a) basic ASCII and Latin-1 (`\u0000` to `\u00FF`), though not all the control characters in this range are needed; +- b) the Euro currency symbol (`\u20AC`); +- c) telephone and ballot symbols (`\u260E` through `\u2612`). + +Support for the following characters is recommended but not required: + +- a) miscellaneous technical symbols (`\u2300` through `\u2335`); +- b) 'Zapf Dingbats': locations `\u2700` through `\u27AF`, and the locations where some symbols have been relocated (e.g., `\u2605`, Black star). + +The private use characters `\u0091` and `\u0092`, and the initial range of the private use area `\uE000` through `\uE0FF` are reserved in this specification. For these Unicode values, and for control characters for which there is no defined graphical behaviour, the terminal shall not display any result: neither a glyph is shown nor is the current rendering position changed. + +## 9.4 Font support + +Fonts are specified in this specification by name, size, and style. There are three special names which shall be recognized by the terminal: Serif, Sans-Serif, and Monospace. It is strongly recommended that these be different fonts for the required characters from ASCII and Latin-1. For many other characters, the terminal may have a limited set or only a single font. Terminals requested to render a character where the selected font does not support that character should substitute a suitable font. This ensures that languages with only one font (e.g., Asian languages), or symbols for which there is only one form, are rendered. + +Fonts are requested by name, in an ordered list. Authors should normally specify one of the special names last in the list. + +Terminals shall support a pixel size of 12 (on a 72 dpi display, this would be a point size of 12). If a size is requested other than the size(s) supported by the terminal, the next smaller supported size + +should be used. If the requested size is smaller than the smallest supported size, the terminal should use the smallest supported size. + +Terminals shall support unstyled text for those characters it supports. It may also support bold, italic (oblique) and bold-italic. If a style is requested which the terminal does not support, it should substitute a supported style; a character shall be rendered if the terminal has that character in any style of any font. + +## 9.5 Fonts and metrics + +Within the sample description, a complete list of the fonts used in the samples is found. This enables the terminal to preload them, or to decide on font substitution. + +Terminals may use varying versions of the same font. For example, here is the same text rendered on two systems; it was authored on the first, where it just fitted into the text box. + +### Example: + +| | +|-----------------------------------------------------| +| This is a string which is rendered to the terminal. | +| This is a string which is rendered to the termin | + +Authors should be aware of this possible variation, and provide text box areas with some 'slack' to allow for rendering variations. + +## 9.6 Colour support + +The colour of both text and background are indicated in this specification using RGB values. Terminals are not required to be able to display all colours in the RGB space. Terminals with a limited colour display, with only gray-scale display, and with only black-and-white are permissible. If a terminal has a limited colour capability it should substitute a suitable colour; dithering of text may be used but is not usually appropriate as it results in "fuzzy" display. If colour substitution is performed, the substitution shall be consistent: the same RGB colour shall result consistently in the same displayed colour. If the same colour is chosen for background and text, then the text shall be invisible (unless a style, such as highlight, changes its colour). If different colours are specified for the background and text, the terminal shall map these to different colours so that the text is visible. + +Colours in this specification also have an alpha or transparency value. In this specification, a transparency value of 0 indicates a fully transparent colour, and a value of 255 indicates fully opaque. Support for partial or full transparency is optional. 'Keying' text (text rendered on a transparent background) is done by using a background colour which is fully transparent. 'Keying' text over video or pictures, and support for transparency in general, can be complex and may require double-buffering, and its support is optional in the terminal. Content authors should beware that if they specify a colour which is not fully opaque, and the content is played on a terminal not supporting it, the affected area (the entire text box for a background colour) will be fully opaque and will obscure visual material behind it. Visual material with transparency is layered closer to the viewer than the material which it partially obscures. + +## 9.7 Text rendering position and composition + +Text is rendered within a region (a concept derived from SMIL). There is a text box set within that region. This permits the terminal to position the text within the overall presentation, and also to render the text appropriately given the writing direction. For text written left to right, for example, the first character would be rendered at, or near, the left edge of the box, and with its baseline down from the top of the box by one baseline height (a value derived from the font and font size chosen). Similar considerations apply to the other writing directions. + +Within the region, text is rendered within a text box. There is a default text box set, which can be overridden by a sample. + +Either the text box or text region is filled with the background colour; after that, the text is painted in the text colour. If highlighting is requested, one or both of these colours may vary. + +Terminals may choose to anti-alias their text, or not. + +The text region and layering are defined using structures from the ISO base media file format. + +This track header box is used for text track: + +``` +aligned(8) class TrackHeaderBox + extends FullBox('tkhd', version, flags){ + if (version==1) { + unsigned int(64) creation_time; + unsigned int(64) modification_time; + unsigned int(32) track_ID; + const unsigned int(32) reserved = 0; + unsigned int(64) duration; + } else { // version==0 + unsigned int(32) creation_time; + unsigned int(32) modification_time; + unsigned int(32) track_ID; + const unsigned int(32) reserved = 0; + unsigned int(32) duration; + } + const unsigned int(32) [2] reserved = 0; + int(16) layer; + template int(16) alternate_group = 0; + template int(16) volume = 0; + const unsigned int(16) reserved = 0; + template int(32) [9] matrix= + { 0x00010000,0,0,0,0x00010000,0,tx,ty,0x40000000 }; + // unity matrix + unsigned int(32) width; + unsigned int(32) height; + } +} +``` + +Visually composed tracks, including video and text, are layered using the 'layer' value. This compares, for example, to z-index in SMIL. More negative layer values are towards the viewer. (This definition is compatible with that in ISO/MJ2.) + +The region is defined by the track width and height, and translation offset. This corresponds to the SMIL region. The width and height are stored in the track header fields above. The sample description sets a text box within the region, which can be overridden by the samples. + +The translation values are stored in the track header matrix in the following positions: + +``` +{ 0x00010000,0,0,0,0x00010000,0, tx, ty, 0x40000000 } +``` + +These values are fixed-point 16.16 values, here restricted to be integers (the lower 16 bits of each value shall be zero). The X axis increases from left to right; the Y axis from top to bottom. (This use of the matrix is conformant with ISO/MJ2.) + +So, for example, a centred region of size $200 \times 20$ , positioned below a video of size $320 \times 240$ , would have track\_width set to 200 (width = 0x00c80000), track\_height set to 20 (height = 0x00140000), and tx = $(320 - 200)/2 = 60$ , and ty = 240. + +Since matrices are not used on the video tracks, all video tracks are set at the coordinate origin. Figure 9-1 provides an overview: + + + +Figure 9-1/J.124 – Illustration of text rendering position and composition. The diagram shows a 'Display area' (yellow hatched rectangle) containing a 'Video track' (blue rectangle) and a 'Text track' (green dashed rectangle). The 'Text track' contains a 'Text box' (blue hatched rectangle). The 'Text track' is positioned at (tx, ty) relative to the origin. The 'Text box' is defined by its top-left corner at (left, top) and its bottom-right corner at (right, bottom). The 'width' of the text box is indicated by a double-headed arrow at the bottom. The 'height' of the text box is indicated by a double-headed arrow on the left. The 'Display area' is labeled 'J.124\_F9-1'. + +**Figure 9-1/J.124 – Illustration of text rendering position and composition** + +The top and left positions of the text track is determined by the tx and ty, which are the translation values from the coordinate origin (since the video track is at the origin, this is also the offset from the video track). The default text box set in the sample description sets the rendering area unless overridden by a 'tbox' in the text sample. The box values are defined as the relative values from the top and left positions of the text track. + +It should be noted that this only specifies the relationship of the tracks within a single 3GP file. If a SMIL presentation lays up multiple files, their relative position is set by the SMIL regions. Each file is assigned to a region, and then, within those regions, the spatial relationship of the tracks is defined. + +## 9.8 Marquee scrolling + +Text can be 'marquee' scrolled in this specification (compare this to Internet Explorer's marquee construction). When scrolling is performed, the terminal first calculates the position in which the text would be displayed with no scrolling requested. Then: + +- If scroll-in is requested, the text is initially invisible, just outside the text box, and enters the box in the indicated direction, scrolling until it is in the normal position; +- If scroll-out is requested, the text scrolls from the normal position, in the indicated direction, until it is completely outside the text box. + +The rendered text is clipped to the text box in each display position, as always. This means that it is possible to scroll a string which is longer than can fit into the text box, progressively disclosing it (for example, like a ticker-tape). Note that both scroll in and scroll out may be specified; the text scrolls continuously from its invisible initial position, through the normal position, and out to its final position. + +If a scroll-delay is specified, the text stays steady in its normal position (not initial position) for the duration of the delay; so the delay is after a scroll-in, but before a scroll-out. This means that the scrolling is not continuous if both are specified. So, without a delay, the text is in motion for the duration of the sample. For a scroll in, it reaches its normal position at the end of the sample duration; with a delay, it reaches its normal position before the end of the sample duration, and + +remains in its normal position for the delay duration which ends at the end of the sample duration. Similarly, for a scroll out, the delay happens in its normal position before scrolling starts. If both scroll in, and scroll out are specified, with a delay, the text scrolls in, stays stationary at the normal position for the delay period, and then scrolls out – all within the sample duration. + +The speed of scrolling is calculated so that the complete operation takes place within the duration of the sample. Therefore, the scrolling has to occur within the time left after scroll-delay has been subtracted from the sample duration. Note that the time it takes to scroll a string may depend on the rendered length of the actual text string. Authors should consider whether the scrolling speed that results will be exceeded by that at which text on a wireless terminal could be readable. + +Terminals may use simple algorithms to determine the actual scroll speed. For example, the speed may be determined by moving the text an integer number of pixels in every update cycle. Terminals should choose a scroll speed which is as fast, or faster, than needed so that the scroll operation completes within the sample duration. + +Terminals are not required to handle dynamic or stylistic effects such as highlight, dynamic highlight, or href links on scrolled text. + +The scrolling direction is set by a two-bit field, with the following possible values: + +- 00b – text is vertically scrolled up ('credits style'), entering from the bottom and leaving towards the top. +- 01b – text is horizontally scrolled ('marquee style'), entering from the right and leaving towards the left. +- 10b – text is vertically scrolled down, entering from the top and leaving towards the bottom. +- 11b – text is horizontally scrolled, entering from the left and leaving towards the right. + +## 9.9 Language + +The human language used in this stream is declared by the language field of the media-header box in this track. It is an ISO 639/T 3-letter code. The knowledge of the language used might assist searching, or speaking the text. Rendering is language neutral. Note that the values 'und' (undetermined) and 'mul' (multiple languages) might occur. + +## 9.10 Writing direction + +Writing direction specifies the way in which the character position changes after each character is rendered. It also will imply a start-point for the rendering within the box. + +Terminals shall support the determination of writing direction, for those characters they support, according to the Unicode 3.0 specification. Note that the only required characters can all be rendered using left-right behaviour. A terminal which supports characters with right-left writing direction shall support the right-left composition rules specified in Unicode. + +Terminals may also set, or allow the user to set, an overall writing direction, either explicitly or implicitly (e.g., by the language selection). This affects layout. For example, if upper-case letters are left-right, and lower-case right-left, and the Unicode string ABCdefGHI shall be rendered, it would appear as ABCfedGHI on a terminal with overall left-right writing (English, for example) and GHIfedABC on a system with overall right-left (Hebrew, for example). + +Terminals are not required to support the bidirectional ordering codes (\u200E, \u200F and \u202A through \u202E). + +If vertical text is requested by the content author, characters are laid out vertically from top to bottom. The terminal may choose to render different glyphs for this writing direction (e.g., a horizontal parenthesis), but, in general, the glyphs should not be rotated. The direction in which lines advance (left-right, as used for European languages, or right-left, as used for Asian languages) + +is set by the terminal, possibly by a direct or indirect user preference (e.g., a language setting). Terminals shall support vertical writing of the required character set. It is recommended that terminals support vertical writing of text in those languages commonly written vertically (e.g., Asian languages). If vertical text is requested for characters which the terminal cannot render vertically, the terminal may behave as if the characters were not available. + +## 9.11 Text wrap + +Automatic wrapping of text from line to line is complex and can require hyphenation rules and other complex language-specific criteria. For these reasons, soft text wrap is optional in this specification. Text wrap behaviour may be specified using a TextWrapBox, and a terminal that does not support this feature shall not perform soft text wrapping. When text wrap is not used and a string is too long to be drawn within the box, it is clipped. The terminal may choose whether to clip at the pixel boundary, or to render only whole glyphs. + +There may be multiple lines of text in a sample (hard wrap). Terminals shall start a new line for the Unicode characters line separator (\u2028), paragraph separator (\u2029) and line feed (\u000A). It is recommended that terminals follow Unicode Technical Report 13. Terminals should treat carriage return (\u000D), next line (\u0085) and CR+LF (\u000D\u000A) as new line. + +## 9.12 Highlighting, Closed Caption, and Karaoke + +Text may be highlighted for emphasis. Since this is a non-interactive system, solely for text display, the utility of this function may be limited. + +Dynamic highlighting used for Closed Caption and Karaoke highlighting, is an extension of highlighting. Successive contiguous sub-strings of the text sample are highlighted at the specified times. + +## 9.13 Media handler + +A text stream is its own unique stream type. For the 3GPP file format, the handler-type within the 'hdlr' box shall be 'text'. + +## 9.14 Media handler header + +The 3G text track uses an empty null media header ('nmhd'), called Mpeg4MediaHeaderBox in the MP4 specification [3], in common with other MPEG streams. + +``` +aligned(8) class Mpeg4MediaHeaderBox + extends FullBox('nmhd', version = 0, flags) { +} +``` + +## 9.15 Style record + +Both the sample format and the sample description contain style records, and so it is defined once here for compactness. + +``` +aligned(8) class StyleRecord { + unsigned int(16) startChar; + unsigned int(16) endChar; + unsigned int(16) font-ID; + unsigned int(8) face-style-flags; + unsigned int(8) font-size; + unsigned int(8) text-color-rgba; +} +``` + +startChar: character offset of the beginning of this style run (always 0 in a sample description). + +endChar: first character offset to which this style does not apply (always 0 in a sample description); shall be greater than or equal to startChar. All characters, including line-break characters and any other non-printing characters, are included in the character counts. + +font-ID: font identifier from the font table; in a sample description, this is the default font. + +face-style-flags: in the absence of any bits set, the text is plain: + +- 1 bold; +- 2 italic; +- 4 underline. + +font-size: font size (nominal pixel size, in essentially the same units as the width and height). + +text-color-rgba: rgb colour, 8 bits each of red, green, blue, and an alpha (transparency) value. + +Terminals shall support plain text, and underlined horizontal text, and may support bold, italic and bold-italic depending on their capabilities and the font selected. If a style is not supported, the text shall still be rendered in the closest style available. + +## 9.16 Sample description format + +The sample table box ('stbl') contains sample descriptions for the text track. Each entry is a sample entry box of type 'tx3g'. This name defines the format both of the sample description and the samples associated with that sample description. Terminals shall not attempt to decode or display sample descriptions with unrecognized names, nor the samples attached to those sample descriptions. + +It starts with the standard fields (the reserved bytes and the data reference index), and then some text-specific fields. Some fields can be overridden or supplemented by additional boxes within the text sample itself. These are discussed below. + +There can be multiple text sample descriptions in the sample table. If the overall text characteristics do not change from one sample to the next, the same sample description is used. Otherwise, a new sample description is added to the table. Not all changes to text characteristics require a new sample description, however. Some characteristics, such as font size, can be overridden on a character-by-character basis. Some, such as dynamic highlighting, are not part of the text sample description and can be changed dynamically. + +The TextDescription extends the regular sample entry with the following fields. + +``` +class FontRecord { + unsigned int(16) font-ID; + unsigned int(8) font-name-length; + unsigned int(8) font[font-name-length]; +} + +class FontTableBox() extends Box('ftab') { + unsigned int(16) entry-count; + FontRecord font-entry[entry-count]; +} + +class BoxRecord { + signed int(16) top; + signed int(16) left; + signed int(16) bottom; + signed int(16) right; +} +``` + +``` + +class TextSampleEntry() extends SampleEntry ('tx3g') { + unsigned int(32) displayFlags; + signed int(8) horizontal-justification; + signed int(8) vertical-justification; + unsigned int(8) background-color-rgba; + BoxRecord default-text-box; + StyleRecord default-style; + FontTableBox font-table; +} + +``` + +displayFlags: + +| | | | +|-----------------------|------------|------------------------| +| scroll In | 0x00000020 | | +| scroll Out | 0x00000040 | | +| scroll direction | 0x00000180 | / see above for values | +| continuous karaoke | 0x00000800 | | +| write text vertically | 0x00020000 | | +| fill text region | 0x00040000 | | + +horizontal and vertical justification: / two eight-bit values from the following list: + +| | | +|---------------|----| +| left, top | 0 | +| centred | 1 | +| bottom, right | -1 | + +background-color-rgba: rgb color, 8 bits each of red, green, blue, and an alpha (transparency) value; +default text box: the default text box is set by four values, relative to the text region; it may be overridden in samples; + +style record of default style: startChar and endChar shall be zero in a sample description. + +The text box is inset within the region defined by the track translation offset, width, and height. The values in the box are relative to the track region, and are uniformly coded with respect to the pixel grid. So, for example, the default text box for a track at the top left of the track region and 50 pixels high and 100 pixels wide is {0, 0, 50, 100}. + +If the 'fill text region' flag is 0 (the default value, and the value from previous releases), then the background fill is applied to the text box only. If this flag is 1, then the author is requesting that the background fill be applied to the entire text region, if possible. Note that this flag was not defined in previous releases and will not, therefore, always be interpreted. Implementation of this flag is recommended but not required for compliance. + +A font table shall follow these fields to define the complete set of fonts used. The font table is a box of type 'ftab'. Every font used in the samples is defined here by name. Each entry consists of a 16-bit local font identifier, and a font name, expressed as a string, preceded by an 8-bit field giving the length of the string in bytes. The name is expressed in UTF-8 characters, unless preceded by a UTF-16 byte-order-mark, whereupon the rest of the string is in 16-bit Unicode characters. The string should be a comma-separated list of font names to be used as alternative fonts, in preference order. The special names "Serif", "Sans-serif" and "Monospace" may be used. The terminal should use the first font in the list which it can support; if it cannot support any for a given character, but it has a font which can, it should use that font. Note that this substitution is technically character-by-character, but terminals are encouraged to keep runs of characters in a consistent font where possible. + +## 9.17 Sample format + +Each sample in the media data consists of a string of text, optionally followed by sample modifier boxes. + +For example, if one word in the sample has a different size than the others, a 'styl' box is appended to that sample, specifying a new text style for those characters, and for the remaining characters in the sample. This overrides the style in the sample description. These boxes are present only if they are needed. If all text conforms to the sample description, and no characteristics are applied that the sample description does not cover, no boxes are inserted into the sample data. + +``` +class TextSampleModifierBox(type) extends Box(type) { +} + +class TextSample { + unsigned int(16) text-length; + unsigned int(8) text[text-length]; + TextSampleModifierBox text-modifier[]; // to end of the sample +} +``` + +The initial string is preceded by a 16-bit count of the number of bytes in the string. There is no need for null termination of the text string. The sample size table provides the complete byte-count of each sample, including the trailing modifier boxes; by comparing the string length and the sample size, you can determine how much space, if any, is left for modifier boxes. + +Authors should limit the string in each text sample to not more than 2048 bytes, for maximum terminal interoperability. + +Any unrecognized box found in the text sample should be skipped and ignored, and processing continue as if it were not there. + +### 9.17.1 Sample modifier boxes + +#### 9.17.1.1 Text style + +'styl' + +This specifies the style of the text. It consists of a series of style records as defined above, preceded by a 16-bit count of the number of style records. Each record specifies the starting and ending character positions of the text to which it applies. The styles shall be ordered by starting character offset, and the starting offset of one style record shall be greater than or equal to the ending character offset of the preceding record; styles records shall not overlap their character ranges. + +``` +class TextStyleBox() extends TextSampleModifierBox ('styl') { + unsigned int(16) entry-count; + StyleRecord text-styles[entry-count]; +} +``` + +#### 9.17.1.2 Highlight + +'hlit' + +This specifies highlighted text: the box contains two 16-bit integers, the starting character to highlight, and the first character with no highlighting (e.g., values 4, 6 would highlight the two characters 4 and 5). The second value may be the number of characters in the text plus one, to indicate that the last character is highlighted. + +``` +class TextHighlightBox() extends TextSampleModifierBox ('hlit') { + unsigned int(16) startcharoffset; + unsigned int(16) endcharoffset; +} +class TextHilightColorBox() extends TextSampleModifierBox ('hclr') { + unsigned int(8) highlight_color_rgba; +} +``` + +highlight\_color\_rgb: rgb color, 8 bits each of red, green, blue, and an alpha (transparency) value. + +The TextHilightColor Box may be present when the TextHighlightBox or TextKaraokeBox is present in a text sample. It is recommended that terminals use the following rules to determine the displayed effect when highlight is requested: + +- a) if a highlight colour is not specified, then the text is highlighted using a suitable technique such as inverse video: both the text colour and the background colour change. +- b) if a highlight colour is specified, the background colour is set to the highlight colour for the highlighted characters; the text colour does not change. + +Terminals do not need to handle text that is both scrolled and either statically or dynamically highlighted. Content authors should avoid specifying both scroll and highlight for the same sample. + +#### 9.17.1.3 Dynamic highlight + +'krok' + +Karaoke, closed caption, or dynamic highlighting. The number of highlight events is specified, and each event is specified by a starting and ending character offset and an end-time for the event. The start-time is either the sample start-time or the end-time of the previous event. The specified characters are highlighted from the previous end-time (initially the beginning of this sample's time), to the end-time. The times are all specified relative to the sample's time; that is, a time of 0 represents the beginning of the sample time. The times are measured in the time-scale of the track. + +The box starts with the start-time offset of the first highlight event, a 16-bit count of the event count, and then that number of 8-byte records. Each record contains the end-time offset as a 32-bit number, and the text start and end values, each as a 16-bit number. These values are specified as in the highlight record: the offset of the first character to highlight, and the offset of the first character not highlighted. The special case, where the startcharoffset equals to the endcharoffset, can be used to pause during, or at the beginning of, dynamic highlighting. The records shall be ordered and not overlap, as in the highlight record. The time in each record is the end-time of this highlight event; the first highlight event starts at the indicated start-time offset from the start-time of the sample. The time values are in the units expressed by the time-scale of the track. The time values shall not exceed the duration of the sample. + +The continuouskaraoke flag controls whether to highlight only those characters (continuouskaraoke = 0) selected by a karaoke entry, or the entire string from the beginning up to the characters highlighted (continuouskaraoke = 1) at any given time. In other words, the flag specifies whether karaoke should ignore the starting offset and highlight all text from the beginning of the sample to the ending offset. + +Karaoke highlighting is usually achieved by using the highlight colour as the text colour, without changing the background. + +At most one dynamic highlight ('krok') box may occur in a sample. + +``` +class TextKaraokeBox() extends TextSampleModifierBox ('krok') { + unsigned int(32) highlight-start-time; + unsigned int(16) entry-count; + for (i=1; i<=entry-count; i++) { + unsigned int(32) highlight-end-time; + unsigned int(16) startcharoffset; + unsigned int(16) endcharoffset; + } +} +``` + +#### 9.17.1.4 Scroll delay + +'dlay' + +This specifies a delay after a Scroll In and/or before Scroll Out. A 32-bit integer specifying the delay, in the units of the time-scale of the track. The default delay, in the absence of this box, is 0. + +``` +class TextScrollDelayBox() extends TextSampleModifierBox ('dlay') { + unsigned int(32) scroll-delay; +} +``` + +#### 9.17.1.5 HyperText + +'href' + +HyperText link. The existence of the hypertext link is visually indicated in a suitable style (e.g., underlined blue text). + +This box contains these values: + +startCharOffset: the start offset of the text to be linked; + +endCharOffset: the end offset of the text (start offset + number of characters); + +URLLength: the number of bytes in the following URL; + +URL: UTF-8 characters – the linked-to URL; + +altLength: the number of bytes in the following "alt" string; + +altstring: UTF-8 characters – an "alt" string for user display. + +The URL should be an absolute URL, as the context for a relative URL may not always be clear. + +The "alt" string may be used as a tool-tip or other visual clue, as a substitute for the URL, if desired by the terminal, to display to the user as a hint on where the link refers. + +Hypertext-linked text should not be scrolled; not all terminals can display this or manage the user interaction to determine whether the user has interacted with moving text. It is also hard for the user to interact with scrolling text. + +``` +class TextHyperTextBox() extends TextSampleModifierBox ('href') { + unsigned int(16) startcharoffset; + unsigned int(16) endcharoffset; + unsigned int(8) URLLength; + unsigned int(8) URL[URLLength]; + unsigned int(8) altLength; + unsigned int(8) altstring[altLength]; +} +``` + +#### 9.17.1.6 Textbox + +'tbox' + +Text box override. This overrides the default text box set in the sample description. + +``` +class TextboxBox() extends TextSampleModifierBox ('tbox') { + BoxRecord text-box; +} +``` + +#### 9.17.1.7 Blink + +'blink' + +Blinking text. This requests blinking text for the indicated character range. Terminals are not required to support blinking text, and the precise way in which blinking is achieved, and its rate, is terminal-dependent. + +``` + +class BlinkBox() extends TextSampleModifierBox ('blnk') { + unsigned int(16) startcharoffset; + unsigned int(16) endcharoffset; +} + +``` + +#### 9.17.1.8 Text wrap indication + +'twrp' + +This specifies text wrap behaviour: the box contains one 8-bit integer as a wrap mode flag. + +``` + +class TextWrapBox() extends TextSampleModifierBox ('twrp') { + unsigned int(8) wrap_flag; +} + +``` + +wrap\_flag: a value from Table 9-1. + +**Table 9-1/J.124 – Wrap flag values** + +| Value | Description | +|-----------|-------------------------------| +| 0x00 | No wrap | +| 0x01 | Automatic 'soft' wrap enabled | +| 0x02-0xFF | Reserved | + +## 9.18 Combinations of features + +Two modifier boxes of the same type shall not be applied to the same character (e.g., it is not permitted to have two href links from the same text). As the 'hclr', 'dlay' and 'tbox' are globally applied to the whole text in a sample, each sample shall contain at most one 'hclr', at most one 'dlay', and at most one 'tbox' modifier. + +Table 9-2 details the effects of multiple options: + +**Table 9-2/J.124 – Combinations of features** + +| | | Sample description style record | First sample modifier box | | | | | +|---------------------------------------|-------------|---------------------------------|---------------------------|------|------|------|------| +| | | | styl | hlit | krok | href | blnk | +| Second sample
modifier box | styl | 1 | 3 | | | | | +| | hlit | | | 3 | | | | +| | krok | | | 4 | 3 | | | +| | href | 2 | 2 | | 5 | 3 | | +| | blnk | | 6 | 6 | 6 | 6 | 6 | + +- 1) The sample description provides the default style; the style records override this for the selected characters. +- 2) The terminal overrides the chosen style for href links. +- 3) Two records of the same type cannot be applied to the same character. +- 4) Dynamic and static highlighting must not be applied to the same text. +- 5) Dynamic highlighting and linking must not be applied to the same text. +- 6) Blinking text is optional, particularly when requested in combination with other features. + +# Appendix I + +## Application example: Typical VOD transmission + +A file transmission request to the server without any specific information starts the VOD transmission. The request syntax is, for example, as follows: + +
field | +|----------------|-----|--|-------------------------------| + +Diagram of Idle cell format showing ATM cell header and ATM cell information field. + +**Figure 6/J.131 – Idle cell format** + +#### e) *HEC processing* + +The HEC value for each cell is calculated and inserted into the HEC field. The method of HEC value calculation shall be in accordance with Recommendation I.432 [10]. Basically, the HEC field is the remainder of the division (modulo 2) by the generator polynomial $x^8 + x^2 + x + 1$ of the product $x^8$ multiplied by the content of the header excluding the HEC field, to which is added the value 55h. + +#### f) *Scrambling* + +The information field of each cell is scrambled with a self-synchronizing scrambler $x^{43} + 1$ . The operation of the scrambler shall be in accordance with Recommendation I.432 [10]. + +#### g) *Cell stream mapping* + +The cell stream shall be inserted into PDH transmission path payload which shall be in accordance with Recommendation G.804 [4]. The mapping into 44 736 kbit/s shall be HEC-based as described in 7.3/G.804 [4]. The cell boundaries are aligned with the transmission path octet boundaries if an octet structure is considered. + +### 7.4.2 Signal processing in the receiver (Signal flow from e to d in Figure 1) + +#### a) *Cell stream demapping* + +The cell stream shall be extracted from PDH transmission path payload which shall be in accordance with Recommendation G.804 [4]. The demapping of cells out of the 44 736 kbit/s data stream has to take into account the HEC-based mapping scheme mentioned in 7.4.1 g) above. The cell boundaries are aligned with the transmission path octet boundaries if an octet structure is considered. + +#### b) *Cell delineation* + +Cell delineation is performed on the continuous cell stream extract from the transmission path frames. The cell delineation algorithm shall be in accordance with Recommendation I.432 [10]. Basically, it is based on the correlation between the header bits to be protected (32 bits) and the relevant control bits (8 bits) introduced in the header by the HEC. Cell delineation is deemed to be lost causing a LCD defect after 7 consecutive incorrect HECs. Cell delineation is deemed to be recovered after 6 consecutive correct HECs. If the function is in the MON state, the LCD defect is reported to the EMF. + +#### c) *Descrambling* + +The information field of each cell is descrambled with a self-synchronizing scrambler polynomial $x^{43} + 1$ . The operation of the descrambler shall be in accordance with Recommendation G.804 [4]. + +#### d) *HEC processing* + +HEC verification and correction are based on the methods described in Recommendation I.432 [10]. The HEC correction mode may be activated/deactivated by the EMF. In case of cells determined to have an invalid and uncorrectable HEC pattern, two options are possible. Either the invalid cells may be discarded (in accordance with Recommendation I.432 [10]) or the invalid cells may not be discarded (not in accordance with Recommendation I.432 [10]). The wanted option is selected by the EMF. Further information is given in Appendix II. + +#### e) *Cell rate decoupling* + +Idle cells are extracted from the cell stream. They are identified by the standardized pattern for the cell header. + +#### f) *PT identification* + +This function is not implemented. The corresponding bits are ignored. + +#### g) *Cell header verification* + +The receiving Network Adapter shall verify that the first four octets of the ATM cell header are recognizable as being a valid header pattern. Invalid header pattern is (p = any value) given in Figure 7. + +| | | | | | +|-------------|------------------|----------------------------|-----------|----------| +| GFC
pppp | VPI
0000 0000 | VCI
0000 0000 0000 0000 | PT
ppp | CLP
1 | +|-------------|------------------|----------------------------|-----------|----------| + +Figure 7/J.131 – Invalid header pattern + +Idle cells are discarded. + +#### h) *GFC check* + +This function is not implemented. The corresponding bits of the GFC field are ignored. + +#### i) *VPI verification* + +The receiving Network Adapter shall verify that the VPI of the received cell is valid. If the VPI is determined to be invalid (i.e. out-of-range or unassigned – see 7.3.1, item "VP setting"), the cell shall be discarded. + +#### j) *Congestion control* + +This function is not implemented. The corresponding bit CLP is ignored. + +#### h) *VP demultiplexing* + +This function enables the flow of cells which have to be logically separated into individual data flows according to their VP values. + +## 7.5 PDH Path Layer Trail Termination (Pqs\_TT) + +Based on the hierarchical bit rates of 1544 kbit/s, 2048 kbit/s, 6312 kbit/s, 34 368 kbit/s, 44 736 kbit/s and 139 264 kbit/s, the references to Recommendations and information for the PDH path layer trail termination are given in Table 3. + +**Table 3/J.131 – References for the Pqs\_TT functions** + +| Bit rate | Function name | Frame structure Recommendation | Atomic functions | +|-----------------|----------------------|---------------------------------------|-------------------------| +| 2 Mbit/s | P12s_TT | G.704 | See [17] | +| 34 Mbit/s | P31s_TT | G.832 | See [17] | +| 140 Mbit/s | P4s_TT | G.832 | See [17] | +| 1.5 Mbit/s | P11s_TT | G.704 | For further study | +| 6 Mbit/s | P21s_TT | G.704 | For further study | +| 45 Mbit/s | P32s_TT | G.704 | For further study | + +## 7.6 PDH Physical Section Layer to PDH Path Layer Adaptation (Eq/Pqs\_A) + +Based on the hierarchical bit rates of 1544 kbit/s, 2048 kbit/s, 6312 kbit/s, 34 368 kbit/s, 44 736 kbit/s and 139 264 kbit/s, the references to Recommendations and information for the PDH physical section layer are given in Table 4. + +**Table 4/J.131 – References for the Eq/Pqs\_A functions** + +| Bit rate | Function name | Frame structure Recommendation | Atomic functions | +|-----------------|----------------------|---------------------------------------|-------------------------| +| 2 Mbit/s | E12/P12s_A | G.704 | Annex D/G.783 | +| 34 Mbit/s | E31/P31s_A | G.832 | See [16] | +| 140 Mbit/s | E4/P4s_A | G.832 | See [16] | +| 1.5 Mbit/s | E11/P11s_A | G.704 | Annex D/G.783 | +| 6 Mbit/s | E21/P21s_A | G.704 | For further study | +| 45 Mbit/s | E32/P32s_A | G.704 | For further study | + +## 7.7 PDH Physical Section Layer Trail Termination (Eq\_TT) + +Based on the hierarchical bit rates of 1544 kbit/s, 2048 kbit/s, 6312 kbit/s, 34 368 kbit/s, 44 736 kbit/s and 139 264 kbit/s, the references to Recommendations and information for the PDH physical section trail termination are given in Table 5. + +**Table 5/J.131 – References for the Eq\_TT functions** + +| Bit rate | Function name | Physical characteristics Recommendation | Atomic functions | +|--------------------------------------------------|----------------------|------------------------------------------------|-------------------------| +| 2 Mbit/s | E12_TT | G.703 | Annex D/G.783 | +| 34 Mbit/s | E31_TT | G.703 | Annex D/G.783 | +| 140 Mbit/s | E4_TT | G.703 | Annex D/G.783 | +| 1.5 Mbit/s | E11_TT | G.703 | Annex D/G.783 | +| 6 Mbit/s | E21_TT | G.703 | Annex D/G.783 | +| 45 Mbit/s | E32_TT | G.703 (Note) | Annex D/G.783 | +| NOTE – Further information is available in [20]. | | | | + +## 7.8 Equipment Management Function (EMF) + +### 7.8.1 Overview of the EMF + +The EMF provides the means through which the Network Element (NE) is managed by an external manager. The EMF interacts with the other basic functions by exchanging information across the MP (Management Points) reference points. The EMF contains a number of filters that provide a data reduction mechanism on the information received across the MP reference points. + +The interface between the processing in the basic functions and the equipment management function is indicated by the dashed line in Figure 8 and represents the MP reference points. For performance monitoring, the signals passed over this interface are the 1 second Near (Far)-end Errored Block Counts (N\_EBC, F\_EBC) and the 1 second Near (Far)-end Defect Seconds (N\_DS, F\_DS). For fault management, the signals passed over this interface are the defects. + + + +Figure 8/J.131 – Supervision process within equipment management function. The diagram shows the flow of information from basic functions through MP reference points into the equipment management function. On the left, 'Supervision processes within basic functions' include 'Anomaly and Defect processing' which sends 'anomalies defects' to 'Perf. Mon. Primitives processing' and 'defects' to 'Defect correlation'. These then pass through 'MP reference points' (labeled '1 second info: N\_EBC/N\_DS F\_EBC/F\_DS') into the EMF. Inside the EMF, 'Perf. Mon. Event processing' receives this info and sends it to 'Perf. Mon. Data Coll. and History Man.', which outputs '15 min/24 h info' (N\_ES\_15 min, N\_SES\_15 min, N\_BBE\_15 min, N\_UAS\_15 min, N\_ES\_24 h etc.), 'TR/RTR', and 'alarms'. 'Defect correlation' sends 'fault causes' through the MP reference points to 'Fault cause persistency', which sends 'failures' to 'Severity, logging and reporting', which outputs 'alarms' and 'TMN'. A 'filters' block is shown at the bottom right of the EMF section. + +Figure 8/J.131 – Supervision process within equipment management function + +The filtering functions provide a data reduction mechanism on the defect and performance monitoring primitives information presented at the MP reference points. Two types of techniques can be distinguished: + +- The fault cause persistency filter will provide a persistency check on the fault causes that are reported across the MP reference points. In addition to the transmission failures listed in Table 6, hardware failures with signal transfer interruption are also reported at the input of the fault cause filter for further processing. +- The performance monitoring event processing processes the information available from the one-second window and reported across the MP reference points in order to derive errored seconds and severely errored seconds, and background block errors (see Recommendation G.826 [5]). + +#### Time-stamping + +Events, performance reports and registers containing event counts that require time-stamping shall be time stamped with a resolution of one second. The time shall be as indicated by the local real time clock of the NE. The required accuracy and precise details of the time-stamping of events/reports relative to UTC is the subject of further study (a maximum value in the range 1 to 10 seconds is being considered). The start of 15-minute and 24-hour counts should be accurate to within $\pm 10$ seconds with respect to the NE clock. + +**Table 6/J.131 – Basic function associated failure list** + +| Basic functions | Failure | +|-------------------------|---------------------------------------------------------------| +| Pqs_TT, Eq_TT, Eq/Pqs_A | See G.783 [3] or ETS 300 417-2-1 [16] or ETS 300 417-5-1 [17] | +| VPME | LCD | +| VPE | | +| MAA | STATUS
SNI
LMC | +| MPI | LOS
TSLE_I
TSLE_O | + +### 7.8.2 Configuration + +The information flow over the MP reference points that arises from configuration and provisioning data is given in Table 7. The information listed under "Set" refers to configuration and provisioning data that is passed from the EMF to the other basic functions. The information listed under "Get" refers to status reports made in response to a request from the EMF for such information. + +**Table 7/J.131 – Command, configuration information flow over MP** + +| | Get | Set | +|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Pqs_TT, Eq_TT, Eq/Pqs_A | See G.783 [3] or ETS 300 417-2-1 [16] or ETS 300 417-5-1 [17] | See G.783 [3] or ETS 300 417-2-1 [16] or ETS 300 417-5-1 [17] | +| VPME | Cell Discarded: Active or Not_Active
HEC correction mode: Active or Not_Active
VPI value | Supervision State: MON or NMON (Note 1)
Cell Discarded: Active or Not_Active
HEC correction mode: Active or Not_Active | +| VPE | | Supervision State: MON or NMON (Note 2)
VPI value | +| MAA | | Supervision State: MON or NMON (Note 2) | +| MPI | Supervision State: MON or NMON
Number of packets per second
Option for system A (European system):
FORMAT: 188 or 204 bytes packet with
16 dummy bytes (Note 3) | Supervision State: MON or NMON (Note 2)
Option for system A (European system):
FORMAT: 188 or 204 bytes packet with
16 dummy bytes (Note 3) | + +NOTE 1 – Eq\_TT and associated Pqs\_TT and VPME are always in the same supervision state. +NOTE 2 – For a given MPEG interface, MPI and associated MAA and VPE are in the same state. +NOTE 3 – This status is only relevant for the selection of the transmission format (188 bytes or 204 with 16 dummy bytes) to be used at an output SSI or SPI interface for the delivery of MPEG-2-TS packets. + +### 7.8.3 Fault (maintenance) management + +#### 7.8.3.1 Fault cause persistency filter + +The equipment management function within the network element performs a persistency check on the fault causes before it declares a fault cause a failure. A transmission failure shall be declared if the fault cause persists continuously for $2.5 \pm 0.5$ seconds. The failure shall be cleared if the fault cause is absent continuously for $10 \pm 0.5$ seconds. Transmission failures associated with the basic functions are listed in Table 6. + +##### 7.8.3.1.1 Alarm history management + +Alarm history management is concerned with the recording of alarms. Historical data shall be stored in registers in the NE. Each register contains all the parameters of an alarm message. Registers shall be readable on demand or periodically. The operator can define the operating mode of the registers as wrapping or stop when full. The operator may also flush the registers or stop recording at any time. + +NOTE – Wrapping is the deletion of the earliest record to allow a new record when a register is full. Flushing is the deletion of all the records. + +### 7.8.4 Performance management + +Performance management consists of performance monitoring event processes, data collection and history processes along with thresholding and reporting functions. Performance monitoring consists of the first three items. + +Within performance monitoring, the concepts of "near-end" and "far-end" are used to refer to performance monitoring information associated with the two directions of transport in the case of a bidirectional transmission path. For a trail from A to Z: + +- at node A the near-end information represents the performance of the unidirectional trail from Z to A, while the far-end information represents the performance of the unidirectional trail from A to Z; +- at node Z the near-end information represents the performance of the unidirectional trail from A to Z, while the far-end information represents the performance of the unidirectional trail from Z to A. + +At either end of the trail (A or Z), the combination of near-end and far-end information presents the performance of the two directions of the trail. + +#### 7.8.4.1 Performance monitoring event process + +The performance monitoring event processing processes the information available from the performance monitoring primitives processing (basic functions) giving the performance primitives (EBC and DS) to derive the performance events (errored seconds, severely errored seconds and background block errors). + +*Near-end Performance Monitoring Event (NPME) function* + +Figure 9 presents the processes and their interconnect within the Near-end Performance Monitoring Event (NPME) function. This function processes information from PPT and MPI functional blocks. + + + +T0905680-97/d05 + +Diagram of the Near-end Performance Monitoring Event (NPME) function. It shows three input signals (NDS, NEBC, and an unlabeled signal) entering a central block labeled NPME. Inside NPME, these inputs are processed by three sub-blocks: NBBE, NSES, and NES. The NBBE block outputs NBBE(t). The NSES block outputs NSES(t) and has an arrow pointing to the NBBE block. The NES block outputs NES(t). The outputs NBBE(t), NSES(t), and NES(t) exit the NPME block to the right. A small text 'T0905680-97/d05' is at the bottom right of the diagram. + +Figure 9/J.131 – Near-end Performance Monitoring Event (NPME) function + +A Near-end Errored Second (NES) shall be generated if the defect second (NDS) is set or if the Near-end Errored Block Count (NEBC) is greater or equal to 1: $NES(t) \leftarrow (NDS = true) \text{ or } (NEBC \geq 1)$ . + +A Near-end Severely Errored Second (NSES) shall be generated if the Near-end Defect Second (NDS) is set or if the Near-end Errored Block Count (NEBC) is greater or equal to 30% of the blocks in a one-second period: $NSES(t) \leftarrow (NDS = true) \text{ or } (NEBC \geq "30\% \text{ of blocks in a one-second period"}).$ + +The number of Near-end Background Block Errors (NBBE) in a one-second period shall be equal to the Near-end Errored Block Count (NEBC) if the second is not a Near-end Severely Errored Second (NSES). Otherwise (NSES is set), NBBE shall be zero. $NBBE(t) \leftarrow NEBC (NSES = false) \text{ or } 0 (NSES = true).$ + +##### *Far-end Performance Monitoring Event (FPME) function* + +Figure 10 presents the processes and their interconnect within the Far-end Performance Monitoring Event (FPME) function. This function processes information from PPT functional blocks in case of bidirectional transmission. + + + +The diagram shows the Far-end Performance Monitoring Event (FPME) function. On the left, three input signals are shown: NDS (Near-end Defect Second), FDS (Far-end Defect Second), and FEBC (Far-end Errored Block Count). These inputs are connected to three processing blocks: FBBE (Far-end Background Block Errors), FSES (Far-end Severely Errored Second), and FES (Far-end Errored Second). The FBBE block receives inputs from NDS, FDS, and FEBC. The FSES block receives inputs from NDS, FDS, and FEBC. The FES block receives inputs from NDS, FDS, and FEBC. The FBBE, FSES, and FES blocks are grouped within a larger box labeled FPME. The FBBE block outputs FBBE(t), the FSES block outputs FSES(t), and the FES block outputs FES(t). A small text label 'T0905690-97/d06' is located at the bottom right of the diagram. + +Block diagram of the Far-end Performance Monitoring Event (FPME) function. Inputs NDS, FDS, and FEBC are shown on the left. NDS connects to FBBE, FSES, and FES. FDS connects to FBBE, FSES, and FES. FEBC connects to FBBE, FSES, and FES. FBBE, FSES, and FES are inside a box labeled FPME. FBBE outputs FBBE(t), FSES outputs FSES(t), and FES outputs FES(t). + +**Figure 10/J.131 – Far-end Performance Monitoring Event (FPME) function** + +A Far-end Errored Second (FES) shall be generated if the Far-end Defect Second (FDS) is set or if the Far-end Errored Block Count (FEBC) is greater or equal to 1, and if that second is not a Near-end Defect Second (NDS): $FES(t) \leftarrow (NDS = false) \text{ and } [(FDS = true) \text{ or } (FEBC \geq 1)].$ + +A Far-end Severely Errored Second (FSES) shall be generated if the Far-end Defect Second (FDS) is set or if the Far-end Errored Block Count (FEBC) is greater or equal to 30% of the blocks in a one-second period, and that second is not a Near-end Defect Second (NDS): $FSES(t) \leftarrow (NDS = false) \text{ and } [(FDS = true) \text{ or } (FEBC \geq "30\% \text{ of blocks in a one second period"})].$ + +The number of Far-end Background Block Errors (FBBE) in a one-second period shall be equal to the Far-end Errored Block Count (FEBC) if the second is not a Far-end Severely Errored Second (FSES), and if that second is not a Near-end Defect Second (NDS). Otherwise, FBBE shall be zero: + +$$FBBE(t) \leftarrow FEBC (FSES = false \text{ and } NDS = false) \text{ or } 0 (FSES = true \text{ or } NDS = true).$$ + +#### 7.8.4.2 Performance data collection + +Performance data collection refers to the event counting associated with each of the performance events BBE, ES, SES as defined in Recommendation G.826 [5], and any additional performance parameter defined in this ETS. The collection as specified in Recommendation M.2120 [14] is based on information for each direction of transport independently. This type is further referred to as performance data collection for maintenance purposes. This type of collection counts the + +events over fixed time periods of 15 minutes and 24 hours. Counting is stopped during unavailable time. These counters operate as follows: + +##### **15-minute counter** + +The performance events (e.g. SES) are counted in a counter per event. These counters are called the current registers. At the end of the 15-minute period, the contents of the current registers are transferred to the first of the recent registers, with a time-stamp to identify the 15-minute period (including the day), after which the current register shall be reset to zero (see Note). It is an option not to transfer the content of a current register to a recent register if this content is zero. + +NOTE – A capability should be provided to insure that, in the absence of reports, the reporting process is functioning properly. + +It shall be possible to reset an individual current register to zero by means of an external command. + +Any register whose content is suspect shall be flagged, using the "suspect interval flag" provided in Recommendation Q.822 [15]. This flag shall be raised independently for far-end and near-end counts. Examples of conditions for raising this flag are provided in Recommendation Q.822 [15]. + +##### **24-hour counter** + +The performance events (e.g. SES) are counted in a counter per event, independent of the 15-minute counters. These counters are called the current registers. It was agreed that it is up to the NE implementation to update the register counts. It is not required that it shall be done on a second by second basis. At the end of the 24-hour period, the contents of the current registers are transferred to recent registers, with a time-stamp to identify the 24-hour period, after which the current register shall be reset to zero. It shall be possible to reset an individual current register to zero by means of an external command. + +Any register whose content is suspect shall be flagged, using the "suspect interval flag" provided in Recommendation Q.822 [15]. This flag shall be raised independently for far-end and near-end counts. Examples of conditions for raising this flag are provided in Recommendation Q.822 [15]. + +##### **7.8.4.2.1 Performance data collection during unavailable time** + +The onset and exit of unavailable time is defined in Annex A/G.826 [5] and in Recommendation M.2120 [14]. A period of unavailable time begins at the onset of ten consecutive SES. These ten seconds are part of unavailable time. A period of available time begins at the onset of ten consecutive non-SES. These ten seconds are part of available time. Performance monitoring event counting for ES, SES, and BBE shall be inhibited during unavailable time. + +#### **7.8.4.3 Availability data collection** + +When a period of unavailability occurs, the beginning and ending of this period should be stored in a log in the NE, and as a consequence time-stamped. The NE should be able to store these data for at least 6 periods of unavailability. + +#### **7.8.4.4 Performance monitoring history** + +Performance history data are necessary to assess the recent performance of transmission systems. Such information can be used to sectionalise faults and to locate the source of intermittent errors. Historical data, in the form of performance monitoring event counts, may be stored in registers in the NE or in mediation devices associated with the NE. For specific applications, for example when only Quality of Service alarms are used, historical data may not be stored. All the history registers shall be time-stamped. The history registers operate as follows (see also Figure 11): + +###### **15-minute registers** + +The history of the 15-minute monitoring is contained in a stack of 16 registers per monitored event. These registers are called the recent registers. Every 15 minutes, the contents of the current registers are moved to the first of the recent registers. When all 15-minute registers are used, the oldest information will be discarded. + +###### 24-hour registers + +The history of the 24-hour monitoring is contained in a single register per monitored event. This register is called the recent register. Every 24 hours, the contents of the current registers are moved to the recent register. + +NOTE – This implies that all 24-hour data are discarded after 24 hours. + + + +Diagram of performance monitoring data collection and history for maintenance purposes. It shows a box labeled MAINTREG containing three boxes labeled '15 min/24 h'. Above the MAINTREG box are three labels: BBE (Note), ES (Note), and SES (Note). Arrows point from each of these labels to one of the '15 min/24 h' boxes. Below the MAINTREG box is a box labeled UAT, with an arrow pointing from the UAT box to the label 'UAT cmd'. + +NOTE – The determination of (un)available time introduces (functionally) a delay of 10 seconds. This delay should be considered when counting BBE, ES, SES. + +**Figure 11/J.131 – Performance monitoring data collection and history for maintenance purposes** + +##### 7.8.4.5 Performance data reporting + +Performance data stored in the NE may be collected by the operator for analysis without affecting the content of the register. + +# Appendix I + +## Mechanisms of the adaptive clock method + +The adaptive clock method is a general method for source clock frequency recovery. No explicit timing information of the source clock is transported by the network; the method is based on the fact that the amount of transmitted data is an indication of the source frequency, and this information can be used at the receiver to recover the source clock frequency. + +The adaptive clock method is implemented at the receiving AAL. The implementation of the method is not standardized. One possible method to measure the amount of data is to use the fill level of the AAL user data buffer. The following is the general description of this method and does not preclude other adaptive clock methods. + +The receiver writes the received data into a buffer, and then reads it out using a locally-generated clock. Therefore the fill level of the buffer depends on the source frequency and it is used to control the frequency of the local clock. Operations are the following: the fill level of the buffer is continuously measured and the measure is used to drive the phase-locked loop generating the local clock. The method maintains the fill level of the buffer around its medium position. To avoid buffer underflow or overflow, the fill level is maintained between two limits. When the level in the buffer goes to the lower limit, this means the frequency of the local clock is too high compared to the one of the source + +and so it has to be decreased; when the level in the buffer goes to upper limit, the frequency of the local clock is too low compared to the one of the source, and so it has to be increased. + +It is pointed out that the compensation of cell delay variation is also performed by the adaptive clock method. However, a cell delay variation is not to be expected if no ATM network is to be crossed. + +## Appendix II + +### Enabling/disabling the Header Error Control functions + +The Header Error Control (HEC) functions of the ATM cells, as described in Recommendation I.432 [10], can correct single errors and detect almost all multiple errors in the header. In an ATM network, when the HEC detects errors that it cannot correct, the whole cell is discarded and its payload is lost for an end-to-end connection. + +When a FEC is applied on a link, it can generate error bursts if it fails to correct errors. In presence of error bursts, the single-bit correcting code of the HEC is unable to correct most errors encountered. In an error bursts environment, the probability of discarding cells is proportional to the BER and not to the square of the BER as in a random error environment. Although bursts of errors due to error correction failures have different lengths and rate of occurrence according to the different FEC schemes, this behaviour would apply to all transmission systems using FEC. + +Therefore, for a given bit error probability, the discarded cell probability in presence of error bursts is definitely different from the discarded cell probability in presence of randomly distributed errors. + +It is then recommended to disable the Header Error Control functions when using the ATM cell format for transporting an MPEG-2-TS over a PDH-network based on transmission systems using FEC (e.g. radio relays, satellites). This measure avoids unwanted and unnecessary degradation of the end-to-end quality. + +## Appendix III + +## Transmission capacity of the Network Adapter + +Transmission capacity of the Network Adapter for MPEG-2-TSs and RS-coded MPEG-2-TSs at specified digital hierarchy bit rates of Recommendation G.702 [1]. + +| PDH link transmission capacity | Transmission capacity for MPEG-2-TSs and RS-coded MPEG-2-TSs (Note) | +|-----------------------------------------------------------------------------|---------------------------------------------------------------------| +| 1544 kbit/s | 1320 kbit/s | +| 2048 kbit/s | 1649 kbit/s | +| 6312 kbit/s | 5279 kbit/s | +| 34 368 kbit/s | 29 140 kbit/s | +| 44 736 kbit/s | 37 980 kbit/s | +| 139 264 kbit/s | 118 759 kbit/s | +| NOTE – Depending on the application, these figures may be slightly reduced. | | + +# ITU-T RECOMMENDATIONS SERIES + +| | | +|-----------------|--------------------------------------------------------------------------------------------------------------------------------| +| Series A | Organization of the work of the ITU-T | +| Series B | Means of expression: definitions, symbols, classification | +| Series C | General telecommunication statistics | +| Series D | General tariff principles | +| Series E | Overall network operation, telephone service, service operation and human factors | +| Series F | Non-telephone telecommunication services | +| Series G | Transmission systems and media, digital systems and networks | +| Series H | Audiovisual and multimedia systems | +| Series I | Integrated services digital network | +| Series J | Transmission of television, sound programme and other multimedia signals | +| Series K | Protection against interference | +| Series L | Construction, installation and protection of cables and other elements of outside plant | +| Series M | TMN and network maintenance: international transmission systems, telephone circuits, telegraphy, facsimile and leased circuits | +| Series N | Maintenance: international sound programme and television transmission circuits | +| Series O | Specifications of measuring equipment | +| Series P | Telephone transmission quality, telephone installations, local line networks | +| Series Q | Switching and signalling | +| Series R | Telegraph transmission | +| Series S | Telegraph services terminal equipment | +| Series T | Terminals for telematic services | +| Series U | Telegraph switching | +| Series V | Data communication over the telephone network | +| Series X | Data networks and open system communications | +| Series Y | Global information infrastructure | +| Series Z | Programming languages | \ No newline at end of file diff --git a/marked/J/T-REC-J.1318-202410-I_PDF-E/raw.md b/marked/J/T-REC-J.1318-202410-I_PDF-E/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..d73fbe11fa09c91c56ef3f723a26e8afa5f0f62e --- /dev/null +++ b/marked/J/T-REC-J.1318-202410-I_PDF-E/raw.md @@ -0,0 +1,432 @@ + + +# Recommendation**ITU-T J.1318 (10/2024)** + +SERIES J: Cable networks and transmission of television, sound programme and other multimedia signals + +Cloud-based Services for IP Delivery over integrated broadband cable network + +# --- **Requirements of end-to-end network platforms for cloud-based object wave transmission** + + + +The logo of the International Telecommunication Union (ITU) is located in the bottom right corner. It features a blue globe with white lines representing latitude and longitude, and the letters 'ITU' in a bold, blue, sans-serif font overlaid on the globe. + +ITU logo + +## ITU-T J-SERIES RECOMMENDATIONS + +# Cable networks and transmission of television, sound programme and other multimedia signals + +| | | +|-------------------------------------------------------------------------------------------------|----------------------| +| GENERAL RECOMMENDATIONS | J.1-J.9 | +| GENERAL SPECIFICATIONS FOR ANALOGUE SOUND-PROGRAMME TRANSMISSION | J.10-J.19 | +| PERFORMANCE CHARACTERISTICS OF ANALOGUE SOUND-PROGRAMME CIRCUITS | J.20-J.29 | +| EQUIPMENT AND LINES USED FOR ANALOGUE SOUND-PROGRAMME CIRCUITS | J.30-J.39 | +| DIGITAL ENCODERS FOR ANALOGUE SOUND-PROGRAMME SIGNALS - PART 1 | J.40-J.49 | +| DIGITAL TRANSMISSION OF SOUND-PROGRAMME SIGNALS | J.50-J.59 | +| CIRCUITS FOR ANALOGUE TELEVISION TRANSMISSION | J.60-J.69 | +| ANALOGUE TELEVISION TRANSMISSION OVER METALLIC LINES AND INTERCONNECTION WITH RADIO-RELAY LINKS | J.70-J.79 | +| DIGITAL TRANSMISSION OF TELEVISION SIGNALS | J.80-J.89 | +| ANCILLARY DIGITAL SERVICES FOR TELEVISION TRANSMISSION | J.90-J.99 | +| OPERATIONAL REQUIREMENTS AND METHODS FOR TELEVISION TRANSMISSION | J.100-J.109 | +| INTERACTIVE SYSTEMS FOR DIGITAL TELEVISION DISTRIBUTION (DOCSIS FIRST AND SECOND GENERATIONS) | J.110-J.129 | +| TRANSPORT OF MPEG-2 SIGNALS ON PACKETIZED NETWORKS | J.130-J.139 | +| MEASUREMENT OF THE QUALITY OF SERVICE - PART 1 | J.140-J.149 | +| DIGITAL TELEVISION DISTRIBUTION THROUGH LOCAL SUBSCRIBER NETWORKS | J.150-J.159 | +| IPCABLECOM (MGCP-BASED) - PART 1 | J.160-J.179 | +| DIGITAL TRANSMISSION OF TELEVISION SIGNALS - PART 1 | J.180-J.189 | +| CABLE MODEMS AND HOME NETWORKING | J.190-J.199 | +| APPLICATION FOR INTERACTIVE DIGITAL TELEVISION - PART 1 | J.200-J.209 | +| INTERACTIVE SYSTEMS FOR DIGITAL TELEVISION DISTRIBUTION (DOCSIS THIRD TO FIFTH GENERATIONS) | J.210-J.229 | +| MULTI-DEVICE SYSTEMS FOR CABLE TELEVISION | J.230-J.239 | +| MEASUREMENT OF THE QUALITY OF SERVICE - PART 2 | J.240-J.249 | +| DIGITAL TELEVISION DISTRIBUTION THROUGH LOCAL SUBSCRIBER NETWORKS | J.250-J.259 | +| IPCABLECOM (MGCP-BASED) - PART 2 | J.260-J.279 | +| DIGITAL TRANSMISSION OF TELEVISION SIGNALS - PART 2 | J.280-J.289 | +| CABLE SET-TOP BOX | J.290-J.299 | +| APPLICATION FOR INTERACTIVE DIGITAL TELEVISION - PART 2 | J.300-J.309 | +| MEASUREMENT OF THE QUALITY OF SERVICE - PART 3 | J.340-J.349 | +| IPCABLECOM2 (SIP-BASED) - PART 1 | J.360-J.379 | +| DIGITAL TRANSMISSION OF TELEVISION SIGNALS - PART 3 | J.380-J.389 | +| MEASUREMENT OF THE QUALITY OF SERVICE - PART 4 | J.440-J.449 | +| IPCABLECOM2 (SIP-BASED) - PART 2 | J.460-J.479 | +| DIGITAL TRANSMISSION OF TELEVISION SIGNALS - PART 4 | J.480-J.489 | +| TRANSPORT OF LARGE SCREEN DIGITAL IMAGERY | J.600-J.699 | +| SECONDARY DISTRIBUTION OF IPTV SERVICES | J.700-J.799 | +| MULTIMEDIA OVER IP IN CABLE | J.800-J.899 | +| TRANSMISSION OF 3-D TV SERVICES | J.900-J.999 | +| CONDITIONAL ACCESS AND PROTECTION | J.1000-J.1099 | +| SWITCHED DIGITAL VIDEO OVER CABLE NETWORKS | J.1100-J.1119 | +| SMART TV OPERATING SYSTEM | J.1200-J.1209 | +| IP VIDEO BROADCAST | J.1210-J.1219 | +| CABLE SET-TOP BOX - PART 2 | J.1290-J.1299 | +| CLOUD-BASED CONVERGED MEDIA SERVICES FOR IP AND BROADCAST CABLE TELEVISION | J.1300-J.1309 | +| CLOUD-BASED SERVICES FOR IP DELIVERY OVER INTEGRATED BROADBAND CABLE NETWORK | J.1310-J.1319 | +| TELEVISION TRANSPORT NETWORK AND SYSTEM DEPLOYMENT IN DEVELOPING COUNTRIES | J.1400-J.1409 | +| ARTIFICIAL INTELLIGENCE (AI) ASSISTED CABLE NETWORKS | J.1600-J.1649 | + +For further details, please refer to the list of ITU-T Recommendations. + +# Recommendation ITU-T J.1318 + +## Requirements of end-to-end network platforms for cloud-based object wave transmission + +## Summary + +Recommendation ITU-T J.1318 specifies the requirements of an end-to-end (E2E) network platform for cloud-based object wave transmission over integrated broadband cable networks. This Recommendation provides an overview of cloud-based object wave transmission along with detailed requirements regarding service functionality, cloud server capability, network capability, and user equipment capability, which are associated with object wave resolutions. Object waves are a type of data used in holography – a highly realistic 3D display technology. + +A notable example of the application of cloud-based object wave transmission over integrated broadband cable networks is remote communication, allowing users to feel as if individuals in distant locations are physically present with them. Additional use cases include remote education and health care, where an immersive experience and intuitive operations are enabled by the transmission of accurate depth information through these networks. + +## History \* + +| Edition | Recommendation | Approval | Study Group | Unique ID | +|---------|----------------|------------|-------------|--------------------| +| 1.0 | ITU-T J.1318 | 2024-10-29 | 9 | 11.1002/1000/16195 | + +## Keywords + +Hologram, holography, integrated broadband cable networks, object wave. + +--- + +\* To access the Recommendation, type the URL
3 generations | +| 50-50-...-50 Mbit/s | | 422p@ml | 7th generation with shift/I frame | +| 19-19-12 Mbit/s | | 422p@ml | 3rd generation | +| n/a | | n/a | Multi-generation Betacam
with drop-out
(4 or 5, composite/component) | + +**Table I.2 – Test factors, coding technologies and applications for which the VQM method has not shown the specified accuracy** + +| Bit rate | Resolution | Method | Comments | +|------------|------------|--------|-------------| +| 4.5 Mbit/s | | mp@ml | with errors | +| 3 Mbit/s | | mp@ml | with errors | + +**Table I.3 – Test sequences used to determine test factors, coding technologies and applications for which the VQM has shown the specified accuracy** + +| Sequence | Characteristics | +|-----------------|------------------------------------------------------| +| Balloon-pops | film, saturated colour, movement | +| NewYork 2 | masking effect, movement | +| Mobile&Calendar | available in both formats, colour, movement | +| Betes_pas_betes | colour, synthetic, movement, scene cut | +| Le_point | colour, transparency, movement in all the directions | +| Autumn_leaves | colour, landscape, zooming, waterfall movement | +| Football | colour, movement | +| Sailboat | almost still | +| Susie | skin colour | +| Tempete | colour, movement | + +# Appendix II + +## MATLAB Source Code + +(This appendix does not form an integral part of this Recommendation) + +Below is a MATLAB subroutine called `vqm_accuracy.m`. This version scales the subjective data to $[0, 1]$ , applies a polynomial fit of the objective to the scaled subjective data, calculates all the metrics, and plots the VQM frequencies of 'False Tie', 'False Differentiation', 'False Ranking', and 'Correct Decision'. It is sufficient to have Version 5.3.1 of MATLAB (1999) with the Statistics and Optimization toolboxes that are available separately. Software can also be developed that does not use either toolbox. The present code is intended as an illustrative example, and does not include all possible options and fitting functions. + +Usage: At the matlab prompt, for VQM r0 type: + +``` +>load r0.dat +``` + +``` +>vqm_accuracy(r0,-1,0,100,2) +``` + +For VQM r2, type: + +``` +>load r2.dat +``` + +``` +>vqm_accuracy(r2,1,0,100,2) +``` + +Here, `r0.dat` and `r2.dat` are text files that contain a subset of the VQEG 525-line data. Each line in this file corresponds to a situation, and comprises an SRC number, an HRC number, VQM score, number of viewings, mean subjective score, and subjective-score variance. Once the `r0` and `r2.dat` files are loaded, either form of `vqm_accuracy` may be run again. + +In the first calling argument of `vqm_accuracy`, `r0` corresponds to the PSNR model in TR A3, and `r2` corresponds to the PQR model in TR A4. The second argument is 1 if the objective metric indicates worse image quality when it is larger, else the argument is $-1$ . The third and fourth arguments are the nominal best and worst ratings on the native subjective scale. The final argument is the order of the polynomial to which the VQM is fit. + +Source Code: + +``` +function vqm_accuracy (data_in, vqm_sign, best, worst, order) +% MATLAB function vqm_accuracy (data_in, vqm_sign, best, worst, order) +% +% Each row of the input data matrix data_in must be organized as +% [src_id hrc_id vqm num_view mos variance], where +% +% src_id is the scene number +% hrc_id is the hypothetical reference circuit number +% vqm is the video quality metric score for this src_id x hrc_id +% num_view is the number of viewers that rated this src_id x hrc_id +% mos is the mean opinion score of this src_id x hrc_id +% variance is the variance of this src_id x hrc_id +% +% The total number of src x hrc combinations is size(data_in,1). +% +% vqm_sign = 1 or -1 and gives the direction of vqm with respect to +% the common subjective scale. For instance, since "0" is +% no impairment and "1" is maximum impairment on the common +% scale, vqm_sign would be -1 for PSNR since higher values +% of PSNR imply better quality (i.e., this is opposite to +% the common subjective scale). +``` + +``` + +% +% mos and variance will be linarly scaled such that +% best is scaled to zero (i.e., the best subjective rating) +% worst is scaled to one (i.e., the worst subjective rating) +% +% order is the order of the polynomial fit used to map the objective data +% to the scaled subjective data (e.g., order = 1 is a linear fit). +% + +% Number of src x hrc combinations +num_comb = size(data_in,1); + +% Pick off the vectors we will use from data_in +vqm = data_in(:,3); +num_view = data_in(:,4); +mos = data_in(:,5); +variance = data_in(:,6); + +% Scale the subjective data for [0,1] +mos = (mos-best)./(worst-best); +variance = variance./((worst-best)^2); + +% Use long format for more decimal places in printouts +format('long'); + +% Fit the objective data to the scaled subjective data. +% Following code implements monotonic polynomial fitting using optimization +% toolbox routine lsqlin. +% +% Create x and dx arrays. For the dx slope array (holds the derivatives of +% mos with respect to vqm), the vqm_sign specifies the direction of the slope +% that must not change over the vqm range. +x = ones(num_comb,1); +dx = zeros(num_comb,1); +for col = 1:order + x = [x vqm.^col]; + dx = [dx col*vqm.^(col-1)]; +end +% The lsqlin routine uses <= inequalities. Thus, if vqm_sign is -1 (negative +% slope), we are correct but if vqm_sign is +1 (positive slope), we must +% multiple each side by -1. +if (vqm_sign == 1) + dx = -1*dx; +end +fit = lsqlin(x,mos,dx,zeros(num_comb,1)); +fit = flipud(fit)' % organize this fit same as what is output by polyfit + +% vqm fitted to mos +vqm_hat = polyval(fit,vqm); + +% Perform the vqm RMSE calculation using vqm_hat. +vqm_rmse = (sum((vqm_hat-mos).^2)/(num_comb-(order+1)))^0.5 + +% Perform the vqm resolution measurement on both vqm and vqm_hat. +vqm_pairs = repmat(vqm,1,num_comb)-repmat(vqm',num_comb,1); +vqm_hat_pairs = repmat(vqm_hat,1,num_comb)-repmat(vqm_hat',num_comb,1); +mos_pairs = repmat(mos,1,num_comb)-repmat(mos',num_comb,1); +stand_err_diff = sqrt(repmat(variance./num_view,1,num_comb)+ ... + repmat((variance./num_view)',num_comb,1)); +z_pairs = mos_pairs./stand_err_diff; + +% Include everything above the diagonal. +delta_vqm = []; +delta_vqm_hat = []; + +``` + +``` + +z = []; +for col = 2:num_comb + delta_vqm = [delta_vqm; vqm_pairs(1:col-1,col)]; + delta_vqm_hat = [delta_vqm_hat; vqm_hat_pairs(1:col-1,col)]; + z = [z; z_pairs(1:col-1,col)]; +end + +% Switch on z and delta_vqm for negative delta_vqm +z_vqm = z; +negs_vqm = find(delta_vqm < 0); +delta_vqm(negs_vqm) = -delta_vqm(negs_vqm); +z_vqm(negs_vqm) = -z_vqm(negs_vqm); + +z_vqm_hat = z; +negs_vqm_hat = find(delta_vqm_hat < 0); +delta_vqm_hat(negs_vqm_hat) = -delta_vqm_hat(negs_vqm_hat); +z_vqm_hat(negs_vqm_hat) = -z_vqm_hat(negs_vqm_hat); + +% Plot scatter plot of z_vqm versus delta_vqm in figure 1. +% Plot scatter plot of z_vqm_hat versus delta_vqm_hat in figure 2. +figure(1) +plot(delta_vqm,z_vqm,'.', 'markersize',1) +set(gca,'LineWidth',1) +set(gca,'FontName','Ariel') +set(gca,'fontsize',12) +xlabel('Delta VQM') +ylabel('Subjective Z Score') +grid on +print -dpng figure1 + +figure(2) +plot(delta_vqm_hat,z_vqm_hat,'.', 'markersize',1) +set(gca,'LineWidth',1) +set(gca,'FontName','Ariel') +set(gca,'fontsize',12) +xlabel('Delta VQM Hat') +ylabel('Subjective Z Score') +grid on +print -dpng figure2 + +% Plot average confidence that vqm(2) is worse than vqm(1) in figure 3. +% Plot average confidence that vqm_hat(2) is worse than vqm_hat(1) in +% figure 4. These are the resolving power plots. +% +% One control parameter for delta_vqm resolution plot; number of vqm bins +% equally spaced from min(delta_vqm) to max(delta_vqm). +% Sliding neighborhood filter with 50% overlap means that there will actually +% be vqm_bins*2-1 points on the delta_vqm resolution plot. +cdf_z_vqm = .5+erf(z_vqm/sqrt(2))/2; +cdf_z_vqm_hat = .5+erf(z_vqm_hat/sqrt(2))/2; + +vqm_bins = 10; % How many bins to divide full vqm range for local averaging +vqm_low = min(delta_vqm); % lower limit on delta_vqm +vqm_high = max(delta_vqm); % upper limit on delta_vqm +vqm_step = (vqm_high-vqm_low)/vqm_bins; % size of delta_vqm bins + +vqm_hat_low = min(delta_vqm_hat); +vqm_hat_high = max(delta_vqm_hat); +vqm_hat_step = (vqm_hat_high-vqm_hat_low)/vqm_bins; + +% lower, upper, and center bin locations +low_limits = [vqm_low:vqm_step/2:vqm_high-vqm_step]; +high_limits = [vqm_low+vqm_step:vqm_step/2:vqm_high]; +centers = [vqm_low+vqm_step/2:vqm_step/2:vqm_high-vqm_step/2]; + +``` + +``` + +hat_low_limits = [vqm_hat_low:vqm_hat_step/2:vqm_hat_high-vqm_hat_step]; +hat_high_limits = [vqm_hat_low+vqm_hat_step:vqm_hat_step/2:vqm_hat_high]; +hat_centers = [vqm_hat_low+vqm_hat_step/2:vqm_hat_step/2: ... + vqm_hat_high-vqm_hat_step/2]; + +mean_cdf_z_vqm = zeros(1,2*vqm_bins-1); +mean_cdf_z_vqm_hat = zeros(1,2*vqm_bins-1); +for i=1:2*vqm_bins-1 + in_bin = find(low_limits(i) <= delta_vqm & delta_vqm < high_limits(i)); + hat_in_bin = find(hat_low_limits(i) <= delta_vqm_hat & ... + delta_vqm_hat < hat_high_limits(i)); + mean_cdf_z_vqm(i) = mean(cdf_z_vqm(in_bin)); + mean_cdf_z_vqm_hat(i) = mean(cdf_z_vqm_hat(hat_in_bin)); +end + +% The x-axis is vqm(2)-vqm(1). For figure 3 (the vqm plot), if vqm_sign is +% 1, then the Y-axis is the average confidence that vqm(2) is worse than +% vqm(1). On the other hand, if vqm_sign is -1, then the Y-axis is the +% average confidence that vqm(1) is worse than vqm(2). Figure 4 is the plot +% for vqm_hat, and since it always has the same sign as mos, the Y-axis is +% always the average confidence that vqm_hat(2) is worse than vqm_hat(1). +if (vqm_sign == 1) + figure(3) + % VQM resolving power + plot(centers,mean_cdf_z_vqm) + grid + set(gca,'LineWidth',1) + set(gca,'FontName','Ariel') + set(gca,'fontsize',11) + xlabel('VQM(2)-VQM(1)') + ylabel('Average Confidence VQM(2) is worse than VQM(1)') + print -dpng figure3 +else + figure(3) + % VQM resolving power + plot(centers,1-mean_cdf_z_vqm) + grid + set(gca,'LineWidth',1) + set(gca,'FontName','Ariel') + set(gca,'fontsize',11) + xlabel('VQM(2)-VQM(1)') + ylabel('Average Confidence VQM(1) is worse than VQM(2)') + print -dpng figure3 +end + +figure(4) +% VQM Hat resolving power. +plot(hat_centers,mean_cdf_z_vqm_hat) +grid +set(gca,'LineWidth',1) +set(gca,'FontName','Ariel') +set(gca,'fontsize',11) +xlabel('VQM Hat(2) - VQM Hat(1)') +ylabel('Average Confidence VQM Hat(2) is worse than VQM Hat(1)') +print -dpng figure4 + +% This portion of the code calculates and plots the relative frequencies of +% three types of classification errors. A classification error is made when +% the subjective test and the VQM lead to different conclusions on a pair +% of data points. +% +% Background: For any subjective test, one must set a threshold that will +% determine when two results are statistically equivalent, and when they are + +``` + +``` + +% statistically distinguishable. Then for each pair of data points (A,B), +% the subjective test can yield one of three possible outcomes: (1) A better +% than B, (2) A same as B, and (3) A worse than B. +% +% If we define a similar threshold for VQM values, we have the same +% situation. For each pair of data points, VQM can yield one of three +% possible outcomes: (1) A better than B, (2) A same as B, and (3) A worse +% than B. Since each pair of data points undergoes three-way classification +% by the subjective test and three-way classification by the VQM, there are +% nine possible outcomes. For three of these outcomes, the subjective test +% and the VQM agree. If we take the subjective test to be correct by +% definition, and the VQM to be under test, then we say that for these three +% outcomes, the VQM is correct. In two other cases the VQM has committed the +% "false-tie" error (subjective test says A better than B, or A worse than B, +% but VQM says A same as B). In two other cases the VQM has committed the +% "false differentiation" error (subjective test says A same as B, but VQM +% says A better than B, or A worse than B.) Finally, there are two cases +% where the VQM has performed a false ranking (subjective test says A better +% than B, or A worse than B, but VQM says the opposite.) Thus, all nine +% outcomes are accounted for. Note that a three by three grid in +% (delta_vqm, subjective Z score) space describing the above could be drawn. +% +% In the code below, the threshold used for the subjective test is subj_th. +% The threshold used for the delta VQM is vqm_th and this is left as a free +% parameter. The code plots the frequency of occurrence for the three +% different kinds of errors and for no error vs. vqm_th. An optimal value of +% vqm_th might be one that maximizes the frequency of occurrence of no error, +% or one that minimizes a cost-weighted sum of the errors. Note that in +% general, it is likely that false ties will be the least offensive error, +% false differentiations will be more offensive, and false rankings will be +% the worst sort of error. +% +% For more details, see S. Voran, "Techniques for Comparing Objective and +% Subjective Speech Quality Tests," Proceedings of the Speech Quality +% Assessment Workshop, Bochum, Germany, November 1994. +% +% Note: The nine outcomes and the three by three grid in (delta_vqm, +% subjective Z score) space is the most natural way to describe this +% analysis. This assumes bipolar values for delta_vqm. But the code has +% already taken the absolute value of delta_vqm (and replaced Z with -Z for +% all points with negative values of delta_vqm). This does not change the +% math, but the more natural description of the situation is now 6 outcomes +% and a 2 by 3 grid. Two correct outcomes (A better than B and A worse +% than B) have been folded on top of each other. There are still two false +% tie outcomes, but only one false differentiation outcome and one false +% ranking outcome. + +% Figure 5 is the plot for vqm and figure 6 is the plot for vqm_hat. +subj_th = 1.6; % 95 percent confidence +num_th = 50; % number of delta_vqm thresholds to examine +vqm_th_list = [vqm_low:(vqm_high-vqm_low)/num_th:vqm_high]; +vqm_hat_th_list = [vqm_hat_low:(vqm_hat_high-vqm_hat_low)/num_th: ... + vqm_hat_high]; +rel_freqs = zeros(vqm_bins+1,4); +rel_hat_freqs = zeros(vqm_bins+1,4); +for i = 1:num_th+1 + vqm_th = vqm_th_list(i); + vqm_hat_th = vqm_hat_th_list(i); + % Number of data points in the false tie region + rel_freqs(i,1) = length(find((delta_vqm < vqm_th) & ... + (subj_th <= abs(z_vqm))))); + rel_hat_freqs(i,1) = length(find((delta_vqm_hat < vqm_hat_th) & ... + (subj_th <= abs(z_vqm_hat))))); + % Number of data points in the false differentiation region + +``` + +``` + +rel_freqs(i,2) = length(find((vqm_th <= delta_vqm) & ... + (abs(z_vqm) < subj_th))); +rel_hat_freqs(i,2) = length(find((vqm_hat_th <= delta_vqm_hat) & ... + (abs(z_vqm_hat) < subj_th))); +% Number of data points in the false ranking region +if (vqm_sign == 1) + rel_freqs(i,3) = length(find((vqm_th <= delta_vqm) & ... + (z_vqm <= -subj_th))); +else + rel_freqs(i,3) = length(find((vqm_th <= delta_vqm) & ... + (z_vqm >= subj_th))); +end +rel_hat_freqs(i,3) = length(find((vqm_hat_th <= delta_vqm_hat) & ... + (z_vqm_hat <= -subj_th))); +end +% Normalize counts by total number of points to get relative frequencies +rel_freqs = rel_freqs/length(z_vqm); +rel_hat_freqs = rel_hat_freqs/length(z_vqm_hat); +% Calculate relative frequency of correctness +rel_freqs(:,4) = (1-sum(rel_freqs(:,1:3)))'; +rel_hat_freqs(:,4) = (1-sum(rel_hat_freqs(:,1:3)))'; + +% Figure 5 is plot for vqm and figure 6 is plot for vqm_hat. +figure(5) +% VQM Subjective Classification Errors +plot(vqm_th_list,rel_freqs(:,1),'m-.', vqm_th_list,rel_freqs(:,2),'r:', ... + vqm_th_list,rel_freqs(:,3),'k-',vqm_th_list,rel_freqs(:,4),'b--'); +grid +set(gca,'LineWidth',1) +set(gca,'FontName','Ariel') +set(gca,'fontsize',12) +xlabel('Delta VQM Significance Threshold') +ylabel('Relative Frequencies') +legend('False Tie','False Differentiation','False Ranking','Correct Decision') +print -dpng figure5 + +figure(6) +% VQM Hat Subjective Classification Errors +plot(vqm_hat_th_list,rel_hat_freqs(:,1),'m-.', ... + vqm_hat_th_list,rel_hat_freqs(:,2),'r:', ... + vqm_hat_th_list,rel_hat_freqs(:,3),'k-', ... + vqm_hat_th_list,rel_hat_freqs(:,4),'b--'); +grid +set(gca,'LineWidth',1) +set(gca,'FontName','Ariel') +set(gca,'fontsize',12) +xlabel('Delta VQM Hat Significance Threshold') +ylabel('Relative Frequencies') +legend('False Tie','False Differentiation','False Ranking','Correct Decision') +print -dpng figure6 + +``` + +# Appendix III + +## Data-fitting to a common scale of VQM + +(This appendix does not form an integral part of this Recommendation) + +As discussed in clause 4.2, the objective VQM data ( $O_i$ ) are mapped to a new domain $\hat{O}_i = F(O_i)$ . This domain is derived by fitting $O_i$ to the scaled subjective data ( $\hat{S}_{i*}$ ) using a family of functions $F$ (with fitting parameters) that have the properties of monotonicity and range mapping noted in clause 4.2. The following are three alternative choices for the form of $F$ , together with notes on data fitting using these functional forms. + +### III.1 Polynomial of order M + +A polynomial that is fit to a set of data points is not guaranteed to be monotonic. The MATLAB optimization toolbox has a function `lsqlin` that ensures monotonicity over the extent of the data. However, monotonicity over the existing data domain does not ensure monotonicity over the entire theoretical domain (for example, 0 to infinity). + +### III.2 Logistic function I + +Fitting the objective VQM data ( $O_i$ ) to the scaled subjective data ( $\hat{S}_{i*}$ ) can be done using a logistic function: + +$$\hat{O}_i = F(O_i) = a + b/\{1 + c(O_i + d)^e\}$$ + +where $a$ , $b$ , $c$ , $d$ , and $e$ are fitting parameters. The fit function must be derived by non-linear least squares4. The part of the function to be used is the monotonic part for $O > -d$ (hence constrain $d > -\min(O)$ ), and the s-curve shape appropriate to the data fit is ensured by constraining $e > 1$ . + +In certain cases, at least asymptotically, the perfect score in the native-scale objective model can be made to map to zero (the best score on the subjective scale), and the worst native-scale objective score possible can be made to map to the worst subjective score (unity, on the Common Scale). For example, consider the following case: *Best objective score is zero, worst objective score is infinite*. Here zero maps to zero and infinity maps to 1, so $a = 1$ and $b = -(1 + cd^e)$ , hence: + +$$F(O_i) = 1 - (1 + cd^e)/\{1 + c(O_i + d)^e\}$$ + +Fitting would take place on $c$ , $d$ , $e$ , subject to $d, e > 0$ . + +### III.3 Logistic function II + +Fitting the objective VQM data ( $O_i$ ) to the scaled subjective data ( $\hat{S}_{i*}$ ) can also be done using a logistic function: + +$$\hat{O}_i = F(O_i) = a + (b-a)/\{1 + \exp[-c(O_i - d)]\}$$ + +--- + +4 Constrained least squares non-linear curve fitting can be performed with the MATLAB function `lsqcurvefit`. + +where $a$ , $b$ , $c$ , and $d$ are fitting parameters, and $c > 0$ (ensured by defining $c = |C|$ for real $C$ ). As with Logistic I, the fit function must be derived by non-linear least squares5. + +One might use this optimization in the case noted in III.2: *Best objective score is zero, worst objective score is infinite*. Here, zero maps to zero and infinity maps to 1, so $a = -\exp[-cd]$ and $b = -a \exp[cd]$ . Hence: + +$$F(O_i) = [1 - \exp(-cO_i)] / [1 + \exp\{c(d - O_i)\}]$$ + +Logistic Function II is also useful in the following case (which could arise when $O_i$ is expressed in logarithmic coordinates such as decibels): *Best objective score is infinite, worst objective score is negative-infinite*. In that case infinity must map to 0, and negative infinity must map to 1. Hence $b = 0$ , $a = 1$ , and: + +$$F(O_i) = 1 / [1 + \exp\{c(O_i - d)\}]$$ + +--- + +5 On p. 28 of the VQEG phase-1 final report (ITU-T Tutorial), the initial values for the parameters were chosen as $a =$ minimum subjective score, $b =$ maximum subjective score, $c = 1$ , and $d =$ mean objective score. A modified version of Logistic Function II was also used that accounted for differences in the variances of the subjective ratings. + +# Bibliography + +- [b-Voran] S. Voran (1994), *Techniques for Comparing Objective and Subjective Speech Quality Tests*, Proceedings of the Speech Quality Assessment Workshop, Bochum, Germany, November. + + + +## SERIES OF ITU-T RECOMMENDATIONS + +| | | +|-----------------|----------------------------------------------------------------------------------------------------| +| Series A | Organization of the work of ITU-T | +| Series D | General tariff principles | +| Series E | Overall network operation, telephone service, service operation and human factors | +| Series F | Non-telephone telecommunication services | +| Series G | Transmission systems and media, digital systems and networks | +| Series H | Audiovisual and multimedia systems | +| Series I | Integrated services digital network | +| Series J | Cable networks and transmission of television, sound programme and other multimedia signals | +| Series K | Protection against interference | +| Series L | Construction, installation and protection of cables and other elements of outside plant | +| Series M | Telecommunication management, including TMN and network maintenance | +| Series N | Maintenance: international sound programme and television transmission circuits | +| Series O | Specifications of measuring equipment | +| Series P | Terminals and subjective and objective assessment methods | +| Series Q | Switching and signalling | +| Series R | Telegraph transmission | +| Series S | Telegraph services terminal equipment | +| Series T | Terminals for telematic services | +| Series U | Telegraph switching | +| Series V | Data communication over the telephone network | +| Series X | Data networks, open system communications and security | +| Series Y | Global information infrastructure, Internet protocol aspects and next-generation networks | +| Series Z | Languages and general software aspects for telecommunication systems | \ No newline at end of file diff --git a/marked/J/T-REC-J.1613-202512-I_PDF-E/raw.md b/marked/J/T-REC-J.1613-202512-I_PDF-E/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..be8e0137ee5a74875c9ff79c19574d064c3e0a87 --- /dev/null +++ b/marked/J/T-REC-J.1613-202512-I_PDF-E/raw.md @@ -0,0 +1,447 @@ + + +# Recommendation + +## **ITU-T J.1613 (12/2025)** + +SERIES J: Cable networks and transmission of television, sound programme and other multimedia signals + +Artificial intelligence (AI) assisted cable networks – +Requirements for the set-top box + +--- + +## **The capability framework and requirements of cloud gaming smart terminals** + + + +The logo of the International Telecommunication Union (ITU), featuring the letters 'ITU' in blue inside a circular emblem with a globe and network lines. + +ITU logo + +## ITU-T J-SERIES RECOMMENDATIONS + +### **Cable networks and transmission of television, sound programme and other multimedia signals** + +| | | +|-------------------------------------------------------------------------------------------------|----------------------| +| GENERAL RECOMMENDATIONS | J.1-J.9 | +| GENERAL SPECIFICATIONS FOR ANALOGUE SOUND-PROGRAMME TRANSMISSION | J.10-J.19 | +| PERFORMANCE CHARACTERISTICS OF ANALOGUE SOUND-PROGRAMME CIRCUITS | J.20-J.29 | +| EQUIPMENT AND LINES USED FOR ANALOGUE SOUND-PROGRAMME CIRCUITS | J.30-J.39 | +| DIGITAL ENCODERS FOR ANALOGUE SOUND-PROGRAMME SIGNALS - PART 1 | J.40-J.49 | +| DIGITAL TRANSMISSION OF SOUND-PROGRAMME SIGNALS | J.50-J.59 | +| CIRCUITS FOR ANALOGUE TELEVISION TRANSMISSION | J.60-J.69 | +| ANALOGUE TELEVISION TRANSMISSION OVER METALLIC LINES AND INTERCONNECTION WITH RADIO-RELAY LINKS | J.70-J.79 | +| DIGITAL TRANSMISSION OF TELEVISION SIGNALS | J.80-J.89 | +| ANCILLARY DIGITAL SERVICES FOR TELEVISION TRANSMISSION | J.90-J.99 | +| OPERATIONAL REQUIREMENTS AND METHODS FOR TELEVISION TRANSMISSION | J.100-J.109 | +| INTERACTIVE SYSTEMS FOR DIGITAL TELEVISION DISTRIBUTION (DOCSIS FIRST AND SECOND GENERATIONS) | J.110-J.129 | +| TRANSPORT OF MPEG-2 SIGNALS ON PACKETIZED NETWORKS | J.130-J.139 | +| MEASUREMENT OF THE QUALITY OF SERVICE - PART 1 | J.140-J.149 | +| DIGITAL TELEVISION DISTRIBUTION THROUGH LOCAL SUBSCRIBER NETWORKS | J.150-J.159 | +| IPCABLECOM (MGCP-BASED) - PART 1 | J.160-J.179 | +| DIGITAL TRANSMISSION OF TELEVISION SIGNALS - PART 1 | J.180-J.189 | +| CABLE MODEMS AND HOME NETWORKING | J.190-J.199 | +| APPLICATION FOR INTERACTIVE DIGITAL TELEVISION - PART 1 | J.200-J.209 | +| INTERACTIVE SYSTEMS FOR DIGITAL TELEVISION DISTRIBUTION (DOCSIS THIRD TO FIFTH GENERATIONS) | J.210-J.229 | +| MULTI-DEVICE SYSTEMS FOR CABLE TELEVISION | J.230-J.239 | +| MEASUREMENT OF THE QUALITY OF SERVICE - PART 2 | J.240-J.249 | +| DIGITAL TELEVISION DISTRIBUTION THROUGH LOCAL SUBSCRIBER NETWORKS | J.250-J.259 | +| IPCABLECOM (MGCP-BASED) - PART 2 | J.260-J.279 | +| DIGITAL TRANSMISSION OF TELEVISION SIGNALS - PART 2 | J.280-J.289 | +| CABLE SET-TOP BOX | J.290-J.299 | +| APPLICATION FOR INTERACTIVE DIGITAL TELEVISION - PART 2 | J.300-J.309 | +| MEASUREMENT OF THE QUALITY OF SERVICE - PART 3 | J.340-J.349 | +| IPCABLECOM2 (SIP-BASED) - PART 1 | J.360-J.379 | +| DIGITAL TRANSMISSION OF TELEVISION SIGNALS - PART 3 | J.380-J.389 | +| MEASUREMENT OF THE QUALITY OF SERVICE - PART 4 | J.440-J.449 | +| IPCABLECOM2 (SIP-BASED) - PART 2 | J.460-J.479 | +| DIGITAL TRANSMISSION OF TELEVISION SIGNALS - PART 4 | J.480-J.489 | +| TRANSPORT OF LARGE SCREEN DIGITAL IMAGERY | J.600-J.699 | +| SECONDARY DISTRIBUTION OF IPTV SERVICES | J.700-J.799 | +| MULTIMEDIA OVER IP IN CABLE | J.800-J.899 | +| TRANSMISSION OF 3-D TV SERVICES | J.900-J.999 | +| CONDITIONAL ACCESS AND PROTECTION | J.1000-J.1099 | +| SWITCHED DIGITAL VIDEO OVER CABLE NETWORKS | J.1100-J.1119 | +| SMART TV OPERATING SYSTEM | J.1200-J.1209 | +| IP VIDEO BROADCAST | J.1210-J.1219 | +| CABLE SET-TOP BOX - PART 2 | J.1290-J.1299 | +| CLOUD-BASED CONVERGED MEDIA SERVICES FOR IP AND BROADCAST CABLE TELEVISION | J.1300-J.1309 | +| CLOUD-BASED SERVICES FOR IP DELIVERY OVER INTEGRATED BROADBAND CABLE NETWORK | J.1310-J.1319 | +| TELEVISION TRANSPORT NETWORK AND SYSTEM DEPLOYMENT IN DEVELOPING COUNTRIES | J.1400-J.1409 | +| ARTIFICIAL INTELLIGENCE (AI) ASSISTED CABLE NETWORKS | J.1600-J.1649 | +| General requirements for the AI-assisted cable network platform | J.1600-J.1609 | +| Requirements for the set-top box | J.1610-J.1619 | +| Interfaces between the AI-assisted cable network platform and set-top box | J.1620-J.1629 | +| Data models of the communicated data for the AI-assisted cable network platform | J.1630-J.1639 | +| Migration and applications of the AI-assisted cable networks | J.1640-J.1649 | + +For further details, please refer to the list of ITU-T Recommendations. + +# Recommendation ITU-T J.1613 + +## The capability framework and requirements of cloud gaming smart terminals + +## Summary + +It is necessary to develop a Recommendation to ensure that cloud gaming smart terminals from different manufacturers can work seamlessly with various cloud gaming platforms, providing a consistent user experience across multiple devices. This also helps maintain a high-quality gaming experience for users, regardless of the terminal used. Additionally, a standardized approach simplifies meeting requirements for cloud gaming services across different regions, as it is more likely to gain universal acceptance. + +Recommendation ITU-T J.1613 defines the technical requirements at each layer, ultimately promoting the uniformity and standardization of the capability framework for cloud gaming smart terminals. It also serves as a reference guide for manufacturers. + +Focusing on cable television networks, the Recommendation specifies terminal-side capabilities and requirements to ensure interoperability with cloud gaming service platforms, and complements the existing Recommendation ITU-T J.1311. It supports the uniformity and standardization of cloud gaming terminals within the remit of the ITU-T J-series. + +## History \* + +| Edition | Recommendation | Approval | Study Group | Unique ID | +|---------|----------------|------------|-------------|--------------------| +| 1.0 | ITU-T J.1613 | 2025-12-14 | 21 | 11.1002/1000/16608 | + +## Keywords + +Cloud gaming, smart terminal. + +--- + +\* To access the Recommendation, type the URL
Recommendation ITU-T J.1631 ..... | 46 | +| VI.1 | Example of E2E network real-time transmission (RTT) requirements of
cloud VR..... | 46 | +| VI.2 | Example of network delay jitter requirements of cloud VR..... | 46 | +| VI.3 | Example of network bandwidth requirements of cloud VR..... | 46 | +| VI.4 | Example of network packet loss requirements of cloud VR ..... | 47 | +| | Bibliography..... | 48 | + +# Introduction + +From a biological perspective there are about 100 000 nerve cells in the ear while there are more than 120 million nerve cells in the eye, which is 1 200 times that of the ear. This huge gap in the number of nerve cells is reflected in the gap in the amount of external information processed. To paraphrase the saying "A picture is worth a thousand words and video can be used to convey so much more". The eye is the most important way for humans to perceive the world, so video may be considered a rigid requirement of consumers. + +From the perspective of communication, the ear is the entrance to auditory perception, connecting the era of speech while the eye is the entrance to visual perception, connecting the era of video. In the digital era, just 64 kbit/s of network bandwidth is required to deliver clear vocal communication. High-definition video however requires more than 10 Mbit/s of network bandwidth. Today audio has been developed to the extreme and 22.2 Hz immersive audio has reached the limits of human hearing; video however ranges from black and white to colour, from standard definition to high definition, from 4 K to 8 K, and also comprises augmented reality (AR), virtual reality (VR) and certainly further developments in the future. Video services demand is still a long way from being satisfied. In the current information explosion era, video is the main carrier of information, and video demand has become a global, universal demand. + +High-definition video will be ubiquitous in the future. Consumers' evaluations of the quality of the broadband network will gradually shift from concern with the original voice quality and the Internet speed to the video viewing experience. Building a core network with a quality video experience is an issue that operators must address in order to enhance their brand influence and market competitiveness, so as to achieve sustainable business success. + +How is the network performance and video viewing experience to be evaluated? Different video services (4K, 8K, VR, AR, etc.) have different network performance requirements which are evaluated by network key performance indicators (KPIs). Also, different video services for user experience have different quality requirements to be evaluated by service key quality indicators (KQIs). In this Recommendation, the scope of KPIs for network performance and KQIs for user experience will be described, and the measurement and monitoring methods will be defined. + + + +## End-to-end network characteristics requirement for video services over integrated broadband cable network + +# 1 Scope + +In this Recommendation, the scope of key performance indicators (KPIs) for cable integrated broadband network performance and key quality indicators (KQIs) for user experience for traditional video services such as Internet protocol television (IPTV) and Internet video and advanced video services such as augmented reality (AR), cloud virtual reality (VR) video and multi-view video, etc., are described, and the measurement and monitoring methods are defined. + +This Recommendation provides a framework for defining video service requirements based on a KPIs and KQIs approach when cable or hybrid networks are used for distribution of television and sound programmes and advanced content delivery. Such services include video services, encompassing both traditional video services such as IPTV and Internet video, as well as cutting-edge video applications such as augmented reality (AR), virtual reality (VR) in the cloud, and multi-view video (MV). + +These KPIs will play a crucial role in quantifying and assessing the efficiency, reliability, and capacity of these networks to support advanced video services. Also, their monitoring and measurement provide the possibility to multi-QoS optimization thus enabling optimization of network performance and more flexible/adaptive usage of network resources for conventional and advanced video services such as AR, VR, etc. Such key performance indicators (KPI) as well as their monitoring and management can be used for multi-QoS optimization thus enabling AI functions over integrated broadband cable network. + +In addition, this Recommendation will delve into the intricacies of key quality indicators (KQIs) related to user experience when accessing a wide range of video services. The goal is to define KQIs that adequately reflect the varying demands and expectations of users engaging with these services. + +This Recommendation will also provide detailed measurement and monitoring methods, offering a comprehensive framework for assessing the performance and quality of experience for video services. The methods will be designed to accommodate the specific needs and characteristics of each type of video service, ensuring that cable or hybrid networks for distribution of television and sound programmes can meet the demands of today's diverse and rapidly evolving video landscape, while enhancing the user experience across the board. + +# 2 References + +The following ITU-T Recommendations and other references contain provisions which, through reference in this text, constitute provisions of this Recommendation. At the time of publication, the editions indicated were valid. All Recommendations and other references are subject to revision; users of this Recommendation are therefore encouraged to investigate the possibility of applying the most recent edition of the Recommendations and other references listed below. A list of the currently valid ITU-T Recommendations is regularly published. The reference to a document within this Recommendation does not give it, as a stand-alone document, the status of a Recommendation. + +- [ITU-T G.1035] Recommendation ITU-T G.1035 (2021), *Influencing factors on quality of experience for virtual reality services*. +- [ITU-T G.1036] Recommendation ITU-T G.1036 (2022), *Quality of experience influencing factors for augmented reality services*. +- [ITU-T G.1082] Recommendation ITU-T G.1082 (2009), *Measurement-based methods for improving the robustness of IPTV performance*. + +- [ITU-T J.144] Recommendation ITU-T J.144 (2004), *Objective perceptual video quality measurement techniques for digital cable television in the presence of a full reference*. +- [ITU-T J.241] Recommendation ITU-T J.241 (2005), *Quality of service ranking and measurement methods for digital video services delivered over broadband IP networks*. +- [ITU-T J.341] Recommendation ITU-T J.341 (2016), *Objective perceptual multimedia video quality measurement of HDTV for digital cable television in the presence of a full reference*. +- [ITU-T J.1631] Recommendation ITU-T J.1631 (2021), *Functional requirements of E2E network platforms to enhance the delivery of cloud-VR services over integrated broadband cable networks*. +- [ITU-T P.1201] Recommendation ITU-T P.1201 (2012), *Parametric non-intrusive assessment of audiovisual media streaming quality*. +- [ITU-T P.1202] Recommendation ITU-T P.1201 (2012), *Parametric non-intrusive bitstream assessment of video media streaming quality*. +- [ITU-T P.1204.4] Recommendation ITU-T P.1204.4 (2022), *Video quality assessment of streaming services over reliable transport for resolutions up to 4K with access to full and reduced reference pixel information*. +- [ETSI ES 202 765-4] ETSI ES 202 765-4 V1.2.1 (2014), *Speech and multimedia Transmission Quality (STQ); QoS and network performance metrics and measurement methods; Part 4: Indicators for supervision of Multiplay services*. +- [ETSI GS F5G 005] ETSI GS F5G 005 V1.1.1 (2022), *Fifth Generation Fixed Network (F5G) F5G High-Quality Service Experience Factors Release #1*. +- [ETSI TR 101 578] ETSI TR 101 578 V1.3.1 (2018), *Speech and multimedia Transmission Quality (STQ); QoS aspects of TCP-based video services like YouTube™*. +- [ETSI TS 103 222-2] ETSI TS 103 222-2 V1.2.1 (2019), *Speech and multimedia Transmission Quality (STQ); Reference benchmarking, background traffic profiles and KPIs; Part 2: Reference benchmarking and KPIs for High speed internet*. +- [ETSI TS 103 222-4] ETSI TS 103 222-4 V1.1.1 (2015), *Speech and multimedia Transmission Quality (STQ); Reference benchmarking, background traffic profiles and KPIs; Part 4: Reference benchmarking for IPTV, Web TV and RCS-e Video Share*. +- [ETSI TS 122 105] ETSI TS 122 105 V15.0.0 (2018), *Digital cellular telecommunications system (Phase 2+) (GSM); Universal Mobile Telecommunications System (UMTS); LTE; Services and service capabilities (3GPP TS 22.105 version 15.0.0 Release 15)*. + +# 3 Definitions + +## 3.1 Terms defined elsewhere + +This Recommendation uses the following terms defined elsewhere: + +**3.1.1 augmented reality (AR)** [b-ITU-T J.301]: A type of mixed reality where graphical elements are integrated into the real world in order to enhance user experience and enrich information. + +**3.1.2 group of pictures (GOP)** [b-ITU-T G.1080]: The group of pictures is a group of successive pictures within a MPEG-coded film and/or video stream. Each MPEG-coded film and/or video stream consists of successive GOPs. From the MPEG pictures contained in it, the visible frames are generated. + +**3.1.3 immersion** [ITU-T G.1035]: A psychological state characterized by perceiving oneself to be enveloped by, included in, and interacting with an environment that provides a continuous stream of stimuli and experiences. + +**3.1.4 jitter** [b-ITU-T G.1050]: Variation in packet delay. + +**3.1.5 key performance indicator (KPI)** [b-ISO/IEC 30134-1]: Indicator representing the resource usage effectiveness or efficiency of a given system. + +**3.1.6 latency** [b-ITU-T G.1050]: An expression of how much time it takes for a packet of data to get from one designated point to another. + +**3.1.7 mean opinion score (MOS)** [b-ITU-R BT.1683]: The average subjective quality judgment assigned by a panel of viewers to a processed video clip. + +**3.1.8 motion-to-photon latency** [ITU-T G.1035]: The time it takes between the user moving their head and this motion being reflected on the screen of the head-mounted display (HMD). + +**3.1.9 packet loss** [b-ITU-T G.1050]: The failure of a packet to traverse the network to its destination. Typically, packet loss is caused by packet discards due to buffer overflow. This model does not take into account packet loss due to discards in the terminal jitter buffer. + +**3.1.10 platform** [b-ITU-T G.1081]: A hardware and/or software architecture that serves as a foundation or base for realizing a certain functionality. + +**3.1.11 quality of experience (QoE)** [b-ITU-T P.10]: The degree of delight or annoyance of the user of an application or service. + +**3.1.12 quality of service (QoS)** [b-ITU-T J.145]: The collective effect of service performances which determine the degree of satisfaction of a user of the service. + +NOTE – The quality of service is characterized by the combined aspects of service support performance, service operability performance, service integrity and other factors specific to each service. + +**3.1.13 virtual reality** [b-ITU-R BT.2420-0]: A technology that replicates an environment, real or imagined, and simulates a user's physical presence and environment to allow for user interaction. Virtual reality artificially creates a sensory experience, which in principle can include sight, touch, hearing, and smell. The current VR devices primarily present content to the visual and auditory systems. On occasion, haptics information is also included. + +## 3.2 Terms defined in this Recommendation + +This Recommendation defines the following term: + +**3.2.1 IP packet loss ratio (IPLR)**: The ratio of the total lost IP packet outcomes to total transmitted IP packets in a population of interest. + +NOTE 1 – Based on [b-ITU-T X.149]. + +NOTE 2 – "Lost IP packet outcomes" and "Populations of Interest" are defined in Recommendation ITU-T Y.1540. + +# 4 Abbreviations and acronyms + +This Recommendation uses the following abbreviations and acronyms: + +A-PSNR Average PSNR + +AR Augmented Reality + +| | | +|---------|--------------------------------------------------| +| BLER | Block Error Ratio | +| CEP | Comfortable Experience Phase | +| CPE | Consumer Premises Equipment | +| DASH | Dynamic Adaptive Streaming over HTTP | +| E2E | End-To-End | +| E-PSNR | Edge Peak Signal-to-Noise Ratio | +| FEC | Forward Error Correction | +| FEP | Fair Experience Phase | +| GOP | Group of Pictures | +| HMD | Head-Mounted Display | +| IEP | Ideal Experience Phase | +| IP | Internet Protocol | +| IPLR | IP Packet Loss Ratio | +| IPTV | Internet Protocol Television | +| KPI | Key Performance Indicator | +| KQI | Key Quality Indicator | +| MBLER | Macro Block Error Ratio | +| MOS | Mean Opinion Score | +| MPEG | Motion Picture Expert Group | +| MTU | Maximum Transmission Unit | +| PLR | Packet Loss Rate | +| PSI/ SI | Program-Specific Information/Service Information | +| PSNR | Peak Signal-to-Noise Ratio | +| PxER | Pixel Error Ratio | +| RTP | Real-Time Protocol | +| RTT | Real-Time Transmission | +| SLER | Slice Error Ratio | +| SSIM | Structural Similarity | +| STB | Set-Top-Box | +| TCP | Transmission Control Protocol | +| UDP | User Datagram Protocol | +| UEP | Ultimate Experience Phase | +| VR | Virtual Reality | +| VQM | Video Quality Metrics | + +# 5 Conventions + +In this Recommendation: + +The keywords "is required to" indicate a requirement that must be strictly followed and from which no deviation is permitted if conformance to this document is to be claimed. + +The keywords "is recommended" indicate a requirement that is recommended but which is not absolutely required. Thus, this requirement need not be present to claim conformance. + +The keywords "is prohibited from" indicate a requirement that must be strictly followed and from which no deviation is permitted if conformance to this Recommendation is to be claimed. + +The keywords "is optionally required" indicate an optional requirement that is permissible, without implying any sense of being recommended. This term is not intended to imply that the vendor's implementation must provide the option and the feature can be optionally enabled by the network operator/service provider. Rather, it means the vendor may optionally provide the feature and still claim conformance with the specification. + +The keywords "mandatorily" indicate a mandatory requirement which is recommended in any sense. This term is intended to imply that the vendor must implement the option and the feature. Otherwise, the vendor cannot declaim conformance with the specification. + +In the body of this Recommendation, the words *shall*, *shall not*, *should*, and *may* sometimes appear, in which case they are to be interpreted, respectively, as **is required to**, **is prohibited from**, **is recommended**, and **can optionally**. The appearance of such phrases or keywords in an appendix or in material explicitly marked as informative are to be interpreted as having no normative intent. + +# 6 Key performance indicators (KPI) + +Different networks have different levels of network performance or quality. Quality of service (QoS) defines the network quality in terms of quantitative network performance parameters called key performance indicators (KPIs) as shown in Figure 1. + + + +| | | +|-----------------------------------------------------------------------------------------------------------------------------|---------| +| Bandwidth | Latency | +|
KPI
| |
+| Packet loss | Jitter |
+
+J.1630(24)
+
+Figure 1: Network performance indicators diagram showing a 2x2 grid of Bandwidth, Latency, Packet loss, and Jitter with KPI in the center.
+
+**Figure 1 – Network performance indicators**
+
+## KPI parameters:
+
+**Bandwidth:** The amount of traffic that can be transmitted in a fixed amount of time.
+
+**Packet loss:** The number of packets that are successfully received, or not, at the destination.
+
+**Latency:** The total time it takes for a packet to travel from source to destination.
+
+**Jitter:** The latency variation.
+
+Based on the above KPI parameters, the network quality can be displayed to operators or users.
+
+## 6.1 Video services
+
+### 6.1.1 General approach to estimate KPIs
+
+Key performance indicators (KPIs) for network video services depend on a number of factors such as transmission protocols including for example pure user datagram protocol (UDP), real-time protocol (RTP), and application FEC-based transmission (e.g., ProMPEG), equipment configurations such as for example maximum transmission unit (MTU) size as a bandwidth related parameter, and motion picture expert group (MPEG) compression encoder configuration, etc.
+
+KPIs indirectly influence key quality indicators (KQIs) in terms of visual quality and MPEG decoding quality. A better way to estimate such influence is to use AI-based objective or human-based
+
+subjective metrics for video quality. In such cases, it is possible to get estimates that are correlated to the maximum extent to user reactions to such failures and that provide adequate reaction to such events on an automated basis.
+
+There are two approaches that can be used for monitoring failures appearing in end-to-end (E2E) video systems: a low-complexity indirect approach and a metrics-based approach. The choice of approach depends on the network operator view and the quality monitoring system architecture.
+
+The low-complexity indirect approach is based on video frame impairment analysis (frozen frames, blackness, slices appearing, etc.). After failures appear they can be notified by such monitoring systems but it is necessary in any case to further indicate the type of impairment with related measurements. This approach then can be used as a first stage fast approach to indicate that something is going wrong with the KPI.
+
+For a network operator the usage of objective metrics is the most optimal approach and is already used in most monitoring equipment. Such an approach ensures a relatively reliable way to monitor network performance that is correlated to user quality interpretation and fixes the moments and points of network failures for further reaction. The choice of objective metrics depends on the network operator's experience and choice of measurement equipment, etc. There are a variety of objective metric variants such as edge peak signal-to-noise ratio (E-PSNR) or average PSNR (A-PSNR), structural similarity (SSIM), pixel error ratio (PxER), video quality metrics (VQM), etc. Also, usage of models and approaches defined in [ITU-T P.1201], [ITU-T P.1202], and [ITU-T P.1204.4] is possible for streaming applications.
+
+Taking into account that the expected influence of network failures is failures in the structure and content of the video picture structure (errors in MPEG slices/macro blocks, etc.) the best approach is to use metrics correlated to the video picture structure. It must be considered that some metrics use a full reference approach so that in the case of a linear TV service it is difficult to implement such a monitoring system directly. To overcome this problem an embedded or separate monitoring channel with a reference image/signal delivery for measurement purposes can be used (see Appendix I). Such a virtual measurement channel is simply identified in an IP stream and is not displayed for the user but will show current network statistics and performance directly.
+
+It is worth noting that, in the realm of quality assessment, obtaining concrete and universally applicable metrics can be a challenging endeavour. The multifaceted nature of network configurations, the wide array of encoder parameters, and the ever-evolving technological landscape make it difficult to establish a one-size-fits-all standard for quality assessment.
+
+In this dynamic environment, relying on empirical, experimental evaluations becomes imperative. These assessments serve as a means to explore the nuanced relationships between network configurations and the resulting quality of service. They allow gauging of the impact of varying parameters and configurations on the user's quality of experience. The wealth of data generated through such experiments enables stakeholders to gain valuable insights into the thresholds of distortion and performance limitations.
+
+Moreover, as network technologies and user expectations continue to evolve, these experimental assessments provide a flexible and adaptive framework for staying ahead of the curve. By monitoring and experimenting with different setups, the ever-changing landscape of network configurations and encoding parameters can be adapted, ensuring that quality remains at the forefront of service provision.
+
+In summary, experimental evaluations serve as a vital tool in quality assessment, offering a dynamic means of navigating the intricate web of network settings and encoder parameters. They provide the foundation for understanding and setting of distortion thresholds and are indispensable in the pursuit of delivering the best possible quality of experience to end-users.
+
+### 6.1.2 Bandwidth influence
+
+Changing the available bit-rate in a network can have a significant impact on the transmitted video traffic. The bit-rate of video traffic determines the number of bits transmitted per second and is a key parameter for high-quality video playback. The impact of bit-rate changes can be both positive and negative, depending on whether the available network bandwidth increases or decreases.
+
+Decreasing available bit-rate: If the available network bandwidth decreases, video traffic may face limitations and constraints such as:
+
+- 1) Reduced video quality: Lower bit-rates can lead to loss of detail and resolution in the video, resulting in lower playback quality.
+- 2) Potential artifacts: Video compression at lower bit-rates can introduce artifacts such as blocks or blurriness, particularly in fast-moving objects.
+- 3) Buffering and delays: Insufficient bit-rate for smooth playback can lead to video buffering and delays, degrading the user experience.
+
+Methods for bandwidth control that can be a good solution for bit-rate control are listed in Appendix I. Periodic or separate measurements of available bandwidth are recommended. Guidelines for bandwidth measurement are provided in clause I.3.
+
+### 6.1.3 IP packet loss
+
+IP packet loss can occur for various reasons, and it can have significant consequences when it comes to video content. An explanation of causes and potential consequences of IP packet loss follows:
+
+- 1) Network congestion: Video networks can experience congestion, similar to any network. When the available bandwidth is fully utilized, packets may be dropped to relieve congestion.
+- 2) Jitter: In cable systems, variations in packet arrival times (jitter) can disrupt the smooth delivery of packets, leading to packet loss. Jitter can be caused by inconsistent signal quality.
+- 3) Signal interference: Interference can occur in cable systems due to factors such as signal attenuation over long cables, impedance mismatches, and electromagnetic interference. This can lead to packet loss.
+- 4) Equipment failures: Hardware failures within the cable infrastructure, such as malfunctioning cable modems, routers, or switches, can result in packet loss.
+
+Consequences of IP packet loss for video service transmission:
+
+- 1) Reduced video quality: Packet loss can degrade the quality of video streams in cable systems, leading to pixilation, artifacts, and a decrease in resolution. The nature of video service signal impairment will depend on the video protocol used and mitigation of failure mechanisms used in the system.
+- 2) Buffering and playback issues: Severe packet loss can cause buffering or interruptions in video playback. Viewers may experience delays, and the content may not stream smoothly.
+- 3) Audio-video synchronization problems: Packet loss can disrupt the synchronization between video and audio streams, causing audio and video to be out of sync.
+- 4) Viewer frustration: Consistent packet loss can frustrate viewers, leading them to abandon the video stream or seek alternative sources for content.
+- 5) Rebuffering: To compensate for packet loss, streaming applications may require retransmissions or increased buffering, resulting in delays and reduced real-time interaction.
+- 6) Content delivery issues: For content providers, IP packet loss can impact the quality of their service, affecting customer satisfaction and potentially leading to subscriber loss.
+- 7) Increased bandwidth usage: Retransmitting lost packets (if used) consumes additional bandwidth, which can strain network resources and increase operational costs in cable systems.
+
+In cable systems, addressing IP packet loss often involves improving the quality of the network infrastructure, optimizing signal quality, and implementing error correction mechanisms to minimize the impact of packet loss on video streaming and other data applications.
+
+In the context of IP packet loss, it is often the case that obtaining precise and universally applicable metrics can be quite a challenging endeavour. The ever-evolving network configurations, the vast array of encoder parameters, and the dynamic nature of data transmission make it difficult to establish a one-size-fits-all standard for assessing packet loss.
+
+Therefore, it becomes necessary to rely on empirical, experimental assessments to gain meaningful insights. These assessments serve as a crucial means of exploring the intricate interplay between network configurations and the resultant quality of service. They allow understanding of the impact of varying parameters, be it in network setup or encoder configurations, on the prevalence of IP packet loss.
+
+To summarize, experimental assessments provide an indispensable tool in the context of IP packet loss, offering a dynamic framework for navigating the complexities of network settings and encoder parameters. They are instrumental in helping to understand and establish thresholds for packet loss, thereby ensuring a high-quality data transmission experience. Possible estimation and methodology for IP packet loss events influence on KPIs is provided in clause I.4 with examples in Appendix III.
+
+### 6.1.4 IP packet duplication
+
+Causes of IP packet duplication in cable systems and its impact on transmission quality:
+
+- 1) **Network redundancy and failures:** In cable systems, network redundancy mechanisms may cause packet duplication. For instance, redundant links or paths in a network can lead to the delivery of the same packet via multiple routes, resulting in duplicate packets at the receiver's end. Also, if network equipment failures exist duplication of packets is possible.
+- 2) **Retransmissions:** Occasionally, network devices or protocols may trigger packet retransmissions due to packet loss or corruption. These retransmissions can result in the duplication of packets in the data stream.
+
+Impact of IP packet duplication on transmission quality in cable systems:
+
+- 1) **Increased bandwidth consumption:** Duplicated packets consume extra bandwidth, which can lead to inefficient network resource utilization, especially in cable systems with limited bandwidth.
+- 2) **Higher processing overhead:** Network devices and receiving systems need to process and identify duplicated packets, leading to increased processing overhead, potentially affecting network performance.
+- 3) **Network congestion:** The presence of duplicated packets can exacerbate network congestion as they compete for limited resources. This can further reduce the overall quality of service for various applications.
+- 4) **Potential for out-of-order packets:** Duplicated packets can lead to confusion in the receiver, as it may need to decide which copy of the packet to use. This can potentially result in out-of-order packet delivery, affecting data integrity.
+- 5) **Reduced efficiency:** Packet duplication diminishes the efficiency of data transmission in cable systems. It can impact the reliability and predictability of data delivery.
+- 6) **Quality of service issues:** In applications like real-time communication and video streaming, IP packet duplication can introduce issues with content synchronization and reduce the overall quality of service.
+
+To mitigate the effects of IP packet duplication, cable system operators and network administrators should implement appropriate network redundancy strategies, such as load balancing, and utilize protocols that can handle packet duplication and out-of-order packets effectively to ensure reliable and efficient data transmission.
+
+Experimental results for packet duplication impairment are provided in Appendix II to this Recommendation.
+
+### 6.1.5 IP packet delay (jitter)
+
+Causes of IP packet delay (jitter) in the context of packet loss and its impact on transmission quality:
+
+- 1) Network congestion: Cable systems, like any network, can experience congestion due to high traffic loads. When congestion occurs, packets may experience varying delays as they contend for available bandwidth. This variability in packet arrival times contributes to jitter.
+- 2) Packet loss and retransmissions: Packet loss can lead to jitter in cable systems. When a packet is lost, it may need to be retransmitted, causing a delay before the receiver finally receives the packet. This delay introduces jitter, especially in real-time applications.
+- 3) Varying path lengths: In cable systems, packets may take different paths to reach their destination. These varying path lengths can result in differing transmission times, leading to jitter when packets arrive at different times.
+- 4) Signal interference: Signal interference or noise in cable systems can affect the consistency of packet delivery, causing packets to experience delays. Interference can result from external factors such as electrical interference or signal degradation over long cables.
+
+Impact of IP packet delay (jitter) on transmission quality in cable systems:
+
+- 1) Reduced quality for real-time applications: Jitter can negatively impact real-time applications by causing variable delays in packet delivery. This can result in synchronization issues, choppy audio or video, and a generally poorer user experience.
+- 2) Buffering requirements: To mitigate the effects of jitter, receiving systems may require larger buffers, which can increase latency and affect the responsiveness of video streaming and interactive applications.
+- 3) Synchronization issues: Jitter can lead to out-of-sync audio and video streams in multimedia content, causing content delivery problems and making it less enjoyable for users.
+- 4) Packet loss: High jitter levels can exacerbate the risk of packet loss, as packets arriving too late may be discarded if they are no longer relevant, further degrading transmission quality.
+- 5) Increased complexity: To cope with jitter, network equipment and applications may need to employ more complex buffering, error correction, and synchronization mechanisms, increasing the overall complexity of the system.
+- 6) Challenges for quality of service (QoS): Maintaining consistent quality of service becomes more challenging in the presence of jitter, making it important for cable system operators to manage and minimize its effects to meet user expectations.
+
+To address jitter in cable systems, network operators can implement QoS mechanisms, prioritize real-time traffic, and employ buffering and error correction techniques to reduce the impact of variable packet delays on transmission quality.
+
+The presence of experimental research on the impact of IP packet jitter in the context of QoS assessment serves several crucial purposes and enables the following:
+
+- 1) Establishing of thresholds for tolerable jitter: Experiments enable the determination of thresholds beyond which jitter begins to negatively impact QoS. This is essential for defining the level of jitter at which service quality remains acceptable.
+- 2) Optimizing network settings: Research can be used to optimize network settings and data transmission parameters to minimize jitter. This helps to improve QoS and provide a more stable user experience.
+
+- 3) Adapting to changes: In a constantly evolving technological and network environment, experiments help to remain flexible and adapt to new challenges. They enable swift responses to changes and optimization of the network infrastructure.
+- 4) Ensuring required KPI: Research into IP packet jitter aids in ensuring high-quality service, which is crucial for meeting user needs and retaining customers.
+
+Measurement methodology and experimental examples on IP packet jitter is provided in clause I.5 and Appendix V.
+
+### 6.1.6 Latency issues
+
+Latency is a critical parameter in network performance evaluation, affecting the quality of service for various applications, including real-time communication and multimedia streaming. This document outlines a general formula for latency calculations, encompassing the key components of encoding delay, transmission delay, and receiver delay, as per the guidelines provided in [b-ETSI TR 101 290] and other relevant documents.
+
+- 1) Encoding delay ( $D_{ENC}$ ): The encoding delay represents the time taken to process and encode data or media content before it is transmitted. It comprises tasks such as compression, formatting, and any other preprocessing necessary for data transmission.
+- 2) Transmission delay ( $D_{TR}$ ): The transmission delay includes the time taken for data packets to traverse the network, including processing within network nodes and switching delays. It is influenced by the network's topology, traffic load, and various network-specific factors.
+- 3) Receiver delay ( $D_{REC}$ ): The receiver delay encompasses the time taken for the receiver to buffer and decode incoming data, ensuring a seamless playback or display. Receiver delays may vary based on the receiver's capabilities and buffer sizes.
+
+Total latency ( $D_{TOTAL}$ ): The total latency is the sum of the encoding delay, transmission delay, and receiver delay:
+
+$$D_{TOTAL} = D_{ENC} + D_{TR} + D_{REC}$$
+
+This expression provides a comprehensive means of evaluating latency within a network, enabling service providers to optimize the quality of service for various applications while adhering to industry standards, such as [b-ETSI TR 101 290], and other relevant guidelines.
+
+## 6.2 AR/VR services
+
+Packet loss, packet duplication, and network jitter can all significantly impact the quality of transmitting images in augmented reality (AR) and virtual reality (VR) services over cable networks. Ensuring high-quality AR and VR experiences over cable networks requires minimizing packet loss, controlling packet duplication, and managing network jitter. Implementing a robust network infrastructure with low latency, appropriate error correction, and congestion management techniques is essential to offer immersive and seamless AR and VR content delivery.
+
+Basic concepts of network influence on video service are provided in [ITU-T G.1035], [ITU-T G.1036] and [ITU-T J.1631] for (cloud and conventional) VR and AR respectively. Examples of KPIs for cloud VR services are provided in Appendix IV.
+
+### 6.2.1 Bandwidth influence
+
+**Impact on AR/VR quality:** A decrease in network bandwidth can significantly affect the quality of AR/VR image transmission. AR and VR applications rely on high-resolution and data-intensive imagery to create immersive experiences. When network bandwidth is limited, there is insufficient capacity to transmit these images at the required quality. This can lead to image compression and lower resolution, resulting in a loss of detail and immersion. Users may experience pixilation, artifacts, and a reduced sense of presence in the virtual environment.
+
+**Mitigation strategies:** To mitigate the impact of reduced network bandwidth on AR/VR, adaptive streaming and content delivery optimization techniques can be employed. These methods dynamically adjust image quality based on available bandwidth, delivering the best possible experience within the constraints of the network.
+
+### 6.2.2 IP packet loss
+
+**Impact on AR/VR quality:** Packet loss occurs when data packets fail to reach their destination. In AR and VR applications, even small packet losses can lead to a poor user experience. When image data packets are lost, users may experience artifacts, blurriness, freezing, tiling artefacts or missing parts in their AR/VR content. This can result in a less immersive and less enjoyable experience. Frequent packet loss can make AR/VR applications unusable and lead to user frustration.
+
+**Mitigation strategies:** To mitigate packet loss in cable networks, error correction techniques, forward error correction (FEC), and reliable transport protocols such as transmission control protocol (TCP) can be used. Proper network design and management practices are also essential to reduce congestion and prevent packet loss.
+
+### 6.2.3 Packet duplication
+
+**Impact on AR/VR quality:** Packet duplication can result from network redundancy mechanisms, retransmissions, or misconfigured equipment. In AR/VR, duplicated packets can disrupt the rendering process. The AR/VR system may render the same image multiple times, which can be disorienting for users. Duplicated packets can waste bandwidth, leading to inefficient data transmission.
+
+**Mitigation strategies:** Network redundancy should be carefully managed to prevent excessive duplication. Proper configuration and error detection mechanisms can help identify and discard duplicated packets.
+
+### 6.2.4 Network jitter
+
+**Impact on AR/VR quality:** Network jitter is the variation in packet arrival times. In AR and VR, consistent and low-latency delivery is crucial for a seamless experience. Jitter can lead to inconsistent rendering and synchronization issues between different components of the AR/VR experience. Users may notice jitter in the movement of objects or avatars, causing motion sickness and a disjointed experience.
+
+**Mitigation strategies:** Reducing network jitter involves prioritizing AR/VR traffic, using quality of service (QoS) mechanisms, and employing buffering and adaptive streaming techniques to smooth out the impact of varying packet arrival times.
+
+### 6.2.5 Latency
+
+**Impact on AR/VR quality:** Latency is the time delay between sending data and its receipt. In AR/VR applications, low latency is critical for maintaining the illusion of real-time interaction and preserving the sense of presence. Increased latency can lead to a noticeable delay in the user's actions and the corresponding response within the AR/VR environment. This delay, often referred to as motion-to-photon latency, can result in motion sickness, reduced immersion, and a disjointed user experience. It is also the cause of presentation quality degradation, e.g., long initial loading delay and stalling. Some VR services may offload computing tasks, such as rendering capability, to remote cloud servers to significantly relieve the computing burden from the user's devices, which is at the expense of incurring additional communication delay.
+
+**Mitigation strategies:** To mitigate increased latency in cable networks, low-latency transmission protocols and efficient network routing are essential. Edge computing and content delivery networks (CDNs) can be used to reduce latency by bringing content closer to the user. Additionally, optimizing the rendering pipeline within AR/VR applications can help minimize motion-to-photon latency.
+
+In summary, reduced network bandwidth and increased latency can have a detrimental impact on the quality of AR/VR image transmission over cable networks. Addressing these issues involves a combination of adaptive content delivery, low-latency protocols, and optimization of the entire AR/VR ecosystem, ensuring that users can enjoy immersive and responsive experiences even in bandwidth-constrained and high-latency network environments.
+
+## **6.3 Multi-view video services**
+
+In the context of video services, particularly in the case of multi-view (MV) video services, several network parameters can significantly impact the quality and perception of these images.
+
+In summary, bandwidth directly affects the quality and resolution of multi-view images, while packet loss can introduce visual artifacts and synchronization issues. Efficient network management, including minimizing packet duplication, is necessary to optimize bandwidth usage. Lastly, low latency is critical for maintaining real-time synchronization between different views, ensuring a smooth and immersive multi-view image experience within a video service.
+
+This clause discusses the influence of bandwidth, packet loss, packet duplication, and latency on multi-view images within a video service.
+
+### **6.3.1 Bandwidth**
+
+In the case of MV video service, a higher bandwidth allows for the transmission of more data, resulting in higher image quality. Multi-view images often consist of multiple perspectives or camera views, each requiring substantial data. Limited bandwidth can lead to compression, reducing image resolution and causing artifacts in MV images.
+
+### **6.3.2 Packet loss**
+
+Packet loss can result in missing image data, leading to artifacts, visible gaps, or distortion in MV images. In the context of MV images, the loss of specific data packets can disrupt the synchronization between different views, affecting the overall 3D perception.
+
+### **6.3.3 Packet duplication**
+
+While packet duplication may not directly impact multi-view images, it can affect network efficiency and bandwidth usage. Unnecessary duplication consumes valuable bandwidth that could otherwise be used for transmitting additional image data or views. Efficient packet handling is crucial for optimizing network resources.
+
+### **6.3.4 Latency**
+
+In the case of multi-view images, low latency is essential to maintain real-time synchronization between different camera views. High latency can lead to asynchrony between views, resulting in a disjointed or disorienting 3D experience. Low-latency networks are crucial for providing a seamless multi-view image experience.
+
+# **7 Key quality indicators (KQIs)**
+
+KQIs as a specific metric are recommended for assessing the quality or performance of a service. KQIs are crucial for measuring and monitoring various aspects of service or system operation to ensure that predefined quality standards are met.
+
+KQIs should be chosen based on their significance to the overall quality of a service to track and evaluate critical factors that can directly impact user level of service satisfaction. These indicators help organizations identify areas for improvement, set benchmarks, and make informed decisions to optimize their processes. KQI parameters classification is provided in Annex B to this Recommendation.
+
+Key quality indicators play an indispensable role in the realm of performance evaluation and quality assessment. They serve as specialized metrics meticulously designed to gauge the effectiveness and efficiency of a given service or system. The significance of KQIs lies in their ability to provide a clear and precise snapshot of how well a particular process or service aligns with established quality standards.
+
+In the world of KQIs, the selection process is of paramount importance. KQIs are not chosen haphazardly; rather, they are carefully selected based on their direct relevance to the overarching quality of the system or service in question. These indicators are strategically tailored to track and assess critical factors that have a direct and discernible impact on the satisfaction levels of end users. Whether it's measuring the responsiveness of a customer support system, the reliability of a network, or the accuracy of a manufacturing process, KQIs are designed to act as the sentinel, constantly vigilant in scrutinizing these aspects.
+
+KQIs are not mere numerical values; they are powerful tools that empower organizations to identify areas ripe for enhancement. They serve as a compass, guiding companies towards improvement by offering a clear and data-driven understanding of where they stand in relation to their quality goals. Additionally, KQIs enable the establishment of benchmarks, setting a standard by which progress can be measured and goals can be aspired to. This data-driven approach empowers decision-makers to make informed choices, fine-tuning their processes, and ultimately optimizing the overall quality of their operations.
+
+In essence, KQIs are more than just metrics; they are the bedrock upon which organizations build their quest for excellence. Through these indicators, businesses and service providers can not only meet but consistently exceed the expectations of their customers, ensuring their enduring success in an ever-evolving landscape of quality and performance.
+
+## **KPI and KQI relationship**
+
+KPIs and KQIs are two different yet interconnected aspects of quality in cable video service transmission.
+
+In general, KPI refers to metrics and parameters that assess the technical quality of provided network services. These metrics include parameters such as delay (latency), packet loss, jitter, bandwidth, and other technical network characteristics. Also, KPIs focus on the technical performance of the cable network and cable network management to ensure data transmission stability and reliability. KPIs help to meet the minimum quality requirements for network services.
+
+KQIs however are an evaluation of the quality of a service or user experience. KQIs take into account how users perceive and assess the quality of a service. This includes aspects such as the perceived quality of video, audio, the user interface, and overall user satisfaction. So, KQIs focus on how users perceive and assess the quality of a service and may encompass various aspects, including satisfaction level, comfort level, and interaction satisfaction with the service.
+
+The relationship between KPIs and KQIs lies in the fact that KPI metrics, such as delay, packet loss, and jitter, can directly influence user perception and evaluation (KQI). High delay or packet loss, for example, can lead to a degradation in the quality of video, affecting user satisfaction levels. However, KQI also depends on other factors such as service interaction design, user-friendliness, and user expectations.
+
+In summary, KPIs provide technical metrics to assess network performance, while KQIs focus on evaluating how users actually perceive service quality. The connection between them is that technical network quality can significantly impact user satisfaction, but KQIs also take into account other aspects of the user experience.
+
+Considering the related nature of KPIs and KQIs, if a service enhancement is required for the benefit of customers or end-users, service providers must be aware of the insufficiency of the KQI and should have the ability to determine which specific technical KPI parameters can be enhanced to attain an
+
+improved KQI. Consequently, a KQI metric should be accompanied by the technical prerequisites of a service to serve the interests of service providers effectively.
+
+# **8 Monitoring and measurement**
+
+The choice of monitoring approach depends on network scale and structure.
+
+For wide area networks covering a wide audience, a monitoring probe-based approach with a distributed network of sensors is probably the best approach because in this case the provider can get real-time diagnostic information from a number of distributed remote nodes. In other cases, a single monitoring equipment may be enough due to the small number of points for monitoring.
+
+Considering a multi-layer approach for an E2E video system, monitoring of the related diagnostics can be implemented on different layers (MPEG layer, transport system layer, etc.). Failures on any layer will lead to problems on another so such events can be notified and appropriate actions carried out from the provider side (see also KQI and KPI relationship, clause 6). In the case of deeper analysis of transmitted streams special audio/video analysers can be used but these measurements are basically related to KQI estimations.
+
+Basically, a software-based approach for measurement of KPI performance of a particular network is used. In this case special software modules called agents provide diagnostic information that can be used for performance estimation in a central monitoring station. It is necessary to distinguish between active and passive approaches for monitoring. In the case of passive monitoring, related agents are activated manually and used for periodic non-systematic monitoring of network performance ("as needed" or according to a monitoring plan). Active monitoring foresees the constant reception of diagnostic information. In both cases graphic information on network performance may be available that simplifies analysis, and enables possible failures detection and/or possible predictions of failures appearing in near future due to non-systematic or systematic performance degradation.
+
+A system model and measurement guidelines are provided in Appendix I and other related appendices.
+
+# Appendix I
+
+## Measurement guidelines for KPI estimation
+
+(This appendix does not form an integral part of this Recommendation.)
+
+### I.1 Scope
+
+The purpose of these guidelines is to establish a comprehensive framework for assessing key performance indicators (KPIs) to ensure the optimal quality and efficiency of cable video services. This document defines the scope of the measurement guidelines, providing a clear understanding of the objectives, parameters, and methodologies involved in KPI estimation. It offers guidance on the performance evaluation of cable video services, emphasizing the critical need for accurate and standardized KPI measurements. The scope of these guidelines encompasses various aspects of cable video service, including but not limited to transmission quality, network performance, and user experience. By adhering to these measurement guidelines, cable service providers can effectively monitor, evaluate, and enhance the quality and reliability of their video services, ultimately ensuring a superior viewing experience for consumers.
+
+### I.2 General concept of measurement
+
+A multi-layer approach is reflected as the basic measurement and monitoring model provided in [ITU-T J.241] and is shown here in Figure I.1.
+
+
+
+The diagram illustrates the ITU-T J.241 system measurement model. It consists of three main components: Head-end, IP network, and CPE/STB. The Head-end is divided into Video input, IP streamer, and IP protocol stack. The CPE/STB is divided into IP protocol stack and Decoder. The IP network is represented by an oval containing Network monitoring. Reference points A, B, C, and D are indicated by circles. A line connects the Video input to point A. A line connects the IP streamer to point B. A line connects point B to the IP network. A line connects the IP network to point C. A line connects point C to the Decoder. A line connects the Decoder to point D. Below the IP network, there are two boxes: End-to-end IP network measurements and End-to-end receiver measurements. Lines connect these boxes to points A, B, C, and D.
+
+Figure I.1: ITU-T J.241 system measurement model. The diagram shows a flow from Head-end to CPE/STB through an IP network. The Head-end contains Video input, IP streamer, and IP protocol stack. The CPE/STB contains IP protocol stack and Decoder. The IP network contains Network monitoring. Reference points A, B, C, and D are marked. End-to-end IP network measurements and End-to-end receiver measurements are shown below the network.
+
+Figure I.1 – ITU-T J.241 system measurement model [ITU-T J.241]
+
+Table I.1 describes the reference points A, B, C, and D shown in Figure I.1:
+
+Table I.1 – Description of reference points for measurements
+
+| Reference point | Description |
+|-----------------|-------------------------------------|
+| A | Video encoder |
+| B | IP layer at head-end (Raw IP data). |
+| C | IP layer at CPE (Raw IP data). |
+| D | Video decoder |
+
+Monitoring can be implemented as distributed or centralized architecture thus providing different flexibility and resource usages. Such an approach is used in [ITU-T G.1082].
+
+In a centralized monitoring system, all data regarding the characteristics of the video traffic transmission system is collected and analysed at a single control centre. This centre can be a physical location or a software platform.
+
+#### Advantages of a centralized system
+
+- 1) **Convenient management:** All data is collected in one place, making it easier to analyse and monitor the entire system.
+- 2) **Centralized analysis:** Data analysis takes place on a single platform, allowing for quick issue detection and action.
+- 3) **Comparison and aggregation:** The ability to compare data from different nodes of the system and aggregate them to gain an overall picture.
+
+#### Disadvantages of a centralized system
+
+- 1) **Single point of failure:** If the central node fails, the entire monitoring system could become inaccessible.
+- 2) **Infrastructure costs:** Establishing and maintaining a centralized infrastructure can be expensive.
+
+#### Distributed monitoring system
+
+In a distributed monitoring system, data collection and analysis are performed at various nodes of the system. Each node is responsible for monitoring its specific part of the infrastructure.
+
+#### Advantages of a distributed system
+
+- 1) **Fault tolerance:** Failure of one node does not impact the operation of the entire system.
+- 2) **Scalability:** Adding new nodes to monitor new segments of the infrastructure is more flexible.
+- 3) **Load distribution:** Spreading the load across multiple nodes reduces the risk of overloads.
+
+#### Disadvantages of a distributed system
+
+- 1) **Complex management:** Analysing data collected from different nodes might be more complex.
+- 2) **Aggregation complexity:** Achieving a complete picture requires aggregating data from various nodes.
+- 3) **Synchronization requirement:** Ensuring data accuracy between nodes necessitates synchronization.
+
+The choice between a centralized and distributed monitoring system depends on specific requirements and characteristics of the video traffic transmission system, as well as situations where a balance is needed between management simplicity, scalability, and fault tolerance.
+
+The choice between a centralized and distributed system depends on several factors, including the characteristics of the system, management requirements, scalability and fault tolerance needs, as well as specific situations and tasks. Here are some of the key factors that can influence this choice:
+
+- a) System characteristics:
+ - Scale of the system: In larger systems with numerous nodes and segments, a distributed system might be more suitable as it allows scaling monitoring without significantly burdening a single centre.
+ - Geographical distribution: If system nodes are geographically dispersed, a distributed system can provide more efficient monitoring and analysis closer to the nodes.
+
+- b) Management requirements:
+ - Convenience of management: A centralized system provides a single point of control and data analysis, which can be useful for consolidated oversight.
+ - Decentralized control: A distributed system might be more beneficial if nodes need more autonomy and control over their data.
+- c) Fault tolerance:
+ - Resilience to failures: A distributed system might be more resilient to failures since the failure of one node would not affect the entire system's operation.
+ - Single point of failure: A centralized system is more susceptible to failure risks, as the failure of the central node could lead to issues with monitoring the whole system.
+- d) Data analysis complexity:
+ - Data aggregation: If collecting and aggregating data from various nodes for an overall picture is necessary, a distributed system could be more complex for analysis.
+ - Centralized analysis: A centralized system simplifies analysis since data is already gathered in one place.
+- e) Budget and resources:
+ - Infrastructure costs: Establishing and maintaining a centralized infrastructure can involve significant expenses, whereas a distributed system might be more cost-effective.
+- f) Specific tasks and scenarios:
+ - Specific requirements: Certain scenarios might have specific monitoring and management requirements that could dictate the choice.
+
+The final decision between a centralized and distributed monitoring system should be based on an analysis of all these factors and a consideration of the specific goals and conditions of the video traffic transmission system.
+
+It is possible to use one of two proposed video monitoring system options:
+
+- Introduction of separate independent (from main video) video streams with frame rates 1 to 2 fps and black field or other images as image contents. Such types of image during compression will result in non-significant bit rate increases (see Figure I.2).
+- Usage of advertising or other recurring themes (such as titles of programmes) that will be interpreted as the embedded test signal (see Figure I.3).
+
+The second option leads to increasing the complexity of the monitoring system due to the requirement of separate channels for undistorted images. The first option is easier due to the uniformity of the images that do not depend on the programme.
+
+
+
+The diagram illustrates the operational monitoring process for E2E video services. On the left, multiple video streams (labeled 1 to n) enter 'Video encoder' blocks. The outputs of these encoders are fed into a 'TS MUX' (Transport Stream Multiplexer) block, which is represented by a dashed line. The multiplexed streams are then transmitted over a 'Cable integrated broadband network'. An arrow labeled 'Impairment during transmission' points to this network block. The output of the network is fed into a 'TS DEMUX' (Transport Stream Demultiplexer) block, also represented by a dashed line. The demultiplexed streams are then fed into 'Video decoder' blocks. The outputs of these decoders are labeled 'Initial/degraded video 1' through 'Initial/degraded video n'. Each video output is also fed into an 'SSIM/PxER PSNR meas.' block. The outputs of these measurement blocks are labeled 'SSIM 1', 'PxER 1', 'PSNR 1' for stream 1, and 'SSIM n', 'PxER n', 'PSNR n' for stream n. A 'Reference (virtual channel) for test images' is shown as a line entering the 'Video decoder' blocks from the bottom. The diagram is labeled 'J.1630(24)' in the bottom right corner.
+
+Diagram of operational monitoring for E2E video services with a separate control channel. The diagram shows multiple video streams (1 to n) being encoded, multiplexed, transmitted over a cable integrated broadband network, and then demultiplexed and decoded. A reference channel for test images is also shown. Quality metrics (SSIM, PxER, PSNR) are measured for each stream.
+
+NOTE – Dotted line blocks are related to additional blocks for MPEG-TS based system only; dot-dashed lines are related to case of video transmissions without MPEG TS multiplexing
+
+**Figure I.2 – Operational monitoring for E2E video services with a separate control channel based on usage SSIM/ PxER metrics as example of possible choice result**
+
+Reference receivers that are located in arbitrary points in individual nodes of the end-to-end path, perform continuous comparisons of reference images using the selected objective quality metrics (for example such as SSIM metric or pixel error ratio (PxER)/block error ratio (BLER)/macro block error ratio (MBLER)/slice error ratio (SLER). If the result of the comparison indicates a significant degradation in the quality of the video, which is impacted with structural distortions, then this indicates failures in equipment operation.
+
+Network impairments impact different networks in different ways in terms of availability, visibility and intensity. Therefore, for the network operator it is important to define network performance KPI requirements in terms of permitted packet loss rate (PLR), packet jitter, latency, etc. Considering the variety of factors influencing network performance, in most cases obtaining such requirements requires network operators to utilize their own network experience.
+
+Video system streams can be corrupted in different ways during transmission via an E2E network (see Figure I.4).
+
+Generalization and classification of existing methods of estimation of the technical quality of cable video systems is realized with the use of a multilevel approach (see Figure I.5). Accordingly, such classification methods of technical quality control are divided into two classes:
+
+- technical quality control methods at transport stream level;
+- technical quality control methods at video and audio streams level.
+
+
+
+```
+
+graph LR
+ VS1[Video stream 1] --> VE1[Video encoder]
+ VSn[Video stream n] --> VEn[Video encoder]
+ VE1 -.-> TSMUX[TS MUX]
+ VEn -.-> TSMUX
+ TSMUX --> CIBN[Cable integrated broadband network]
+ Impairments[Impairments during transmission] --> CIBN
+ CIBN --> TSDEMUX[TS DEMUX]
+ TSDEMUX -.-> VD1[Video decoder]
+ TSDEMUX -.-> VDn[Video decoder]
+ VD1 --> IV1[Initial/degraded video 1]
+ VDn --> IVn[Initial/degraded video n]
+ IV1 --> M1[SSIM/PxER PSNR meas.]
+ IVn --> Mn[SSIM/PxER PSNR meas.]
+ TSG[Test signal generator] --> M1
+ TSG --> Mn
+ M1 --> SSIM1[SSIM 1]
+ Mn --> SSIMn[SSIM n]
+
+ subgraph Legend
+ direction TB
+ L1[-.-> Dotted line: MPEG-TS based system only]
+ L2[--> Dot-dashed line: without MPEG TS multiplexing]
+ end
+
+```
+
+Figure I.3: Operational monitoring for E2E video services with an embedded control channel based on usage SSIM/ PxER metrics as example of possible choice result.
+
+NOTE – Dotted line blocks are related to additional blocks for MPEG-TS based system only; dot-dashed lines are related to case of video transmissions without MPEG TS multiplexing
+
+**Figure I.3 – Operational monitoring for E2E video services with an embedded control channel based on usage SSIM/ PxER metrics as example of possible choice result**
+
+
+
+```
+
+graph TD
+ Root[Impairments of compression based video services] --> L1[Impairments on level of video multiplexing/demultiplexing]
+ Root --> L2[Impairments on level of encoding/decoding of compressed video signals]
+
+ L1 --> L1A[Impairments on video compression elementary stream level]
+ L1 --> L1B[Impairments on transport stream level]
+
+ L1A --> L1A1[Non-decodability of video picture]
+ L1A --> L1A2[Errors in encoding parameters picture type]
+
+ L1B --> L1B1[Impairments in system and programme service information of video stream]
+ L1B --> L1B2[Impairments on packet level]
+
+ L1A1 --> Sync[Synchronization failure for audio/video signals]
+ L1A2 --> Sync
+ L1B1 --> Sync
+
+ Sync --> Sync1[Programme synchronization signal jitter]
+ Sync --> Sync2[Loss of audio/video sync]
+
+ L2 --> L2A[Impairments of audio signal]
+ L2 --> L2B[Structural impairments of video signal]
+
+ L2B --> L2B1[Intra-frame Spatial]
+ L2B --> L2B2[Inter-frame Time]
+
+ L2B1 --> Errors
+ L2B2 --> Errors
+
+ subgraph Errors [Dashed Box]
+ E1[Errors in pixels]
+ E2[Errors in blocks]
+ E3[Errors in macroblocks]
+ E4[Errors in slices]
+ end
+
+```
+
+Figure I.4: Impairments during distribution of compressed video streams.
+
+**Figure I.4 – Impairments during distribution of compressed video streams**
+
+
+
+```
+
+graph TD
+ Root[Methods of control of technical operation quality of E2E video system path] --> Level1[Methods of control on transport stream level]
+ Root --> Level2[Methods of control on video and audio streams level]
+ Level1 --> L1_1[Estimation of synchronization accuracy]
+ Level1 --> L1_2[Measurement of error rates for bits, packets, frames]
+ Level1 --> L1_3[Stream analysis for error detection for three priorities and statistical estimation]
+ Level2 --> L2_1[Estimation of program synchronization]
+ Level2 --> L2_2[Analysis of video streams time parameters]
+ Level2 --> L2_3[Objective quality estimation (Metrics)]
+ Level2 --> L2_4[Subjective quality estimation (Visual control)]
+ Level2 --> L2_5[Estimation of structural impairments]
+
+```
+
+J.1630(24)
+
+Flowchart showing methods of control of technical operation quality of E2E video system path, divided into transport stream level and video/audio streams level.
+
+**Figure I.5 – Methods of technical quality control of services operation of E2E video system**
+
+## I.3 Measurement of bandwidth influence
+
+Table I.2 lists IP network measurement parameters for bandwidth reduction. All measurements should be taken from point B to point C in the system measurement model described in Figure I.1:
+
+**Table I.2 – IP network measurement parameters for bandwidth reduction**
+
+| Parameter | Equipment | Motivation | Monitoring method |
+|-----------------------|-----------|-----------------------------------|-----------------------------------------------------------------------------|
+| Downstream throughput | CPE (STB) | Service qualification, monitoring | Test signal representative of worst case encoding scenario, throughput test |
+| Upstream throughput | CPE (STB) | Service qualification, monitoring | Throughput test |
+
+#### I.3.1 Bandwidth control policies
+
+In addition, another approach is usage of KPI provisioning mechanisms such as IntServ (integrated services) and DiffServ (differentiated services). Other mechanisms are also possible so IntServ and DiffServ are considered as examples.
+
+- *IntServ* (integrated services): IntServ is suitable for situations where ensuring guaranteed QoS parameters (such as minimum delay and low packet loss) is important for specific data streams, such as high-resolution videos or video conferences. If QoS is of paramount importance and the network allows resource management for each data stream, then IntServ can be beneficial.
+- *DiffServ* (differentiated services): DiffServ is well-suited for situations where priorities need to be established for different classes of traffic in the overall network. Video traffic can be classified as one of the classes with higher priority (e.g., "priority" or "voice" class), which helps minimize delay and data loss for video streams.
+
+In larger networks, such as service provider networks or corporate networks, DiffServ is typically preferable as it provides a more flexible and scalable way to manage traffic without the need to maintain state for each individual stream. Many IPTV providers use DiffServ technology to ensure quality of service (QoS) and optimize video transmission in their networks. DiffServ allows providers to manage priorities and handling of various types of traffic, including video streams.
+
+Using DiffServ in video streaming networks can offer the following benefits:
+
+- Prioritization for video traffic: Providers can classify video streams as high-priority and assign them a higher level of service. This minimizes delays and data loss for video, ensuring smoother and higher-quality transmission.
+- Mitigation of impact on other traffic types: Traffic classification enables the isolation of video traffic from other data types, such as internet browsing or file downloads. This helps prevent scenarios where intensive usage of one type of traffic negatively affects the quality of other applications.
+- Bandwidth management: Providers can allocate specific bandwidth for video traffic to ensure it has sufficient capacity and prevent network congestion.
+- Prevention of buffering effect and delays: By prioritizing video traffic, DiffServ can help minimize buffering and delays, which is crucial for video service users, where users expect immediate and smooth video playback. However, it is important to note that the specific implementation and effectiveness of DiffServ can vary depending on the level of control the provider has over the network infrastructure and the available resources.
+
+However, it is also important to note that the specific implementation and effectiveness of DiffServ can vary depending on the level of control the provider has over the network infrastructure and the available resources.
+
+DiffServ's ability to prioritize traffic based on different classes makes it a valuable tool for video service providers to ensure a high-quality viewing experience for their customers. By assigning higher priority to video traffic, providers can minimize latency and buffering, which are critical factors for delivering seamless video content. Additionally, DiffServ's flexibility allows providers to adapt to changing network conditions and allocate resources dynamically to different classes of traffic.
+
+In summary, both IntServ and DiffServ, along with other techniques, play significant roles in shaping the quality of service in modern networks, including IPTV systems. While IntServ offers a more fine-grained control for individual data streams, DiffServ provides a scalable and adaptable approach to managing traffic classes. For video service providers, the choice between these approaches depends on their specific network requirements, infrastructure capabilities, and the desired level of control over the quality of service for video content delivery.
+
+To select the video traffic control strategy that is best suited for a specific network there are periodic or constant measurements of available network bit-rate. Such measurements provide the best shaping of traffic usage control and optimization.
+
+Measuring bit-rate using a time window is a common method to determine the average data transmission rate in a network based on data analysis within a specified time interval. This method allows assessing how many bits or packets are transmitted through the network over a certain amount of time.
+
+#### **I.3.2 Available bandwidth measurement**
+
+A bit-rate measurement algorithm can be used as follows:
+
+- 1) Select the time window size: Define the duration of the time window during which you want to measure the bit-rate. For example, you can choose a time window of 1 second.
+- 2) Data capture: Capture or obtain network traffic within the chosen time window. This can be done using a network analyser, network monitoring tools, or data collection software.
+
+- 3) Count bits: Count the total number of bits transmitted during the chosen time window. This can be done by summing the sizes of all data packets received during this time.
+- 4) Calculate bit-rate: Calculate the bit-rate by dividing the total number of bits by the duration of the time window. The formula is as follows:
+
+$$\text{Bit-rate} = (\text{Total number of bits}) / (\text{Duration of time window}).$$
+
+This method allows assessing of the average data transmission bit-rates in the network based on the traffic analysis over a specific time interval. However, it is important to remember that the bit-rate can vary depending on network load and other factors. Therefore, it is recommended to conduct measurements across different time intervals to obtain more accurate data.
+
+Measuring bit-rate using a time window is a valuable method for evaluating data transmission bit-rate in a network. It can be used for quality of service monitoring, network load analysis, and resource optimization. However, it is important to understand that bit-rate is an average characteristic, and actual values can fluctuate based on network conditions. So, it is necessary to consider the following factors:
+
+- Averaging and analysis: To obtain a more stable representation of the bit-rate, it is advisable to measure the bit-rate using time windows over a certain period (for example, a few minutes or hours) and average the obtained values. This accounts for temporal fluctuations and provides a more accurate characterization of the network's bit-rate.
+- Tool usage: Various tools, analysers and software programs exist that can automate the process of measuring bit-rate using a time window.
+- Header consideration: When measuring bit-rate, it is important to consider that network traffic contains packet headers, which also occupy a certain number of bits. Therefore, when counting bits, it is necessary to account for header sizes to avoid distortions in the actual data transmission bit-rate.
+
+### I.4 Measurement of IP packet loss influence
+
+Table I.3 lists IP network measurement parameters for IP packet loss estimation. All measurements should be taken from point B to point C in the system measurement model described in Figure I.1.
+
+**Table I.3 – IP network measurement parameters for packet loss estimation**
+
+| Parameter | Equipment | Motivation | Monitoring method |
+|------------------------|-------------------------------------------------------------|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Packet loss rate (PLR) | Consumer premises equipment (CPE) e.g., a set-top-box (STB) | Image quality, video information loss estimation | In service or through test streams with RTP/RTCP or sequence numbers available on packet header.Periodic PLR summary.
Reports with one-minute resolution.
Measurement of PLR requires analysis of a number of packets at least 10 times greater than the number related to the target PLR value.
This determines the rate at which the PLR is reported. | + +Requirements for permissible values of PLR are quite case-relative and highly dependent on the MPEG compression method and MPEG encoder configuration. Considering MPEG auto-configuration for receiver decoder operation, different performance improving approaches are possible. These include some network re-configuration or video encoder reconfiguration. So in the case of systematic or periodic performance failures a strategy for failures mitigation will be chosen. + +### I.5 Measurement of IP packet jitter influence + +Table I.4 lists IP network measurement parameters for packet jitter related measurements. All measurements should be taken from point B to point C in the system measurement model described on Figure I.1. + +**Table I.4 – IP network measurement parameters for packet jitter related measurements** + +| Parameter | Equipment | Motivation | Monitoring method | +|------------------|------------------------------------------------------------------------------------------|-------------------|--------------------------------------------------------------------------------------------| +| Network latency | Test probe at user side, within CPE (STB) or as closest as possible to user access link. | Smooth play-out | Test stream | +| Jitter | CPE (STB) | Smooth play-out | In service or through test streams with RTP/RTCP or timestamps available on packet header. | + +# Appendix II + +## KQI estimation guidelines + +(This appendix does not form an integral part of this Recommendation.) + +### II.1 General approach to KQI measurement + +A multi-level approach to assessing KQI is employed for several reasons: + +- 1) Consideration of multiple factors: In the world of video services, numerous factors influence the quality of the user experience. By categorizing KQIs into different tiers, a broad spectrum of aspects can be considered, ranging from content quality to network performance and user satisfaction. This provides a more comprehensive understanding of how the service is perceived by users. +- 2) Problem localization: A multi-tiered approach helps to pinpoint the location of issues and bottlenecks in service delivery more accurately. For instance, if issues are related to data transmission, they can be identified within transmission-related KQI. If the problem lies in user perception, it becomes evident through user-related KQI. This streamlines the process of issue identification and resolution. +- 3) Enhanced decision-making: The multi-tiered approach provides more detailed information that can be used for more informed decision-making. Video service providers can gain a better understanding of where to focus their efforts to improve quality and meet user expectations. +- 4) Accounting for service and technology diversity: Modern video services can be diverse, including traditional video services, streaming video, AR, VR, and others. The multi-tiered approach allows for adaptation to different types of services and technologies, which is crucial for a more comprehensive coverage of various video services. + +Ultimately, a multi-tiered approach to assessing KQI helps provide a more detailed and comprehensive understanding of service quality and user experience, enabling the enhancement of video services to make them more competitive and aligned with user needs. + +So, with regard to the aims of the current Recommendation KQI can be categorized as: + +- **Service-related KQI:** used to assess the subjective-related quality of a service (IPTV, streaming service, Cloud VR, etc.). Service-related KQIs are essential for measuring and evaluating various aspects of service delivery to ensure that the service meets or exceeds user level of expectations or satisfaction. These indicators help to identify strengths and weaknesses in service delivery, make improvements, and ensure that the service remains competitive and valuable to users. +- **Transmission-related KQI:** used to assess the quality of data transmission within a communication network. These KQIs help monitor and manage network performance to ensure that it meets user level of expectations or satisfaction. +- **User-related KQI:** used to assess the quality of a user's experience with a service. These indicators are essential for understanding how well a service meets the needs, expectations, and satisfaction levels of users. + +The effectiveness of this approach lies in its ability to provide researchers and video service providers with a more detailed understanding of where issues or discrepancies with user expectations occur in the service delivery process. This helps identify bottlenecks in infrastructure and service processes, allowing for more informed actions to improve service quality and user satisfaction. + +Thus, this approach to assessing KQI allows for a more comprehensive analysis and enhancement of the quality of video services, taking into account various aspects that influence the quality of the user experience. + +### II.2 Guidelines for KQI measurement management + +KQI measurement management refers to the process of planning, implementing, monitoring, and improving the measurement of key quality indicators. This process is crucial for ensuring that KQI accurately reflects the performance, quality, and effectiveness of its services or systems. Effective KQI measurement management involves several key steps: + +- **Selection of relevant KQI**, including its formula, calculation methodology, and units of measurement that are meaningful and provide actionable insights. Recommended relevant KQI metrics are given in Table II.1. +- **Measuring KQI:** + - 1) Define objectives: Clearly define what you want to measure and evaluate. Ensure that the KQIs align with business and user goals. + - 2) Select appropriate tools: Determine the tools and methodologies that best suit the measurement of each category of KQI. This may involve network performance analysis, user experience monitoring, and user surveys. + - 3) Establish baseline values: Determine initial values for KQIs in network and video services. This helps understand the quality levels that need to be achieved. + - 4) Regular monitoring: Set regular intervals for monitoring and measuring KQIs. This can be daily, weekly, or as per the specifics of infrastructure and services. + +It should be noted that one measurement point is not enough to obtain a macroscopic view of the KQI. As described in [b-ETSI ES 202 765-2], for multiple offers deployed in a perimeter of potential users greater or equal to 10 000 000, at least 10 analysis points should be distributed over the perimeter. For multiple offers deployed in a perimeter of potential users lower than 10 000 000, at least 5 analysis points should be distributed over the perimeter. + +- **Managing results:** + - 1) Data analysis: Analyse the data collected using KQIs to identify trends and anomalies. Identify areas where improvements have occurred and areas where issues have arisen. + - 2) Benchmarking: Compare KQI results with industry benchmarks and competitors. This helps you understand how well it performed in comparison to industry standards. + - 3) Setting priorities: Determine which aspects of quality require the most attention and improvement. Set priorities for developing an improvement plan. + - 4) Development and implementation of improvements: Develop specific measures and strategies for improving KQIs. This may involve updating infrastructure, process optimization, and service enhancement. + - 5) Monitoring after implementation: After implementing improvements, continue to monitor KQIs to ensure they have had a positive impact. Continuously analyse and manage results. + - 6) User feedback: Collect feedback from users to understand the changes they have noticed and how they have affected their experience. + - 7) Documentation and reporting: Carefully document all data and changes to ensure transparency and reporting to internal teams and stakeholders. For reporting, the presentation of each metric shall be made separately. Each metric shall be presented on its own scale. For each indicator, presentation results shall consist at least of presenting metric value, number of measurements to determine the metric value and measurement standard deviation + +Adhering to these guidelines will help ensure effective measurement of KQIs and efficient results management for improving the quality of video services and user satisfaction. + +**Table II.1 – Recommended relevant KQI** + +| Parameter | Description | Details | Applications | References | +|----------------------------|----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------|-------------------------------------------| +| Service-related KQI | | | | | +| Service access | After requesting a service by the user, the first service data packet is received at the user equipment |
- Service Access Time: Is the duration of a service access from requesting the service until the reception of the first data packet at the user equipment
- Streaming Reproduction Start Failure Ratio: probability of unsuccessful streaming reproduction. This includes streaming access failure before the service has been accessed.
- Initial Buffering Duration: Is the time from when the user clicks video play button to when the first video frame is displayed.
- Re-buffering Time Percentage: Is the time for a given video that has been stopped playing due to exhaustion of its buffer to the point it resumes playing during a time period (24 hours, 1 week, etc.)
- Stalling Duration: Is the time of the stalling when the buffer is empty during a time period (24 hours, 1 week, etc.)
[ETSI TS 103 222-4] | + +**Table II.1 – Recommended relevant KQI** + +| Parameter | Description | Details | Applications | References | +|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | As with traditional online video, after the user clicks the cloud VR video play button, there is a loading process for performing CDN scheduling, index downloading, and data caching. For this process, users generally only see the loading progress bar. The shorter the loading time, the sooner the user sees the video content and the better the experience. |
- Initial Buffering Duration: Is the time from when the user clicks the cloud VR video play button to when the user sees the normal play screen
- Zapping Delay: Is the duration of a channel switching from requesting the channel until the reception of the first picture frame and audio at the user equipment
- encoder/decoder implementation when no video stream is present;
- a major loss of video packet during a long period of time.
- «Black Screen» Occurrences. This metric corresponds to the number of black screen sequences during a time period (24 hours, 1 week, etc.)
- Blockiness Occurrences. This metric corresponds to the number of Blockiness sequences during a time period (24 hours, 1 week, etc.)
- Frozen Picture Occurrences. This metric corresponds to the number of frozen picture sequence during a time period (24 hours, 1 week, etc.)
- Average duration of Frames Freezing: Is the average of multiple freezing time per time window during VR video playing.
- Average percentage of Frames Freezing: Is the ratio of the total freezing time to the total playing time per time window during VR video playing.
- Number of Frames Freezing: Is the number of frames freezing per second during VR video playing.
Strong-interaction Cloud VR services: VR games, VR home fitness, VR education, and VR social networking | [ETSI GS F5G 005] | +| End-to-End delay | A real-time telecommunication system generates and delivers information in a time-frame similar to the real-life process that it is assisting. Depending on the real-life process being assisted, the frame may include seconds or be perceived by end-users as immediate. These systems therefore have real-time technical requirements and constraints for their implementation associated with real-time computing and the real-time transport protocol | Depends on system/network configuration | Video service (TV, streaming) | [ETSI TS 122 105] | +| User-related KQI | | | | | +| Video access timeout | Level of user patience/time pressure
This time out reflects the maximal time between requesting the video and the first frame is displayed. It can be imagined as the maximum waiting patience of a user for the start of the video. | Usually are few seconds, but to cover also other technologies and heavy-load situations in the networks, the timeout can be set to 15 s up to 20 s. | Video service (TV, streaming) | [ETSI TR 101 578] | + +**Table II.1 – Recommended relevant KQI** + +| Parameter | Description | Details | Applications | References | +|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|-------------------| +| Maximum duration of single freeze | Level of user patience/time pressure
It can be seen as an indication for "stream lost". A user may stop watching the video in case the freeze exceeds particular value of time. The video can be considered as "lost" or "dropped" in this case. | A value of 15 s is an acceptable best-practice value for a maximum accepted freezing event | Video service (TV, streaming) | [ETSI TR 101 578] | +| Minimum freeze duration | Level of user patience/time pressure. | A threshold of 1, 2 s is recommended to recognize freezes caused by the network | Video service (TV, streaming) | [ETSI TR 101 578] | +| Operation response latency | In strong-interaction application scenarios, such as Cloud VR gaming, users expect immediate audio-visual responses when they move horizontally, pull a trigger, or wave a hand. If the response takes longer than they expect, they experience interactive latency. Operation response latency is caused by the asynchronous collaboration between the cloud rendering and streaming process and the local playout process |
- Average Response Duration: is the average time from the action of the user detected by the terminal to the corresponding game screen display.
- Average percentage of the Black Edge Area: is the average value of the black edge/smearing in the user's viewing area during the game.
- Percentage of the Black Edge Duration: is the proportion of the time duration with black edge effect to the total time duration of the game.
- databases
- servers (TFTP, etc.)] + Provider -- "Business relationship" --> SP_A[Service provider A] + Provider -- "Business relationship" --> SP_B[Service provider B] + Provider -- "Business relationship" --> SP_C[Service provider C] + +``` + +Diagram illustrating the partitioning of management domains. A central 'Provider: Provisioning/network management' block, containing 'databases' and 'servers (TFTP, etc.)', is connected to a 'CM/MTA' block on the left and three 'Service provider' blocks (A, B, and C) on the right. Each connection is labeled 'Business relationship'. A small label 'J.166(07)\_F02' is in the bottom right corner. + +Figure 2 – Partitioning of management domains + +### 5.2.2 Support for embedded and stand-alone MTAs + +The IPCablecom MIBs will provide features for both embedded and stand-alone MTAs. Since stand-alone MTAs are not required to include any CM related functions, the IPCablecom MIBs, therefore, should be independent of CM and able to provide management support for voice communications functionalities. Cable modems with embedded MTAs must adhere to the DOCSIS or eDOCSIS specifications related to the MIBs. The CM part of the E-MTA (i.e., eCM) MUST support eDOCSIS requirements defined in ITU-T Rec. J.126. + +Figure 3 describes the possible MIB module implementation for an MTA (embedded or stand-alone): + + + +**MTA MIB implementation** + +``` + +graph TD + subgraph Cable_modem [Cable modem] + CM[RF] + subgraph CM_MIBs [ ] + MIB-II_1[MIB-II] + Bridge[Bridge MIB] + DOCSIS[DOCSIS RF MIB] + BPI[BPI+MIB] + Device[Device MIB] + eSAFE[eSAFE MIB] + UPS["Battery backup UPS MIB (if MTA supports battery backup)"] + end + Ethernet[Ethernet] + end + subgraph MTA [MTA] + subgraph MTA_MIBs [ ] + MIB-II_2[MIB-II] + DeviceMIB[IPCablecom device MIB] + Signalling[IPCablecom signalling MIB] + MgmtEvent[IPCablecom MgmtEvent MIB] + Extension[IPCablecom extension MIBs] + SNMPv2[SNMPv2 MIB] + end + Voice[Voice] + end + CM_MIBs -- Embedded --> MTA_MIBs + +``` + +J.166(07)\_F03 + +Diagram showing MTA MIB implementation for Cable modem and MTA components. The Cable modem (RF) contains MIB-II, Bridge MIB, DOCSIS RF MIB, BPI+MIB, Device MIB, eSAFE MIB, and Battery backup UPS MIB (if MTA supports battery backup). The MTA contains MIB-II, IPCablecom device MIB, IPCablecom signalling MIB, IPCablecom MgmtEvent MIB, IPCablecom extension MIBs, and SNMPv2 MIB. The Cable modem and MTA are connected via an Embedded link. The MTA is also connected to Voice and Ethernet. + +**Figure 3 – Embedded and stand-alone MTA implementations** + +### 5.2.3 Simple network management protocol (SNMP) considerations + +SNMPv3 provides an extended user security model which implies changes to the way SNMP packets are exchanged between agents and managers. Since MIB modules are used to define the content of the packets, the changes for SNMPv3 do not affect MIB design. + +The only requirements imposed are that IPCablecom MIBs MUST conform to SMIV2, which is described in [IETF RFC 2578] and [IETF RFC 2579]. + +The following IETF RFCs provide more information on SNMPv3: + +- IETF RFC 3410, Introduction and Applicability Statements for Internet Standard Management Framework. +- IETF RFC 3411, An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks. +- IETF RFC 3412, Message Processing and Dispatching for the Simple Network Management Protocol (SNMP). +- IETF RFC 3413, Simple Network Management Protocol (SNMP) Applications. +- IETF RFC 3414, User-based Security Model (USM) for version 3 of the Simple Network Management Protocol (SNMPv3). +- IETF RFC 3415, View-based Access Control Model (VACM) for the Simple Network Management Protocol (SNMP). + +#### 5.2.3.1 USM requirements + +For IPCablecom, the usmUserTable MUST be configured immediately after the AP Reply received from the Provisioning Server with the following entries. + +``` + +usmUserEngineID - the SNMP local engine id +usmUserName - MTA-Prov-xx:xx:xx:xx:xx:xx +usmUserSecurityName - MTA-Prov-xx:xx:xx:xx:xx:xx +usmUserCloneFrom - 0.0 + +``` + +``` + +usmUserAuthProtocol - usmHMACMD5AuthProtocol or + usmHMACSHAAuthProtocol +usmUserAuthKeyChange - "" +usmUserOwnAuthKeyChange - "" +usmUserPrivProtocol - usmDESPrivProtocol if privacy indicated in AP Reply, +usmNoPrivProtocol if no privacy is indicated in the AP Reply. +UsmUserPrivKeyChange - "" +UsmUserOwnPrivKeyChange - "" +usmUserPublic ' ' ' ' +usmUserStorageType - permanent +usmUserStatus - active + +``` + +The xx:xx:xx:xx:xx:xx in the usmUserName and usmUserSecurityName represents the MAC address of the MTA. + +Initial authentication and privacy keys for this user are derived from the AP Reply message. + +New users MAY be created by cloning as defined in SNMPv3. This MAY be done through the config file, or later through SNMP Set operations. + +#### 5.2.3.2 VACM requirements + +The following VACM entries MUST be defined for IPCablecom. Other table entries MAY be implemented at vendor or operator discretion. + +VACM views MUST be defined for IPCablecom as described below. + +##### 5.2.3.2.1 VacmSecurityToGroup Table + +The following configuration of the vacmSecurityToGroup table provides a read/write/create view. + +``` + +vacmSecurityModel - USM +vacmSecurityName - "MTA-Prov-xx:xx:xx:xx:xx:xx" +vacmGroupName - 'PacketCableFullAccess' +vacmSecurityToGroupStorageType - permanent +vacmSecurityToGroupStatus - active + +``` + +##### 5.2.3.2.2 vacmAccessTable + +The vacmAccessTable MUST be configured with the following entries. Other table entries MAY be implemented at vendor or operator discretion. + +##### 5.2.3.2.2.1 Full access + +This configuration allows for read access of all MIB modules in the MTA, write access to IPCablecom MIB modules, and notifications as defined in the IPCablecom MIB modules: + +``` + +vacmGroupName - PacketCableFullAccess +vacmAccessContextPrefix - "" +vacmAccessSecurityModel - USM +vacmAccessSecurityLevel - authPriv or authNoPriv, depending on whether privacy +has been specified +vacmAccessContextMatch - exact +vacmAccessReadViewName - ReadOnlyView +vacmAccessWriteViewName - FullAccessView +vacmAccess NotifyViewName - NotifyView +vacmAccessStorageType - permanent +vacmAccessStatus - active + +``` + +##### 5.2.3.2.3 MIB view requirements + +The FullAccessView MUST consist of the MIB2 system group, the IFMIB, and all IPCablecom defined MIB modules. It MAY include vendor defined MIBs, VACM, USM, and Notifications MIB. The following lists the required OIDs: + +``` + +1.3.6.1.2.1.1 /* MIB-II system group MIB tree */ +1.3.6.1.2.1.2.2 /* MIB-II IF MIB tree */ +1.3.6.1.4.1.4491.2.2 /* PacketCable Project MIB tree */ +1.3.6.1.6.3.13 /* NOTIFY MIB tree */ +1.3.6.1.6.3.15 /* USM MIB tree */ +1.3.6.1.6.3.16 /* VACM MIB tree */ + +``` + +The ReadOnlyView MUST consist of the entire MIB tree contained in the MTA, including IPCablecom defined MIB modules, and vendor defined MIB modules for IPCablecom. + +``` + +1.3.6.1 /* Full Internet MIB Tree*/ + +``` + +The NotifyView MUST consist of the MTA MIB tree, MIB-2 System MIB tree and the snmpTrapOID MIB. It MAY include vendor defined MIB modules. + +``` + +1.3.6.1.4.1.4491.2.2.1 /*MTA mib tree*/ +1.3.6.1.2.1.1 /* MIB-2 system mib tree */ +1.3.6.1.6.3.1.1.4.1.0 /* snmpTrapOID mib*/ + +``` + +## 5.3 Functional requirements + +This clause describes management functions that are supported by the IPCablecom MIB modules. + +### 5.3.1 IPCablecom device provisioning + +The IPCablecom MIB modules should provide definitions for attributes that are required in the MTA device-provisioning flows. These attributes are specified in the J.167 MTA device provisioning specification and include parameters such as CMS identifier, MTA domain name, MTA server addresses, and MTA capabilities. These attributes are defined as configuration file attributes and/or MIB objects as needed. + +### 5.3.2 Security + +The IPCablecom MIB modules provide definitions for attributes that are required for security handshake of the MTA and the provisioning server. These attributes are contained in [ITU-T J.170] and include certificates and signatures. + +### 5.3.3 Voice interfaces (FFS) + +The IPCablecom MIB modules should provide a generic external interface to voice service management attributes. This should be done so as to allow a device to implement proprietary mechanisms for internal control and management of voice interfaces. + +### 5.3.4 Packet voice call signalling + +The IPCablecom MIB modules should provide attributes that are needed for management of the packet voice call signalling protocol [ITU-T J.162]. Examples of attributes that have to be supported for packet voice call signalling include: + +- dial time-outs; +- distinctive ring patterns; +- Coder-DECoder (Codec) capabilities; +- signalling configuration for voice communication end points; +- call agent identifier. + +### 5.3.5 Media packet transport + +The IPCablecom MIB modules do not provide any managed objects to monitor and manage media packet transport. The RTP and RTCP protocols are used for media transport in IPCablecom. The RTP MIB (IETF RFC 2959) may be used for management of the media transport function of the MTA. Specific details are for future study. + +### 5.3.6 Fault management (FFS) + +The IPCablecom MIB modules should provide objects for the management of network faults and failures. Some of these managed objects and management functions are defined in the IPCablecom MTA MIB (Annex B) and the IPCablecom Signalling MIB (Annex C) and Management Event MIB (Annex D). In addition, these managed objects and functions can also be managed using the IETF MIB modules indicated by [IETF RFC 4682], [draft-ietf-ipcdn-pktc-eventmess-09], if implemented by the MTA. + +### 5.3.7 Performance management (FFS) + +The IPCablecom MIB modules should provide objects for the monitoring of the performance of the network when used for voice communications. Further definition of performance management is for future study. + +### 5.3.8 Event Management + +The IPCablecom Management Event MIB module provides the means to define and distribute events generated by the MTA. Refer to the Management Event MIB specification (Annex D and [draft-ietf-ipcdn-pktc-eventmess-09]) for more details. + +# 6 MIBs available in an IPCablecom network + +In designing the IPCablecom MIBs, it was necessary to consider other MIBs that are also present in the network and which can provide the required attributes and functions. This clause describes the MIBs that can be present in the IPCablecom MTA device, and which can be used for IPCablecom management functions as needed. + +Table 1 lists the MIB modules that must be present in the IPCablecom MTAs. E-MTAs and S-MTAs MUST implement MIB modules present in Table 1. + +**Table 1 – MIB modules implemented by E-MTA and S-MTA** + +| | +|---------------------------------| +| IF MIB | +| MIB II | +| Ethernet MIB | +| Bridge MIB | +| IPCablecom MTA Device MIB | +| IPCablecom Signalling MIB | +| IPCablecom Management Event MIB | +| SNMP V2 MIB group | +| IPCablecom Extension MIBs | +| eDOCSIS eSAFE MIB | +| Battery Backup UPS MIB | + +As mentioned before, partitioning of voice and data services and support of both S-MTA and E-MTA has been part of the requirements for design of the IPCablecom MIBs Framework. + +Figure 3 in the "General Requirements" clause describes possible organizations of the MIB modules in order to meet these requirements. + +## 6.1 DOCSIS MIB modules + +As described in clause 5.2, the IPCablecom Embedded MTA must support the DOCSIS ([ITU-T J.112] or ITU-T Rec. J.122) MIB requirements. Refer to the following documents for the normative DOCSIS MIB requirements: + +- For J.112, the MIB module requirements are defined in section 3 of [ANSI/SCTE 23-3]. +- For J.122, the MIB module requirements are defined in section 6 of [ANSI/SCTE 79-2]. +- For DOCSIS 3.0, the MIB module requirements are defined in [IETF RFC 4293]. +- For eDOCSIS, the MIB module requirements are defined in ITU-T Rec. J.126. + +## 6.2 IF MIB + +This is the interfaces section of the MIB II [IETF RFC 2863], and is needed for definitions of multiple interfaces in the MTA. + +## 6.3 MIB II + +[IETF RFC 1907], [IETF RFC 2011] and [IETF RFC 2013] define the second version of the management information base (MIB-II) for use with network management protocols in TCP/IP-based Internets. Not all objects in this MIB are deemed necessary for the IPCablecom MTA device. This MIB module only requires the system, interfaces, IP, and transmission objects of MIB II to be present in the MTA. + +The system object group contact, administrative, location, and service information regarding the managed node. + +### 6.3.1 sysDescr requirements + +The MTA's MIB II sysDescr object MUST conform to the format specified in DOCSIS [ANSI/SCTE 23-3]. + +### 6.3.2 sysObjectID requirements + +sysObjectID is defined as follows: + +``` +sysObjectID OBJECT-TYPE +SYNTAX OBJECT IDENTIFIER +ACCESS read-only +STATUS mandatory +DESCRIPTION + "The vendor's authoritative identification of the network + management subsystem contained in the entity. This + value is allocated within the SMI enterprises subtree + (1.3.6.1.4.1) and provides an easy and unambiguous + means for determining 'what kind of box' is being + managed. For example, if vendor 'Flintstones, Inc.' + was assigned the subtree 1.3.6.1.4.1.4242, it could + assign the identifier 1.3.6.1.4.1.4242.1.1 to its 'Fred + Router'." +::= { system 2 } +``` + +By using sysObjectID the manager will be able to determine any enterprise specific MIBs which must be used to manage the embedded MTA. + +### 6.3.3 "ifTable" requirements + +IPCablecom ifTable MUST contain information about all IPCablecom endpoints. IfIndex, in case of IPCablecom MTAs, MUST start with value of 9 for telephony endpoints and MUST be + +incremented sequentially and match the physical numbering of the telephony endpoints (Indices 2 through 8 are reserved for future use and the usage of index 1 is defined later in this clause). Each instance of the end-point in an E-MTA MUST have a corresponding entry ("conceptual row") in the "ifTable" MIB Table. + +The CableModem part of an embedded MTA MUST adhere to DOCSIS and eDOCSIS requirements for MIB compliance. + +For each "conceptual row" in the "ifTable" table that corresponds to a Telephony Endpoint, the following conceptual columns MUST be used: + +- "ifIndex" +- "ifDescr" +- "ifType" +- "ifAdminStatus" +- "ifOperStatus" + +Each conceptual row in "ifTable" MUST conform to the "IANAifType-MIB" definition for the IPCablecom interface type: + +- "ifType" - voiceOverCable (198) +- "ifDescr" - "Voice Over Cable Interface" + +IfIndex 1 is used to recognize the DOCSIS Cable Modem behind which an MTA is connected and the MIB modules involved are indicated in Tables 2 and 3. In the case of an embedded MTA, the tables MUST be adhered to. For stand-alone MTAs, the MTA MAY choose to follow the same. In case a stand-alone MTA cannot display the information, ifIndex 1 MUST be left unused. If the stand-alone MTA is behind a CableHome or other device for its data connectivity, it MAY change the ifDescr to reflect the same. + +IPCablecom E-MTAs MUST implement [ANSI SCTE 23-3], IETF STD 5 and [IETF RFC 2011]. An IPCablecom MTA MUST conform to the ifTable and ipNetToMediaTable defined in Tables 2 and 3, respectively. If an E-MTA is embedded with an eCM that supports IPv6, it MUST also support the ipNetToPhysicalTable as specified in Table 4. + +**Table 2 – RFC 2863 ifTable, MIB-Object details for embedded MTA device interfaces** + +| RFC 2863 MIB-Object details for MTA device interface | MTA device | +|----------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| ifIndex | 1 | +| ifDescr: MUST match the text provided in the next column. | "DOCSIS Embedded Interface" | +| ifType | other(1) | +| ifMtu | 0 | +| ifSpeed | 0 | +| ifPhysAddress | eMTA MAC address | +| ifAdminStatus: Only up control is required for this interface, down(2) and testing(3) is out of the scope of this specification. | up(1) | +| ifOperStatus: only up report is required for this object, other options are out of the scope of this specification. | up(1) | +| ifLastChange | per RFC 2863 | +| ifInOctets: This object is optional, if not implemented, it MUST return 0 | (n), 0 | +| ifInNUCastPkts | Deprecated | +| ifInDiscards | 0 | +| ifInErrors | 0 | +| ifUnknownProtos | 0 | +| ifOutOctets: This object is optional, if not implemented, it MUST return 0 | (n), 0 | +| ifOutUCastPkts: This object is optional, if not implemented, it MUST return 0 | (n), 0 | +| ifOutNUCastPkts | Deprecated | +| ifOutDiscards | 0 | +| ifOutErrors | 0 | +| ifOutQlen | Deprecated | +| ifSpecific | Deprecated | +| ifXTable: entries in ifXTable for this type of interface are not required | NA | + +**Table 3 – RFC 2011 ipNetToMedia MIB-Object details for eMTA device interfaces** + +| RFC 2011 MIB-Object details for MTA device interfaces | CM device | +|--------------------------------------------------------------|--------------------------------------------------------------------------------------------------| +| ipNetToMediaIfIndex | 1 | +| ipNetToMediaPhysAddress | CM MAC Address or a value of '0.0.0.0' if the eCM address cannot be represented (e.g., IPv6 eCM) | +| ipNetToMediaNetAddress | Acquired CM IP address | +| ipNetToMediaType | Static(4) or invalid(2) if ipNetToMediaPhysAddress is set to a value of '0.0.0.0' | +| ifIndex | 1 | + +**Table 4 – ipNetToPhysicalTable MIB object details** + +| MIB object name | CM device | +|-------------------------------|---------------------| +| ipNetToPhysicalIfIndex | 1 | +| ipNetToPhysicalPhysAddress | eCM MAC Address | +| ipNetToPhysicalNetAddressType | ipv4(1) or ipv6(2) | +| ipNetToPhysicalNetAddress | eCM IP Address | +| ipNetToPhysicalLastUpdated |
for hybrid and basic flows ..... | 77 | +| 12.2 | SNMP default entries for SNMPv2 access..... | 78 | + +| | Page | +|-----------------------------------------------------------------------------------------------|-------------| +| 13 Service interruption impact reporting and other enhanced features support ..... | 80 | +| 13.1 eDosis requirements support..... | 80 | +| 13.2 IPCablecom extension MIB ..... | 81 | +| 13.3 Battery backup MIBs..... | 81 | +| 13.4 Syslog MIBs ..... | 81 | +| 13.5 Foreign potential detection ..... | 81 | +| Appendix I – SNMPv2c coexistence configuration example – Template for service providers ..... | 82 | + + + +# Media terminal adapter (MTA) device provisioning requirements for the delivery of real-time services over cable television networks using cable modems + +# 1 Scope + +This Recommendation describes the IPCablecom media terminal adapter (MTA) device initialization and provisioning process. It is limited to the provisioning of an IPCablecom embedded-MTA device by a single provisioning and network management provider. + +NOTE – The structure and content of this Recommendation have been organized for ease of use by those familiar with the original source material; as such, the usual style of ITU-T recommendations has not been applied. + +# 2 References + +## 2.1 Normative references + +The following ITU-T Recommendations and other references contain provisions which, through reference in this text, constitute provisions of this Recommendation. At the time of publication, the editions indicated were valid. All Recommendations and other references are subject to revision; users of this Recommendation are therefore encouraged to investigate the possibility of applying the most recent edition of the Recommendations and other references listed below. A list of the currently valid ITU-T Recommendations is regularly published. The reference to a document within this Recommendation does not give it, as a stand-alone document, the status of a Recommendation. + +- [ITU-T J.83] ITU-T Recommendation J.83 (2007), *Digital multi-programme systems for television, sound and data services for cable distribution*. +- [ITU-T J.112.B] ITU-T Recommendation J.112 Annex B (2004), *Data-over-cable service interface specifications: Radio-frequency interface specification*. +- [ITU-T J.162] ITU-T Recommendation J.162 (2007), *Network call signalling protocol for the delivery of time-critical services over cable television networks using cable modems*. +- [ITU-T J.166] ITU-T Recommendation J.166 (2007), *IPCablecom Management Information Base (MIB) framework*. +- [ITU-T J.170] ITU-T Recommendation J.170 (2005), *IPCablecom security specification*. +- [IETF RFC 2131] IETF RFC 2131 (1997), *Dynamic Host Configuration Protocol*. +- [IETF RFC 2132] IETF RFC 2132 (1997), *DHCP Options and BOOTP Vendor Extensions*. +- [IETF RFC 2475] IETF RFC 2475 (1998), *An Architecture for Differentiated Services*. +- [IETF RFC 2616] IETF RFC 2616 (1999), *Hypertext Transfer Protocol – HTTP/1.1*. +- [IETF RFC 2833] IETF RFC 2833 (2000), *RTP Payload for DTMF Digits, Telephony Tones and Telephony Signals*. +- [IETF RFC 2863] IETF RFC 2863 (2000), *The Interfaces Group MIB*. +- [IETF RFC 3396] IETF RFC 3396 (2002), *Encoding Long Options in the Dynamic Host Configuration Protocol (DHCPv4)*. + +- [IETF RFC 3410] IETF RFC 3410 (2002), *Introduction and Applicability Statements for Internet Standard Management Framework*. +- [IETF RFC 3411] IETF RFC 3411 (2002), *An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks*. +- [IETF RFC 3412] IETF RFC 3412 (2002), *Message Processing and Dispatching for the Simple Network Management Protocol (SNMP)*. +- [IETF RFC 3413] IETF RFC 3413 (2002), *Simple Network Management Protocol (SNMP) Applications*. +- [IETF RFC 3414] IETF RFC 3414 (2002), *User-based Security Model (USM) for version 3 of the Simple Network Management Protocol (SNMPv3)*. +- [IETF RFC 3415] IETF RFC 3415 (2002), *View-based Access Control Model (VACM) for the Simple Network Management Protocol (SNMP)*. +- [IETF RFC 3495] IETF RFC 3495 (2003), *Dynamic Host Configuration Protocol (DHCP) Option for CableLabs Client Configuration*. +- [IETF RFC 3584] IETF RFC 3584 (2003), *Coexistence between Version 1, Version 2, and Version 3 of the Internet-standard Network Management Framework*. +- [IETF RFC 3594] IETF RFC 3594 (2003), *PacketCable Security Ticket Control Sub-Option for the DHCP CableLabs Client Configuration (CCC) Option*. +- [IETF RFC 3617] IETF RFC 3617 (2003), *Uniform Resource Identifier (URI) Scheme and Applicability Statement for the Trivial File Transfer Protocol (TFTP)*. + +## 2.2 Informative references + +- [IETF RFC 3315] IETF RFC 3315 (2003), *Dynamic Host Configuration Protocol for IPv6 (DHCPv6)*. +- [IETF RFC 4682] IETF RFC 4682 (2006), *Multimedia Terminal Adapter (MTA) Management Information Base for PacketCable- and IPCablecom-Compliant Devices*. +- [IETF RFC 5098] IETF RFC 5098 (2008), *Signaling MIB for PacketCable and IPCablecom Multimedia Terminal Adapters (MTAs)*. +- [IETF-draft-eventmess] IETF Internet Draft, *Management Event Management Information Base (MIB) for PacketCable- and IPCablecom-compliant Devices*, October 2006,
The client device begins device registration by having the CM component send a broadcast DHCP discover message.
Included in this message is option code 60 (Vendor Specific Option) in the format "docsis1.1:xxxxxxx". This message MUST request option 122 in option 55, the request parameter list. The remainder of this message MUST conform to the DHCP discover data as defined in the DOCSIS Recommendations.
|Initial
MUST step in sequence
| Per DOCSIS | +| CM2 |The DOCSIS DHCP Server, if it has been configured to support MTA devices, MUST include option code 122 with sub-option 1 and, possibly, sub-option 2 as per clause 8.1. If it is configured to prevent the MTA portion of the device from provisioning, then sub-option 1 in option code 122 MUST contain a DHCP server address of value 0.0.0.0.
DOCSIS DHCP Servers without any prior knowledge of MTA devices MAY respond with DHCP OFFER without including option 122.
|CM2
MUST occur after CM1 completion
| Per DOCSIS | +| CM3 |Upon receiving a DHCP OFFER, the CM MUST check for the requested option 122. If it is not present, then it MUST retry the DHCP DISCOVER process (CM1) exponentially for 3 attempts (e.g., 2-, 4-, 8-second intervals). Upon failing to receive any DHCP OFFER with option 122 after the exponential retry mechanism, it MUST consider OFFERs without option code 122 and accept one of them as per the DHCP specification [IETF RFC 2131]. The client device (CM) MUST then send a DHCP REQUEST broadcast message to the DHCP server whose OFFER is accepted as specified in the DHCP specification [IETF RFC 2131].
|CM3
MUST occur after CM2 completion
| Per DOCSIS | +| CM4 |The DHCP server sends the client device CM component a DHCP ACK message to confirm acceptance of the offered data. Upon receiving the DHCP ACK, the CM MUST check again for option 122. The absence of option 122 in the DHCP ACK message, which was accepted by the CM, implies that it MUST NOT initialize the embedded MTA. The presence of option 122 implies that it MUST initialize the MTA and pass sub-option 1 and, possibly, sub-option 2.
If the option content of this DHCP ACK differs from the preceding DHCP OFFER, the option content of this DHCP ACK MUST be treated as authoritative (per [IETF RFC 2131]).
|CM4
MUST occur after CM3 completion
| Per DOCSIS | +| CM5-CM10 |The client device's CM component completes the remainder of the CM specified registration sequence. This includes downloading the CM configuration file, requesting time of day registration and registering with the CMTS.
|CM5-CM10
MUST occur after CM4 completion
| Per DOCSIS | + +**Table 1 – Embedded-MTA power-on initialization flow description (IPv4 eCM)** + +| Flow | Embedded-MTA power-on initialization flow description | Normal flow sequencing | MUST proceed to here if this step fails | +|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|-----------------------------------------------------| +| MTA1 |DHCP Broadcast Discover. The MTA MUST send a broadcast DHCP DISCOVER message. This message MUST include option code 60 (Vendor Specific Option) in the format "pktc1.0:xxxxxx". The MTA MUST include the DHCP option code 43 in the DHCP DISCOVER message as defined in clause 8.5. The MTA MUST request in DHCP option 55 the following: 1, 3, 6, 7, 12, 15 and 122 options. If the CM DHCP option code 122 sub-option 1 (passed by the CM to the MTA) contains a DHCP server of value of 0.0.0.0, then the MTA MUST not attempt to provision and MUST remain dormant until it is reinitialized by the CM.
|MTA1
MUST NOT occur before completion of CM4
|If failure per DHCP protocol, repeat MTA1
| +| MTA2 |DHCP OFFER
The MTA may receive multiple DHCP OFFERs (during its wait period as per [IETF RFC 2131]).
The following requirements apply to the MTA and/or the Provisioning Applications.
- 1) The MTA MUST only accept a valid DHCP OFFER message. A valid DHCP OFFER MUST be sent by the primary or secondary DHCP servers returned in DHCP option code 122 sub-options 1 and 2 as obtained by the E-MTA via the CM provisioning step CM4. A valid DHCP OFFER MUST also include the following options: 1, 3, 6, 7, 12, 15, 122 with DHCP option 122 sub-options 3 and 6. DHCP option 122 MAY contain the additional sub-options 4, 5, 7, 8 and 9.
- 2) If the DHCP option 122 sub-option 6 returned by a valid DHCP server indicates that the Basic or Hybrid flow must be performed, the MTA MUST ignore the DHCP option 122 sub-options 4, 5, 7 and 9 if they are present.
- 3) If the DHCP option 122 sub-option 6 returned by a valid DHCP server indicates that the Basic Flow must be performed, the Provisioning Server MUST include the configuration file location in the 'siaddr' and 'file' fields in the DHCP responses.
- 4) If the DHCP option 122 sub-option 6 returned by a valid DHCP server indicates the Secure flow must be performed, the MTA MUST process the DHCP option 122 sub-options 4, 5, 7 and 9.
The MTA next applies the following rules to the set of valid DHCP OFFERs:
- a) The MTA MUST check the value of the DHCP option 122 sub-option 3. If all valid OFFERs contain 0.0.0.0 in DHCP option 122 sub-option 3, then the MTA MUST not further the DHCP process and it MUST shut down until it is reinitialized. Otherwise, the MTA MUST further restrict its set of valid OFFERs to those with a non-zero value in the DHCP option 122 sub-option 3.
MTA2
MUST occur after MTA1 completion
|If failure per DHCP protocol, return to MTA1
| + +**Table 1 – Embedded-MTA power-on initialization flow description (IPv4 eCM)** + +| Flow | Embedded-MTA power-on initialization flow description | Normal flow sequencing | MUST proceed to here if this step fails | +|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|-----------------------------------------------------| +| MTA2 |b) The MTA MUST check the value of the DHCP option 122 sub-option 6 for indication of the Secure Flow. If no valid DHCP OFFER message directs the MTA to the Secure flow, the MTA MUST retry the DHCP DISCOVER process (MTA1) exponentially for 3 attempts (e.g., 2-, 4-, 8-second intervals). Upon failing to receive any valid DHCP OFFER indicating the Secure flow, the MTA MUST select a valid Hybrid Flow DHCP OFFER, or a valid Basic Flow OFFER in that order.
If no valid DHCP OFFER is received, the MTA MUST fail the corresponding provisioning flow step.
NOTE – In the case of Secure Flow, if an MTA supports TGTs and receives the DHCP option 122 sub-option 7 set to a FALSE value, it MUST NOT request TGTs. If an MTA supports TGTs and receives the DHCP option 122 sub-option 7 set to a TRUE value, it MUST request TGTs. MTAs that do not support TGTs MUST ignore the DHCP option 122 sub-option 7.
| | | +| MTA3 |DHCP Broadcast REQUEST
Once the MTA has selected a valid DHCP OFFER, the MTA MUST send a DHCP REQUEST broadcast message to accept the DHCP OFFER per [IETF RFC 2131].
|MTA3
MUST occur after MTA2 completion
|If failure per DHCP protocol, return to MTA1
| +| MTA4 |DHCP ACK
The DHCP server sends a DHCP ACK message to the MTA. The DHCP ACK message MUST include all options and sub-options which had been sent in MTA2 (DHCP OFFER). If the option and sub-option values of this DHCP ACK differ from the preceding DHCP OFFER (MTA2), the option and sub-option values of this DHCP ACK MUST be treated as authoritative (per [IETF RFC 2131]).
If the DHCP ACK is not valid as per the criteria established in MTA2, the MTA MUST fail this step.
NOTE – The provisioning flow forks into one of three directions as follows:
If the MTA4 DHCP ACK indicates the Basic Flow, the MTA MUST proceed to flow step B-MTA-22 described in clause 7.3.
If the MTA4 DHCP ACK indicates the Hybrid Flow, the MTA MUST proceed to flow step H-MTA-15 described in clause 7.4.
Otherwise, the Secure Flow is indicated and the MTA MUST proceed to step MTA5 below.
|MTA4
MUST occur after MTA3 completion
|If failure per DHCP protocol, return to MTA1
| +| MTA5 |DNS Srv Request
The MTA requests the MSO KDC host name for the Kerberos realm.
|MTA5
MUST occur after MTA4 completion
|MTA1
| +| MTA6 |DNS Srv Reply
Returns the MSO KDC host name associated with the provisioning REALM.
|MTA6
MUST occur after MTA5 completion
|MTA1
| + +**Table 1 – Embedded-MTA power-on initialization flow description (IPv4 eCM)** + +| Flow | Embedded-MTA power-on initialization flow description | Normal flow sequencing | MUST proceed to here if this step fails | +|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|----------------------------------------------------------------------------------------| +| MTA7 | DNS RequestThe MTA now requests the IP Address of the MSO KDC. | MTA7
MUST occur after MTA6 completion | MTA1 | +| MTA8 | DNS Reply
The DNS Server returns the IP Address of the MSO KDC. | MTA8
MUST occur after MTA7 completion | MTA1 | +| MTA9 | AS Request
The AS Request message is sent to the MSO KDC to request a Kerberos ticket. | If MTA9 occurs, it MUST occur after MTA8 completion | MTA1
The failure conditions are defined by the security specification [ITU-T J.170] | +| MTA10 | AS Reply
The AS Reply Message is received from the MSO KDC containing the Kerberos ticket.
NOTE 1 – The KDC must map the MTA MAC address to the FQDN before sending the AS Reply.
NOTE 2 – Flows MTA11-MTA12 are optional in some cases, refer to the security specification ([ITU-T J.170]).
NOTE 3 – SNMPv3 entity (FQDN) MUST be resolved to an IP address anywhere during flows MTA5 to MTA12.
NOTE 4 – If an IP address is provided in the Additional information field of the DNS-SRV response (MTA6), MTA MAY use the same and skip the flows MTA7 and MTA8.
NOTE 5 – If the MTA has valid provisioning application server ticket saved in NVRAM, then it MUST skip the flows MTA5 to MTA12 in successive MTA resets (flows MTA1 to MTA25). | MTA10
MUST occur after MTA9 completion | MTA1 | +| MTA11 | TGS Request
If MTA obtained TGT in MTA10, the TGS Request message is sent to the MSO KDC. | If MTA11 occurs, it MUST occur after MTA10 completion | MTA1 | +| MTA12 | TGS Reply
The TGS Reply message is received from the MSO KDC. | MTA12
MUST occur after MTA11 completion | MTA1 | +| MTA13 | AP Request
The AP Request message is sent to the Provisioning Server to request the keying information for SNMPv3. | MTA13
MUST occur after MTA12 or MTA10 completion | MTA1
The failure conditions are defined by the security specification [ITU-T J.170] | + +**Table 1 – Embedded-MTA power-on initialization flow description (IPv4 eCM)** + +| Flow | Embedded-MTA power-on initialization flow description | Normal flow sequencing | MUST proceed to here if this step fails | +|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------| +| MTA14 |
AP Reply
The AP Reply message is received from the Provisioning Server containing the keying information for SNMPv3.
NOTE – The SNMPv3 keys must be established before the next step using the information in the AP Reply.
|MTA14
MUST occur after MTA13 completion
| MTA1 | +| MTA15 |SNMP Enrolment INFORM
The MTA MUST send an SNMPv3 Enrollment INFORM to the PROV_SNMP_ENTITY (specified in the DHCP option 122 sub-option 3). The SNMP INFORM MUST contain a "PktcMtaDevProvisioningEnrolment" object as defined in [ITU-T J.166].
The PROV_SNMP_ENTITY notifies the Provisioning Application that the MTA has entered the management domain.
NOTE – The provisioning server can reset the MTA at this point in the flows. The MTA is part of the security domain and MUST respond to management requests, the SNMP INFORM of MTA15 is the indicator, see clause 5.4.1.2.
|MTA15
MUST occur after MTA14 completion
|If failure per SNMP protocol, return to MTA1.
SNMP server MUST send response to SNMP-INFORM.
| +| MTA16 |SNMPv3 GET Request (Optional). If any additional MTA device capabilities are needed by the PROV_APP, the PROV_APP requests these from the MTA via SNMPv3 Get Requests. This is done by having the PROV_APP send the PROV_SNMP_ENTITY a "get request" Iterative: The PROV_SNMP_ENTITY sends the MTA one or more SNMPv3 GET requests to obtain any needed MTA capability information. The Provisioning Application may use a GETBulk request to obtain several pieces of information in a single message.
|MTA16 is optional, can occur after MTA15 completion
| N/A | +| MTA17 |SNMPv3 GET Response
Iterative:
MTA sends the PROV_SNMP_ENTITY a response for each GET Request. After all the Gets, or the GetBulk, finish, the PROV_SNMP_ENTITY sends the requested data to the PROV_APP.
|MTA17
MUST occur after MTA16 completion if MTA16 is performed
| N/A | +| MTA18 |This Protocol is not defined by IPCablecom. The PROV_APP MAY use the information from MTA16 and MTA17 to determine the contents of the MTA Configuration Data file. Mechanisms for sending, storing and, possibly, creating the configuration file are outlined in MTA19.
|MTA18
SHOULD occur after MTA15 completion unless MTA16 is performed, then it SHOULD be after MTA17 has completed
| N/A | + +**Table 1 – Embedded-MTA power-on initialization flow description (IPv4 eCM)** + +| Flow | Embedded-MTA power-on initialization flow description | Normal flow sequencing | MUST proceed to here if this step fails | +|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------| +| MTA19 |SNMPv3 SET
The PROV_APP MAY create the configuration file at this point, or send a predefined one. A hash MUST be run on the contents of the configuration file. The configuration file MAY be encrypted. The hash and the encryption key (if the configuration file is encrypted) MUST be sent to the MTA. The PROV_APP MUST store the configuration file on the appropriate TFTP server.
The PROV_APP then instructs the PROV_SNMP_ENTITY to send an SNMP SET message to the MTA containing the following variables (defined in [ITU-T J.166]).
pktcMtaDevConfigFile pktcMtaDevProvConfigHash
and
pktcMtaDevProvConfigKey (This MUST NOT be included if the MTA configuration file is unencrypted).
NOTE 1 – In the case of file download using the HTTP access method, the filename MUST be URL-encoded with a URL format compliant with [IETF RFC 2616] with the exception stated below in Note 3.
NOTE 2 – In the case of file download using the TFTP access method, the filename MUST be URL-encoded with a URL format compliant with [IETF RFC 3617] with the exception stated below in Note 3.
NOTE 3 – MTA MUST accept IPv4 addresses embedded in URL encoded format with or without square brackets.
| MTA19 MUST occur after MTA18 completion | If failure per SNMP protocol, return to MTA1 | +| MTA20 |DNS Request
If the URL-encoded access method contains a FQDN instead of an IPv4 address, the MTA MUST use the service provider network's DNS server to resolve the FQDN into an IPv4 address of either the TFTP Server or the HTTP Server.
| MTA20 MUST occur after MTA19 completion if FQDN is used | If failure per DNS protocol, return to MTA1 | +| MTA21 |DNS Reply
DNS Response: DNS server returns the IP address against MTA20 DNS request.
| MTA21 MUST occur after MTA20 completion if FQDN is used | If failure per DNS protocol, return to MTA1 | +| MTA22 |TFTP/HTTP Configuration file Request
The MTA MUST perform either the TFTP or HTTP protocol exchange, as specified in step MTA19, to download its configuration file. For specific details of each protocol, see [IETF RFC 3415] and [IETF RFC 3412].
|MTA22 MUST occur:
After MTA19 if DNS resolution is not required.
After MTA21 if DNS resolution is required.
| If failure per TFTP or HTTP protocols, return to MTA1 | + +**Table 1 – Embedded-MTA power-on initialization flow description (IPv4 eCM)** + +| Flow | Embedded-MTA power-on initialization flow description | Normal flow sequencing | MUST proceed to here if this step fails | +|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MTA23 |TFTP/HTTP Configuration file Request
The TFTP/HTTP Server MUST send the requested configuration file to the MTA. Specific details of each protocol are found in [IETF RFC 3415] and [IETF RFC 3412]. The hash of the downloaded configuration file is calculated by the MTA and compared to the value received in step MTA19. If the hashes do not match, the MTA MUST fail this step. If encrypted, the configuration file MUST be decrypted.
Refer to clause 9.1 for MTA configuration file contents.
| MTA23 MUST occur after MTA22 completion |If the configuration file download failed per TFTP or HTTP protocols, return to MTA1.
Otherwise, proceed to MTA24 or MTA25, and send the failed response if the MTA configuration file itself is in error.
| +| MTA24 |SYSLOG Notification
If a SYSLOG server is configured and enabled as part of the Provisioning Process (Refer to step MTA2 for DHCP Options and ITU-T Rec. J.172, [ITU-T J.166] and [IETF-draft-eventness] for configuration using the MEM-MIB), then the MTA MUST send the voice service provider's SYSLOG a "provisioning complete" event indicating the status of the provisioning operation. This notification will include the pass-fail result of the provisioning operation. The general format of this notification is as defined in clause 5.4.3.
| MTA24 MUST occur after MTA23 completion if SYSLOG is configured | The MTA MAY retry this step before proceeding to MTA25 | +| MTA25 |SNMP INFORM
The MTA MUST send the PROV_SNMP_ENTITY (specified in DHCP option 122 sub-option 3) an SNMP INFORM containing a "provisioning complete" notification. The receipt of the inform is acknowledged by the response message as defined in [IETF RFC 3414].
The SNMP INFORM MUST contain a "pktcMtaDevProvisioningStatus" MIB object.
NOTE 1 – At this stage, the MTA device provisioning data is sufficient to provide any minimal services as determined by the service provider (e.g., 611).
NOTE 2 – Depending on the TLV-38 configuration, there might be multiple SNMP INFORMs sent to the configured SNMP Management stations.
| MTA25 MUST occur after MTA24 if SYSLOG is used, otherwise MUST occur after MTA23 completion |MTA MAY generate a Provisioning Failure event notification to the Service Provider's Fault Management server.
Provisioning process stops; manual interaction required.
SNMP server MUST send response to SNMP-INFORM.
| + +### 7.2.2 Embedded-MTA secure power-on initialization flow (IPv6 eCM) + + + +The diagram is a sequence diagram titled "eCM provisioning in IPv6 mode". It shows the following sequence of messages: + +- Start with DOCSIS Initialization/Registration** (highlighted in yellow) +- CM1v6: CMTS sends DHCPv6 SOLICIT (w/IPv6 CL Option Code CL\_OPTION\_ORO(1) with CL\_OPTION\_CCC) to DOCSIS DHCP. +- CM2v6: DOCSIS DHCP responds with DHCPv6 ADVERTISE (w/DHCPv6 OPTION\_VENDOR\_OPTS(17) including the CL Option Code CL\_OPTION\_CCC(122)) to CMTS. +- CM3v6: CMTS sends DHCPv6 REQUEST to DOCSIS DHCP. +- CM4v6: DOCSIS DHCP responds with DHCPv6 REPLY to CMTS. +- CM5v6: CMTS sends DOCSIS 3.0 CM config file request to DOCSIS TFTP. +- CM6v6: DOCSIS TFTP responds with DOCSIS 3.0 config file to CMTS. +- CM7v6: CMTS sends ToD Request to DOCSIS ToD. +- CM8v6: DOCSIS ToD responds with ToD Response to CMTS. +- CM9v6: CMTS sends CM registration with CMTS to DOCSIS DHCP. +- CM10v6: DOCSIS DHCP responds with CMTS Registration ACK to CMTS. +- Complete DOCSIS Initialization/Registration** (highlighted in yellow) +- After CM10v6, arrows point from CM/MTA, CMTS, DOCSIS DHCP, DOCSIS TFTP, DOCSIS ToD, Prov Server, PKT DHCP, PKT DNS, PKT TFTP, MSO KDC, and SYSLOG to the right, indicating the flow continues. + +Sequence diagram showing the eCM provisioning flow in IPv6 mode. The diagram illustrates the interaction between CM/MTA, CMTS, DOCSIS DHCP, DOCSIS TFTP, DOCSIS ToD, Prov Server, PKT DHCP, PKT DNS, PKT TFTP, MSO KDC, and SYSLOG. The flow starts with DOCSIS Initialization/Registration (CM1v6 to CM10v6) and ends with the completion of the flow. + +Figure 6a – eCM provisioning in IPv6 mode + +Table 1a – Embedded-MTA power-on initialization flow description (IPv6 eCM) + +| Flow | Embedded-MTA power-on initialization flow description | Normal flow sequencing | MUST proceed to here if this step fails | +|-------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|-----------------------------------------| +| NOTE – Refer to [ITU-T J.222.2] for a complete description of the eCM Provisioning Flows. This only provides IP configuration retrieval using DHCPv6. | | | | +| CM1v6 | As specified in DOCSIS, an eCM trying to obtain IP configuration information from a DHCPv6 server transmits a DHCPv6 SOLICIT message. The following requirements apply to the message:- – The eCM MUST include all the DHCPv6 Options required by [ITU-T J.222.2].
- – The eCM MUST request option CL_OPTION_CCC(122) within the "CableLabs Option Request Option", CL_OPTION_ORO(1), as specified in Annex A of [ITU-T J.166].
- – The eCM MUST include the CableLabs vendor specific options from CL_OPTION_DEVICE_TYPE(2) until CL_OPTION_VENDOR_NAME(10), inclusive, as specified in Annex A of [ITU-T J.166].
- – The eCM MUST include CL_OPTION_DEVICE_ID(36) as specified in Annex A of [ITU-T J.166].
MUST step in sequence | Per DOCSIS | +| CM2v6 | The DOCSIS DHCPv6 server, if it has been configured to support E-MTA devices, MUST respond with a DHCPv6 ADVERTISE message. The following requirements apply to the message:
- – The DOCSIS DHCPv6 server MUST include all the DHCPv6 options specified in [ITU-T J.222.2].
- – The DOCSIS DHCPv6 server MUST include the option OPTION_VENDOR_OPTS(17) containing option CL_OPTION_CCC with sub-option 1 and, possibly, sub-option 2.
- – A DOCSIS DHCPv6 server configured to prevent eMTAs from provisioning MUST include a value of 0.0.0.0 within sub-option 1 of CL_OPTION_CCC.
- – A DOCSIS DHCPv6 server without any prior knowledge of eMTA devices MAY respond with DHCP ADVERTISE messages without the CL_OPTION_CCC option.
Refer to clause 8.1 for more information on sub-options 1 and 2.
| | | +| CM3v6 |Upon receiving a DHCPv6 ADVERTISE by the eCM, the following requirements apply:
- – the eCM MUST check for the requested option CL_OPTION_CCC. If it is not present, the eCM MUST exponentially retransmit the DHCPv6 SOLICIT message (CM1v5) for three attempts (e.g., in two-, four-, eight-second intervals).
- – If the eCM does not receive any DHCPv6 ADVERTISE message with option CL_OPTION_CCC within the retry attempts, it MUST select a DHCPv6 ADVERTISE message without the option code CL_OPTION_CCC.
- – Once a DHCPv6 ADVERTISE message has been selected, the eCM MUST send a DHCPv6 REQUEST message to indicate acceptance, as specified in [IETF RFC 3315].
CM3v6 MUST occur after CM2v6 completion, unless two-message rapid commit message exchange is used
| Per DOCSIS | +| CM4v6 |The DOCSIS DHCPv6 server, upon receiving a DHCPv6 REQUEST message indicating its presence, MUST respond with a DHCPv6 REPLY message.
Upon receiving this message by an eCM, the following requirements apply:
- – the eCM MUST check again for the presence of option CL_OPTION_CCC. If it is not present, the eCM MUST NOT initialize the MTA. If it is present and the value of sub-option 1 is not set to a value of 0.0.0.0, the eCM MUST initialize the MTA and transmit the values pertaining to the Telephony Service Provider's DHCP server information (sub-option 1 and sub-option 2). If it is present and the value of sub-option 1 is set to a value of 0.0.0.0, the eCM MUST NOT initialize the MTA.
- – The eCM MUST treat the contents of the DHCPv6 REPLY message as authoritative over the DHCPv6 ADVERTISE message.
CM4v6 MUST occur after CM3v6 or CM1v6 (if rapid commit is used)
| Per DOCSIS | +| CM5v6-CM10v6 |The eCM MUST complete the remainder of the DOCSIS specified registration sequence.
|CM5v6-CM10v6 MUST occur after CM4v6 completion
| Per DOCSIS | +| MTA1-MTA25 |The eMTA MUST complete the remainder of the flow as indicated in clause 7.2.1.
|MTA1-MTA25 MUST occur after CM10v6 completion
| | + +## 7.3 Embedded-MTA power-on initialization flow (Basic flow) + +The Basic MTA provisioning flow is very similar to the DOCSIS CM provisioning flow. See Figure 7 and Table 2. + + + +Sequence diagram showing the Embedded-MTA basic power-on initialization flow. The diagram shows four steps: B-MTA-22 (Telephony config file request), B-MTA-23 (Telephony config file), B-MTA-24 (TA send telephony service provider SYSLOG a notification of provisioning completed (Optional)), and B-MTA-25 (Notify completion of telephony provisioning (MTA MAC address, ESN, pass/fail) - OPTIONAL). Arrows indicate the flow between CM/MTA, CM/MTS, DOCSIS DHCP, DOCSIS TFTP, DOCSIS ToD, Prov Server, PKT DHCP, PKT DNS, PKT TFTP, MSO KDC, and SYSLOG. + +Figure 7 – Embedded-MTA basic power-on initialization flow + +Table 2 – Embedded-MTA basic power-on initialization flow description + +| Flow | Embedded-MTA basic power-on initialization flow description | Normal flow sequencing | MUST proceed to here if this step fails | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE – The FQDN provided in the DHCP ACK in DHCP option 122 sub-option 3 (Provisioning Entity Address) MUST be resolved to an IP address before step B-MTA-22. | | | | +| B-MTA-22 | TFTP Configuration File RequestThe MTA MUST perform a TFTP protocol exchange to download its configuration file. The 'siaddr' and 'file' fields of the DHCP ACK are used to locate the configuration file. Specific details of the TFTP protocol can be found in [IETF RFC 3415]. | B-MTA-22 MUST occur after MTA4. | If failure per TFTP protocol, return to MTA1 | +| B-MTA-23 | TFTP Configuration File Response
The TFTP server MUST send the requested configuration file to the MTA. Specific details of the TFTP protocol can be found in [IETF RFC 3415].
The downloaded configuration file MUST contain the MIB object 'pktcMtaDevConfigHash'. The MTA MUST calculate the hash of the downloaded configuration file per clause 9.1 and compare this value to the value contained in the 'pktcMtaDevConfigHash' object. If these values do not match, this step MUST fail.
Refer to clause 9.1 for MTA configuration file contents. | B-MTA-23 MUST occur after B-MTA-22 | If the configuration file download failed per TFTP protocols, return to MTA1.
Otherwise, proceed to B-MTA-24 and send the failed response if the MTA configuration file itself is in error. | +| B-MTA-24 | SYSLOG Notification
If a SYSLOG server is configured and enabled as part of the Provisioning Process (refer to step MTA2 for DHCP options and ITU-T Rec. J.172, [ITU-T J.166] and [IETF-draft-eventmess] for configuration using the MEM-MIB), then the MTA MUST send the voice service provider's SYSLOG a "provisioning complete" event indicating the status of the provisioning operation. The general format of this notification is as defined in clause 5.4.3. | B-MTA-24 MUST occur after B-MTA-23 completion if SYSLOG is configured | The MTA MAY retry this step before proceeding to B-MTA-25 | + +**Table 2 – Embedded-MTA basic power-on initialization flow description** + +| Flow | Embedded-MTA basic power-on initialization flow description | Normal flow sequencing | MUST proceed to here if this step fails | +|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------| +| B-MTA-25 |
SNMPv2c Provisioning Status INFORM (optional)
If commanded by DHCP option 122 sub-option 6, the MTA MUST send the PROV_SNMP_ENTITY (specified in DHCP option 122 sub-option 3) an SNMP INFORM containing a "provisioning complete" notification. The receipt of the SNMP INFORM is acknowledged.
The SNMP INFORM MUST contain a "pktcMtaDevProvisioningStatus" MIB object.
The SNMPv2c community name used in the status SNMP INFORM MUST have a value "private" (taken without the quotation mark).
NOTE 1 – At this stage, the MTA device provisioning data is sufficient to provide any minimal services as determined by the service provider (e.g., 611).
NOTE 2 – Depending on the TLV-38 configuration value pairs, there might be multiple SNMP INFORMs sent to the configured SNMP Management stations.
| B-MTA-25 is optional, MAY occur after B-MTA-24 if SYSLOG is used, otherwise MAY occur after B-MTA-23 completion | Provisioning process stops; Manual interaction required. SNMP server MUST send response to SNMP-INFORM. | + +## **7.4 Embedded-MTA power-on initialization flow (Hybrid flow)** + +The Hybrid Provisioning Flow (Hybrid Flow) is essentially the Secure Flow with Kerberos exchanges removed and SNMPv2c substituted for SNMPv3. The SNMPv2c community name, used in the SNMP INFORM messages sent by the MTA in steps H-MTA-15 and H-MTA-25 below, MUST have a value "private" (taken without the quotation mark). See Figure 8 and Table 3. + + + +``` + +sequenceDiagram + participant CM_MTA as CM/MTA + participant CMTS + participant DOCSIS_DHCP as DOCSIS DHCP + participant DOCSIS_TFTP as DOCSIS TFTP + participant DOCSIS_ToD as DOCSIS ToD + participant Prov_Server as Prov Server + participant PKT_DHCP as PKT DHCP + participant PKT_DNS as PKT DNS + participant PKT_TFTP as PKT TFTP + participant MSO_KDC as MSO KDC + participant SYSLOG + + Note over CM_MTA, Prov_Server: H-MTA-15: SNMP Inform (see table for data list) + CM_MTA->>Prov_Server: SNMP Inform + Note over CM_MTA, Prov_Server: H-MTA-16: SNMP Get Request(s) for MTA device capabilities (optional/iterative) + Prov_Server->>CM_MTA: SNMP Get Request + Note over CM_MTA, Prov_Server: H-MTA-17: SNMP Get Response(s) containing MTA device capabilities (optional/iterative) + CM_MTA->>Prov_Server: SNMP Get Response + Note over Prov_Server, PKT_TFTP: H-MTA-18: MTA config file + Prov_Server->>PKT_TFTP: MTA config file + Note over CM_MTA, Prov_Server: H-MTA-19: SNMP Set with URL encoded file download access method (TFTP or HTTP), filename, and hash + Prov_Server->>CM_MTA: SNMP Set + Note over CM_MTA, PKT_DNS: H-MTA-20: Resolve TFTP server FQDN + CM_MTA->>PKT_DNS: Resolve TFTP server FQDN + Note over CM_MTA, PKT_DNS: H-MTA-21: TFTP server IP address + PKT_DNS->>CM_MTA: TFTP server IP address + Note over CM_MTA, PKT_TFTP: H-MTA-22: Telephony config file request + CM_MTA->>PKT_TFTP: Telephony config file request + Note over CM_MTA, PKT_TFTP: H-MTA-23: Telephony config file + PKT_TFTP->>CM_MTA: Telephony config file + Note over CM_MTA, SYSLOG: H-MTA-24: MTA send telephony service provider SYSLOG a notification of provisioning completed (Optional) + CM_MTA->>SYSLOG: SYSLOG notification + Note over CM_MTA, Prov_Server: H-MTA-25: Notify completion of telephony provisioning (MTA MAC address, ESN, pass/fail) - OPTIONAL + CM_MTA->>Prov_Server: Notify completion + +``` + +Sequence diagram for Embedded-MTA hybrid power-on initialization flow (Hybrid flow). + +**Figure 8 – Embedded-MTA hybrid power-on initialization flow** + +**Table 3 – Embedded-MTA hybrid power-on initialization flow description** + +| Flow | Embedded-MTA hybrid power-on initialization flow description | Normal flow sequencing | MUST proceed to here if this step fails | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------| +| NOTE – The FQDN provided in the DHCP ACK in DHCP option 122 sub-option 3 (Provisioning Entity Address) MUST be resolved to an IP address before step H-MTA-15. | | | | +| H-MTA-15 |SNMPv2c Enrolment INFORM
The MTA MUST send a SNMPv2c Enrolment INFORM to PROV_SNMP_ENTITY (specified in the DHCP option 122 sub-option 3). The SNMP INFORM MUST contain a 'PktcMtaDevProvisioningEnrollment' object as defined in [ITU-T J.166].
The PROV_SNMP_ENTITY notifies the PROV_APP that the MTA has entered the management domain.
| H-MTA-15 MUST occur after MTA4 completion | If failure per SNMP protocol, return to MTA1. SNMP server MUST send response to SNMP-INFORM. | +| H-MTA-16 |SNMPv2c GET Request (optional)
The Provisioning Application may request additional MTA device capabilities from the MTA via SNMPv2c GET requests. This is done by having the Provisioning Application send the PROV_SNMP_ENTITY an SNMP GET request.
Iterative:
The PROV_SNMP_ENTITY sends the MTA one or more SNMPv2c GET requests to obtain any needed MTA capability information. The Provisioning Application may use a GETBulk request to obtain several pieces of information in a single message.
| H-MTA-16 is optional, can occur after H-MTA-15 completion | N/A | +| H-MTA-17 |SNMPv2c GET Response (optional)
Iterative:
MTA sends the PROV_SNMP_ENTITY a Get Response for each Get Request.
After all the Gets, or the GetBulk, finish, the PROV_SNMP_ENTITY sends the requested data to the Provisioning Application.
| H-MTA-17 MUST occur after H-MTA-16 completion if H-MTA-16 is performed | N/A | +| H-MTA-18 |This protocol is not defined by IPCablecom.
The Provisioning Application MAY use the information from H-MTA-15, -16, and -17 to determine the contents of the MTA configuration data file. Mechanisms for sending, storing and, possibly, creating the configuration file are outlined in H-MTA-19.
| H-MTA-18 SHOULD occur after H-MTA-15 completion unless H-MTA-16 is performed, then it SHOULD be after H-MTA-17 has completed | N/A | + +**Table 3 – Embedded-MTA hybrid power-on initialization flow description** + +| Flow | Embedded-MTA hybrid power-on initialization flow description | Normal flow sequencing | MUST proceed to here if this step fails | +|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|--------------------------------------------------------| +| H-MTA-19 |SNMPv2c Configuration File Set
The Provisioning Application MAY create the configuration file at this point, or send a predefined one. The Provisioning Application MUST calculate SHA-1 hash on the contents of the configuration file. The Provisioning Application MUST store the configuration file on the appropriate TFTP server.
The Provisioning Application then instructs the PROV_SNMP_ENTITY to send an SNMPv2c SET message to the MTA, containing the following varbindings (defined in [ITU-T J.166]):
pktcMtaDevConfigFile
pktcMtaDevProvConfigHash
Unlike the Secure Flow, the pktcMtaDevProvConfigKey MIB object MUST NOT be included. If the pktcMtaDevProvConfigKey MIB object is included, the MTA MUST return an 'inconsistent value' error (refer to [IETF RFC 3413] for more information regarding SNMP SET Responses).
NOTE 1 – In the case of file download using the HTTP access method, the filename MUST be URL-encoded with a URL format compliant with [IETF RFC 2616] with the exception stated below in Note 3.
NOTE 2 – In the case of file download using the TFTP access method, the filename MUST be URL-encoded with a URL format compliant with [IETF RFC 3617] with the exception stated below in Note 3.
NOTE 3 – MTA MUST accept IPv4 addresses embedded in URL encoded format with or without square brackets.
| H-MTA-19 MUST occur after H-MTA-18 completion | If failure per SNMP protocol, return to MTA1 | +| H-MTA-20 |DNS Request (optional)
If the URL-encoded access method contains a FQDN instead of an IPv4 address, the MTA MUST use the service provider network's DNS server to resolve the FQDN into an IPv4 address of either the TFTP Server or the HTTP Server.
| H-MTA-20 MUST occur after H-MTA-19 completion if FQDN is used | If failure per DNS protocol, return to MTA1 | +| H-MTA-21 |DNS Reply (optional)
DNS Response: DNS server returns the IP address against H-MTA-20 DNS request.
| H-MTA-21 MUST occur after H-MTA-20 completion if FQDN is used | If failure per DNS protocol, return to MTA1 | +| H-MTA-22 |TFTP/HTTP Configuration file Request
The MTA MUST perform either the TFTP or HTTP protocol exchange, as specified in step H-MTA-19, to download its configuration file. For specific details of each protocol, see [IETF RFC 3415] and [IETF RFC 3412].
| H-MTA-22 MUST occur after H-MTA-19 unless FQDN is specified then MUST be after H-MTA-21. | If failure per TFTP or HTTP protocols, return to MTA1. | + +**Table 3 – Embedded-MTA hybrid power-on initialization flow description** + +| Flow | Embedded-MTA hybrid power-on initialization flow description | Normal flow sequencing | MUST proceed to here if this step fails | +|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| H-MTA-23 |TFTP/HTTP Configuration file Response
TFTP/HTTP server MUST send the requested configuration file to the MTA. Specific details of each protocol are found in [IETF RFC 3415] and [IETF RFC 3412].
The hash of the downloaded configuration file is calculated by the MTA and compared to the value received in step H-MTA-19. If the hashes do not match, this step MUST fail.
Refer to clause 9.1 for MTA configuration file contents.
| H-MTA-23 MUST occur after H-MTA-22 |If the configuration file download failed per TFTP or HTTP protocols, return to MTA1.
Otherwise, proceed to MTA24 or MTA25, and send the failed response if the MTA configuration file itself is in error.
| +| H-MTA-24 |SYSLOG Notification
If a SYSLOG server is configured and enabled as part of the Provisioning Process (Refer to step MTA2 for DHCP Options and ITU-T Rec. J.172, [ITU-T J.166] and [IETF-draft-eventmess] for configuration using the MEM-MIB), then the MTA MUST send the voice service provider's SYSLOG a "provisioning complete" event indicating the status of the provisioning operation. This notification will include the pass-fail result of the provisioning operation. The general format of this notification is as defined in clause 5.4.3.
| H-MTA-24 MUST occur after H-MTA-23 completion if SYSLOG is configured | The MTA MAY retry this step before proceeding to H-MTA-25 | +| H-MTA-25 |SNMPv2c Provisioning Status Inform (optional)
If commanded by DHCP 122 sub-option 6, the MTA MUST send the PROV_SNMP_ENTITY (specified in DHCP option 122 sub-option 3) a SNMPv2C Provisioning Status INFORM containing a "provisioning complete" notification. The receipt of the inform is acknowledged.
The inform MUST contain a 'pktcMtaDevProvisioningStatus' MIB object.
NOTE 1 – At this stage, the MTA device provisioning data is sufficient to provide any minimal services as determined by the service provider (e.g., 611).
NOTE 2 – Depending on the TLV-38 configuration, there might be multiple SNMPv2c INFORM sent to the configured SNMP Management stations.
| H-MTA-25 is optional. It MAY occur after H-MTA-24 if SYSLOG is used, otherwise it MAY occur after H-MTA-23 completion | Provisioning process stops; manual interaction required. SNMP server MUST send response to SNMP-INFORM | + +## 7.5 Endpoint provisioning completion notifications + +After the MTA has been provisioned successfully regardless of the selected provisioning flow, the MTA will set up the necessary security association for the related CMS configured realms (KDCs). The MTA NCS signalling software will initiate the establishment of the IPsec security association to the configured CMS clusters. Event notifications are triggered if security associations cannot be established (based on [ITU-T J.170]). + +With the selected Basic, Hybrid, or Secure flow complete, and after any required security associations are established, the MTA NCS signalling software determines whether a signalling path can be set up with an RSIP message and the associated ACK. Coming from a link down situation, the MTA will send an SNMP Link Up Trap when the RSIP has been properly acknowledged. This indicates that the endpoint is provisioned. If the same CMS is used for multiple endpoints, a SNMP link up message will be sent for each associated endpoint. If not all endpoints use the same CMS, the same process needs to be repeated for each endpoint needing a different configured CMS. + +## **7.6 Post initialization incremental provisioning** + +This clause describes the flows allowing the Provisioning Application to perform incremental provisioning of individual voice communications endpoints after the MTA has been initialized. Post-initialization incremental provisioning MAY involve communication with a customer service representative (CSR). + +### **7.6.1 Synchronization of provisioning attributes with configuration file** + +Incremental provisioning includes adding, deleting and modifying subscriber services on one or more endpoints of the embedded-MTA. Services on an MTA endpoint MUST be modified using SNMP via the MTA MIB [ITU-T J.166] and [IETF RFC 4682]. The back office applications SHOULD support a "flow-through" provisioning mechanism that synchronizes all device provisioning information on the embedded-MTA with the appropriate back office databases and servers. Synchronization is required in the event that provisioning information needs to be recovered in order to reinitialize the device. Although the details of the back office synchronization are beyond the scope of this Recommendation, it is expected that, at a minimum, the following information be updated: customer records and the MTA configuration file on the TFTP or HTTP server. + +### **7.6.2 Adding/Enabling telephone services on an MTA endpoint** + +The Telephony Services may be added and/or enabled on an MTA endpoint. Telephony Services may be added to MTA endpoints that have not been previously provisioned. + +Whenever such an MTA endpoint is added/enabled: + +- The MTA MUST have been provisioned with the 'device level' configuration data via the configuration file (as described in clause 9.1.1). +- The authorized SNMP Management Station MUST provision all required configuration attributes as described in clauses 9.1.3, 9.1.4 and 9.1.5 using SNMP SET operations to update the provisioning attributes on the device for the specific telephony port being enabled. + +Telephony Services may be enabled for MTA endpoints with services provisioned, but disabled (refer to clauses 7.6.3 and 9.1.1 for more details). To enable previously disabled telephony services on the MTA endpoint, an authorized SNMP Management Station MUST use appropriate SNMP SET operations to achieve both of the following: + +- Ensure that the row status MIB Object (pktcNcsEndPntConfigStatus) for the row corresponding to the endpoint is set to a value of "active (1)" (modify it appropriately if it is set to any other value). +- Ensure that the value of "ifAdminStatus" corresponding to the endpoint being enabled has a value of "up(2)" (modify it appropriately if it is set to any other value). + +When an endpoint is provisioned or enabled, the MTA MUST perform the following steps (not necessarily in this order): + +- Follow the procedures described in clause 7.1.1.2.5 of the security specification [ITU-T J.170]. +- Modify the "ifOperStatus" MIB Object according to clause 7.7. + +If "pktcMtaDevEnabled" MIB Object is set to "true (1)", the MTA MUST follow the above steps for all configured endpoints. + +It is to be noted that, given the nature of the MIB Object controlling the absence or presence of IPsec Security Associations with a Call Management Server, Endpoint Provisioning cannot be used to change the IPsec status (refer to Annex B of [ITU-T J.166] and [IETF RFC 4682] for more information). Thus, enabling new services with a Call Management Server whose status has not been indicated earlier (via the configuration file) will result in IPsec being enabled, upon assignment to an endpoint. + +As an example of enabling telephony services on an endpoint, consider the case where a subscriber has requested service on an endpoint that has not been previously provisioned. + +NOTE – This example assumes the service provider's account creation process has been completed, and shows only the components critical for the flows. For instance, account creation and billing database creation are assumed to be available and integrated in the back office application suite. + + + +| Flow | MTA | SNMP | +|------|---------------------------------------------------------------------|------| +| EN-1 | Update endpoint service provisioning information using SNMP set(s). | | +| EN-2 | Sends Link Up Trap | | + +Sequence diagram showing two flows (EN-1 and EN-2) between an MTA and an SNMP Management Station. EN-1: MTA sends an 'Update endpoint service provisioning information using SNMP set(s)' message to the SNMP station. EN-2: The SNMP station sends a 'Sends Link Up Trap' message back to the MTA. + +J.167\_F09 + +**Figure 9 – Enabling services on an MTA endpoint** + +**Table 4 – Enabling services on an MTA endpoint flow description** + +| Flow | Enabling services on an MTA endpoint flow description | Normal flow sequencing | +|------|-------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| +| EN-1 | Authorized SNMP Management Station performs required SNMP SET operations to add services on the MTA Endpoint. | If Endpoint configuration is desired, EN-1 MUST occur after successful completion of power-on initialization flow | +| EN-2 | The MTA MUST send a Link Up trap to the configured SNMP Management Stations. Refer to clause 7.7 and the IF-MIB [IETF RFC 2863] for more information. | EN-2 MUST occur after EN-1 | + +### 7.6.3 Deleting/Disabling telephony services on an MTA endpoint + +Provisioned and enabled Telephony Services can be disabled (taken out of service) or deleted if required using SNMP via the MTA MIB ([ITU-T J.166] and [IETF RFC 4682]) and the Signaling MIB ([ITU-T J.166] and [IETF RFC 5098]) on a per-endpoint basis. + +Whenever a telephony service is desired to be deleted on an endpoint, the authorized SNMP Management Station MUST delete appropriate configuration attributes described in clauses 9.1.3, 9.1.4 and 9.1.5 using SNMP SET operations for the corresponding endpoint. + +To disable the services on an MTA endpoint, an authorized SNMP Management Station MUST use SNMP SET operations to accomplish one or more of the following conditions: + +- For the particular endpoint, modify the row status object to a value other than "active (1)" in "pktcNcsEndPntConfigTable". +- Modify the value of "ifAdminStatus" to "down (2)", for the particular endpoint. + +If the endpoint is being deleted or disabled while a call is in progress, the MTA MUST: + +- Shut down all media sessions if present. +- Shut down NCS signalling by following the Restart in Progress procedures in the IPCablecom NCS Specification [ITU-T J.162]. +- Set the pktcNcsEndPntStatusError MIB Object for the particular endpoint to the "disconnected (3)" state. + +If "pktcMtaDevEnabled" MIB Object is set to "false (2)", the MTA MUST follow the above procedure for all configured endpoints. + +As an example of disabling telephony services on an endpoint, consider the case where a subscriber has requested disabling telephony services on a previously configured endpoint. + +NOTE 1 – It is assumed that the service provider's account update process has been completed and shows only the applications critical to MTA operation. + +NOTE 2 – This example assumes the service provider's account update process has been completed and shows only the applications critical to MTA operation. + + + +| Flow | MTA | SNMP | +|------|---------------------------------------------------------------------|------| +| DS-1 | Delete endpoint service provisioning information using SNMP set(s). | | +| DS-2 | Sends Link Down Trap | | + +Sequence diagram showing two flows, DS-1 and DS-2, between an MTA and an SNMP Management Station. DS-1 involves the MTA deleting endpoint service provisioning information using an SNMP set(s). DS-2 involves the MTA sending a Link Down Trap to the SNMP Management Station. + +J.167\_F10 + +**Figure 10 – Disabling services on an MTA endpoint** + +**Table 5 – Disabling services on an MTA endpoint flow description** + +| Flow | Disabling services on an MTA endpoint flow description | Normal flow sequencing | +|------|---------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DS-1 | Authorized SNMP Management Station performs required SNMP SET operations to disable services on the MTA Endpoint. | DS-1 MUST occur after the endpoint is brought to enabled state either immediately after the initial provisioning or after the per-endpoint incremental provisioning. | +| DS-2 | The MTA MUST send a Link Down trap to the configured SNMP Management Stations. Refer to clause 7.7 and the IF-MIB [IETF RFC 2863] for more information. | DS-2 MUST occur after DS-1 | + +### 7.6.4 Modifying telephone services on an MTA endpoint + +Telephony Services may be modified on a currently provisioned 'MTA Endpoint'. This is accomplished using SNMP via the MTA MIB ([ITU-T J.166] and [IETF RFC 4682]), and the Signalling MIB ([ITU-T J.166], and [IETF RFC 5098]) on a per-endpoint basis. If such a + +modification to an endpoint changes the CMS association (pktcNcsEndPntConfigCallAgentId) and/or the port (pktcNcsEndPntConfigCallAgentUdpPort), the endpoint is treated as being taken out of service (as per clause 7.6.3), followed by placing the endpoint back in service (as per clause 7.6.2). + +The MTA MUST also follow the procedures described in clause 7.1.1.2.5 of the security specification [ITU-T J.170]. + +It is to be noted that: + +- Modification to call service features requires modifications in the CMS, not in the MTA. +- Modification to service level parameters related to the eCM component of the eMTA may require rebooting of the E-MTA. + +## 7.7 Reflecting the State of the endpoint interface in the ifTable + +The operational state of each 'MTA Endpoint' is reflected in the "ifOperStatus" MIB Object of the MTA. This is influenced by the following conditions: + +- The corresponding administrative status for the endpoint, reflected in the "ifAdminStatus" table. +- The state of the telephony service assigned to the corresponding endpoint. +- The presence or absence of the IPSec security associations on the corresponding endpoint, provided IPSec is enabled (i.e., the MIB Object "pktcMtaDevCmsIpsSecCtrl" set to a value of "true(1)" for that endpoint). + +Whenever an MTA reinitializes (following a reboot or a reset), it MUST immediately set the "ifAdminStatus" entries corresponding to all available physical endpoints to a value of 'up (1)'. However, entries in the configuration file or the SNMP Management station can change this status. The MTA MUST further reflect the above conditions in the operational status of each endpoint as explained below. + +For each entry corresponding to an endpoint in the "ifTable" MIB, the MTA MUST set the "ifOperStatus" to a value of: + +- "down(2)", if the corresponding endpoint is disabled or deleted, or the corresponding "ifAdminStatus" is set to a value of "down(2)"; +- "up(1)", if the corresponding "ifAdminStatus" has a value of "up(1)", the telephony services have been added/enabled for the particular endpoint, and IPSec is disabled with the assigned Call Management Server; +- "up(1)", if the corresponding "ifAdminStatus" has a value of "up(1)", the telephony services have been added/enabled for the particular endpoint, IPSec is enabled for the assigned Call Management Server, and the IPSec Security association has been established; +- "dormant(3)", if the corresponding "ifAdminStatus" has a value of "up(1)", the telephony services have been added/enabled for the particular endpoint, IPSec is enabled for the assigned Call Management Server, but the IPSec Security association has not been established. + +Further, the MTA MUST not set the 'ifOperStatus' to a value of 'dormant(3)' for endpoints on which IPSec is disabled. Refer to [ITU-T J.166] for more details on enabling/disabling IPSec, clause 7.6.2 for more details on adding/enabling endpoints, and clause 7.6.3 for more details on deleting/disabling endpoints. + +The MTA MUST be able to enable or disable the 'Link Up Trap' and 'Link Down Trap' by using the "ifLinkUpDownTrapEnable" MIB Object (Refer to the IF-MIB [IETF RFC 2863] for more details). + +## 7.8 Provisioning of the signalling communication path between the MTA and CMS + +All issues related to the creation and handling of the NCS Service Flows are considered to be resolved by the DOCSIS means and are out of the scope of this Recommendation. + +## 7.9 MTA replacement + +IP Cablecom has no requirement to specify MTA replacement procedures. However, the provisioning sequence flows detailed within this Recommendation provide sufficient coverage and flexibility to support replacement. In fact, the initialization sequence for a replacement MTA could be the same as the original MTA's first time initialization. Back office procedures related to migration of subscriber profiles from one MTA to another are specific to individual service provider's network operations. As a result of this wide variance, discussion of these back office procedures are beyond the scope of this Recommendation. + +## 7.10 Temporary signal loss + +If the eCM (in an E-MTA) resets due to any Rf condition (for example Temporary Rf loss), then the associated IPCablecom eMTA MUST also reset. + +NOTE – This will impact calls in progress. + +## 7.11 MTA hard reboot/soft reset scenarios + +Hard Reboot is defined as a 'power cycle' of the entire E-MTA device. Soft Reset is defined as an 'SNMP reset' of the eMTA, an SNMP reset of the eCM (resulting in the reset of the associated eMTA) or an Rf condition that results in a reset of the eCM, i.e., CM1 or CM1v6 (resulting in the reset of the associated eMTA). + +The eMTA MUST NOT differentiate between a 'Hard Reboot' and a 'Soft Reset', unless explicitly specified otherwise. To be more specific, the eMTA MUST have the same initialization parameters (for example, SNMP tables) and follow any requirements regarding persistent information (e.g., NVRAM ticket storage) the same way in either scenario, unless specified otherwise. + +# 8 DHCP options + +DHCP ([IETF RFC 2131] and [IETF RFC 3315]) is used to obtain the IP configuration data for both the eCM and the eMTA. For IPv4 addressing mode, if total number of octets in any DHCP option exceeds 255 octets, then the MTA MUST follow [IETF RFC 3396] to split the DHCP message into multiple sub-messages. + +DHCP option code 122 is used to specify the IPCablecom-specific options to the eCM and eMTA components of an E-MTA. This is conveyed as option 122 within DHCPv4. For eCMs obtaining information from DHCPv6 server, this is conveyed as CL\_OPTION\_CCC(122) within the "CableLabs Option Request Option", CL\_OPTION\_ORO(1), as specified in Annex A of [ITU-T J.166]. + +## 8.1 DHCP option 122: Client configuration option + +DHCP option code 122 is the RFCed replacement for the former option 177 (which was intended as a temporary code). CM and MTA MUST NOT request option 177 in their DHCP DISCOVER or REQUEST message in option 55 (parameter request list). In the case that a CM or MTA requests both options 122 and 177: + +- The provisioning server MUST respond with DHCP option 122. +- The provisioning server MUST NOT respond with DHCP option 177. +- CM and MTA MUST treat DHCP option 122 as authoritative. + +DHCP option code 122 is used in both the CM and MTA DHCP OFFER/ACK messages to provide the addresses of valid IPCablecom network servers and various device configuration data. + +Full details of DHCP option 122 encoding can be found in [IETF RFC 3495] and [IETF RFC 3594]. + +The following clauses provide additional semantic details of each sub-option in DHCP option 122. + +**Table 6 – Server options** + +| Option | Sub-option | Description and comments | Sub-option required or optional | Default value | +|---------------|-------------------|----------------------------------------------------------------------------------|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 122 | 1 | Service Provider's Primary DHCP Server AddressRequired by CM only. | Required | N/A | +| | 2 | Service Provider's Secondary DHCP Server Address
Optional requirement for CM. | Optional | Empty String | +| | 3 | Service Provider's Provisioning Entity Address | Required | N/A | +| | 4 | AS-REQ/REP Exchange Backoff and Retry for SNMPv3 Key Management | Optional | As per the following MIB Objects:
"pktcMtaDevRealmUnsolicitedKeyNomTimeout",
"pktcMtaDevRealmUnsolicitedKeyMaxTimeout",
"pktcMtaDevRealmUnsolicitedKeyMaxRetries" | +| | 5 | AP-REQ/REP Kerberized Provisioning Backoff and Retry | Optional | As per the following MIB Objects:
"pktcMtaDevProvUnsolicitedKeyNomTimeout"
"pktcMtaDevProvUnsolicitedKeyMaxTimeout"
"pktcMtaDevProvUnsolicitedKeyMaxRetries" | +| | 6 | Kerberos Realm of SNMP Entity | Required | N/A | +| | 7 | Ticket Granting Server Usage | Optional | N/A – if MTA does not implement TGT.0 – otherwise. | +| | 8 | Provisioning Timer | Optional | As per "pktcMtaDevProvisioningTimer" MIB Object (10 minutes) | +| | 9 | Security Ticket Invalidation | Optional | 0 – apply normal ticket invalidation rules per [ITU-T J.170] | + +MTA MUST be able to retrieve and process the data from all sub-options in the above table. Provisioning Server MUST supply to the MTA all "required" sub-options and MAY supply all "optional" sub-options. + +If an "optional" sub-option is not supplied by the Provisioning Server, the MTA MUST use the default value of the sub-option. + +If the "required" sub-option is not supplied by the Provisioning Server, the MTA MUST reject the corresponding DHCP OFFER/ACK. + +If the sub-option contains wrong (invalid) value, the MTA MUST: + +- reject the corresponding DHCP OFFER/ACK in case of "required" sub-option; +- use the default value in case of "optional" sub-option. For any sub-option with multiple parameters (e.g., option 122 sub-option 4 or option 122 sub-option 5), the MTA MUST apply the corresponding default value only to the parameter (or parameters) that contains the wrong value. + +An MTA MUST ignore any other sub-option in option 122 except those listed in the above table. + +### 8.1.1 Service provider's DHCP address (sub-option 2) + +The Service Provider's DHCP Server Address identifies the DHCP servers that a DHCP OFFER will be accepted from in order to obtain an MTA-unique IP address for a given service provider's network administrative domain. + +The encoding of these sub-options is defined in [IETF RFC 3495]. + +Sub-option 1 MUST be included in the DHCP OFFER/ACK to the CM and it indicates the Primary DHCP server's IP address. The value contained in sub-option 1 MUST be a valid IP address, a value of 255.255.255.255 or a value of 0.0.0.0. The value contained in sub-option 2 MUST be a valid IP address. + +The MTA MUST follow the logic in Table 7 when defining its DHCP strategy regardless of the Provisioning Flow used: + +**Table 7 – Service provider's DHCP address (sub-option 2)** + +| Value of sub-option 1 | Value of sub-option 2 | | +|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------| +| | Valid IP – DHCP Server is Responding | Valid IP – DHCP is not responding | +| Valid IP – DHCP Server is Responding | MTA MUST accept DHCP OFFERs coming only from the IP Address in the sub-option 1. | MTA MUST accept DHCP OFFERs coming only from the IP Address in the sub-option 1. | +| Valid IP – DHCP is NOT responding | MTA MUST try exponentially at least three times before accepting the DHCP OFFER coming from the DHCP Server pointed out by sub-option 2. | MTA MUST return to MTA1 step. | +| 255.255.255.255 | MTA MUST select the OFFERs according to the logic of [IETF RFC 2131]. Value in the sub-option 2 MUST be ignored. | MTA MUST select the OFFERs according to the logic of [IETF RFC 2131]. Value in the sub-option 2 MUST be ignored. | +| 0.0.0.0 | MTA MUST stop all provisioning attempts as well as all other activities. | MTA MUST stop all provisioning attempts as well as all other activities. | + +### **8.1.2 Service provider's provisioning entity address (sub-option 3)** + +The Service Provider's Provisioning Entity Address is the network address of the provisioning server for a given voice service provider's network administrative domain. + +The encoding of this sub-option is defined in [IETF RFC 3495]. This address MUST be configured as an FQDN only. + +An FQDN value of 0.0.0.0 in sub-option 3 of a valid MTA DHCP OFFER/ACK specifies that the MTA MUST shut down and not try to provision unless it is reinitialized by the CM. This is explained in step MTA2 of the provisioning flow process of clause 7.2. + +The Service Provider's provisioning Entity Address component MUST be capable of accepting SNMP traps. + +Sub-option 3 MUST be included in the DHCP OFFER to the MTA. + +### **8.1.3 AS-REQ/REP exchange backoff and retry for SNMPv3 key management (sub-option 4)** + +The MTA MUST use the DHCP option 122 sub-option 4, if supplied in Secure Flow only. AS-REQ/REP exchange backoff and retry mechanism of the Kerberized SNMPv3 key negotiation defined in [ITU-T J.170] is controlled by the values delivered in this sub-option or by the default values of the corresponding MIB objects in the Realm Table if this sub-option is not present in the DHCP Option 122. + +The encoding of this sub-option is defined in [IETF RFC 3495]. + +The sub-option's nominal timeout value corresponds to the: +pktcMtaDevRealmUnsolicitedKeyNomTimeout MIB object in the pktcMtaDevRealmTable. + +The sub-option's maximum timeout value corresponds to the: +pktcMtaDevRealmUnsolicitedKeyMaxTimeout MIB object in the pktcMtaDevRealmTable. + +The sub-option's max retry count corresponds to the pktcMtaDevRealmUnsolicitedKeyMaxRetries MIB object in the pktcMtaDevRealmTable. + +An MTA MUST be able to retrieve the above parameters from this sub-option, if they are supplied by the Provisioning Server. + +Provisioning Server MAY provision an MTA with the above parameters using this sub-option. + +If any of the values defined in this sub-option are "FFFFFFFF" (hexadecimal), then the default value of the corresponding column from the Realm Table MUST be used. + +### **8.1.4 AP-REQ/REP kerberized provisioning backoff and retry (sub-option 5)** + +The MTA MUST use the DHCP option 122 sub-option 5, if supplied in Secure Flow only. AP-REQ/REP backoff and retry mechanism of the Kerberized SNMPv3 key negotiation defined in the security specification [ITU-T J.170] is controlled by the values delivered by this sub-option. + +The encoding of this sub-option is defined in [IETF RFC 3495]. + +The sub-option's nominal timeout value corresponds to the: +pktcMtaDevProvUnsolicitedKeyNomTimeout MIB object. + +The sub-option's maximum timeout value corresponds to the: +pktcMtaDevProvUnsolicitedKeyMaxTimeout MIB object. + +The sub-option's max retry count corresponds to the pktcMtaDevProvUnsolicitedKeyMaxRetries MIB object. + +An MTA MUST be able to retrieve the above parameters from this sub-option, if they are supplied by the Provisioning Server. + +Provisioning Server MAY provision an MTA with the above parameters using this sub-option. + +If any of the values defined in this sub-option are "FFFFFFFF" (hexadecimal), then the default value of the corresponding MIB Object MUST be used. + +### 8.1.5 Kerberos realm of SNMP Entity (sub-option 6) + +In conjunction with the Provisioning Entity Address, the Kerberos Realm is used as a means of contacting a SNMP Entity in the provisioning realm. The realm name is used to perform a DNS SRV lookup for the realm's KDC. + +The DHCP option 122 sub-option 6 MUST be included in the DHCP OFFER to the MTA. For the Secure Flow, the DHCP option 122 sub-option 6 MUST only contain the realm name in the format of FQDN (type = 0 as per [IETF RFC 3495]). + +The MTA MUST select the corresponding Provisioning Flow as per Table 8 (the DHCP option 122 sub-option 6 content comparison is case-sensitive and MUST be in all capital letters). + +**Table 8 – MTA device provisioning flow selection** + +| Content of the DHCP option 122 sub-option 6 | MTA device provisioning flow selection | +|---------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| BASIC.1 | If the DHCP option 122 sub-option 6 value is BASIC.1, the MTA MUST execute the Basic flow without the provisioning complete SNMP INFORM. | +| BASIC.2 | If the DHCP option 122 sub-option 6 value is BASIC.2, the MTA MUST execute the Basic flow with the provisioning complete SNMP INFORM. | +| HYBRID.1 | If the DHCP option 122 sub-option 6 value is HYBRID.1, the MTA MUST execute the Hybrid flow without the provisioning complete SNMP INFORM. | +| HYBRID.2 | If the DHCP option 122 sub-option 6 value is HYBRID.2, the MTA MUST execute the Hybrid flow with the provisioning complete SNMP INFORM. | + +The MTA MUST use the Secure Flow if any other value is provided in the DHCP option 122 sub-option 6. For Secure Flow, the encoding of the DHCP option 122 sub-option 6 is defined in [IETF RFC 3495]. + +#### 8.1.5.1 SNMPv3 key establishment + +The SNMPv3 Key Establishment is applicable for Secure Flow only. The AP Request/AP Reply described in Figure 6, the accompanying flow description and the security specification are used by the MTA in the initial provisioning phase to establish keys with the SNMPv3 USM User "MTA-Prov-xx:xx:xx:xx:xx:xx", where xx:xx:xx:xx:xx:xx represents the MAC address of the MTA and MUST be uppercase. The MTA MUST instantiate this user in the USM MIB described in [IETF RFC 3414], with the ability to be keyed using the IPCablecom Kerberized key management method described in the security specification. SNMPv3 authentication is required and privacy is optional. For the list of allowed SNMPv3 authentication and privacy algorithms, see [ITU-T J.170]. + +Additionally, the usmUserSecurityName MUST be set to the string "MTA-Prov-xx:xx:xx:xx:xx:xx" (quotation marks not included), where xx:xx:xx:xx:xx:xx represents the MAC address of the MTA and MUST be uppercase. This ensures a unique usmUserSecurityName is created for each MTA. + +The MTA must first obtain a service ticket for the provisioning realm as described in step MTA9. USM key management is performed over UDP, as specified in [ITU-T J.170]. The SNMPv3 keys are established prior to any SNMPv3 communication and therefore SNMPv3 messages MUST be authenticated at all times (with privacy being optional). The MTA MUST use the USM user created above in the initial INFORM. + +### **8.1.6 Ticket granting server usage (sub-option 7)** + +The MTA MUST use the DHCP option 122 sub-option 7 if supplied for the provisioning kerberized key management in Secure Flow only. This sub-option contains a Boolean, which when true, indicates that the MTA SHOULD get its TGT (ticket granting ticket). + +Sub-option 7 MAY be included in the DHCP OFFER/ACK to the MTA. + +The encoding of this sub-option is defined in [IETF RFC 3495]. + +### **8.1.7 Provisioning timer (sub-option 8)** + +Sub-option 8 defines the value to be used for the provisioning timer. Sub-option 8 MAY be included in the DHCP OFFER/ACK to the MTA. + +The encoding of this sub-option is defined in [IETF RFC 3495]. + +### **8.1.8 Security ticket invalidation (sub-option 9)** + +Sub-option 9 contains a bit mask that directs the MTA to invalidate specific application server security tickets. Sub-option 9 MAY be included in the DHCP OFFER/ACK to the MTA. The encoding of this sub-option is defined in [IETF RFC 3594]. + +## **8.2 DHCP option 60: Vendor-client identifier** + +Option code 60 contains a string identifying Capabilities of the MTA. The MTA MUST send the following ASCII Coded String in DHCP option code 60: "pktc1.0:xxxxxx", where xxxxxx MUST be an ASCII representation of the hexadecimal encoding of the MTA TLV Encoded Capabilities, as defined in clause 10. + +## **8.3 DHCP options 12 and 15** + +MTA FQDN MUST be sent to the E-MTA in option 12 and option 15. Option 12 MUST contain "Host Name" part of the FQDN, and option 15 MUST contain "Domain Name" part of the FQDN. + +For example, if MTA FQDN is "mta1.pclab.com", then option 12 must contain "mta1" and option 15 must contain "pclab.com". + +## **8.4 DHCP option 6** + +DHCP option 6 MUST be used to provide the MTA with its list of DNS server addresses. Option 6 MUST contain at least one DNS server address. Option 6 MAY contain a secondary DNS server address. If this option contains more than two DNS servers, the MTA MUST use the first two addresses. + +## **8.5 DHCP option 43** + +The MTA MUST send the DHCP option 43 in the DHCP DISCOVER and DHCP REQUEST for the Secure, Hybrid and Basic Flows. + +DHCP option 43 contains the number of sub-options defined to provide the MTA device specific information to the back-office systems. The DHCP option 43 sub-options 1 through 10, 31 and 32 are specified by IPCablecom, sub-options 11-30 are reserved for the IPCable2Home Recommendations (ITU-T J.19x-series), sub-options 33 through 50 are reserved for IPCablecom, sub-options 51 through 127 are reserved for future standardized use, and sub-options 128 and above are reserved for vendor use. The IPCablecom DHCP option 43 sub-options MUST be present in the format of "Encapsulated vendor-specific extensions" [IETF RFC 2132]. + +Table 9 contains the sub-options of the DHCP option 43, which the MTA MUST use. The MTA MUST send all required sub-options listed in the table below unless explicitly stated otherwise. If + +the total number of octets in all DHCP option 43 sub-options exceeds 255 octets, the MTA MUST follow [IETF RFC 3396] to split the option into multiple smaller options. + +**Table 9 – DHCP option 43 syntax** + +| MTA DHCP option 43 sub-options | Required/ Not used in option 43 | Value | Description | +|---------------------------------------|----------------------------------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Sub-option 1 | Not Used | | The request sub-option vector is a list of sub-options (within option 43) to be returned to client by the server upon reply to the request. None defined. The DHCP option 43 sub-option 1 MUST NOT be used by the MTA, and if present, it MUST be ignored by the Provisioning Server. | +| Sub-option 2 | R |
For IPCablecom MTAs, the allowable device types are:
– "EMTA" – for E-MTAs
– "SMTA" – for S-MTAs | +| Sub-option 3 | Not Used | | The sub-option 3 contains a colon separated list of all components in the eDOCSIS device. It is used by the eDOCSIS eCM device.
The DHCP option 43 sub-option 3 MUST NOT be sent by the MTA, and if present, it MUST be ignored by the Provisioning Server. | +| Sub-option 4 | R |
The MTA MUST send the DHCP option 43 sub-option 4. The DHCP option 43 sub-option 4 value MUST be identical to the value of the pktcMtaDevSerialNumber MIB Object. | +| Sub-option 5 | R |
The MTA MUST send the DHCP option 43 sub-option 5. The DHCP option 43 sub-option 5 MUST be identical to the value of the Hardware version number as in
The MTA MUST send the DHCP option 43 sub-option 6. The DHCP option 43 sub-option 6 value MUST be identical to the value of the pktcMtaDevSwCurrentVers MIB object. | + +**Table 9 – DHCP option 43 syntax** + +| MTA DHCP option 43 sub-options | Required/ Not used in option 43 | Value | Description | +|---------------------------------------|----------------------------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Sub-option 7 | R |
The sub-option 7 contains the Boot ROM Version represented as an ASCII string.
The MTA MUST send the DHCP option 43 sub-option 7.
The DHCP option 43 sub-option 7 value MUST be identical to the <Boot ROM version> field in MIB-II object sysDescr.
| +| Sub-option 8 | R |The sub-option 8 contains the Organizational Unique Identifier (OUI) represented as a hexadecimal-encoded 3-byte octet string. It MAY match the OUI in the MTA MAC address.
The MTA MUST send the DHCP option 43 sub-option 8.
If omitted, the Provisioning Server SHOULD use the MTA MAC address as the MTA OUI.
| +| Sub-option 9 | R |The sub-option 9 contains the MTA Device Model Number represented as an ASCII string.
The MTA MUST send the DHCP option 43 sub-option 9.
The DHCP option 43 sub-option 9 value MUST be identical to <Model Number> field in the MIB-II object sysDescr.
| +| Sub-option 10 | R |The sub-option 10 contains the Vendor Name represented as an ASCII string.
The MTA MUST send the DHCP option 43 sub-option 10. The DHCP option 43 sub-option 10 value MUST be identical to <Vendor Name> field in the MIB-II object sysDescr.
| +| Sub-options 11-30 | | | Reserved for CableHome | +| Sub-option 31 | R |The sub-option 31 contains the MTA MAC Address encoded as a 6-byte octet string.
The MTA MUST send the DHCP option 43 sub-option 31. The DHCP option 43 sub-option 31 value MUST be identical to the content of the pktcMtaDevMacAddress MIB object.
| + +**Table 9 – DHCP option 43 syntax** + +| MTA DHCP option 43 sub-options | Required/ Not used in option 43 | Value | Description | +|---------------------------------------|----------------------------------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Sub-option 32 | R |The sub-option 32 contains the Correlation ID number encoded as 4-byte INTEGER in the network order.
The MTA MUST send the DHCP option 43 sub-option 32.
The DHCP option 43 sub-option 32 value MUST be identical to the content of the pktcMtaDevCorrelationId MIB object.
| +| Sub-options 33-50 | | | Reserved for IPCablecom. | +| Sub-options 51 to 127 | | | Reserved for CableLabs. | +| Sub-options 128 to 254 | | | Reserved for vendors. | + +## 8.6 DHCP option 1 + +DHCP option 1 is defined in [IETF RFC 2132]. + +## 8.7 DHCP option 3 + +DHCP option 3 is defined in [IETF RFC 2132]. + +## 8.8 DHCP OPTION CL\_V4\_PACKETCABLE\_MIB\_ENV\_OPTION + +The Provisioning Server can provide the option 'CL\_V4\_PACKETCABLE\_MIB\_ENV\_OPTION' within the DHCP OFFER and ACK messages to indicate preference of the MIB module for MTAs implementing both the IPCablecom and IETF MIBs. The following requirements apply: + +- if it is not provided the MTA MUST assume a value of 0x01 (CableLabs); +- if 'CL\_V4\_PACKETCABLE\_MIB\_ENV\_OPTION' is set to a value of 0x01, the MTA MUST use the CableLabs issued MIB modules specified in clause 10.23.2 for provisioning flows (for example, MTA1 through MTA25 for the secure provisioning flow) and default values for all the MIB Objects; +- if 'CL\_V4\_PACKETCABLE\_MIB\_ENV\_OPTION' is set to a value of 0x02, the MTA MUST use the IETF issued MIB modules specified in clause 10.23.3, if implemented, for provisioning flows (for example, MTA1 through MTA25 for the secure provisioning flow) and default values for all the MIB Objects; +- irrespective of the preference indicated within: 'CL\_V4\_PACKETCABLE\_MIB\_ENV\_OPTION', the Provisioning Server MAY use any MIB environment supported by the MTA (as specified in clause 10.23); +- while providing the configuration file information (for example, MTA19), the Provisioning Server MUST use the MIB environment used by the MTA while requesting the configuration file (for example, MTA15), irrespective of the value provided in 'CL\_V4\_PACKETCABLE\_MIB\_ENV\_OPTION'. + +# 9 MTA provisionable attributes + +This clause includes the list of attributes and their associated properties used in device provisioning. All of the provisionable attributes specified in this clause MAY be updated via the MTA configuration data file, or on a per-attribute basis using SNMP. + +IP Cablecom requires that an MTA configuration data file MUST be provided to all embedded-MTAs during the registration sequence. Endpoint voice services do not have to be enabled at the time of device initialization. MTA device level configuration data MUST be provisioned during initialization. These items are contained in clause 9.1.1. + +The MTA configuration data URL generated by the Provisioning Application MUST be less than 255 bytes in length and cannot be NULL. Since this filename is provided to the MTA by the Provisioning Application during the registration sequence, it is not necessary to specify a file-naming convention. + +## 9.1 MTA configuration file + +This clause explains the format and contents of an MTA configuration file. This file contains a series of "type length and value" (TLV) parameters. Each TLV parameter in the configuration file describes an MTA or endpoint attribute. The configuration data file includes TLVs that have read-write, read-only, and no MIB access. Unless specifically indicated, all MIB-accessible configuration file parameters MUST be defined using DOCSIS TLV type 11, the IP Cablecom type 64, or IP Cablecom TLV type 38. TLV-64 is an IP Cablecom defined TLV where the length value is 2 bytes long instead of the 1 byte for DOCSIS TLV type 11. The TLV type 64 MUST be used when the length is greater than 254 bytes. If desired, vendor-specific information may be added to the configuration file using the vendor-specific TLV-43. This TLV has been specified by the DOCSIS specification (ITU-T Rec. J.112). Vendors MUST NOT provision vendor-specific information using TLV type 11 or 64. TLV-38 is an IP Cablecom defined TLV, analogous to TLV-38 used by DOCSIS and IP Cable2Home. The MTA MUST be able to process the TLVs given in Table 10: + +**Table 10 – MTA configuration file** + +| Type | Length | Value | +|------------------------------------------------------------------------------------|-----------------------|-----------------------------------------------------------------| +| 11 | n, where n is 1 byte | variable binding | +| 64 | m, where m is 2 bytes | variable binding | +| 38 | n, where n is 1 byte | Composite (Contains sub TLVs) | +| 254 | 1 byte | 0x01 for beginning of the file and 0xFF for the end of the file | +| NOTE – The use of TLV type 11 rather than TLV-64 is recommended wherever possible. | | | + +In the future, new TLVs introduced in IP Cablecom must have a "length field" size of 2 bytes. + +The VarBind is encoded in ASN.1 Basic Encoding Rules, just as it would be if part of an SNMP Set request. + +The MTA configuration file MUST start with the "telephony configuration file start" tag and MUST end with the "telephony configuration file end" tag. These tags enable the MTA TLV parameters to be distinguished from DOCSIS TLV parameters. These tags also provide deterministic indications for start and stop of the MTA configuration file. + +The MTA configuration file MUST contain the attributes identified as "required" in the Device Level Configuration Data table, which appears in clause 9.1.1; failing which, the MTA MUST reject the configuration file and take the necessary steps as defined in clause 7.2 (failure of step MTA23 due to 'Configuration file error'). The MTA configuration file MAY contain any of the non-required attributes which appear in the Device Level Configuration Data table. If the configuration file does + +not contain required attributes, it MUST be rejected. The MTA configuration file MUST be sent to the embedded-MTA every time this device is powered on. + +The Device Level Service Data MAY be sent to the MTA as part of the MTA configuration file or it MAY be sent to the MTA using SNMP. If included in the configuration file, it MUST contain all of attributes identified as 'required' in the Device Level service data, if any. The MTA configuration file MAY additionally contain any of the non-required attributes that appear in the Device Level Service Data table. + +If voice services are required on the MTA on any endpoint, the following MUST be done: + +- 1) pktcMtaDevEnabled MUST be set to TRUE; +- 2) per endpoint configuration data MUST be supplied either through the MTA configuration file (during provisioning) or through endpoint provisioning (using SNMP) in the post-provisioning phase. + +The Endpoint details, when included, MUST contain the attributes identified as "required" in the Per-Endpoint Configuration Data table, which appears in clause 9.1.3. The MTA configuration file MAY contain any of the non-required attributes which appear in the Per-Endpoint Configuration Data table in clause 9.1.3. The Per-Endpoint Configuration Data MUST be sent to the MTA when voice communications service is activated. + +It is to be noted that the Device Level Service Data and Per-Endpoint Configuration Data MAY also be sent to the MTA via incremental provisioning, using SNMP. The MTA MUST support incremental provisioning. + +The MTA MUST be able to process all TLV-11 and TLV-64 values with variable bindings containing all MIB objects defined in [ITU-T J.166], unless stated otherwise. + +The Device Level Configuration data parameter 'pktcMtaDevEnabled' is used to actually enable or disable voice services on an MTA. + +Refer to clause 7.6.1 for a discussion concerning synchronization of provisioning attributes with back office systems. + +For the Secure and Hybrid Provisioning Flows, the MTA MUST authenticate the configuration file according to IPCablecom security specification [ITU-T J.170]; the MTA MUST reject the configuration file if the configuration file authentication fails and take the necessary steps as defined in clause 7.2 for the Secure Flow and clause 7.4 for the Hybrid Flow. If the configuration file contains the MIB object 'pktcMtaDevProvConfigHash' in the Secure Flow or the Hybrid Flow, the MTA MUST ignore the value of this MIB object and proceed with further processing of the configuration file and report passWithWarnings and populate the Error OID table (pktcMtaDevErrorOidsTable). + +For the Basic Flow, the Provisioning Server and the MTA MUST support the configuration file data verification process as described below: + +- 1) When the Provisioning Server creates a new MTA Configuration File or modifies an existing one, to be served for an MTA intended to go through the Basic Flow, it MUST calculate a SHA-1 hash value of the contents of the entire MTA Configuration File including start and end markers, taken as a byte string. +- 2) The Provisioning Server MUST add the hash value, calculated in Step 1 to the MTA Configuration File as a TLV-11 triplet corresponding to the 'pktcMtaDevProvConfigHash' MIB Object. The Provisioning Server MUST insert the TLV-11 triplet before the Configuration file end-marker. The Provisioning Server MUST NOT change the order of the TLVs in the configuration file after the hash has been calculated. The MTA Configuration File is then made available to the MTA through the appropriate TFTP/HTTP server. + +- 3) Upon receiving the configuration file, the MTA MUST do the following: If the MIB object 'pktcMtaDevProvConfigHash' is absent, the MTA MUST reject the configuration file and MUST report 'failOtherReason'. + +If the MIB object 'pktcMtaDevProvConfigHash' is present, then the MTA MUST: + +- a) Calculate SHA-1 over the contents of the file without TLV-11 triplet containing the 'pktcMtaDevProvConfigHash' and MUST populate the calculated value into 'pktcMtaDevProvConfigHash' MIB object. The MTA must maintain the order of the TLVs for the hash calculation to be correct. +- b) If the computed hash and the value of the 'pktcMtaDevProvConfigHash' MIB object are the same, the MTA Configuration File integrity is verified and the MTA MUST accept the configuration file for further processing; otherwise, the MTA MUST reject the Configuration File and the MTA MUST report 'failOtherReason'. + +The MTA must also check for errors in the configuration file. As described above, errors in any of the mandatory parameters MUST be treated as an error in the configuration file and appropriate steps taken (failure of step MTA23 due to 'Configuration file error'). + +If there are errors in the non-required OIDs then the MTA MUST accept the configuration file, but report the same in the status (MTA25). + +If the Configuration file contains per-cms data and per-endpoint parameters related to CMSs which are not associated to endpoints, an MTA MUST NOT establish SAs till an endpoint gets associated with that particular CMS (either using SNMP or via NCS redirection). + +The MTA MUST report the state of the configuration file it received in the 'Provisioning complete Inform' (step MTA25 in the provisioning process) as given below: + +- If the configuration file could be parsed successfully and the MTA is able to reflect the same in its MIB, it must return: 'pass'. +- If the configuration file was in error due to incorrect values in the mandatory parameters, the MTA MUST reject the configuration file and return: 'failConfigFileError'. +- It MUST also populate 'pktcMtaDevErrorOidsTable' with the parameter containing the incorrect value and MAY also populate it with other OID errors/warnings if it parsed the file completely. +- If the configuration file had proper values for all the mandatory parameters but has errors in any of the optional parameters (this includes any vendor-specific OIDs which are incorrect or not known to the MTA), it must return: 'passWithWarnings'. +- It MUST also populate 'pktcMtaDevErrorOidsTable' with a list of all the parameters which were rejected and the reason for the same. The MTA MUST also use the default values for all such parameters, unless they were overridden by some other means like DHCP, in which case it must use the overridden values. +- If the configuration file is proper, but the MTA cannot reflect the same in its MIB (for example, too many entries leading to memory exhaustion), it MUST accept details related to the CMSs associated with the endpoints and return: 'passWithIncompleteParsing'. +- It MUST also populate 'pktcMtaDevErrorOidsTable' with a list of all the parameters which cannot be reflected in the MIB. +- If the configuration file cannot be parsed due to an internal error, it must return 'failureInternalError'. It SHOULD try to populate 'pktcMtaDevErrorOidsTable' for parameters which lead to failure. +- If the configuration file contains overlapping MIB Object references from multiple MIB environments (for example, CableLabs and IETF), the MTA MUST use the preference provided via DHCP, if such a preference is provided and supported by the MTA (see + +clause 8.8). In the absence of any preference via DHCP, the MTA MUST use the last recognized occurrence (vendor specific) of such objects in the configuration file. The MTA MUST also indicate any rejected configuration file entries as warnings (provisioning state 'passWithWarnings', unless other conditions exist) and populate the error OIDs table (pktcMtaDevErrorOidsTable). + +- If the MTA cannot accept the configuration file for any reason other than the one stated above, it must return 'failureOtherReason'. It SHOULD try to populate 'pktcMtaDevErrorOidsTable' for parameters, which lead to the failure. + +The MTA Configuration File MUST contain Per-Realm Configuration Data. In the case of the Secure Provisioning Flow, per-Realm Configuration Data MUST contain at least the data for the Provisioning Realm that is identified in DHCP option 122, sub-option 6. + +In the case of the Secure Provisioning Flow, after receiving the MTA Configuration File, an MTA MUST validate the following: + +- "pktcMtaDevRealmName" MIB Object of the Realm Table MUST be the same as the Realm Name supplied to the MTA in DHCP option 122, sub-option 6. +- "pktcMtaDevRealmOrgName" MIB Object of the Realm Table MUST be the same as the "Organization Name" attribute in the Service Provider Certificate. +- Encryption and Authentication of the MTA Configuration File as per [ITU-T J.170]. + +An MTA MUST treat any of the above validation failures as failure of the MTA23 Provisioning Flow and the MTA MUST discard the Configuration File. + +If the MTA encounters a vendor-specific TLV-43 with a vendor ID that the MTA does not recognize as its own, the MTA must ignore the TLV-43 and the MTA MUST continue to process the configuration file. If the MTA detects the presence of an unrecognized TLV (TLV type other than TLV-11, TLV-43, TLV-64, TLV-38, or TLV-254), the MTA MUST ignore the TLV assuming the length field of the unrecognized TLV is 2 bytes and proceed with further processing. The MTA MUST report a provisioning state of 'passWithWarnings' and populate the error OID table (pktcMtaDevErrorOidsTable) if it detects the presence of an unrecognized TLV. If the MTA encounters an unrecognized variable binding in a TLV-11 or TLV-64, it MUST ignore this binding, MUST report a provisioning state of 'passWithWarnings' and populate the error OID table (pktcMtaDevErrorOidsTable). It is strongly recommended for the vendors to give serious considerations to backward compatibility issues when modifying existing or introducing new sub-TLVs for TLV-43. + +The MTA MUST attempt to accept configuration file that contains valid set of per-realm and per-CMS configuration data identified in clauses 9.1.4 and 9.1.5, even if the MTA endpoints are not associated with the CMS in the per-CMS configuration data. + +IPCablecom MIB objects in MTA-MIB ([ITU-T J.166] and [IETF RFC 4682]), Signaling-MIB ([ITU-T J.166] and [IETF RFC 5098]) and Event-MIB ([ITU-T J.166] and [IETF draft-eventmess]) of type RowStatus MUST NOT be included in the MTA configuration file. If any IPCablecom MIB objects (MTA MIB, Signaling MIB and Event MIB) of type 'RowStatus' are included in the configuration file, the MTA MUST ignore the value supplied in any RowStatus object, report a 'passWithWarnings' and populate the MIB table 'pktcMtaDevErrorOidsTable' appropriately. Regardless of the action taken by the MTA, it MUST properly populate the Error OIDs table with the RowStatus OID. Non-IPCablecom MIB objects type RowStatus can be present or absent in the MTA configuration file and MTA MUST process these objects according to the corresponding RFCs for the particular MIB objects (for example SNMPv2c table). + +IPCablecom MIB object pktcEnMtaDevMltplGrantsPerInterval if included in the configuration file is set to enable multiple grants per interval (MGPI) functionality and if the MTA does not support + +this functionality, then the MTA MUST ignore the object and report 'PassWithWarnings' and populate the ErrorOidsTable. + +### 9.1.1 Device level configuration data + +Refer to the MTA MIB ([ITU-T J.166] and [IETF RFC 4682]) for more detailed information concerning these attributes and their default values (see Table 11). + +- The MTA Manufacturer Certificate validates the MTA Device Certificate. + +**Table 11 – Device level configuration** + +| Attribute | Syntax | Configuration access | SNMP access | MIB file | Object | Comments | +|-----------------------------------|------------|---------------------------------------------------------------------------------------------------|-------------|----------------|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Telephony Config File Start | Integer | W, required | None | N/A | N/A | Type Length Value254 1 1
The MTA config file MUST start with this attribute. | +| Telephony Config File End | Integer | W, required | None | N/A | N/A | Type Length Value
254 1 255
This MUST be the last attribute in the MTA config file. | +| Telephony MTA Admin State | ENUM | W, required | R/W | MTA Device MIB | pktcMtaDev Enabled | Used to enable/disable all telephony ports on the MTA. Applies to the MTA side of the embedded-MTA or the entire stand-alone MTA. Allows blanket management of all telephony ports (external interfaces) on the device. The state of the MTA is controlled by this MIB Object. For more information about this object, refer to the MTA MIB [ITU-T J.166]. | +| Realm Organization Name | String | W, Required
(Secure Provisioning Flow)
W, Optional
(Basic and Hybrid Provisioning Flows) | R/W | MTA Device MIB | pktcMtaDev RealmOrg Name | The value of the X.500 name organization name attribute in the subject name of the service provider certificate. | +| Solicited Key Timeout | Integer | W, optional | R/W | N/A | pktcMtaDev ProvSolicitdKey Timeout | This timeout applies only when the Provisioning Server initiated key management (with a Wake Up message) for SNMPv3. It is the period during which the MTA will save a nonce (inside the sequence number field) from the sent out AP Request and wait for the matching AP Reply from the Provisioning Server. Since there is a default value, this is optional. | +| Reset Kerberos ticket information | Integer 32 | W, optional | R/W | MTA Device MIB | pktcMtaDev ResetKrb Tickets | Security Specification [ITU-T J.170] allows the Kerberos tickets associated with any of the application server (Provisioning Server or CMS) to be stored in the MTA NVRAM until ticket expiry. In order to control the invalidation of the tickets stored in NVRAM, this MIB attribute is used to communicate the required action to the MTA. Upon receiving this attribute in the config file, an MTA MUST take the specified action. Refer to [ITU-T J.166] for | + +**Table 11 – Device level configuration** + +| Attribute | Syntax | Configuration access | SNMP access | MIB file | Object | Comments | +|-----------|--------|----------------------|-------------|----------|--------|-------------------| +| | | | | | | more information. | + +### 9.1.2 Device level service data + +Refer to the MTA MIB [ITU-T J.166] and [IETF RFC 4682], the NCS MIB [ITU-T J.166] and [IETF RFC 5098] the NCS Call Signalling specification [ITU-T J.162] and [IETF RFC 2475] for more detailed information concerning these attributes and their default values (see Table 12). + +**Table 12 – Device level service** + +| Attribute | Syntax | Configuration access | SNMP access | MIB file | Object | pkteDevEvSyslog comments | +|-----------------------------------|-----------------------|----------------------|-------------|--------------------|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NCS Default Call Signalling TOS | Integer | W, optional | R/W | MTA Signalling MIB | pkteSigDef CallSigTos | The default value used in the IP header for setting the TOS value for NCS call signalling. | +| NCS Default Media Stream TOS | Integer | W, optional | R/W | MTA Signalling MIB | pkteSigDef MediaStream Tos | The default value used in the IP header for setting the TOS value for NCS media stream packets. | +| MTA UDP receive port used for NCS | Integer (1025..65535) | W, optional | R/O | MTA Signalling MIB | pkteSigDef NcsReceive UdpPort | This object contains the MTA User Datagram Protocol Receive Port that is used for NCS call signalling. This object should only be changed by the configuration file. | +| NCS TOS Format Selector | ENUM | W, optional | R/W | MTA Signalling MIB | pkteSigTos FormatSelector | The format of the default NCS signalling and media TOS values.
Allowed values are "IPv4 TOS octet" or "DSCP codepoint". Refer to [IETF RFC 2475]. | +| R0 cadence | Bit-field | W, optional | R/W | MTA Signalling MIB | pkteSigDev R0Cadence | User-defined field where each bit represents a duration of 100 ms (6 s total)
1 = active ringing, 0 = silence.
64 bits are used for representation; MSB 60 bits for ring cadence. Bit 61 is used to represent repeatable (when set to ZERO) and non-repeatable (when set to ONE). Other three bits are reserved for future use, and currently set to 000. | +| R6 cadence | Bit-field | W, optional | R/W | MTA Signalling MIB | pkteSigDev R6Cadence | User-defined bit field where each bit represents a duration of 100 ms (6 s total)
1 = active ringing, 0 = silence.
64 bits are used for representation; MSB 60 bits for ring cadence. Bit 61 is used to represent repeatable (when set to ZERO) and non-repeatable (when set to ONE). Other three bits are reserved for future use, and currently set to 000. | + +**Table 12 – Device level service** + +| Attribute | Syntax | Configuration access | SNMP access | MIB file | Object | pktcDevEvSyslog comments | +|------------|-----------|----------------------|-------------|--------------------|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| R7 cadence | Bit-field | W, optional | R/W | MTA Signalling MIB | pktcSigDev R7Cadence | User-defined bit field where each bit represents a duration of 100 ms (6 s total)
1 = active ringing, 0 = silence.
64 bits are used for representation; MSB 60 bits for ring cadence. Bit 61 is used to represent repeatable (when set to ZERO) and non-repeatable (when set to ONE). Other three bits are reserved for future use, and currently set to 000. | +| R1 cadence | Bit-field | W, optional | R/W | MTA Signalling MIB | pktcSigDev R1Cadence | User-defined field where each bit (least significant bit) represents a duration of 100 ms (6 s total)
1 = active ringing, 0 = silence
64 bits are used for representation; MSB 60 bits for ring cadence. Bit 61 is used to represent repeatable (when set to ZERO) and non-repeatable (when set to ONE). Other three bits are reserved for future use, and currently set to 000. | +| R2 cadence | Bit-field | W, optional | R/W | MTA Signalling MIB | pktcSigDev R2Cadence | User-defined field where each bit (least significant bit) represents a duration of 100 ms (6 s total)
1 = active ringing, 0 = silence
64 bits are used for representation; MSB 60 bits for ring cadence. Bit 61 is used to represent repeatable (when set to ZERO) and non-repeatable (when set to ONE). Other three bits are reserved for future use, and currently set to 000. | +| R3 cadence | Bit-field | W, optional | R/W | MTA Signalling MIB | pktcSigDev R3Cadence | User-defined field where each bit (least significant bit) represents a duration of 100 ms (6 s total)
1 = active ringing, 0 = silence
64 bits are used for representation; MSB 60 bits for ring cadence. Bit 61 is used to represent repeatable (when set to ZERO) and non-repeatable (when set to ONE). Other three bits are reserved for future use, and currently set to 000. | +| R4 cadence | Bit-field | W, optional | R/W | MTA Signalling MIB | pktcSigDev R4Cadence | User-defined field where each bit (least significant bit) represents a duration of 100 ms (6 s total)
1 = active ringing, 0 = silence
64 bits are used for representation; MSB 60 bits for ring cadence. Bit 61 is used to represent repeatable (when set to ZERO) and non-repeatable (when set to ONE). Other three bits are reserved for future use, and currently set to 000. | + +**Table 12 – Device level service** + +| Attribute | Syntax | Configuration access | SNMP access | MIB file | Object | pktcDevEvSyslog comments | +|------------|-----------|----------------------|-------------|--------------------|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| R5 cadence | Bit-field | W, optional | R/W | MTA Signalling MIB | pktcSigDev R5Cadence | User-defined field where each bit (least significant bit) represents a duration of 100 ms (6 s total)
1 = active ringing, 0 = silence
64 bits are used for representation; MSB 60 bits for ring cadence. Bit 61 is used to represent repeatable (when set to ZERO) and non-repeatable (when set to ONE). Other three bits are reserved for future use, and currently set to 000. | +| Rg cadence | Bit-field | W, optional | R/W | MTA Signalling MIB | pktcSigDev RgCadence | User-defined field where each bit (least significant bit) represents a duration of 100 ms (6 s total)
1= active ringing, 0 = silence
64 bits are used for representation; MSB 60 bits for ring cadence. Bit 61 is used to represent repeatable (when set to ZERO) and non-repeatable (when set to ONE). Other three bits are reserved for future use, and currently set to 000. | +| Rt cadence | Bit-field | W, optional | R/W | MTA Signalling MIB | pktcSigDev RtCadence | User-defined field where each bit (least significant bit) represents a duration of 100 ms (6 s total)
1 = active ringing, 0 = silence
64 bits are used for representation; MSB 60 bits for ring cadence. Bit 61 is used to represent repeatable (when set to ZERO) and non-repeatable (when set to ONE). Other three bits are reserved for future use, and currently set to 000. | +| Rs cadence | Bit-field | W, optional | R/W | MTA Signalling MIB | pktcSigDev RsCadence | User-defined field where each bit (least significant bit) represents a duration of 100 ms (6 s total)
1 = active ringing, 0 = silence
64 bits are used for representation; MSB 60 bits for ring cadence. Bit 61 is used to represent repeatable (when set to ZERO) and non-repeatable (when set to ONE). Other three bits are reserved for future use, and currently set to 000. | + +### **9.1.3 Per-endpoint configuration data** + +Refer to the NCS MIB ([ITU-T J.166] and [IETF RFC 5098]), the NCS specification [ITU-T J.162], the security specification [ITU-T J.170] and the MTA MIB ([ITU-T Rec. J.166] and [IETF RFC 4682]) for more detailed information concerning these attributes and their default values (see Table 13). + +- MTA sends KDC the MTA/CMS certificate, MTA's FQDN, CMS-ID. The KDC returns the MTA a "Kerberos Ticket" that says "this MTA is assigned to this CMS". +- The Telephony Service Provider Certificate validates the MTA Telephony Certificate. +- If two different endpoints share the same Kerberos Realm and the same CMS FQDN, then these four attributes **MUST** be identical: PKINIT grace period, KDC name list, MTA telephony certificate, telephony service provider certificate. + +**Table 13 – Per-endpoint configuration** + +| Attribute | Syntax | Configuration access | SNMP access | MIB file | Object | Comments | +|---------------------------------|---------|----------------------|-------------|------------------------|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Port Admin State | ENUM | W, optional | R/W | IF-MIB [IETF RFC 2863] | ifAdmin Status | The administrative state of the port the operator can access to either enable or disable service to the port. The administrative state can be used to disable access to the user port without de-provisioning the subscriber. Allowed values for this attribute are:
up(1) or down(2).
For SNMP access, ifAdminStatus is found in the ifTable of MIB-II. | +| Call Management Server Name | String | W, required | R/W | MTA Signalling MIB | pktcNcsEnd PntConfig CallAgentId | This attribute is a string indicating the name of the CMS assigned to the endpoint. The call agent name after the character '@' MUST be a fully qualified domain name and MUST have a corresponding conceptual row in the pktcMtaDevCmsTable. DNS support is assumed to support multiple CMSs as described in the NCS spec. [ITU-T J.162]. | +| Call Management Server UDP Port | Integer | W | R/W | MTA Signalling MIB | pktcNcsEnd PntConfig CallAgentUdpPort | UDP port for the CMS. | +| Partial dial time-out | Integer | W | R/W | MTA Signalling MIB | pktcNcsEnd PntConfig PartialDialTO | Time-out value in seconds for partial dial time-out. | +| Critical dial time-out | Integer | W | R/W | MTA Signalling MIB | pktcNcsEnd PntConfig CriticalDialTO | Time-out value in seconds for critical dial time-out. | +| Busy tone time-out | Integer | W | R/W | MTA Signalling MIB | pktcNcsEnd PntConfig BusyToneTO | Time-out value in seconds for busy tone. | +| Dial tone time-out | Integer | W | R/W | MTA Signalling MIB | pktcNcsEnd PntConfig DialToneTO | Time-out value in seconds for dial tone. | +| Message waiting time-out | Integer | W | R/W | MTA Signalling MIB | pktcNcsEnd PntConfig MessageWaitingTO | Time-out value in seconds for message waiting. | +| Off-hook warning time-out | Integer | W | R/W | MTA Signalling MIB | pktcNcsEnd PntConfig OffHookWarnToneTO | Time-out value in seconds for off-hook warning. | +| Ringing time-out | Integer | W | R/W | MTA Signalling MIB | pktcNcsEnd PntConfig RingingTO | Time-out value in seconds for ringing. | +| Ringback time-out | Integer | W | R/W | MTA Signalling MIB | pktcNcsEnd PntConfig RingBackTO | Time-out value in seconds for ringback. | +| Reorder tone time-out | Integer | W | R/W | MTA Signalling MIB | pktcNcsEnd PntConfig ReorderToneTO | Time-out value in seconds for reorder tone. | + +**Table 13 – Per-endpoint configuration** + +| Attribute | Syntax | Configuration access | SNMP access | MIB file | Object | Comments | +|-------------------------|---------|----------------------|-------------|------------------------|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Stutter dial time-out | Integer | W | R/W | MTA Signalling MIB | pktcNcsEndPntConfigStutterDialToneTO | Time-out value in seconds for stutter dial tone. | +| TS Max | Integer | W | R/W | MTA Signalling MIB | pktcNcsEndPntConfigTSMax | Contains the maximum time in seconds since the sending of the initial datagram. | +| Max1 | Integer | W | R/W | MTA Signalling MIB | pktcNcsEndPntConfigMax1 | The suspicious error threshold for each endpoint retransmission. | +| Max2 | Integer | W | R/W | MTA Signalling MIB | pktcNcsEndPntConfigMax2 | The disconnect error threshold per endpoint retransmission. | +| Max1 Queue Enable | Enum | W | R/W | MTA Signalling MIB | pktcNcsEndPntConfigMax1QEnable | Enables/disables the Max1 DNS query operation when Max1 expires. | +| Max2 Queue Enable | Enum | W | R/W | MTA Signalling MIB | pktcNcsEndPntConfigMax2QEnable | Enables/disables the Max2 DNS query operation when Max2 expires. | +| MWD | Integer | W | R/W | MTA Signalling MIB | pktcNcsEndPntConfigMWD | Number of seconds to wait to restart after a restart is received. | +| Tdinit | Integer | W | R/W | MTA Signalling MIB | pktcNcsEndPntConfigTdinit | Number of seconds to wait after a disconnect. | +| TDMin | Integer | W | R/W | MTA Signalling MIB | pktcNcsEndPntConfigTdmin | Minimum number of seconds to wait after a disconnect. | +| TDMax | Integer | W | R/W | MTA Signalling MIB | pktcNcsEndPntConfigTdmax | Maximum number of seconds to wait after a disconnect. | +| RTO Max | Integer | W | R/W | MTA Signalling MIB | pktcNcsEndPntConfigRtoMax | Maximum number of seconds for the retransmission timer. | +| RTO Init | Integer | W | R/W | MTA Signalling MIB | pktcNcsEndPntConfigRtoInit | Initial value for the retransmission timer. | +| Long Duration Keepalive | Integer | W | R/W | MTA Signalling MIB | pktcNcsEndPntConfigLongDurationKeepAlive | Time-out in minutes for sending long duration call notification messages. | +| Thist | Integer | W | R/W | MTA Signalling MIB | pktcNcsEndPntConfigThist | The time-out period in seconds before no response is declared. | +| Call Waiting Max Reps | Integer | W, optional | R/W | MTA Signalling MIB | pktcNcsEndPntConfigCallWaitingMaxRep | This object contains the maximum number of repetitions of the call waiting that the MTA will play from a single CMS request. A value of zero (0) will be used when the CMS invokes any play repetition. | +| Call Waiting Delay | Integer | W, optional | R/W | IF-MIB (IETF RFC 2863) | pktcNcsEndPntConfigCallWaitingDelay | This object contains the delay between repetitions of the call waiting that the MTA will play from a single CMS request. | + +### **9.1.4 Per-realm configuration data** + +Refer to the MTA MIB [ITU-T J.166] and [IETF RFC 4682] for more detailed information concerning these attributes and their default values. Refer to the security Recommendation [ITU-T J.170] for more information on the use of Kerberos realms. There MUST be at least one conceptual row in the pktcMtaDevRealmTable to establish service upon completion of configuration. These configuration parameters are optional in the config file, but if included the config file MUST contain at least one Realm name to permit proper instantiation of the table. There may be more than one set of entries if multiple realms are supported. + +**Table 14 – Per-realm configuration data** + +| Attribute | Syntax | Access | SNMP access | MIB file | Object | Comments | +|------------------------------------|---------|-------------|-------------|----------------|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Pkinit Grace Period | Integer | W, optional | R/W | MTA Device MIB | pktcMtaDevRealmPkinitGracePeriod | For the purpose of IPSec key management with a CMS, the MTA MUST obtain a new Kerberos ticket (with a PKINIT exchange), many minutes before the old ticket expires. The minimum allowable value is 15 min. The default is 30 min. This parameter MAY also be used with other Kerberized applications. | +| TGS Grace Period | Integer | W, optional | R/W | MTA Device MIB | pktcMtaDevRealmTgsGracePeriod | When the MTA implementation uses TGS Request/TGS Reply Kerberos messages for the purpose of IPSec key management with the CMS, the MTA MUST obtain a new service ticket for the CMS (with a TGS request), many minutes before the old ticket expires. The minimum allowable value is 1 min. The default is 10 min. This parameter MAY also be used with other Kerberized applications. | +| Realm Org Name | Integer | W, required | R/W | MTA Device MIB | pktcMtaDevRealmOrgName | The value of the X.500 organization name attribute in the subject name of the Service provider certificate. | +| Unsolicited Keying max Timeout | Integer | W, optional | R/W | MTA Device MIB | pktcMtaDevRealmUnsolicitedKeyMaxTimeout | This timeout applies only when the MTA initiated key management. The maximum timeout is the value which may not be exceeded in the exponential backoff algorithm. | +| Unsolicited Keying Nominal Timeout | Integer | W, optional | R/W | MTA Device MIB | pktcMtaDevRealmUnsolicitedKeyNomTimeout | This timeout applies only when the MTA initiated key management. Typically this is the average roundtrip time between the MTA and the KDC. | +| Unsolicited Keying Max Retries | Integer | W, optional | R/W | MTA Device MIB | pktcMtaDevRealmUnsolicitedKeyMaxRetries | This is the maximum number of retries before the MTA gives up attempting to establish a Security Association. | + +### 9.1.5 Per-CMS configuration data + +Refer to the MTA MIB ([ITU-T J.166] and [IETF RFC 4682]) for more detailed information concerning these attributes and their default values. There MUST be at least one conceptual row in the pktcDevCmsTable to establish service upon completion of configuration. These configuration parameters are optional in the config file, but if included the config file MUST identify at least one CMS and its corresponding Kerberos Realm Name. There may be more than one set of entries if multiple CMSs are supported. + +As per [ITU-T J.170], the IPSec signalling security must be controlled by the Operator depending on the deployment and operational conditions. As the IPSec Security Association is established between the MTA and the CMS, the IPSec enabling/disabling control should also be on a per CMS basis. Enabling/Disabling of the IPSec Signalling Security MUST be defined only by the information in the MTA's Configuration File when the file is being downloaded, and the enable/disable toggling MUST be done only as a result of the MTA Reset. + +For more details on the MIB Object controlling the IPSec enabling/disabling, refer to the MTA MIB ([ITU-T J.166] and [IETF RFC 4682]). + +**Table 15 – Per-CMS configuration data** + +| Attribute | Syntax | Access | SNMP access | MIB file | Object | Comments | +|-------------------------------------------------------------------------------------------------------------|---------|--------------------|-------------|----------------|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Kerberos Realm Name | String | W, required (Note) | R/W | MTA Device MIB | pktcMtaDevCmsKerbRealm Name | The name for the associated Kerberos Realm. This is the corresponding Kerberos Realm Name in the Per Realm Configuration Data. | +| CMS Maximum Clock Skew | Integer | W, optional | R/W | MTA Device MIB | pktcMtaDevCmsMaxClockSkew | This is the maximum allowable clock skew between the MTA and CMS. | +| CMS Solicited Key Timeout | Integer | W, optional | R/W | MTA Device MIB | pktcMtaDevCmsSolicitedKey Timeout | This timeout applies only when the CMS initiated key management (with a Wake Up or Rekey message). It is the period during which the MTA will save a nonce (inside the sequence number field) from the sent out AP Request and wait for the matching AP Reply from the CMS. | +| Unsolicited Key Max Timeout | Integer | W, optional | R/W | MTA Device MIB | pktcMtaDevCmsUnsolicited KeyMaxTimeout | This timeout applies only when the MTA initiated key management. The maximum timeout is the value which may not be exceeded in the exponential backoff algorithm. | +| Unsolicited Key Nominal Timeout | Integer | W, optional | R/W | MTA Device MIB | pktcMtaDevCmsUnsolicited KeyNomTimeout | This timeout applies only when the MTA initiated key management. Typically this is the average roundtrip time between the MTA and the CMS. | +| Unsolicited Key Max Retries | Integer | W, optional | R/W | MTA Device MIB | pktcMtaDevCmsUnsolicited KeyMaxRetries | This is the maximum number of retries before the MTA gives up attempting to establish a security association. | +| IPSec Control | Integer | W, optional | R/O | MTA Device MIB | pktcMtaDevCmsIpsecCtrl | IPSec Control for each CMS: controls the IPSec establishment and IPSec related Key Management. | +| NOTE – If any data from the Per-CMS Data Table is included in the config file, this entry MUST be included. | | | | | | | + +### 9.1.6 Exclusion of MIB objects in configuration file + +The following MIB objects MUST NOT be sent in the configuration file since the values of these objects can be either set only by the MTA or by DHCP options during provisioning. If an MTA receives the following MIB objects in its configuration file, the MTA MUST ignore the object and report "passWithWarnings" and populate the Error OIDs Table. + +- PktcMtaDevSnmpEntity +- PktcMtaDevProvKerbRealmName +- PktcMtaDevFqdn +- PktcMtaDevSerialNumber +- PktcMtaDevMacAddress +- PktcMtaDevEndPntCount +- PktcMtaDevTypeIdentifier +- PktcEnNcsEndPntQuarantineState +- PktcEnNcsEndPntHookState +- pktcEnEndPntInfoTable +- pktcDevEventDescrEnterprise +- pktcDevEventDescrFacility +- pktcDevEventDescrText +- pktcDevEvLogIndex +- pktcDevEvLogTime +- pktcDevEvLogLevel +- pktcDevEvLogId +- pktcDevEvLogText +- pktcDevEvLogEndpointName +- pktcDevEvLogType +- pktcDevEvLogTargetInfo +- pktcDevEvLogCorrelationId +- pktcMtaDevProvConfigKey + +NOTE – For Syslog entries, specifically the MIB Objects "pktcDevEvSyslogAddressType" and "pktcDevEvSyslogAddress", the MTA MUST validate the 'type' provided (or stored) with the provided (or stored) 'Syslog Address' – if they are inconsistent, it MUST ignore any such entries in the configuration file, report a 'passWithWarnings' and populate the Error OIDs Table. + +# 10 MTA device capabilities + +MTA Capabilities string is supplied to the Provisioning Server in Option code 60 (Vendor Class Identifier) – to allow the Back-Office to differentiate between MTAs during the Provisioning Process. Use of Capabilities information by the Provisioning Application is optional. + +Capabilities string is encoded as an ASCII string containing the Capabilities information in Type/Length/Value (TLV) Format. + +For example, the ASCII encoding of the first two TLVs (IPCablecom Version 1.0 and Number of Telephony Endpoints = 2) of an MTA would be 05nn0101020102. Note that many more TLVs are required for IPCablecom MTA, and the field "nn" will contain the length of all the TLVs. This example shows only two TLVs for simplicity. + +The "value" field describes the capabilities of a particular modem, i.e., implementation dependent limits on the particular features or number of features, which the modem can support. It is composed from a number of encapsulated TLV fields. The encapsulated sub-types define the specific capabilities for the MTA. Note that the sub-type fields defined are only valid within the encapsulated capabilities configuration setting string. + +| Type | Length | Value | +|------|--------|-------| +| 5 | n | | + +The set of possible encapsulated fields is described below. + +MTA MUST Send Capabilities String in option 60 of the DHCP DISCOVER request. + +## 10.1 IPCablecom version + +This TLV MUST be supplied in the Capabilities String. + +| Type | Length | Value | Comment | Default value | +|------|--------|-------|-----------------|---------------| +| 5.1 | 1 | 0 | PacketCable 1.0 | NONE | +| | | 1 | PacketCable 1.5 | | + +## 10.2 Number of telephony endpoints + +This TLV of sub-type 5.2 (Number of telephony Endpoints) MUST be supplied in the Capabilities String. + +| Type | Length | Value | Comment | Default | +|------|--------|-------|---------------------|---------| +| 5.2 | 1 | n | Number of endpoints | NONE | + +## 10.3 TGT support + +| Type | Length | Value | Comment | Default value | +|------|--------|-------|---------|---------------| +| 5.3 | 1 | 0 | 0: No | 0 | +| | | 1 | 1: Yes | | + +## 10.4 HTTP download file access method support + +| Type | Length | Value | Comment | Default value | +|------|--------|-------|---------|---------------| +| 5.4 | 1 | 0 | 0: No | 0 | +| | | 1 | 1: Yes | | + +## 10.5 MTA24 event SYSLOG notification support + +| Type | Length | Value | Comment | Default value | +|------|--------|-------|---------|---------------| +| 5.5 | 1 | 0 | 0: No | 1 | +| | | 1 | 1: Yes | | + +## 10.6 NCS service flow support + +| Type | Length | Value | Comment | Default value | +|------|--------|-----------|----------|---------------| +| 5.6 | 1 | Undefined | Reserved | Undefined | + +Sub-type 5.6, which was previously used to indicate support for NCS Service Flow functionality, is currently undefined and reserved for future usage. + +## 10.7 Primary line support + +| Type | Length | Value | Comment | Default value | +|------|--------|-------|---------|---------------| +| 5.7 | 1 | 0 | 0: No | 0 | +| | | 1 | 1: Yes | | + +## 10.8 Vendor specific TLV Type(s) + +This TLV can be supplied in the Capabilities String if an MTA requires a specific processing of the Vendor Specific TLV Type(s). + +| Type | Length | Value | Comment | Default value | +|------|--------|----------------|-------------------|---------------| +| 5.8 | n | {seq-of-bytes} | One type per byte | 43 | + +Sub-type 5.8 which was previously used to indicate vendor specific TLV support by MTAs is currently obsolete, and the sub-type (5.8) is reserved for future usage. This MUST not be used by MTAs. + +## 10.9 NVRAM ticket/Ticket information storage support + +| Type | Length | Value | Comment | Default value | +|------|--------|-------|---------|---------------| +| 5.9 | 1 | 0 | 0: No | 1 | +| | | 1 | 1: Yes | | + +## 10.10 Provisioning event reporting support + +| Type | Length | Value | Comment | Default value | +|------|--------|-------|---------|---------------| +| 5.10 | 1 | 0 | 0: No | 1 | +| | | 1 | 1: Yes | | + +## 10.11 Supported CODEC(s) + +This TLV MUST be supplied in the Capabilities String. + +| Type | Length | Value | Comment | Default value | +|------|--------|----------------|-----------------|---------------| +| 5.11 | n | {seq-of-bytes} | One ID per byte | NONE | + +CODEC ID is the value represented by the Enumerated Type of "PktcCodecType" TEXTUAL CONVENTION in MTA MIB: + +- 1: other; +- 2: unknown; +- 3: G.729; +- 4: reserved; +- 5: G.729E; +- 6: PCMU; +- 7: G.726-32; +- 8: G.728; +- 9: PCMA; +- 10: G.726-16; +- 11: G.726-24; +- 12: G.726-40; +- 13: iLBC; +- 14: BV16; +- 15: telephone-event. + +Telephone-event represents [IETF RFC 2833] DTMF events. For more information, refer to ITU-T Rec. J.161. + +## 10.12 Silence suppression support + +| Type | Length | Value | Comment | Default value | +|------|--------|-------|---------|---------------| +| 5.12 | 1 | 0 | 0: No | 0 | +| | | 1 | 1: Yes | | + +## 10.13 Echo cancellation support + +| Type | Length | Value | Comment | Default value | +|------|--------|-------|---------|---------------| +| 5.13 | 1 | 0 | 0: No | 0 | +| | | 1 | 1: Yes | | + +## 10.14 RSVP support + +| Type | Length | Value | Comment | Default value | +|------|--------|-----------|---------------------------|---------------| +| 5.14 | 1 | Undefined | Reserved for future usage | Undefined | + +Sub-Type 5.14 which was previously used to indicate RSVP support is currently undefined and reserved for future usage. + +## 10.15 UGS-AD support + +| Type | Length | Value | Comment | Default value | +|------|--------|-------|---------|---------------| +| 5.15 | 1 | 0 | 0: No | 0 | +| | | 1 | 1: Yes | | + +## 10.16 MTA's "ifIndex" starting number in "ifTable" + +This TLV contains the value of the "ifIndex" for the first MTA Telephony Interface in "ifTable" MIB Table. The TLV MUST be supplied in the Capabilities String. + +| Type | Length | Value | Comment | Default value | +|------|--------|-------|---------------------|---------------| +| 5.16 | 1 | n | first MTA Interface | 9 | + +## 10.17 Provisioning flow logging support + +This capability is set to a corresponding value depending on the support of the logging capability of the Provisioning Flow (as per clause 5.4.3). + +| Type | Length | Value | Comment | Default value | +|------|--------|-------|---------|---------------| +| 5.17 | 1 | 0 | 0: No | 0 | +| | | 1 | 1: Yes | | + +## 10.18 Supported provisioning flows + +An MTA MUST include this TLV of sub-type 5.18 (Supported Provisioning flows) in the Capabilities String. This TLV indicates the provisioning flows the MTA supports (Basic, Hybrid and Secure). It contains a bitmask indicating all the provisioning flows supported by the MTA. + +| Type | Length | Value | Comment | Default value | +|------|--------|------------|-----------|---------------| +| 5.18 | 2 | {bit-mask} | See below | NONE | + +The Value field is an unsigned 16-bit integer encoded in network byte order. Each bit represents a specific provisioning flow. If a bit is set to 1, the MTA supports the corresponding flow. If a bit is set to 0 (zero), the MTA does not support the flow. + +Bit assignments: + +Bit 0 – Secure Flow (Full Secure Provisioning Flow) + +Bit 1 – Hybrid Flow + +Bit 2 – Basic Flow + +The MTA MUST set all unused bits in the bitmask to 0. The MTA MUST set bit 0 in the TLV to 1 to indicate that it supports the Secure Flow. The MTA MUST set bits 1 and 2 in the TLV to indicate whether it supports the Basic and Hybrid Flows. An example: if an MTA supports Secure and Basic Provisioning Flows, the integer value of the mask is 0x0005, and the capability will be encoded in option 60 as the following sequence of octets (in HEX notation): 12 02 00 05. + +To provide backward compatibility prior to the introduction of the Basic & Hybrid Flows, the absence of this TLV indicates that the MTA only supports the Secure Flow. + +## 10.19 T38 version support + +An MTA MUST include this TLV of sub-type 5.19 (T38 Version Support) in the Capabilities String. This TLV indicates the version of T.38 the MTA supports. For more details, refer to ITU-T Rec. J.161. + +| Type | Length | Value | Comment | Default value | +|------|--------|-------|------------------|---------------| +| 5.19 | 1 | 0 | 0: Unsupported: | 1 | +| | | 1 | 1: Version Zero | | +| | | 2 | 2: Version One | | +| | | 3 | 3: Version Two | | +| | | 4 | 4: Version Three | | + +## 10.20 T38 error correction support + +An MTA MUST include this TLV of sub-type 5.20 (T38 Error Correction Support) in the Capabilities String. This TLV indicates the type of error correction the MTA supports for T.38. For more details, refer to ITU-T Rec. J.161. + +| Type | Length | Value | Comment | Default value | +|------|--------|-------|---------------|---------------| +| 5.20 | 1 | 0 | 0: None | 1 | +| | | 1 | 1: Redundancy | | +| | | 2 | 2: FEC | | + +If you support FEC, it means you also support Redundancy. For more information, refer to ITU-T Rec. J.161. + +## 10.21 RFC 2833 DTMF support + +An MTA MUST include this TLV of sub-type 5.21 (RFC 2833 DTMF Support) in the Capabilities String. This TLV indicates the support for RFC 2833 DTMF relay. For more details, refer to ITU-T Rec. J.161. + +| Type | Length | Value | Comment | Default value | +|------|--------|-------|---------|---------------| +| 5.21 | 1 | 0 | 0: No | 1 | +| | | 1 | 1: Yes | | + +## 10.22 Voice metrics support + +An MTA MUST include this TLV of sub-type 5.22 (Voice Metrics Support) in the Capabilities String. This TLV indicates the support for voice metrics as defined in [IETF RFC 3611]. + +| Type | Length | Value | Comment | Default value | +|------|--------|-------|---------|---------------| +| 5.22 | 1 | 0 | 0: No | 1 | +| | | 1 | 1: Yes | | + +## 10.23 Device MIB support + +An MTA MUST include this TLV of sub-type 5.23 (Device MIB support) in the Capabilities String. This TLV indicates the various MIBs supported by the MTA. + +| Type | Length | Value | Comment | Default value | +|------|--------|----------------|---------------------------------------------|---------------| +| 5.23 | n | {seq-of-bytes} | MIB Support encoded as 'length-value' pairs | NONE | + +The 'length-value' pairs are defined as follows: + +[L1] [OCTET-1] [OCTET-2][OCTET-3] ...[OCTET-L1], + +[L2] [OCTET-1] [OCTET-2][OCTET-3] ...[OCTET-L2] + +(And other Length-Value pairs as deemed appropriate) + +Where: + +'L1' and 'L2' denote lengths. + +The first OCTET (OCTET-1) always represents the MIB issuing organization (Example, CableLabs, IETF, etc.). + +The remaining OCTETS are always placed in network-byte order to form a bit string where each bit represents a particular MIB. Setting a bit (to a value of 1) indicates support for the representative MIB and unsetting a bit (to a value of 0) indicates absence of support for the representative MIB. + +MTAs MUST NOT use any 'reserved assignments' unless defined by IPCablecom or assigned as 'vendor specific'. + +### 10.23.1 Issuing organization assignments + +OCTET-1 of the 'length-value' pair indicates the MIB issuing organization and the assignments are as follows: + +| Assignment | Organization indicator | +|------------|------------------------| +| 0 | CableLabs | +| 1 | IETF | +| 2 | EuroCableLabs | +| 3-9 | *reserved* | +| 10-63 | *vendor-specific* | + +NOTE – The higher order two bits of OCTET-1 are reserved allowing for 64 possibilities. + +### 10.23.2 Representing CableLabs MIBs + +For CableLabs issued MIBs (OCTET-1 = 0), the bit mask is defined as follows: + +| | | +|-------|-------------------------------------------| +| Bit 0 | PacketCable 1.5 MTA MIB. | +| Bit 1 | PacketCable 1.5 Signalling MIB. | +| Bit 2 | PacketCable 1.5 Management Event MIB. | +| Bit 3 | PacketCable 1.5 MTA Extension MIB. | +| Bit 4 | PacketCable 1.5 Signalling Extension MIB. | +| Bit 5 | PacketCable 1.5 MEM Extension MIB. | +| Bit 6 | *reserved* | +| Bit 7 | *reserved* | + +Where the bits are placed as follows: + +7 6 5 4 3 2 1 0 + +Given only one octet is used currently for the bit mask, the length for this length-value pair MUST be two (one each for the Organization Indicator and the bit mask, respectively). + +### 10.23.3 Representing IETF MIBs + +For MIBs represented as IETF RFCs (OCTET-1 = 1), the bit mask is defined as follows: + +| | | +|-------|-----------------------| +| Bit 0 | MTA MIB. | +| Bit 1 | Signalling MIB. | +| Bit 2 | Management Event MIB. | +| Bit 3 | *reserved* | +| Bit 4 | *reserved* | +| Bit 5 | *reserved* | +| Bit 6 | *reserved* | +| Bit 7 | *reserved* | + +Given only one octet is used currently for the bit mask, the length for this length-value pair MUST be two (One each for the Organization Indicator and the bit mask, respectively). + +#### Example + +For an MTA that supports all defined IETF MIBs (MTA, Signalling and MEM) and all defined IPCablecom 1.5 extension MIBs (MTA extension, Signalling extension and MEM extension), this sub-option would be encoded (in Hex) as follows (taken as a snapshot of option 60): + +| | | | | | | | | | | | | +|-----|-----|----|----|----|----|----|----|----|----|-----|-----| +| ... | ... | 17 | 06 | 02 | 00 | 38 | 02 | 01 | 07 | ... | ... | +|-----|-----|----|----|----|----|----|----|----|----|-----|-----| + +NOTE – As of this writing, only one of the proposed IETF drafts has received the status of RFC and this reference has been used only as an example. + +## 10.24 Multiple grants per interval support + +An MTA MUST include this TLV of sub-type 5.24 (Multiple Grants Per Interval Support) in the Capabilities String. This TLV indicates the support for Multiple Grants per interval. For more details, refer to ITU-T Rec. J.163. + +| Type | Length | Value | Comment | Default value | +|------|--------|-------|---------|---------------| +| 5.24 | 1 | 0 | 0: No | 0 | +| | | 1 | 1: Yes | | + +## 10.25 V.152 Support + +An MTA MUST include this TLV of sub-type 5.25 (V.152 Support) in the Capabilities String. This TLV indicates the support for V.152. + +| Type | Length | Value | Comment | Default Value | +|------|--------|-------|---------|---------------| +| 5.25 | 1 | 0 | 0: No | 1 | +| | | 1 | 1: Yes | | + +# 11 TLV-38 SNMP notification receiver specification + +This IPCablecom TLV-38 specifies one or more Network Management Stations that must receive notifications from the MTA (MTA25 or H-MTA-25 or B-MTA-25 and post-provisioning, if required). If TLV-38 and its sub-TLVs defined in this clause contain incorrect value in 'Length' field, the MTA MUST reject the configuration file and report a "failConfigFile" error. If TLV-38 contains sub-types with wrong values, then the MTA MUST follow the requirements specified below in each sub-TLV. + +In addition, if the MTA encounters unknown sub-TLVs within TLV-38, it MUST: + +- Assume the length field size of 1 byte for the sub-TLV; +- Ignore the sub-TLV and continue with further processing; and +- Report a provisioning state of 'passWithWarnings' and populate Error Oid Table. + +| Type | Length | Value | +|------|--------|-------------------------------| +| 38 | N | Composite (contains sub-TLVs) | + +Unless specified or configured otherwise, the MTA MUST send the notifications to the default provisioning system (defined in DHCP option 122 sub-option 3). + +## 11.1 Sub-TLVs of TLV-38 + +### 11.1.1 SNMP notification receiver IP address + +This sub-TLV specifies the IP address of the notification receiver. + +| Type | Length | Value | +|------|--------|--------------------------------------------------| +| 38.1 | 4 | 4 bytes of an IPv4 address in network byte order | + +If TLV-38 is present in the configuration file and the sub-TLV 38.1 is absent, the MTA MUST ignore TLV-38 and proceed with further processing of the configuration file and MUST report a provisioning state of 'passWithWarnings' and populate the error OID table (pktcMtaDevErrorOidsTable). + +### 11.1.2 SNMP notification receiver UDP port number + +This sub-TLV specifies the Port number on the notification receiver to receive the notifications. + +| Type | Length | Value | +|------|--------|-----------------| +| 38.2 | 2 | UDP Port Number | + +If TLV-38 is present and the sub-TLV 38.2 is absent, then a default value of 162 MUST be used. + +### 11.1.3 SNMP notification receiver type + +This sub-TLV specifies the SNMP Notification Receiver Type; it is the type of SNMP notifications the MTA MUST send to the associated SNMP Notification Receiver. + +| Type | Length | Value | +|------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 38.3 | 2 | 1: SNMPv1 trap in an SNMPv1 packet
2: SNMPv2c trap in an SNMPv2c packet
3: SNMP INFORM in an SNMPv2c packet
4: SNMP trap in an SNMPv3 packet
5: SNMP INFORM in a SNMPv3 packet | + +If TLV-38 is present in the configuration file but sub-TLV 38.3 is absent, the MTA MUST ignore the entire TLV-38 and proceed with further processing of the configuration file and MUST report 'passWithWarnings' and populate the Error OID table (pktcMtaDevErrorOidsTable). The MTA and Provisioning Server MUST support notification type values 2 and 3, and MAY support notification type values 1, 4 or 5 from the above table. If an unsupported or invalid notification type value is received, the MTA MUST ignore the entire TLV-38 that contains this entry and MUST report 'passWithWarnings' and populate the error OID table (pktcMtaDevErrorOidsTable). If the notification types of 4 or 5 are used in the Basic or Hybrid provisioning flows, SNMPv3 communication is assumed to be implemented as per SNMPv3 recommendations and is outside the scope of this Recommendation. + +### 11.1.4 SNMP notification receiver timeout + +This sub-TLV specifies the wait time before a retry is attempted when the sender of an SNMP INFORM fails to receive an acknowledgement. Note that the number of retries is defined in sub-TLV 38.5. + +| Type | Length | Value | +|------|--------|----------------------| +| 38.4 | 2 | Time in milliseconds | + +If TLV-38 is present in the configuration file and the sub-TLV 38.4 is absent, the MTA MUST assume a default value of 15000 milliseconds. This corresponds to the default value of 1500 hundredths of a second defined for the snmpTargetAddrTimeout MIB object (see [IETF RFC 3413]). + +### 11.1.5 SNMP notification receiver retries + +This sub-TLV specifies the maximum number of times the MTA MUST retry sending an SNMP INFORM message if an acknowledgement is not received. Note that the wait time before each retry is defined by sub-TLV 38.4. + +| Type | Length | Value | +|------|--------|-------------------| +| 38.5 | 2 | Number of retries | + +If not present, the MTA MUST use a default value of 3. The maximum number of retries that can be specified is 255. + +### 11.1.6 SNMP notification receiver filtering parameters + +This sub-TLV specifies the filtering scheme for notifications and contains the root OID of the MIB sub-tree that defines the notifications to be sent to the Notification Receiver. The MTA MUST filter notifications being sent to the SNMP manager specified in sub-TLV 38.1 using the information + +provided. If this sub-TLV is not present, the MTA MUST use the default OID value for the 'iso' root. + +| Type | Length | Value | +|------|--------|---------------------------------------------------| +| 38.6 | n | Filter OID
(ASN.1 formatted Object Identifier) | + +The encoding of this TLV value field starts with the ASN.1 Universal type 6 (Object Identifier) followed by the ASN.1 length field and is terminated by the ASN.1 encoded object identifier component. + +### 11.1.7 SNMPv3 notification receiver security name + +This sub-TLV specifies the SNMPv3 Security Name to use when sending an SNMPv3 Notification. This sub-TLV is only being used if MTA supports sub-TLV 38.3 (Notification Receiver Type) types 4 and 5. The MTA MUST ignore this sub-TLV 38.7 if a Notification Receiver Type (sub-TLV 38.3) other than 4 or 5 is received in the configuration file. + +The following requirements apply to MTAs that support Notification Receiver Type values of 4 or 5 in sub-TLV 38.3: + +- If this sub-TLV 38.7 is omitted, then the SNMPv3 Notifications MUST be sent in the noAuthNoPriv security level using the security name "@mtaconfig". +- If this sub-TLV is included, the MTA verifies that the value of the Security Name exists for the MTA local authoritative SNMP engine and creates an entry to further associate with the notification receiver authoritative engine (using the security levels and keys from the existing Security Name). If the Security Name of this sub-TLV does not exist for the local engine, the entire TLV-38 MUST be ignored and the MTA MUST report 'passWithWarnings' and populate the Error OID table (pktcMtaDevErrorOidsTable) for the entire TLV-38 and associated sub-TLVs that are ignored. + +| Type | Length | Value | +|------|--------|---------------| +| 38.7 | 2-26 | Security Name | + +## 11.2 Mapping of TLV fields into SNMP tables + +The following clauses detail the MTA configuration file TLV-38 "PacketCable SNMP Notification Receiver" mapping onto SNMP functional tables. + +Upon receiving each TLV-38 value, the MTA MUST make entries to the following tables in order to cause the desired SNMP TRAP or INFORM transmission: snmpNotifyTable, snmpTargetAddrTable, snmpTargetAddrExtTable, snmpTargetParamsTable, snmpNotifyFilterProfileTable, snmpNotifyFilterTable, snmpCommunityTable, usmUserTable, vacmSecurityToGroupTable, vacmAccessTable, and vacmViewTreeFamilyTable. An MTA MUST support a minimum of ten TLV-38 elements in a configuration file. + +### 11.2.1 Mapping of TLV fields into created SNMP table rows + +The tables in this clause show how the fields from the Configuration file TLV element (the tags in angle brackets <>) are placed into the SNMP tables. + +The correspondence between the tags and the sub-TLVs themselves is as shown below: + +| | | +|--------------|----------| +|
(RFC 3413, SNMP-
NOTIFICATION-MIB) | First row | Second row | +|-------------------------------------------------------------------|---------------------|-------------------| +| Column Name (* = Part of Index) | Column Value | Column Value | +| * snmpNotifyName | "@mtaconfig_inform" | "@mtaconfig_trap" | +| snmpNotifyTag | "@mtaconfig_inform" | "@mtaconfig_trap" | +| snmpNotifyType | inform (2) | trap (1) | +| snmpNotifyStorageType | Volatile | Volatile | +| snmpNotifyRowStatus | active (1) | active (1) | + +#### 11.2.1.2 snmpTargetAddrTable + +For each TLV-38 element in the configuration file, the MTA MUST create one row according to Table 17. + +**Table 17 – snmpTargetAddrTable** + +| snmpTargetAddrTable
(RFC 3413, SNMP-TARGET-MIB) | New row | +|-------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| Column Name (* = Part of Index) | Column Value | +| * snmpTargetAddrName | "@mtaconfig_n" Where n ranges from 0 to m – 1 where m is the number of notification receiver TLV elements in the Configuration file | +| snmpTargetAddrTDomain | snmpUDPDomain = snmpDomains.1 | +| snmpTargetAddrTAddress
(IP Address and UDP Port of
the Notification Receiver) | OCTET STRING (6)
Octets 1-4:
Octets 5-6:
"@mtaconfig_trap"
Else If
"@mtaconfig_inform" | + +**Table 17 – snmpTargetAddrTable** + +| snmpTargetAddrTable
(RFC 3413, SNMP-TARGET-MIB) | New row | +|------------------------------------------------------------|---------------------------------------------------| +| snmpTargetAddrParams | "@mtaconfig_n" (Same as snmpTargetAddrName value) | +| snmpTargetAddrStorageType | Volatile | +| snmpTargetAddrRowStatus | active (1) | + +#### **11.2.1.3 snmpTargetAddrExtTable** + +For each TLV-38 element in the configuration file, the MTA MUST create one row according to Table 18. + +**Table 18 – snmpTargetAddrExtTable** + +| snmpTargetAddrExtTable
(RFC 3584, SNMP-COMMUNITY-MIB) | New row | +|------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| Column Name (* = Part of Index) | Column Value | +| * snmpTargetAddrName | "@mtaconfig_n" Where n ranges from 0 to m – 1 where m is the number of notification receiver TLV elements in the Configuration file | +| snmpTargetAddrTMask |
(RFC 3413, SNMP-TARGET-MIB) | New row | +|------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| Column Name (* = Part of Index) | Column Value | +| * snmpTargetParamsName | "@mtaconfig_n" Where n ranges from 0 to m – 1 where m is the number of notification receiver TLV elements in the Configuration file | +| snmpTargetParamsMPModel
SYNTAX:
snmpMessageProcessingModel | SNMPv2c (1) | +| snmpTargetParamsSecurityModel
SYNTAX: snmpSecurityModel | SNMPv2c (2)
NOTE – The mapping of SNMP protocol types to value here is different from snmpTargetParamsMPModel | +| snmpTargetParamsSecurityName | "@mtaconfig" | +| snmpTargetParamsSecurityLevel | NoAuthNoPriv | +| snmpTargetParamsStorageType | Volatile | +| snmpTargetParamsRowStatus | active (1) | + +#### 11.2.1.5 snmpNotifyFilterProfileTable + +For each TLV-38 element in the configuration file with non-zero value of TLV-38 sub-type 6, the MTA MUST create one row according to Table 20. + +**Table 20 – snmpNotifyFilterProfileTable** + +| snmpNotifyFilterProfileTable
(RFC 3413, SNMP-NOTIFICATION-MIB) | New row | +|---------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| Column Name (* = Part of Index) | Column Value | +| * snmpTargetParamsName | "@mtaconfig_n" Where n ranges from 0 to m – 1 where m is the number of notification receiver TLV elements in the Configuration file | +| snmpNotifyFilterProfileName | "@mtaconfig_n" Where n ranges from 0 to m – 1 where m is the number of notification receiver TLV elements in the Configuration file | +| snmpNotifyFilterProfileStorageType | volatile | +| snmpNotifyFilterProfileRowStatus | active (1) | + +#### 11.2.1.6 snmpNotifyFilterTable + +For each TLV-38 element in the configuration file with non-zero value of TLV-38 sub-type 6, the MTA MUST create one row according to Table 21. + +**Table 21 – snmpNotifyFilterTable** + +| snmpNotifyFilterTable
(RFC 3413, SNMP-NOTIFICATION-MIB) | New row | +|--------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| Column Name (* = Part of Index) | Column Value | +| * snmpNotifyFilterProfileName | "@mtaconfig_n" Where n ranges from 0 to m – 1 where m is the number of notification receiver TLV elements in the Configuration file | +| * snmpNotifyFilterSubtree |
(RFC 3584, SNMP-COMMUNITY-MIB) | First row | +|--------------------------------------------------------------|----------------------------| +| Column Name (* = Part of Index) | Column Value | +| * snmpCommunityIndex | "@mtaconfig" | +| snmpCommunityName | "public" | +| snmpCommunitySecurityName | "@mtaconfig" | +| snmpCommunityContextEngineID |
(RFC 3414,
SNMP-USER-BASED-SM-MIB) | Static row
Case 1 | Other rows
Case 2 | +|----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------| +| Column Name (* = Part of Index) | Column Value | Column Value | +| * usmUserEngineID | 0x00, create a new row on each time the EngineID of the Authoritative Notification Receiver is discovered. | 0x00, create a new row on each time the EngineID of the Authoritative Notification Receiver is discovered. | +| usmUserName | "@mtaconfig". | When other rows are created, this is replaced with the
This row is not created by cloning mechanism |
This row is not created by cloning mechanism. | + +**Table 23 – usmUserTable** + +| usmUserTable
(RFC 3414,
SNMP-USER-BASED-SM-MIB) | Static row
Case 1 | Other rows
Case 2 | +|----------------------------------------------------------------|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| usmUserAuthProtocol | None
(usmNoAuthProtocol) | When other rows are created, this is replaced with none (usmNoAuthProtocol), or MD5 (usmHMACMD5AuthProtocol), or SHA (usmHMACSHAAuthProtocol) depending on the security level of the SNMPv3 user. | +| usmUserAuthKeyChange | Empty | Empty | +| usmUserOwnAuthKeyChange | Empty | Empty | +| usmUserPrivProtocol | Case 1:
none (usmNoPrivProtocol) | When other rows are created this is replaced with none (usmNoPrivProtocol) or DES (usmDESPrivProtocol), depending on the security level of the SNMPv3 user. | +| usmUserPrivKeyChange | Empty | Empty | +| usmUserOwnPrivKeyChange | Empty | Empty | +| usmUserPublic | Empty | Empty | +| usmUserStorageType | volatile (2) | volatile (2) | +| usmUserStatus | active (1) | Active (1) | + +#### **11.2.1.9 vacmSecurityToGroupTable** + +If TLV-38 elements are present and irrespective of the number of elements, the MTA MUST create "Second Row" column and MAY create "First Row" or "Third Row" columns with fixed values as described in Table 24. MTA MUST populate "Second Row" and "Third Row" columns for Secure Provisioning Flow only. + +**Table 24 – vacmSecurityToGroupTable** + +| vacmSecurityToGroupTable
(RFC 3415,
SNMP-VIEW-BASED-ACM-MIB) | First row | Second row | Third row | +|-----------------------------------------------------------------------------|------------------|-------------------|------------------| +| Column Name (* = Part of Index) | Column Value | Column Value | Column Value | +| * vacmSecurityModel | SNMPV1 (1) | SNMPV2c (2) | SNMPUSM (3) | +| * vacmSecurityName | "@mtaconfig" | "@mtaconfig" | "@mtaconfig" | +| vacmGroupName | "@mtaconfigV1" | "@mtaconfigV2" | "@mtaconfigUSM" | +| vacmSecurityToGroupStorageType | volatile (2) | volatile (2) | volatile (2) | +| vacmSecurityToGroupStatus | Active (1) | active (1) | active (1) | + +#### 11.2.1.10 vacmAccessTable + +If TLV-38 elements are present and irrespective of the number of elements, the MTA MUST create "Second Row" column and MAY create "First Row" or "Third Row" columns with fixed values as described in Table 25. MTA MUST populate "Second Row" and "Third Row" columns for Secure Provisioning Flow only. + +**Table 25 – vacmAccessTable** + +| vacmAccessTable
(RFC 3415,
SNMP-VIEW-BASED-ACM-MIB) | First row | Second row | Third row | +|--------------------------------------------------------------------|------------------|-------------------|------------------| +| Column Name (* = Part of Index) | Column Value | Column Value | Column Value | +| * vacmGroupName | "@mtaconfigV1" | "@mtaconfigV2" | "@mtaconfigUSM" | +| * vacmAccessContextPrefix | Empty | Empty | Empty | +| * vacmAccessSecurityModel | SNMPv1 (1) | SNMPv2c (2) | USM (3) | +| * vacmAccessSecurityLevel | noAuthNoPriv (1) | noAuthNoPriv (1) | noAuthNoPriv (1) | +| vacmAccessContextMatch | exact (1) | exact (1) | exact (1) | +| vacmAccessReadViewName | Empty | Empty | Empty | +| vacmAccessWriteViewName | Empty | Empty | Empty | +| vacmAccessNotifyViewName | "@mtaconfig" | "@mtaconfig" | "@mtaconfig" | +| vacmAccessStorageType | volatile (2) | volatile (2) | volatile (2) | +| vacmAccessStatus | active (1) | active (1) | active (1) | + +#### 11.2.1.11 vacmViewTreeFamilyTable + +If TLV-38 elements are present and irrespective of the number of elements, the entry below as defined in Table 26 MUST be created. Note that this entry is already created at MTA initialization. + +**Table 26 – vacmViewTreeFamilyTable** + +| vacmViewTreeFamilyTable
(RFC 3415, SNMP-VIEW-BASED-ACM-MIB) | First row | +|------------------------------------------------------------------------|--------------------| +| Column Name (* = Part of Index) | Column Value | +| * vacmViewTreeFamilyViewName | "@mtaconfig" | +| * vacmViewTreeFamilySubtree | 1.3 | +| vacmViewTreeFamilyMask |
[org] | [@mtaconfig_1]
[pktcMtaProvision-
ingStatus] | [@mtaconfig_3]
[PktcMtaMib] | [@mtaconfig_4]
[pktcMtaProvision-
ingStatus] | +|--------------|---------------------------------|-------------------------------------------------------------|----------------------------------------|-------------------------------------------------------------| +| Mask | "" | "" | "" | "" | +| Type | Included | Included | Included | Included | +| StorageType | Volatile | Volatile | Volatile | Volatile | +| RowStatus | Active | Active | Active | Active | + +# 12 SNMPv2c management requirements + +The management of an MTA device using SNMPv2c can be configured if required by an operator by setting the proper coexistence tables (using TLV-11) in the MTA configuration file or via post-provisioning management. + +- In the Basic and Hybrid Flows, the MTA MUST configure the tables described in clauses 12.1 and 12.2 after MTA4 to provide SNMPv2c read/write access to the default management system (provisioning entity provided in DHCP option 122 sub-option 3). +- In the Secure Flow, the MTA MUST configure the tables in clause 12.2 if the configuration file contains TLV-11 varbindings with the data of snmpCommunityTable. Additionally, in order to restrict SNMP access to the MTA in the inbound direction, the configuration file may also contain TLV-11 varbindings for snmpTargetAddrTable and/or snmpTargetAddrExtTab. + +Appendix I provides an example template for operators to enable SNMPv2c management. + +## 12.1 SNMPV2c coexistence mode tables content created by MTA after MTA4 for hybrid and basic flows + +See Tables 40 to 42. + +**Table 40 – snmpCommunityTable Content** + +| snmpCommunityTable
(RFC 3584, SNMP-COMMUNITY-MIB) | Read write access | +|--------------------------------------------------------------|---------------------------| +| Column Name (* = Part of Index) | Column Value | +| * snmpCommunityIndex | "@mtaprov" | +| snmpCommunityName | "private" | +| snmpCommunitySecurityName | "@mtaprov" | +| snmpCommunityContextEngineID |
(RFC 3413, SNMP-TARGET-MIB) | First row | +|----------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| +| Column Name (* = Part of Index) | Column Value | +| * snmpTargetAddrName | "@mtaprov" | +| snmpTargetAddrTDomain | snmpUDPDomain = snmpDomains.1 | +| snmpTargetAddrTAddress
(IP Address non-Authoritative SNMP entity) | OCTET STRING (6)
Octets 1-4:
Octets 5-6:
any 2-byte port value | +| snmpTargetAddrTimeout | Ignore,