For the complete documentation index, see llms.txt. This page is also available as Markdown.

Playlist Group Feed

Use FeedResource.PlaylistGroup to display a playlist group configured in Firework. A group is distinct from a single FeedResource.Playlist, which requires both a channel ID and a playlist ID.

Parameters

FeedResource.PlaylistGroup(playlistGroupId: String)
Parameter
Type
Required
Meaning

playlistGroupId

String

Yes

Encoded playlist group identifier from Firework. It must not be empty.

Only a group ID is required by this source. Do not pass a channel ID, playlist ID, or content ID in its place. The group and its contents must be configured and available for your integration.

Feed View Example

import com.firework.common.feed.FeedResource
import com.firework.viewoptions.BaseOption
import com.firework.viewoptions.ViewOptions

val options = ViewOptions.Builder()
    .baseOption(
        BaseOption.Builder()
            .feedResource(FeedResource.PlaylistGroup("YOUR_ENCODED_PLAYLIST_GROUP_ID"))
            .build()
    )
    .build()

// Use your layout's FwVideoFeedView after SDK initialization.
videoFeedView.setOnErrorListener { error ->
    // Handle unavailable content or feed-loading failures.
}
videoFeedView.init(options)

Register listeners before initialization. A group entry can open its associated playlist in fullscreen playback. Customize feed cards through the same LayoutOption and TitleOption used by other feed sources.

Content Limits

BaseOption.maxItemCount applies to the current feed/session. Child playlist sessions inherit the configured limit; each session counts its own entries. For pagination, advertising, and reinitialization details, see Maximum Item Count.

Errors and Lifecycle

An empty group ID fails constructor validation. A non-empty ID does not guarantee that content is available; handle errors and empty feed results through the widget's normal callbacks. Follow Video Feed lifecycle guidance when the owning screen is destroyed.

See Also

Last updated

Was this helpful?