टीवी पर चलने वाले मीडिया ऐप्लिकेशन के लिए ज़रूरी है कि वह लोगों को कॉन्टेंट ब्राउज़ करने, चुनें, और कॉन्टेंट चलाना शुरू करें. कॉन्टेंट ब्राउज़ करने का अनुभव सरल और सहज होने के साथ-साथ दिखने में आकर्षक और दिलचस्प होनी चाहिए.
इस गाइड में androidx.leanback लाइब्रेरी से दी गई क्लास को इस्तेमाल करने के बारे में बताया गया है का इस्तेमाल करें.
ध्यान दें: लागू करने के उदाहरण में, यहां दिए गए उदाहरण का इस्तेमाल किया गया है
BrowseSupportFragment
बंद किए गए BrowseFragment
के बजाय
क्लास. BrowseSupportFragment
, AndroidX की अवधि को बढ़ाता है
Fragment
क्लास,
इससे सभी डिवाइसों और Android वर्शन पर एक जैसा काम करने में मदद मिलती है.
मीडिया ब्राउज़ करने का लेआउट बनाना
BrowseSupportFragment
Leanback यूज़र इंटरफ़ेस (यूआई) टूलकिट में क्लास
से मीडिया आइटम की श्रेणियों और पंक्तियों को ब्राउज़ करने के लिए एक प्राइमरी लेआउट बनाया जा सकता है.
कोड का कम से कम मान. नीचे दिए गए उदाहरण में ऐसा लेआउट बनाने का तरीका बताया गया है, जिसमें
BrowseSupportFragment
ऑब्जेक्ट:
<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android" android:id="@+id/main_frame" android:layout_width="match_parent" android:layout_height="match_parent"> <fragment android:name="com.example.android.tvleanback.ui.MainFragment" android:id="@+id/main_browse_fragment" android:layout_width="match_parent" android:layout_height="match_parent" /> </FrameLayout>
ऐप्लिकेशन की मुख्य गतिविधि यह व्यू सेट करती है, जैसा कि इस उदाहरण में दिखाया गया है:
Kotlin
class MainActivity : Activity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.main) } ...
Java
public class MainActivity extends Activity { @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.main); } ...
BrowseSupportFragment
वाले तरीके से व्यू को
वीडियो डेटा और यूज़र इंटरफ़ेस (यूआई) एलिमेंट के साथ-साथ, लेआउट पैरामीटर, जैसे कि आइकॉन, टाइटल, और
श्रेणी हेडर सक्षम हैं या नहीं.
BrowseSupportFragment
को लागू करने वाले ऐप्लिकेशन की सब-क्लास
मेथड, यूज़र इंटरफ़ेस (यूआई) एलिमेंट पर उपयोगकर्ता की कार्रवाइयों के लिए, इवेंट लिसनर सेट अप करती हैं और उन्हें तैयार करती हैं
बैकग्राउंड मैनेजर के बारे में जानें, जैसा कि नीचे दिए गए उदाहरण में दिखाया गया है:
Kotlin
class MainFragment : BrowseSupportFragment(), LoaderManager.LoaderCallbacks<HashMap<String, List<Movie>>> { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) loadVideoData() } override fun onViewCreated(view: View, savedInstanceState: Bundle?) { super.onViewCreated(view, savedInstanceState) prepareBackgroundManager() setupUIElements() setupEventListeners() } ... private fun prepareBackgroundManager() { backgroundManager = BackgroundManager.getInstance(activity).apply { attach(activity?.window) } defaultBackground = resources.getDrawable(R.drawable.default_background) metrics = DisplayMetrics() activity?.windowManager?.defaultDisplay?.getMetrics(metrics) } private fun setupUIElements() { badgeDrawable = resources.getDrawable(R.drawable.videos_by_google_banner) // Badge, when set, takes precedent over title title = getString(R.string.browse_title) headersState = BrowseSupportFragment.HEADERS_ENABLED isHeadersTransitionOnBackEnabled = true // Set header background color brandColor = ContextCompat.getColor(requireContext(), R.color.fastlane_background) // Set search icon color searchAffordanceColor = ContextCompat.getColor(requireContext(), R.color.search_opaque) } private fun loadVideoData() { VideoProvider.setContext(activity) videosUrl = getString(R.string.catalog_url) loaderManager.initLoader(0, null, this) } private fun setupEventListeners() { setOnSearchClickedListener { Intent(activity, SearchActivity::class.java).also { intent -> startActivity(intent) } } onItemViewClickedListener = ItemViewClickedListener() onItemViewSelectedListener = ItemViewSelectedListener() } ...
Java
public class MainFragment extends BrowseSupportFragment implements LoaderManager.LoaderCallbacks<HashMap<String, List<Movie>>> { } ... @Override public void onCreate(@Nullable Bundle savedInstanceState) { super.onCreate(savedInstanceState); loadVideoData(); } @Override public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) { super.onViewCreated(view, savedInstanceState); prepareBackgroundManager(); setupUIElements(); setupEventListeners(); } ... private void prepareBackgroundManager() { backgroundManager = BackgroundManager.getInstance(getActivity()); backgroundManager.attach(getActivity().getWindow()); defaultBackground = getResources() .getDrawable(R.drawable.default_background); metrics = new DisplayMetrics(); getActivity().getWindowManager().getDefaultDisplay().getMetrics(metrics); } private void setupUIElements() { setBadgeDrawable(getActivity().getResources() .getDrawable(R.drawable.videos_by_google_banner)); // Badge, when set, takes precedent over title setTitle(getString(R.string.browse_title)); setHeadersState(HEADERS_ENABLED); setHeadersTransitionOnBackEnabled(true); // Set header background color setBrandColor(ContextCompat.getColor(requireContext(), R.color.fastlane_background)); // Set search icon color setSearchAffordanceColor(ContextCompat.getColor(requireContext(), R.color.search_opaque)); } private void loadVideoData() { VideoProvider.setContext(getActivity()); videosUrl = getString(R.string.catalog_url); getLoaderManager().initLoader(0, null, this); } private void setupEventListeners() { setOnSearchClickedListener(new View.OnClickListener() { @Override public void onClick(View view) { Intent intent = new Intent(getActivity(), SearchActivity.class); startActivity(intent); } }); setOnItemViewClickedListener(new ItemViewClickedListener()); setOnItemViewSelectedListener(new ItemViewSelectedListener()); } ...
यूज़र इंटरफ़ेस (यूआई) एलिमेंट सेट करना
पिछले सैंपल में, निजी तरीके setupUIElements()
में कई
BrowseSupportFragment
मीडिया कैटलॉग ब्राउज़र को स्टाइल करने के तरीके:
setBadgeDrawable()
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है बताए गए ड्रॉ करने लायक संसाधन को ब्राउज़ फ़्रैगमेंट के ऊपरी दाएं कोने में रखता है, जैसे कि पहली और दूसरी इमेज में दिखाया गया है. यह तरीका, टाइटल स्ट्रिंग को ड्रॉ करने लायक संसाधन, अगरsetTitle()
को भी कॉल किया जाता है. ड्रॉ करने लायक संसाधन 52 dp होना चाहिए बड़ा.setTitle()
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है ब्राउज़ फ़्रैगमेंट के ऊपरी दाएं कोने में टाइटल स्ट्रिंग सेट करता है, बशर्तेsetBadgeDrawable()
को कॉल किया गया है.setHeadersState()
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है औरsetHeadersTransitionOnBackEnabled()
हेडर को छिपाते या बंद करते हैं. ज़्यादा जानकारी के लिए, हेडर छिपाएं या बंद करें सेक्शन देखें.setBrandColor()
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है ब्राउज़ फ़्रैगमेंट में यूज़र इंटरफ़ेस (यूआई) एलिमेंट के लिए बैकग्राउंड का रंग सेट करता है, खास तौर पर हेडर सेक्शन के बैकग्राउंड का रंग, और रंग की वैल्यू तय की गई है.setSearchAffordanceColor()
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है दिए गए रंग मान के साथ खोज आइकॉन का रंग सेट करता है. खोज का आइकॉन ब्राउज़ फ़्रैगमेंट के ऊपरी बाएं कोने में दिखाई देता है, जैसा कि 1 और 2 में दिखाया गया है.
हेडर व्यू को पसंद के मुताबिक बनाना
पहली इमेज में दिखाए गए ब्राउज़ फ़्रैगमेंट में वीडियो कैटगरी के नाम दिखाए गए हैं, जो टेक्स्ट व्यू में वीडियो डेटाबेस में लाइन हेडर होते हैं. आपके पास यह चुनने का विकल्प भी है कि हेडर का इस्तेमाल करें. इन सेक्शन में, में ऐसा इमेज व्यू शामिल करें जो कैटगरी के नाम के बगल में आइकॉन दिखाता हो, जैसा कि दूसरी इमेज में दिखाया गया है.
लाइन हेडर का लेआउट इस तरह से तय किया गया है:
<?xml version="1.0" encoding="utf-8"?> <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" android:orientation="horizontal" android:layout_width="match_parent" android:layout_height="match_parent"> <ImageView android:id="@+id/header_icon" android:layout_width="32dp" android:layout_height="32dp" /> <TextView android:id="@+id/header_label" android:layout_marginTop="6dp" android:layout_width="wrap_content" android:layout_height="wrap_content" /> </LinearLayout>
Presenter
का इस्तेमाल करें और
व्यू होल्डर को बनाने, बाइंड करने, और उसे हटाने के लिए ऐब्स्ट्रैक्ट तरीके. नीचे दिए गए
उदाहरण में व्यूहोल्डर को दो व्यू से जोड़ने का तरीका बताया गया है,
ImageView
और TextView
.
Kotlin
class IconHeaderItemPresenter : Presenter() { override fun onCreateViewHolder(viewGroup: ViewGroup): Presenter.ViewHolder { val view = LayoutInflater.from(viewGroup.context).run { inflate(R.layout.icon_header_item, null) } return Presenter.ViewHolder(view) } override fun onBindViewHolder(viewHolder: Presenter.ViewHolder, o: Any) { val headerItem = (o as ListRow).headerItem val rootView = viewHolder.view rootView.findViewById<ImageView>(R.id.header_icon).apply { rootView.resources.getDrawable(R.drawable.ic_action_video, null).also { icon -> setImageDrawable(icon) } } rootView.findViewById<TextView>(R.id.header_label).apply { text = headerItem.name } } override fun onUnbindViewHolder(viewHolder: Presenter.ViewHolder) { // no-op } }
Java
public class IconHeaderItemPresenter extends Presenter { @Override public ViewHolder onCreateViewHolder(ViewGroup viewGroup) { LayoutInflater inflater = LayoutInflater.from(viewGroup.getContext()); View view = inflater.inflate(R.layout.icon_header_item, null); return new ViewHolder(view); } @Override public void onBindViewHolder(ViewHolder viewHolder, Object o) { HeaderItem headerItem = ((ListRow) o).getHeaderItem(); View rootView = viewHolder.view; ImageView iconView = (ImageView) rootView.findViewById(R.id.header_icon); Drawable icon = rootView.getResources().getDrawable(R.drawable.ic_action_video, null); iconView.setImageDrawable(icon); TextView label = (TextView) rootView.findViewById(R.id.header_label); label.setText(headerItem.getName()); } @Override public void onUnbindViewHolder(ViewHolder viewHolder) { // no-op } }
आपके हेडर फ़ोकस करने लायक होने चाहिए, ताकि डी-पैड का इस्तेमाल इन कामों के लिए किया जा सके तो उन्हें स्क्रोल करके देखें. इसे मैनेज करने के दो तरीके हैं:
- अपने व्यू को
onBindViewHolder()
में फ़ोकस करने लायक बनाएं:Kotlin
override fun onBindViewHolder(viewHolder: Presenter.ViewHolder, o: Any) { val headerItem = (o as ListRow).headerItem val rootView = viewHolder.view rootView.focusable = View.FOCUSABLE // ... }
Java
@Override public void onBindViewHolder(ViewHolder viewHolder, Object o) { HeaderItem headerItem = ((ListRow) o).getHeaderItem(); View rootView = viewHolder.view; rootView.setFocusable(View.FOCUSABLE) // Allows the D-Pad to navigate to this header item // ... }
- अपने लेआउट को फ़ोकस करने लायक बनाएं:
<?xml version="1.0" encoding="utf-8"?> <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" ... android:focusable="true">
आखिर में, BrowseSupportFragment
लागू करने में, जो
कैटलॉग ब्राउज़र, setHeaderPresenterSelector()
का इस्तेमाल करें
का तरीका कैसे सेट करें, जैसा कि नीचे दिए गए उदाहरण में दिखाया गया है.
Kotlin
setHeaderPresenterSelector(object : PresenterSelector() { override fun getPresenter(o: Any): Presenter { return IconHeaderItemPresenter() } })
Java
setHeaderPresenterSelector(new PresenterSelector() { @Override public Presenter getPresenter(Object o) { return new IconHeaderItemPresenter(); } });
एक पूरे उदाहरण के लिए, देखें Leanback सैंपल ऐप्लिकेशन को अपनाएं.
हेडर छिपाएं या बंद करें
कभी-कभी आप पंक्ति के हेडर नहीं दिखाना चाहते हैं. जैसे, जब हेडर की संख्या ज़रूरत के मुताबिक नहीं होती है
कैटगरी के हिसाब से स्क्रोल करने के लिए, सूची को स्क्रोल करना ज़रूरी है. BrowseSupportFragment.setHeadersState()
पर कॉल करें
फ़्रैगमेंट के onActivityCreated()
के दौरान का तरीका
का तरीका बताया गया है. setHeadersState()
तरीका, नीचे दिए गए विकल्पों में से किसी एक के मुताबिक, ब्राउज़ फ़्रैगमेंट में हेडर की शुरुआती स्थिति सेट करता है
पैरामीटर के तौर पर कॉन्सटेंट:
HEADERS_ENABLED
: जब ब्राउज़ फ़्रैगमेंट गतिविधि बनाई जाती है, तो हेडर चालू हो जाते हैं और डिफ़ॉल्ट. हेडर, इस पेज पर पहली और दूसरी इमेज के हिसाब से दिखते हैं.HEADERS_HIDDEN
: जब ब्राउज़ फ़्रैगमेंट गतिविधि बनाई जाती है, तो हेडर डिफ़ॉल्ट रूप से चालू रहते हैं और छिपाए जाते हैं. स्क्रीन का हेडर सेक्शन छोटा किया गया है, जैसा कि में दिखाया गया है में कोई फ़िगर कार्ड व्यू दें. कॉन्टेंट बनाने हेडर के छोटे किए गए सेक्शन को बड़ा करने के लिए, उपयोगकर्ता उसे चुन सकता है.HEADERS_DISABLED
: जब ब्राउज़ फ़्रैगमेंट गतिविधि बनाई जाती है, तो हेडर डिफ़ॉल्ट रूप से बंद रहते हैं और कभी प्रदर्शित नहीं किया गया.
अगर HEADERS_ENABLED
या HEADERS_HIDDEN
सेट है, तो कॉल किया जा सकता है
setHeadersTransitionOnBackEnabled()
का इस्तेमाल करें. यह इसकी मदद से चालू करता है
अगर इस तरीके को कॉल नहीं किया जाता है, तो डिफ़ॉल्ट तौर पर सेट हो जाएगा. पीठ की गतिविधि खुद मैनेज करने के लिए,
setHeadersTransitionOnBackEnabled()
के लिए false
पास करें
और अपनी बैक स्टैक हैंडलिंग को खुद लागू करें.
मीडिया की सूचियां दिखाएं
BrowseSupportFragment
क्लास की मदद से
ब्राउज़ किए जा सकने वाले मीडिया कॉन्टेंट की कैटगरी और मीडिया आइटम को परिभाषित करें और दिखाएं
अडैप्टर और प्रज़ेंटर का इस्तेमाल करने वाला मीडिया कैटलॉग. अडैप्टर आपको कनेक्ट करने देते हैं
उन स्थानीय या ऑनलाइन डेटा सोर्स को ऐक्सेस करना होगा जिनमें आपके मीडिया कैटलॉग की जानकारी शामिल है.
अडैप्टर, प्रज़ेंटर का इस्तेमाल करके व्यू बनाते हैं और डेटा को इन व्यू से बाइंड करते हैं
स्क्रीन पर कोई आइटम दिखा रहा है.
उदाहरण के तौर पर दिया गया यह कोड, स्ट्रिंग डेटा दिखाने के लिए Presenter
को लागू करता है:
Kotlin
private const val TAG = "StringPresenter" class StringPresenter : Presenter() { override fun onCreateViewHolder(parent: ViewGroup): Presenter.ViewHolder { val textView = TextView(parent.context).apply { isFocusable = true isFocusableInTouchMode = true background = parent.resources.getDrawable(R.drawable.text_bg) } return Presenter.ViewHolder(textView) } override fun onBindViewHolder(viewHolder: Presenter.ViewHolder, item: Any) { (viewHolder.view as TextView).text = item.toString() } override fun onUnbindViewHolder(viewHolder: Presenter.ViewHolder) { // no op } }
Java
public class StringPresenter extends Presenter { private static final String TAG = "StringPresenter"; public ViewHolder onCreateViewHolder(ViewGroup parent) { TextView textView = new TextView(parent.getContext()); textView.setFocusable(true); textView.setFocusableInTouchMode(true); textView.setBackground( parent.getResources().getDrawable(R.drawable.text_bg)); return new ViewHolder(textView); } public void onBindViewHolder(ViewHolder viewHolder, Object item) { ((TextView) viewHolder.view).setText(item.toString()); } public void onUnbindViewHolder(ViewHolder viewHolder) { // no op } }
अपने मीडिया आइटम के लिए प्रज़ेंटर क्लास बनाने के बाद,
अडैप्टर को जोड़कर इसे BrowseSupportFragment
से अटैच करें
के ज़रिए ब्राउज़ किया जा सकता है. यह उदाहरण
कोड से पता चलता है कि कैटगरी और आइटम दिखाने के लिए, अडैप्टर कैसे बनाया जाता है
में दिखाई गई StringPresenter
क्लास का इस्तेमाल करके उन कैटगरी में
पिछले कोड का उदाहरण:
Kotlin
private const val NUM_ROWS = 4 ... private lateinit var rowsAdapter: ArrayObjectAdapter override fun onCreate(savedInstanceState: Bundle?) { ... buildRowsAdapter() } private fun buildRowsAdapter() { rowsAdapter = ArrayObjectAdapter(ListRowPresenter()) for (i in 0 until NUM_ROWS) { val listRowAdapter = ArrayObjectAdapter(StringPresenter()).apply { add("Media Item 1") add("Media Item 2") add("Media Item 3") } HeaderItem(i.toLong(), "Category $i").also { header -> rowsAdapter.add(ListRow(header, listRowAdapter)) } } browseSupportFragment.adapter = rowsAdapter }
Java
private ArrayObjectAdapter rowsAdapter; private static final int NUM_ROWS = 4; @Override protected void onCreate(Bundle savedInstanceState) { ... buildRowsAdapter(); } private void buildRowsAdapter() { rowsAdapter = new ArrayObjectAdapter(new ListRowPresenter()); for (int i = 0; i < NUM_ROWS; ++i) { ArrayObjectAdapter listRowAdapter = new ArrayObjectAdapter( new StringPresenter()); listRowAdapter.add("Media Item 1"); listRowAdapter.add("Media Item 2"); listRowAdapter.add("Media Item 3"); HeaderItem header = new HeaderItem(i, "Category " + i); rowsAdapter.add(new ListRow(header, listRowAdapter)); } browseSupportFragment.setAdapter(rowsAdapter); }
इस उदाहरण में दिखाया गया है कि अडैप्टर को स्टैटिक तरीके से लागू किया गया है. सामान्य मीडिया ब्राउज़िंग ऐप्लिकेशन किसी ऑनलाइन डेटाबेस या वेब सेवा के डेटा का इस्तेमाल करता है. ऐसे ब्राउज़िंग ऐप्लिकेशन के उदाहरण के लिए जो वेब से मिले डेटा का उपयोग करता है, तो Leanback सैंपल ऐप्लिकेशन को अपनाएं.
बैकग्राउंड अपडेट करें
टीवी पर मीडिया ब्राउज़िंग ऐप्लिकेशन में विज़ुअल पसंद जोड़ने के लिए, बैकग्राउंड को अपडेट किया जा सकता है इमेज, जिसमें उपयोगकर्ता कॉन्टेंट ब्राउज़ कर रहे हैं. इस तकनीक से आपके ऐप्लिकेशन के साथ ज़्यादा इंटरैक्शन हो सकता है और मज़ेदार वीडियो बनाने के लिए करें.
Leanback यूज़र इंटरफ़ेस (यूआई) टूलकिट एक BackgroundManager
क्लास का इस्तेमाल करें. नीचे दिए गए उदाहरण में,
टीवी ऐप्लिकेशन की गतिविधि में बैकग्राउंड अपडेट करने का आसान तरीक़ा बनाएँ:
Kotlin
protected fun updateBackground(drawable: Drawable) { BackgroundManager.getInstance(this).drawable = drawable }
Java
protected void updateBackground(Drawable drawable) { BackgroundManager.getInstance(this).setDrawable(drawable); }
उपयोगकर्ता के नेविगेट करने पर, कई मीडिया-ब्राउज़िंग ऐप्लिकेशन बैकग्राउंड को अपने-आप अपडेट कर देते हैं
के ज़रिए प्रमोशन किया जा सकता है. ऐसा करने के लिए, अपने-आप लिसनर सेट अप किया जा सकता है
उपयोगकर्ता के मौजूदा चुनाव के आधार पर बैकग्राउंड अपडेट करें. नीचे दिए गए उदाहरण में बताया गया है कि
OnItemViewSelectedListener
क्लास सेट अप करने के लिए
चुने गए इवेंट को कैच करें और बैकग्राउंड अपडेट करें:
Kotlin
protected fun clearBackground() { BackgroundManager.getInstance(this).drawable = defaultBackground } protected fun getDefaultItemViewSelectedListener(): OnItemViewSelectedListener = OnItemViewSelectedListener { _, item, _, _ -> if (item is Movie) { item.getBackdropDrawable().also { background -> updateBackground(background) } } else { clearBackground() } }
Java
protected void clearBackground() { BackgroundManager.getInstance(this).setDrawable(defaultBackground); } protected OnItemViewSelectedListener getDefaultItemViewSelectedListener() { return new OnItemViewSelectedListener() { @Override public void onItemSelected(Presenter.ViewHolder itemViewHolder, Object item, RowPresenter.ViewHolder rowViewHolder, Row row) { if (item instanceof Movie ) { Drawable background = ((Movie)item).getBackdropDrawable(); updateBackground(background); } else { clearBackground(); } } }; }
ध्यान दें: पिछला लागू करने का तरीका, नीचे दिए गए कामों के मकसद से एक आसान उदाहरण है चित्र. अपने ऐप्लिकेशन में इस फ़ंक्शन को बनाते समय, बेहतर परफ़ॉर्मेंस के लिए, बैकग्राउंड में अपडेट करने की कार्रवाई को एक अलग थ्रेड में करें. साथ ही, अगर आपको आइटम को स्क्रोल करने वाले उपयोगकर्ताओं के जवाब में, बैकग्राउंड को अपडेट करने की योजना है. बैकग्राउंड की इमेज को अपडेट होने में लगने वाला समय, जब तक उपयोगकर्ता किसी आइटम को सेटल कर नहीं लेता. इस तकनीक से, Google Photos के बैकग्राउंड में इमेज अपडेट करने की सुविधा का बहुत ज़्यादा समय तक इस्तेमाल करना.