JMSDK Windows  v2.6.1
Public 成员函数 | 静态 Public 成员函数 | 属性 | 所有成员列表
JMSDK.JCMediaDevice.JCMediaDevice类 参考

设备模块 更多...

Public 成员函数

JCMediaDeviceVideoCanvas StartCameraVideo (JCMediaDeviceCamera camera, JCMediaDeviceRenderMode mode)
 获取预览视频对象,通过此对象能获得视图用于UI显示 更多...
 
JCMediaDeviceVideoCanvas StartVideo (string videoSource, JCMediaDeviceRenderMode mode)
 获得视频对象,通过此对象能获得视图用于UI显示 更多...
 
void StopVideo (JCMediaDeviceVideoCanvas canvas)
 停止视频 更多...
 
bool StartAudio ()
 启动音频,一般正式开启通话前需要调用此接口 /summary> returns>true为启动成功,false为启动失败
 
bool StopAudio ()
 停止音频,一般在通话结束时调用 更多...
 
bool StartInput (JCMediaDeviceAudio input)
 打开输入设备 更多...
 
bool StopInput ()
 关闭输入设备 更多...
 
bool StartOutput (JCMediaDeviceAudio output)
 打开输出设备 更多...
 
bool StopOutput ()
 关闭输出设备 更多...
 
bool StartCamera (JCMediaDeviceCamera camera)
 开启摄像头 更多...
 
bool StopCamera ()
 关闭摄像头 更多...
 
bool SwitchCamera (JCMediaDeviceCamera camera)
 切换摄像头 更多...
 
void SetCameraProperty (int width, int height, int framerate)
 设定摄像头分辨率,请在调用startCamera()接口之前调用才会生效 更多...
 
void SetScreenCaptureProperty (int width, int height, int framerate)
 设置屏幕桌面共享采集属性 更多...
 
bool EnableScreenOrWindowCapture (bool enable)
 开启关闭桌面或窗口采集 更多...
 
bool EnableScreenOrWindowCapture (bool enable, int framerate)
 开启关闭桌面或窗口采集 更多...
 
bool StartVideoFile ()
 开启视频文件作为视频输入源,文件和摄像头作为视频输入源只能存在一种,当前摄像头开启的话会关闭摄像头 更多...
 
void SetVideoFileFrame (byte[] srcFrame, JCMediaDeviceVideoPixelFormat format, int width, int height)
 逐帧采集视频画面 更多...
 
bool StopVideoFile ()
 关闭逐帧采集画面 更多...
 
bool StartVideoCaptureRecord (String filePath, String captureId, JCMeidaDeviceVideoRecordFile fileType, int width, int height)
 开启视频录制(本地录制,不需要建立通信) 更多...
 
bool StopVideoCaptureRecord (String captureId)
 关闭视频录制(本地录制,不需要建立通信,不能和音频同时录制) 更多...
 
bool StartAudioRecord (String filePath, JCMeidaDeviceAudioRecordFile fileType)
 开启音频录制(本地录制,不需要建立通信,不能和视频同时录制) 更多...
 
bool StopAudioRecord ()
 关闭音频录制(本地录制,不需要建立通信) 更多...
 
void OnLogin (bool result, JCClientReason reason)
 登陆结果回调 更多...
 
void OnLogout (JCClientReason reason)
 登出回调 更多...
 
void OnClientStateChange (JCClientState state, JCClientState oldState)
 登陆状态变化通知 更多...
 

静态 Public 成员函数

static JCMediaDevice Create (JCClient.JCClient client, JCMediaDeviceCallback callback)
 创建JCMediaDevice实例 更多...
 
static void Destroy ()
 销毁 JCMediaDevice实例 更多...
 

属性

string VideoFileId [get]
 共享视频文件时的captureId 更多...
 
bool CameraOpen [get]
 摄像头是否打开 更多...
 
bool VideoFileOpen [get]
 是否在采集视频文件 更多...
 
