[DAI] Plugin's `addEventListener` method does not work

[alexypdu]

Description

Currently with version 2.4.0 calling player.imaDai.addEventListener() will give you an error:

Uncaught TypeError: this.sdkImpl.addEventListener is not a function

Tracing the call stack:

• videojs-ima/src/ima-plugin.js

  Line 82 in 2949f22

  this.controller.addEventListener(event, callback);

• videojs-ima/src/dai/dai-controller.js

  Line 255 in 2949f22

  this.sdkImpl.addEventListener(event, callback);

eventually you will see that the addEventListener method is not defined on class SdkImpl.

Note

This method is not documented in the DAI readme, so maybe it's still an incomplete feature. But I believe it will be easier (and more intuitive semantically) to add ad event listeners with this method than doing it manually as shown in the example:

player.on("stream-manager", (response) => {
  const streamManager = response.streamManager;
  streamManager.addEventListener(
    google.ima.dai.api.StreamEvent.Type.AD_BREAK_STARTED,
    () => {
      console.log("AD_BREAK_STARTED");
    }
  );
});

[Kiro705]

Hello @alexypdu ,

Thank you for pointing this out. Could you give an example of how you would use player.imaDai.addEventListener(). Then I can look into adding functionality to fit that use-case.

Thank you,
Jackson
IMA SDK team

[alexypdu]

Hi @Kiro705,

If player.imaDai.addEventListener() is working, people can do:

player.imaDai.addEventListener(
  google.ima.dai.api.StreamEvent.Type.AD_BREAK_STARTED,
  () => {
    console.log("AD_BREAK_STARTED");
  }
);

instead of

player.on("stream-manager", (response) => {
  const streamManager = response.streamManager;
  streamManager.addEventListener(
    google.ima.dai.api.StreamEvent.Type.AD_BREAK_STARTED,
    () => {
      console.log("AD_BREAK_STARTED");
    }
  );
});

I am actually fine with the second approach although it's more verbose. My point here is if addEventListener is defined on classes ImaDaiPlugin and DaiController then it should work. Otherwise we should just remove them.

One thing to note is that streamManager in class SdkImpl is null initially and will not be instantiated until SdkImpl.prototype.initImaDai() is called when the player is ready. So if the user calls player.imaDai.addEventListener() before the player gets ready, the plugin will need to lazily register the listeners until streamManager is actually available.

[Kiro705]

Hi @alexypdu ,

Thanks for the reply. Commit ed91f62 adds the method to dai/sdk-impl.js, so now the method in ima-plugin.js should be fully functional.

This change will go live in the next release of the plugin.

Thank you,
Jackson
IMA SDK team

[Kiro705]

Hello @alexypdu ,

This issue should not be resolved in v2.5.0 of the plugin. I'm going to close this issue, but feel free to re-open it as needed.

Thank you,
Jackson
IMA SDK team