HbbTv  17.9.0
Open source HBBTV engine
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
Typedefs | Functions | Variables
scheduled_recording.c File Reference

ScheduledRecording class. More...

#include <stdio.h>
#include <string.h>
#include "dbgfuncs.h"
#include "techtype.h"
#include "hbbtv.h"
#include "hbbtv_sif_os.h"
#include "hbbtv_sif_service.h"
#include "hbbtv_sif_pvr.h"
#include "object.h"
#include "debug.h"
#include "channel.h"
#include "hbbtv_string.h"
#include "queue.h"
#include "collection.h"
#include "parental_rating.h"
#include "parental_rating_scheme.h"

Typedefs

typedef struct
s_scheduled_recording 
S_SCHEDULED_RECORDING
 

Functions

void * HBBTV_SchedRecCreate (void *programme, U16BIT service_lcn, U32BIT id)
 
void * HBBTV_SchedRecCreateFromDetails (S_HBBTV_SCHEDULED_RECORDING_DETAILS *recDetails)
 Creates a ScheduledRecording object from the incoming recording details. More...
 
void * HBBTV_SchedRecCreateFromRecordingDetails (S_HBBTV_RECORDING_DETAILS *recDetails)
 Creates a Recording object (it implements the ScheduledRecording interface) from the incoming recording details. More...
 
void HBBTV_SchedRecChangeTime (void *obj, U32BIT start_time, U32BIT duration)
 Change the startTime and duration properties. HBBTV_SchedRecCreate sets them using the event information in programme, but recordAt method needs to set them independently. This function is internal to the hbbtv module. More...
 
void HBBTV_SchedRecEvent (S_QUE_RECORDING_EVENT_PARAMS *event_params)
 
void HBBTV_SchedRecRemove (void *obj, S_HBBTV_STRING *fqdn)
 Internal function used to delete a ScheduledRecording object. More...
 
S32BIT HBBTV_JSScheduledRecording_getStartPadding (void *obj)
 Integer startPadding, Section 7.10.2.2. More...
 
void HBBTV_JSScheduledRecording_setStartPadding (void *obj, S32BIT start_padding)
 Integer startPadding, Section 7.10.2.2. More...
 
S32BIT HBBTV_JSScheduledRecording_getEndPadding (void *obj)
 Integer endPadding, Section 7.10.2.2. More...
 
void HBBTV_JSScheduledRecording_setEndPadding (void *obj, S32BIT end_padding)
 Integer endPadding, Section 7.10.2.2. More...
 
void * HBBTV_JSScheduledRecording_getName (void *obj)
 String name, Section 7.10.2.2. More...
 
void HBBTV_JSScheduledRecording_setName (void *obj, S_HBBTV_STRING *name)
 String name, Section 7.10.2.2. More...
 
void * HBBTV_JSScheduledRecording_getDescription (void *obj)
 String description, Section 7.10.2.2. More...
 
void HBBTV_JSScheduledRecording_setDescription (void *obj, S_HBBTV_STRING *description)
 String description, Section 7.10.2.2. More...
 
U32BIT HBBTV_JSScheduledRecording_getStartTime (void *obj)
 readonly Integer startTime, Section 7.10.2.2 More...
 
U32BIT HBBTV_JSScheduledRecording_getDuration (void *obj)
 readonly Integer duration, Section 7.10.2.2 More...
 
HBBTV_JSScheduledRecording_STATE HBBTV_JSScheduledRecording_getState (void *obj)
 readonly Integer state, Section 7.10.2.2 More...
 
void * HBBTV_JSScheduledRecording_getParentalRatings (void *obj)
 readonly ParentalRatingCollection parentalRatings, Section 7.10.2.2 More...
 
void * HBBTV_JSScheduledRecording_getChannel (void *obj)
 readonly Channel channel, Section 7.10.2.2 More...
 
void * HBBTV_JSScheduledRecording_getId (void *obj)
 readonly String id, Section 7.10.5.1. Returns a pointer to a string object if called on a Recording object, NULL otherwise. More...
 
U32BIT HBBTV_JSScheduledRecording_getRecordingStartTime (void *obj)
 readonly Integer recordingStartTime, Section 7.10.5.1 More...
 
U32BIT HBBTV_JSScheduledRecording_getRecordingDuration (void *obj)
 readonly Integer recordingDuration, Section 7.10.5.1 More...
 

Variables

void * JS_SCHEDULED_RECORDING_CLASS = &s_vtab
 

Detailed Description

ScheduledRecording class.

Date
November 2013
Author
Sergio Panseri

Function Documentation

void* HBBTV_JSScheduledRecording_getChannel ( void *  obj)

readonly Channel channel, Section 7.10.2.2

Note
readonly Channel channel
Section 7.10.2.2
void* HBBTV_JSScheduledRecording_getDescription ( void *  obj)

