音视频设备管理更多...

#include <JRTCMediaDevice.h>

实例方法
(JRTCMediaDeviceVideoCanvas *__nullable)	- startCameraVideo:
(JRTCMediaDeviceVideoCanvas *__nullable)	- startCameraVideo:view:
(JRTCMediaDeviceVideoCanvas *__nullable)	- startVideo:renderType:
(JRTCMediaDeviceVideoCanvas *__nullable)	- startVideo:renderType:view:
(void)	- stopVideo:
(void)	- stopAllVideos
(bool)	- startAudio
(bool)	- stopAudio
(bool)	- startAudioInput
(bool)	- stopAudioInput
(bool)	- startAudioOutput
(bool)	- stopAudioOutput
(bool)	- startCamera
(void)	- setDetectBrightness:
(bool)	- stopCamera
(bool)	- switchCamera
(bool)	- switchCamera:
(void)	- specifyCamera:
(void)	- specifyCameraAngle:
(void)	- setFrontCameraRenderMirror:
(void)	- setCameraProperty:height:framerate:
(void)	- setCameraWatermarkList:watermarkList:
(void)	- setScreenCaptureProperty:height:framerate:
(int)	- getScreenFramerate
(void)	- setVideoAngle:
(void)	- setAutoScreenOrientation:
(bool)	- isSpeakerOn
(void)	- enableSpeaker:
(bool)	- enableScreenCapture:
(bool)	- enableScreenCapture:appGroupId:preferredExtension:
(bool)	- enableScreenCapture:appGroupId:preferredExtension:captureAudio:
(JRTCMediaDeviceAudioRouteType)	- getAudioRouteType
(NSString *__nullable)	- getScreenCaptureId
(bool)	- startVideoFile
(bool)	- stopVideoFile
(bool)	- setVideoFileFrame:format:width:height:angle:
(void)	- setVideoFileFrame:angle:mirror:
(bool)	- startVideoCaptureRecord:recordParam:
(bool)	- startVideoCaptureRecord:streamId:audioSource:fileType:width:height:
(bool)	- stopVideoCaptureRecord:
(bool)	- startAudioRecord:audioSource:fileType:
(bool)	- stopAudioRecord
(bool)	- recoveryRecordFile:
(bool)	- snapshotWithStreamId:path:
(void)	- setAudioInputFrameCallback:
(void)	- setVideoCaptureFrameCallback:
(void)	- setScreenCaptureData:
(void)	- resetScreenCaptureData
(bool)	- startAudioTest:fileName:
(bool)	- stopAudioTest:
(int)	- getMicLevel
(int)	- getSpkLevel
(int)	- getAnrNoiseLevel
(int)	- getAnrNoiseRatio
(bool)	- startRing:isLoop:
(bool)	- stopRing
(bool)	- enableAudioInputFromFile:filePath:loop:
(bool)	- suspendAudioInputFromFile:
(void)	- setAec:
(void)	- setAgc:

类方法
(JRTCMediaDevice *_Nullable)	+ create:callback:initParam:
(void)	+ destroy

属性
id< AudioInputFrameCallback >	audioInputFrameCallback
bool	isAudioInputStart
bool	isAudioOutputStart
bool	cameraOpen
bool	videoFileOpen
JRTCMediaDeviceCamera *	currentCamera
NSArray< JRTCMediaDeviceCamera * > *	cameras
JRTCMediaDeviceCamera *	defaultCamera
JRTCMediaDeviceAudioParam *	audioParam
NSString *	videoFileId
bool	audioInterrupt
JRTCMediaDeviceVideoAngle	videoAngle
bool	isAutoScreenOrientation
bool	useInternalAudioDeviceLogic
NSString *	appUrlScheme
NSArray< JRTCMediaDeviceAudio * > *	audioInputs
JRTCMediaDeviceAudio *	audioInput
NSArray< JRTCMediaDeviceAudio * > *	audioOutputs
JRTCMediaDeviceAudio *	audioOutput
NSArray< JRTCMediaDeviceWindow * > *	desktops
NSArray< JRTCMediaDeviceWindow * > *	windows
JRTCMediaDeviceWindow *	screenshareWindow
bool	defaultSpeakerOn

详细描述

音视频设备管理

成员函数文档

