ExoPlayer, Android के लिए ऐप्लिकेशन लेवल का मीडिया प्लेयर है. इस गाइड में, ExoPlayer IMA एक्सटेंशन का इस्तेमाल करने का तरीका बताया गया है. यह एक्सटेंशन, IMA DAI SDK टूल को रैप करता है. इसकी मदद से, विज्ञापनों और कॉन्टेंट, दोनों के साथ मीडिया स्ट्रीम का अनुरोध किया जा सकता है और उसे चलाया जा सकता है.
एक्सटेंशन के कुछ फ़ायदे यहां दिए गए हैं:
- IMA को सुविधाओं के साथ इंटिग्रेट करने के लिए ज़रूरी कोड को आसान बनाता है.
- IMA के नए वर्शन पर अपडेट करने के लिए, डेवलपमेंट में लगने वाले समय को कम करता है.
ExoPlayer IMA एक्सटेंशन, एचएलएस और DASH स्ट्रीमिंग प्रोटोकॉल के साथ काम करता है. यहां इन अपडेट की खास जानकारी दी गई है:
ExoPlayer-IMA एक्सटेंशन स्ट्रीम के लिए सहायता | ||
---|---|---|
लाइवस्ट्रीम | वीओडी स्ट्रीम | |
एचएलएस | ||
DASH |
DASH लाइव स्ट्रीम, ExoPlayer-IMA के 1.1.0 और इसके बाद के वर्शन पर काम करती हैं.
यह गाइड, ExoPlayer की गाइड पर आधारित है. इसमें, पूरा ऐप्लिकेशन बनाने और एक्सटेंशन को इंटिग्रेट करने का तरीका बताया गया है. पूरे सैंपल ऐप्लिकेशन का उदाहरण देखने के लिए, GitHub पर ExoPlayerExample
देखें.
ज़रूरी शर्तें
- Android Studio
- डीआई के साथ काम करने के लिए, AndroidX Media3 ExoPlayer का 1.0.0 या इसके बाद का वर्शन.
Android Studio में नया प्रोजेक्ट बनाना
Android Studio प्रोजेक्ट बनाने के लिए, यह तरीका अपनाएं:
- Android Studio खोलें.
- Android Studio में नया प्रोजेक्ट शुरू करें को चुनें.
- अपना प्रोजेक्ट चुनें पेज पर, कोई गतिविधि नहीं टेंप्लेट चुनें.
- आगे बढ़ें पर क्लिक करें.
अपने प्रोजेक्ट को कॉन्फ़िगर करें पेज पर, अपने प्रोजेक्ट का नाम डालें और भाषा के लिए Java चुनें.
पूरा करें पर क्लिक करें.
अपने प्रोजेक्ट में ExoPlayer IMA एक्सटेंशन जोड़ना
dependencies
सेक्शन में, ऐप्लिकेशन-लेवल की build.gradle फ़ाइल में एक्सटेंशन के लिए इंपोर्ट जोड़ें.
अपने ऐप्लिकेशन को कॉन्फ़िगर करें और मल्टीडेक्स को चालू करें. एक्सटेंशन के साइज़ की वजह से, ऐसा करना ज़रूरी है. साथ ही, यह उन ऐप्लिकेशन के लिए ज़रूरी है जिनके minSdkVersion
को Android 4.4W (एपीआई लेवल 20) या उससे पहले के वर्शन पर सेट किया गया है.
यहां एक उदाहरण दिया गया है:
app/build.gradle
android { ... defaultConfig { applicationId "com.google.ads.interactivemedia.v3.samples.videoplayerapp" minSdkVersion 21 targetSdkVersion 34 multiDexEnabled true versionCode 1 versionName "1.0" } ... } dependencies { implementation 'androidx.multidex:multidex:2.0.1' implementation 'androidx.media3:media3-ui:1.1.1' implementation 'androidx.media3:media3-exoplayer:1.1.1' implementation 'androidx.media3:media3-exoplayer-hls:1.1.1' implementation 'androidx.media3:media3-exoplayer-dash:1.1.1' // Adding the ExoPlayer IMA extension for ads will also include the IMA // SDK as a dependency. implementation 'androidx.media3:media3-exoplayer-ima:1.1.1' }
विज्ञापनों का अनुरोध करने के लिए, IMA DAI SDK टूल के लिए ज़रूरी उपयोगकर्ता अनुमतियां जोड़ें:
app/src/main/AndroidManifest.xml
<?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.example.project name"> <!-- Required permissions for the IMA DAI SDK --> <uses-permission android:name="android.permission.INTERNET"/> <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/> ... </manifest>
इंटेंट के एलान जोड़ना
अगर आपका ऐप्लिकेशन Android 11 (एपीआई लेवल 30) या उसके बाद के वर्शन को टारगेट करता है, तो IMA DAI SDK टूल के मौजूदा और हाल ही के वर्शन के लिए, वेब लिंक खोलने के इंटेंट का साफ़ तौर पर एलान करना ज़रूरी है. विज्ञापन पर क्लिक मिलने की सुविधा चालू करने के लिए, अपने ऐप्लिकेशन की मेनिफ़ेस्ट फ़ाइल में यह स्निपेट जोड़ें. विज्ञापन पर क्लिक मिलने की सुविधा चालू होने पर, उपयोगकर्ता ज़्यादा जानें बटन पर क्लिक कर पाएंगे.
<?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.example.project name"> ... </application> <queries> <intent> <action android:name="android.intent.action.VIEW" /> <data android:scheme="https" /> </intent> <intent> <action android:name="android.intent.action.VIEW" /> <data android:scheme="http" /> </intent> </queries> </manifest>
ExoPlayer का यूज़र इंटरफ़ेस (यूआई) सेट अप करना
ExoPlayer का इस्तेमाल करने के लिए, PlayerView
ऑब्जेक्ट बनाएं.
androidx.constraintlayout.widget.ConstraintLayout
को LinearLayout
में बदलें. यह ExoPlayer IMA एक्सटेंशन के लिए सुझाया गया है.
यहां एक उदाहरण दिया गया है:
app/src/main/res/layout/activity_my.xml
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools" android:background="@android:color/black" 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:layout_width="match_parent" android:layout_height="match_parent" /> </LinearLayout>
स्ट्रीम पैरामीटर जोड़ना
अपने प्रोजेक्ट की जांच करने के लिए, स्ट्रीम एसेट के सैंपल के आईएमए सैंपल स्ट्रीम पेज पर जाएं. अपनी स्ट्रीम सेट अप करने के बारे में जानकारी पाने के लिए, डीएआई पर Ad Manager सेक्शन भी देखें.
इस चरण में, लाइव स्ट्रीम सेट अप करने का तरीका बताया गया है. हालांकि, ExoPlayer IMA एक्सटेंशन में डीएआई वीओडी स्ट्रीम भी काम करती हैं. वीओडी (वीडियो ऑन डिमांड) स्ट्रीम के लिए ज़रूरी कदम देखें. इससे आपको पता चलेगा कि वीओडी स्ट्रीम को मैनेज करने के लिए, आपके ऐप्लिकेशन में कौनसे बदलाव करने होंगे.
ExoPlayer IMA एक्सटेंशन इंपोर्ट करना
ExoPlayer एक्सटेंशन के लिए, इंपोर्ट स्टेटमेंट जोड़ें.
MyActivity.java
में ये निजी वैरिएबल जोड़ें:
PlayerView
ExoPlayer
ImaServerSideAdInsertionMediaSource.AdsLoader
ImaServerSideAdInsertionMediaSource.AdsLoader.State
इस स्ट्रीम की जांच करने के लिए, Big Buck Bunny (लाइव) एचएलएस स्ट्रीम की एसेट पासकोड जोड़ें. आईएमए के सैंपल स्ट्रीम पेज पर, जांच के लिए ज़्यादा स्ट्रीम उपलब्ध हैं.
AdsLoader
की स्थिति को सेव और वापस पाने के लिए, KEY_ADS_LOADER_STATE
कॉन्स्टेंट बनाएं.
यहां एक उदाहरण दिया गया है:
app/src/main/java/com/example/project name/MyActivity.java
import static androidx.media3.common.C.CONTENT_TYPE_HLS; import android.app.Activity; import android.net.Uri; import android.os.Bundle; import androidx.annotation.Nullable; import androidx.annotation.OptIn; 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.exoplayer.util.EventLogger; import androidx.media3.ui.PlayerView; import androidx.multidex.MultiDex; ... 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 PlayerView playerView; private ExoPlayer player; private ImaServerSideAdInsertionMediaSource.AdsLoader adsLoader; private ImaServerSideAdInsertionMediaSource.AdsLoader.State adsLoaderState; }
adsLoader
इंस्टेंस बनाना
PlayerView
ढूंढने के लिए, onCreate
तरीके को बदलें और सेव किए गए AdsLoader.State
की जांच करें. इसका इस्तेमाल adsLoader
ऑब्जेक्ट को शुरू करते समय किया जा सकता है.
साथ ही, अगर आपके ऐप्लिकेशन के तरीके की संख्या और minSdkVersion
के हिसाब से ज़रूरी हो, तो मल्टीडेक्स चालू करें (जैसा कि दूसरे चरण में बताया गया है).
यहां एक उदाहरण दिया गया है:
app/src/main/java/com/example/project name/MyActivity.java
... 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 PlayerView playerView; private ExoPlayer player; private ImaServerSideAdInsertionMediaSource.AdsLoader adsLoader; private ImaServerSideAdInsertionMediaSource.AdsLoader.State adsLoaderState; @Override protected void onCreate(@Nullable Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_my); MultiDex.install(this); 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); } } } }
प्लेयर को शुरू करने के तरीके जोड़ना
प्लेयर को शुरू करने का तरीका जोड़ें और यह तरीका अपनाएं:
AdsLoader
इंस्टेंस बनाएं.ExoPlayer
बनाएं.- लाइव स्ट्रीम की ऐसेट कुंजी का इस्तेमाल करके
MediaItem
बनाएं. MediaItem
को अपने प्लेयर पर सेट करें.
यहां एक उदाहरण दिया गया है:
app/src/main/java/com/example/project name/MyActivity.java
public class MyActivity extends Activity { ... // Create a server side ad insertion (SSAI) AdsLoader. private ImaServerSideAdInsertionMediaSource.AdsLoader createAdsLoader() { ImaServerSideAdInsertionMediaSource.AdsLoader.Builder adsLoaderBuilder = new ImaServerSideAdInsertionMediaSource.AdsLoader.Builder(this, playerView); // Attempt to set the AdsLoader state if available from a previous session. if (adsLoaderState != null) { adsLoaderBuilder.setAdsLoaderState(adsLoaderState); } return adsLoaderBuilder.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 an ExoPlayer and set it as the player for content and ads. player = new ExoPlayer.Builder(this).setMediaSourceFactory(mediaSourceFactory).build(); playerView.setPlayer(player); adsLoader.setPlayer(player); // Build an IMA SSAI media item to prepare the player with. Uri ssaiLiveUri = new ImaServerSideAdInsertionUriBuilder() .setAssetKey(SAMPLE_ASSET_KEY) .setFormat(CONTENT_TYPE_HLS) // Use CONTENT_TYPE_DASH for dash streams. .build(); // Create the MediaItem to play, specifying the stream URI. MediaItem ssaiMediaItem = MediaItem.fromUri(ssaiLiveUri); // 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); } }
प्लेयर को रिलीज़ करने का तरीका जोड़ना
इस क्रम में प्लेयर को रिलीज़ करने का तरीका जोड़ें:
- प्लेयर के रेफ़रंस को शून्य पर सेट करें और प्लेयर के संसाधनों को रिलीज़ करें.
adsLoader
की स्थिति को छोड़ें.
app/src/main/java/com/example/project name/MyActivity.java
public class MyActivity extends Activity { ... 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 SDK टूल के 24 और उसके बाद के वर्शन के साथ काम करने के लिए:
Android SDK टूल के 24 से पहले के वर्शन के साथ काम करने के लिए:
- onResume()
- onPause()
onStart()
और onResume()
, playerView.onResume()
पर मैप होते हैं. साथ ही, onStop()
और
onPause()
, playerView.onPause()
पर मैप होते हैं.
इस चरण में, adsLoaderState
को सेव करने के लिए onSaveInstanceState()
इवेंट का भी इस्तेमाल किया जाता है.
app/src/main/java/com/example/project name/MyActivity.java
public class MyActivity extends Activity { ... @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()); } } ... }
वीओडी स्ट्रीम सेटअप करना (ज़रूरी नहीं)
अगर आपके ऐप्लिकेशन में वीओडी कॉन्टेंट को विज्ञापनों के साथ चलाना ज़रूरी है, तो आपको ये काम करने होंगे:
- वीओडी टेस्ट स्ट्रीम के लिए,
CMS ID
औरVideo ID
जोड़ें. ImaServerSideAdInsertionUriBuilder()
का इस्तेमाल करके, एसएसएआई वीओडी यूआरआई बनाएं.- इस नए यूआरआई का इस्तेमाल, अपने प्लेयर के मीडिया आइटम के तौर पर करें.
app/src/main/java/com/example/project name/MyActivity.java
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 SAMPLE_CMS_ID = "2548831"; private static final String SAMPLE_VIDEO_ID = "tears-of-steel"; ... private void initializePlayer() { ... Uri ssaiVodUri = new ImaServerSideAdInsertionUriBuilder() .setContentSourceId(SAMPLE_CMS_ID) .setVideoId(SAMPLE_VIDEO_ID) .setFormat(CONTENT_TYPE_HLS) .build(); // Create the MediaItem to play, specifying the stream URI. MediaItem ssaiMediaItem = MediaItem.fromUri(ssaiVodUri); // 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); }
हो गया! अब आपने ExoPlayer के IMA एक्सटेंशन की मदद से, मीडिया स्ट्रीम का अनुरोध किया है और उसे चलाया है. पूरा कोड देखने के लिए, GitHub पर Android डीआई के सैंपल देखें.