@capgo/capacitor-ivs-player

中文文档
8.0.44发布于 2026/10/15MPL-2.0TypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 4万

电容器应用程序的 Ivs 播放器

中文使用文档
文档目录46 节
  1. *免费开始*
  2. 主要特点
  3. 文档
  4. 兼容性
  5. 安装
  6. API 密码
  7. 创建(...)
  8. 开始( c)
  9. 铸( )
  10. 获取状态( C)
  11. 暂停( c)
  12. 删除( )
  13. 获取Url ()
  14. 获取状态( C)
  15. 设置 PlayerPostition (...)
  16. 获取 Player 选项 ()
  17. 设置自动质量(...)
  18. 获得自动质量 ()
  19. 设置Pip(...)
  20. 获取Pip( )
  21. 设置Frame(...)
  22. 获取Frame ()
  23. 设置背景状态(...)
  24. 获取背景状态 ()
  25. 设置Mute(...)
  26. 获取Mute ()
  27. 设置质量(...)
  28. 获取质量( C)
  29. 获取质量( )
  30. 获取 PluginVersion ()
  31. 添加倾听器( “ start Pip ” ,...)
  32. 添加倾听器( “ stopPip' , )..
  33. 添加倾听器( “ 扩展 Pip' ,...)
  34. 添加倾听器( “ 关闭 Pip ” ,...)
  35. 添加倾听器( “ 关于 State ” ,...)
  36. 添加倾听器( 关于 Cues,...)
  37. 添加倾听器( “ 定义 ” ,...)
  38. 添加倾听器( 错误,...)
  39. 添加倾听器( “ 在缓存 ” ,...)
  40. 添加倾听器( 在“ 搜索完成 ” 中,...)
  41. 添加收听器( 在“ 视频” 上,...)
  42. 添加倾听器( 质量 ),..
  43. 添加收听器( “ 关于状态 ” , )
  44. 删除所有收听器( )
  45. 接口
  46. 类型异名

@ capgo/ 电容- ivs- player

在您的 Capacitor app 中与本地的 IVS 播放器在 iOS 和 Android 上播放 Amazon IVS 活流,包括图片和回放事件中的图片.

Capgo - Build Capacitor apps with AI, ship updates instantly

队长:在几分钟内将修正推给您的 Capacitor 用户,在没有Mac的情况下构建已签名的iOS和Android apps,并在一击中回滚.

*免费开始*

14天无限自由审判. 不需要信用卡

🤖 建筑与AI编码代理? 安装 Capgo 技能 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 @capgo/capacitor-ivs-player 在您的电容应用程序中: npx skills add Cap-go/capgo-skills。然后问你的经纪人: 添加@capgo/capor-ivs-player到我的Capacitor应用上,并把它接上" 代理设置指南 • 妇女 主机磁共振

@capgo/capacitor-ivs-player for Capacitor apps

主要特点

  • 玩家数字 : create() 带有流 URL,然后 start(), (中文(简体) ), pause() 财务报告和审定财务报表 delete()。 。 。 .
  • 版式数字 : setFrame() 财务报告和审定财务报表 setPlayerPosition() 将本地玩家放在您的网络用户界面前或后方.
  • 图片中的图片数字 : setPip() 与 startPip, (中文(简体) ), stopPip 财务报告和审定财务报表 closePip 事件.
  • 质量数字 : setAutoQuality() 和质量变化事件.
  • 回放事件:状态,持续时间,提示,缓冲,寻求和错误的收听者.
  • 平台: iOS和Android. 互联网档案馆的存檔,存档日期2013-12-22. 使用亚马逊IVS播放器SDK. 在网上不可用.

文档

这里有最完整的医生: https://capgo.app/docs/plugins/ivs-player/ 页面存档备份,存于互联网档案馆

兼容性

插件版本电容兼容性维护
联合国联合国✅
页:1页:1应要求
页:1页:1❌
页:1页:1❌

说明: 此插件的主要版本沿用了Capacitor的主要版本. 使用匹配您的 Capacitor 安装的版本( 如 Capacitor 8 的插件 v8) 。 只有最新的主要版本得到积极维护.

安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

然后使用下列提示:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-ivs-player` plugin in my project.

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

npm install @capgo/capacitor-ivs-player
npx cap sync

API 密码

创建(...)

create(options: { url: string; pip?: boolean; title?: string; subtitle?: string; cover?: string; autoPlay?: boolean; toBack?: boolean; x?: number; y?: number; width?: number; height?: number; }) => Promise<void>
参数类型
options{ url: string; pip?: boolean; title?: string; subtitle?: string; cover?: string; autoPlay?: boolean; toBack?: boolean; x?: number; y?: number; width?: number; height?: number; }

开始( c)

start() => Promise<void>

铸( )

cast() => Promise<void>

获取状态( C)

getCastStatus() => Promise<{ isActive: boolean; }>

回返情况: Promise<{ isActive: boolean; }>


暂停( c)

pause() => Promise<void>

删除( )

delete() => Promise<void>

获取Url ()

getUrl() => Promise<{ url: string; }>

回返情况: Promise<{ url: string; }>


获取状态( C)

getState() => Promise<{ state: CapacitorIvsPlayerState; }>

回返情况: Promise<{ state: CapacitorIvsPlayerState; }>


设置 PlayerPostition (...)

setPlayerPosition(options?: { toBack: boolean; } | undefined) => Promise<void>
参数类型
options{ toBack: boolean; }

获取 Player 选项 ()

getPlayerPosition() => Promise<{ toBack: boolean; }>

回返情况: Promise<{ toBack: boolean; }>


设置自动质量(...)

setAutoQuality(options?: { autoQuality?: boolean | undefined; } | undefined) => Promise<void>
参数类型
options{ autoQuality?: boolean; }

获得自动质量 ()

getAutoQuality() => Promise<{ autoQuality: boolean; }>

回返情况: Promise<{ autoQuality: boolean; }>


设置Pip(...)

setPip(options?: { pip?: boolean | undefined; } | undefined) => Promise<void>
参数类型
options{ pip?: boolean; }

获取Pip( )

getPip() => Promise<{ pip: boolean; }>

回返情况: Promise<{ pip: boolean; }>


设置Frame(...)

setFrame(options?: { x?: number | undefined; y?: number | undefined; width?: number | undefined; height?: number | undefined; } | undefined) => Promise<void>

设置玩家视图的框架, 所有数字必须是正和整数

参数类型说明
options{ x?: number; y?: number; width?: number; height?: number; }:数,y:数,宽:数,高:数}

自: 1.0.0 (单位:千美元)


获取Frame ()

getFrame() => Promise<CapacitorFrame>

回返情况: Promise<CapacitorFrame>


设置背景状态(...)

setBackgroundState(options: { backgroundState: CapacitorIvsPlayerBackgroundState; }) => Promise<void>
参数类型
options{ backgroundState: CapacitorIvsPlayerBackgroundState; }

获取背景状态 ()

getBackgroundState() => Promise<{ backgroundState: CapacitorIvsPlayerBackgroundState; }>

回返情况: Promise<{ backgroundState: CapacitorIvsPlayerBackgroundState; }>


设置Mute(...)

setMute(options?: { muted?: boolean | undefined; } | undefined) => Promise<void>
参数类型
options{ muted?: boolean; }

获取Mute ()

getMute() => Promise<{ mute: boolean; }>

回返情况: Promise<{ mute: boolean; }>


设置质量(...)

setQuality(options?: { quality: string; } | undefined) => Promise<void>
参数类型
options{ quality: string; }

获取质量( C)

getQuality() => Promise<{ quality: string; }>

回返情况: Promise<{ quality: string; }>


获取质量( )

getQualities() => Promise<{ qualities: string[]; }>

回返情况: Promise<{ qualities: string[]; }>


获取 PluginVersion ()

getPluginVersion() => Promise<{ version: string; }>

获取本地 Capacitor 插件版本

回返情况: Promise<{ version: string; }>


添加倾听器( “ start Pip ” ,...)

addListener(eventName: 'startPip', listenerFunc: () => void) => Promise<PluginListenerHandle>

听着,开始吧

参数类型
eventName'startPip'
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>

自: 1.0.0 (单位:千美元)


添加倾听器( “ stopPip' , )..

addListener(eventName: 'stopPip', listenerFunc: () => void) => Promise<PluginListenerHandle>

听好,停下来

参数类型
eventName'stopPip'
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>

自: 1.0.0 (单位:千美元)


添加倾听器( “ 扩展 Pip' ,...)

addListener(eventName: 'expandPip', listenerFunc: () => void) => Promise<PluginListenerHandle>

听好,费尽心思

参数类型
eventName'expandPip'
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>

自: 1.0.0 (单位:千美元)


添加倾听器( “ 关闭 Pip ” ,...)

addListener(eventName: 'closePip', listenerFunc: () => void) => Promise<PluginListenerHandle>

听好了,关闭管道

参数类型
eventName'closePip'
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>

自: 1.0.0 (单位:千美元)


添加倾听器( “ 关于 State ” ,...)

addListener(eventName: 'onState', listenerFunc: (data: { state: CapacitorIvsPlayerState; }) => void) => Promise<PluginListenerHandle>

状态变化的监听

参数类型
eventName'onState'
listenerFunc(data: { state: CapacitorIvsPlayerState; }) => void

回返情况: Promise<PluginListenerHandle>

自: 1.0.0 (单位:千美元)


添加倾听器( 关于 Cues,...)

addListener(eventName: 'onCues', listenerFunc: (data: { cues: string; }) => void) => Promise<PluginListenerHandle>

听听提示更改

参数类型
eventName'onCues'
listenerFunc(data: { cues: string; }) => void

回返情况: Promise<PluginListenerHandle>

自: 1.0.0 (单位:千美元)


添加倾听器( “ 定义 ” ,...)

addListener(eventName: 'onDuration', listenerFunc: (data: { duration: number; }) => void) => Promise<PluginListenerHandle>

持续时间变化的监听

参数类型
eventName'onDuration'
listenerFunc(data: { duration: number; }) => void

回返情况: Promise<PluginListenerHandle>

自: 1.0.0 (单位:千美元)


添加倾听器( 错误,...)

addListener(eventName: 'onError', listenerFunc: (data: { error: string; }) => void) => Promise<PluginListenerHandle>

听错

参数类型
eventName'onError'
listenerFunc(data: { error: string; }) => void

回返情况: Promise<PluginListenerHandle>

自: 1.0.0 (单位:千美元)


添加倾听器( “ 在缓存 ” ,...)

addListener(eventName: 'onRebuffering', listenerFunc: () => void) => Promise<PluginListenerHandle>

听好了 缓冲

参数类型
eventName'onRebuffering'
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>

自: 1.0.0 (单位:千美元)


添加倾听器( 在“ 搜索完成 ” 中,...)

addListener(eventName: 'onSeekCompleted', listenerFunc: (data: { position: number; }) => void) => Promise<PluginListenerHandle>

位置变化的监听

参数类型
eventName'onSeekCompleted'
listenerFunc(data: { position: number; }) => void

回返情况: Promise<PluginListenerHandle>

自: 1.0.0 (单位:千美元)


添加收听器( 在“ 视频” 上,...)

addListener(eventName: 'onVideoSize', listenerFunc: (data: { width: number; height: number; }) => void) => Promise<PluginListenerHandle>

听取视频大小变化

参数类型
eventName'onVideoSize'
listenerFunc(data: { width: number; height: number; }) => void

回返情况: Promise<PluginListenerHandle>

自: 1.0.0 (单位:千美元)


添加倾听器( 质量 ),..

addListener(eventName: 'onQuality', listenerFunc: (data: { quality: string; }) => void) => Promise<PluginListenerHandle>

听取质量变化

参数类型
eventName'onQuality'
listenerFunc(data: { quality: string; }) => void

回返情况: Promise<PluginListenerHandle>

自: 1.0.0 (单位:千美元)


添加收听器( “ 关于状态 ” , )

addListener(eventName: 'onCastStatus', listenerFunc: (data: { isActive: boolean; }) => void) => Promise<PluginListenerHandle>

显示状态变化

参数类型
eventName'onCastStatus'
listenerFunc(data: { isActive: boolean; }) => void

回返情况: Promise<PluginListenerHandle>

自: 1.0.0 (单位:千美元)


删除所有收听器( )

removeAllListeners() => Promise<void>

删除此插件的所有听众 .

自: 1.0.0 (单位:千美元)


接口

电容

Prop类型
xnumber
ynumber
widthnumber
heightnumber

插件听筒

Prop类型
remove() => Promise<void>

类型异名

电容Ivslayers状态

'IDLE' | 'BUFFERING' | 'READY' | 'PLAYING' | 'ENDED' | 'UNKNOWN'

电容器IvsPlayer背景状态

'PAUSED' | 'PLAYING'

贷项

此插件最初是为 Kick.com (英语) 以 队长

版本与发布记录

@capgo/capacitor-ivs-player 共发布 65 个版本,首次发布于 2025/10/26;过去 12 个月发布了 51 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
8.0.44latest2026/10/1525 天前
8.0.432026/10/1327 天前
8.0.422026/10/1227 天前
8.0.412026/10/091 个月前
8.0.402026/10/091 个月前
8.0.392026/10/091 个月前

关于 @capgo/capacitor-ivs-player 的常见问题

@capgo/capacitor-ivs-player 是什么?

电容器应用程序的 Ivs 播放器

如何安装 @capgo/capacitor-ivs-player?

在项目目录运行 npm install @capgo/capacitor-ivs-player,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@capacitor/core(>=8.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@capgo/capacitor-ivs-player 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@capgo/capacitor-ivs-player 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@capgo/capacitor-ivs-player 可以商用吗?

@capgo/capacitor-ivs-player 使用 MPL-2.0 许可。弱 Copyleft:可以商用,也可以和闭源代码一起使用;但如果分发时修改了 MPL 授权的文件,这些文件的修改需以 MPL 开源。以上为概括,不构成法律意见,请以许可原文为准。

@capgo/capacitor-ivs-player 的下载量有多少?

根据 npm 官方下载统计,@capgo/capacitor-ivs-player 在 2026/10/09 – 2026/11/07 这 30 天内被下载 39,913 次,日均约 1,330 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@capgo/capacitor-ivs-player 还在维护吗?

最新版本 8.0.44 发布于 2026/10/15(25 天前);至今共发布 65 个版本,其中过去 12 个月发布了 51 个;首次发布于 2025/10/26。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。