static Future<void> setGlobalLicense(String licenceUrl, String licenceKey) async;
参数名 | 类型 | 描述 |
licenceUrl | String | licence 的 url |
licenceKey | String | licence 的 key |
TXVodPlayerController
,其中已经集成,不需要额外创建。static Future<int?> createVodPlayer() async;
返回值 | 类型 | 描述 |
playerId | int | 播放器ID |
TXVodPlayerController
,其中已经集成,不需要额外创建。static Future<int?> createLivePlayer() async;
返回值 | 类型 | 描述 |
playerId | int | 播放器ID |
static Future<int?> setConsoleEnabled() async;
参数名 | 类型 | 描述 |
enabled | bool | 开启或关闭播放器 log |
static Future<int?> releasePlayer(int? playerId) async;
static Future<void> setGlobalMaxCacheSize(int size) async;
参数名 | 类型 | 描述 |
size | int | 最大缓存大小(单位:MB) |
static Future<bool> setGlobalCacheFolderPath(String postfixPath) async;
参数名 | 类型 | 描述 |
postfixPath | String | 缓存目录,该缓存路径默认设置到 app 沙盒目录下,postfixPath 只需要传递相对缓存目录即可,不需要传递整个绝对路径。Android 平台:视频将会缓存到 sdcard的Android/data/your-pkg-name/files/testCache 目录。iOS 平台视频将会缓存到沙盒的 Documents/testCache 目录。 |
static Future<void> setLogLevel(int logLevel) async;
参数名 | 类型 | 描述 |
logLevel | int | 0:输出所有级别的 log 1:输出 DEBUG,INFO,WARNING,ERROR 和 FATAL 级别的 log 2:输出 INFO,WARNNING,ERROR 和 FATAL 级别的 log 3:输出 WARNNING,ERROR 和 FATAL 级别的log 4:输出 ERROR 和 FATAL 级别的log 5:只输出 FATAL 级别的log 6:不输出任何 sdk log |
static Future<void> setBrightness(double brightness) async;
参数名 | 类型 | 描述 |
brightness | double | 亮度取值范围 0.0~1.0 |
static Future<void> restorePageBrightness() async;
static Future<double> getBrightness() async;
参数名 | 类型 | 描述 |
brightness | double | 亮度取值范围 0.0~1.0 |
static Future<void> setSystemVolume(double volume) async;
参数名 | 类型 | 描述 |
volume | double | 音量取值范围 0.0~1.0 |
static Future<double> getSystemVolume() async;
参数名 | 类型 | 描述 |
volume | double | 音量取值范围 0.0~1.0 |
static Future<double> abandonAudioFocus() async;
static Future<void> requestAudioFocus() async ;
static Future<int> isDeviceSupportPip() async;
参数名 | 类型 | 描述 |
isDeviceSupportPip | int | 0 可开启画中画模式 -101 android版本过低 -102 画中画权限关闭/设备不支持画中画 -103 当前界面已销毁 |
static Future<String?> getLiteAVSDKVersion() async;
参数名 | 类型 | 描述 |
sdkVersion | String | 当前播放器 SDK 版本 |
static Future<int> setGlobalEnv(String envConfig) async;
参数名 | 类型 | 描述 |
envConfig | String | 需要接入的环境,SDK 默认接入的环境是:默认正式环境 |
参数名 | 类型 | 描述 |
result | int | 1 设置成功, 2 设置失败 |
static Future<bool> startVideoOrientationService() async
参数名 | 类型 | 描述 |
result | bool | true 开启成功,false 开启失败,如开启过早,还未等到上下文初始化、获取sensor失败等原因 |
static Future<void>registerSysBrightness(bool isRegister) async
参数名 | 类型 | 描述 |
isRegister | bool | true:开启监听。 false:关闭监听。 |
Future<void> initialize({bool? onlyAudio}) async;
参数名 | 类型 | 描述 |
onlyAudio | bool | 选填,是否是纯音频播放器 |
Future<bool> startVodPlay(String url) async;
参数名 | 类型 | 描述 |
url | String | 要播放的视频url |
参数名 | 类型 | 描述 |
result | bool | 创建是否成功 |
Future<void> startVodPlayWithParams(TXPlayInfoParams params) async;
参数名 | 类型 | 描述 |
appId | int | 应用 appId。必填 |
fileId | String | 文件 id。必填 |
sign | String | |
url | String | 播放链接,该字段与fileId填写一个即可 |
Future<void> pause() async;
Future<void> resume() async;
Future<bool> stop({bool isNeedClear = false}) async;
参数名 | 类型 | 描述 |
isNeedClear | bool | 是否清除最后一帧画面 |
参数名 | 类型 | 描述 |
result | bool | 停止是否成功 |
Future<void> setIsAutoPlay({bool? isAutoPlay}) async;
参数名 | 类型 | 描述 |
isAutoPlay | bool | 是否自动播放 |
Future<bool> isPlaying() async;
参数名 | 类型 | 描述 |
isPlaying | bool | 是否正在播放 |
Future<void> setMute(bool mute) async;
参数名 | 类型 | 描述 |
mute | bool | 是否静音 |
Future<void> setLoop(bool loop) async;
参数名 | 类型 | 描述 |
loop | bool | 是否循环播放 |
_controller.seek(progress);
参数名 | 类型 | 描述 |
progress | double | 需要调整到的播放时间,单位 秒。 |
Future<void> setRate(double rate) async;
参数名 | 类型 | 描述 |
rate | double | 视频的播放速率。默认1.0 |
Future<List?> getSupportedBitrates() async;
返回值 | 类型 | 描述 |
index | int | 码率序号 |
width | int | 码率对应视频宽度 |
height | int | 码率对应视频高度 |
bitrate | int | 码率值 |
Future<int> getBitrateIndex() async;
返回值 | 类型 | 描述 |
index | int | 码率序号 |
Future<void> setBitrateIndex(int index) async;
返回值 | 类型 | 描述 |
index | int | 码率序号。 传入-1时,表示开启码流自适应。 |
Future<void> setStartTime(double startTime) async;
返回值 | 类型 | 描述 |
startTime | double | 播放开始时间,单位 秒 |
Future<void> setAudioPlayoutVolume(int volume) async;
参数名 | 类型 | 描述 |
volume | int | 视频声音大小,范围0~100 |
Future<bool> setRequestAudioFocus(bool focus) async;
参数名 | 类型 | 描述 |
focus | bool | 是否设置焦点 |
参数名 | 类型 | 描述 |
result | bool | 设置焦点是否成功 |
Future<void> setConfig(FTXVodPlayConfig config) async ;
参数名 | 类型 | 描述 |
config | FTXVodPlayConfig | 请参考 FTXVodPlayConfig类 |
Future<double> getCurrentPlaybackTime() async;
参数名 | 类型 | 描述 |
playbackTime | double | 当前播放时间,单位 秒 |
Future<double> getBufferDuration();
参数名 | 类型 | 描述 |
playbackTime | double | 当前视频已缓存的时间,单位 秒 |
Future<double> getPlayableDuration() async;
参数名 | 类型 | 描述 |
playableDuration | double | 当前视频可播放时,单位 秒 |
Future<int> getWidth() async;
参数名 | 类型 | 描述 |
width | int | 当前视频宽度 |
Future<int> getHeight() async;
参数名 | 类型 | 描述 |
height | int | 当前视频高度 |
voddrm.token
。Future<void> setToken(String? token) async;
参数名 | 类型 | 描述 |
token | String | 播放视频的token |
Future<bool> isLoop() async;
参数名 | 类型 | 描述 |
isLoop | bool | 播放器是否处于循环播放状态 |
Future<bool> enableHardwareDecode(bool enable);
参数名 | 类型 | 描述 |
enable | bool | 是否开启硬解 |
参数名 | 类型 | 描述 |
result | bool | 硬解/软解设置结果 |
Future<void> dispose() async;
Future<double> getDuration() async;
参数名 | 类型 | 描述 |
duration | double | 视频总时长,单位 秒 |
Future<int> enterPictureInPictureMode({String? backIconForAndroid, String? playIconForAndroid, String? pauseIconForAndroid, String? forwardIconForAndroid}) async;
参数名 | 类型 | 描述 |
backIcon | String | 回退按钮图标,由于 android 平台限制,图标大小不得超过1M,可不传,不传则使用系统自带图标 |
playIcon | String | 播放按钮图标,由于 android 平台限制,图标大小不得超过1M,可不传,不传则使用系统自带图标 |
pauseIcon | String | 暂停按钮图标,由于 android 平台限制,图标大小不得超过1M,可不传,不传则使用系统自带图标 |
forwardIcon | String | 快进按钮图标,由于 android 平台限制,图标大小不得超过1M,可不传,不传则使用系统自带图标 |
参数名 | 值 | 描述 |
NO_ERROR | 0 | 启动成功,没有错误 |
ERROR_PIP_LOWER_VERSION | -101 | android 版本过低,不支持画中画模式 |
ERROR_PIP_DENIED_PERMISSION | -102 | 画中画模式权限未打开,或者当前设备不支持画中画 |
ERROR_PIP_ACTIVITY_DESTROYED | -103 | 当前界面已经销毁 |
ERROR_IOS_PIP_DEVICE_NOT_SUPPORT | -104 | 设备或系统版本不支持(iPad iOS9+ 才支持PIP),只适用于 iOS |
ERROR_IOS_PIP_PLAYER_NOT_SUPPORT | -105 | 播放器不支持,只适用于 iOS |
ERROR_IOS_PIP_VIDEO_NOT_SUPPORT | -106 | 视频不支持,只适用于 iOS |
ERROR_IOS_PIP_IS_NOT_POSSIBLE | -107 | PIP控制器不可用,只适用于 iOS |
ERROR_IOS_PIP_FROM_SYSTEM | -108 | PIP控制器报错,只适用于 iOS |
ERROR_IOS_PIP_PLAYER_NOT_EXIST | -109 | 播放器对象不存在,只适用于 iOS |
ERROR_IOS_PIP_IS_RUNNING | -110 | PIP功能已经运行,只适用于 iOS |
ERROR_IOS_PIP_NOT_RUNNING | -111 | PIP功能没有启动,只适用于 iOS |
Future<void> initImageSprite(String? vvtUrl, List<String>? imageUrls) async;
参数名 | 类型 | 描述 |
vvtUrl | String | 雪碧图 web vtt 描述文件下载 URL |
imageUrls | List<String> | 雪碧图图片下载 URL |
Future<Uint8List?> getImageSprite(double time) async;
参数名 | 类型 | 描述 |
time | double | 时间点,单位 秒 |
参数名 | 类型 | 描述 |
thumb | Uint8List | 雪碧图 |
Future<void> exitPictureInPictureMode() async;
参数名 | 类型 | 描述 |
connectRetryCount | int | 播放器重连次数,当 SDK 与服务器异常断开连接时,SDK 会尝试与服务器重连.通过该值设置 SDK 重连次数 |
connectRetryInterval | int | 播放器重连间隔,当 SDK 与服务器异常断开连接时,SDK 会尝试与服务器重连.通过该值设置两次重连间隔时间 |
timeout | int | 播放器连接超时时间 |
playerType | int | 播放器类型,0 点播,1 直播,2 直播回看 |
headers | Map | 自定义 http headers |
enableAccurateSeek | bool | 是否精确 seek,默认 true |
autoRotate | bool | 播放mp4文件时,若设为 true 则根据文件中的旋转角度自动旋转。旋转角度可在 PLAY_EVT_CHANGE_ROTATION 事件中获得。默认 true |
smoothSwitchBitrate | bool | 平滑切换多码率HLS,默认 false。设为 false时,可提高多码率地址打开速度; 设为 true,在 IDR 对齐时可平滑切换码率 |
cacheMp4ExtName | String | 缓存 mp4文件扩展名,默认mp4 |
progressInterval | int | 设置进度回调间隔,若不设置,SDK 默认间隔0.5秒回调一次,单位毫秒 |
maxBufferSize | int | 最大播放缓冲大小,单位 MB。此设置会影响 playableDuration,设置越大,提前缓存的越多 |
maxPreloadSize | int | 预加载最大缓冲大小,单位:MB |
firstStartPlayBufferTime | int | 首缓需要加载的数据时长,单位ms,默认值为100ms |
nextStartPlayBufferTime | int | 缓冲时(缓冲数据不够引起的二次缓冲,或者seek引起的拖动缓冲)最少要缓存多长的数据才能结束缓冲,单位ms,默认值为250ms |
overlayKey | String | HLS安全加固加解密 key |
overlayIv | String | HLS安全加固加解密 Iv |
extInfoMap | Map | 一些不必周知的特殊配置 |
enableRenderProcess | bool | 是否允许加载后渲染后处理服务,默认开启,开启后超分插件如果存在,默认加载 |
preferredResolution | int | 优先播放的分辨率,preferredResolution = width * height |
Future<void> initialize({bool? onlyAudio}) async;
参数名 | 类型 | 描述 |
onlyAudio | bool | 选填,是否是纯音频播放器 |
Future<bool> play(String url, {int? playType}) async;
参数名 | 类型 | 描述 |
url | String | 要播放的视频 url |
playType | int | 选填,支持的播放类型,默认 RTMP 直播,支持 LIVE_RTMP、LIVE_FLV、LIVE_RTMP_ACC以及VOD_HLS,详见 TXPlayType |
参数名 | 类型 | 描述 |
result | bool | 创建是否成功 |
Future<void> pause() async;
Future<void> resume() async;
Future<bool> stop({bool isNeedClear = false}) async;
参数名 | 类型 | 描述 |
isNeedClear | bool | 是否清除最后一帧画面 |
参数名 | 类型 | 描述 |
result | bool | 停止是否成功 |
Future<bool> isPlaying() async;
参数名 | 类型 | 描述 |
isPlaying | bool | 是否正在播放 |
Future<void> setMute(bool mute) async;
参数名 | 类型 | 描述 |
mute | bool | 是否静音 |
Future<void> setVolume(int volume);
参数名 | 类型 | 描述 |
volume | int | 视频声音大小,范围0~100 |
Future<void> setLiveMode(TXPlayerLiveMode mode) async;
参数名 | 类型 | 描述 |
mode | int | 直播模式,自动模式、极速模式、流畅模式 |
Future<void> setAppID(int appId) async;
参数名 | 类型 | 描述 |
appId | int | appId |
Future<void> setConfig(FTXLivePlayConfig config) async;
参数名 | 类型 | 描述 |
config | FTXLivePlayConfig | 请参考 FTXLivePlayConfig类 |
Future<bool> enableHardwareDecode(bool enable);
参数名 | 类型 | 描述 |
enable | bool | 是否开启硬解 |
参数名 | 类型 | 描述 |
result | bool | 硬解/软解设置结果 |
Future<int> enterPictureInPictureMode({String? backIconForAndroid, String? playIconForAndroid, String? pauseIconForAndroid, String? forwardIconForAndroid}) async;
参数名 | 类型 | 描述 |
backIcon | String | 回退按钮图标,由于 android 平台限制,图标大小不得超过1M,可不传,不传则使用系统自带图标 |
playIcon | String | 播放按钮图标,由于 android 平台限制,图标大小不得超过1M,可不传,不传则使用系统自带图标 |
pauseIcon | String | 暂停按钮图标,由于 android 平台限制,图标大小不得超过1M,可不传,不传则使用系统自带图标 |
forwardIcon | String | 快进按钮图标,由于 android 平台限制,图标大小不得超过1M,可不传,不传则使用系统自带图标 |
参数名 | 值 | 描述 |
NO_ERROR | 0 | 启动成功,没有错误 |
ERROR_PIP_LOWER_VERSION | -101 | android版本过低,不支持画中画模式 |
ERROR_PIP_DENIED_PERMISSION | -102 | 画中画模式权限未打开,或者当前设备不支持画中画 |
ERROR_PIP_ACTIVITY_DESTROYED | -103 | 当前界面已经销毁 |
ERROR_IOS_PIP_DEVICE_NOT_SUPPORT | -104 | 设备或系统版本不支持(iPad iOS9+ 才支持PIP),只适用于 iOS |
ERROR_IOS_PIP_PLAYER_NOT_SUPPORT | -105 | 播放器不支持,只适用于 iOS |
ERROR_IOS_PIP_VIDEO_NOT_SUPPORT | -106 | 视频不支持,只适用于 iOS |
ERROR_IOS_PIP_IS_NOT_POSSIBLE | -107 | PIP控制器不可用,只适用于 iOS |
ERROR_IOS_PIP_FROM_SYSTEM | -108 | PIP控制器报错,只适用于 iOS |
ERROR_IOS_PIP_PLAYER_NOT_EXIST | -109 | 播放器对象不存在,只适用于 iOS |
ERROR_IOS_PIP_IS_RUNNING | -110 | PIP功能已经运行,只适用于 iOS |
ERROR_IOS_PIP_NOT_RUNNING | -111 | PIP功能没有启动,只适用于 iOS |
Future<void> dispose() async;
Future<int> switchStream(String url) async;
参数名 | 类型 | 描述 |
url | String | 需要切换的视频源 |
参数名 | 类型 | 描述 |
result | int | 切换结果 |
参数名 | 类型 | 描述 |
cacheTime | double | 播放器缓存时间,单位秒,取值需要大于0,默认值:5 |
maxAutoAdjustCacheTime | double | 播放器缓存自动调整的最大时间,单位秒,取值需要大于0,默认值:5 |
minAutoAdjustCacheTime | double | 播放器缓存自动调整的最小时间,单位秒,取值需要大于0,默认值为1 |
videoBlockThreshold | int | 播放器视频卡顿报警阈值,单位毫秒,只有渲染间隔超过这个阈值的卡顿才会有 PLAY_WARNING_VIDEO_PLAY_LAG 通知 |
connectRetryCount | int | 播放器遭遇网络连接断开时 SDK 默认重试的次数,取值范围1 - 10,默认值:3。 |
connectRetryInterval | int | 网络重连的时间间隔,单位秒,取值范围3 - 30,默认值:3。 |
autoAdjustCacheTime | bool | 是否自动调整播放器缓存时间,默认值:true。true:启用自动调整,自动调整的最大值和最小值可以分别通过修改 maxCacheTime 和 minCacheTime 来设置。false:关闭自动调整,采用默认的指定缓存时间(1s),可以通过修改 cacheTime 来调整缓存时间 |
enableAec | bool | 是否开启回声消除, 默认值为 false |
enableMessage | bool | 是否开启消息通道, 默认值为 true |
enableMetaData | bool | 是否开启 MetaData 数据回调,默认值为 NO。 true:SDK 通过 EVT_PLAY_GET_METADATA 消息抛出视频流的 MetaData 数据;false:SDK 不抛出视频流的 MetaData 数据。 |
flvSessionKey | String | 是否开启 HTTP 头信息回调,默认值为 “” |
[SuperPlayerPlugin.setGlobalCacheFolderPath]
和缓存大小[SuperPlayerPlugin.setGlobalMaxCacheSize]
,这个设置是全局配置需和播放器保持一致,否则会造成播放缓存失效。Future<int> startPreLoad(final String playUrl,final int preloadSizeMB,final int preferredResolution, {FTXPredownlodOnCompleteListener? onCompleteListener,FTXPredownlodOnErrorListener? onErrorListener,}) async
Future<void> startPreload(TXPlayInfoParams txPlayInfoParams, final int preloadSizeMB, final int preferredResolution, { FTXPredownlodOnCompleteListener? onCompleteListener, FTXPredownlodOnErrorListener? onErrorListener, FTXPredownlodOnStartListener? onStartListener, }) async
参数名 | 类型 | 描述 |
playUrl | String | 要预下载的 url |
preloadSizeMB | int | 预下载的大小(单位:MB) |
preferredResolution | int | 期望分辨率,值为高x宽。可参考如720*1080。不支持多分辨率或不需指定时,传-1 |
onCompleteListener | FTXPredownlodOnCompleteListener? | 预下载成功回调,全局 |
onErrorListener | FTXPredownlodOnErrorListener | 预下载失败回调,全局 |
参数名 | 类型 | 描述 |
appId | int | 应用appId。必填 |
fileId | String | 文件id。必填 |
url | String | 视频url,与fileId只用填写一个,如果都填写,url优先 |
sign | String |
参数名 | 类型 | 描述 |
taskId | int | 任务 ID |
Future<void> stopPreLoad(final int taskId) async
参数名 | 类型 | 描述 |
taskId | int | 任务 ID |
Future<void> startDownload(TXVodDownloadMediaInfo mediaInfo) async
参数名 | 类型 | 描述 |
mediaInfo | TXVodDownloadMediaInfo | 下载任务信息 |
参数名 | 类型 | 描述 |
playPath | String? | 缓存地址,获得到的视频缓存会有该值,启动下载可以不赋值 |
progress | double? | 缓存进度,获得到的视频缓存会有该值,启动下载可以不赋值 |
downloadState | int? | 缓存状态,获得到的视频缓存会有该值,启动下载可以不赋值 |
userName | String? | 下载账户名称,用于区分不同账户的下载,传空则为 default |
duration | int? | 缓存视频总时长,Android 端单位为毫秒,iOS 为秒,获得到的视频缓存会有该值,启动下载可以不赋值 |
playableDuration | int? | 视频已缓存时长,Android 端单位为毫秒,iOS 为秒,获得到的视频缓存会有该值,启动下载可以不赋值 |
size | int? | 文件总大小,单位:byte,获得到的视频缓存会有该值,启动下载可以不赋值 |
downloadSize | int? | 文件已下载的大小,单位:byte,获得到的视频缓存会有该值,启动下载可以不赋值 |
url | String? | 需要下载的视频 url,url 下载必填,不支持嵌套 m3u8 和 mp4 下载 |
dataSource | TXVodDownloadDataSource? | 需要下载的视频 fileId 信息,url 与该参数可只使用一个 |
speed | int? | 下载速度,单位:KByte/秒 |
isResourceBroken | bool? | 资源是否已损坏, 如:资源被删除了 |
参数名 | 类型 | 描述 |
appId | int? | 下载文件对应的 appId,必填 |
fileId | String? | 下载文件 Id,必填 |
pSign | String? | 加密签名,加密视频必填 |
quality | int? | 清晰度 ID,必传 |
token | String? | 加密 token |
userName | String? | 下载账户名称,用于区分不同账户的下载,传空则为 default |
Future<void> stopDownload(TXVodDownloadMediaInfo mediaInfo) async
参数名 | 类型 | 描述 |
mediaInfo | TXVodDownloadMediaInfo | 任务信息 |
Future<void> setDownloadHeaders(Map<String, String> headers) async
参数名 | 类型 | 描述 |
headers | Map<String, String> | 请求头信息 |
Future<List<TXVodDownloadMediaInfo>> getDownloadList() async
参数名 | 类型 | 描述 |
mediaInfoList | List<TXVodDownloadMediaInfo> | 任务列表,可通过对比 userName 来区分不同用户的下载 |
Future<TXVodDownloadMediaInfo> getDownloadInfo(TXVodDownloadMediaInfo mediaInfo) async
参数名 | 类型 | 描述 |
mediaInfo | TXVodDownloadMediaInfo | 任务信息 |
参数名 | 类型 | 描述 |
mediaInfo | TXVodDownloadMediaInfo | 缓存任务详情信息 |
void setDownloadObserver(FTXDownlodOnStateChangeListener downlodOnStateChangeListener, FTXDownlodOnErrorListener downlodOnErrorListener)
参数名 | 类型 | 描述 |
downlodOnStateChangeListener | FTXDownlodOnStateChangeListener | 任务下载状态回调 |
downlodOnErrorListener | FTXDownlodOnErrorListener | 任务下载错误回调 |
Future<bool> deleteDownloadMediaInfo(TXVodDownloadMediaInfo mediaInfo) async
参数名 | 类型 | 描述 |
mediaInfo | TXVodDownloadMediaInfo | 任务下载信息 |
参数名 | 类型 | 描述 |
result | bool | 删除结果 |
本页内容是否解决了您的问题?