ExoPlayer IMA एक्सटेंशन का इस्तेमाल शुरू करना

ExoPlayer, Android मीडिया प्लेयर है. इस गाइड में, ExoPlayer IMA एक्सटेंशन का इस्तेमाल करने का तरीका बताया गया है. यह एक्सटेंशन, IMA DAI SDK का इस्तेमाल करके, विज्ञापन और कॉन्टेंट, दोनों के साथ मीडिया स्ट्रीम का अनुरोध करता है और उन्हें चलाता है.

एक्सटेंशन के फ़ायदे यहां दिए गए हैं:

  • इससे IMA की सुविधाओं को इंटिग्रेट करने के लिए ज़रूरी कोड को आसान बनाया जा सकता है.
  • इससे IMA के नए वर्शन पर अपडेट करने में लगने वाला समय कम हो जाता है.

ExoPlayer IMA एक्सटेंशन, एचएलएस और डैश स्ट्रीमिंग प्रोटोकॉल के साथ काम करता है. यहां इसकी खास जानकारी दी गई है:

ExoPlayer-IMA एक्सटेंशन में स्ट्रीम करने की सुविधा
लाइवस्ट्रीम वीओडी स्ट्रीम
एचएलएस चेकमार्क चेकमार्क
DASH चेकमार्क चेकमार्क

ExoPlayer-IMA का वर्शन 1.1.0 और इसके बाद के वर्शन, DASH लाइव स्ट्रीम के साथ काम करते हैं.

इस गाइड में, ExoPlayer गाइड का इस्तेमाल किया गया है. इससे आपको पूरा ऐप्लिकेशन बनाने और एक्सटेंशन को इंटिग्रेट करने में मदद मिलेगी. पूरे सैंपल ऐप्लिकेशन के लिए, ExoPlayerExample on GitHub देखें.

ज़रूरी शर्तें

नया Android Studio प्रोजेक्ट बनाना

Android Studio प्रोजेक्ट बनाने के लिए, यह तरीका अपनाएं:

  1. Android Studio शुरू करें.
  2. नया Android Studio प्रोजेक्ट शुरू करें को चुनें.
  3. अपना प्रोजेक्ट चुनें पेज पर, कोई गतिविधि नहीं टेंप्लेट चुनें.
  4. आगे बढ़ें पर क्लिक करें.
  5. अपने प्रोजेक्ट को कॉन्फ़िगर करें पेज पर, अपने प्रोजेक्ट का नाम डालें और भाषा के तौर पर Java को चुनें. ध्यान दें: IMA डीएआई एसडीके, Kotlin के साथ काम करता है. हालांकि, इस गाइड में Java के उदाहरणों का इस्तेमाल किया गया है.
  • पूरा करें पर क्लिक करें.

अपने प्रोजेक्ट में ExoPlayer IMA एक्सटेंशन जोड़ना

ExoPlayer IMA एक्सटेंशन जोड़ने के लिए, यह तरीका अपनाएं:

  1. अपने ऐप्लिकेशन की build.gradle फ़ाइल के dependencies सेक्शन में, ये इंपोर्ट शामिल करें:

    dependencies {
        def media3_version = "1.8.0"
        implementation(platform("org.jetbrains.kotlin:kotlin-bom:1.8.0"))
        implementation 'androidx.appcompat:appcompat:1.7.1'
        implementation "androidx.media3:media3-ui:$media3_version"
        implementation "androidx.media3:media3-exoplayer:$media3_version"
        implementation "androidx.media3:media3-exoplayer-hls:$media3_version"
        implementation "androidx.media3:media3-exoplayer-dash:$media3_version"
    
        // The library adds the IMA ExoPlayer integration for ads.
        implementation "androidx.media3:media3-exoplayer-ima:$media3_version"
    }
    
  2. उपयोगकर्ता की वे अनुमतियां जोड़ें जिनकी ज़रूरत IMA DAI SDK को विज्ञापन का अनुरोध करने के लिए होती है:

    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
    

ExoPlayer का यूज़र इंटरफ़ेस (यूआई) सेट अप करना

ExoPlayer यूज़र इंटरफ़ेस (यूआई) सेट अप करने के लिए, यह तरीका अपनाएं:

  1. ExoPlayer के लिए PlayerView ऑब्जेक्ट बनाएं.

  2. ExoPlayer IMA एक्सटेंशन के सुझाव के मुताबिक, androidx.constraintlayout.widget.ConstraintLayout व्यू को LinearLayout व्यू में बदलें:

    <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:tools="http://schemas.android.com/tools"
        android:id="@+id/container"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical"
        tools:context=".MyActivity"
        tools:ignore="MergeRootFrame">
    
        <androidx.media3.ui.PlayerView
            android:id="@+id/player_view"
            android:fitsSystemWindows="true"
            android:layout_width="match_parent"
            android:layout_height="wrap_content" />
    
        <!-- UI element for viewing SDK event log -->
        <TextView
            android:id="@+id/logText"
            android:gravity="bottom"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:maxLines="100"
            android:scrollbars="vertical"
            android:textSize="@dimen/font_size">
        </TextView>
    
    </LinearLayout>
    
    

