The application/oipfGatewayInfo embedded object

Support in HbbTV

Available since: Not implemented in HbbTV

Properties

readonly Boolean isIGDiscovered
Readonly property that indicates whether an IMS Gateway is discovered or not. NOTE: This property was formerly referred to as IGDiscovery.
readonly Boolean isAGDiscovered
Readonly property that indicates whether an Application Gateway is discovered or not. NOTE: This property was formerly referred to as AGDiscovery.
readonly Boolean isCSPGCIPlusDiscovered
Readonly property that indicates whether a CSPG-CI+ Gateway is discovered or not. NOTE: This property was formerly referred to as cspGatewayDiscovery. The former cspGatewayDiscovery property is now replaced with isCSPGCIPlusDiscovered for CSPG-CI+ case and isCSPGDTCPDiscovered for CSPG-DTCP case.
readonly Boolean isCSPGDTCPDiscovered
Readonly property that indicates whether a CSPG-DTCP Gateway is discovered or not. NOTE: This property was formerly referred to as cspGatewayDiscovery. The former cspGatewayDiscovery property is now replaced with isCSPGCIPlusDiscovered for CSPG-CI+ case and isCSPGDTCPDiscovered for CSPG-DTCP case.
readonly String igURL
Readonly property that indicates the base Gateway’s URL for interacting between an OITF and an IMS Gateway.
readonly String agURL
Readonly property that indicates the base Gateway’s URL for interacting between an OITF and an Application Gateway.
readonly String cspgDTCPURL
Readonly property that indicates the base Gateway’s URL for interacting between an OITF and an CSPG-DTCP Gateway. NOTE: This property was formerly referred to as cspGatewayURL which was relevant for CSPG-DTCP case only.
Integer interval
Read-write property that specifies the periodic interval time(seconds) to discover the gateways. When the interval property is set, an UPnP Discovery mechanism is executed.
function onDiscoverIG()
The function that SHALL be called when an IMS Gateway is discovered or lost by the OITF which uses a UPnP Discovery mechanism described in [OIPF_PROT2] section 10.1.1.1. The actual status of the gateway (discovered or not) can be determined by reading the isIGDiscovered property. The specified function is called with no arguments.
function onDiscoverAG()
The function that SHALL be called when an Application Gateway is discovered or lost by the OITF which uses a UPnP Discovery mechanism described in [OIPF_PROT2] section 10.1.1.2. The actual status of the gateway (discovered or not) can be determined by reading the isAGDiscovered property. The specified function is called with no arguments.
function onDiscoverCSPGDTCP()
The function that SHALL be called when an CSPG-DTCP Gateway is discovered or lost by the OITF. The CSPG-DTCP gateway SHALL be discovered using a UPnP Discovery mechanism described in [OIPF_PROT2] section 10.1.1.3. The actual status of the gateway (discovered or not) can be determined by reading the isCSPGDTCPDiscovered property. The specified function is called with no arguments. NOTE: This property was formerly referred to as onDiscoverCSPG. The former onDiscoverCSPG property is now replaced with onDiscoverCSPGCIPlus for CSPG-CI+ case and onDiscoverCSPGDTCP for CSPG-DTCP case.
readonly Boolean isIGSupported
Readonly property that indicates whether an IMS Gateway is supported or not.
readonly Boolean isAGSupported
Readonly property that indicates whether an Application Gateway is supported or not.
readonly Boolean isCSPGCIPlusSupported
Readonly property that indicates whether a CSPG-CI+ Gateway is supported or not.
readonly Boolean isCSPGDTCPSupported
Readonly property that indicates whether a CSPG-DTCP Gateway is supported or not.
function onDiscoverCSPGCIPlus()
The function that SHALL be called when a CSPG-CI+ Gateway is discovered or lost by the OITF (including any change to the DRM systems supported by that gateway). The CSPG-CI+ Gateway SHALL be discovered as defined in [OIPF_CSP2]. The actual status of the gateway (discovered or not) can be determined by reading the isCSPGCIPlusDiscovered property. The specified function is called with no arguments. NOTE: This property was formerly referred to as onDiscoverCSPG. The former onDiscoverCSPG property is now replaced with onDiscoverCSPGCIPlus for CSPG-CI+ case and onDiscoverCSPGDTCP for CSPG-DTCP case.
readonly StringCollection CSPGCIPlusDRMType
Readonly property that indicates the list of CA Systems supported by the CSPG-CI+ Gateway under the form of URN with the DVB CASystemID (16 bit number) in there. Each element of CSPGCIPlusDRMType shall be signalled by prefixing the decimal number format of CA_System_ID with “urn:dvb:casystemid:”.

Methods

Boolean isIGSupportedMethod( String methodName )

Description

Shall return true when the IG supports the method specified in the ‘methodName’ argument. If the function returns false, it indicates that IG does not support the specified method.

Arguments

methodName

The name of the method to be checked for support.

Events

For the intrinsic events listed in the table below, a corresponding DOM event SHALL be generated, in the following manner:

Intrinsic eventCorresponding DOM eventDOM Event properties
onDiscoverIGDiscoverIGBubbles: No Cancellable: No
onDiscoverAGDiscoverAGBubbles: No Cancellable: No
onDiscoverCSPGDTCPDiscoverCSPGDTCPBubbles: No Cancellable: No
onDiscoverCSPGCIPlusDiscoverCSPGCIPlusBubbles: No Cancellable: No

NOTE: the above DOM events are directly dispatched to the event target, and will not bubble nor capture. Applications SHOULD NOT rely on receiving these events during the bubbling or the capturing phase. Applications that use DOM event handlers SHALL call the addEventListener() method on the application/oipfGatewayInfo object. The third parameter of addEventListener, i.e. “useCapture”, will be ignored.