String description, Section 7.10.2.2.

Note
String description
Section 7.10.2.2
U32BIT HBBTV_JSScheduledRecording_getDuration ( void *  obj)

readonly Integer duration, Section 7.10.2.2

Note
readonly Integer duration
Section 7.10.2.2
S32BIT HBBTV_JSScheduledRecording_getEndPadding ( void *  obj)

Integer endPadding, Section 7.10.2.2.

Note
Integer endPadding
Section 7.10.2.2
void* HBBTV_JSScheduledRecording_getId ( void *  obj)

readonly String id, Section 7.10.5.1. Returns a pointer to a string object if called on a Recording object, NULL otherwise.

Note
readonly String id
Section 7.10.5.1
Returns a pointer to a string object if called on a Recording object, NULL otherwise
void* HBBTV_JSScheduledRecording_getName ( void *  obj)

String name, Section 7.10.2.2.

Note
String name
Section 7.10.2.2
void* HBBTV_JSScheduledRecording_getParentalRatings ( void *  obj)

readonly ParentalRatingCollection parentalRatings, Section 7.10.2.2

Note
readonly ParentalRatingCollection parentalRatings
Section 7.10.2.2
U32BIT HBBTV_JSScheduledRecording_getRecordingDuration ( void *  obj)

readonly Integer recordingDuration, Section 7.10.5.1

Note
readonly Integer recordingDuration
Section 7.10.5.1
U32BIT HBBTV_JSScheduledRecording_getRecordingStartTime ( void *  obj)

readonly Integer recordingStartTime, Section 7.10.5.1

Note
readonly Integer recordingStartTime
Section 7.10.5.1
S32BIT HBBTV_JSScheduledRecording_getStartPadding ( void *  obj)

Integer startPadding, Section 7.10.2.2.

Note
Integer startPadding
Section 7.10.2.2
U32BIT HBBTV_JSScheduledRecording_getStartTime ( void *  obj)

readonly Integer startTime, Section 7.10.2.2

Note
readonly Integer startTime
Section 7.10.2.2
HBBTV_JSScheduledRecording_STATE HBBTV_JSScheduledRecording_getState ( void *  obj)

readonly Integer state, Section 7.10.2.2

Note
readonly Integer state
Section 7.10.2.2
void HBBTV_JSScheduledRecording_setDescription ( void *  obj,
S_HBBTV_STRING description 
)

String description, Section 7.10.2.2.

Note
String description
Section 7.10.2.2
void HBBTV_JSScheduledRecording_setEndPadding ( void *  obj,
S32BIT  end_padding 
)

Integer endPadding, Section 7.10.2.2.

Note
Integer endPadding
Section 7.10.2.2
void HBBTV_JSScheduledRecording_setName ( void *  obj,
S_HBBTV_STRING name 
)

String name, Section 7.10.2.2.

Note
String name
Section 7.10.2.2
void HBBTV_JSScheduledRecording_setStartPadding ( void *  obj,
S32BIT  start_padding 
)

Integer startPadding, Section 7.10.2.2.

Note
Integer startPadding
Section 7.10.2.2
void HBBTV_SchedRecChangeTime ( void *  obj,
U32BIT  start_time,
U32BIT  duration 
)

Change the startTime and duration properties. HBBTV_SchedRecCreate sets them using the event information in programme, but recordAt method needs to set them independently. This function is internal to the hbbtv module.

Parameters
objpointer to the ScheduledRecording object
start_timenew value for the startTime property
durationnew value for the duration property
void* HBBTV_SchedRecCreate ( void *  programme,
U16BIT  service_lcn,
U32BIT  id 
)
Parameters
programmeobject of Programme class that may contain information to initialise the created object.
service_lcnLCN of the service associated with the programme
idunique identifier of the scheduled recording
Returns
Pointer to the object
void* HBBTV_SchedRecCreateFromDetails ( S_HBBTV_SCHEDULED_RECORDING_DETAILS recDetails)

Creates a ScheduledRecording object from the incoming recording details.

Parameters
retDetailsstructure containing the details of the scheduled recording object to create
Returns
Pointer to the object
void* HBBTV_SchedRecCreateFromRecordingDetails ( S_HBBTV_RECORDING_DETAILS recDetails)

Creates a Recording object (it implements the ScheduledRecording interface) from the incoming recording details.

Parameters
retDetailsstructure containing the details of the recording object to create
Returns
Pointer to the object
void HBBTV_SchedRecRemove ( void *  obj,
S_HBBTV_STRING fqdn 
)

Internal function used to delete a ScheduledRecording object.

Parameters
objpointer to the ScheduledRecording object
fqdnpointer to an S_HBBTV_STRING containing the FQDN of the calling application