सूची बनाना

खास जानकारी

वेब रिसीवर SDK टूल की मदद से, डिफ़ॉल्ट सूची को SDK टूल इसका इस्तेमाल कर रहा है QueueData और QueueManager इसके अलावा, कस्टम सूची का इस्तेमाल करके लागू करना cast.framework.QueueBase और इसका इस्तेमाल करके QueueManager अपडेट देखें.

सूची बनाने वाला एपीआई, ऐप्लिकेशन को ये सुविधाएं:

  • Google और पार्टनर की क्लाउड सूची को लागू करने के लिए बाहरी लोगों से मदद सेव की गई और बनाई गई सूची, सीधे कास्ट डिवाइसों पर लोड की जा सकती है.
  • ऐसे तरीके जो लोड होने के बजाय सूची में मौजूद आइटम को पेजों में बांटने की सुविधा देते हैं सब कुछ एक ही जगह पर पाएं.
  • नए मैसेज के लिए सहायता. जैसे, अगले आइटम पर जाना, पिछले आइटम पर जाना, आइटम की विंडो फ़ेच कर रहा हो. साथ ही, उससे जुड़ी मीडिया की जानकारी फ़ेच कर रहा था सूची में मौजूद आइटम का सेट.
  • कॉन्टेंट बनाने QueueManager का इस्तेमाल, सूची में आइटम जोड़ने, हटाने, और उन्हें अपडेट करने के लिए किया जा सकता है.

डिफ़ॉल्ट सूची

वेब प्राप्तकर्ता SDK, फ़ॉर्म में बॉक्स के बाहर सीमित सूची में समर्थन देता है डिफ़ॉल्ट सूची बनाएं.

डिफ़ॉल्ट सूची का इस्तेमाल करने के लिए, queueData सेंडर-साइड लोड के LoadRequestData में या लोकल लोडिंग का अनुरोध भेजें इसका उपयोग कर रहा है PlayerManager#load. मीडिया लोड हो रहा है भी देखें.

रिसीवर की ओर से, सूची में बदलाव करने के लिए QueueManager एक बार मीडिया लोड हो जाने के बाद.

पसंद के मुताबिक सूची

अगर डिफ़ॉल्ट सूची, सूची बनाने की वह सुविधा नहीं देती है जो आपके ऐप्लिकेशन के लिए, पसंद के मुताबिक सूची बनाने की सुविधा उपलब्ध है. क्षमता और ज़रूरत के हिसाब से सुविधाएं मिलती हैं.

ऐप्लिकेशन डेवलपर, cast.framework.QueueBase.

यहां एक सामान्य सूची का उदाहरण दिया गया है, जिसमें initialize पहले कॉल को ओवरराइड कर दिया जाता है. इसके बाद, सूची में मौजूद टास्क के साथ सूची की सूची कास्ट डिवाइस के लिए उपलब्ध कराई जाती हैं.

मीडिया लोड हो रहा है भी देखें.

// Creates a simple queue with a combination of contents.
const DemoQueue = class extends cast.framework.QueueBase {
 constructor() {
   super();

   /**
    * List of media urls.
    * @private @const {!Array<string>}
    */
   this.myMediaUrls_ = [...];
 }
 /**
  * Provide a list of items.
  * @param {!cast.framework.messages.LoadRequestData} loadRequestData
  * @return {!cast.framework.messages.QueueData}
  */
 initialize(loadRequestData) {
   const items = [];
   for (const mediaUrl of this.myMediaUrls_) {
     const item = new cast.framework.messages.QueueItem();
     item.media = new cast.framework.messages.MediaInformation();
     item.media.contentId = mediaUrl;
     items.push(item);
   }
   let queueData = loadRequestData.queueData;
   // Create a new queue with media from the load request if one doesn't exist.
   if (!queueData) {
     queueData = new cast.framework.messages.QueueData();
     queueData.name = 'Your Queue Name';
     queueData.description = 'Your Queue Description';
     queueData.items = items;
     // Start with the first item in the playlist.
     queueData.startIndex = 0;
     // Start from 10 seconds into the first item.
     queueData.currentTime = 10;
   }
   return queueData;
 }
};

इस उदाहरण में, initialize कॉल का अनुरोध, सेवा देने वाली कंपनी के QueueBase कंस्ट्रक्टर कॉल. हालांकि, क्लाउड सूची लागू करने के लिए, कस्टम वेब पाने वाला लॉजिक, आइटम को बाहर से फ़ेच कर सकता है और फिर उन्हें कॉल शुरू करें.

सूची बनाने वाले एपीआई को बेहतर तरीके से इस्तेमाल करने के लिए, यहां डेमो दिया गया है वह सूची जो लागू करने के लिए सबसे QueueBase क्लास.

