Android(Java)[v1.7.5.0]
| Public 成员函数 | 所有成员列表
com.pano.rtc.api.RtcVideoStreamManager接口 参考

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

interface  Callback
 PANO RtcVideoStreamManager 回调接口。 更多...
 

Public 成员函数

QResult setCallback (Callback callback)
 设置视频流管理器的回调。 更多...
 
int createVideoStream (String deviceId)
 创建一个新的视频流。 更多...
 
QResult destroyVideoStream (int streamId)
 销毁一个视频流。 更多...
 
QResult setCaptureDevice (int streamId, String deviceId)
 设置或更新视频流的采集设备。 更多...
 
String getCaptureDevice (int streamId)
 获取视频流的采集设备。 更多...
 
QResult setLocalVideoRender (int streamId, IVideoRender render)
 
QResult setRemoteVideoRender (long userId, int streamId, IVideoRender render)
 
QResult startVideo (int streamId, VideoProfileType profileType)
 开启视频。 更多...
 
QResult stopVideo (int streamId)
 关闭视频流 更多...
 
QResult muteVideo (int streamId)
 暂停视频流。 更多...
 
QResult unmuteVideo (int streamId)
 恢复视频。 更多...
 
QResult subscribeVideo (long userId, int streamId, VideoProfileType profile)
 订阅用户的视频流, 并设置渲染窗口。 更多...
 
QResult unsubscribeVideo (long userId, int streamId)
 取消订阅用户的视频。 更多...
 
QResult snapshotVideo (long userId, int streamId, String outputDir, RtcSnapshotVideoOption option)
 捕获指定用户的视频流画面 更多...
 
QResult setOption (int streamId, PanoOptionType type, Object value)
 设置视频流的可选项 更多...
 

详细描述

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

RtcVideoStreamManager 对象可以通过 RtcEngine 实例获取。

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

成员函数说明

◆ createVideoStream()

int com.pano.rtc.api.RtcVideoStreamManager.createVideoStream ( String  deviceId)

创建一个新的视频流。

参数
deviceId设备 ID, 此设备会设置给新视频流。
返回
  • >= 0: 视频流 ID
  • 其他: 失败

◆ destroyVideoStream()

QResult com.pano.rtc.api.RtcVideoStreamManager.destroyVideoStream ( int  streamId)

销毁一个视频流。

参数
streamId视频流 ID。
返回
  • OK: 成功
  • 其他: 失败

◆ getCaptureDevice()

String com.pano.rtc.api.RtcVideoStreamManager.getCaptureDevice ( int  streamId)

获取视频流的采集设备。

参数
streamId视频流 ID。
返回
  • 空字符串: 失败,streamId未找到或其他错误
  • 非空字符串: 成功,返回采集设备ID

◆ muteVideo()

QResult com.pano.rtc.api.RtcVideoStreamManager.muteVideo ( int  streamId)

暂停视频流。

参数
streamId视频流 ID
返回
  • OK: 成功
  • 其他: 失败
注解
暂停视频流前请先开启视频流,否则操作将无效。

◆ setCallback()

QResult com.pano.rtc.api.RtcVideoStreamManager.setCallback ( Callback  callback)

设置视频流管理器的回调。

参数
callback回调。
返回
  • OK: 成功
  • 其他: 失败

◆ setCaptureDevice()

QResult com.pano.rtc.api.RtcVideoStreamManager.setCaptureDevice ( int  streamId,
String  deviceId 
)

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

参数
streamId视频流 ID。
deviceId采集设备 ID。
返回
  • OK: 成功
  • 其他: 失败

◆ setLocalVideoRender()

QResult com.pano.rtc.api.RtcVideoStreamManager.setLocalVideoRender ( int  streamId,
IVideoRender  render 
)

设置本地用户的视频画布。 一个画布同时只能被用于一个用户,如果要把一个画布用于另一个用户,则需先将画布的当前用户的画布设为空。

参数
streamId视频流 ID
render视频画布,null值将会取消本地用户画布
返回
  • OK: 成功
  • 其它值: 失败

◆ setOption()

QResult com.pano.rtc.api.RtcVideoStreamManager.setOption ( int  streamId,
PanoOptionType  type,
Object  value 
)

设置视频流的可选项

参数
streamId视频流 ID
type可选项类型PanoOptionType
value参数的定义需遵循不同的object所定义的参数
返回
  • OK: 成功
  • 其他: 失败

◆ setRemoteVideoRender()

QResult com.pano.rtc.api.RtcVideoStreamManager.setRemoteVideoRender ( long  userId,
int  streamId,
IVideoRender  render 
)

设置远端用户的视频画布。 一个画布同时只能被用于一个用户,如果要把一个画布用于另一个用户,则需先将画布的当前用户的画布设为空。

参数
userId远端用户的用户ID
streamId视频流 ID
render视频画布,null值将会取消此用户的视频画布
返回
  • OK: 成功
  • 其它值: 失败

◆ snapshotVideo()

QResult com.pano.rtc.api.RtcVideoStreamManager.snapshotVideo ( long  userId,
int  streamId,
String  outputDir,
RtcSnapshotVideoOption  option 
)

捕获指定用户的视频流画面

参数
userId目标用户的 ID
streamId视频流 ID
outputDir输出路径
option快照选项
返回
  • OK: 成功
  • 其他: 失败

◆ startVideo()

QResult com.pano.rtc.api.RtcVideoStreamManager.startVideo ( int  streamId,
VideoProfileType  profileType 
)

开启视频。

参数
streamId视频流 ID
profileType视频分辨率。
返回
  • OK: 成功
  • 其他: 失败
注解
开启视频前请先加入一个频道,否则将返回失败。

◆ stopVideo()

QResult com.pano.rtc.api.RtcVideoStreamManager.stopVideo ( int  streamId)

关闭视频流

参数
streamId视频流 ID
返回
  • OK: 调用成功
  • others: 调用失败

◆ subscribeVideo()

QResult com.pano.rtc.api.RtcVideoStreamManager.subscribeVideo ( long  userId,
int  streamId,
VideoProfileType  profile 
)

订阅用户的视频流, 并设置渲染窗口。

参数
userId客户定义的用户标识。
streamId视频流 ID。
profile视频分辨率。
返回
  • OK: 成功
  • 其他: 失败
注解
订阅用户的视频流前,请确保用户已开启视频流。 在 macOS iOS and Android 平台下必须从主线程调用。

◆ unmuteVideo()

QResult com.pano.rtc.api.RtcVideoStreamManager.unmuteVideo ( int  streamId)

恢复视频。

参数
streamId视频流 ID
返回
  • OK: 成功
  • 其他: 失败
注解
恢复视频流前请先开启视频流,否则操作将无效。

◆ unsubscribeVideo()

QResult com.pano.rtc.api.RtcVideoStreamManager.unsubscribeVideo ( long  userId,
int  streamId 
)

取消订阅用户的视频。

参数
userId客户定义的用户标识。
streamId视频流 ID。
返回
  • OK: 成功
  • 其他: 失败
注解
当用户停止视频流或者离开频道的时候,用户的视频流将会被自动取消订阅。

该接口的文档由以下文件生成: