添加链接
link管理
链接快照平台
  • 输入网页链接,自动生成快照
  • 标签化管理网页链接

API文档.md

File metadata and controls

SuperPlayerPlugin类

setGlobalLicense

设置license

申请到license后,通过下面的接口初始化license,建议在启动的时候进行,如果没有设置license,将会播放视频失败。

static Future<void> setGlobalLicense(String licenceUrl, String licenceKey) async;

创建原生层的点播播放器实例,如果使用 TXVodPlayerController ,其中已经集成,不需要额外创建

static Future<int?> createVodPlayer() async;

创建原生层的点播播放器实例,如果使用 TXVodPlayerController ,其中已经集成,不需要额外创建

static Future<int?> createLivePlayer() async;

设置播放引擎的最大缓存大小。设置后会根据设定值自动清理Cache目录的文件

static Future<void> setGlobalMaxCacheSize(int size) async;

该缓存路径默认设置到app沙盒目录下,参数只需要传递相对缓存目录即可,不需要传递整个绝对路径。

static Future<bool> setGlobalCacheFolderPath(String postfixPath) async;
腾讯云在全球各地区部署的环境,按照各地区政策法规要求,需要接入不同地区接入点。

目标市场为中国大陆的客户请不要调用此接口,如果目标市场为海外用户,请通过技术支持联系我们,了解 env_config 的配置方法,以确保 App 遵守 GDPR 标准。

static Future<int> setGlobalEnv(String envConfig) async;

开启或关闭对于系统亮度的监听,如果开启,当系统亮度发生变化,会改变当前window亮度,并回调亮度到flutter层。该接口需配合 setBrightness和onExtraEventBroadcast使用。

static Future<void>registerSysBrightness(bool isRegister) async

startVodPlay

10.7版本开始,startPlay变更为startVodPlay,需要通过 {@link SuperPlayerPlugin#setGlobalLicense} 设置 Licence 后方可成功播放, 否则将播放失败(黑屏),全局仅设置一次即可。直播 Licence、短视频 Licence 和视频播放 Licence 均可使用,若您暂未获取上述 Licence ,可 快速免费申请测试版 Licence 以正常播放,正式版 License 需 购买

通过播视频url进行播放。

Future<bool> startVodPlay(String url) async;

startVodPlayWithParams

10.7版本开始,startPlay变更为startVodPlay,需要通过 {@link SuperPlayerPlugin#setGlobalLicense} 设置 Licence 后方可成功播放, 否则将播放失败(黑屏),全局仅设置一次即可。直播 Licence、短视频 Licence 和视频播放 Licence 均可使用,若您暂未获取上述 Licence ,可 快速免费申请测试版 Licence 以正常播放,正式版 License 需 购买

通过视频field进行播放。

Future<void> startVodPlayWithParams(TXPlayInfoParams params) async;

设置即将播放的视频,在startVodPlay加载视频地址之后,是否直接自动播放

Future<void> setIsAutoPlay({bool? isAutoPlay}) async;

加密HLS的token。设置此值后,播放器自动在URL中的文件名之前增加voddrm.token

Future<void> setToken(String? token) async;

进入画中画模式

Future<int> enterPictureInPictureMode({String? backIconForAndroid, String? playIconForAndroid, String? pauseIconForAndroid, String? forwardIconForAndroid}) async;

该参数只适用于android平台

初始化视频雪碧图

Future<void> initImageSprite(String? vvtUrl, List<String>? imageUrls) async;

注意:此功能需要播放器高级版 11.7 版本开始支持。

Future<void> addSubtitleSource(String url, String name, {String? mimeType}) async;
trackType 轨道类型。取值有:
视频轨:TX_VOD_MEDIA_TRACK_TYPE_VIDEO = 1
音频轨: TX_VOD_MEDIA_TRACK_TYPE_AUDIO = 2
字幕轨:TX_VOD_MEDIA_TRACK_TYPE_SUBTITLE = 3 trackIndex 轨道index String isSelected 当前轨道是否被选中 isExclusive 如果是true,该类型轨道每个时刻只有一条能被选中,如果是false,该类型轨道可以同时选中多条 isInternal 当前的轨道是否是内部原始轨道

getAudioTrackInfo

返回字幕轨道信息列表。

注意:此功能需要播放器高级版 11.7 版本开始支持。

Future<List<TXTrackInfo>> getAudioTrackInfo() async;

参考TXTrackInfo类

selectTrack

选择轨道。

注意:此功能需要播放器高级版 11.7 版本开始支持。

Future<void> selectTrack(int trackIndex) async;
nextStartPlayBufferTime 缓冲时(缓冲数据不够引起的二次缓冲,或者seek引起的拖动缓冲)最少要缓存多长的数据才能结束缓冲,单位ms,默认值为250ms overlayKey String HLS安全加固加解密key overlayIv String HLS安全加固加解密Iv extInfoMap 一些不必周知的特殊配置 enableRenderProcess 是否允许加载后渲染后处理服务,默认开启,开启后超分插件如果存在,默认加载 preferredResolution 优先播放的分辨率,preferredResolution = width * height mediaType 设置媒资类型, 默认为 auto 类型。可选值有:
TXVodConstants#MEDIA_TYPE_AUTO,AUTO 类型(默认值,自适应码率播放暂不支持)。
TXVodConstants#MEDIA_TYPE_HLS_VOD,HLS 点播媒资。
TXVodConstants#MEDIA_TYPE_HLS_LIVE,HLS 直播媒资。
TXVodConstants#MEDIA_TYPE_FILE_VOD,MP4 等通用文件点播媒资(从 11.7 版本开始支持)。
TXVodConstants#MEDIA_TYPE_DASH_VOD,DASH 点播媒资(从 11.7 版本开始支持)。

TXLivePlayerController类

initialize

初始化controller,请求分配共享纹理

Future<void> initialize({bool? onlyAudio}) async;

startLivePlay

10.7版本开始,startPlay变更为startLivePlay,需要通过 {@link SuperPlayerPlugin#setGlobalLicense} 设置 Licence 后方可成功播放, 否则将播放失败(黑屏),全局仅设置一次即可。直播 Licence、短视频 Licence 和视频播放 Licence 均可使用,若您暂未获取上述 Licence ,可 快速免费申请测试版 Licence 以正常播放,正式版 License 需 购买

通过播视频url进行播放。

Future<bool> play(String url, {int? playType}) async;

进入画中画模式,仅支持Android端,IOS端直播目前暂不支持画中画模式

Future<int> enterPictureInPictureMode({String? backIconForAndroid, String? playIconForAndroid, String? pauseIconForAndroid, String? forwardIconForAndroid}) async;

该参数只适用于android平台

autoAdjustCacheTime 是否自动调整播放器缓存时间,默认值:true。true:启用自动调整,自动调整的最大值和最小值可以分别通过修改 maxCacheTime 和 minCacheTime 来设置。false:关闭自动调整,采用默认的指定缓存时间(1s),可以通过修改 cacheTime 来调整缓存时间 enableAec 是否开启回声消除, 默认值为 false enableMessage 是否开启消息通道, 默认值为 true enableMetaData 是否开启 MetaData 数据回调,默认值为 NO。 true:SDK 通过 EVT_PLAY_GET_METADATA 消息抛出视频流的 MetaData 数据;false:SDK 不抛出视频流的 MetaData 数据。 flvSessionKey String 是否开启 HTTP 头信息回调,默认值为 “”

TXVodDownloadController类

startPreLoad

启动预下载。启动预下载前,请先设置好播放引擎的缓存目录[SuperPlayerPlugin.setGlobalCacheFolderPath]和缓存大小[SuperPlayerPlugin.setGlobalMaxCacheSize],这个设置是全局配置需和播放器保持一致,否则会造成播放缓存失效。

  Future<int> startPreLoad(
final String playUrl,
final double preloadSizeMB,
final int preferredResolution, {
FTXPredownlodOnCompleteListener? onCompleteListener,
    FTXPredownlodOnErrorListener? onErrorListener,
}) async
  Future<void> startPreload(TXPlayInfoParams txPlayInfoParams,
      final double preloadSizeMB,
      final int preferredResolution, {
        FTXPredownlodOnCompleteListener? onCompleteListener,
        FTXPredownlodOnErrorListener? onErrorListener,
        FTXPredownlodOnStartListener? onStartListener,
      }) async 

获得所有下载任务,包括已下载、正在下载以及下载错误的任务

Future<List<TXVodDownloadMediaInfo>> getDownloadList() async

返回值说明

获得下载任务信息

Future<TXVodDownloadMediaInfo> getDownloadInfo(TXVodDownloadMediaInfo mediaInfo) async

获得下载任务信息

void setDownloadObserver(FTXDownlodOnStateChangeListener downlodOnStateChangeListener, FTXDownlodOnErrorListener downlodOnErrorListener)