[interactive_media_ads] Adds support for time offsets of ad breaks (#9953)

Fixes flutter/flutter#174405

## Pre-Review Checklist

**Note**: The Flutter team is currently trialing the use of [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from the `gemini-code-assist` bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

[^1]: Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling.

Author: bparrishMines

packages/interactive_media_ads/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.2.7
+
+* Adds support to retrieve content time offsets at which ad breaks are scheduled. See
+  `AdsManager.adCuePoints`
+
 ## 0.2.6+7
 
 * Updates Android `PlatformAdDisplayContainer` implementation to support preloading ads.

packages/interactive_media_ads/android/src/main/kotlin/dev/flutter/packages/interactive_media_ads/AdsManagerProxyApi.kt

@@ -26,7 +26,7 @@ class AdsManagerProxyApi(override val pigeonRegistrar: ProxyApiRegistrar) :
     pigeon_instance.start()
   }
 
-  override fun getAdCuePoints(pigeon_instance: AdsManager): List<Double> {
+  override fun adCuePoints(pigeon_instance: AdsManager): List<Double> {
     return pigeon_instance.adCuePoints.map { it.toDouble() }
   }
 

packages/interactive_media_ads/android/src/main/kotlin/dev/flutter/packages/interactive_media_ads/AdsRequestProxyApi.kt

@@ -21,7 +21,7 @@ class AdsRequestProxyApi(override val pigeonRegistrar: ProxyApiRegistrar) :
      *
      * This must match the version in pubspec.yaml.
      */
-    const val pluginVersion = "0.2.6+7"
+    const val pluginVersion = "0.2.7"
   }
 
   override fun setAdTagUrl(pigeon_instance: AdsRequest, adTagUrl: String) {

packages/interactive_media_ads/android/src/main/kotlin/dev/flutter/packages/interactive_media_ads/InteractiveMediaAdsLibrary.g.kt

@@ -2074,6 +2074,15 @@ abstract class PigeonApiContentProgressProvider(
 abstract class PigeonApiAdsManager(
     open val pigeonRegistrar: InteractiveMediaAdsLibraryPigeonProxyApiRegistrar
 ) {
+  /**
+   * List of content time offsets in seconds at which ad breaks are scheduled.
+   *
+   * The list will be empty if no ad breaks are scheduled.
+   */
+  abstract fun adCuePoints(
+      pigeon_instance: com.google.ads.interactivemedia.v3.api.AdsManager
+  ): List<Double>
+
   /** Discards current ad break and resumes content. */
   abstract fun discardAdBreak(pigeon_instance: com.google.ads.interactivemedia.v3.api.AdsManager)
 
@@ -2083,15 +2092,6 @@ abstract class PigeonApiAdsManager(
   /** Starts playing the ads. */
   abstract fun start(pigeon_instance: com.google.ads.interactivemedia.v3.api.AdsManager)
 
-  /**
-   * List of content time offsets in seconds at which ad breaks are scheduled.
-   *
-   * The list will be empty if no ad breaks are scheduled.
-   */
-  abstract fun getAdCuePoints(
-      pigeon_instance: com.google.ads.interactivemedia.v3.api.AdsManager
-  ): List<Double>
-
   /** Resumes the current ad. */
   abstract fun resume(pigeon_instance: com.google.ads.interactivemedia.v3.api.AdsManager)
 
@@ -2171,28 +2171,6 @@ abstract class PigeonApiAdsManager(
           channel.setMessageHandler(null)
         }
       }
-      run {
-        val channel =
-            BasicMessageChannel<Any?>(
-                binaryMessenger,
-                "dev.flutter.pigeon.interactive_media_ads.AdsManager.getAdCuePoints",
-                codec)
-        if (api != null) {
-          channel.setMessageHandler { message, reply ->
-            val args = message as List<Any?>
-            val pigeon_instanceArg = args[0] as com.google.ads.interactivemedia.v3.api.AdsManager
-            val wrapped: List<Any?> =
-                try {
-                  listOf(api.getAdCuePoints(pigeon_instanceArg))
-                } catch (exception: Throwable) {
-                  InteractiveMediaAdsLibraryPigeonUtils.wrapError(exception)
-                }
-            reply.reply(wrapped)
-          }
-        } else {
-          channel.setMessageHandler(null)
-        }
-      }
       run {
         val channel =
             BasicMessageChannel<Any?>(
@@ -2255,11 +2233,12 @@ abstract class PigeonApiAdsManager(
     } else {
       val pigeon_identifierArg =
           pigeonRegistrar.instanceManager.addHostCreatedInstance(pigeon_instanceArg)
+      val adCuePointsArg = adCuePoints(pigeon_instanceArg)
       val binaryMessenger = pigeonRegistrar.binaryMessenger
       val codec = pigeonRegistrar.codec
       val channelName = "dev.flutter.pigeon.interactive_media_ads.AdsManager.pigeon_newInstance"
       val channel = BasicMessageChannel<Any?>(binaryMessenger, channelName, codec)
-      channel.send(listOf(pigeon_identifierArg)) {
+      channel.send(listOf(pigeon_identifierArg, adCuePointsArg)) {
         if (it is List<*>) {
           if (it.size > 1) {
             callback(

packages/interactive_media_ads/android/src/test/kotlin/dev/flutter/packages/interactive_media_ads/AdsManagerProxyApiTest.kt

@@ -43,14 +43,14 @@ class AdsManagerProxyApiTest {
   }
 
   @Test
-  fun getAdCuePoints() {
+  fun adCuePoints() {
     val api = TestProxyApiRegistrar().getPigeonApiAdsManager()
 
     val instance = mock<AdsManager>()
     val value = listOf(1.0)
     whenever(instance.adCuePoints).thenReturn(listOf(1.0f))
 
-    assertEquals(value, api.getAdCuePoints(instance))
+    assertEquals(value, api.adCuePoints(instance))
   }
 
   @Test

packages/interactive_media_ads/example/ios/RunnerTests/AdsManagerTests.swift

@@ -101,6 +101,17 @@ final class AdsManagerTests: XCTestCase {
 
     XCTAssertTrue(instance.destroyCalled)
   }
+
+  func testAdCuePoints() {
+    let registrar = TestProxyApiRegistrar()
+    let api = registrar.apiDelegate.pigeonApiIMAAdsManager(registrar)
+
+    let instance = TestAdsManager.customInit()
+
+    let value = try? api.pigeonDelegate.adCuePoints(pigeonApi: api, pigeonInstance: instance)
+
+    XCTAssertEqual(value, [2.2, 3.3])
+  }
 }
 
 class TestAdsManager: IMAAdsManager {
@@ -146,4 +157,8 @@ class TestAdsManager: IMAAdsManager {
   override func destroy() {
     destroyCalled = true
   }
+
+  override var adCuePoints: [Any] {
+    return [2.2, 3.3]
+  }
 }

packages/interactive_media_ads/example/lib/video_ad_example_screen.dart

@@ -70,6 +70,7 @@ class _VideoAdExampleScreenState extends State<VideoAdExampleScreen>
       _adsLoader = AdsLoader(
         container: container,
         onAdsLoaded: (OnAdsLoadedData data) {
+          debugPrint('OnAdsLoaded: (cuePoints: ${data.manager.adCuePoints})');
           final AdsManager manager = data.manager;
           _adsManager = data.manager;
 

packages/interactive_media_ads/ios/interactive_media_ads/Sources/interactive_media_ads/AdsManagerProxyAPIDelegate.swift

@@ -47,4 +47,12 @@ class AdsManagerProxyAPIDelegate: PigeonApiDelegateIMAAdsManager {
   func destroy(pigeonApi: PigeonApiIMAAdsManager, pigeonInstance: IMAAdsManager) throws {
     pigeonInstance.destroy()
   }
+
+  func adCuePoints(pigeonApi: PigeonApiIMAAdsManager, pigeonInstance: IMAAdsManager) throws
+    -> [Double]
+  {
+    return pigeonInstance.adCuePoints.map { cuePoint -> Double in
+      return (cuePoint as! NSNumber).doubleValue
+    }
+  }
 }

packages/interactive_media_ads/ios/interactive_media_ads/Sources/interactive_media_ads/AdsRequestProxyAPIDelegate.swift

@@ -13,7 +13,7 @@ class AdsRequestProxyAPIDelegate: PigeonApiDelegateIMAAdsRequest {
   /// The current version of the `interactive_media_ads` plugin.
   ///
   /// This must match the version in pubspec.yaml.
-  static let pluginVersion = "0.2.6+7"
+  static let pluginVersion = "0.2.7"
 
   func pigeonDefaultConstructor(
     pigeonApi: PigeonApiIMAAdsRequest, adTagUrl: String, adDisplayContainer: IMAAdDisplayContainer,

packages/interactive_media_ads/ios/interactive_media_ads/Sources/interactive_media_ads/InteractiveMediaAdsLibrary.g.swift

@@ -3157,6 +3157,12 @@ final class PigeonApiIMAAdError: PigeonApiProtocolIMAAdError {
   }
 }
 protocol PigeonApiDelegateIMAAdsManager {
+  /// List of content time offsets at which ad breaks are scheduled.
+  ///
+  /// List of double values in seconds. Empty list for single ads or if no ad
+  /// breaks are scheduled.
+  func adCuePoints(pigeonApi: PigeonApiIMAAdsManager, pigeonInstance: IMAAdsManager) throws
+    -> [Double]
   /// The `IMAAdsManagerDelegate` to notify with events during ad playback.
   func setDelegate(
     pigeonApi: PigeonApiIMAAdsManager, pigeonInstance: IMAAdsManager,
@@ -3365,13 +3371,15 @@ final class PigeonApiIMAAdsManager: PigeonApiProtocolIMAAdsManager {
     } else {
       let pigeonIdentifierArg = pigeonRegistrar.instanceManager.addHostCreatedInstance(
         pigeonInstance as AnyObject)
+      let adCuePointsArg = try! pigeonDelegate.adCuePoints(
+        pigeonApi: self, pigeonInstance: pigeonInstance)
       let binaryMessenger = pigeonRegistrar.binaryMessenger
       let codec = pigeonRegistrar.codec
       let channelName: String =
         "dev.flutter.pigeon.interactive_media_ads.IMAAdsManager.pigeon_newInstance"
       let channel = FlutterBasicMessageChannel(
         name: channelName, binaryMessenger: binaryMessenger, codec: codec)
-      channel.sendMessage([pigeonIdentifierArg] as [Any?]) { response in
+      channel.sendMessage([pigeonIdentifierArg, adCuePointsArg] as [Any?]) { response in
         guard let listResponse = response as? [Any?] else {
           completion(.failure(createConnectionError(withChannelName: channelName)))
           return