You need to enable JavaScript to run this app.
视频直播

视频直播

Copy page
Download PDF
SDK API 参考
概览
Copy page
Download PDF
概览

方法

方法

描述

initWithType:

初始化特定类型的播放器。

setEnableSharpen:

设置是否开启视频锐化。开启后,可以使视频中的边缘和细节更加突出,使画面看起来更加清晰和生动。

isSupportResolutionSwitch:

检查播放器当前是否支持指定的分辨率档位。

setConfig:

初始化播放器,用于设置是否开启 SEI 消息、是否开启硬件解码和是否开启本地 DNS 预解析等配置信息。

setObserver:

设置播放器回调,用于监听播放器 VeLivePlayer 的播放错误、播放状态、音视频首帧渲染状态和清晰度档位信息等回调事件。

setRenderFillMode:

设置播放器画面的填充模式。

setPlayUrl:

设置单个直播播放地址。

getVersion

获取播放器 SDK 的版本号。

setPlayStreamData:

多路流信息配置。例如,您需要使用 ABR、手动切档和主备流等依赖多路流的功能,可以调用本方法进行配置。

setLogLevel:

设置打印日志的级别。

play

开始/恢复播放。

stop

停止播放,不销毁播放器。

init

播放器初始化方法。

switchResolution:

切换播放的清晰度档位。

setMute:

设置是否静音播放。

isMute

获取是否处于静音状态。

destroy

停止播放,并销毁播放器。

snapshot

视频截图。

enableVideoFrameObserver:pixelFormat:bufferType:

设置视频帧回调。

enableAudioFrameObserver:enableRendering:

设置音频帧回调。

getStreamList

获取流信息。

setEnableSuperResolution:

设置是否开启超分。

setUrlHostIP:

设置域名和服务器的 IP 地址映射关系。

setRenderRotation:

设置视频顺时针旋转角度。

setRenderMirror:

设置视频镜像。

setProperty:value:

设置播放器高级配置。高级配置包括离屏渲染设置、缓冲区最大时长、ABR 码率自适应算法类型等,如需了解详细信息,请联系技术支持

setVeHttpDNSAuth:key:

该方法用来设置使用火山引擎 HTTPDNS 服务时需要的鉴权信息。

prefetchDomains:

该方法用来解析域名,并将解析结果存储在缓存中。

回调

方法

描述

onError:error:

播放器错误信息回调,播放器出现错误时,触发此回调。

onAudioRenderStall:stallTime:

音频渲染卡顿回调。音频渲染发生卡顿时,触发此回调。

onVideoRenderStall:stallTime:

视频渲染卡顿回调。视频渲染发生卡顿时,触发此回调。

onFirstAudioFrameRender:isFirstFrame:

音频首帧渲染事件回调。音频首帧渲染成功,或播放过程中发生重试,重试后的第一个音频帧渲染成功,均会触发此回调。

onInfo:info:

播放器信息回调。在播放器有内部错误时,SDK 会触发此回调。

onResolutionSwitch:resolution:error:reason:

清晰度档位发生变化回调。

onVideoSizeChanged:width:height:

视频分辨率变化回调。视频大小发生变化时,触发此回调。

onReceiveBinarySeiMessage:message:

二级制 SEI 消息回调,当播放器 SDK 接收到 SEI 消息时,触发该回调。需要开启 VeLivePlayerConfiguration 中 enableBinarySei 属性。当 enableBinarySei 属性开启时,字符串 SEI 消息将不再发送。

onMainBackupSwitch:streamType:error:

主备流切换回调。

onPlayerStatusUpdate:status:

播放状态发生变化时,触发此回调。

onStatistics:statistics:

播放信息周期性回调。播放器 SDK 会周期性地回调本方法,您可以通过本方法获取当前播放器的播放地址、码率和帧率等信息。

onSnapshotComplete:image:

截图成功回调。当播放器调用 snapshot 截图成功后,触发此回调。

onRenderVideoFrame:videoFrame:

视频帧回调。调用 enableVideoFrameObserver:pixelFormat:bufferType: 开启视频帧解析回调后,当播放器成功解码视频帧时,会触发此回调。

onRenderAudioFrame:audioFrame:

音频帧回调。调用 enableAudioFrameObserver:enableRendering:开启音频帧解析回调后,当播放器成功解码音频帧时,会触发此回调。

onStreamFailedOpenSuperResolution:error:

超分开启失败。调用 setEnableSuperResolution:开启超分后,当播放器不支持超分开启或者超分处理出错时,会触发此回调。

getDrmResourceLoaderCertificateData:

您需要在此回调中返回 FairPlay 证书的 NSData 数据。

getDrmResourceLoaderLicenseUrl:

您需要在此回调中返回 DRM license 的 URL。

onReceiveSeiMessage:message:

字符串 SEI 消息回调,当播放器 SDK 接收到 SEI 消息时,触发该回调。需要开启 VeLivePlayerConfiguration 中 enableSei 属性。当 enableBinarySei 属性开启时,字符串 SEI 消息将不再发送。

onStallStart:

播放卡顿开始回调。

onStallEnd:

播放卡顿结束回调。音频缓冲区达到起播条件且开始播放后,触发此回调。

onFirstVideoFrameRender:isFirstFrame:

视频首帧渲染事件回调。视频首帧渲染成功,或播放过程中发生重试,重试后的第一个视频帧渲染成功,均会触发此回调。

onStreamFormatSwitch:fromStreamFormat:toStreamFormat:error:extraInfo:

当播放器切换流的格式时,SDK 会触发此回调。

Last updated: 2026.04.07 23:17:22