const DemoQueue = class extends cast.framework.QueueBase {
 constructor() {
   /** @private {} */
   super();
   YourServer.onSomeEvent = this.updateEntireQueue_;
 }

 /**
  * Initializes the queue.
  * @param {!cast.framework.messages.LoadRequestData} loadRequestData
  * @return {!cast.framework.messages.QueueData}
  */
 initialize(loadRequestData) {
   let queueData = loadRequestData.queueData;
   // Create a new queue with media from the load request if one doesn't exist.
   if (!queueData) {
     queueData = new cast.framework.messages.QueueData();
     queueData.name = 'Your Queue Name';
     queueData.description = 'Your Queue Description';
     // Put the first set of items into the queue
     const items = this.nextItems();
     queueData.items = items;
     // Start with the first item in the playlist.
     queueData.startIndex = 0;
     // Start from 10 seconds into the first item.
     queueData.currentTime = 10;
   }
   return queueData;
 }

 /**
  * Picks a set of items from remote server after the reference item id and
  * return as the next items to be inserted into the queue. When
  * referenceItemId is omitted, items are simply appended to the end of the
  * queue.
  * @param {number} referenceItemId
  * @return {!Array<cast.framework.QueueItem>}
  */
 nextItems(referenceItemId) {
   // Assume your media has a itemId and the media url
   return this.constructQueueList_(YourServer.getNextMedias(referenceItemId));
 }

 /**
  * Picks a set of items from remote server before the reference item id and
  * return as the items to be inserted into the queue. When
  * referenceItemId is omitted, items are simply appended to beginning of the
  * queue.
  * @param {number} referenceItemId
  * @return {!Array<cast.framework.QueueItem>}
  */
 prevItems(referenceItemId) {
   return this.constructQueueList_(YourServer.getPrevMedias(referenceItemId));
 }

 /**
  * Constructs a list of QueueItems based on the media information containing
  * the item id and the media url.
  * @param {number} referenceItemId
  * @return {!Array<cast.framework.QueueItem>}
  */
 constructQueueList_(medias) {
   const items = [];
   for (media of medias) {
     const item = new cast.framework.messages.QueueItem(media.itemId);
     item.media = new cast.framework.messages.MediaInformation();
     item.media.contentId = media.url;
     items.push(item);
   }
   return items;
 }

 /**
  * Logs the currently playing item.
  * @param {number} itemId The unique id for the item.
  * @export
  */
 onCurrentItemIdChanged(itemId) {
   console.log('We are now playing video ' + itemId);
   YourServer.trackUsage(itemId);
 }
};

ऊपर दिए गए उदाहरण में, YourServer आपका क्लाउड क्यू सर्वर है और इसमें लॉजिक मीडिया आइटम को फ़ेच करने का तरीका जानें.

QueueBase का इस्तेमाल करने के लिए -लागू की गई सूची बनाने की सुविधा का इस्तेमाल करने पर, सूची बनाने की सुविधा CastReceiverContext:

const context = cast.framework.CastReceiverContext.getInstance();
context.start({queue: new DemoQueue()});

सूची मैनेज करना

कॉन्टेंट बनाने QueueManager इससे डेवलपर को सूची बनाने की प्रोसेस बेहतर बनाने में मदद मिलती है. इसके लिए, सूची में मौजूद आइटम की सूची और सूची में मौजूद चल रहा आइटम. इसकी मदद से, किसी प्रॉपर्टी को जोड़ने, हटाने, और सूची में जोड़े गए आइटम को अपडेट करें. नीचे दिया गया स्निपेट दिखाता है कि का इंस्टेंस QueueManager:

const context = cast.framework.CastReceiverContext.getInstance();
const queueManager = context.getPlayerManager().getQueueManager();

डिफ़ॉल्ट सूची मैनेज करें

शुरुआती सूची लोड हो जाने के बाद, QueueManager का इस्तेमाल मौजूदा आइटम को वापस लाने, उसे वापस पाने जैसी कार्रवाइयों के लिए किया जा सकता है सूची के सभी आइटम चुनें और इसका इस्तेमाल करके सूची के आइटम अपडेट करें insertItems, removeItems, और updateItems.

पसंद के मुताबिक सूची मैनेज करना

यहां कस्टम सूची को लागू करने का एक उदाहरण दिया गया है, जिसमें इंसर्शन का इस्तेमाल किया गया है और हटाने के तरीकों का इस्तेमाल करें. इस उदाहरण में, updateItems जहां डेवलपर मौजूदा सूची की सूची में मौजूद आइटम में बदलाव कर सकते हैं, जैसे कि विज्ञापन के लिए ब्रेक हटाने होंगे.

