PanoRtcVideoStreamManager 接口类提供了应用程序调用所需的所有视频流相关方法。更多...

#import <PanoRtcEngineKit.h>

类 PanoRtcVideoStreamManager 继承关系图:

构造函数
(instancetype)	- init
	此方法不可用。

(PanoResult)	- setDelegate:
	设置视频流管理器回调对象，用以接收视频流事件。更多...

(SInt32)	- createVideoStream:
	创建一个新的视频流。更多...

(PanoResult)	- destroyVideoStream:
	销毁一个视频流。更多...

(PanoResult)	- setCaptureDevice:stream:
	设置或更新视频流的采集设备。更多...

(NSString *_Nullable)	- getCaptureDevice:
	获取当前使用的视频流采集设备。更多...

(PanoResult)	- startVideo:view:config:
	开启视频流（随带渲染视图）。更多...

(PanoResult)	- startVideo:delegate:profile:
	开启视频流（随带外置渲染器）。更多...

(PanoResult)	- startVideo:delegate:config:
	开启视频流（随带外置渲染器）。更多...

(PanoResult)	- stopVideo:
	停止视频流。更多...

(PanoResult)	- subscribeVideo:stream:view:config:
	订阅用户的视频流（随带渲染视图）。更多...

(PanoResult)	- subscribeVideo:stream:delegate:profile:
	订阅用户的视频流（随带外置渲染器）。更多...

(PanoResult)	- unsubscribeVideo:stream:
	取消订阅用户的视频流。更多...

(PanoResult)	- muteVideo:
	暂停视频流。更多...

(PanoResult)	- unmuteVideo:
	恢复视频流。更多...

(PanoResult)	- setVideoFilter:stream:
	设置视频流过滤器。更多...

(PanoResult)	- snapshotVideo:stream:outputDir:option:
	Snapshot specific user's video content. 更多...

类方法
(instancetype)	+ new
	此方法不可用。

详细描述

PanoRtcVideoStreamManager 接口类提供了应用程序调用所需的所有视频流相关方法。

PanoRtcVideoStreamManager 对象可以通过 PanoRtcEngineKit 实例获取。

注解: 如果应用各端都不会同时发送多路视频流，则无需使用视频流管理器。

函数文档

◆ createVideoStream:

- (SInt32) createVideoStream: (NSString *_Nonnull) deviceId

创建一个新的视频流。

参数

deviceId 设备唯一标识, 此设备会设置给新视频流。

返回

新视频流标识。

> 0: 成功
其他: 失败

◆ destroyVideoStream:

- (PanoResult) destroyVideoStream: (SInt32) streamId

销毁一个视频流。

参数

streamId 要销毁的视频流标识。

返回

kPanoResultOK: 成功
其他: 失败

◆ getCaptureDevice:

- (NSString *_Nullable) getCaptureDevice: (SInt32) streamId

获取当前使用的视频流采集设备。

参数

streamId 视频流标识。

返回: 视频流设备唯一标识。

◆ muteVideo:

- (PanoResult) muteVideo: (SInt32) streamId

暂停视频流。

参数

streamId 视频流标识。

返回

kPanoResultOK: 成功
其他: 失败

注解: 暂停视频前请先开启视频，否则操作将无效。

◆ setCaptureDevice:stream:

- (PanoResult) setCaptureDevice:	(NSString *_Nonnull)	deviceId
stream:	(SInt32)	streamId

设置或更新视频流的采集设备。

参数

deviceId	设备唯一标识。
streamId	视频流标识。

返回

kPanoResultOK: 成功
其他: 失败

◆ setDelegate:

- (PanoResult) setDelegate: (id< PanoRtcVideoStreamDelegate > _Nullable) delegate

设置视频流管理器回调对象，用以接收视频流事件。

参数

delegate PanoRtcVideoStreamDelegate 协议对象。

返回

kPanoResultOK: 成功
其他: 失败

◆ setVideoFilter:stream:

- (PanoResult) setVideoFilter:	(id< PanoRtcVideoFilterDelegate > _Nullable)	filter
stream:	(SInt32)	streamId

设置视频流过滤器。

参数

filter	过滤器代表, PanoRtcVideoFilterDelegate 协议对象。
streamId	视频流标识。

返回

kPanoResultOK: 成功
其他: 失败

◆ snapshotVideo:stream:outputDir:option:

- (PanoResult) snapshotVideo:	(UInt64)	userId
stream:	(SInt32)	streamId
outputDir:	(NSString *_Nonnull)	outputDir
option:	(PanoRtcSnapshotVideoOption *_Nullable)	option

Snapshot specific user's video content.

参数

userId	The user ID defined by customer.
streamId	The video stream ID.
outputDir	The snapshot output directory.
option	The snapshot option.

返回

kPanoResultOK: Success
others: Failure