JCMediaDeviceCamera CurrentCamera [get]
 当前摄像头 更多...
 
JCMediaDeviceCamera DefaultCamera [get, set]
 默认摄像头 更多...
 
JCMediaDeviceAudioParam AudioParam [get]
 音频参数 更多...
 
JCMediaDeviceAudio AudioInput [get, set]
 当前输入设备 更多...
 
JCMediaDeviceAudio AudioOutput [get, set]
 当前输出设备 更多...
 
List< JCMediaDeviceCameraCameras [get]
 摄像头列表 更多...
 
List< JCMediaDeviceAudioAudioInputs [get]
 音频输入设备列表 更多...
 
List< JCMediaDeviceAudioAudioOutputs [get]
 音频输出设备列表 更多...
 
List< JCMediaDeviceWindowWindows [get]
 窗口列表 更多...
 
List< JCMediaDeviceWindowDesktops [get]
 桌面列表 更多...
 
JCMediaDeviceWindow ScreenshareWindow [get, set]
 屏幕分享的窗口 更多...
 
bool AudioStart [get]
 音频设备是否打开 更多...
 

详细描述

设备模块

成员函数说明

◆ Create()

static JCMediaDevice JMSDK.JCMediaDevice.JCMediaDevice.Create ( JCClient.JCClient  client,
JCMediaDeviceCallback  callback 
)
inlinestatic

创建JCMediaDevice实例

参数
clientJCClient实例
callbackJCMediaDeviceCallback回调函数,用于接收JCMediaDevice相关事件
返回
JCMediaDevice实例

◆ Destroy()

static void JMSDK.JCMediaDevice.JCMediaDevice.Destroy ( )
inlinestatic

销毁 JCMediaDevice实例

◆ EnableScreenOrWindowCapture() [1/2]

bool JMSDK.JCMediaDevice.JCMediaDevice.EnableScreenOrWindowCapture ( bool  enable)
inline

开启关闭桌面或窗口采集

参数
enable打开或关闭

<returens>true为开启成功,false为开启失败</returens>

◆ EnableScreenOrWindowCapture() [2/2]

bool JMSDK.JCMediaDevice.JCMediaDevice.EnableScreenOrWindowCapture ( bool  enable,
int  framerate 
)
inline

开启关闭桌面或窗口采集

参数
enable打开或关闭
framerate设置采集帧数,范围1-10,默认8

<returens>true为开启成功,false为开启失败</returens>

◆ OnClientStateChange()

void JMSDK.JCMediaDevice.JCMediaDevice.OnClientStateChange ( JCClientState  state,
JCClientState  oldState 
)
inline

登陆状态变化通知

参数
state当前状态值
oldState之前状态值

实现了 JMSDK.JCClient.JCClientCallback.

◆ OnLogin()

void JMSDK.JCMediaDevice.JCMediaDevice.OnLogin ( bool  result,
JCClientReason  reason 
)
inline

登陆结果回调

参数
resulttrue 表示登陆成功,false 表示登陆失败
reason当 result 为 false 时该值有效,了解具体原因

实现了 JMSDK.JCClient.JCClientCallback.

◆ OnLogout()

void JMSDK.JCMediaDevice.JCMediaDevice.OnLogout ( JCClientReason  reason)
inline

登出回调

参数
reason登出原因

实现了 JMSDK.JCClient.JCClientCallback.

◆ SetCameraProperty()

void JMSDK.JCMediaDevice.JCMediaDevice.SetCameraProperty ( int  width,
int  height,
int  framerate 
)
inline

设定摄像头分辨率,请在调用startCamera()接口之前调用才会生效

参数
width摄像头分辨率宽
height摄像头分辨率高
framerate帧速率

◆ SetScreenCaptureProperty()

void JMSDK.JCMediaDevice.JCMediaDevice.SetScreenCaptureProperty ( int  width,
int  height,
int  framerate 
)
inline

设置屏幕桌面共享采集属性