◆ create:callback:initParam:

+ (JRTCMediaDevice *_Nullable) create:	(JRTCClient *_Nonnull)	client
callback:	(id< JRTCMediaDeviceCallback > _Nonnull)	callback
initParam:	(JRTCMediaDeviceInitParam *_Nullable)	initParam

创建 JRTCMediaDevice 对象

JRTCMediaDevice 的所有接口函数，如无特殊说明，都建议在主线程调用

注解

调用此方法创建 JRTCMediaDevice 对象后，期间没有调用过 destroy 方法销毁对象，然后又重复调用此方法，会直接返回第一次创建的 JRTCMediaDevice 对象
调用此方法前确保 JRTCClient 已完成初始化，即 state 状态值不等于 JRTCClientStateNotInit

参数

client	JRTCClient 对象
callback	JRTCMediaDeviceCallback 对象，用于回调相关通知
initParam	预留参数，目前不生效

返回: JRTCMediaDevice 对象

异常

JRTCClient、JRTCMediaDeviceCallback 任意一个参数传空就会调用失败

◆ destroy

+ (void) destroy

销毁 JRTCMediaDevice 对象

注解: 该方法为同步调用，需要等待 JRTCMediaDevice 实例资源释放后才能执行其他操作，调用此方法后，你将无法再使用 JRTCMediaDevice 的其它方法和回调。
我们 不建议 在 JRTCSDK 的回调中调用此方法销毁 JRTCMediaDevice 对象，否则会出现崩溃。
如需在销毁后再次创建 JRTCMediaDevice 实例，需要等待 destroy 方法执行结束后再创建实例。

◆ enableAudioInputFromFile:filePath:loop:

- (bool) enableAudioInputFromFile:	(bool)	enable
filePath:	(NSString *__nullable)	filePath
loop:	(bool)	loop

开始/结束播放本地音频文件作为音频源输入

参数

enable	- true: 开始输入，当输入完成后会收到 `onFileAudioInputDidFinish` 回调通知 false: 结束输入，会收到 `onFileAudioInputDidFinish` 回调通知
filePath	音频文件路径，支持pcm，wav的格式（需要单声道，采样率16K音频文件）
loop	是否循环播放

注解: 重复调用会覆盖

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ enableScreenCapture:

- (bool) enableScreenCapture: (bool) enable

开启/关闭屏幕采集

注解: 仅支持应用内采集，需要 iOS 11.0 及以上

参数

enable

开启或关闭屏幕采集

true: 开启
false: 关闭

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ enableScreenCapture:appGroupId:preferredExtension:

- (bool) enableScreenCapture:	(bool)	enable
appGroupId:	(NSString *__nullable)	appGroupId
preferredExtension:	(NSString *__nullable)	preferredExtension

开启/关闭屏幕采集

注解: 支持应用外采集，需要 iOS 12.0 及以上（不包含 iOS 13.0），需要集成屏幕采集插件，调用此方法后成功，界面上会拉起屏幕采集插件，需手动点击"开始直播"按钮进行屏幕采集，

参数

enable	是否开启
appGroupId	extension 和 app 所处于的同一个 groupId，如果是关闭可以传空
preferredExtension	希望打开的 extension 的 ID，如果是关闭可以传空

返回: 返回 true 表示开启/关闭屏幕共享成功，false 表示失败

◆ enableScreenCapture:appGroupId:preferredExtension:captureAudio:

- (bool) enableScreenCapture:	(bool)	enable
appGroupId:	(NSString *__nullable)	appGroupId
preferredExtension:	(NSString *__nullable)	preferredExtension
captureAudio:	(bool)	captureAudio

开启/关闭屏幕采集

注解: 支持应用外采集，需要 iOS 12.0 及以上（不包含 iOS 13.0），需要集成屏幕采集插件，调用此方法后成功，界面上会拉起屏幕采集插件，需手动点击"开始直播"按钮进行屏幕采集，

参数

enable	是否开启
appGroupId	extension 和 app 所处于的同一个 groupId，如果是关闭可以传空
preferredExtension	希望打开的 extension 的 ID，如果是关闭可以传空
captureAudio	是否采集系统音频，需要 iOS 13.0 以及以上

返回: 返回 true 表示开启/关闭屏幕共享成功，false 表示失败

