已编码视频数据

  • React Native

更新时间不可用

addListener

添加一个 IMediaEngineEvent 监听器。

TypeScript
addListener?<EventType extends keyof IMediaEngineEvent>(
      eventType: EventType,
      listener: IMediaEngineEvent[EventType]
    ): void;

成功调用该方法后,你可以通过 IMediaEngineEvent 监听对应 IMediaEngine 对象的事件、获取数据。根据业务需要,你可以为同一事件添加多个监听器。

参数

参数名描述
eventType

需要监听的目标事件名。详见 IMediaEngineEvent。

listener

eventType 对应的回调函数。以添加 onPlaybackAudioFrameBeforeMixing 为例:

Text
const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {};
engine.addListener('onPlaybackAudioFrameBeforeMixing', onPlaybackAudioFrameBeforeMixing);
表格内容超出当前宽度,可横向滚动查看更多列。

所属接口类

registerVideoEncodedFrameObserver

为编码后的视频图像注册视频帧接收观测器。

TypeScript
abstract registerVideoEncodedFrameObserver(
    observer: IVideoEncodedFrameObserver
  ): number;

如果你只想要观测编码后的视频帧 (如 H.264 格式),而不需要对视频进行解码和渲染,声网推荐你通过该方法注册一个 IVideoEncodedFrameObserver 类。

注: 该方法需要在加入频道前调用。

参数

参数名描述
observer

视频帧接收观测器,详见 IVideoEncodedFrameObserver。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0:方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

removeAllListeners

移除指定事件的所有监听器。

TypeScript
removeAllListeners?<EventType extends keyof IMediaEngineEvent>(
      eventType?: EventType
    ): void;

参数

参数名描述
eventType

需要监听的目标事件名。详见 IMediaEngineEvent。

表格内容超出当前宽度,可横向滚动查看更多列。

所属接口类

removeListener

移除指定的 IMediaEngineEvent 监听器。

TypeScript
removeListener?<EventType extends keyof IMediaEngineEvent>(
      eventType: EventType,
      listener: IMediaEngineEvent[EventType]
    ): void;

参数

参数名描述
eventType

需要监听的目标事件名。详见 IMediaEngineEvent。

listener

eventType 对应的回调函数。必须传入 addListener 中传入的同一个函数对象。以取消监听 onJoinChannelSuccess 为例:

Text
const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {};
engine.addListener('onPlaybackAudioFrameBeforeMixing', onPlaybackAudioFrameBeforeMixing);
engine.removeListener('onPlaybackAudioFrameBeforeMixing', onPlaybackAudioFrameBeforeMixing);
表格内容超出当前宽度,可横向滚动查看更多列。

所属接口类

unregisterVideoEncodedFrameObserver

为编码后的视频图像取消注册视频帧接收观测器。

TypeScript
abstract unregisterVideoEncodedFrameObserver(
    observer: IVideoEncodedFrameObserver
  ): number;

参数

参数名描述
observer

视频帧观测器,观测每帧视频的接收, 详见 IVideoEncodedFrameObserver。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

onEncodedVideoFrameReceived

报告接收端已收到远端发送的待解码视频帧。

TypeScript
onEncodedVideoFrameReceived?(
    channelId: string,
    uid: number,
    imageBuffer: Uint8Array,
    length: number,
    videoEncodedFrameInfo: EncodedVideoFrameInfo
  ): void;

调用 setRemoteVideoSubscriptionOptions 方法并将 encodedFrameOnly 设置为 true 时,SDK 会在本地触发该回调,上报接收到的编码后视频帧信息。

参数

参数名描述
channelId

频道名。

uid

远端用户 ID。

imageBuffer

视频图像 buffer。

length

视频图像的数据长度。

videoEncodedFrameInfo

编码后的视频帧信息,详见 EncodedVideoFrameInfo。

表格内容超出当前宽度,可横向滚动查看更多列。

所属接口类