You need to enable JavaScript to run this app.
导航

回调

最近更新时间2024.04.19 14:57:37

首次发布时间2022.11.01 18:14:39

VeLiveVideoFrameFilter
public interface VeLiveVideoFrameFilter

自定义的视频处理回调。

成员函数

返回名称
default intonVideoProcess

函数说明

onVideoProcess

default int onVideoProcess(
    VeLiveVideoFrame srcFrame,
    VeLiveVideoFrame dstFrame
)

自定义的视频处理方法。

传入参数

参数名类型说明
srcFrameVeLiveVideoFrame源视频帧,详情请参见 VeLiveVideoFrame
dstFrameVeLiveVideoFrame处理后的视频帧,详情请参见 VeLiveVideoFrame

返回值

  • 0:处理成功;
  • <0:处理失败,该帧会被 SDK 丢弃;
  • >0:处理失败,该帧会被 SDK 继续传递到编码器。

VeLiveVideoFrameListener
public interface VeLiveVideoFrameListener

视频帧订阅回调。

成员函数

返回名称
default VeLiveVideoFrameSourcegetObservedVideoFrameSource
default voidonCaptureVideoFrame
default voidonPreEncodeVideoFrame

函数说明

getObservedVideoFrameSource

default VeLiveVideoFrameSource getObservedVideoFrameSource()

设置当前 Listener 需要的视频帧来源。

返回值

您所要订阅的视频数据的位置信息,详情请参见 VeLiveVideoFrameSource

onCaptureVideoFrame

default void onCaptureVideoFrame(VeLiveVideoFrame frame)

采集视频帧回调。只有当您通过 getObservedVideoFrameSource 返回 VeLiveVideoFrameSourceCapture 时,才会触发该回调。

传入参数

参数名类型说明
frameVeLiveVideoFrame视频帧数据,详情请参见 VeLiveVideoFrame

onPreEncodeVideoFrame

default void onPreEncodeVideoFrame(VeLiveVideoFrame frame)

编码前视频帧回调。只有当您通过 getObservedVideoFrameSource 返回 VeLiveVideoFrameSourcePreEncode 时,才会触发该回调。

传入参数

参数名类型说明
frameVeLiveVideoFrame视频帧数据,详情请参见 VeLiveVideoFrame

VeLiveVideoEffectCallback
public interface VeLiveVideoEffectCallback

视频特效回调。

成员函数

返回名称
default voidonResult

函数说明

onResult

default void onResult(
    int result,
    String msg
)

视频特效处理结果回调。

传入参数

参数名类型说明
resultint处理结果
msgString消息

VeLiveMediaPlayerListener
public interface VeLiveMediaPlayerListener

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

成员变量

类型默认值名称
String"has_video_stream"KEY_HAS_VIDEO_STREAM
String"has_audio_stream"KEY_HAS_AUDIO_STREAM
String"duration"KEY_DURATION
String"video_width"KEY_VIDEO_WIDTH
String"video_height"KEY_VIDEO_HEIGHT

成员函数

返回名称
default voidonStart
default voidonProgress
default voidonStop
default voidonError

变量说明

KEY_HAS_VIDEO_STREAM

public String KEY_HAS_VIDEO_STREAM = "has_video_stream"

是否有视频流。

KEY_HAS_AUDIO_STREAM

public String KEY_HAS_AUDIO_STREAM = "has_audio_stream"

是否有音频流。

KEY_DURATION

public String KEY_DURATION = "duration"

音视频总时长,单位为 ms。

KEY_VIDEO_WIDTH

public String KEY_VIDEO_WIDTH = "video_width"

视频的宽度。

KEY_VIDEO_HEIGHT

public String KEY_VIDEO_HEIGHT = "video_height"

视频的高度。

函数说明

onStart

default void onStart(Bundle info)

开始播放的回调。

传入参数

参数名类型说明
infoBundle-

onProgress

default void onProgress(long timeMs)

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

传入参数

参数名类型说明
timeMslong播放进度,单位为 ms。

onStop

default void onStop()

停止播放的回调。

onError

default void onError(
    int code,
    String msg
)

返错误状态的回调。

传入参数

参数名类型说明
codeint错误码,详情请参见 VeLivePusherErrorCode
msgString错误消息。

