Extensions to application/oipfCommunicationServices for video telephony services

Support in HbbTV

Available since: Not implemented in HbbTV

If an OITF has indicated support for full-duplex Video Telephony Services functionality by a server by stating <telephony_services video=”true”>true</telephony_services> as defined in section 9.3.9 in its capability description, the OITF SHALL support communication services through the use of the following non-visual embedded object:

<object type=”application/oipfCommunicationServices”/>

The extensions for telephony services provide support for:

  • Parameters and values related to video (identified by (*) in previous sections).
  • Methods to manage the rendering of local and remote video streams through CEA-2014 A/V Control or HTML5 video element.
  • Methods to send a session update request and to accept or refuse it. A session update is typically invoked when users want to add video to their currently ongoing voice-only call session.

When a remote or local video is activated on a target CEA-2014 A/V Control or HTML5 video element, any currently displayed video content on that object is stopped and released. The activated stream is automatically played.

The full-duplex Video Telephony Services API MAY be supported in the combined OITF and IG deployment cases as well as the separated OITF and IG case. It MAY be supported in other deployment cases. The use of the HNI-IGI interface is OPTIONAL between the OITF and IG when these are co-deployed.

Methods

Boolean showRemoteVideo( Integer cid, Integer mode, String idVideoCallObject )

Description

Activates or deactivates remote peer video rendering. Returns true if the method is successfully executed; false if an error occurred. This method can be invoked as soon as a valid call id is available: after a call method invocation or when an incoming call is notified.

Arguments

cid

Call session identifier for the application (Call ID).

mode

Valid values are shown in the table below.

Value

Description

0

Deactivates remote video

1

Activates remote video

idVideoCallObject

ID attribute associated with the HTML tag of the A/V Control object as defined in section 7.14 or HTML5 video element in which the video frames will be rendered

Boolean showLocalVideoPreview( Integer cid, Integer mode, String idVideoCallObject )

Description

Activates or deactivates local video preview. This method can be invoked before a call session creation or during an ongoing call session. If cid parameter is defined, then the local video stream will be one currently used in the call session identified by this Call ID. If cid parameter is null then the local video stream will be the one that will be used in the next call session that will be created (outgoing or incoming call). Returns true if the method is successfully executed; false if an error occurred. This method can be invoked before or after the call session setup

Arguments

cid

Call session identifier for the application (Call ID).

mode

Valid values are shown in the table below.

Value

Description

0

Deactivates local video preview

1

Activates local video preview

idVideoCallObject

ID attribute associated with the HTML tag of the A/V Control object as defined in section 7.14 or HTML5 video element in which the video frames will be rendered

Boolean callUpdate( Integer cid, Integer callType )

Description

Requests an update for the call session identified by the cid parameter. Returns true if the method is successfully executed; false if an error occurred.

Arguments

cid

Call session identifier for the application (Call ID).

callType

Valid values are shown in the table below.

Value

Description

0

AUDIO_ONLY: activate a full-duplex voice only call

1

VIDEO_ONLY: activate a video only call

2

AUDIO_VIDEO: activate a full-duplex video call (voice + video)

Boolean callAnswerUpdate( Integer cid, Integer responseUpdate )

Description

Answers an incoming call. Returns true if the method is successfully executed; false if an error occurred. Note that if an OITF supports full-duplex voice only calls, then the underlying signalling layer SHALL automatically refuse any update request to video. Requests an update for the call session identified by the cid parameter.

Arguments

cid

Call session identifier for the application (Call ID).

responseUpdate

Valid values are shown in the table below.

Value

Description

0

UPDATE_ACCEPT: Accepts the update request

1

UPDATE_REFUSE: Refuses the update request

2

UPDATE_TIMEOUT: Refuses the update request due to no answer from user