Playback Module
Updated: 2026-03-16 09:21:59
回放模块(playback) is responsible for managing the setting and retrieval of live playback objects, providing configuration and data for the player and interactive replay features.
1. API Method Overview
| API Method | Description |
|---|---|
| setCurrentPlaybackTarget | Sets the current playback object. Automatically triggers the CurrentPlaybackTargetUpdated event after setting. |
| getCurrentPlaybackTarget | Gets the current playback object. |
| getCurrentPlaybackMode | Gets the current playback mode. Determines whether it is single playback or list playback based on channel configuration and entry method. |
| getSinglePlaybackTarget | Gets the "single video" playback object. Retrieves the current channel's playback information based on channel configuration and converts it into a playback target object. |
| getPlaybackList | Gets the playback list. Retrieves paginated playback list data from the API. Starting from version v2.14.0, supports passing a keyword parameter to search for videos. |
| getPlaybackTargetById | Gets a playback object by its ID. Retrieves a single playback target object from the API using the playback ID. |
| getChapterEnabled | Gets whether chapters are displayed. |
| getChapterList | Gets the chapter list. Retrieves corresponding chapter data based on playback options. |
| getOutlineList | Gets the smart outline data. Retrieves AI-generated playback outline data from a specified URL. |
| getQuestionList | Gets the knowledge check data. Retrieves AI-generated knowledge check/interactive quiz data from a specified URL. |
| getAiSubtitleList | Gets the verbatim transcript data. Retrieves AI-generated subtitle/verbatim transcript data from a specified URL. Depends on the AI-SDK. |
| getFastForwardBackwardEnabled | Gets whether fast forward/rewind is supported. Determines if the current channel and playback support the fast forward/rewind feature. |
| getLoopPlayEnabled | Gets whether loop playback is supported. Determines if the current channel playback supports the loop playback feature. |
| getListLiveStartTimeEnabled | Gets whether to display the playback list start time. Determines if the playback list shows the live broadcast start time. |
2. Event Overview
| Event | Description |
|---|---|
| PlaybackEvents.CurrentPlaybackTargetUpdated | The current playback object has been updated. |
