Files
archived-MoviePilot-Plugins/docs/faq/10-extend-recommend-source.md
2026-04-20 21:43:30 +08:00

1.3 KiB
Raw Blame History

如何扩展推荐功能的媒体数据源?

返回 README | FAQ 索引

(仅支持 v2.2.8+ 版本)

  • 实现ChainEventType.RecommendSource链式事件响应,将额外的媒体数据源塞入事件数据extra_sources数组中(注意:如果事件中已经有其它数据源,需要叠加而不是替换,避免影响其它插件塞入的数据)

    • name:数据源名称
    • api_path数据获取API相对路径需要在插件中实现API接口功能GET模式接收过滤参数注意page参数默认需要有返回List[schemas.MediaInfo])格式数据,参考app/api/endpoints/recommend.py 中的 tmdb_trending
class RecommendMediaSource(BaseModel):
    """
    推荐媒体数据源的基类
    """
    name: str = Field(..., description="数据源名称")
    api_path: str = Field(..., description="媒体数据源API地址")

class RecommendSourceEventData(ChainEventData):
    """
    RecommendSource 事件的数据模型
    Attributes:
        # 输出参数
        extra_sources (List[RecommendMediaSource]): 额外媒体数据源
    """
    # 输出参数
    extra_sources: List[RecommendMediaSource] = Field(default_factory=list, description="额外媒体数据源")