स्ट्रीम पैरामीटर जोड़ना

अपने प्रोजेक्ट को टेस्ट करने के लिए, सैंपल स्ट्रीम ऐसेट के लिए IMA सैंपल स्ट्रीम पेज देखें. अपनी स्ट्रीम सेट अप करने के लिए, DAI पर Ad Manager सेक्शन देखें.

इस चरण से लाइव स्ट्रीम सेट अप हो जाती है. ExoPlayer IMA एक्सटेंशन, डीएआई वीओडी स्ट्रीम के साथ भी काम करता है. वीओडी स्ट्रीम के लिए, आपके ऐप्लिकेशन में कौनसे बदलाव ज़रूरी हैं, यह जानने के लिए वीडियो ऑन डिमांड (वीओडी) स्ट्रीम के लिए दिया गया तरीका देखें.

ExoPlayer IMA एक्सटेंशन इंपोर्ट करें

  1. ExoPlayer एक्सटेंशन के लिए, ये इंपोर्ट स्टेटमेंट जोड़ें:

    import static androidx.media3.common.C.CONTENT_TYPE_HLS;
    
    import android.annotation.SuppressLint;
    import android.app.Activity;
    import android.net.Uri;
    import android.os.Bundle;
    import android.text.method.ScrollingMovementMethod;
    import android.util.Log;
    import android.widget.TextView;
    import androidx.media3.common.MediaItem;
    import androidx.media3.common.util.Util;
    import androidx.media3.datasource.DataSource;
    import androidx.media3.datasource.DefaultDataSource;
    import androidx.media3.exoplayer.ExoPlayer;
    import androidx.media3.exoplayer.ima.ImaServerSideAdInsertionMediaSource;
    import androidx.media3.exoplayer.ima.ImaServerSideAdInsertionUriBuilder;
    import androidx.media3.exoplayer.source.DefaultMediaSourceFactory;
    import androidx.media3.ui.PlayerView;
    import com.google.ads.interactivemedia.v3.api.AdEvent;
    import com.google.ads.interactivemedia.v3.api.ImaSdkFactory;
    import com.google.ads.interactivemedia.v3.api.ImaSdkSettings;
    import java.util.HashMap;
    import java.util.Map;
    
    
  2. MyActivity.java में, ये निजी वैरिएबल जोड़ें:

    Big Buck Bunny (लाइव) एचएलएस स्ट्रीम के साथ जांच करने के लिए, उसका ऐसेट कुंजी जोड़ें. आपको टेस्ट करने के लिए और स्ट्रीम मिल सकती हैं. इसके लिए, IMA के सैंपल स्ट्रीम पेज पर जाएं.

  3. KEY_ADS_LOADER_STATE की स्थिति को सेव करने और वापस पाने के लिए, KEY_ADS_LOADER_STATE कॉन्स्टेंट बनाएं:AdsLoader

    /** Main Activity. */
    @SuppressLint("UnsafeOptInUsageError")
    /* @SuppressLint is needed for new media3 APIs. */
    public class MyActivity extends Activity {
    
      private static final String KEY_ADS_LOADER_STATE = "ads_loader_state";
      private static final String SAMPLE_ASSET_KEY = "c-rArva4ShKVIAkNfy6HUQ";
      private static final String LOG_TAG = "ImaExoPlayerExample";
    
      private PlayerView playerView;
      private TextView logText;
      private ExoPlayer player;
      private ImaServerSideAdInsertionMediaSource.AdsLoader adsLoader;
      private ImaServerSideAdInsertionMediaSource.AdsLoader.State adsLoaderState;
      private ImaSdkSettings imaSdkSettings;
    
    

adsLoader इंस्टेंस बनाना

onCreate तरीके को बदलें. इसमें PlayerView ढूंढें और देखें कि कोई AdsLoader.State सेव किया गया है या नहीं. adsLoader ऑब्जेक्ट को शुरू करते समय, इस स्थिति का इस्तेमाल किया जा सकता है.

@Override
protected void onCreate(Bundle savedInstanceState) {
  super.onCreate(savedInstanceState);
  setContentView(R.layout.activity_my);

  // Initialize the IMA SDK as early as possible when the app starts. If your app already
  // overrides Application.onCreate(), call this method inside the onCreate() method.
  // https://developer.android.com/topic/performance/vitals/launch-time#app-creation
  ImaSdkFactory.getInstance().initialize(this, getImaSdkSettings());

  playerView = findViewById(R.id.player_view);

  // Checks if there is a saved AdsLoader state to be used later when initiating the AdsLoader.
  if (savedInstanceState != null) {
    Bundle adsLoaderStateBundle = savedInstanceState.getBundle(KEY_ADS_LOADER_STATE);
    if (adsLoaderStateBundle != null) {
      adsLoaderState =
          ImaServerSideAdInsertionMediaSource.AdsLoader.State.fromBundle(adsLoaderStateBundle);
    }
  }
}

private ImaSdkSettings getImaSdkSettings() {
  if (imaSdkSettings == null) {
    imaSdkSettings = ImaSdkFactory.getInstance().createImaSdkSettings();
    // Set any IMA SDK settings here.
  }
  return imaSdkSettings;
}

प्लेयर को शुरू करने के तरीके जोड़ना

प्लेयर को शुरू करने का तरीका जोड़ें. इस तरीके से ये काम होने चाहिए:

  • AdsLoader इंस्टेंस बनाएं.
  • ExoPlayer बनाएं.
  • लाइव स्ट्रीम की ऐसेट कुंजी का इस्तेमाल करके, MediaItem बनाएं.
  • अपने प्लेयर के लिए MediaItem सेट करें.
// Create a server side ad insertion (SSAI) AdsLoader.
private ImaServerSideAdInsertionMediaSource.AdsLoader createAdsLoader() {
  ImaServerSideAdInsertionMediaSource.AdsLoader.Builder adsLoaderBuilder =
      new ImaServerSideAdInsertionMediaSource.AdsLoader.Builder(this, playerView);

  // Attempts to set the AdsLoader state if available from a previous session.
  if (adsLoaderState != null) {
    adsLoaderBuilder.setAdsLoaderState(adsLoaderState);
  }

  return adsLoaderBuilder
      .setAdEventListener(buildAdEventListener())
      .setImaSdkSettings(getImaSdkSettings())
      .build();
}

private void initializePlayer() {
  adsLoader = createAdsLoader();

  // Set up the factory for media sources, passing the ads loader.
  DataSource.Factory dataSourceFactory = new DefaultDataSource.Factory(this);

  DefaultMediaSourceFactory mediaSourceFactory = new DefaultMediaSourceFactory(dataSourceFactory);

  // MediaSource.Factory to create the ad sources for the current player.
  ImaServerSideAdInsertionMediaSource.Factory adsMediaSourceFactory =
      new ImaServerSideAdInsertionMediaSource.Factory(adsLoader, mediaSourceFactory);

  // 'mediaSourceFactory' is an ExoPlayer component for the DefaultMediaSourceFactory.
  // 'adsMediaSourceFactory' is an ExoPlayer component for a MediaSource factory for IMA server
  // side inserted ad streams.
  mediaSourceFactory.setServerSideAdInsertionMediaSourceFactory(adsMediaSourceFactory);

  // Create a SimpleExoPlayer and set it as the player for content and ads.
  player = new ExoPlayer.Builder(this).setMediaSourceFactory(mediaSourceFactory).build();
  playerView.setPlayer(player);
  adsLoader.setPlayer(player);

  // Create the MediaItem to play, specifying the stream URI.
  Uri ssaiUri = buildLiveStreamUri(SAMPLE_ASSET_KEY, CONTENT_TYPE_HLS);
  MediaItem ssaiMediaItem = MediaItem.fromUri(ssaiUri);

  // Prepare the content and ad to be played with the ExoPlayer.
  player.setMediaItem(ssaiMediaItem);
  player.prepare();

  // Set PlayWhenReady. If true, content and ads will autoplay.
  player.setPlayWhenReady(false);
}

/**
 * Builds an IMA SSAI live stream URI for the given asset key and format.
 *
 * @param assetKey The asset key of the live stream.
 * @param format The format of the live stream request, either {@code CONTENT_TYPE_HLS} or {@code
 *     CONTENT_TYPE_DASH}.
 * @return The URI of the live stream.
 */
public Uri buildLiveStreamUri(String assetKey, int format) {
  Map<String, String> adTagParams = new HashMap<String, String>();
  // Update the adTagParams map with any parameters.
  // For more information, see https://support.google.com/admanager/answer/7320899

  return new ImaServerSideAdInsertionUriBuilder()
      .setAssetKey(assetKey)
      .setFormat(format)
      .setAdTagParameters(adTagParams)
      .build();
}

खिलाड़ी को रिलीज़ करने का तरीका जोड़ें

प्लेयर को रिलीज़ करने का तरीका जोड़ें. इस तरीके से, क्रम से ये कार्रवाइयां होनी चाहिए:

  • खिलाड़ी के रेफ़रंस को शून्य पर सेट करें और खिलाड़ी के संसाधनों को रिलीज़ करें.
  • adsLoader को छोड़ें.
private void releasePlayer() {
  // Set the player references to null and release the player's resources.
  playerView.setPlayer(null);
  player.release();
  player = null;

  // Release the adsLoader state so that it can be initiated again.
  adsLoaderState = adsLoader.release();
}

खिलाड़ी से जुड़े इवेंट मैनेज करना

खिलाड़ी के इवेंट मैनेज करने के लिए, स्ट्रीम चलाने की सुविधा को मैनेज करने के लिए, ऐक्टिविटी के लाइफ़साइकल इवेंट के लिए कॉलबैक बनाएं.

Android API लेवल 24 और इसके बाद के वर्शन के लिए, इन तरीकों का इस्तेमाल करें:

Android के एपीआई लेवल 24 से पहले के वर्शन के लिए, इन तरीकों का इस्तेमाल करें:

onStart() और onResume() तरीके, playerView.onResume() पर मैप करते हैं. वहीं, onStop() और onPause(), playerView.onPause() पर मैप करते हैं.

इस चरण में, adsLoaderState को सेव करने के लिए onSaveInstanceState() इवेंट का भी इस्तेमाल किया जाता है.

@Override
public void onStart() {
  super.onStart();
  if (Util.SDK_INT > 23) {
    initializePlayer();
    if (playerView != null) {
      playerView.onResume();
    }
  }
}

@Override
public void onResume() {
  super.onResume();
  if (Util.SDK_INT <= 23 || player == null) {
    initializePlayer();
    if (playerView != null) {
      playerView.onResume();
    }
  }
}

@Override
public void onPause() {
  super.onPause();
  if (Util.SDK_INT <= 23) {
    if (playerView != null) {
      playerView.onPause();
    }
    releasePlayer();
  }
}

@Override
public void onStop() {
  super.onStop();
  if (Util.SDK_INT > 23) {
    if (playerView != null) {
      playerView.onPause();
    }
    releasePlayer();
  }
}

@Override
public void onSaveInstanceState(Bundle outState) {
  // Attempts to save the AdsLoader state to handle app backgrounding.
  if (adsLoaderState != null) {
    outState.putBundle(KEY_ADS_LOADER_STATE, adsLoaderState.toBundle());
  }
}

वीओडी स्ट्रीम सेटअप करना (ज़रूरी नहीं)

अगर आपके ऐप्लिकेशन को विज्ञापनों के साथ वीओडी कॉन्टेंट चलाना है, तो यह तरीका अपनाएं:

  1. वीओडी स्ट्रीम के लिए CMS ID और Video ID जोड़ें. जांच के लिए, इन स्ट्रीम पैरामीटर का इस्तेमाल करें:
    • सीएमएस आईडी: "2548831"
    • वीडियो आईडी: "tears-of-steel"
  2. ImaServerSideAdInsertionUriBuilder() तरीके का इस्तेमाल करके, एसएसएआई वीओडी यूआरआई बनाएं:

    /**
     * Builds an IMA SSAI VOD stream URI for the given CMS ID, video ID, and format.
     *
     * @param cmsId The CMS ID of the VOD stream.
     * @param videoId The video ID of the VOD stream.
     * @param format The format of the VOD stream request, either {@code CONTENT_TYPE_HLS} or {@code
     *     CONTENT_TYPE_DASH}.
     * @return The URI of the VOD stream.
     */
    public Uri buildVodStreamUri(String cmsId, String videoId, int format) {
      Map<String, String> adTagParams = new HashMap<String, String>();
      // Update the adTagParams map with any parameters.
      // For more information, see https://support.google.com/admanager/answer/7320899
    
      return new ImaServerSideAdInsertionUriBuilder()
          .setContentSourceId(cmsId)
          .setVideoId(videoId)
          .setFormat(format)
          .setAdTagParameters(adTagParams)
          .build();
    }
    
    
  3. MediaItem.fromUri() तरीके का इस्तेमाल करके, अपने प्लेयर के मीडिया आइटम के तौर पर वीओडी स्ट्रीम का नया यूआरआई सेट करें.

अगर ऐसा हो जाता है, तो ExoPlayer IMA एक्सटेंशन की मदद से मीडिया स्ट्रीम चलाने का अनुरोध किया जा सकता है. पूरा उदाहरण देखने के लिए, GitHub पर Android DAI के सैंपल देखें.