Network timeshifting

Summary

The NpvrLocker Product provides the following main features to SDP clients:

Storage of Recording Requests per user containing current EPG-related metadata.
Aggregation of per-user Recording Requests into per-event content capture requests.
Interfaces to provide CMS' WFM system with capture job details for initiating actual recording capturing requests with the various HE encoders, such as Harmonic and Envivio.
Per user storage quotas.
Integration with the MDS to retrieve the most current event metadata.
Integration with the SDP for authorisation of all client requests.

Data models

Recording Request data model

This is a JSON object with the following fields:

Name	Type	Description	Localised	Always available
`_id`	String	Internal identifier for the object.	No	Yes
`accountNumber`	String	The account number requesting the recording.	No	Yes
`availabilityEndDate`	Date	The availability end date of the recording request.	No	Yes
`availabilityStartDate`	Date	The availability start date of the recording request.	No	Yes
`channelId`	String	The main channel ID of the event.	No	Yes
`contentId`	String	The metadata content identifier.	No	Yes
`created`	Date	The date that the recording request was created.	No	Yes
`deviceType`	Array of strings	The device types supported by this recording request for example, `ios` or `stb`.	No	Yes
`duration`	Long	The duration of the content.	No	Yes
`isprotected`	Boolean	A flag to indicate whether the recording request can be deleted fully. This field should be set to `true` if DELETE should not be allowed and to `false` if it should.	No	Yes
`modified`	Date	The date that the recording request was modified.	No	Yes
`programmeId`	String	The programme ID of the event to be recorded. Maps to the `programme.id` in MDS.	No	Yes
`programmeMetaData`	Map	The programme metadata, sourced from the MDS. This can be applied when the recording request is created with a POST, but will be overwritten when the programme moves to RECORDING state with the latest copy from MDS.	No	Yes
`seriesId`	String	The metadata series identifier.	No	Yes
`serviceProviderPublicId`	String	The Service Provider name.	No	Yes
`status`	String	The status of the recording request.	No	Yes
`uri`	String	The URI of the recording request.	No	Yes
`workflowVersion`	Integer	The workflow version corresponding to the nPVR capability.	No	Yes

Example

CODE

{
    "accountNumber": "910-5754255",
    "programmeId": "6033_531",
    "created": 1394127591406,
    "modified": 1394127591406,
    "status": "NEW",
    "uri": "http://127.0.0.1:7777/api/npvrlocker/v1/recordingrequests/KBRO/5318b2f8e4b00c4a6e839f01"
}

21 reads

Series Recording Request data model

This is a JSON object with the following fields:

Name	Type	Description	Localised	Always available
`_id`	String	The internal identifier for the object.	No	Yes
`accountNumber`	String	The account number requesting the recording.	No	Yes
`channelId`	String	The main channel ID of the event.	No	Yes
`contentId`	String	The metadata content identifier.	No	Yes
`created`	Date	The date that the recording request was created.	No	Yes
`modified`	Date	The date that the recording request was modified.	No	Yes
`seriesId`	String	The metadata series identifier.	No	Yes
`seriesMetaData`	Map	The series metadata, sourced from the MDS.	No	Yes
`serviceProviderPublicId`	String	The Service Provider name.	No	Yes
`status`	String	The status of the recording request.	No	Yes

Example

CODE

{
    "accountNumber": "910-5754255",
    "programmeId": "6033_70x",
    "created": 1394127591406,
    "modified": 1394127591406,
    "status": "NEW",
    "uri": "http://127.0.0.1:7777/api/npvrlocker/v1/recordingrequests/KBRO/5318b2f8e4b00c4a6e839f01",
    "seriesId": "CDNPS624201",
    "contentId": "SCONT6242_006"
}

18 reads

Use cases

Record a broadcast event using network PVR

Example:

CODE

POST http://server:port/api/npvrlocker/v1/recordingrequests/CMS4X
Content-Type: application/json
 
    {
        "accountNumber": "910-5754255",
        "programmeId": "6033_531",
        "created": 1394127591406,
        "modified": 1394127591406,
        "status": "NEW",
        "uri": "http://127.0.0.1:7777/api/npvrlocker/v1/recordingrequests/KBRO/5318b2f8e4b00c4a6e839f01"
      }

Record a broadcast series using network PVR

POST /api/npvrlocker/v1/recordingrequests/{serviceProviderPublicId}

Example:

CODE

POST http://server:port/api/npvrlocker/v1/recordingrequests/CMS4X?seriesLinking=true"
Content-Type: application/json
     {
        "accountNumber": "910-5754255",
        "programmeId": "6033_70x",
        "created": 1394127591406,
        "modified": 1394127591406,
        "status": "NEW",
        "uri": "http://127.0.0.1:7777/api/npvrlocker/v1/recordingrequests/KBRO/5318b2f8e4b00c4a6e839f01",
        "seriesId": "CDNPS624201",
        "contentId": "SCONT6242_006"
      }

Retrieve a list of NPVR recordings

GET /api/npvrlocker/v1/seriesrecording/{serviceProviderPublicId}

Example:

CODE

GET http://server:port/api/npvrlocker/v1/recordingrequests/CMS4X?sort={'seriesId':1}&filter={status: {'$in': ['NEW', 'RECORDING']}}

Retrieve a specific NPVR recording

Example:

CODE

GET http://server:port/api/npvrlocker/v1/seriesrecording/CMS4X/543fb80200b090525021fb1a

Update a NPVR event recording

Protect a recording

Example:

CODE

PUT http://server:port/api/npvrlocker/v1/recordingrequests/CMS4X/programme/123/protection/true

Unprotect a recording

Example:

CODE

PUT http://server:port/api/npvrlocker/v1/recordingrequests/CMS4X/programme/123/protection/false

Delete a NPVR event recording

Example:

CODE

DELETE http://server:port/api/npvrlocker/v1/recordingrecordings/CMS4X/543fb80200b090525021fb1a

Retrieve the quota usage

Example:

CODE

GET http://server:port/api/npvrlocker/v1/quotausage/{serviceProviderPublicId}&filter={status:'RECORDING'}")

Summary

Data models

Use cases

Record a broadcast event using network PVR

Record a broadcast series using network PVR

Retrieve a list of NPVR recordings

Retrieve a specific NPVR recording

Update a NPVR event recording

Protect a recording

Unprotect a recording

Delete a NPVR event recording

Retrieve the quota usage

See also