参数
width采集宽度
height采集高度
framerate帧速率

◆ SetVideoFileFrame()

void JMSDK.JCMediaDevice.JCMediaDevice.SetVideoFileFrame ( byte[]  srcFrame,
JCMediaDeviceVideoPixelFormat  format,
int  width,
int  height 
)
inline

逐帧采集视频画面

参数
srcFrame画面二进制数据
format视频像素格式
width
height

◆ StartAudioRecord()

bool JMSDK.JCMediaDevice.JCMediaDevice.StartAudioRecord ( String  filePath,
JCMeidaDeviceAudioRecordFile  fileType 
)
inline

开启音频录制(本地录制,不需要建立通信,不能和视频同时录制)

参数
filePath保存的文件路径,必须包含文件名(xxx.wav或者pcm)
fileType录制文件编码封装类型
返回

◆ StartCamera()

bool JMSDK.JCMediaDevice.JCMediaDevice.StartCamera ( JCMediaDeviceCamera  camera)
inline

开启摄像头

参数
camera要开启的摄像头

>

返回
true为开启成功,false为开启失败

◆ StartCameraVideo()

JCMediaDeviceVideoCanvas JMSDK.JCMediaDevice.JCMediaDevice.StartCameraVideo ( JCMediaDeviceCamera  camera,
JCMediaDeviceRenderMode  mode 
)
inline

获取预览视频对象,通过此对象能获得视图用于UI显示

参数
camera摄像头对象
mode渲染方式
返回
JCMediaDeviceVideoCanvas对象

◆ StartInput()

bool JMSDK.JCMediaDevice.JCMediaDevice.StartInput ( JCMediaDeviceAudio  input)
inline

打开输入设备

参数
input输入设备
返回
打开输入设备成功失败

◆ StartOutput()

bool JMSDK.JCMediaDevice.JCMediaDevice.StartOutput ( JCMediaDeviceAudio  output)
inline

打开输出设备

参数
output输出设备
返回
打开输出设备成功失败

◆ StartVideo()

JCMediaDeviceVideoCanvas JMSDK.JCMediaDevice.JCMediaDevice.StartVideo ( string  videoSource,
JCMediaDeviceRenderMode  mode 
)
inline

获得视频对象,通过此对象能获得视图用于UI显示

参数
videoSource渲染标识串,比如JCConferencelParticipant JCCallItem中的renderId
mode渲染模式
返回
JCMediaDeviceVideoCanvas对象

◆ StartVideoCaptureRecord()

bool JMSDK.JCMediaDevice.JCMediaDevice.StartVideoCaptureRecord ( String  filePath,
String  captureId,
JCMeidaDeviceVideoRecordFile  fileType,
int  width,
int  height 
)
inline

开启视频录制(本地录制,不需要建立通信)

参数
filePath保存的文件路径,必须包含文件名(xxx.mp4或者xxx.avi)
captureId视频采集id, (包括摄像头id、文件视频源渲染id、屏幕共享采集id等)
fileType录制文件编码封装类型
width录制文件宽(传-1则默认屏幕共享采集属性的宽)
height录制文件高(传-1则默认屏幕共享采集属性的高)
返回
开启视频录制是否成功

◆ StartVideoFile()

bool JMSDK.JCMediaDevice.JCMediaDevice.StartVideoFile ( )
inline

开启视频文件作为视频输入源,文件和摄像头作为视频输入源只能存在一种,当前摄像头开启的话会关闭摄像头

返回

◆ StopAudio()

bool JMSDK.JCMediaDevice.JCMediaDevice.StopAudio ( )
inline

停止音频,一般在通话结束时调用

返回
true为停止成功,false为停止失败

◆ StopAudioRecord()

bool JMSDK.JCMediaDevice.JCMediaDevice.StopAudioRecord ( )
inline

关闭音频录制(本地录制,不需要建立通信)

◆ StopCamera()

bool JMSDK.JCMediaDevice.JCMediaDevice.StopCamera ( )
inline