◆ enableSpeaker:

- (void) enableSpeaker: (bool) enable

开启/关闭扬声器，iOS 使用

只有在音频已经启动的情况下调用才会生效

参数

enable

开启或关闭扬声器

true: 开启
false: 关闭

◆ getAnrNoiseLevel

- (int) getAnrNoiseLevel

获取当前噪声强度环境平均噪声强度（1s）, 检测需要打开麦克风 startAudio 或者 startAudioInput

返回

噪声强度

-1：获取失败
0-50dB：噪声非常微弱
50-60dB：噪声较弱
60-70dB：噪声较强
70dB以上：噪声非常强

◆ getAnrNoiseRatio

- (int) getAnrNoiseRatio

获取当前信噪比强度环境平均信噪比强度（1s）, 检测需要打开麦克风 startAudio 或者 startAudioInput

返回

噪声强度

-1：获取失败
0-20dB：噪声明显，语音含糊，较难听清
20-40dB：语音基本能听清，但有一定的噪声
40dB以上：语音非常清晰

◆ getAudioRouteType

- (JRTCMediaDeviceAudioRouteType) getAudioRouteType

获得当前音频输出通道类型，如扬声器、听筒、耳机、蓝牙等

返回: 当前音频输出通道类型

◆ getMicLevel

- (int) getMicLevel

获取当前本地音量级别，音量级别范围为0-100，用以测试设备目前只在开始麦克风检测，或者当房间内有输入音频时，才能获取到有效的音量级别

返回: 麦克风音量级别，返回-1获取失败

◆ getScreenCaptureId

- (NSString *__nullable) getScreenCaptureId

获得屏幕采集视频流ID

返回: 屏幕采集视频流ID

◆ getScreenFramerate

- (int) getScreenFramerate

获得当前屏幕采集帧率

返回: 屏幕采集帧率

◆ getSpkLevel

- (int) getSpkLevel

获取当前扬声器音量级别，音量级别范围为0-100，用以测试设备目前只在开始扬声器检测，或者当房间内有输出音频时，才能获取到有效的音量级别

返回: 扬声器音量级别，返回-1获取失败

◆ isSpeakerOn

- (bool) isSpeakerOn

扬声器是否已打开，iOS 使用

true: 已打开
false: 未打开

◆ recoveryRecordFile:

- (bool) recoveryRecordFile: (NSString *_Nonnull) fileDir

恢复录制文件

注解

使用场景：

开启音视频录制；
录制过程中程序出现异常（比如崩溃），导致无法正常关闭音视频录制；
本地录制目录下生成了录制过程文件，不是一个有效的音视频文件；
当程序再次启动时可以调用该接口，将录制目录中已经录制的音视频过程文件恢复成有效的音视频文件。

参数

fileDir 录制文件所在本地目录

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ resetScreenCaptureData

- (void) resetScreenCaptureData

重置屏幕采集数据

◆ setAec:

- (void) setAec: (bool) aecOn

设置开启自适应回声消除

注解: 需要在打开音频输入设备 startAudioInput() 或者 startAudio() 前调用才生效

参数

aecOn 是否开启自适应回声消除

◆ setAgc:

- (void) setAgc: (bool) agcOn

设置是否开启自动增益控制

注解: 需要在打开音频输入设备 startAudioInput() 或者 startAudio() 前调用才生效

参数

agcOn 是否开启自动增益控制

◆ setAudioInputFrameCallback:

- (void) setAudioInputFrameCallback: (id< AudioInputFrameCallback > _Nullable) callback

设置音频输入帧回调

参数

callback 原始音频数据输入回调代理对象

◆ setAutoScreenOrientation:

- (void) setAutoScreenOrientation: (bool) enable

设置屏幕方向自适应，默认开启

true: 开启
false: 不开启

◆ setCameraProperty:height:framerate:

- (void) setCameraProperty:	(int)	width
height:	(int)	height
framerate:	(int)	frameRate

设置摄像头采集属性

在调用开始自身视频渲染前设置即可生效

参数

width	采集宽度，默认为 640
height	采集高度，默认为 360
frameRate	采集帧速率，默认为 24

◆ setCameraWatermarkList:watermarkList:

- (void) setCameraWatermarkList:		(JRTCMediaDeviceCamera *_Nonnull)	camera
watermarkList:		(NSArray< JRTCRecordWatermark * > *_Nonnull)	watermarkList

设置摄像头采集数据水印信息

注解: 同时支持打开摄像头前和打开摄像头后设置

参数

camera	需要设置水印的摄像头对象
watermarkList	水印信息列表

◆ setDetectBrightness:

- (void) setDetectBrightness: (bool) enable

设置是否需要检测光线明暗度，结果通过 JRTCMediaDeviceCallback#onCaptureBrightnessChanged 上报

注解: 主要通过摄像头图片数据检测，需要在 startCamera 打开摄像头之前调用

参数

enable 是否打开光线明暗度检测

◆ setFrontCameraRenderMirror:

- (void) setFrontCameraRenderMirror: (bool) mirror

设置前置摄像头渲染是否镜像，默认镜像

参数

mirror 是否镜像

◆ setScreenCaptureData:

- (void) setScreenCaptureData: (UIImage *__nonnull) image

设置屏幕采集数据

参数

image 替换图片

◆ setScreenCaptureProperty:height:framerate:

- (void) setScreenCaptureProperty:	(int)	width
height:	(int)	height
framerate:	(int)	frameRate

设置屏幕共享采集属性

在调用开启屏幕共享前设置即可生效

参数

width	采集宽度，默认1280
height	采集高度，默认720
frameRate	采集帧速率，默认10

◆ setVideoAngle:

- (void) setVideoAngle: (JRTCMediaDeviceVideoAngle) angle

设置视频窗体角度

参数

angle 视频旋转角度，详见 JRTCMediaDeviceVideoAngle

◆ setVideoCaptureFrameCallback:

- (void) setVideoCaptureFrameCallback: (id< VideoCaptureFrameCallback > _Nullable) callback

设置视频采集帧数据回调

参数

callback VideoCaptureFrameCallback 接口对象

◆ setVideoFileFrame:angle:mirror:

- (void) setVideoFileFrame:	(CVPixelBufferRef __nonnull)	srcFrame
angle:	(int)	angle
mirror:	(int)	mirror

向文件视频源逐帧添加视频数据

调用此方法时要保证文件视频源已开启

注解

当 format 为 H264 格式并且是关键帧时：

第一帧一定要包含关键帧，并且需要将 0x67 0x68 0x65 的数据作为完整一帧传入，其中0x67，0x68为pps，0x65为关键帧标识
后续P帧以 0x41 数据形式传入
关键帧要以固定间隔传入，例如5秒，否则一开始可能有几秒对端无法显示视频

参数

srcFrame	CVPixelBufferRef 视频数据
angle	视频角度, 为 90 的倍数
mirror	是否镜像，0 不镜像，1 镜像

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ setVideoFileFrame:format:width:height:angle:

- (bool) setVideoFileFrame:	(NSData *__nonnull)	srcFrame
format:	(JRTCMediaDeviceVideoPixelFormat)	format
width:	(int)	width
height:	(int)	height
angle:	(int)	angle

逐帧采集视频画面

调用此方法时要保证文件视频源已开启

注解

当 format 为 H264 格式并且是关键帧时：

第一帧一定要包含关键帧，并且需要将 0x67 0x68 0x65 的数据作为完整一帧传入，其中0x67，0x68为pps，0x65为关键帧标识
后续P帧以 0x41 数据形式传入
关键帧要以固定间隔传入，例如5秒，否则一开始可能有几秒对端无法显示视频

参数

srcFrame	画面二进制数据
format	视频像素格式
width	视频画面像素宽
height	视频画面像素高
angle	视频角度，为 90 的倍数

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ snapshotWithStreamId:path:

- (bool) snapshotWithStreamId:		(NSString *__nonnull)	streamId
path:		(NSString *__nonnull)	path

截图

参数

streamId	要截图的视频流ID
path	要存放截图的文件路径

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ specifyCamera:

- (void) specifyCamera: (JRTCMediaDeviceCamera *__nonnull) camera

指定要开启的摄像头，在 startCamera 之前调用

参数

camera 摄像头对象

◆ specifyCameraAngle:

- (void) specifyCameraAngle: (int) angle

指定摄像头采集角度，为90的倍数

参数

angle 角度

◆ startAudio

- (bool) startAudio

启动音频

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ startAudioInput

- (bool) startAudioInput

打开音频输入设备

注解: 默认开启自适应回声消除和自动增益控制

返回

调用是否成功

true: 调用成功
false: 调用失败

◆ startAudioOutput

- (bool) startAudioOutput

打开音频输出设备

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ startAudioRecord:audioSource:fileType:

- (bool) startAudioRecord:	(NSString *_Nullable)	filePath
audioSource:	(JRTCRecordAudioSource)	audioSource
fileType:	(JRTCAudioRecordFileType)	fileType

开启音频录制（本地录制，不需要建立通信，不能和视频录制 startVideoCaptureRecord 同时开启）

参数

filePath	存储路径
audioSource	录制文件音频源
fileType	文件类型，必须包含文件名（xxx.wav或者pcm）

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ startAudioTest:fileName:

- (bool) startAudioTest:		(JRTCMediaDeviceTestType)	type
fileName:		(NSString *__nullable)	fileName

检测音频设备是否正常

参数

type	音频设备类型，JRTCMediaDeviceTestType
fileName	测试扬声器时播放的文件路径，测试麦克风是传 nil 即可

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ startCamera

- (bool) startCamera

开启摄像头

注解: 调用此方法时需要保证默认摄像头不为空，即 defaultCamera 不为空，否则将直接返回 false

返回

接口调用结果

true: 接口调用成功
- 若调用此方法前摄像头已打开，不会收到回调通知
- 若调用此方法前摄像头未打开，会收到 onCameraUpdate 回调
false: 接口调用异常

◆ startCameraVideo:

- (JRTCMediaDeviceVideoCanvas *__nullable) startCameraVideo: (JRTCMediaDeviceRender) renderType

开始本端视频渲染

获取本端视频预览对象 JRTCMediaDeviceVideoCanvas ，通过此对象能获得视图用于UI显示

注解: 调用此方法时需要保证默认摄像头不为空，即 defaultCamera 不为空，否则将直接返回 nil

参数

renderType

渲染模式:

JRTCMediaDeviceRenderFullScreen : 铺满窗口，会有裁剪
JRTCMediaDeviceRenderFullContent : 全图像显示，会有黑边
JRTCMediaDeviceRenderFullAuto : 自适应

返回

JRTCMediaDeviceVideoCanvas 对象: 开始自身视频渲染成功
nil: 开始自身视频渲染失败

◆ startCameraVideo:view:

- (JRTCMediaDeviceVideoCanvas *__nullable) startCameraVideo:		(JRTCMediaDeviceRender)	type
view:		(UIView *__nonnull)	view

开始自身视频渲染

获取本端视频预览对象 JRTCMediaDeviceVideoCanvas ，通过此对象能获得视图用于UI显示

注解: 调用此方法时需要保证默认摄像头不为空，即 defaultCamera 不为空，否则将直接返回 nil

参数

type	渲染模式: JRTCMediaDeviceRenderFullScreen : 铺满窗口，会有裁剪 JRTCMediaDeviceRenderFullContent : 全图像显示，会有黑边 JRTCMediaDeviceRenderFullAuto : 自适应
view	渲染视图控件

返回

JRTCMediaDeviceVideoCanvas 对象: 开始自身视频渲染成功
nil: 开始自身视频渲染失败

◆ startRing:isLoop:

- (bool) startRing:		(NSString *_Nonnull)	filePath
isLoop:		(bool)	isLoop

开始播放音频

当播放音频文件完成后会收到 onRingPlayFinish 回调通知
参数

filePath 音频文件路径，支持pcm，wav的格式（需要单声道，采样率16K音频文件）

isLoop 是否循环播放

返回
播放音频结果
true: 接口调用成功
false: 接口调用异常

◆ startVideo:renderType:

- (JRTCMediaDeviceVideoCanvas *__nullable) startVideo:		(NSString *__nonnull)	streamId
renderType:		(JRTCMediaDeviceRender)	type

开始其他端的视频渲染

获取其他端的视频预览对象 JRTCMediaDeviceVideoCanvas ，通过此对象能获得视图用于UI显示

参数

