Stay organized with collections
Save and categorize content based on your preferences.
The Cast framework provides queueing APIs that support the creation of lists of
content items, such as video or audio streams, to play sequentially on the Web
Receiver. The queue of content items may be edited, reordered, updated, and so
forth.
The Web Receiver SDK maintains the queue and responds to operations on the
queue as long as the queue has at least one item currently active (playing or
paused). Senders can join the session and add items to the queue. The receiver
maintains a session for queue items until the last item completes playback or
the sender stops the playback and terminates the session, or until a sender
loads a new queue on the receiver. The receiver does not maintain any
information about terminated queues by default. Once the last item in the queue
finishes, the media session ends and the queue vanishes.
Create and load media queue items
In iOS, a media queue item is represented in the Cast framework as a
GCKMediaQueueItem instance.
When you create a media queue item with adaptive content, you can set the
preload time so that the player can begin buffering the media queue item before
the item ahead of it in the queue finishes playing. See more about preloading in
the
Web Receiver preloading guide.
Setting the item's autoplay
attribute to true allows the Web Receiver to play it automatically. For example,
you can use a builder pattern to create your media queue item as follows:
Load an array of media queue items in the queue by using the appropriate
queueLoadItems method of the
GCKRemoteMediaClient
class.
Receive media queue status update
When the Web Receiver loads a media queue item, it assigns a unique ID to the
item that persists for the duration of the session (and the life of the queue).
You can learn the status of the queue indicating which item is currently loaded
(it might not be playing), loading, or preloaded. You can also get an ordered
list of all the items in the queue. The
GCKMediaStatus
class provides this status information:
preloadedItemID
property - The ID of the item that is currently preloaded, if any.
loadingItemID
property - The ID of the item that is currently loading,
currentItemID
property - The ID of the current queue item, if any.
queueItemCount
method - Returns the number of items in the playback queue.
queueItemAtIndex
method - Returns the item at the specified index in the playback queue.
Use these members together with the other media status members to inform your
app about the status of the queue and the items in the queue. In addition to
media status updates from the Web Receiver, you can listen for changes to the
queue by implementing -[remoteMediaClientDidUpdateQueue:] of the
GCKRemoteMediaClientListener.
Edit the queue
To work with the items in the queue, use the queue methods of
GCKRemoteMediaClient.
you have several APIs. These let you load an array of items into a new queue,
insert items into an existing queue, update the properties of items in the
queue, make an item jump forward or backward in the queue, set the properties of
the queue itself (for example, change the repeatMode that selects the next
item), remove items from the queue, and reorder the items in the queue.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eThe Google Cast framework enables the creation and management of media queues on Web Receivers for sequential playback of audio or video content.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can build media queue items, set autoplay and preload times, and load them into the queue using the \u003ccode\u003eGCKRemoteMediaClient\u003c/code\u003e class.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGCKMediaStatus\u003c/code\u003e class provides information about the queue's status, including the currently playing, loading, and preloaded items.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGCKRemoteMediaClient\u003c/code\u003e offers various methods to edit the queue, such as inserting, updating, removing, and reordering items, as well as controlling queue behavior.\u003c/p\u003e\n"],["\u003cp\u003eSender applications should display the upcoming autoplay item from the queue in their user interface to enhance the user experience.\u003c/p\u003e\n"]]],["The Cast framework enables sequential playback of content items (like audio/video) via queueing APIs. Senders can create, edit, reorder, and update queues. The Web Receiver manages the queue as long as it has an active item, maintaining session until the last item finishes or the session is terminated. In iOS, `GCKMediaQueueItem` represents queue items, with options for autoplay and preloading. `GCKMediaStatus` provides information about the loaded, loading, or preloaded item and the queue status. `GCKRemoteMediaClient` allows to load, insert, update, remove, and reorder items.\n"],null,["# Queueing\n\nThe Cast framework provides queueing APIs that support the creation of lists of\ncontent items, such as video or audio streams, to play sequentially on the Web\nReceiver. The queue of content items may be edited, reordered, updated, and so\nforth.\n| **Note:** Review the [Google Cast Autoplay](/cast/docs/design_checklist/cast-autoplay) for best practices when designing an autoplay or queueing experience for Cast.\n\nThe Web Receiver SDK maintains the queue and responds to operations on the\nqueue as long as the queue has at least one item currently active (playing or\npaused). Senders can join the session and add items to the queue. The receiver\nmaintains a session for queue items until the last item completes playback or\nthe sender stops the playback and terminates the session, or until a sender\nloads a new queue on the receiver. The receiver does not maintain any\ninformation about terminated queues by default. Once the last item in the queue\nfinishes, the media session ends and the queue vanishes.\n| **Note:** The [Styled](/cast/docs/styled_receiver) and [Default Media](/cast/docs/web_receiver#default_media_web_receiver) Receivers only support a queue of audio or video streams. To use a queue of images, you must develop a [Custom Receiver](/cast/docs/web_receiver/basic).\n\nCreate and load media queue items\n---------------------------------\n\nIn iOS, a media queue item is represented in the Cast framework as a\n[`GCKMediaQueueItem` instance](/cast/docs/reference/ios/interface_g_c_k_media_queue_item).\nWhen you create a media queue item with adaptive content, you can set the\npreload time so that the player can begin buffering the media queue item before\nthe item ahead of it in the queue finishes playing. See more about preloading in\nthe\n[Web Receiver preloading guide](/cast/docs/web_receiver/core_features#content_preload).\n\nSetting the item's autoplay\nattribute to true allows the Web Receiver to play it automatically. For example,\nyou can use a builder pattern to create your media queue item as follows:\nSwift \n\n```swift\nlet builder = GCKMediaQueueItemBuilder.init()\nbuilder.mediaInformation = mediaInformation\nbuilder.autoplay = true\nbuilder.preloadTime = 8.0\nlet newItem = builder.build()\n```\nObjective-C \n\n```objective-c\nGCKMediaQueueItemBuilder *builder = [[GCKMediaQueueItemBuilder alloc] init];\nbuilder.mediaInformation = self.mediaInformation;\nbuilder.autoplay = YES;\nbuilder.preloadTime = 8.0;\nGCKMediaQueueItem *newItem = [builder build];\n```\n\nLoad an array of media queue items in the queue by using the appropriate\n`queueLoadItems` method of the\n[`GCKRemoteMediaClient`](/cast/docs/reference/ios/interface_g_c_k_remote_media_client)\nclass.\n\nReceive media queue status update\n---------------------------------\n\nWhen the Web Receiver loads a media queue item, it assigns a unique ID to the\nitem that persists for the duration of the session (and the life of the queue).\nYou can learn the status of the queue indicating which item is currently loaded\n(it might not be playing), loading, or preloaded. You can also get an ordered\nlist of all the items in the queue. The\n[`GCKMediaStatus`](/cast/docs/reference/ios/interface_g_c_k_media_status)\nclass provides this status information:\n\n- [`preloadedItemID`](/cast/docs/reference/ios/interface_g_c_k_media_status#aca544cb983806b859c0d62c6e1438150) property - The ID of the item that is currently preloaded, if any.\n- [`loadingItemID`](/cast/docs/reference/ios/interface_g_c_k_media_status#a0676da67792f35cbea8de2bc9015b05d) property - The ID of the item that is currently loading,\n- [`currentItemID`](/cast/docs/reference/ios/interface_g_c_k_media_status#a1818b62cd378f6648d06042dce494c58) property - The ID of the current queue item, if any.\n- [`queueItemCount`](/cast/docs/reference/ios/interface_g_c_k_media_status#a2ba0ff0a3da66b18520c2858388bc58d) method - Returns the number of items in the playback queue.\n- [`queueItemAtIndex`](/cast/docs/reference/ios/interface_g_c_k_media_status#ad1417e02dca50f0cfd5841c614bd41fa) method - Returns the item at the specified index in the playback queue.\n\nUse these members together with the other media status members to inform your\napp about the status of the queue and the items in the queue. In addition to\nmedia status updates from the Web Receiver, you can listen for changes to the\nqueue by implementing `-[remoteMediaClientDidUpdateQueue:]` of the\n[`GCKRemoteMediaClientListener`](/cast/docs/reference/ios/protocol_g_c_k_remote_media_client_listener-p).\n| **Note:** To provide the best user experience, the sender app must show the next autoplay item in the queue in the sender UI.\n\nEdit the queue\n--------------\n\nTo work with the items in the queue, use the queue methods of\n[`GCKRemoteMediaClient`](/cast/docs/reference/ios/interface_g_c_k_remote_media_client).\nyou have several APIs. These let you load an array of items into a new queue,\ninsert items into an existing queue, update the properties of items in the\nqueue, make an item jump forward or backward in the queue, set the properties of\nthe queue itself (for example, change the `repeatMode` that selects the next\nitem), remove items from the queue, and reorder the items in the queue."]]