关闭摄像头

返回
true为关闭成功,false为关闭失败

◆ StopInput()

bool JMSDK.JCMediaDevice.JCMediaDevice.StopInput ( )
inline

关闭输入设备

返回
关闭输入设备成功失败

◆ StopOutput()

bool JMSDK.JCMediaDevice.JCMediaDevice.StopOutput ( )
inline

关闭输出设备

返回
关闭输出设备成功失败

◆ StopVideo()

void JMSDK.JCMediaDevice.JCMediaDevice.StopVideo ( JCMediaDeviceVideoCanvas  canvas)
inline

停止视频

参数
canvasJCMediaDeviceVideoCanvas对象,由startVideo获得

◆ StopVideoCaptureRecord()

bool JMSDK.JCMediaDevice.JCMediaDevice.StopVideoCaptureRecord ( String  captureId)
inline

关闭视频录制(本地录制,不需要建立通信,不能和音频同时录制)

参数
captureId视频采集id, (包括摄像头id、文件视频源渲染id、屏幕共享采集id等)
返回
关闭视频录制是否成功

◆ StopVideoFile()

bool JMSDK.JCMediaDevice.JCMediaDevice.StopVideoFile ( )
inline

关闭逐帧采集画面

返回
ture表示关闭成功,false表示关闭失败

◆ SwitchCamera()

bool JMSDK.JCMediaDevice.JCMediaDevice.SwitchCamera ( JCMediaDeviceCamera  camera)
inline

切换摄像头

参数
camera要切换的摄像头
返回
true为切换成功,false为切换失败

属性说明

◆ AudioInput

JCMediaDeviceAudio JMSDK.JCMediaDevice.JCMediaDevice.AudioInput
getset

当前输入设备

◆ AudioInputs

List<JCMediaDeviceAudio> JMSDK.JCMediaDevice.JCMediaDevice.AudioInputs
get

音频输入设备列表

◆ AudioOutput

JCMediaDeviceAudio JMSDK.JCMediaDevice.JCMediaDevice.AudioOutput
getset

当前输出设备

◆ AudioOutputs

List<JCMediaDeviceAudio> JMSDK.JCMediaDevice.JCMediaDevice.AudioOutputs
get

音频输出设备列表

◆ AudioParam

JCMediaDeviceAudioParam JMSDK.JCMediaDevice.JCMediaDevice.AudioParam
get

音频参数

◆ AudioStart

bool JMSDK.JCMediaDevice.JCMediaDevice.AudioStart
get

音频设备是否打开

◆ CameraOpen

bool JMSDK.JCMediaDevice.JCMediaDevice.CameraOpen
get

摄像头是否打开

◆ Cameras

List<JCMediaDeviceCamera> JMSDK.JCMediaDevice.JCMediaDevice.Cameras
get

摄像头列表

◆ CurrentCamera

JCMediaDeviceCamera JMSDK.JCMediaDevice.JCMediaDevice.CurrentCamera
get

当前摄像头

◆ DefaultCamera

JCMediaDeviceCamera JMSDK.JCMediaDevice.JCMediaDevice.DefaultCamera
getset

默认摄像头

◆ Desktops

List<JCMediaDeviceWindow> JMSDK.JCMediaDevice.JCMediaDevice.Desktops
get

桌面列表

◆ ScreenshareWindow

JCMediaDeviceWindow JMSDK.JCMediaDevice.JCMediaDevice.ScreenshareWindow
getset

屏幕分享的窗口

◆ VideoFileId

string JMSDK.JCMediaDevice.JCMediaDevice.VideoFileId
get

共享视频文件时的captureId

◆ VideoFileOpen

bool JMSDK.JCMediaDevice.JCMediaDevice.VideoFileOpen
get

是否在采集视频文件

◆ Windows

List<JCMediaDeviceWindow> JMSDK.JCMediaDevice.JCMediaDevice.Windows
get

窗口列表


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