streamId	视频流ID
type	渲染模式: JRTCMediaDeviceRenderFullScreen : 铺满窗口，会有裁剪 JRTCMediaDeviceRenderFullContent : 全图像显示，会有黑边 JRTCMediaDeviceRenderFullAuto : 自适应

返回

JRTCMediaDeviceVideoCanvas 对象: 开始其他端视频渲染成功
nil: 开始其他端视频渲染失败

◆ startVideo:renderType:view:

- (JRTCMediaDeviceVideoCanvas *__nullable) startVideo:	(NSString *__nonnull)	streamId
renderType:	(JRTCMediaDeviceRender)	type
view:	(UIView *__nonnull)	view

开始其他端的视频渲染

获取其他端的视频预览对象 JRTCMediaDeviceVideoCanvas ，通过此对象能获得视图用于UI显示

参数

streamId	视频流ID
type	渲染模式: JRTCMediaDeviceRenderFullScreen : 铺满窗口，会有裁剪 JRTCMediaDeviceRenderFullContent : 全图像显示，会有黑边 JRTCMediaDeviceRenderFullAuto : 自适应
view	渲染视图控件

返回

JRTCMediaDeviceVideoCanvas 对象: 开始其他端视频渲染成功
nil: 开始其他端视频渲染失败

◆ startVideoCaptureRecord:recordParam:

- (bool) startVideoCaptureRecord:		(NSString *_Nonnull)	streamId
recordParam:		(JRTCRecordVideoCaptureParam *_Nonnull)	recordParam

开启视频录制（本地录制，不需要建立通信，不能和音频录制 startAudioRecord 同时开启）

参数

streamId	视频流ID, (包括摄像头ID、文件视频源ID、屏幕ID等)
recordParam	录制参数

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ startVideoCaptureRecord:streamId:audioSource:fileType:width:height:

- (bool) startVideoCaptureRecord:	(NSString *_Nonnull)	filePath
streamId:	(NSString *_Nonnull)	streamId
audioSource:	(JRTCRecordAudioSource)	audioSource
fileType:	(JRTCVideoRecordFileType)	fileType
width:	(int)	width
height:	(int)	height

开启视频录制（本地录制，不需要建立通信，不能和音频录制 startAudioRecord 同时开启）

参数

filePath	存储路径
streamId	视频流ID, (包括摄像头ID、文件视频源ID、屏幕ID等)
audioSource	录制文件音频源
fileType	文件类型
width	视频画面像素宽
height	视频画面像素高

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ startVideoFile

- (bool) startVideoFile

开启视频文件作为视频输入源

注解: 文件和摄像头作为视频输入源只能存在一种，如果当前摄像头已开启的话会关闭摄像头

返回

接口调用结果

true: 接口调用成功
- 若调用此方法时文件视频源已开启，则不会收到回调
- 若调用此方法时文件视频源还未开启，则会收到 onCameraUpdate 回调
false: 接口调用异常，不会收到回调

◆ stopAllVideos

- (void) stopAllVideos

停止所有视频渲染

◆ stopAudio

- (bool) stopAudio

停止音频

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ stopAudioInput

- (bool) stopAudioInput

关闭音频输入设备

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ stopAudioOutput

- (bool) stopAudioOutput

关闭音频输出设备

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ stopAudioRecord

- (bool) stopAudioRecord

停止音频录制（本地录制，不需要建立通信）

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ stopAudioTest:

- (bool) stopAudioTest: (JRTCMediaDeviceTestType) type

停止检测音频设备

警告: 开启某项音频设备检测完成后，需停止对应的测试，避免影响后续的音频设备使用。

参数

type	音频设备类型，JRTCMediaDeviceTestType

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ stopCamera

- (bool) stopCamera

关闭摄像头

返回

接口调用结果

true: 接口调用成功
- 调用此方法前摄像头未打开，不会收到回调通知
- 调用此方法前摄像头已打开，会收到 onCameraUpdate 回调
false: 接口调用异常

◆ stopRing

- (bool) stopRing

结束播放音频

会收到 onRingPlayFinish 回调通知

返回

关闭音频结果

true: 接口调用成功
false: 接口调用异常

◆ stopVideo:

- (void) stopVideo: (JRTCMediaDeviceVideoCanvas *__nonnull) canvas

停止视频渲染

