ZegoExternalVideoRender Class Reference

Inherits from NSObject
Declared in zego-api-external-video-render-oc.h

Overview

提供视频外部渲染功能

+ sharedInstance

获取 ZegoExternalVideoRender 单例

+ (instancetype)sharedInstance

Return Value

ZegoExternalVideoRender 单例对象

Declared In

zego-api-external-video-render-oc.h

– setExternalVideoRenderDelegate:

设置外部渲染代理对象

- (void)setExternalVideoRenderDelegate:(id<ZegoExternalVideoRenderDelegate>)delegate

Parameters

delegate

外部渲染代理,详见 delegate ZegoExternalVideoRenderDelegate。

Discussion

  • 注意:
  • 1.未设置代理,不会收到视频数据的回调。
  • 2.推荐使用单例对象设置外部渲染代理,保证回调是全局唯一的。

Warning: Deprecated 请使用 setZegoVideoRenderDelegate

Declared In

zego-api-external-video-render-oc.h

+ enableExternalVideoRender:type:

设置是否开启外部渲染

+ (void)enableExternalVideoRender:(BOOL)enable type:(VideoExternalRenderType)type

Parameters

enable

YES 表示开启外部渲染,NO 表示关闭外部渲染

type

视频外部渲染类型,详见 enum VideoExternalRenderType。

Discussion

  • 当出现 SDK 的渲染无法满足需求时,或者 App 需要获取 SDK 采集或拉流的视频数据进行特殊处理时,又或者 App 使用了跨平台界面框架(例如 QT 需要有复杂层级关系的界面以实现高体验的交互)或游戏引擎(例如 Unity3D、Cocos2d-x)等情况时建议使用 SDK 的自定义视频渲染功能。
  • 注意:
  • 1.此 API 必须在初始化 SDK 之前调用。
  • 2.开启外部渲染后,需要设置外部渲染代理(setExternalVideoRenderDelegate:)才能收到视频数据再做相应的渲染处理。

Warning: Deprecated 请使用 setVideoRenderType

Declared In

zego-api-external-video-render-oc.h

+ enableVideoRender:streamID:

开/关外部视频渲染(拉流),拉流时 App 能拿到 SDK 抛出的视频数据。

+ (bool)enableVideoRender:(BOOL)enable streamID:(NSString *)streamID

Parameters

enable

YES 开启外部视频渲染, NO 关闭外部视频渲染,默认为不开启

streamID

拉流的流 ID

Discussion

  • 注意:
  • 1.只有当 enableExternalVideoRender:type: 的 type 参数设置为 VideoExternalRenderTypeDecodeRender,该接口才有效。
  • 2.必须在拉流(startPlayingStream)之后调用才生效。

Declared In

zego-api-external-video-render-oc.h

+ enableVideoPreview:channelIndex:

开/关外部视频渲染(推流预览),推流时 App 能拿到 SDK 抛出的视频数据。

+ (bool)enableVideoPreview:(BOOL)enable channelIndex:(ZegoAPIPublishChannelIndex)channelIndex

Parameters

enable

YES 开启外部视频渲染, NO 关闭外部视频渲染,默认为不开启

channelIndex

推流通道,详见 enum ZegoAPIPublishChannelIndex,默认为主推流通道。

Discussion

  • 注意:
  • 1.只有当 enableExternalVideoRender:type: 的 type 参数设置为 VideoExternalRenderTypeDecodeRender,该接口才有效。
  • 2.必须在 初始化 SDK 之后调用才生效。

Declared In

zego-api-external-video-render-oc.h

+ setVideoRenderType:

设置开启外部渲染时要求 SDK 提供的数据格式及渲染方式

+ (void)setVideoRenderType:(VideoRenderType)type

Parameters

type

指定 SDK 提供的数据格式及渲染方式

Discussion

Note: 在初始化 SDK 之前调用有效

Declared In

zego-api-external-video-render-oc.h

– setZegoVideoRenderDelegate:

设置外部渲染回调

- (void)setZegoVideoRenderDelegate:(id<ZegoVideoRenderDelegate>)delegate

Parameters

delegate

外部渲染回调代理,用于接收待渲染的视频数据

Declared In

zego-api-external-video-render-oc.h