Skip to main content

Enable VAS EPG-Based Recording for Customer

EPG-based Recording provides automated recording capabilities driven by Electronic Program Guide (EPG) data, enabling scheduled recording of linear television content based on program schedules.

EPG-Based Recording Setup​

Prerequisites and Configuration​

Initial Setup Requirements​

  1. VAS Enablement: Contact the SH team to enable EPG-based Recording VAS and obtain FTP authentication credentials for the customer account

  2. Linear Live Job Configuration: Create corresponding linear live jobs through the portal or Open API with EPG-based recording options enabled

![Figure Needed] Screenshot showing EPG-based recording selection options in job configuration

Recording Options​

Select one of the required EPG-based recording formats:

  • EPG-based Live Recording as HLS
  • EPG-based Live Recording as MP4

Implementation Process​

EPG XML File Preparation​

Manual Preparation: Create EPG XML files manually following the specified template format Automated Generation: Utilize Professional Services resources for automated EPG file generation through custom development

File Upload and Deployment​

  1. FTP Upload: Upload the prepared EPG XML file to the designated FTP server using credentials from step 1
  2. Stream Validation: Ensure linear live streaming operates correctly during the time periods defined in the EPG XML
  3. Monitoring: Verify EPG-based recording information through the job view page on the portal

![Figure Needed] Screenshot of EPG-based recording information displayed in job view page

EPG XML Template Specification​

XML Structure Template​

<tv>
    <channel id="s271">
        <!--value of name: {app_name}/{stream_name}-->
        <!-- Input the same app name and stream name with these information of the linear live job -->
        <name>live/s271</name>
    </channel>

    <channel id="s273">
        <name>live/s273</name>
    </channel>

    <!-- A recording stream will be generated for each program. -->
    <!--start: time point to start recording of this program. -->
    <!--stop: time point to stop recording of this program. -->
    <program start="20180412184200 +0800" stop="20180412184700 +0800" channel="s271">
        <name>s271program_12</name>
    </program>

    <program start="20180412184700 +0800" stop="20180412185200 +0800" channel="s271">
        <name>s271program_13</name>
    </program>

    <program start="20180412185200 +0800" stop="20180412185700 +0800" channel="s271">
        <name>s271program_14</name>
    </program>

    <program start="20180412185200 +0800" stop="20180412185700 +0800" channel="s273">
        <name>s273program_1</name>
    </program>
</tv>

XML Configuration Guidelines​

Channel Configuration: Define channels with unique IDs matching app_name/stream_name format Program Scheduling: Specify start and stop times with timezone information (+0800) Recording Generation: Each program element generates a separate recording stream Naming Convention: Use descriptive program names for easy identification

Stream Quality Monitoring​

RTMP Stream Analysis​

Smooth Stream Characteristics​

Bitrate Stability: Bitrate curve fluctuates within a small, consistent range

![Figure Needed] Screenshot of stable RTMP bitrate monitoring chart

Frame Rate Consistency: FPS and FPS metadata curves overlap as a horizontal line, indicating stable frame delivery

![Figure Needed] Screenshot showing consistent FPS and metadata curves

Unstable Stream Indicators​

Bitrate Irregularities: Sharp concave curves or reduction to zero indicate stream interruption

![Figure Needed] Screenshot of unstable RTMP bitrate with sharp drops

Frame Rate Disruption: Obvious drops in FPS curves indicate streaming issues

![Figure Needed] Screenshot showing FPS disruption patterns

MPEG-TS Stream Analysis​

Stable MPEG-TS Characteristics​

Bitrate Consistency: Bitrate fluctuations remain within acceptable ranges

![Figure Needed] Screenshot of stable MPEG-TS bitrate monitoring

PCR Stability: PCR per 5 seconds maintains consistent horizontal line pattern

![Figure Needed] Screenshot showing stable PCR monitoring data

MPEG-TS Stream Issues​

Bitrate Problems: Sharp concave curves or drops to zero indicate stream instability

![Figure Needed] Screenshot of unstable MPEG-TS bitrate patterns

PCR Disruption: Irregular PCR patterns indicate timing and synchronization issues

![Figure Needed] Screenshot showing PCR instability indicators

The monitoring capabilities enable proactive identification of stream quality issues that could affect EPG-based recording operations, ensuring reliable automated recording functionality.