RDK Documentation (Open Sourced RDK Components)

Description

Certain information will be shared among messages, as described below.

Custom Attributes

Tuner State object represents state of the tuner.
CustomAttributes :=
{
// JSON Entities defined by application
}

The CustomAttribute contains JSON Entities defined by the application. It is sent by the application when it requests for a tuner reservation. After the reservation is granted, and as long as the content of the reservation is not modified, the customAttributes will be present in any messages, including the asynchronous notifications, that contains the corresponding TunerRevervation. If a renewed TunerReservation also contains CustomAttribute, the new attributes object will take the place. See more on this in NotifyTunerReservationUpdate message.
The lifetime of the object is then same as the lifetime of the TunerReversation itself.

Modules

 TRM General Messages
 The messages will follow the request-response message exchange pattern. The general format of the request payload is:
 
 TRM Interface Classes
 Described the details about the classes used in Messages.
 
 TRM Notification Messages
 Notifications are asynchronous messages sent by TRM to token owners with regard to status update of an existing reservation.
 
 TRM Utility Messages
 Utility Messages provide useful information about the status of the TRM.