参数

canvas JRTCMediaDeviceVideoCanvas 对象，由 startVideo 或 startCameraVideo 接口返回

◆ stopVideoCaptureRecord:

- (bool) stopVideoCaptureRecord: (NSString *_Nonnull) streamId

关闭视频录制（本地录制，不需要建立通信，不能和音频同时录制）

参数

streamId 视频流ID, (包括摄像头ID、文件视频源ID、屏幕ID等)

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ stopVideoFile

- (bool) stopVideoFile

关闭视频文件作为视频输入源

返回

接口调用结果

true: 接口调用成功
- 若调用此方法时文件视频源已关闭，不会收到回调
- 若调用此方法时文件视频源未关闭，则会收到 onCameraUpdate 回调
false: 接口调用异常

◆ suspendAudioInputFromFile:

- (bool) suspendAudioInputFromFile: (bool) suspend

暂停/继续播放语音文件作为音频源输入

参数

suspend true 暂停播放 false 继续播放

返回

调用是否正常

true：正常执行调用流程
false：调用异常

◆ switchCamera

- (bool) switchCamera

切换摄像头

内部会根据当前摄像头类型来进行切换

调用此方法时要保证摄像头已打开，否则将直接返回 false
设备拥有两个以上摄像头，否则将直接返回 true
满足以上两个条件后，内部会调用 switchCamera: 接口并提供返回值

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ switchCamera:

- (bool) switchCamera: (JRTCMediaDeviceCamera *__nonnull) camera

切换到指定摄像头

调用此方法时需要保证摄像头已打开并且摄像头数大于0，否则将直接返回 false

参数

camera 摄像头对象

返回

接口调用结果

true: 接口调用成功
- 摄像头个数 == 1，不会收到回调
- 摄像头个数 > 1，会收到 onCameraUpdate 回调
false: 接口调用异常，不会收到回调

属性说明

◆ appUrlScheme

- (NSString*) appUrlScheme

readwritenonatomiccopy

应用的 URL Schemes,完整的路径，格式:xxxx:// 用于应用外屏幕共享开启后返回主程序

◆ audioInput

- (JRTCMediaDeviceAudio*) audioInput

readwritenonatomicstrong

当前音频输入设备，mac 使用

◆ audioInputFrameCallback

- (id<AudioInputFrameCallback>) audioInputFrameCallback

readwritenonatomicassign

原始音频数据输入回调代理对象

◆ audioInputs

- (NSArray<JRTCMediaDeviceAudio*>*) audioInputs

readnonatomicassign

音频输入设备列表，mac 使用

◆ audioInterrupt

- (bool) audioInterrupt

readnonatomicassign

是否声音被中断

◆ audioOutput

- (JRTCMediaDeviceAudio*) audioOutput

readwritenonatomicstrong

当前音频输出设备，mac 使用

◆ audioOutputs

- (NSArray<JRTCMediaDeviceAudio*>*) audioOutputs

readnonatomicassign

音频输出设备列表，mac 使用

◆ audioParam

- (JRTCMediaDeviceAudioParam*) audioParam

readwritenonatomicstrong

音频参数

需要在调用 startAudio 方法前设置，即连接通话或加入房间前设置此参数。若不设置此参数，将使用默认值。

◆ cameraOpen

- (bool) cameraOpen

readnonatomicassign

摄像头是否打开

◆ cameras

- (NSArray<JRTCMediaDeviceCamera*>*) cameras

readnonatomicassign

摄像头列表

◆ currentCamera

- (JRTCMediaDeviceCamera*) currentCamera

readnonatomicassign

当前摄像头

◆ defaultCamera

- (JRTCMediaDeviceCamera*) defaultCamera

readwritenonatomicassign

默认摄像头

◆ defaultSpeakerOn

- (bool) defaultSpeakerOn

readwritenonatomicassign

没有插入耳机或外接蓝牙时是否默认开启扬声器，默认关闭，iOS 使用

true: 默认开启
false: 默认不开启

◆ desktops

- (NSArray<JRTCMediaDeviceWindow*>*) desktops

readnonatomicassign

桌面列表，mac 使用

◆ isAudioInputStart

- (bool) isAudioInputStart

readnonatomicassign

音频输入设备是否打开