VeLiveAudioFrameListener
public interface VeLiveAudioFrameListener

音频帧订阅回调。

成员函数

返回名称
default VeLiveAudioFrameSourcegetObservedAudioFrameSource
default voidonCaptureAudioFrame
default voidonPreEncodeAudioFrame

函数说明

getObservedAudioFrameSource

default VeLiveAudioFrameSource getObservedAudioFrameSource()

设置当前 Listener 需要的音频帧来源。

返回值

订阅的音频帧位置信息,详情请参见 VeLiveAudioFrameSource

onCaptureAudioFrame

default void onCaptureAudioFrame(VeLiveAudioFrame frame)

采集音频帧回调。只有当您通过 getObservedAudioFrameSource 返回 VeLiveAudioFrameSourceCapture 时,才会触发该回调。

传入参数

参数名类型说明
frameVeLiveAudioFrame音频帧数据,详情请参见 VeLiveAudioFrame

onPreEncodeAudioFrame

default void onPreEncodeAudioFrame(VeLiveAudioFrame frame)

编码前音频帧回调。只有当您通过 getObservedAudioFrameSource 返回 VeLiveAudioFrameSourcePreEncode 时,才会触发该回调。

传入参数

参数名类型说明
frameVeLiveAudioFrame音频帧数据,详情请参见 VeLiveAudioFrame

VeLiveMediaPlayerFrameListener
public interface VeLiveMediaPlayerFrameListener

播放器音视频帧回调。通过该回调,您可以获取音频和视频帧的数据。

成员函数

返回名称
default voidonAudioFrame
default voidonVideoFrame

函数说明

onAudioFrame

default void onAudioFrame(VeLiveAudioFrame frame)

播放器音频帧回调。

传入参数

参数名类型说明
frameVeLiveAudioFrame音频帧,详情请参见 VeLiveAudioFrame

onVideoFrame

default void onVideoFrame(VeLiveVideoFrame frame)

播放器视频帧回调。当完成一个新的视频帧的解码后,触发该回调。

传入参数

参数名类型说明
frameVeLiveVideoFrame视频帧数据,包含了帧的时间戳和格式等信息,详情请参见 VeLiveVideoFrame

VeLiveSnapshotListener
public interface VeLiveSnapshotListener

直播截图回调。

成员函数

返回名称
default voidonSnapshotComplete

函数说明

onSnapshotComplete

default void onSnapshotComplete(Bitmap image)

截图成功回调。

传入参数

参数名类型说明
imageBitmap视频的截图。

注意

调用 snapshot 截图成功后,会收到这个回调。

VeLiveAudioFrameFilter
public interface VeLiveAudioFrameFilter

自定义的音频处理回调。

成员函数

返回名称
default intonAudioProcess

函数说明

onAudioProcess

default int onAudioProcess(
    VeLiveAudioFrame srcFrame,
    VeLiveAudioFrame dstFrame
)

自定义的音频处理方法。

传入参数

参数名类型说明
srcFrameVeLiveAudioFrame源音频帧,详情请参见 VeLiveAudioFrame
dstFrameVeLiveAudioFrame处理后的音频帧,详情请参见 VeLiveAudioFrame
  • 0:处理成功;
  • ≠0:处理失败,该帧会被 SDK 继续传递到编码器;

VeLivePusherObserver
public interface VeLivePusherObserver

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

成员函数

返回名称
default voidonError
default voidonStatusChange
default voidonFirstVideoFrame
default voidonFirstAudioFrame
default voidonCameraOpened
default voidonMicrophoneOpened
default voidonScreenRecording
default voidonNetworkQuality
default voidonAudioPowerQuality

函数说明

onError

default void onError(
    int code,
    int subCode,
    String msg
)

推流错误回调。

传入参数

参数名类型说明
codeint错误码。详情请参见 VeLivePusherErrorCode
subCodeint子错误码。
msgString错误信息。

onStatusChange

default void onStatusChange(VeLivePusherStatus status)

推流状态变化回调。

传入参数

参数名类型说明
statusVeLivePusherStatus变化后的推流状态。详情请参见 VeLivePusherStatus

onFirstVideoFrame

