自定义视频采集和渲染
- macOS
更新时间不可用
createCustomVideoTrack
创建一个自定义视频轨道。
- (unsigned int)createCustomVideoTrack NS_SWIFT_NAME(createCustomVideoTrack());要发布自定义视频源,请按照以下步骤操作:
- 调用该方法创建一个视频轨道,并获取视频轨道 ID。
- 调用
joinChannelByToken加入频道。在 AgoraRtcChannelMediaOptions 中,将customVideoTrackId设置为你想要发布的视频轨道 ID,并将publishCustomVideoTrack设置为 YES。 - 调用
pushExternalVideoFrame,并将videoTrackId设置为第 2 步中设置的视频轨道 ID,即可在频道中发布对应的自定义视频源。
返回值
- 方法调用成功时,返回视频轨道 ID,作为该视频轨道的唯一标识符。
- 方法调用失败时,返回
0xffffffff。
所属接口类
destroyCustomVideoTrack:
销毁指定的视频轨道。
- (int)destroyCustomVideoTrack:(NSUInteger)videoTrackId NS_SWIFT_NAME(destroyCustomVideoTrack(_:));参数
| 参数名 | 描述 |
|---|---|
videoTrackId | 调用 createCustomVideoTrack 方法返回的视频轨道 ID。 |
返回值
- 0:方法调用成功。
- < 0:方法调用失败。详见错误码了解详情和解决建议。
所属接口类
pushExternalVideoFrame:videoTrackId:
通过视频轨道将外部原始视频帧推送到 SDK。
- (BOOL)pushExternalVideoFrame:(AgoraVideoFrame * _Nonnull)frame videoTrackId:(NSUInteger)videoTrackId NS_SWIFT_NAME(pushExternalVideoFrame(_:videoTrackId:));要发布自定义视频源,请按照以下步骤操作:
- 调用 createCustomVideoTrack 创建视频轨道并获取视频轨道 ID。
- 调用
joinChannelByToken加入频道。在 AgoraRtcChannelMediaOptions 中,将customVideoTrackId设置为要发布的视频轨道 ID,并将publishCustomVideoTrack设置为 YES。 - 调用 pushExternalVideoFrame:videoTrackId: 方法,并将
videoTrackId指定为第 2 步中设置的视频轨道 ID,即可在频道中发布相应的自定义视频源。
参数
| 参数名 | 描述 |
|---|---|
frame | 要推送的外部原始视频帧。详见 AgoraVideoFrame。 |
videoTrackId |
返回值
- YES:推送外部视频帧成功。
- NO:推送外部视频帧失败。
所属接口类
pushExternalVideoFrame:
将外部原始视频帧推送到 SDK。
- (BOOL)pushExternalVideoFrame:(AgoraVideoFrame * _Nonnull)frame NS_SWIFT_NAME(pushExternalVideoFrame(_:)) __deprecated_msg("use pushExternalVideoFrame:frame,videoTrackId options instead.");废弃
该方法已废弃,请改用 pushExternalVideoFrame:frame,videoTrackId。
调用 setExternalVideoSource:useTexture:sourceType: 方法,并将 enabled 参数设置为 YES,encodedFrame 参数设置为 NO 后,可以调用该方法将外部原始视频帧推送到 SDK。
参数
| 参数名 | 描述 |
|---|---|
frame | 要推送的外部原始视频帧。详见 AgoraVideoFrame。 |
返回值
- YES:方法调用成功。
- NO:方法调用失败。
所属接口类
setExternalVideoSource:useTexture:sourceType:
配置外部视频源。
- (void)setExternalVideoSource:(BOOL)enable useTexture:(BOOL)useTexture sourceType:(AgoraExternalVideoSourceType)sourceType NS_SWIFT_NAME(setExternalVideoSource(_:useTexture:sourceType:));调用该方法启用外部视频源后,可以调用 pushExternalVideoFrame:videoTrackId: 方法将外部视频数据推送到 SDK。
注: 频道内不支持动态切换视频源。如需从外部视频源切换为内部视频源,必须先离开频道,调用该方法关闭外部视频源,再重新加入频道。
调用时机
该方法需要在加入频道前调用。
参数
| 参数名 | 描述 |
|---|---|
enable | |
useTexture | |
sourceType | 外部视频帧的类型,详见 AgoraExternalVideoSourceType。 |