◆ isAudioOutputStart

- (bool) isAudioOutputStart

readnonatomicassign

音频输出设备是否打开

◆ isAutoScreenOrientation

- (bool) isAutoScreenOrientation

readnonatomicassign

屏幕方向是否自适应

◆ screenshareWindow

- (JRTCMediaDeviceWindow*) screenshareWindow

readwritenonatomicstrong

屏幕共享的窗口，mac 使用

◆ useInternalAudioDeviceLogic

- (bool) useInternalAudioDeviceLogic

readwritenonatomicassign

是否使用内部音频设备逻辑

1.打开扬声器 -> 使用扬声器输出声音 2.连上蓝牙耳机 -> 使用蓝牙耳机输出声音，如果扬声器开着则关闭扬声器 3.插入耳机 -> 使用耳机输出声音，如果扬声器开着则关闭扬声器 4.蓝牙耳机和有线耳机以最后连上的作为输出 5.关闭扬声器 -> (蓝牙耳机|有线耳机) > 听筒

◆ videoAngle

- (JRTCMediaDeviceVideoAngle) videoAngle

readwritenonatomicassign

视频窗体角度

◆ videoFileId

- (NSString*) videoFileId

readnonatomicstrong

视频文件作为本地视频源的视频流ID

◆ videoFileOpen

- (bool) videoFileOpen

readnonatomicassign

文件播放是否打开

◆ windows

- (NSArray<JRTCMediaDeviceWindow*>*) windows

readnonatomicassign

窗口列表，mac 使用

filePath	音频文件路径，支持pcm，wav的格式（需要单声道，采样率16K音频文件）
isLoop	是否循环播放

实例方法

类方法

属性

详细描述

成员函数文档

◆ create:callback:initParam:

◆ destroy

◆ enableAudioInputFromFile:filePath:loop:

◆ enableScreenCapture:

◆ enableScreenCapture:appGroupId:preferredExtension:

◆ enableScreenCapture:appGroupId:preferredExtension:captureAudio:

◆ enableSpeaker:

◆ getAnrNoiseLevel

◆ getAnrNoiseRatio

◆ getAudioRouteType

◆ getMicLevel

◆ getScreenCaptureId

◆ getScreenFramerate

◆ getSpkLevel

◆ isSpeakerOn

◆ recoveryRecordFile:

◆ resetScreenCaptureData

◆ setAec:

◆ setAgc:

◆ setAudioInputFrameCallback:

◆ setAutoScreenOrientation:

◆ setCameraProperty:height:framerate:

◆ setCameraWatermarkList:watermarkList:

◆ setDetectBrightness:

◆ setFrontCameraRenderMirror:

◆ setScreenCaptureData:

◆ setScreenCaptureProperty:height:framerate:

◆ setVideoAngle:

◆ setVideoCaptureFrameCallback:

◆ setVideoFileFrame:angle:mirror:

◆ setVideoFileFrame:format:width:height:angle:

◆ snapshotWithStreamId:path:

◆ specifyCamera:

◆ specifyCameraAngle:

◆ startAudio

◆ startAudioInput

◆ startAudioOutput

◆ startAudioRecord:audioSource:fileType:

◆ startAudioTest:fileName:

◆ startCamera

◆ startCameraVideo:

◆ startCameraVideo:view:

◆ startRing:isLoop:

◆ startVideo:renderType:

◆ startVideo:renderType:view:

◆ startVideoCaptureRecord:recordParam:

◆ startVideoCaptureRecord:streamId:audioSource:fileType:width:height:

◆ startVideoFile

◆ stopAllVideos

◆ stopAudio

◆ stopAudioInput

◆ stopAudioOutput

◆ stopAudioRecord

◆ stopAudioTest:

◆ stopCamera

◆ stopRing

◆ stopVideo:

◆ stopVideoCaptureRecord:

◆ stopVideoFile

◆ suspendAudioInputFromFile:

◆ switchCamera

◆ switchCamera:

属性说明

◆ appUrlScheme

◆ audioInput

◆ audioInputFrameCallback

◆ audioInputs

◆ audioInterrupt

◆ audioOutput

◆ audioOutputs

◆ audioParam

◆ cameraOpen

◆ cameras

◆ currentCamera

◆ defaultCamera