捕获指定用户的视频内容快照。

参数

userId	客户定义的用户标识。
streamId	视频流标识。
outputDir	快照输出路径。
option	快照选项。

返回

kPanoResultOK: 成功
其他: 失败

◆ startVideo:delegate:config:

- (PanoResult) startVideo:	(SInt32)	streamId
delegate:	(id< PanoRtcRenderDelegate > _Nonnull)	delegate
config:	(PanoRtcVideoSourceConfig *_Nullable)	config

开启视频流（随带外置渲染器）。

参数

streamId	视频流标识。
delegate	PanoRtcRenderDelegate 协议对象。
config	PanoRtcVideoSourceConfig 对象。

返回

kPanoResultOK: 成功
其他: 失败

注解: 开启视频流前请先加入一个频道，否则将返回失败。

◆ startVideo:delegate:profile:

- (PanoResult) startVideo:	(SInt32)	streamId
delegate:	(id< PanoRtcRenderDelegate > _Nonnull)	delegate
profile:	(PanoVideoProfileType)	profile

开启视频流（随带外置渲染器）。

参数

streamId	视频流标识。
delegate	PanoRtcRenderDelegate 协议对象。
profile	PanoVideoProfileType 枚举类型，视频发送的设定档。

返回

kPanoResultOK: 成功
其他: 失败

注解: 开启视频流前请先加入一个频道，否则将返回失败。

◆ startVideo:view:config:

- (PanoResult) startVideo:	(SInt32)	streamId
view:	(PanoView *_Nullable)	view
config:	(PanoRtcVideoConfig *_Nullable)	config

开启视频流（随带渲染视图）。

参数

streamId	视频流标识。
view	PanoView 对象。
config	PanoRtcVideoConfig 对象。

返回

kPanoResultOK: 成功
其他: 失败

注解: 开启视频流前请先加入一个频道，否则将返回失败。view为空则不渲染视图。必须从主线程调用。

◆ stopVideo:

- (PanoResult) stopVideo: (SInt32) streamId

停止视频流。

参数

streamId 视频流标识。

返回

kPanoResultOK: 成功
其他: 失败

◆ subscribeVideo:stream:delegate:profile:

- (PanoResult) subscribeVideo:	(UInt64)	userId
stream:	(SInt32)	streamId
delegate:	(id< PanoRtcRenderDelegate > _Nonnull)	delegate
profile:	(PanoVideoProfileType)	profile

订阅用户的视频流（随带外置渲染器）。

参数

userId	客户定义的用户标识。
streamId	视频流标识。
delegate	PanoRtcRenderDelegate 协议对象。
profile	PanoVideoProfileType 枚举对象，视频订阅的设定档。

返回

kPanoResultOK: 成功
其他: 失败

注解: 订阅用户的视频流前，请确保用户已开启此视频流。

◆ subscribeVideo:stream:view:config:

- (PanoResult) subscribeVideo:	(UInt64)	userId
stream:	(SInt32)	streamId
view:	(PanoView *_Nullable)	view
config:	(PanoRtcVideoConfig *_Nullable)	config

订阅用户的视频流（随带渲染视图）。

参数

userId	客户定义的用户标识。
streamId	视频流标识。
view	PanoView 对象。
config	PanoRtcVideoConfig 对象。

返回

kPanoResultOK: 成功
其他: 失败

注解: 订阅用户的视频流前，请确保用户已开启此视频流。必须从主线程调用。

◆ unmuteVideo:

- (PanoResult) unmuteVideo: (SInt32) streamId

恢复视频流。

参数

streamId 视频流标识。

返回

kPanoResultOK: 成功
其他: 失败

注解: 恢复视频流前请先开启此视频流，否则操作将无效。

◆ unsubscribeVideo:stream:

- (PanoResult) unsubscribeVideo:	(UInt64)	userId
stream:	(SInt32)	streamId

取消订阅用户的视频流。

参数

userId	客户定义的用户标识。
streamId	视频流标识。

返回

kPanoResultOK: 成功
其他: 失败

注解: 当用户停止视频流或者离开频道的时候，此用户视频流将会被自动取消订阅。

该类的文档由以下文件生成:

PanoRtcEngineKit.h

构造函数

类方法

详细描述

函数文档

◆ createVideoStream:

◆ destroyVideoStream:

◆ getCaptureDevice:

◆ muteVideo:

◆ setCaptureDevice:stream:

◆ setDelegate:

◆ setVideoFilter:stream:

◆ snapshotVideo:stream:outputDir:option:

◆ startVideo:delegate:config:

◆ startVideo:delegate:profile:

◆ startVideo:view:config:

◆ stopVideo:

◆ subscribeVideo:stream:delegate:profile:

◆ subscribeVideo:stream:view:config:

◆ unmuteVideo:

◆ unsubscribeVideo:stream: