文档中心

视频直播

SDK API 参考

类型详情

LicenseConfig

类型：interface

AppID

类型：string
App ID，可在视频直播控制台的应用管理页面获取。详见获取 SDK License。

AppName

类型：string
应用英文名，可在视频直播控制台的应用管理页面获取。详见获取 SDK License。

AppVersion

类型：string
应用版本号。合法版本号应包含 2 个或以上的分隔符（.），例如 "1.3.2"。

AppChannel

类型：string
渠道号。由您自定义，如小米应用商店 (xiaomi)、华为应用市场 (huawei) 等。

LicenseUri

类型：{ android: string; ios: string; }
nativeResources 文件夹下 License 文件所在的相对路径。

说明

Android 和 iOS 的相对路径形式有所区别。

成员

名称	类型	说明
android	`string`	Android 的 License 文件相对路径。例如 `assets:///ttsdk.lic`。
ios	`string`	iOS 的 License 文件相对路径。例如 `ttsdk.lic`。

openLog

类型：boolean | undefined
是否开启日志上报。建议仅 debug 模式开启。默认值为 true。取值如下：

true：开启。开启后，Android 可通过 logcat 捕获日志，iOS 可通过 Xcode 捕获日志。
false：关闭。

UserUniqueID

类型：string | undefined
用户 ID，全局唯一，由您自定义。用于查询指定用户的日志信息。

PackageName

类型：string | undefined
Android 应用的唯一标识。不传，则默认使用创建应用时配置的 PackageName。

BundleID

类型：string | undefined
iOS 应用的唯一标识。不传，则默认使用创建应用时配置的 Bundle ID。

VeLivePlayerResolution

类型：enum
直播播放器的清晰度档位。

属性	值	说明
VeLivePlayerResolutionOrigin	`0`	原始流。
VeLivePlayerResolutionUHD	`1`	UHD 超高清。
VeLivePlayerResolutionHD	`2`	HD 高清。
VeLivePlayerResolutionSD	`3`	SD 标清。
VeLivePlayerResolutionLD	`4`	LD 低清。

VeLivePlayerConfiguration

类型：class
播放器初始化相关配置。

enableSei

类型：boolean
是否开启 SEI 消息的解析，默认值为 false。

true：开启；
false：关闭。

enableHardwareDecode

类型：boolean
是否开启硬件解码功能，默认值为 true。开启硬件解码后，如果出现硬件解码启动失败或硬件解码失败的情况，播放器内部会自动切换为软解。

true：开启；
false：关闭。

networkTimeoutMs

类型：number
网络超时时间，单位为 ms，默认值为 5000。播放器发起网络请求，如果超过了该时间仍未收到服务器响应，则认为网络请求失败。

retryIntervalTimeMs

类型：number
重试时间间隔，单位为 ms，默认值为 5000，仅在无备流时生效。

在无备流的场景下，若遇到网络异常等问题导致播放中断，播放器会立即进行重试，前三次重试为立即执行，第四次及之后的重试将按照设置的重试时间间隔执行；
在有备流的场景下，重试时间间隔将不生效，所有重试均会立即执行。

retryMaxCount

类型：number
在网络连接错误的情况下，播放器最大重试次数，默认值为 5。如果取值为 0，表示关闭播放器内部重试。

在无备流的场景下，每次重试，会消耗一次重试次数；
在有备流的场景下，每次主备流切换，会消耗一次重试次数。

enableLiveDNS

类型：boolean
是否开启本地 DNS 预解析，默认值为 false。开启本地 DNS 预解析可以缩短启播时间。如果本地 DNS 预解析出现异常，可能会影响播放器的正常使用。

true：开启；
false：关闭。

enableStatisticsCallback

类型：boolean
是否开启播放信息周期性回调。默认值为 false。周期性回调参数详细说明请参见 VeLivePlayerStatistics 。当 enableStatisticsCallback 为 true，且 statisticsCallbackInterval 大于 0 时，播放器会在指定的时间间隔内，周期性地回调播放器状态信息。

true：开启；
false：关闭。

statisticsCallbackInterval

类型：number
播放信息周期性回调的时间间隔，单位为 s，默认值为 5。当 enableStatisticsCallback 为 true，且 statisticsCallbackInterval 大于 0 时，播放器会在指定的时间间隔内，周期性地回调播放器状态信息。

VeLivePlayerFormat

类型：enum
直播播放格式。

属性	值	说明
VeLivePlayerFormatFLV	`0`	FLV 格式。
VeLivePlayerFormatHLS	`1`	HLS 格式。
VeLivePlayerFormatRTM	`2`	RTM 格式。

VeLivePlayerProtocol

类型：enum
直播播放传输协议。

属性	值	说明
VeLivePlayerProtocolTCP	`0`	TCP 协议。
VeLivePlayerProtocolQUIC	`1`	QUIC 协议。
VeLivePlayerProtocolTLS	`2`	TLS 协议。

VeLivePlayerMirror

类型：enum
视频镜像。

属性	值	说明
VeLivePlayerMirrorNone	`0`	关闭镜像。
VeLivePlayerMirrorHorizontal	`1`	水平镜像。
VeLivePlayerMirrorVertical	`2`	垂直镜像。

VeLivePlayerVideoBufferType

类型：enum
视频数据封装格式。

属性	值	说明
VeLivePlayerVideoBufferTypeUnknown	`0`	未知格式。
VeLivePlayerVideoBufferTypeByteBuffer	`1`	ByteBuffer 格式。
VeLivePlayerVideoBufferTypeByteArray	`2`	ByteArray 格式。
VeLivePlayerVideoBufferTypeTexture	`3`	纹理格式。
VeLivePlayerVideoBufferTypePixelBuffer	`5`	CVPixelBufferRef 格式。
VeLivePlayerVideoBufferTypeSampleBuffer	`6`	CVSampleBufferRef 格式。
VeLivePlayerVideoBufferTypeNSData	`7`	NSData 格式。

VeLivePlayerStatus

类型：enum
直播播放器状态。

属性	值	说明
VeLivePlayerStatusStopped	`3`	停止播放状态。
VeLivePlayerStatusPaused	`2`	暂停播放状态。
VeLivePlayerStatusPrepared	`0`	播放器准备完成，等待渲染。
VeLivePlayerStatusPlaying	`1`	正在播放，即首帧渲染完成且播放器未发生错误。
VeLivePlayerStatusError	`4`	播放器发生错误。

VeLivePlayerStreamData

类型：class
播放地址相关配置。

enableABR

类型：boolean
是否打开 ABR 平滑切档功能，默认为 false。

true：开启；
false：关闭。

enableMainBackupSwitch

类型：boolean
是否打开主备切换，默认为 false。

true：开启；
false：关闭。

defaultResolution

类型：[VeLivePlayerResolution ](/docs/6469/1909498#veliveplayerresolution)
播放器的默认清晰度档位，默认使用原始流清晰度。详情请参见 VeLivePlayerResolution 。

defaultFormat

类型：[VeLivePlayerFormat ](/docs/6469/1909498#veliveplayerformat)
播放器的默认播放格式，默认值为 FLV。详情请参见 VeLivePlayerFormat 。

defaultProtocol

类型：[VeLivePlayerProtocol ](/docs/6469/1909498#veliveplayerprotocol)
播放器的默认播放传输层协议，默认值为 TCP。详情请参见 VeLivePlayerProtocol 。

mainStreamList

类型：[VeLivePlayerStream](/docs/6469/1909498#veliveplayerstream)[]
主路流地址列表，详情请参见 VeLivePlayerStream。

backupStreamList

类型：[VeLivePlayerStream](/docs/6469/1909498#veliveplayerstream)[]
备路流地址列表。详情请参见VeLivePlayerStream。

VeLivePlayerStream

类型：class
流地址信息。

url

类型：string
播放地址。

resolution

类型：[VeLivePlayerResolution ](/docs/6469/1909498#veliveplayerresolution)
清晰度档位。详情请参见 VeLivePlayerResolution 。

bitrate

类型：number
播放码率，单位为 kbps。

format

类型：[VeLivePlayerFormat ](/docs/6469/1909498#veliveplayerformat)
播放格式。详情请参见 VeLivePlayerFormat 。

streamType

类型：$p_a.VeLivePlayerStreamType
播放流类型为主路或备路。详情请参见 VeLivePlayerStreamType 。

VeLivePlayerResolutionSwitchReason

类型：enum
直播播放器清晰度档位变化原因。

属性	值	说明
VeLivePlayerResolutionSwitchByAuto	`0`	ABR 自动切档。
VeLivePlayerResolutionSwitchByManual	`1`	手动切换档位。

VeLivePlayerFillMode

类型：enum
直播播放器画面的填充模式。

属性	值	说明
VeLivePlayerFillModeAspectFit	`0`	显示完整的视频帧。视频帧等比缩放，直至视频帧恰好在画布上全部显示。如果视频帧长宽比例与画布不同，视窗上未被视频帧填满区域将填充为黑色。
VeLivePlayerFillModeFullFill	`1`	视频帧自适应画布。视频帧非等比缩放，直至填满画布。在此过程中，视频帧的长宽比例可能会发生变化。
VeLivePlayerFillModeAspectFill	`2`	视频填满画布。视频帧等比缩放，直至填满画布，超出屏幕的部分将被裁剪，画面可能不完整。

VeLivePlayerPixelFormat

类型：enum
视频帧像素格式。

属性	值	说明
VeLivePlayerPixelFormatUnknown	`0`	未知格式。
VeLivePlayerPixelFormatRGBA32	`1`	RGBA8888 格式。
VeLivePlayerPixelFormatTexture	`2`	纹理格式。
VeLivePlayerPixelFormatNV12	`4`	NV12 格式。
VeLivePlayerPixelFormatI420	`5`	YUVI420 格式。
VeLivePlayerPixelFormatBGRA32	`6`	BGRA 格式。

VeLivePlayerStatistics

类型：class
播放周期性统计信息。

url

类型：string
只读, 当前直播的播放地址。

isHardwareDecode

类型：boolean
只读, 是否使用硬件解码。

true：硬解；
false：非硬解。

videoCodec

类型：string
只读, 视频的编码类型。

stallTimeMs

类型：number
只读, 从当前视频开始播放起，累计的卡顿时长，单位为 ms。

bandwidthEstimation

类型：number
只读, 带宽预测，单位为 kbps

delayMs

类型：number
只读, 当前播放延时，单位为 ms。仅在使用了火山引擎视频直播推流 SDK 时，支持统计播放延时。

width

类型：number
只读, 当前播放视频的宽度，单位为 px。

height

类型：number
只读, 当前播放视频的高度，单位为 px。

fps

类型：number
只读, 当前播放视频的帧率，单位为 fps。

bitrate

类型：number
只读, 实时下载的码率，单位为 kbps。

videoBufferMs

类型：number
只读, 视频播放的缓冲区 buffer 大小，单位为 ms。

audioBufferMs

类型：number
只读, 音频播放的缓冲区 buffer 大小，单位为 ms。

format

类型：[VeLivePlayerFormat ](/docs/6469/1909498#veliveplayerformat)
只读, 当前播放的视频格式。

protocol

类型：[VeLivePlayerProtocol ](/docs/6469/1909498#veliveplayerprotocol)
只读, 当前播放的传输协议。

VeLivePlayerVideoFrame

类型：class
视频帧数据。

bufferType

类型：[VeLivePlayerVideoBufferType ](/docs/6469/1909498#veliveplayervideobuffertype)
视频帧数据封装格式。详情请参见 VeLivePlayerVideoBufferType 。

pixelFormat

类型：[VeLivePlayerPixelFormat ](/docs/6469/1909498#veliveplayerpixelformat)
视频帧像素格式。详情请参见 VeLivePlayerPixelFormat 。

width

类型：number
视频宽度，单位为 px。

height

类型：number
视频高度，单位为 px。

pts

类型：number
视频帧的渲染时间戳。单位为 ms。

android_buffer

类型：ArrayBuffer
pixelFormat 为 VeLivePlayerPixelFormatRGBA32 时的视频数据，ByteBuffer 格式。

data

类型：ArrayBuffer
pixelFormat 为 VeLivePlayerPixelFormatRGBA32 时的视频数据，ByteArray 格式。

VeLivePlayerStreamType

类型：enum
直播播放流类型。

属性	值	说明
VeLivePlayerStreamTypeMain	`0`	主路流。
VeLivePlayerStreamTypeBackup	`1`	备路流。

VeLivePlayerLogLevel

类型：enum
直播播放器日志打印级别。

属性	值	说明
VeLivePlayerLogLevelVerbose	`0`	输出 VERBOSE、DEBUG、INFO、WARNING 和 ERROR 级别的日志。
VeLivePlayerLogLevelDebug	`1`	输出 DEBUG、INFO、WARNING 和 ERROR 级别的日志。
VeLivePlayerLogLevelInfo	`2`	输出 INFO、WARNING 和 ERROR 级别的日志。
VeLivePlayerLogLevelWarn	`3`	输出 WARNING 和 ERROR 级别的日志。
VeLivePlayerLogLevelError	`4`	输出 ERROR 级别的日志。
VeLivePlayerLogLevelNone	`5`	关闭日志打印。

VeLivePlayerAudioFrame

类型：class
音频帧数据。

bufferType

类型：[VeLivePlayerAudioBufferType ](/docs/6469/1909498#veliveplayeraudiobuffertype)
音频帧数据封装格式，详情请参见 VeLivePlayerAudioBufferType 。

sampleRate

类型：number
音频采样率，单位为 Hz。

channels

类型：number
声道数。

1：单声道；
2：双声道。

bitDepth

类型：number
音频位深度。

pts

类型：number
音频渲染时间戳。单位为 ms。

android_buffer

类型：ArrayBuffer
PCM 音频数据。

samples

类型：number
音频采样点个数。

VeLivePlayerAudioBufferType

类型：enum
音频数据封装格式。

属性	值	说明
VeLivePlayerAudioBufferTypeUnknown	`0`	未知格式。
VeLivePlayerAudioBufferTypeByteArray	`1`	ByteArray 格式。
VeLivePlayerAudioBufferUnknown	`3`	未知格式。
VeLivePlayerAudioBufferTypeSampleBuffer	`4`	CVSampleBufferRef 格式，音频数据以样本缓冲区 sample buffer 的形式进行处理和渲染。
VeLivePlayerAudioBufferTypeNSData	`5`	NSData 格式，音频数据以 NSData 对象的形式进行处理和渲染。

VeLivePlayerRotation

类型：enum
视频顺时针旋转角度。

属性	值	说明
VeLivePlayerRotation0	`0`	关闭旋转。
VeLivePlayerRotation90	`1`	顺时针旋转 90 度。
VeLivePlayerRotation180	`2`	顺时针旋转 180 度。
VeLivePlayerRotation270	`3`	顺时针旋转 270 度。

InitOptions

类型：interface
播放器初始化相关配置。

enableSei

类型：boolean
是否开启 SEI 消息的解析，默认值为 false。

true：开启；
false：关闭。

enableHardwareDecode

true：开启；
false：关闭。

networkTimeoutMs

类型：number
网络超时时间，单位为 ms，默认值为 5000。播放器发起网络请求，如果超过了该时间仍未收到服务器响应，则认为网络请求失败。

retryIntervalTimeMs

类型：number
重试时间间隔，单位为 ms，默认值为 5000，仅在无备流时生效。

在无备流的场景下，若遇到网络异常等问题导致播放中断，播放器会立即进行重试，前三次重试为立即执行，第四次及之后的重试将按照设置的重试时间间隔执行；
在有备流的场景下，重试时间间隔将不生效，所有重试均会立即执行。

retryMaxCount

类型：number
在网络连接错误的情况下，播放器最大重试次数，默认值为 5。如果取值为 0，表示关闭播放器内部重试。

在无备流的场景下，每次重试，会消耗一次重试次数；
在有备流的场景下，每次主备流切换，会消耗一次重试次数。

enableLiveDNS

true：开启；
false：关闭。

enableStatisticsCallback

true：开启；
false：关闭。

statisticsCallbackInterval

viewId

类型：number
viewId，播放器视图 ID

最近更新时间：2026.03.31 16:08:23

这个页面对您有帮助吗？

有用

无用

视频直播

LicenseConfig #

AppID #

AppName #

AppVersion #

AppChannel #

LicenseUri #

openLog #

UserUniqueID #

PackageName #

BundleID #

VeLivePlayerResolution #

VeLivePlayerConfiguration #

enableSei #

enableHardwareDecode #

networkTimeoutMs #

retryIntervalTimeMs #

retryMaxCount #

enableLiveDNS #

enableStatisticsCallback #

statisticsCallbackInterval #

VeLivePlayerFormat #

VeLivePlayerProtocol #

VeLivePlayerMirror #

VeLivePlayerVideoBufferType #

VeLivePlayerStatus #

VeLivePlayerStreamData #

enableABR #

enableMainBackupSwitch #

defaultResolution #

defaultFormat #

defaultProtocol #

mainStreamList #

backupStreamList #

VeLivePlayerStream #

url #

resolution #

bitrate #

format #

streamType #

VeLivePlayerResolutionSwitchReason #

VeLivePlayerFillMode #

VeLivePlayerPixelFormat #

VeLivePlayerStatistics #

url #

isHardwareDecode #

videoCodec #

stallTimeMs #

bandwidthEstimation #

delayMs #

width #

height #

fps #

bitrate #

videoBufferMs #

audioBufferMs #

format #

protocol #

VeLivePlayerVideoFrame #

bufferType #

pixelFormat #

width #

height #

pts #

android_buffer #

data #

VeLivePlayerStreamType #

VeLivePlayerLogLevel #

VeLivePlayerAudioFrame #

bufferType #

sampleRate #

channels #

bitDepth #

pts #

android_buffer #

samples #

VeLivePlayerAudioBufferType #

VeLivePlayerRotation #

InitOptions #

enableSei #

LicenseConfig

AppID

AppName

AppVersion

AppChannel

LicenseUri

openLog

UserUniqueID

PackageName

BundleID

VeLivePlayerResolution

VeLivePlayerConfiguration

enableSei

enableHardwareDecode

networkTimeoutMs

retryIntervalTimeMs

retryMaxCount

enableLiveDNS

enableStatisticsCallback

statisticsCallbackInterval

VeLivePlayerFormat

VeLivePlayerProtocol

VeLivePlayerMirror

VeLivePlayerVideoBufferType

VeLivePlayerStatus

VeLivePlayerStreamData

enableABR

enableMainBackupSwitch

defaultResolution

defaultFormat

defaultProtocol

mainStreamList

backupStreamList

VeLivePlayerStream

url

resolution

bitrate

format

streamType

VeLivePlayerResolutionSwitchReason

VeLivePlayerFillMode

VeLivePlayerPixelFormat

VeLivePlayerStatistics

url

isHardwareDecode

videoCodec

stallTimeMs

bandwidthEstimation

delayMs

width

height

fps

bitrate

videoBufferMs

audioBufferMs

format

protocol

VeLivePlayerVideoFrame

bufferType

pixelFormat

width

height

pts

android_buffer

data

VeLivePlayerStreamType

VeLivePlayerLogLevel

VeLivePlayerAudioFrame

bufferType

sampleRate

channels

bitDepth

pts

android_buffer

samples

VeLivePlayerAudioBufferType

VeLivePlayerRotation

InitOptions

enableSei

enableHardwareDecode