回调--视频直播-火山引擎

文档中心

立即注册

导航

回调

最近更新时间：2024.08.02 17:34:00首次发布时间：2024.08.02 17:34:00

VeLiveMediaPlayerListener

类型：interface

播放器播放回调。通过该回调，您可以获取与播放相关的事件和通知。

onStart

开始播放的回调。

类型

((info: $p_a.Bundle) => void) | undefined

参数

名称	类型	是否必选	默认值	说明
info	$p_a.Bundle	是	无	-

onProgress

播放进度的回调，每 100ms 触发一次。

类型

((timeMs: number) => void) | undefined

参数

名称	类型	是否必选	默认值	说明
timeMs	number	是	无	播放进度，单位为 ms。

onStop

停止播放的回调。

类型

(() => void) | undefined

onError

返错误状态的回调。

类型

((code: number, msg: string) => void) | undefined

参数

名称	类型	是否必选	默认值	说明
code	number	是	无	错误码，详情请参见 VeLivePusherErrorCode。
msg	string	是	无	错误消息。

VeLivePusherObserver

类型：interface

回调协议，用于监听推流器的推流错误、状态、网络质量、设备、首帧等回调事件等。

onError

推流错误回调。

类型

((code: number, subCode: number, msg: string) => void) | undefined

参数

名称	类型	是否必选	默认值	说明
code	number	是	无	错误码。详情请参见 VeLivePusherErrorCode。
subCode	number	是	无	子错误码。
msg	string	是	无	错误信息。

onStatusChange

推流状态变化回调。

类型

((status: VeLivePusherStatus) => void) | undefined

参数

名称	类型	是否必选	默认值	说明
status	VeLivePusherStatus	是	无	变化后的推流状态。详情请参见 VeLivePusherStatus。

onFirstVideoFrame

首帧视频回调，当推流器发送出第一帧视频时，触发该回调。

类型

((type: VeLiveFirstFrameType, timestampMs: number) => void) | undefined

参数

名称	类型	是否必选	默认值	说明
type	VeLiveFirstFrameType	是	无	首帧的类型，详情请参见 VeLiveFirstFrameType。
timestampMs	number	是	无	时间戳，单位为 ms。

onFirstAudioFrame

首帧音频回调，当推流器发送出第一帧音频时，触发该回调。

类型

((type: VeLiveFirstFrameType, timestampMs: number) => void) | undefined

参数

名称	类型	是否必选	默认值	说明
type	VeLiveFirstFrameType	是	无	首帧的类型，详情请参见 VeLiveFirstFrameType。
timestampMs	number	是	无	时间戳，单位为 ms。

onCameraOpened

摄像头开启/关闭回调，当推流器的摄像头开启或关闭时，触发该回调。

类型

((open: boolean) => void) | undefined

参数

名称	类型	是否必选	默认值	说明
open	boolean	是	无	摄像头的新状态是否为开启。 true：摄像头开启； false：摄像头关闭。

onMicrophoneOpened

麦克风开启/关闭回调，当推流器的麦克风开启或关闭时，触发该回调。

类型

((open: boolean) => void) | undefined

参数

名称	类型	是否必选	默认值	说明
open	boolean	是	无	麦克风的新状态是否为开启。 true：麦克风开启； false：麦克风关闭。

android_onScreenRecording

屏幕采集开启/关闭回调，当推流器的屏幕采集开启或关闭时，触发该回调。

类型

((open: boolean) => void) | undefined

参数

名称	类型	是否必选	默认值	说明
open	boolean	是	无	屏幕采集的新状态是否为开启。 true：屏幕采集开启； false：屏幕采集关闭。

onNetworkQuality

网络质量状态回调，当推流器检测到网络质量发生变化时，触发该回调。

类型

((quality: VeLiveNetworkQuality) => void) | undefined

参数

名称	类型	是否必选	默认值	说明
quality	VeLiveNetworkQuality	是	无	变化后的网络质量。详情请参见 VeLiveNetworkQuality。

onAudioPowerQuality

音量等级回调，当推流器的音频音量等级发生变化时，触发该回调。

类型

((level: VeLiveAudioPowerLevel, value: number) => void) | undefined

参数

名称	类型	是否必选	默认值	说明
level	VeLiveAudioPowerLevel	是	无	变化后的音量等级。详情请参见 VeLiveAudioPowerLevel。
value	number	是	无	当前音量的分贝值（dB）。 -1 表示当前没有获取到对应的音量分贝值。分贝数小于 1，对应 VeLiveAudioPowerLevelSilent 级别分贝数大于 1 小于等于 15，对应 VeLiveAudioPowerLevelQuiet 级别分贝数大于 15 小于等于 30，对应 VeLiveAudioPowerLevelLight 级别分贝数大于 30 小于等于 60，对应 VeLiveAudioPowerLevelNormal 级别分贝数大于 60 小于等于 85，对应 VeLiveAudioPowerLevelLoud 分贝数大于 85，对应 VeLiveAudioPowerLevelNoisy 级别

VeLivePusherStatisticsObserver

类型：interface

推流器周期性回调。

onStatistics

推流周期性统计信息回调。

类型

((statistics: VeLivePusherStatistics) => void) | undefined

参数

名称	类型	是否必选	默认值	说明
statistics	VeLivePusherStatistics	是	无	周期性统计信息，默认每 5s 回调一次。详情请参见 VeLivePusherStatistics。

onLogMonitor

周期性日志信息回调。

类型

((logInfo: object) => void) | undefined

参数

名称	类型	是否必选	默认值	说明
logInfo	object	是	无	周期性日志信息。

VeLiveFileRecordingListener

类型：interface

直播录制回调。

onFileRecordingStarted

直播录制开始回调。

类型

(() => void) | undefined

onFileRecordingStopped

直播录制停止回调。

类型

(() => void) | undefined

onFileRecordingError

直播录制错误回调。

类型

((errorCode: number, message: string) => void) | undefined

参数

名称	类型	是否必选	默认值	说明
errorCode	number	是	无	错误码，详情请参见 VeLivePusherErrorCode。
message	string	是	无	错误信息。