default void onFirstVideoFrame(
    VeLiveFirstFrameType type,
    long timestampMs
)

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

传入参数

参数名类型说明
typeVeLiveFirstFrameType首帧的类型,详情请参见 VeLiveFirstFrameType
timestampMslong时间戳,单位为 ms。

onFirstAudioFrame

default void onFirstAudioFrame(
    VeLiveFirstFrameType type,
    long timestampMs
)

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

传入参数

参数名类型说明
typeVeLiveFirstFrameType首帧的类型,详情请参见 VeLiveFirstFrameType
timestampMslong时间戳,单位为 ms。

onCameraOpened

default void onCameraOpened(boolean open)

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

传入参数

参数名类型说明
openboolean摄像头的新状态是否为开启。
  • true:摄像头开启;
  • false:摄像头关闭。

onMicrophoneOpened

default void onMicrophoneOpened(boolean open)

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

传入参数

参数名类型说明
openboolean麦克风的新状态是否为开启。
  • true:麦克风开启;
  • false:麦克风关闭。

onScreenRecording

default void onScreenRecording(boolean open)

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

传入参数

参数名类型说明
openboolean屏幕采集的新状态是否为开启。
  • true:屏幕采集开启;
  • false:屏幕采集关闭。

onNetworkQuality

default void onNetworkQuality(VeLiveNetworkQuality quality)

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

传入参数

参数名类型说明
qualityVeLiveNetworkQuality变化后的网络质量。详情请参见 VeLiveNetworkQuality

onAudioPowerQuality

default void onAudioPowerQuality(
    VeLiveAudioPowerLevel level,
    float value
)

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

传入参数

参数名类型说明
levelVeLiveAudioPowerLevel变化后的音量等级。详情请参见 VeLiveAudioPowerLevel
valuefloat当前音量的分贝值(dB)。
  • -1 表示当前没有获取到对应的音量分贝值。
  • 分贝数小于 1,对应 VeLiveAudioPowerLevelSilent 级别
  • 分贝数大于 1 小于等于 15,对应 VeLiveAudioPowerLevelQuiet 级别
  • 分贝数大于 15 小于等于 30,对应 VeLiveAudioPowerLevelLight 级别
  • 分贝数大于 30 小于等于 60,对应 VeLiveAudioPowerLevelNormal 级别
  • 分贝数大于 60 小于等于 85,对应 VeLiveAudioPowerLevelLoud
  • 分贝数大于 85,对应 VeLiveAudioPowerLevelNoisy 级别

VeLivePusherStatisticsObserver
public interface VeLivePusherStatisticsObserver

推流器周期性回调。

成员函数

返回名称
default voidonStatistics
default voidonLogMonitor

函数说明

onStatistics

default void onStatistics(VeLivePusherStatistics statistics)

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

传入参数

参数名类型说明
statisticsVeLivePusherStatistics周期性统计信息,默认每 5s 回调一次。详情请参见 VeLivePusherStatistics

onLogMonitor

default void onLogMonitor(JSONObject logInfo)

周期性日志信息回调。

传入参数

参数名类型说明
logInfoJSONObject周期性日志信息。

VeLivePusherDef
public class VeLivePusherDef

类型定义。

VeLiveFileRecordingListener
public interface VeLiveFileRecordingListener

直播录制回调。

成员函数

返回名称
default voidonFileRecordingStarted
default voidonFileRecordingStopped
default voidonFileRecordingError

函数说明

onFileRecordingStarted

default void onFileRecordingStarted()

直播录制开始回调。

onFileRecordingStopped

default void onFileRecordingStopped()

直播录制停止回调。

onFileRecordingError

default void onFileRecordingError(
    int errorCode,
    String message
)

直播录制错误回调。

传入参数

参数名类型说明
errorCodeint错误码,详情请参见 VeLivePusherErrorCode
messageString错误信息。

VeLiveVideoEffectHandleCallback
public interface VeLiveVideoEffectHandleCallback

视频特效对象回调。

成员函数

返回名称
default voidonEffectHandle

函数说明

onEffectHandle

default void onEffectHandle(Object handle)

视频特效对象回调,调用 setAdvancedFeature 接口时触发此回调,如需使用请联系技术支持

传入参数

参数名类型说明
handleObject视频特效对象。