इस डेवलपर गाइड में, Android Sender SDK टूल का इस्तेमाल करके, Android सेंडर ऐप्लिकेशन में Google Cast की सुविधा जोड़ने का तरीका बताया गया है.
मोबाइल डिवाइस या लैपटॉप, भेजने वाला डिवाइस होता है. इससे वीडियो चलाने की सुविधा को कंट्रोल किया जाता है. वहीं, Google Cast डिवाइस, पाने वाला डिवाइस होता है. इससे टीवी पर कॉन्टेंट दिखाया जाता है.
सेंडर फ़्रेमवर्क का मतलब, Cast क्लास लाइब्रेरी बाइनरी और उससे जुड़े उन संसाधनों से है जो सेंडर पर रनटाइम के दौरान मौजूद होते हैं. sender app या Cast app, उस ऐप्लिकेशन को कहते हैं जो सेंडर पर भी चल रहा हो. वेब रिसीवर ऐप्लिकेशन, कास्ट की सुविधा वाले डिवाइस पर चलने वाले एचटीएमएल ऐप्लिकेशन को कहते हैं.
सेंडर फ़्रेमवर्क, एसिंक्रोनस कॉलबैक डिज़ाइन का इस्तेमाल करता है. इससे, सेंडर ऐप्लिकेशन को इवेंट की जानकारी मिलती है. साथ ही, Cast ऐप्लिकेशन के लाइफ़ साइकल की अलग-अलग स्थितियों के बीच ट्रांज़िशन होता है.
ऐप्लिकेशन फ़्लो
यहां दिए गए चरणों में, Android ऐप्लिकेशन से कॉन्टेंट भेजने के लिए, हाई-लेवल एक्ज़ीक्यूशन फ़्लो के बारे में बताया गया है:
- Cast फ़्रेमवर्क,
Activityलाइफ़साइकल के आधार पर,MediaRouterडिवाइस की खोज अपने-आप शुरू कर देता है. - जब उपयोगकर्ता कास्ट बटन पर क्लिक करता है, तो फ़्रेमवर्क, कास्ट किए जा सकने वाले डिवाइसों की सूची के साथ कास्ट डायलॉग दिखाता है.
- जब उपयोगकर्ता कोई कास्ट डिवाइस चुनता है, तो फ़्रेमवर्क, कास्ट डिवाइस पर वेब रिसीवर ऐप्लिकेशन को लॉन्च करने की कोशिश करता है.
- फ़्रेमवर्क, भेजने वाले ऐप्लिकेशन में कॉलबैक को शुरू करता है, ताकि यह पुष्टि की जा सके कि वेब रिसीवर ऐप्लिकेशन लॉन्च किया गया था.
- यह फ़्रेमवर्क, सेंडर और वेब रिसीवर ऐप्लिकेशन के बीच कम्यूनिकेशन चैनल बनाता है.
- यह फ़्रेमवर्क, वेब रिसीवर पर मीडिया प्लेबैक को लोड और कंट्रोल करने के लिए, कम्यूनिकेशन चैनल का इस्तेमाल करता है.
- फ़्रेमवर्क, सेंडर और वेब रिसीवर के बीच मीडिया प्लेबैक की स्थिति को सिंक करता है: जब उपयोगकर्ता सेंडर के यूज़र इंटरफ़ेस (यूआई) पर कोई कार्रवाई करता है, तो फ़्रेमवर्क मीडिया कंट्रोल के उन अनुरोधों को वेब रिसीवर को भेजता है. साथ ही, जब वेब रिसीवर मीडिया की स्थिति के अपडेट भेजता है, तो फ़्रेमवर्क सेंडर के यूज़र इंटरफ़ेस (यूआई) की स्थिति को अपडेट करता है.
- जब उपयोगकर्ता कास्ट किए जा रहे डिवाइस से डिसकनेक्ट करने के लिए कास्ट बटन पर क्लिक करता है, तो फ़्रेमवर्क, वेब रिसीवर से सेंडर ऐप्लिकेशन को डिसकनेक्ट कर देगा.
Google Cast Android SDK में मौजूद सभी क्लास, तरीकों, और इवेंट की पूरी सूची देखने के लिए, Android के लिए Google Cast Sender API का रेफ़रंस देखें. यहां दिए गए सेक्शन में, Android ऐप्लिकेशन में Cast की सुविधा जोड़ने का तरीका बताया गया है.
Android मेनिफ़ेस्ट को कॉन्फ़िगर करना
आपके ऐप्लिकेशन की AndroidManifest.xml फ़ाइल में, Cast SDK के लिए इन एलिमेंट को कॉन्फ़िगर करना ज़रूरी है:
uses-sdk
Android के कम से कम और टारगेट एपीआई लेवल सेट करें जिन पर Cast SDK काम करता है. फ़िलहाल, कम से कम एपीआई लेवल 24 और टारगेट एपीआई लेवल 35 होना चाहिए.
<uses-sdk
android:minSdkVersion="24"
android:targetSdkVersion="35" />
android:theme
Android SDK के कम से कम वर्शन के आधार पर, अपने ऐप्लिकेशन की थीम सेट करें. उदाहरण के लिए, अगर आपने अपनी थीम लागू नहीं की है, तो Lollipop से पहले के Android SDK टूल के वर्शन को टारगेट करते समय, आपको Theme.AppCompat के वैरिएंट का इस्तेमाल करना चाहिए.
<application
android:icon="@drawable/ic_launcher"
android:label="@string/app_name"
android:theme="@style/Theme.AppCompat" >
...
</application>
Cast कॉन्टेक्स्ट को शुरू करना
फ़्रेमवर्क में एक ग्लोबल सिंगलटन ऑब्जेक्ट, CastContext होता है. यह फ़्रेमवर्क के सभी इंटरैक्शन को मैनेज करता है.
आपके ऐप्लिकेशन को
OptionsProvider
इंटरफ़ेस लागू करना होगा, ताकि
CastContext
सिंगलटन को शुरू करने के लिए ज़रूरी विकल्प उपलब्ध कराए जा सकें. OptionsProvider, CastOptions का एक इंस्टेंस उपलब्ध कराता है. इसमें ऐसे विकल्प होते हैं जो फ़्रेमवर्क के काम करने के तरीके पर असर डालते हैं. इनमें सबसे अहम है वेब रिसीवर ऐप्लिकेशन आईडी. इसका इस्तेमाल, खोज के नतीजों को फ़िल्टर करने और कास्ट सेशन शुरू होने पर वेब रिसीवर ऐप्लिकेशन को लॉन्च करने के लिए किया जाता है.
class CastOptionsProvider : OptionsProvider { override fun getCastOptions(context: Context): CastOptions { return Builder() .setReceiverApplicationId(context.getString(R.string.app_id)) .build() } override fun getAdditionalSessionProviders(context: Context): List<SessionProvider>? { return null } }
public class CastOptionsProvider implements OptionsProvider { @Override public CastOptions getCastOptions(Context context) { CastOptions castOptions = new CastOptions.Builder() .setReceiverApplicationId(context.getString(R.string.app_id)) .build(); return castOptions; } @Override public List<SessionProvider> getAdditionalSessionProviders(Context context) { return null; } }
आपको भेजने वाले ऐप्लिकेशन की AndroidManifest.xml फ़ाइल में, मेटाडेटा फ़ील्ड के तौर पर लागू किए गए OptionsProvider का पूरा नाम बताना होगा:
<application>
...
<meta-data
android:name=
"com.google.android.gms.cast.framework.OPTIONS_PROVIDER_CLASS_NAME"
android:value="com.foo.CastOptionsProvider" />
</application>
CastContext.getSharedInstance() को कॉल करने पर, CastContext को लेज़ी तरीके से शुरू किया जाता है.
class MyActivity : FragmentActivity() { override fun onCreate(savedInstanceState: Bundle?) { val castContext = CastContext.getSharedInstance(this) } }
public class MyActivity extends FragmentActivity { @Override public void onCreate(Bundle savedInstanceState) { CastContext castContext = CastContext.getSharedInstance(this); } }
Cast UX विजेट
Cast फ़्रेमवर्क, Cast डिज़ाइन चेकलिस्ट के मुताबिक विजेट उपलब्ध कराता है:
इंट्रोडक्टरी ओवरले: फ़्रेमवर्क, कस्टम व्यू उपलब्ध कराता है,
IntroductoryOverlay, जो उपयोगकर्ता को पहली बार रिसीवर उपलब्ध होने पर, कास्ट बटन पर ध्यान देने के लिए दिखाया जाता है. सेंडर ऐप्लिकेशन, टेक्स्ट और टाइटल टेक्स्ट की पोज़िशन को पसंद के मुताबिक बना सकता है.कास्ट बटन: कास्ट बटन हमेशा दिखता है, भले ही कास्ट करने की सुविधा वाले डिवाइस उपलब्ध हों या नहीं. जब उपयोगकर्ता पहली बार कास्ट बटन पर क्लिक करता है, तो कास्ट डायलॉग बॉक्स दिखता है. इसमें, खोजे गए डिवाइसों की सूची होती है. जब उपयोगकर्ता डिवाइस कनेक्ट होने के दौरान कास्ट बटन पर क्लिक करता है, तो मौजूदा मीडिया मेटाडेटा (जैसे, टाइटल, रिकॉर्डिंग स्टूडियो का नाम, और थंबनेल इमेज) दिखता है. इसके अलावा, उपयोगकर्ता को कास्ट डिवाइस से डिसकनेक्ट करने की अनुमति मिलती है. "कास्ट बटन" को कभी-कभी "कास्ट आइकॉन" भी कहा जाता है.
मिनी कंट्रोलर: जब उपयोगकर्ता कॉन्टेंट कास्ट कर रहा हो और वह कॉन्टेंट के मौजूदा पेज से बाहर निकल गया हो या सेंडर ऐप्लिकेशन में एक्सपैंडेड कंट्रोलर से दूसरी स्क्रीन पर चला गया हो, तो स्क्रीन पर सबसे नीचे मिनी कंट्रोलर दिखता है. इससे उपयोगकर्ता, कास्ट किए जा रहे मीडिया का मेटाडेटा देख सकता है और प्लेबैक को कंट्रोल कर सकता है.
Expanded Controller: जब उपयोगकर्ता कॉन्टेंट कास्ट कर रहा हो, तो मीडिया की सूचना या मिनी कंट्रोलर पर क्लिक करने से, Expanded Controller लॉन्च हो जाता है. इसमें, फ़िलहाल चल रहे मीडिया का मेटाडेटा दिखता है. साथ ही, मीडिया प्लेबैक को कंट्रोल करने के लिए कई बटन मिलते हैं.
सूचना: सिर्फ़ Android के लिए. जब उपयोगकर्ता कॉन्टेंट कास्ट कर रहा होता है और सेंडर ऐप्लिकेशन से बाहर निकल जाता है, तो मीडिया की सूचना दिखती है. इसमें, कास्ट किए जा रहे मीडिया का मेटाडेटा और प्लेबैक कंट्रोल दिखते हैं.
लॉक स्क्रीन: सिर्फ़ Android के लिए. जब उपयोगकर्ता कॉन्टेंट कास्ट कर रहा होता है और लॉक स्क्रीन पर जाता है (या डिवाइस का टाइम आउट हो जाता है), तो मीडिया लॉक स्क्रीन कंट्रोल दिखता है. इसमें, कास्ट किए जा रहे मीडिया का मेटाडेटा और प्लेबैक कंट्रोल दिखते हैं.
इस गाइड में, अपने ऐप्लिकेशन में इन विजेट को जोड़ने का तरीका बताया गया है.
कास्ट बटन जोड़ना
Android
MediaRouter
एपीआई को इस तरह डिज़ाइन किया गया है कि सेकंडरी डिवाइसों पर मीडिया को दिखाया और चलाया जा सके.
MediaRouter एपीआई का इस्तेमाल करने वाले Android ऐप्लिकेशन के यूज़र इंटरफ़ेस में, कास्ट बटन शामिल होना चाहिए. इससे उपयोगकर्ता, कास्ट डिवाइस जैसे किसी दूसरे डिवाइस पर मीडिया चलाने के लिए, मीडिया रूट चुन सकते हैं.
इस फ़्रेमवर्क की मदद से,
MediaRouteButton
को
Cast button
के तौर पर जोड़ना बहुत आसान हो जाता है. आपको सबसे पहले, मेन्यू को तय करने वाली एक्सएमएल फ़ाइल में, मेन्यू आइटम या MediaRouteButton जोड़ना चाहिए. इसके बाद, इसे फ़्रेमवर्क से जोड़ने के लिए, CastButtonFactory का इस्तेमाल करना चाहिए.
// To add a Cast button, add the following snippet.
// menu.xml
<item
android:id="@+id/media_route_menu_item"
android:title="@string/media_route_menu_title"
app:actionProviderClass="androidx.mediarouter.app.MediaRouteActionProvider"
app:showAsAction="always" />
// Then override the onCreateOptionMenu() for each of your activities. // MyActivity.kt override fun onCreateOptionsMenu(menu: Menu): Boolean { super.onCreateOptionsMenu(menu) menuInflater.inflate(R.menu.main, menu) CastButtonFactory.setUpMediaRouteButton( applicationContext, menu, R.id.media_route_menu_item ) return true }
// Then override the onCreateOptionMenu() for each of your activities. // MyActivity.java @Override public boolean onCreateOptionsMenu(Menu menu) { super.onCreateOptionsMenu(menu); getMenuInflater().inflate(R.menu.main, menu); CastButtonFactory.setUpMediaRouteButton(getApplicationContext(), menu, R.id.media_route_menu_item); return true; }
इसके बाद, अगर आपका Activity, FragmentActivity से इनहेरिट करता है, तो अपने लेआउट में MediaRouteButton जोड़ा जा सकता है.
// activity_layout.xml
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:gravity="center_vertical"
android:orientation="horizontal" >
<androidx.mediarouter.app.MediaRouteButton
android:id="@+id/media_route_button"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_weight="1"
android:mediaRouteTypes="user"
android:visibility="gone" />
</LinearLayout>
// MyActivity.kt override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.activity_layout) mMediaRouteButton = findViewById<View>(R.id.media_route_button) as MediaRouteButton CastButtonFactory.setUpMediaRouteButton(applicationContext, mMediaRouteButton) mCastContext = CastContext.getSharedInstance(this) }
// MyActivity.java @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_layout); mMediaRouteButton = (MediaRouteButton) findViewById(R.id.media_route_button); CastButtonFactory.setUpMediaRouteButton(getApplicationContext(), mMediaRouteButton); mCastContext = CastContext.getSharedInstance(this); }
थीम का इस्तेमाल करके कास्ट बटन के दिखने का तरीका सेट करने के लिए, कास्ट बटन को पसंद के मुताबिक बनाएं देखें.
डिवाइस खोजने की सुविधा को कॉन्फ़िगर करना
डिवाइस खोजने की सुविधा को पूरी तरह से CastContext मैनेज करता है.
CastContext को शुरू करते समय, सेंडर ऐप्लिकेशन, वेब रिसीवर ऐप्लिकेशन आईडी की जानकारी देता है. साथ ही, CastOptions में supportedNamespaces को सेट करके, नेमस्पेस फ़िल्टर करने का अनुरोध कर सकता है.
CastContext में MediaRouter का रेफ़रंस होता है. साथ ही, यह इन स्थितियों में खोजने की प्रोसेस शुरू करेगा:
- डिवाइस खोजने में लगने वाले समय और बैटरी के इस्तेमाल को संतुलित करने के लिए डिज़ाइन किए गए एल्गोरिदम के आधार पर, डिवाइस खोजने की प्रोसेस कभी-कभी अपने-आप शुरू हो जाएगी. ऐसा तब होगा, जब कॉन्टेंट भेजने वाला ऐप्लिकेशन फ़ोरग्राउंड में खुलेगा.
- कास्ट करने का डायलॉग बॉक्स खुला है.
- Cast SDK, कास्ट सेशन को वापस लाने की कोशिश कर रहा है.
कास्ट डायलॉग बंद होने या सेंडर ऐप्लिकेशन के बैकग्राउंड में जाने पर, डिवाइस खोजने की प्रोसेस बंद हो जाएगी.
class CastOptionsProvider : OptionsProvider { companion object { const val CUSTOM_NAMESPACE = "urn:x-cast:custom_namespace" } override fun getCastOptions(appContext: Context): CastOptions { val supportedNamespaces: MutableList<String> = ArrayList() supportedNamespaces.add(CUSTOM_NAMESPACE) return CastOptions.Builder() .setReceiverApplicationId(context.getString(R.string.app_id)) .setSupportedNamespaces(supportedNamespaces) .build() } override fun getAdditionalSessionProviders(context: Context): List<SessionProvider>? { return null } }
class CastOptionsProvider implements OptionsProvider { public static final String CUSTOM_NAMESPACE = "urn:x-cast:custom_namespace"; @Override public CastOptions getCastOptions(Context appContext) { List<String> supportedNamespaces = new ArrayList<>(); supportedNamespaces.add(CUSTOM_NAMESPACE); CastOptions castOptions = new CastOptions.Builder() .setReceiverApplicationId(context.getString(R.string.app_id)) .setSupportedNamespaces(supportedNamespaces) .build(); return castOptions; } @Override public List<SessionProvider> getAdditionalSessionProviders(Context context) { return null; } }
सेशन मैनेजमेंट की सुविधा कैसे काम करती है
Cast SDK, Cast सेशन का कॉन्सेप्ट पेश करता है. इसे सेट अप करने के लिए, किसी डिवाइस से कनेक्ट करने, वेब रिसीवर ऐप्लिकेशन को लॉन्च करने (या उसमें शामिल होने), उस ऐप्लिकेशन से कनेक्ट करने, और मीडिया कंट्रोल चैनल को शुरू करने के चरणों को पूरा करना होता है. Cast सेशन और वेब रिसीवर के लाइफ़ साइकल के बारे में ज़्यादा जानने के लिए, वेब रिसीवर ऐप्लिकेशन के लाइफ़ साइकल की गाइड देखें.
सेशन को SessionManager क्लास मैनेज करती है. आपका ऐप्लिकेशन इसे CastContext.getSessionManager() की मदद से ऐक्सेस कर सकता है.
अलग-अलग सेशन को Session क्लास की सबक्लास से दिखाया जाता है.
उदाहरण के लिए,
CastSession
कास्ट डिवाइसों के साथ सेशन दिखाता है. आपका ऐप्लिकेशन, SessionManager.getCurrentCastSession() की मदद से, फ़िलहाल चालू Cast सेशन को ऐक्सेस कर सकता है.
आपका ऐप्लिकेशन, सेशन के इवेंट को मॉनिटर करने के लिए,
SessionManagerListener
क्लास का इस्तेमाल कर सकता है. जैसे, सेशन बनाना, निलंबित करना, फिर से शुरू करना, और
खत्म करना. अगर कोई सेशन अचानक या असामान्य तरीके से बंद हो जाता है, तो फ़्रेमवर्क उसे अपने-आप फिर से शुरू करने की कोशिश करता है.
MediaRouter डायलॉग से उपयोगकर्ता के जेस्चर के जवाब में, सेशन अपने-आप बनते और खत्म होते हैं.
कास्ट करने की सुविधा शुरू होने से जुड़ी गड़बड़ियों को बेहतर तरीके से समझने के लिए, ऐप्लिकेशन
CastContext#getCastReasonCodeForCastStatusCode(int)
का इस्तेमाल कर सकते हैं. इससे, सेशन शुरू होने से जुड़ी गड़बड़ी को
CastReasonCodes में बदला जा सकता है.
कृपया ध्यान दें कि सेशन शुरू होने से जुड़ी कुछ गड़बड़ियां (जैसे, CastReasonCodes#CAST_CANCELLED) सामान्य होती हैं. इन्हें गड़बड़ी के तौर पर लॉग नहीं किया जाना चाहिए.
अगर आपको सेशन की स्थिति में होने वाले बदलावों के बारे में जानना है, तो SessionManagerListener को लागू किया जा सकता है. इस उदाहरण में, Activity में CastSession की उपलब्धता के बारे में सुना जा सकता है.
class MyActivity : Activity() { private var mCastSession: CastSession? = null private lateinit var mCastContext: CastContext private lateinit var mSessionManager: SessionManager private val mSessionManagerListener: SessionManagerListener<CastSession> = SessionManagerListenerImpl() private inner class SessionManagerListenerImpl : SessionManagerListener<CastSession?> { override fun onSessionStarting(session: CastSession?) {} override fun onSessionStarted(session: CastSession?, sessionId: String) { invalidateOptionsMenu() } override fun onSessionStartFailed(session: CastSession?, error: Int) { val castReasonCode = mCastContext.getCastReasonCodeForCastStatusCode(error) // Handle error } override fun onSessionSuspended(session: CastSession?, reason Int) {} override fun onSessionResuming(session: CastSession?, sessionId: String) {} override fun onSessionResumed(session: CastSession?, wasSuspended: Boolean) { invalidateOptionsMenu() } override fun onSessionResumeFailed(session: CastSession?, error: Int) {} override fun onSessionEnding(session: CastSession?) {} override fun onSessionEnded(session: CastSession?, error: Int) { finish() } } override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) mCastContext = CastContext.getSharedInstance(this) mSessionManager = mCastContext.sessionManager mSessionManager.addSessionManagerListener(mSessionManagerListener, CastSession::class.java) } override fun onResume() { super.onResume() mCastSession = mSessionManager.currentCastSession } override fun onDestroy() { super.onDestroy() mSessionManager.removeSessionManagerListener(mSessionManagerListener, CastSession::class.java) } }
public class MyActivity extends Activity { private CastContext mCastContext; private CastSession mCastSession; private SessionManager mSessionManager; private SessionManagerListener<CastSession> mSessionManagerListener = new SessionManagerListenerImpl(); private class SessionManagerListenerImpl implements SessionManagerListener<CastSession> { @Override public void onSessionStarting(CastSession session) {} @Override public void onSessionStarted(CastSession session, String sessionId) { invalidateOptionsMenu(); } @Override public void onSessionStartFailed(CastSession session, int error) { int castReasonCode = mCastContext.getCastReasonCodeForCastStatusCode(error); // Handle error } @Override public void onSessionSuspended(CastSession session, int reason) {} @Override public void onSessionResuming(CastSession session, String sessionId) {} @Override public void onSessionResumed(CastSession session, boolean wasSuspended) { invalidateOptionsMenu(); } @Override public void onSessionResumeFailed(CastSession session, int error) {} @Override public void onSessionEnding(CastSession session) {} @Override public void onSessionEnded(CastSession session, int error) { finish(); } } @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); mCastContext = CastContext.getSharedInstance(this); mSessionManager = mCastContext.getSessionManager(); mSessionManager.addSessionManagerListener(mSessionManagerListener, CastSession.class); } @Override protected void onResume() { super.onResume(); mCastSession = mSessionManager.getCurrentCastSession(); } @Override protected void onDestroy() { super.onDestroy(); mSessionManager.removeSessionManagerListener(mSessionManagerListener, CastSession.class); } }
स्ट्रीम ट्रांसफ़र
सेशन की स्थिति को बनाए रखना, स्ट्रीम ट्रांसफ़र का आधार है. इसकी मदद से, उपयोगकर्ता बोले गए निर्देशों, Google Home ऐप्लिकेशन या स्मार्ट डिसप्ले का इस्तेमाल करके, मौजूदा ऑडियो और वीडियो स्ट्रीम को एक डिवाइस से दूसरे डिवाइस पर ट्रांसफ़र कर सकते हैं. मीडिया एक डिवाइस (सोर्स) पर चलना बंद हो जाता है और दूसरे डिवाइस (डेस्टिनेशन) पर चलने लगता है. नए फ़र्मवेयर वाले किसी भी Cast डिवाइस का इस्तेमाल, संगीत को दूसरे स्पीकर पर चलाने की सुविधा के लिए, सोर्स या डेस्टिनेशन के तौर पर किया जा सकता है.
स्ट्रीम ट्रांसफ़र या एक्सपैंशन के दौरान नया डेस्टिनेशन डिवाइस पाने के लिए,
CastSession#addCastListener
का इस्तेमाल करके
Cast.Listener
रजिस्टर करें.
इसके बाद, onDeviceNameChanged कॉलबैक के दौरान CastSession#getCastDevice() को कॉल करें.
ज़्यादा जानकारी के लिए, वेब रिसीवर पर स्ट्रीम ट्रांसफ़र करना देखें.
अपने-आप फिर से कनेक्ट होने की सुविधा
फ़्रेमवर्क में
ReconnectionService
होता है. इसे भेजने वाला ऐप्लिकेशन चालू कर सकता है, ताकि कई मुश्किल मामलों में फिर से कनेक्ट करने की सुविधा को मैनेज किया जा सके. जैसे:
- वाई-फ़ाई कनेक्शन कुछ समय के लिए बंद होने पर, उसे फिर से चालू करना
- डिवाइस के स्लीप मोड से बाहर आने पर, ऐप्लिकेशन को फिर से चालू करना
- ऐप्लिकेशन को बैकग्राउंड में चलाने के बाद, उसे फिर से चालू करना
- ऐप्लिकेशन क्रैश होने पर उसे वापस लाना
यह सेवा डिफ़ॉल्ट रूप से चालू होती है. इसे CastOptions.Builder में जाकर बंद किया जा सकता है.
अगर आपकी gradle फ़ाइल में अपने-आप मर्ज होने की सुविधा चालू है, तो यह सेवा आपके ऐप्लिकेशन के मेनिफ़ेस्ट में अपने-आप मर्ज हो सकती है.
फ़्रेमवर्क, मीडिया सेशन होने पर सेवा शुरू करेगा और मीडिया सेशन खत्म होने पर इसे बंद कर देगा.
मीडिया कंट्रोल की सुविधा कैसे काम करती है
Cast फ़्रेमवर्क, Cast 2.x की
RemoteMediaPlayer
क्लास को बंद कर देता है. इसकी जगह, नई क्लास
RemoteMediaClient
का इस्तेमाल किया जाता है. यह क्लास, ज़्यादा सुविधाजनक एपीआई के सेट में एक जैसी सुविधाएं उपलब्ध कराती है. साथ ही, GoogleApiClient में पास करने की ज़रूरत नहीं पड़ती.
जब आपका ऐप्लिकेशन, मीडिया नेमस्पेस के साथ काम करने वाले वेब रिसीवर ऐप्लिकेशन के साथ
CastSession
बनाता है, तो फ़्रेमवर्क अपने-आप
RemoteMediaClient का इंस्टेंस बना देगा; आपका ऐप्लिकेशन
CastSession इंस्टेंस पर getRemoteMediaClient() तरीके को कॉल करके, इसे ऐक्सेस कर सकता है.
RemoteMediaClient के वे सभी तरीके जो वेब रिसीवर को अनुरोध भेजते हैं, वे PendingResult ऑब्जेक्ट दिखाएंगे. इसका इस्तेमाल, उस अनुरोध को ट्रैक करने के लिए किया जा सकता है.
ऐसा हो सकता है कि RemoteMediaClient के इंस्टेंस को आपके ऐप्लिकेशन के कई हिस्सों के साथ शेयर किया जाए. साथ ही, फ़्रेमवर्क के कुछ इंटरनल कॉम्पोनेंट के साथ भी शेयर किया जाए. जैसे, लगातार दिखने वाले मिनी कंट्रोलर और सूचना सेवा.
इसके लिए, यह इंस्टेंस RemoteMediaClient.Listener के कई इंस्टेंस के रजिस्ट्रेशन की सुविधा देता है.
मीडिया मेटाडेटा सेट करना
MediaMetadata
क्लास, उस मीडिया आइटम की जानकारी दिखाती है जिसे आपको कास्ट करना है. नीचे दिए गए उदाहरण में, किसी फ़िल्म का नया MediaMetadata इंस्टेंस बनाया गया है. साथ ही, टाइटल, सबटाइटल, और दो इमेज सेट की गई हैं.
val movieMetadata = MediaMetadata(MediaMetadata.MEDIA_TYPE_MOVIE) movieMetadata.putString(MediaMetadata.KEY_TITLE, mSelectedMedia.getTitle()) movieMetadata.putString(MediaMetadata.KEY_SUBTITLE, mSelectedMedia.getStudio()) movieMetadata.addImage(WebImage(Uri.parse(mSelectedMedia.getImage(0)))) movieMetadata.addImage(WebImage(Uri.parse(mSelectedMedia.getImage(1))))
MediaMetadata movieMetadata = new MediaMetadata(MediaMetadata.MEDIA_TYPE_MOVIE); movieMetadata.putString(MediaMetadata.KEY_TITLE, mSelectedMedia.getTitle()); movieMetadata.putString(MediaMetadata.KEY_SUBTITLE, mSelectedMedia.getStudio()); movieMetadata.addImage(new WebImage(Uri.parse(mSelectedMedia.getImage(0)))); movieMetadata.addImage(new WebImage(Uri.parse(mSelectedMedia.getImage(1))));
मीडिया मेटाडेटा के साथ इमेज इस्तेमाल करने के बारे में जानने के लिए, इमेज चुनना देखें.
मीडिया लोड करना
आपका ऐप्लिकेशन, किसी मीडिया आइटम को लोड कर सकता है. इसके लिए, यहां दिया गया कोड देखें. सबसे पहले,
MediaInfo
इंस्टेंस बनाने के लिए, मीडिया के मेटाडेटा के साथ
MediaInfo.Builder
का इस्तेमाल करें. मौजूदा CastSession से RemoteMediaClient पाएं. इसके बाद, MediaInfo को उस RemoteMediaClient में लोड करें. वेब रिसीवर पर चल रहे मीडिया प्लेयर ऐप्लिकेशन को चलाने, रोकने, और कंट्रोल करने के लिए, RemoteMediaClient का इस्तेमाल करें.
val mediaInfo = MediaInfo.Builder(mSelectedMedia.getUrl()) .setStreamType(MediaInfo.STREAM_TYPE_BUFFERED) .setContentType("videos/mp4") .setMetadata(movieMetadata) .setStreamDuration(mSelectedMedia.getDuration() * 1000) .build() val remoteMediaClient = mCastSession.getRemoteMediaClient() remoteMediaClient.load(MediaLoadRequestData.Builder().setMediaInfo(mediaInfo).build())
MediaInfo mediaInfo = new MediaInfo.Builder(mSelectedMedia.getUrl()) .setStreamType(MediaInfo.STREAM_TYPE_BUFFERED) .setContentType("videos/mp4") .setMetadata(movieMetadata) .setStreamDuration(mSelectedMedia.getDuration() * 1000) .build(); RemoteMediaClient remoteMediaClient = mCastSession.getRemoteMediaClient(); remoteMediaClient.load(new MediaLoadRequestData.Builder().setMediaInfo(mediaInfo).build());
मीडिया ट्रैक इस्तेमाल करने के बारे में जानकारी देने वाला सेक्शन भी देखें.
4K वीडियो फ़ॉर्मैट
यह देखने के लिए कि आपका मीडिया किस वीडियो फ़ॉर्मैट में है, MediaStatus में getVideoInfo() का इस्तेमाल करके, VideoInfo का मौजूदा इंस्टेंस पाएं.
इस इंस्टेंस में, एचडीआर टीवी फ़ॉर्मैट का टाइप और डिसप्ले की ऊंचाई और चौड़ाई पिक्सल में शामिल होती है. 4K फ़ॉर्मैट के वैरिएंट, कॉन्स्टेंट HDR_TYPE_* से दिखाए जाते हैं.
कई डिवाइसों पर रिमोट कंट्रोल की सूचनाएं
जब कोई उपयोगकर्ता कास्ट कर रहा होता है, तो उसी नेटवर्क से जुड़े अन्य Android डिवाइसों को एक सूचना मिलेगी. इससे वे भी मीडिया को कंट्रोल कर पाएंगे. जिस व्यक्ति के डिवाइस पर ऐसी सूचनाएं मिलती हैं वह उस डिवाइस के लिए, सेटिंग ऐप्लिकेशन में जाकर उन्हें बंद कर सकता है. इसके लिए, Google > Google Cast > रिमोट कंट्रोल की सूचनाएं दिखाएं पर जाएं. (सूचनाओं में, सेटिंग ऐप्लिकेशन का शॉर्टकट शामिल होता है.) ज़्यादा जानकारी के लिए, कास्ट रिमोट कंट्रोल की सूचनाएं देखें.
मिनी कंट्रोलर जोड़ें
Cast डिज़ाइन चेकलिस्ट के मुताबिक, सेंडर ऐप्लिकेशन में एक स्थायी कंट्रोल होना चाहिए. इसे मिनी कंट्रोलर कहा जाता है. यह तब दिखना चाहिए, जब उपयोगकर्ता मौजूदा कॉन्टेंट पेज से सेंडर ऐप्लिकेशन के किसी दूसरे हिस्से पर जाता है. मिनी कंट्रोलर, उपयोगकर्ता को मौजूदा Cast सेशन के बारे में याद दिलाता है. मिनी कंट्रोलर पर टैप करके, उपयोगकर्ता Cast के फ़ुल-स्क्रीन वाले बड़े कंट्रोलर व्यू पर वापस जा सकता है.
यह फ़्रेमवर्क, MiniControllerFragment नाम का एक कस्टम व्यू उपलब्ध कराता है. इसे हर उस गतिविधि की लेआउट फ़ाइल के सबसे नीचे जोड़ा जा सकता है जिसमें आपको मिनी कंट्रोलर दिखाना है.
<fragment
android:id="@+id/castMiniController"
android:layout_width="fill_parent"
android:layout_height="wrap_content"
android:layout_alignParentBottom="true"
android:visibility="gone"
class="com.google.android.gms.cast.framework.media.widget.MiniControllerFragment" />
जब आपका सेंडर ऐप्लिकेशन, वीडियो या ऑडियो की लाइव स्ट्रीम चला रहा होता है, तो एसडीके, मिनी कंट्रोलर में चलाएं/रोकें बटन की जगह, चलाएं/बंद करें बटन अपने-आप दिखाता है.
इस कस्टम व्यू के टाइटल और सबटाइटल के टेक्स्ट का लुक सेट करने और बटन चुनने के लिए, मिनी कंट्रोलर को पसंद के मुताबिक बनाएं देखें.
बड़ा किया गया कंट्रोलर जोड़ना
Google Cast की डिज़ाइन चेकलिस्ट के मुताबिक, सेंडर ऐप्लिकेशन को कास्ट किए जा रहे मीडिया के लिए, बड़ा किया गया कंट्रोलर उपलब्ध कराना ज़रूरी है. बड़ा किया गया कंट्रोलर, मिनी कंट्रोलर का फ़ुल स्क्रीन वर्शन होता है.
Cast SDK, बड़े किए गए कंट्रोलर के लिए एक विजेट उपलब्ध कराता है. इसे ExpandedControllerActivity कहा जाता है.
यह एक ऐब्स्ट्रैक्ट क्लास है, जिसे कास्ट बटन जोड़ने के लिए आपको सबक्लास करना होगा.
सबसे पहले, कास्ट बटन उपलब्ध कराने के लिए, बड़े किए गए कंट्रोलर के लिए एक नई मेन्यू रिसॉर्स फ़ाइल बनाएं:
<menu xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto">
<item
android:id="@+id/media_route_menu_item"
android:title="@string/media_route_menu_title"
app:actionProviderClass="androidx.mediarouter.app.MediaRouteActionProvider"
app:showAsAction="always"/>
</menu>
ExpandedControllerActivity को एक्सटेंड करने वाली नई क्लास बनाएं.
class ExpandedControlsActivity : ExpandedControllerActivity() { override fun onCreateOptionsMenu(menu: Menu): Boolean { super.onCreateOptionsMenu(menu) menuInflater.inflate(R.menu.expanded_controller, menu) CastButtonFactory.setUpMediaRouteButton(this, menu, R.id.media_route_menu_item) return true } }
public class ExpandedControlsActivity extends ExpandedControllerActivity { @Override public boolean onCreateOptionsMenu(Menu menu) { super.onCreateOptionsMenu(menu); getMenuInflater().inflate(R.menu.expanded_controller, menu); CastButtonFactory.setUpMediaRouteButton(this, menu, R.id.media_route_menu_item); return true; } }
अब application टैग में, ऐप्लिकेशन मेनिफ़ेस्ट में अपनी नई गतिविधि का एलान करें:
<application>
...
<activity
android:name=".expandedcontrols.ExpandedControlsActivity"
android:label="@string/app_name"
android:launchMode="singleTask"
android:theme="@style/Theme.CastVideosDark"
android:screenOrientation="portrait"
android:parentActivityName="com.google.sample.cast.refplayer.VideoBrowserActivity">
<intent-filter>
<action android:name="android.intent.action.MAIN"/>
</intent-filter>
</activity>
...
</application>
CastOptionsProvider में बदलाव करें. साथ ही, टारगेट ऐक्टिविटी को अपनी नई ऐक्टिविटी पर सेट करने के लिए, NotificationOptions और CastMediaOptions को बदलें:
override fun getCastOptions(context: Context): CastOptions? { val notificationOptions = NotificationOptions.Builder() .setTargetActivityClassName(ExpandedControlsActivity::class.java.name) .build() val mediaOptions = CastMediaOptions.Builder() .setNotificationOptions(notificationOptions) .setExpandedControllerActivityClassName(ExpandedControlsActivity::class.java.name) .build() return CastOptions.Builder() .setReceiverApplicationId(context.getString(R.string.app_id)) .setCastMediaOptions(mediaOptions) .build() }
public CastOptions getCastOptions(Context context) { NotificationOptions notificationOptions = new NotificationOptions.Builder() .setTargetActivityClassName(ExpandedControlsActivity.class.getName()) .build(); CastMediaOptions mediaOptions = new CastMediaOptions.Builder() .setNotificationOptions(notificationOptions) .setExpandedControllerActivityClassName(ExpandedControlsActivity.class.getName()) .build(); return new CastOptions.Builder() .setReceiverApplicationId(context.getString(R.string.app_id)) .setCastMediaOptions(mediaOptions) .build(); }
रिमोट मीडिया लोड होने पर, अपनी नई गतिविधि दिखाने के लिए, LocalPlayerActivity loadRemoteMedia तरीके को अपडेट करें:
private fun loadRemoteMedia(position: Int, autoPlay: Boolean) { val remoteMediaClient = mCastSession?.remoteMediaClient ?: return remoteMediaClient.registerCallback(object : RemoteMediaClient.Callback() { override fun onStatusUpdated() { val intent = Intent(this@LocalPlayerActivity, ExpandedControlsActivity::class.java) startActivity(intent) remoteMediaClient.unregisterCallback(this) } }) remoteMediaClient.load( MediaLoadRequestData.Builder() .setMediaInfo(mSelectedMedia) .setAutoplay(autoPlay) .setCurrentTime(position.toLong()).build() ) }
private void loadRemoteMedia(int position, boolean autoPlay) { if (mCastSession == null) { return; } final RemoteMediaClient remoteMediaClient = mCastSession.getRemoteMediaClient(); if (remoteMediaClient == null) { return; } remoteMediaClient.registerCallback(new RemoteMediaClient.Callback() { @Override public void onStatusUpdated() { Intent intent = new Intent(LocalPlayerActivity.this, ExpandedControlsActivity.class); startActivity(intent); remoteMediaClient.unregisterCallback(this); } }); remoteMediaClient.load(new MediaLoadRequestData.Builder() .setMediaInfo(mSelectedMedia) .setAutoplay(autoPlay) .setCurrentTime(position).build()); }
जब आपका सेंडर ऐप्लिकेशन, वीडियो या ऑडियो की लाइव स्ट्रीम चला रहा होता है, तब एसडीके, बड़े किए गए कंट्रोलर में चलाएं/रोकें बटन की जगह, चलाएं/बंद करें बटन अपने-आप दिखाता है.
थीम का इस्तेमाल करके, कंट्रोलर के दिखने का तरीका सेट करने, यह चुनने कि कौनसे बटन दिखाने हैं, और कस्टम बटन जोड़ने के लिए, एक्सपैंडेड कंट्रोलर को पसंद के मुताबिक बनाना लेख पढ़ें.
आवाज़ कंट्रोल करें
फ़्रेमवर्क, सेंडर ऐप्लिकेशन के लिए आवाज़ को अपने-आप मैनेज करता है. फ़्रेमवर्क, सेंडर और वेब रिसीवर ऐप्लिकेशन को अपने-आप सिंक करता है, ताकि सेंडर यूज़र इंटरफ़ेस (यूआई) हमेशा वेब रिसीवर की तय की गई आवाज़ को रिपोर्ट करे.
फ़िज़िकल बटन से आवाज़ को कंट्रोल करना
Android पर, वेब रिसीवर पर कास्ट सेशन की आवाज़ को डिफ़ॉल्ट रूप से बदलने के लिए, सेंडर डिवाइस पर मौजूद फ़िज़िकल बटन का इस्तेमाल किया जा सकता है. ऐसा Jelly Bean या इसके बाद के वर्शन का इस्तेमाल करने वाले किसी भी डिवाइस के लिए किया जा सकता है.
Jelly Bean से पहले के वर्शन में, फ़िज़िकल बटन से आवाज़ को कम या ज़्यादा करने की सुविधा
Jelly Bean से पुराने Android डिवाइसों पर, वेब रिसीवर डिवाइस की आवाज़ को कंट्रोल करने के लिए, आवाज़ बटन का इस्तेमाल किया जा सकता है. इसके लिए, भेजने वाले ऐप्लिकेशन को अपनी गतिविधियों में dispatchKeyEvent को बदलना होगा और CastContext.onDispatchVolumeKeyEventBeforeJellyBean() को कॉल करना होगा:
class MyActivity : FragmentActivity() { override fun dispatchKeyEvent(event: KeyEvent): Boolean { return (CastContext.getSharedInstance(this) .onDispatchVolumeKeyEventBeforeJellyBean(event) || super.dispatchKeyEvent(event)) } }
class MyActivity extends FragmentActivity { @Override public boolean dispatchKeyEvent(KeyEvent event) { return CastContext.getSharedInstance(this) .onDispatchVolumeKeyEventBeforeJellyBean(event) || super.dispatchKeyEvent(event); } }
सूचना और लॉक स्क्रीन पर मीडिया कंट्रोल जोड़ना
सिर्फ़ Android पर, Google Cast की डिज़ाइन चेकलिस्ट के मुताबिक, सेंडर ऐप्लिकेशन को सूचना और लॉक स्क्रीन में मीडिया कंट्रोल लागू करने की ज़रूरत होती है. ऐसा तब होता है, जब सेंडर कास्ट कर रहा हो, लेकिन सेंडर ऐप्लिकेशन फ़ोकस में न हो. यह फ़्रेमवर्क,
MediaNotificationService
और
MediaIntentReceiver
उपलब्ध कराता है. इनकी मदद से, सेंडर ऐप्लिकेशन, सूचना और लॉक स्क्रीन में मीडिया कंट्रोल बना सकता है.
MediaNotificationService तब चलता है, जब भेजने वाला व्यक्ति कास्ट कर रहा हो. यह इमेज के थंबनेल के साथ एक सूचना दिखाएगा. साथ ही, कास्ट किए जा रहे मौजूदा आइटम की जानकारी, 'चलाएं'/'रोकें' बटन, और 'बंद करें' बटन दिखाएगा.
MediaIntentReceiver एक BroadcastReceiver है, जो सूचना से उपयोगकर्ता की कार्रवाइयों को मैनेज करता है.
आपका ऐप्लिकेशन, NotificationOptions की मदद से, लॉक स्क्रीन से सूचना और मीडिया कंट्रोल को कॉन्फ़िगर कर सकता है.
आपका ऐप्लिकेशन यह कॉन्फ़िगर कर सकता है कि सूचना में कौनसे कंट्रोल बटन दिखाने हैं. साथ ही, उपयोगकर्ता के सूचना पर टैप करने पर कौनसा Activity खोलना है. अगर कार्रवाइयां साफ़ तौर पर नहीं दी गई हैं, तो डिफ़ॉल्ट वैल्यू, MediaIntentReceiver.ACTION_TOGGLE_PLAYBACK और MediaIntentReceiver.ACTION_STOP_CASTING का इस्तेमाल किया जाएगा.
// Example showing 4 buttons: "rewind", "play/pause", "forward" and "stop casting". val buttonActions: MutableList<String> = ArrayList() buttonActions.add(MediaIntentReceiver.ACTION_REWIND) buttonActions.add(MediaIntentReceiver.ACTION_TOGGLE_PLAYBACK) buttonActions.add(MediaIntentReceiver.ACTION_FORWARD) buttonActions.add(MediaIntentReceiver.ACTION_STOP_CASTING) // Showing "play/pause" and "stop casting" in the compat view of the notification. val compatButtonActionsIndices = intArrayOf(1, 3) // Builds a notification with the above actions. Each tap on the "rewind" and "forward" buttons skips 30 seconds. // Tapping on the notification opens an Activity with class VideoBrowserActivity. val notificationOptions = NotificationOptions.Builder() .setActions(buttonActions, compatButtonActionsIndices) .setSkipStepMs(30 * DateUtils.SECOND_IN_MILLIS) .setTargetActivityClassName(VideoBrowserActivity::class.java.name) .build()
// Example showing 4 buttons: "rewind", "play/pause", "forward" and "stop casting". List<String> buttonActions = new ArrayList<>(); buttonActions.add(MediaIntentReceiver.ACTION_REWIND); buttonActions.add(MediaIntentReceiver.ACTION_TOGGLE_PLAYBACK); buttonActions.add(MediaIntentReceiver.ACTION_FORWARD); buttonActions.add(MediaIntentReceiver.ACTION_STOP_CASTING); // Showing "play/pause" and "stop casting" in the compat view of the notification. int[] compatButtonActionsIndices = new int[]{1, 3}; // Builds a notification with the above actions. Each tap on the "rewind" and "forward" buttons skips 30 seconds. // Tapping on the notification opens an Activity with class VideoBrowserActivity. NotificationOptions notificationOptions = new NotificationOptions.Builder() .setActions(buttonActions, compatButtonActionsIndices) .setSkipStepMs(30 * DateUtils.SECOND_IN_MILLIS) .setTargetActivityClassName(VideoBrowserActivity.class.getName()) .build();
सूचना और लॉक स्क्रीन से मीडिया कंट्रोल दिखाने की सुविधा, डिफ़ॉल्ट रूप से चालू होती है. इसे बंद करने के लिए, CastMediaOptions.Builder में null के साथ setNotificationOptions को कॉल करें.
फ़िलहाल, लॉक स्क्रीन पर सूचनाएं दिखाने की सुविधा तब तक चालू रहती है, जब तक सूचनाएं दिखाने की सुविधा चालू रहती है.
// ... continue with the NotificationOptions built above val mediaOptions = CastMediaOptions.Builder() .setNotificationOptions(notificationOptions) .build() val castOptions: CastOptions = Builder() .setReceiverApplicationId(context.getString(R.string.app_id)) .setCastMediaOptions(mediaOptions) .build()
// ... continue with the NotificationOptions built above CastMediaOptions mediaOptions = new CastMediaOptions.Builder() .setNotificationOptions(notificationOptions) .build(); CastOptions castOptions = new CastOptions.Builder() .setReceiverApplicationId(context.getString(R.string.app_id)) .setCastMediaOptions(mediaOptions) .build();
जब आपका सेंडर ऐप्लिकेशन कोई वीडियो या ऑडियो लाइव स्ट्रीम चला रहा होता है, तो SDK टूल, सूचना कंट्रोल पर चलाएं/रोकें बटन की जगह, अपने-आप चलाएं/बंद करें बटन दिखाता है. हालांकि, लॉक स्क्रीन कंट्रोल पर ऐसा नहीं होता.
ध्यान दें: Lollipop से पहले के डिवाइसों पर लॉक स्क्रीन कंट्रोल दिखाने के लिए, RemoteMediaClient आपकी ओर से ऑडियो फ़ोकस का अनुरोध अपने-आप करेगा.
गड़बड़ियां ठीक करना
यह ज़रूरी है कि सेंडर ऐप्लिकेशन, गड़बड़ी के सभी कॉलबैक को हैंडल करें. साथ ही, Cast की लाइफ़ साइकल के हर चरण के लिए सबसे सही जवाब तय करें. ऐप्लिकेशन, उपयोगकर्ता को गड़बड़ी के डायलॉग दिखा सकता है या वेब रिसीवर से कनेक्शन को खत्म कर सकता है.