- 自从
- v3.5.0
IVideoSink 类,可以设置自定义的视频渲染器。
实时音视频互动过程中,Agora SDK 会启动默认的渲染器渲染本地及远端视频。IVideoSink 接口可以自定义视频渲染器, 你可以先实现该接口,然后通过调用 setLocalVideoRenderer 或 setRemoteVideoRenderer 自定义你想要的视频渲染器。
◆ onInitialize()
virtual bool agora::rtc::IVideoSink::onInitialize |
( |
| ) |
|
|
pure virtual |
初始化视频渲染器回调。
- 自从
- v3.5.0
SDK 触发该回调提醒你初始化视频渲染器。你可以在该回调中做一些准备工作,然后通过该回调的返回值告诉 SDK 自定义的渲染器是否已经完成初始化, SDK 会根据返回值采取对应的行为。
- 返回
- true: 自定义的渲染器已经完成初始化工作。SDK 会准备好发送待渲染的视频数据。
- false: 自定义的渲染器没准备好或者初始化失败。SDK 会上报错误。
◆ onStart()
virtual bool agora::rtc::IVideoSink::onStart |
( |
| ) |
|
|
pure virtual |
启动渲染器回调。
- 自从
- v3.5.0
SDK 触发该回调提醒你启动视频渲染。你可以在该回调中启动自定义的视频渲染器,然后通过该回调的返回值告诉 SDK 自定义的渲染器是否已经完成启动后, SDK 会根据返回值采集对应的行为。
- 返回
- true: 自定义的渲染器已经完成启动。SDK 会将待渲染的视频数据传输给自定义的渲染器进行渲染。
- false: 自定义的渲染器没有完成启动或者启动失败。SDK 会停止传输数据并上报错误。
◆ onStop()
virtual void agora::rtc::IVideoSink::onStop |
( |
| ) |
|
|
pure virtual |
停止渲染器回调。
- 自从
- v3.5.0
SDK 触发该回调提醒你停止视频渲染。该回调通知你 SDK 即将停止向自定义的渲染器传输视频数据。
◆ onDispose()
virtual void agora::rtc::IVideoSink::onDispose |
( |
| ) |
|
|
pure virtual |
释放渲染器回调。
- 自从
- v3.5.0
SDK 触发该回调提醒你关闭自定义视频渲染器。
◆ getBufferType()
查询视频帧数据类型。
- 自从
- v3.5.0
在你初始化自定义渲染器之前,SDK 会触发该回调查询你想要处理的视频帧的数据类型。 你必须在该回调的返回值中指定一种视频帧类型来告知 SDK。
- 返回
- VIDEO_BUFFER_TYPE
◆ getPixelFormat()
查询视频帧像素格式。
- 自从
- v3.5.0
在你初始化自定义渲染器之前,SDK 会触发该回调查询你想要处理的视频帧的像素格式。 你必须在该回调的返回值中指定一种像素格式来通知给 SDK。
- 返回
- VIDEO_PIXEL_FORMAT
◆ onRenderPixelBuffer()
virtual void agora::rtc::IVideoSink::onRenderPixelBuffer |
( |
CVPixelBufferRef |
pixelBuffer, |
|
|
int |
rotation |
|
) |
| |
|
pure virtual |
渲染 Pixel 格式的视频数据回调。
- 自从
- v3.5.0
SDK 在采集到 Pixel 格式的视频数据后,会触发该回调,提醒自定义的渲染器处理该视频数据。
- 注解
- 该方法仅适用于 iOS 平台。
- 参数
-
pixelBuffer | Pixel 类型的视频数据。 |
rotation | 视频的顺时针旋转角度。 |
◆ onRenderRawData()
virtual void agora::rtc::IVideoSink::onRenderRawData |
( |
uint8_t * |
rawData, |
|
|
int |
width, |
|
|
int |
height, |
|
|
int |
rotation |
|
) |
| |
|
pure virtual |
渲染原始数据类型的视频数据回调。
- 自从
- v3.5.0
SDK 在采集到原始数据格式的视频数据后,会触发该回调,提醒自定义的渲染器处理该视频数据。
- 参数
-
rawData | 原始数据类型的视频数据。 |
width | 视频宽度 (px)。 |
height | 视频高度 (px)。 |
rotation | 视频的顺时针旋转角度。 |