const DemoQueue = class extends cast.framework.QueueBase {
  constructor() {
    super();

    /** @private @const {!cast.framework.QueueManager} */
    this.queueManager_ = context.getPlayerManager().getQueueManager();
  }

  /**
   * Provide a list of items.
   * @param {!cast.framework.messages.LoadRequestData} loadRequestData
   * @return {!cast.framework.messages.QueueData}
   */
  initialize(loadRequestData) {
    // Your normal initialization; see examples above.
    return queueData;
  }

  /** Inserts items to the queue. */
  onSomeEventTriggeringInsertionToQueue() {
    const twoMoreUrls = ['http://url1', 'http://url2'];
    const items = [];
    for (const mediaUrl of twoMoreUrls) {
      const item = new cast.framework.QueueItem();
      item.media = new cast.framework.messages.MediaInformation();
      item.media.contentId = mediaUrl;
      items.push(item);
    }
    // Insert two more items after the current playing item.
    const allItems = this.queueManager_.getItems();
    const currentItemIndex = this.queueManager_.getCurrentItemIndex();
    const nextItemIndex = currentItemIndex + 1;
    let insertBefore = undefined;
    if (currentItemIndex >= 0 &&
        currentItemIndex < allItems.length - 1) {
      insertBefore = allItems[nextItemIndex].itemId;
    }
    this.queueManager_.insertItems(items, insertBefore);
  }

  /** Removes a particular item from the queue. */
  onSomeEventTriggeringRemovalFromQueue() {
    this.queueManager_.removeItems([2]);
  }

  /** Removes all the ads from all the items across the entire queue. */
  onUserBoughtAdFreeVersion() {
    const items = this.queueManager_.getItems();
    this.queueManager_.updateItems(items.map(item => {
      item.media.breaks = undefined;
      return item;
    }));
  }
};

इनकमिंग और आउटगोइंग मैसेज

सबसे अहम जानकारी के तौर पर, रिसीवर की सूची को फ़ेच करने में मदद करने के लिए, सीएएफ़ की ओर से, सूची में शामिल अतिरिक्त मैसेज दिखाए जाते हैं और उन्हें मैनेज किया जाता है रिसीवर का SDK टूल:

इनकमिंग मैसेज पैरामीटर जवाब देने के लिए भेजा जाने वाला मैसेज लौटाए जाने वाले प्रॉडक्ट
आगे बढ़ें किसी पैरामीटर की ज़रूरत नहीं है. MEDIA_STATUS पाने वाला (ज़रूरी होने पर Nextआइटम() फ़ेच करेगा) और खेलना शुरू करेगा अगला आइटम.
पिछला किसी पैरामीटर की ज़रूरत नहीं है. MEDIA_STATUS वेब पाने वाला (ज़रूरी होने पर prevItem() को फ़ेच करेगा) और शुरू होगा पिछला आइटम चला रही हूँ.
FETCH_ITEMS FetchItemsRequestData QUEUE_CHANGE Cast.framework.messages.queChange. उदाहरण के लिए, इंसर्ट केस JSON के आइटम फ़ील्ड में, फ़ेच किए गए नए आइटम की सूची शामिल होगी.
GET_ITEMS_INFO itemIds वाले GetItemInfoRequestData: सरणी<number> ITEMS_INFO सूची में मौजूद आइटम की जानकारी के साथ, Cast.framework.messages.itemsInfo.
GET_QUEUE_IDS किसी पैरामीटर की ज़रूरत नहीं है. QUEUE_IDS cast.framework.messages.QueueIds.

NEXT/PREVIOUS के लिए, अगर वेब पाने वाले पर मौजूदा सूची दिखती है और आइटम नहीं हैं, QueueBase.nextItems() या QueueBase.prevItems() को ज़्यादा आइटम पाने के लिए अपने-आप शुरू कर दिया जाता है.

FETCH_ITEM के लिए, संबंधित फ़ंक्शन fetchItems लागू करने के लिए, QueueBase को क्लाउड क्यू के लिए कॉल किया जाता है, जो स्टोर करने के लिए वेब रिसीवर को वापस की जाने वाली प्रासंगिक डेटा.

जब भी ज़्यादा आइटम फ़ेच किए जाते हैं, तो एक नया मैसेज टाइप QUEUE_CHANGE ट्रिगर हो जाता है और भेजने वाले को वापस भेज दिया जाता है. देखें कि अलग-अलग तरह के सूची में बदलाव दिखेगा.

GET_ITEMS_INFO के लिए, QueueBase की लागू होने की वजह से ट्रिगर नहीं होता और वेब पाने वाला मीडिया की जानकारी लौटाता है आईडी की सूची से जिसके बारे में पहले से पता है.

सूची को शफ़ल किया जा रहा है

अपनी सूची के आइटमों को शफ़ल करने के लिए सेट करने के लिए, shuffle इसका झंडा QueueData true तक.

अगर आपने QueueBase, इसका इस्तेमाल करें यह shuffle का तरीका भी बताया गया है.

किसी मौजूदा सूची को शफ़ल करने के लिए, shuffle QUEUE_UPDATE का झंडा MessageType, QUEUE_SHUFFLE कमांड के बजाय शब्दों का इस्तेमाल करें. यहां जाएं: QueueUpdateRequestData हमारा वीडियो देखें.

दोहराने वाला मोड

अपनी सूची में मौजूद आइटम को दोहराने के लिए सेट करें repeatMode इसकी प्रॉपर्टी QueueData ज़रूरत के मुताबिक RepeatMode सूची में आपके आइटम लोड करते समय.

किसी मौजूदा सूची का RepeatMode बदलने के लिए, repeatMode प्रॉपर्टी QueueUpdateRequestData, जो QUEUE_UPDATE का इस्तेमाल करता है MessageType.