自定义视频采集和渲染
createCustomVideoTrack
创建一个自定义的视频轨道。
Objective-C
- (unsigned int)createCustomVideoTrack;
详情
当你需要在频道中发布自定义采集视频时,可参考以下步骤:
- 调用该方法创建视频轨道并获得视频轨道 ID。
- 调用 joinChannelByToken [2/4] 加入频道时,将 AgoraRtcChannelMediaOptions 中的 customVideoTrackId 设置为你想要发布的视频轨道 ID,并将 publishCustomVideoTrack 设置为
YES
。 - 调用 pushExternalVideoFrame [1/2] 将 videoTrackId 指定为步骤 2 中指定的视频轨道 ID,即可实现在频道内发布对应的自定义视频源。
返回值
- 方法调用成功,返回视频轨道 ID 作为该视频轨道的唯一标识。
- 方法调用失败,返回负值。详见错误码了解详情和解决建议。
destroyCustomVideoTrack
销毁指定的视频轨道。
Objective-C
- (int)destroyCustomVideoTrack:(NSUInteger)videoTrackId;
参数
- videoTrackId
- 调用 createCustomVideoTrack 方法返回的视频轨道 ID。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
pushExternalVideoFrame [1/2]
将外部原始视频帧通过自定义视频轨道发布到频道中。
Objective-C
- (BOOL)pushExternalVideoFrame:(AgoraVideoFrame * _Nonnull)frame videoTrackId:(NSUInteger)videoTrackId NS_SWIFT_NAME(pushExternalVideoFrame(_:videoTrackId:));
详情
当你需要在频道中发布自定义采集视频时,可参考以下步骤:
- 调用 createCustomVideoTrack 方法创建视频轨道并获得视频轨道 ID。
- 调用 joinChannelByToken [2/4] 加入频道时,将 AgoraRtcChannelMediaOptions 中的 customVideoTrackId 设置为你想要发布的视频轨道 ID,并将 publishCustomVideoTrack 设置为
YES
。 - 调用该方法将 videoTrackId 指定为步骤 2 中指定的视频轨道 ID,即可实现在频道内发布对应的自定义视频源。
警告
调用该方法后,即使你停止推送外部视频帧到 SDK,自定义采集的视频流仍然会被计入视频时长用量并产生费用,声网建议你根据实际情况采取相应措施避免此类视频计费:
- 如果你不再需要采集外部视频数据,可以调用 destroyCustomVideoTrack 销毁自定义采集的视频轨道。
- 如果你只想将采集到的外部视频数据用于本地预览、而不在频道内发布,可以调用 muteLocalVideoStream 取消发送视频流,或调用 updateChannelWithMediaOptions 将 publishCustomVideoTrack 设置为
NO
。
参数
- frame
待推送的视频帧。详见 AgoraVideoFrame。
- videoTrackId
- 调用 createCustomVideoTrack 方法返回的视频轨道 ID。默认值为 0。
返回值
YES
:方法调用成功。NO
:方法调用失败。详见错误码了解详情和解决建议。
pushExternalVideoFrame [2/2]
推送外部原始视频帧到 SDK。
Objective-C
- (BOOL)pushExternalVideoFrame:(AgoraVideoFrame * _Nonnull)frame NS_SWIFT_NAME(pushExternalVideoFrame(_:))
详情
调用 setExternalVideoSource 方法,设置 enabled 参数为 YES
、encodedFrame 参数为 NO
后,你可以调用本方法将未编码的外部视频帧推送到 SDK。
参数
- frame
待推送的视频帧。详见 AgoraVideoFrame。
返回值
YES
:方法调用成功。NO
:方法调用失败。详见错误码了解详情和解决建议。
setExternalVideoSource
设置外部视频源。
Objective-C
- (void)setExternalVideoSource:(BOOL)enable useTexture:(BOOL)useTexture sourceType:(AgoraExternalVideoSourceType)sourceType;
详情
注意
请在加入频道前调用该方法。
参数
- enable
- 是否启用外部视频源:
YES
: 启用外部视频源。SDK 准备接收外部视频帧。NO
:(默认)不启用外部视频源。
- useTexture
- 是否使用 Texture 格式的外部视频帧:
YES
: 使用 Texture 格式的外部视频帧。NO
: 不使用 Texture 格式的外部视频帧。
- sourceType
- 外部视频帧是否编码,详见 AgoraExternalVideoSourceType。