The application/oipfParentalControlManager embedded object

Support in HbbTV

Available since: HbbTV 1.0 (ETSI TS 102 796 V1.1.1, OIPF DAE V1.1)

The parentalRatingSchemes property shall be supported. Other properties and methods are not included.

If an OITF supports parental controls as indicated by value “true” for element <parentalcontrol> (as defined by section 9.3.5) in its capability profile, the OITF SHALL support the application/oipfParentalControlManager object with the following interface.

The following example shows a possible usage scenario for the application/oipfParentalControlManager, i.e. to add a new parental rating scheme to the parentalRatingSchemes collection:

The following example shows a possible usage scenario for the application/oipfParentalControlManager, i.e. to temporarily unblock a blocked content item (e.g. after asking the user to enter the parental control pin):

Properties

readonly ParentalRatingSchemeCollection parentalRatingSchemes
A reference to the collection of rating schemes known by the OITF.
readonly Boolean isPINEntryLocked
The lockout status of the parental control PIN. If the incorrect PIN has been entered too many times in the configured timeout period, parental control PIN entry SHALL be locked out for a period of time determined by the OITF.

Methods

Integer setParentalControlStatus( String pcPIN, Boolean enable )

Description

As defined in [OIPF_CSP2], the OITF shall prevent the consumption of a programme when its parental rating doesn’t meet the parental rating criterion currently defined in the OITF. Calling this method with enable set to false will temporarily allow the consumption of any blocked programme.

Setting the parental control status using this method SHALL set the status until the consumption of any of all the blocked programmes terminates (e.g. until the content item being played is changed), or another call to the setParentalControlStatus() method is made.

Setting the parental control status using this method has the following effect; for the Programme and Channel objects as defined in sections 7.16.2 and 7.13.11, the blocked property of a programme or channel SHALL be set to true for programmes whose parental rating does not meet the applicable parental rating criterion, but the locked property SHALL be set to false.

This operation to temporarily disable parental rating control SHALL be protected by the parental control PIN (i.e. through the pcPIN argument). The return value indicates the success of the operation, and SHALL take one of the following values:

Value

Description

0

The PIN is correct.

1

The PIN is incorrect.

2

PIN entry is locked because an invalid PIN has been entered too many times. The number of invalid PIN attempts before PIN entry is locked is outside the scope of this specification.

Arguments

pcPIN

The parental control PIN.

enable

Flag indicating whether parental control should be enabled.

Boolean getParentalControlStatus()

Description

Returns a flag indicating the temporary parental control status set by setParentalControlStatus(). Note that the returned status covers parental control functionality related to all rating schemes, not only the rating scheme upon which the method is called.

Boolean getBlockUnrated()

Description

Returns a flag indicating whether or not the OITF has been configured by the user to block content for which a parental rating is absent.

Integer setParentalControlPIN( String oldPcPIN, String newPcPIN )

Description

Set the parental control PIN.

This operation SHALL be protected by the parental control PIN (if PIN entry is enabled). The return value indicates the success of the operation, and SHALL take one of the following values:

Value

Description

0

The PIN is correct.

1

The PIN is incorrect.

2

PIN entry is locked because an invalid PIN has been entered too many times. The number of invalid PIN attempts before PIN entry is locked is outside the scope of this specification.

Arguments

oldPcPIN

The current parental control PIN.

newPcPIN

The new value for the parental control PIN.

Integer unlockWithParentalControlPIN( String pcPIN, Object target )

Description

Unlock the object specified by target for viewing if pcPIN contains the correct parental control PIN.

The object type of target can be one of the following:

· video/broadcast object, in which case the content being presented through this object SHALL be unlocked until a new channel is selected.

· A/V Control object, in which case the content being presented through this object SHALL be unlocked until a new item of content is played using this object

Otherwise an Invalid Object error SHALL be returned.

The return value indicates the success of the operation, and SHALL take the following values:

Value

Description

0

The PIN is correct.

1

The PIN is incorrect.

2

PIN entry is locked because an invalid PIN has been entered too many times. The number of invalid PIN attempts before PIN entry is locked is outside the scope of this specification.

3

Invalid object.

Arguments

pcPIN

The parental control PIN.

target

The object to be unlocked..

Integer verifyParentalControlPIN( String pcPIN )

Description

Verify that the PIN specified by pcPIN is the correct parental control PIN.

This method will return one of the following values:

Value

Description

0

The PIN is correct.

1

The PIN is incorrect.

2

PIN entry is locked because an invalid PIN has been entered too many times. The number of invalid PIN attempts before PIN entry is locked is outside the scope of this specification.

Arguments

pcPIN

The parental control PIN to be verified.

Integer setBlockUnrated( String pcPIN, Boolean block )

Description

Set whether programmes for which no parental rating has been retrieved from the metadata client nor defined by the service provider should be blocked automatically by the terminal.

This operation SHALL be protected by the parental control PIN (if PIN entry is enabled). The return value indicates the success of the operation, and SHALL take one of the following values:

Value

Description

0

The PIN is correct.

1

The PIN is incorrect.

2

PIN entry is locked because an invalid PIN has been entered too many times. The number of invalid PIN attempts before PIN entry is locked is outside the scope of this specification.

Arguments

pcPIN

The parental control PIN.

block

Flag indicating whether programmes SHALL be blocked.