音视频观测器
- Electron
更新时间不可用
registerAudioFrameObserver
注册音频帧观测器。
abstract registerAudioFrameObserver(
observer: IAudioPcmFrameSink,
mode?: RawAudioFrameOpModeType
): number;参数
| 参数名 | 描述 |
|---|---|
observer | 音频帧观测器，观测每帧音频的接收，详见 IAudioPcmFrameSink。 |
mode | 音频帧的使用模式，详见 RawAudioFrameOpModeType。 |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
registerPlayerSourceObserver
注册一个播放观测器。
abstract registerPlayerSourceObserver(
observer: IMediaPlayerSourceObserver
): number;调用时机
加入频道前后均可调用。
参数
| 参数名 | 描述 |
|---|---|
observer | 播放观测器，报告播放中的事件，详见 IMediaPlayerSourceObserver。 |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
registerVideoFrameObserver
注册视频帧观测器。
abstract registerVideoFrameObserver(
observer: IMediaPlayerVideoFrameObserver
): number;你需要在该方法中实现一个 IMediaPlayerVideoFrameObserver 类，并根据场景需要，注册该类的回调。成功注册视频帧观测器后，SDK 会在捕捉到每个视频帧时，触发你所注册的回调。
参数
| 参数名 | 描述 |
|---|---|
observer | 视频帧观测器，观测每帧视频的接收。详见 IMediaPlayerVideoFrameObserver。 |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
unregisterAudioFrameObserver
取消注册音频帧观测器。
abstract unregisterAudioFrameObserver(observer: IAudioPcmFrameSink): number;参数
| 参数名 | 描述 |
|---|---|
observer | 音频帧观测器，详见 IAudioPcmFrameSink。 |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
unregisterPlayerSourceObserver
取消注册播放观测器。
abstract unregisterPlayerSourceObserver(
observer: IMediaPlayerSourceObserver
): number;参数
| 参数名 | 描述 |
|---|---|
observer | 播放观测器，报告播放中的事件，详见 IMediaPlayerSourceObserver。 |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
unregisterVideoFrameObserver
取消注册视频帧观测器。
abstract unregisterVideoFrameObserver(
observer: IMediaPlayerVideoFrameObserver
): number;参数
| 参数名 | 描述 |
|---|---|
observer | 视频帧观测器，观测每帧视频的接收，详见 IMediaPlayerVideoFrameObserver。 |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
onAudioVolumeIndication
媒体播放器音量提示回调。
onAudioVolumeIndication?(volume: number): void;SDK 每 200 毫秒触发一次该回调，报告媒体播放器当前的音量。
参数
所属接口类
onFrame
已获取音频帧回调。
onFrame?(frame: AudioPcmFrame): void;注册音频数据观测器后，每次接收到一帧音频帧时，都会触发该回调，报告音频帧信息。
参数
| 参数名 | 描述 |
|---|---|
frame | 音频帧信息。详见 AudioPcmFrame。 |
所属接口类
onMetaData
报告已获取媒体附属信息。
onMetaData?(data: Uint8Array, length: number): void;解析媒体附属信息后时，SDK 会触发该回调，报告媒体附属信息的数据类型和具体数据。
参数
所属接口类
onPlayBufferUpdated
报告当前缓冲数据能播放的时间。
onPlayBufferUpdated?(playCachedBuffer: number): void;播放在线媒体资源的过程中，SDK 会每隔 1 秒触发一次该回调，报告当前缓冲的数据能支持的播放时间。
- 当缓冲数据支持的播放时间小于阈值（默认为 0）时，返回
PlayerEventBufferLow(6)。 - 当缓冲数据支持的播放时间大于阈值（默认为 0）时，返回
PlayerEventBufferRecover(7)。
参数
所属接口类
onPlayerEvent
报告播放器的事件。
onPlayerEvent?(
eventCode: MediaPlayerEvent,
elapsedTime: number,
message: string
): void;- 调用 seek 定位播放后，SDK 会触发该回调，报告定位播放的结果。
参数
| 参数名 | 描述 |
|---|---|
eventCode | 播放器事件，详见 MediaPlayerEvent。 |
elapsedTime | |
message |
所属接口类
onPlayerInfoUpdated
媒体播放器相关信息发生改变回调。
onPlayerInfoUpdated?(info: PlayerUpdatedInfo): void;当媒体播放器相关信息发生改变时，SDK 会触发该回调。你可用其进行问题定位和排查。
参数
| 参数名 | 描述 |
|---|---|
info | 媒体播放器相关信息。详见 PlayerUpdatedInfo。 |
所属接口类
onPlayerSourceStateChanged
报告播放器状态改变。
onPlayerSourceStateChanged?(
state: MediaPlayerState,
reason: MediaPlayerReason
): void;当播放器状态改变时，SDK 会触发该回调，报告新的播放状态。
参数
| 参数名 | 描述 |
|---|---|
state | 新的播放状态，详见 MediaPlayerState。 |
reason | 播放器状态改变的原因，详见 MediaPlayerReason。 |
所属接口类
onPlayerSrcInfoChanged
媒体资源视频码率变化回调。
onPlayerSrcInfoChanged?(from: SrcInfo, to: SrcInfo): void;参数
所属接口类
onPositionChanged
报告当前媒体资源的播放进度。
onPositionChanged?(positionMs: number, timestampMs: number): void;播放媒体文件时，SDK 每隔 1 秒会自动触发该回调，报告当前播放进度。
参数
所属接口类
onPreloadEvent
报告预加载媒体资源的事件。
onPreloadEvent?(src: string, event: PlayerPreloadEvent): void;参数
| 参数名 | 描述 |
|---|---|
src | |
event | 预加载媒体资源时发生的事件。详见 PlayerPreloadEvent。 |