Add setApplicationMuted and setApplicationVolume methods (#228)

ecc521 · web-flow · commit e3a7b15d3dd2 · 2023-03-09T17:50:03.000+09:00
diff --git a/README.md b/README.md
@@ -254,6 +254,8 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
 
 * [`initialize(...)`](#initialize)
 * [`trackingAuthorizationStatus()`](#trackingauthorizationstatus)
+* [`setApplicationMuted(...)`](#setapplicationmuted)
+* [`setApplicationVolume(...)`](#setapplicationvolume)
 * [`showBanner(...)`](#showbanner)
 * [`hideBanner()`](#hidebanner)
 * [`resumeBanner()`](#resumebanner)
@@ -317,6 +319,36 @@ Confirm requestTrackingAuthorization status (iOS &gt;14)
 --------------------
 
 
+### setApplicationMuted(...)
+
+```typescript
+setApplicationMuted(options: ApplicationMutedOptions) => Promise<void>
+```
+
+Report application mute state to AdMob SDK
+
+| Param         | Type                                                                        |
+| ------------- | --------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#applicationmutedoptions">ApplicationMutedOptions</a></code> |
+
+--------------------
+
+
+### setApplicationVolume(...)
+
+```typescript
+setApplicationVolume(options: ApplicationVolumeOptions) => Promise<void>
+```
+
+Report application volume to AdMob SDK
+
+| Param         | Type                                                                          |
+| ------------- | ----------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#applicationvolumeoptions">ApplicationVolumeOptions</a></code> |
+
+--------------------
+
+
 ### showBanner(...)
 
 ```typescript
@@ -727,6 +759,20 @@ addListener(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) =>
 | **`status`** | <code>'authorized' \| 'denied' \| 'notDetermined' \| 'restricted'</code> |
 
 
+#### ApplicationMutedOptions
+
+| Prop        | Type                 | Description                                                                                                                                                                                                                                                                                           |
+| ----------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`muted`** | <code>boolean</code> | To inform the SDK that the app volume has been muted. Note: Video ads that are ineligible to be shown with muted audio are not returned for ad requests made, when the app volume is reported as muted or set to a value of 0. This may restrict a subset of the broader video ads pool from serving. |
+
+
+#### ApplicationVolumeOptions
+
+| Prop         | Type                                                                               | Description                                                                                                                                                                                                                          |
+| ------------ | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **`volume`** | <code>0 \| 1 \| 0.1 \| 0.2 \| 0.3 \| 0.4 \| 0.5 \| 0.6 \| 0.7 \| 0.8 \| 0.9</code> | If your app has its own volume controls (such as custom music or sound effect volumes), disclosing app volume to the Google Mobile Ads SDK allows video ads to respect app volume settings. enable set 0.0 - 1.0, any float allowed. |
+
+
 #### BannerAdOptions
 
 This interface extends <a href="#adoptions">AdOptions</a>
@@ -756,7 +802,7 @@ When notice listener of OnAdLoaded, you can get banner size.
 
 #### AdMobError
 
-For more information
+For more information
 https://developers.google.com/android/reference/com/google/android/gms/ads/AdError
 
 | Prop          | Type                | Description                            |
@@ -791,7 +837,7 @@ https://developers.google.com/android/reference/com/google/android/gms/ads/AdErr
 
 #### AdMobRewardItem
 
-For more information
+For more information
 https://developers.google.com/admob/android/rewarded-video-adapters?hl=en
 
 | Prop         | Type                | Description              |
@@ -812,9 +858,7 @@ https://developers.google.com/admob/android/rewarded-video-adapters?hl=en
 
 From T, pick a set of properties whose keys are in the union K
 
-<code>{
- [P in K]: T[P];
- }</code>
+<code>{ [P in K]: T[P]; }</code>
 
 
 ### Enums
diff --git a/android/src/main/java/com/getcapacitor/community/admob/AdMob.java b/android/src/main/java/com/getcapacitor/community/admob/AdMob.java
@@ -73,6 +73,28 @@ public void trackingAuthorizationStatus(final PluginCall call) {
         call.resolve(response);
     }
 
+    @PluginMethod
+    public void setApplicationMuted(final PluginCall call) {
+        Boolean muted = call.getBoolean("muted");
+        if (muted == null) {
+            call.reject("muted property cannot be null");
+            return;
+        }
+        MobileAds.setAppMuted(muted);
+        call.resolve();
+    }
+
+    @PluginMethod
+    public void setApplicationVolume(final PluginCall call) {
+        Float volume = call.getFloat("volume");
+        if (volume == null) {
+            call.reject("volume property cannot be null");
+            return;
+        }
+        MobileAds.setAppVolume(volume);
+        call.resolve();
+    }
+
     // Show a banner Ad
     @PluginMethod
     public void showBanner(final PluginCall call) {
diff --git a/demo/angular/src/app/app.component.ts b/demo/angular/src/app/app.component.ts
@@ -24,6 +24,14 @@ export class AppComponent {
         testingDevices: ['2077ef9a63d2b398840261c8221a0c9b'],
         initializeForTesting: true,
       });
+
+      AdMob.setApplicationMuted({
+        muted: false,
+      });
+
+      AdMob.setApplicationVolume({
+        volume: 0.5,
+      });
     });
   }
 }
diff --git a/ios/Plugin/Plugin.m b/ios/Plugin/Plugin.m
@@ -6,6 +6,8 @@
 CAP_PLUGIN(AdMob, "AdMob",
            CAP_PLUGIN_METHOD(initialize, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(trackingAuthorizationStatus, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(setApplicationMuted, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(setApplicationVolume, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(showBanner, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(resumeBanner, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(hideBanner, CAPPluginReturnPromise);
diff --git a/ios/Plugin/Plugin.swift b/ios/Plugin/Plugin.swift
@@ -48,6 +48,31 @@ public class AdMob: CAPPlugin {
             call.resolve([:])
         }
     }
+    
+    @objc func setApplicationMuted(_ call: CAPPluginCall) {
+        if let shouldMute = call.getBool("muted") {
+            GADMobileAds.sharedInstance().applicationMuted = shouldMute
+            call.resolve([:])
+        } else {
+            call.reject("muted property cannot be null");
+            return;
+        }
+    }
+    
+    @objc func setApplicationVolume(_ call: CAPPluginCall) {
+        if var volume = call.getFloat("volume") {
+            //Clamp volumes. 
+            if (volume < 0.0) {volume = 0.0}
+            else if (volume > 1.0) {volume = 1.0}
+            
+            GADMobileAds.sharedInstance().applicationVolume = volume
+
+            call.resolve([:])
+        } else {
+            call.reject("volume property cannot be null");
+            return;
+        }
+    }
 
     /**
      *  AdMob: Banner
diff --git a/src/definitions.ts b/src/definitions.ts
@@ -24,6 +24,22 @@ export interface AdMobPlugin extends AdMobDefinitions {
    * @since 3.1.0
    */
   trackingAuthorizationStatus(): Promise<TrackingAuthorizationStatusInterface>;
+
+  /**
+   * Report application mute state to AdMob SDK
+   *
+   * @see https://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/3547038-trackingauthorizationstatus
+   * @since 4.1.1
+   */
+  setApplicationMuted(options: ApplicationMutedOptions): Promise<void>;
+
+  /**
+   * Report application volume to AdMob SDK
+   *
+   * @see https://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/3547038-trackingauthorizationstatus
+   * @since 4.1.1
+   */
+  setApplicationVolume(options: ApplicationVolumeOptions): Promise<void>;
 }
 
 export interface AdMobInitializationOptions {
@@ -103,3 +119,27 @@ export enum MaxAdContentRating {
    */
   MatureAudience = 'MatureAudience',
 }
+
+export interface ApplicationMutedOptions {
+  /**
+   * To inform the SDK that the app volume has been muted.
+   * Note: Video ads that are ineligible to be shown with muted audio are not returned for ad requests made,
+   * when the app volume is reported as muted or set to a value of 0. This may restrict a subset of the broader video ads pool from serving.
+   *
+   * @see https://developers.google.com/admob/android/global-settings
+   * @since 4.1.1
+   */
+  muted?: boolean;
+}
+
+export interface ApplicationVolumeOptions {
+  /**
+   * If your app has its own volume controls (such as custom music or sound effect volumes),
+   * disclosing app volume to the Google Mobile Ads SDK allows video ads to respect app volume settings.
+   * enable set 0.0 - 1.0, any float allowed.
+   *
+   * @see https://developers.google.com/admob/android/global-settings
+   * @since 4.1.1
+   */
+  volume?: 0.0 | 0.1 | 0.2 | 0.3 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9 | 1.0;
+}
diff --git a/src/web.ts b/src/web.ts
@@ -1,6 +1,10 @@
 import { WebPlugin } from '@capacitor/core';
 
-import type { AdMobPlugin } from '.';
+import type {
+  AdMobPlugin,
+  ApplicationMutedOptions,
+  ApplicationVolumeOptions,
+} from '.';
 import type { AdMobRewardItem } from './reward';
 import type { AdOptions, AdLoadInfo } from './shared';
 import type { TrackingAuthorizationStatusInterface } from './shared/tracking-authorization-status.interface';
@@ -27,6 +31,14 @@ export class AdMobWeb extends WebPlugin implements AdMobPlugin {
     };
   }
 
+  async setApplicationMuted(options: ApplicationMutedOptions): Promise<void> {
+    console.log('setApplicationMuted', options);
+  }
+
+  async setApplicationVolume(options: ApplicationVolumeOptions): Promise<void> {
+    console.log('setApplicationVolume', options);
+  }
+
   async showBanner(options: AdOptions): Promise<void> {
     console.log('showBanner', options);
   }
