JRTCSDK-Java v2301.0
多方通话 API 文档
|
类 | |
interface | AudioDeviceState |
interface | AudioInputFrameCallback |
interface | AudioRecordFileType |
interface | BeautyFilterType |
interface | CameraType |
interface | DeviceTestType |
class | JRTCMediaDeviceAudio |
class | JRTCMediaDeviceCamera |
class | JRTCMediaDeviceDesktop |
class | JRTCMediaDeviceWindow |
interface | RecordAudioSource |
interface | RenderType |
interface | VideoAngle |
interface | VideoFrameCallback |
interface | VideoPixelFormat |
interface | VideoRecordFileType |
Public 成员函数 | |
abstract JRTCMediaDeviceAudio | getOpenedAudioOutput () |
abstract List< JRTCMediaDeviceAudio > | getOpenedAudioInputs () |
abstract List< JRTCMediaDeviceAudio > | getAudioInputs () |
abstract List< JRTCMediaDeviceAudio > | getAudioOutputs () |
abstract void | setDefaultAudioInput (JRTCMediaDeviceAudio audioInput) |
abstract JRTCMediaDeviceAudio | getDefaultAudioInput () |
abstract void | setDefaultAudioOutput (JRTCMediaDeviceAudio audioOutput) |
abstract JRTCMediaDeviceAudio | getDefaultAudioOutput () |
abstract boolean | startAudio () |
abstract boolean | isAudioStart () |
abstract boolean | stopAudio () |
abstract boolean | startAudioInput (JRTCMediaDeviceAudio audioInput) |
abstract boolean | stopAudioInput (JRTCMediaDeviceAudio audioInput) |
abstract boolean | stopAllAudioInputs () |
abstract boolean | startAudioOutput (JRTCMediaDeviceAudio audioOutput) |
abstract boolean | stopAudioOutput () |
abstract boolean | enableLoopback (boolean enable) |
abstract List< JRTCMediaDeviceCamera > | getCameras () |
abstract List< JRTCMediaDeviceCamera > | getOpenedCameras () |
abstract List< JRTCMediaDeviceWindow > | getWindows () |
abstract List< JRTCMediaDeviceDesktop > | getDesktops () |
abstract JRTCBeautyEffectParam | getBeautyEffectParam () |
abstract JRTCMediaDeviceVideoCanvas | startCameraVideo (int view, JRTCMediaDeviceCamera camera, @RenderType int renderType) |
abstract JRTCMediaDeviceVideoCanvas | startVideo (int view, String streamId, @RenderType int renderType) |
abstract void | stopVideo (JRTCMediaDeviceVideoCanvas canvas) |
abstract void | stopAllVideos () |
abstract boolean | startCamera (JRTCMediaDeviceCamera camera) |
abstract boolean | isCameraOpen () |
abstract boolean | stopCamera (JRTCMediaDeviceCamera camera) |
abstract boolean | stopAllCameras () |
abstract boolean | switchCamera (JRTCMediaDeviceCamera oldCamera, JRTCMediaDeviceCamera newCamera) |
abstract void | setCameraProperty (int width, int height, int frameRate) |
abstract boolean | isVideoFileOpen () |
abstract String | getVideoFileId () |
abstract boolean | startVideoFile () |
abstract void | setVideoFileFrame (byte[] data, @VideoPixelFormat int format, int width, int height, int angle, int mirror, boolean keyFrame) |
abstract boolean | stopVideoFile () |
abstract void | setScreenCaptureProperty (int width, int height, int frameRate) |
abstract boolean | enableScreenOrWindowCapture (boolean enable, String streamId) |
abstract boolean | enableScreenOrWindowAreaCapture (boolean enable, String streamId, int frameRate, int top, int bottom, int left, int right) |
abstract boolean | snapshotWithStreamId (String streamId, String path) |
abstract boolean | snapshotWithStreamId (String streamId, String path, int width, int height) |
abstract void | setAudioInputFrameCallback (AudioInputFrameCallback callback) |
abstract void | setVideoCaptureFrameCallback (VideoFrameCallback callback) |
abstract void | setVideoAngle (@VideoAngle int angle) |
abstract int | getVideoAngle () |
abstract boolean | startVideoCaptureRecord (@NonNull String streamId, @NonNull JRTCRecordVideoCaptureParam recordVideoCaptureParam) |
abstract boolean | startVideoCaptureRecord (@NonNull String filePath, @NonNull String streamId, @RecordAudioSource int audioSource, @VideoRecordFileType int fileType, int width, int height) |
abstract boolean | stopVideoCaptureRecord (@NonNull String streamId) |
abstract boolean | startAudioRecord (String filePath, @RecordAudioSource int audioSource, @AudioRecordFileType int fileType) |
abstract boolean | stopAudioRecord () |
abstract boolean | enableVirtualBacklot (boolean enable, String imagePath) |
abstract boolean | startAudioTest (@DeviceTestType int type, String fileName, JRTCMediaDeviceAudio audioDevice) |
abstract boolean | stopAudioTest (@DeviceTestType int type) |
abstract int | getMicLevel () |
abstract int | getSpkLevel () |
abstract int | getAnrNoiseLevel () |
abstract int | getAnrNoiseRatio () |
abstract boolean | controlBeautyEffect (boolean start, JRTCBeautyEffectParam beautyEffectParam) |
abstract boolean | controlBeautyFilter (@BeautyFilterType int filterType) |
abstract boolean | startRing (String filePath, boolean isLoop) |
abstract boolean | stopRing () |
静态 Public 成员函数 | |
static JRTCMediaDevice | create (JRTCClient client, JRTCMediaDeviceCallback callback, JRTCMediaDeviceInitParam initParam) |
static void | destroy () |
静态 Public 属性 | |
static final int | RENDER_FULL_SCREEN = 0 |
static final int | RENDER_FULL_CONTENT = 1 |
static final int | RENDER_FULL_AUTO = 2 |
static final int | CAMERA_NONE = 0 |
static final int | CAMERA_FRONT = 1 |
static final int | CAMERA_BACK = 2 |
static final int | CAMERA_UNKNOWN = 3 |
static final int | VIDEO_ANGLE_AUTO = -1 |
static final int | VIDEO_ANGLE_0 = 0 |
static final int | VIDEO_ANGLE_90 = 90 |
static final int | VIDEO_ANGLE_180 = 180 |
static final int | VIDEO_ANGLE_270 = 270 |
static final int | I420 = 1 |
static final int | IYUV = 2 |
static final int | RGB24 = 3 |
static final int | ABGR = 4 |
static final int | ARGB = 5 |
static final int | ARGB444 = 6 |
static final int | RGB565 = 7 |
static final int | ARGB1555 = 8 |
static final int | YUY2 = 9 |
static final int | YV12 = 10 |
static final int | UYVY = 11 |
static final int | MJPG = 12 |
static final int | NV21 = 13 |
static final int | NV12 = 14 |
static final int | BGRA = 15 |
static final int | H264 = 100 |
static final int | AUDIO_RECORD_FILE_PCM = 0 |
static final int | AUDIO_RECORD_FILE_WAV_PCM = 1 |
static final int | AUDIO_RECORD_FILE_WAV_PCMU = 2 |
static final int | AUDIO_RECORD_FILE_WAV_PCMA = 3 |
static final int | AUDIO_RECORD_FILE_WAV_AMR = 4 |
static final int | VIDEO_RECORD_FILE_AVI_VP8 = 1 |
static final int | VIDEO_RECORD_FILE_AVI_I420 = 2 |
static final int | VIDEO_RECORD_FILE_AVI_H264 = 3 |
static final int | VIDEO_RECORD_FILE_MP4_H264 = 4 |
static final int | RECORD_AUDIO_NO = 0 |
static final int | RECORD_AUDIO_FROM_MICROPHONE = 1 |
static final int | RECORD_AUDIO_FROM_SPEAKER = 2 |
static final int | RECORD_AUDIO_BOTH = 3 |
static final int | DEVICE_TEST_TYPE_MIC = 1 |
static final int | DEVICE_TEST_TYPE_SPEAKER = 2 |
static final int | BEAUTY_FILTER_PINK = 1 |
static final int | BEAUTY_FILTER_CHERRY = 2 |
static final int | BEAUTY_FILTER_FRESH = 3 |
static final int | BEAUTY_FILTER_DETACHED = 4 |
static final int | BEAUTY_FILTER_COWBOY = 5 |
static final int | BEAUTY_FILTER_FRAGRANCE = 6 |
static final int | BEAUTY_FILTER_SPIRIT = 7 |
static final int | BEAUTY_FILTER_BRIGHT = 8 |
static final int | BEAUTY_FILTER_ROMANCE = 9 |
static final int | BEAUTY_FILTER_AESTHETICISM = 10 |
static final int | BEAUTY_FILTER_PURE = 11 |
static final int | BEAUTY_FILTER_BLACK = 12 |
static final int | AUDIO_DEVICE_STATE_ACTIVE = 1 |
static final int | AUDIO_DEVICE_STATE_DISABLED = 2 |
static final int | AUDIO_DEVICE_STATE_NOTPRESENT = 3 |
static final int | AUDIO_DEVICE_STATE_UNPLUGGED = 4 |
static final int | AUDIO_DEVICE_STATE_INVALID = 5 |
Protected 成员函数 | |
abstract void | destroyObj () |
音视频设备管理
|
abstract |
开启/关闭摄像头美颜功能
start | 打开/关闭 |
beautyEffectParam | 美颜参数对象 |
|
abstract |
|
static |
创建 JRTCMediaDevice 对象
client | client对象 |
callback | JRTCMediaDeviceCallback 回调接口,用于接收 JRTCMediaDevice 相关通知 |
initParam | 预留参数,目前不生效 |
|
static |
销毁 JRTCMediaDevice 对象
|
abstractprotected |
销毁对象
|
abstract |
开启/关闭 loopback 音频采集
enable | 开启/关闭 |
|
abstract |
开启/关闭屏幕区域采集
enable | 开启或是关闭区域共享 |
streamId | 窗口或者屏幕的ID |
frameRate | 采集帧率 |
top | 上边距 |
bottom | 下边距 |
left | 左边距 |
right | 右边距 |
|
abstract |
开启/关闭屏幕采集
enable | 开启或关闭屏幕采集 |
streamId | 窗口或者屏幕的ID |
|
abstract |
开启/关闭虚拟背景墙
enable | 是否开启虚拟背景墙 |
imagePath | 背景图片路径,当 enable 为 true 时有效 |
|
abstract |
获取当前噪声强度 环境平均噪声强度(1s), 检测需要打开麦克风 startAudio
或者 startAudioInput
|
abstract |
获取当前信噪比强度 环境平均信噪比强度(1s), 检测需要打开麦克风 startAudio
或者 startAudioInput
|
abstract |
获取所有音频输入设备列表
|
abstract |
获取所有音频输出设备列表
|
abstract |
获取当前美颜设置参数
|
abstract |
获取摄像头列表
|
abstract |
获取默认音频输入设备
|
abstract |
获取默认音频输出设备
|
abstract |
获取当前桌面列表
|
abstract |
获取当前本地音量级别,音量级别范围为0-100,用以测试设备 目前只在开始麦克风检测,或者当房间内有输入音频时,才能获取到有效的音量级别
|
abstract |
获取使用中的音频输入设备列表
|
abstract |
获取使用中的音频输出设备
|
abstract |
获取当前打开的摄像头列表
|
abstract |
获取当前扬声器音量级别,音量级别范围为0-100,用以测试设备 目前只在开始扬声器检测,或者当房间内有输出音频时,才能获取到有效的音量级别
|
abstract |
获取视频窗体角度
|
abstract |
获取文件视频流ID
|
abstract |
获取当前窗口列表
|
abstract |
音频设备是否打开
|
abstract |
是否有摄像头打开
|
abstract |
是否开启文件视频源
|
abstract |
设置音频输入数据回调
callback | AudioInputFrameCallback 接口对象 |
|
abstract |
|
abstract |
设置默认音频输入设备,可以在业务进行前设置
|
abstract |
设置默认音频输出设备,可以在业务进行前设置
|
abstract |
设置屏幕共享采集属性 在调用 enableScreenOrWindowCapture
接口开启屏幕共享前设置即可生效
width | 采集宽度,默认640 |
height | 采集高度,默认360 |
frameRate | 采集帧速率,默认10 |
|
abstract |
设置视频窗体角度
angle | 参看 VideoAngle |
|
abstract |
设置视频采集帧数据回调
callback | VideoFrameCallback 接口对象 |
|
abstract |
逐帧采集视频画面
当为 H264 格式时
data | 画面二进制数据 |
format | 视频像素格式 |
width | 宽 |
height | 高 |
angle | 90 的倍数 |
mirror | 0 不镜像,1进行左右镜像 |
keyFrame | 是否为关键帧,针对 format 为 H264 |
|
abstract |
截图
streamId | 要截图的视频流ID |
path | 要存放的文件路径 |
|
abstract |
截图
streamId | 要截图的视频流ID |
path | 要存放的文件路径 |
width | 视频画面像素宽 |
height | 视频画面像素高 |
|
abstract |
启动音频
|
abstract |
打开音频输入设备
audioInput | 音频输入设备 |
|
abstract |
打开音频输出设备
audioOutput | 音频输出设备 |
|
abstract |
开启音频录制(本地录制,不需要建立通信,不能和视频录制 startVideoCaptureRecord
同时开启)
filePath | 保存的文件路径,必须包含文件名(xxx.wav或者pcm) |
audioSource | 录制文件音频源 |
fileType | 录制文件编码封装类型 |
|
abstract |
检测音频设备是否正常
type | 音频设备类型 |
fileName | 测试扬声器时播放的文件路径,测试麦克风时传 null 即可 |
audioDevice | 测试的音频设备,输入设备或者输出设备 |
|
abstract |
开启指定摄像头
onCameraUpdate
回调
|
abstract |
开始本端视频渲染
获取本端视频预览对象 JRTCMediaDeviceVideoCanvas,通过此对象能获得视图用于UI显示
view | 视频窗口句柄 |
camera | 摄像头对象 |
renderType | 渲染模式:
|
|
abstract |
开始播放音频
onRingPlayFinish
回调通知 filePath | 音频文件路径,支持pcm,wav的格式(需要单声道,采样率16K音频文件) |
isLoop | 是否循环播放 |
|
abstract |
开始其他端的视频渲染
获取其他端的视频预览对象 JRTCMediaDeviceVideoCanvas,通过此对象能获得视图用于UI显示
view | 视频窗口句柄 |
streamId | 视频流ID |
renderType | 渲染模式:
|
|
abstract |
开启视频录制(本地录制,不需要建立通信,不能和音频录制 startAudioRecord
同时开启)
filePath | 保存的文件路径,必须包含文件名(xxx.mp4或者xxx.avi) |
streamId | 视频流ID, (包括摄像头ID、文件视频源ID、屏幕ID等) |
audioSource | 录制文件音频源 |
fileType | 录制文件编码封装类型 |
width | 录制文件宽(传-1则使用实际视频采集的宽) |
height | 录制文件高(传-1则使用实际视频采集的高) |
startVideoCaptureRecord
替换
|
abstract |
开启视频录制(本地录制,不需要建立通信,不能和音频录制 startAudioRecord
同时开启)
streamId | 视频流ID, (包括摄像头ID、文件视频源ID、屏幕ID等) |
recordVideoCaptureParam | 录制参数 |
|
abstract |
开启视频文件作为视频输入源
onCameraUpdate
回调
|
abstract |
关闭当前所有打开的音频输入设备
|
abstract |
关闭当前打开的所有摄像头
onCameraUpdate
回调
|
abstract |
停止所有视频渲染
|
abstract |
停止音频
|
abstract |
关闭音频输入设备
audioInput | 音频输入设备 |
|
abstract |
关闭当前打开的音频输出设备
|
abstract |
关闭音频录制(本地录制,不需要建立通信)
|
abstract |
|
abstract |
关闭指定摄像头
onCameraUpdate
回调
|
abstract |
结束播放音频
onRingPlayFinish
回调通知
|
abstract |
停止视频渲染
canvas | JRTCMediaDeviceVideoCanvas 对象,由 startVideo 或 startCameraVideo 接口返回 |
|
abstract |
关闭视频录制(本地录制,不需要建立通信)
streamId | 视频流ID, (包括摄像头ID、文件视频源ID、屏幕ID等) |
|
abstract |
关闭视频文件作为视频输入源
onCameraUpdate
回调
|
abstract |
切换摄像头
|
static |
ABGR
|
static |
ARGB
|
static |
ARGB1555
|
static |
ARGB444
|
static |
音频设备已使能,且插入启用
|
static |
停用音频设备
|
static |
音频设备在使用期间失效
|
static |
未发现音频设备
|
static |
音频设备已使能,但未插入启用
|
static |
封装格式PCM, 编码格式PCM
|
static |
封装格式WAV,编码格式AMR
|
static |
封装格式WAV, 编码格式PCM
|
static |
封装格式WAV,编码格式PCMA
|
static |
封装格式WAV,编码格式PCMU
|
static |
唯美
|
static |
黑白
|
static |
明亮
|
static |
樱红
|
static |
牛仔
|
static |
超脱
|
static |
气氛
|
static |
清新
|
static |
粉嫩
|
static |
纯真
|
static |
浪漫
|
static |
元气
|
static |
BGRA
|
static |
后置摄像头
|
static |
前置摄像头
|
static |
未获取到摄像头
|
static |
未知摄像头
|
static |
麦克风
|
static |
扬声器
|
static |
H264
|
static |
I420
|
static |
IYUV
|
static |
MJPG
|
static |
NV12
|
static |
NV21
|
static |
录制输入音频和输出音频
|
static |
录制输入音频
|
static |
录制输出音频
|
static |
不录制音频
|
static |
自适应
|
static |
视频图像的内容完全呈现到渲染区域(可能会出现黑边,类似放电影的荧幕)
|
static |
视频图像按比例填充整个渲染区域(裁剪掉超出渲染区域的部分区域)
|
static |
RGB24
|
static |
RGB565
|
static |
UYVY
|
static |
0度
|
static |
180度
|
static |
270度
|
static |
90度
|
static |
自动
|
static |
封装格式AVI,视频编码格式H264, 音频编码格式PCM
|
static |
封装格式AVI,视频编码格式I420, 音频编码格式PCM
|
static |
封装格式AVI,视频编码格式VP8, 音频编码格式PCM
|
static |
封装格式MP4,视频编码格式H264,音频编码格式AAC
|
static |
YUY2
|
static |
YV12