Feature Overlay events

[sebastianpiq]

This PR implements Overlays

Summary

This PR implements Overlay functionality, enabling the management and rendering of Overlay events within the player. The following changes were introduced:

• Added parsing logic for events to retrieve and interpret Overlay events.
• Extended the event controller to recognize and handle Overlay events.
• Implemented a new method attachOverlayRenderingDiv to assign a dedicated div element for rendering overlays.
• Created an OverlayController to manage Overlay events:
  • Differentiates between the various overlay event types: start, stop, and extend.
  • Includes a scheduler to manage the lifecycle of overlays, including starting, stopping, and extending them.
  • Applies styles dynamically to the overlay rendering div, video element, and parent element based on the following parameters:
    • ViewPort
    • Size
    • TopLeft
    • SqueezeCurrent

Assumptions

• Overlay events are triggered only once. Once an overlay is displayed, it will not reappear.
• Positioning elements at the same level as the video element and the overlay rendering div may lead to unexpected behavior.

Unit Tests

The following unit tests were added to ensure proper functionality:

configureVideoElementForOverlay

• Test Case 1: Applies the correct style properties to the video element.
• Test Case 2: Applies the correct style properties to the parent element.

setupOverlayEvents

• Test Case 1: Executes without throwing errors.
• Test Case 2: Handles triggering an empty event without errors.
• Test Case 3: Handles start mode events with video mimetype without errors.
• Test Case 4: Handles start mode events with iframe mimetype without errors.
• Test Case 5: Handles extend mode events, ensuring the correct overlay is updated.
• Test Case 6: Handles stop mode events, ensuring overlays are removed as expected.
  Each test validates that the system processes the corresponding overlay event type correctly without exceptions or unexpected behavior. Example for extend mode:

eventBus.trigger(Constants.OVERLAY.SCHEME_ID, { event: {
    overlay: { mode: Constants.OVERLAY.START_MODE, mimeType: Constants.OVERLAY.VIDEO_MIMETYPE },
    duration: 5, presentationTime: 3000, id: '1234'
}});
eventBus.trigger(Constants.OVERLAY.SCHEME_ID, { event: {
    overlay: { mode: Constants.OVERLAY.EXTEND_MODE, refId: '1234' },
    duration: 10, presentationTime: 4000
}});

Test cases

Assets used to test the different cases:

• Case 0 (Basic video overlay): https://comcast-dash-6-assets.s3.us-east-2.amazonaws.com/Overlay/case8-b/case0.mpd
• Case 1 (Basic iframe overlay): https://comcast-dash-6-assets.s3.us-east-2.amazonaws.com/Overlay/case8-b/case1.mpd
• Case 2 (Preloading overlay): https://comcast-dash-6-assets.s3.us-east-2.amazonaws.com/Overlay/case8-b/case2.mpd
• Case 3 (L-shaped ADs): https://comcast-dash-6-assets.s3.us-east-2.amazonaws.com/Overlay/case8-b/case3.mpd
• Case 4 (Looped video overlay): https://comcast-dash-6-assets.s3.us-east-2.amazonaws.com/Overlay/case8-b/case4.mpd
• Case 5 (Logo insertion): https://comcast-dash-6-assets.s3.us-east-2.amazonaws.com/Overlay/case8-b/case5.mpd
• Case 6 (Extending overlay duration): https://comcast-dash-6-assets.s3.us-east-2.amazonaws.com/Overlay/case8-b/case6.mpd
• Case 7 (Seeking past an overlay stop/extend event): https://comcast-dash-6-assets.s3.us-east-2.amazonaws.com/Overlay/case8-b/case7.mpd