OpenTV ENTera & OpenTV Platform Documentation
26.26_Q2 25.52_Q4 25.26_Q2 25.12_Q1 24.50_Q4 24.38_Q3 24.26_Q2 23.50_Q4 23.24_Q2 23.12_Q1 22.50_Q4 22.38_Q3 22.24_Q2
26.26_Q2 25.52_Q4 25.26_Q2 25.12_Q1 24.50_Q4 24.38_Q3 24.26_Q2 23.50_Q4 23.24_Q2 23.12_Q1 22.50_Q4 22.38_Q3 22.24_Q2

Message format – EPG update

Overview

OpenTV Platform can be configured to send notifications to clients to let them know that there have been changes to EPG metadata.

These changes include:

  • Changes to BTV (live) metadata – for example, a change to a description or episode name

  • Rescheduling of live events – for example, the extension of a football match that has gone into extra time, and the rearrangement of subsequent programmes

EPG change notifications do not include the details of the changes. They are just notifications.

The client must call Metadata Server (MDS) or Content Discovery Facade to get the updated event details.

Depending on how the platform is configured, EPG changes are notified in this format, in the format described in Respond to metadata change notifications, or both. A client should handle both formats.

Changes are grouped by channel: at regular intervals (every five minutes by default), one message is sent for each channel that has changed, covering the time window that changed. Only changes within six hours before or after the current time are notified.

Message format

Example of an EPG update message, as received through AWS IoT Core:

JSON
{"data":{"reference":"GLOBAL_sky_one","referenceType":"EPG_UPDATE","action":"REFRESH","name":"epg","priority":"HIGH","start":1454284800,"end":1454292000}}

Through Firebase or ADM, the SDK delivers the same fields as strings:

JSON
{
  "reference": "GLOBAL_sky_one",
  "referenceType": "CHANNEL",
  "action": "REFRESH",
  "name": "epg",
  "priority": "HIGH",
  "start": "1454284800",
  "end": "1454292000"
}

Field

Description

reference

The ID of the channel whose EPG has changed

referenceType

CHANNEL

action

REFRESH

name

epg if the schedule changed (for example, events were rescheduled), or content if only metadata changed (for example, a title or description)

priority

HIGH

start

The start of the time window that changed, in Unix time (seconds). A number through AWS IoT Core, a string through Firebase or ADM.

end

The end of the time window that changed, in Unix time (seconds). A number through AWS IoT Core, a string through Firebase or ADM.

See also

Metadata change alerts