JCSDK Java API Reference for Android
2.5.1
|
被 com.juphoon.cloud.JCMediaChannelImpl 继承.
类 | |
class | JoinParam |
class | PropChangeParam |
class | RecordParam |
class | ScreenShareParam |
class | SipParam |
Public 成员函数 | |
abstract String | getChannelUri () |
abstract String | getChannelId () |
abstract String | getSessionId () |
abstract String | getPassword () |
abstract int | getChannelNumber () |
abstract String | getTitle () |
abstract int | getState () |
abstract List< JCMediaChannelParticipant > | getParticipants () |
abstract boolean | getUploadLocalAudio () |
abstract boolean | getUploadLocalVideo () |
abstract boolean | getAudioOutput () |
abstract String | getScreenRenderId () |
abstract String | getScreenUserId () |
abstract int | getRecordState () |
abstract int | getCdnState () |
abstract int | query (String channelId) |
abstract boolean | join (String channelIdOrUri, JoinParam joinParam) |
abstract boolean | leave () |
abstract boolean | stop () |
abstract boolean | enableUploadAudioStream (boolean enable) |
abstract boolean | enableUploadVideoStream (boolean enable) |
abstract boolean | enableAudioOutput (boolean enable) |
abstract boolean | requestVideo (JCMediaChannelParticipant participant, @PictureSize int pictureSize) |
abstract boolean | requestScreenVideo (String screenUri, @PictureSize int pictureSize) |
abstract boolean | enableCdn (boolean enable, int keyInterval) |
abstract boolean | enableRecord (boolean enable, RecordParam recordParam) |
abstract boolean | enableScreenShare (boolean enable, ScreenShareParam screenShareParam) |
abstract JCMediaChannelParticipant | getParticipant (String userId) |
abstract String | getStatistics () |
abstract boolean | setCustomProperty (String property) |
abstract String | getCustomProperty () |
abstract boolean | sendMessage (String type, String content, String toUserId) |
abstract boolean | sendCommand (String name, String param) |
abstract int | inviteSipUser (String userId, SipParam sipParam) |
abstract void | setCustomRole (@CustomRole int customRole, JCMediaChannelParticipant participant) |
abstract int | getCustomRole () |
abstract void | setCustomState (@CustomState int customState, JCMediaChannelParticipant participant) |
abstract int | getCustomState () |
abstract boolean | kick (JCMediaChannelParticipant participant) |
abstract boolean | sendCommandToDelivery (String command) |
abstract void | enableSelfVideoRatio (boolean enable, float ratio) |
abstract JCMediaDeviceVideoCanvas | startScreenShareVideo (@JCMediaDevice.RenderType int renderType, @PictureSize int pictureSize) |
abstract void | stopScreenShareVideo () |
abstract JCMediaChannelParticipant | getSelfParticipant () |
静态 Public 成员函数 | |
static JCMediaChannel | create (JCClient client, JCMediaDevice mediaDevice, JCMediaChannelCallback callback) |
static void | destroy () |
Public 属性 | |
boolean | volumeChangeNotify = false |
静态 Public 属性 | |
static final int | REASON_NONE = 0 |
static final int | REASON_NOT_LOGIN = 1 |
static final int | REASON_TIMEOUT = 2 |
static final int | REASON_NETWORK = 3 |
static final int | REASON_CALL_FUNCTION_ERROR = 4 |
static final int | REASON_ALREADY_JOINED = 5 |
static final int | REASON_KICKED = 6 |
static final int | REASON_OFFLINE = 7 |
static final int | REASON_QUIT = 8 |
static final int | REASON_OVER = 9 |
static final int | REASON_FULL = 10 |
static final int | REASON_INVALID_PASSWORD = 11 |
static final int | REASON_INTERNAL_ERROR = 12 |
static final int | REASON_SERVER_ERROR = 13 |
static final int | REASON_INVALID_PARAM = 14 |
static final int | REASON_OTHER = 100 |
static final int | PICTURESIZE_NONE = 0 |
static final int | PICTURESIZE_MIN = 1 |
static final int | PICTURESIZE_SMALL = 2 |
static final int | PICTURESIZE_LARGE = 3 |
static final int | PICTURESIZE_MAX = 4 |
static final int | STATE_IDLE = 0 |
static final int | STATE_JOINING = 1 |
static final int | STATE_JOINED = 2 |
static final int | STATE_LEAVING = 3 |
static final int | PARTICIPANT_TYPE_NORMAL = 0 |
static final int | PARTICIPANT_TYPE_PSTN = 1 |
static final int | PARTICIPANT_TYPE_WEBRTC = 2 |
static final int | PARTICIPANT_TYPE_IRC = 3 |
static final int | VOLUME_STATUS_NONE = 0 |
static final int | VOLUME_STATUS_ZERO = 1 |
static final int | VOLUME_STATUS_LOW = 2 |
static final int | VOLUME_STATUS_MID = 3 |
static final int | VOLUME_STATUS_HIGH = 4 |
static final int | NET_STATUS_DISCONNECTED = 0 |
static final int | NET_STATUS_VERY_BAD = 1 |
static final int | NET_STATUS_BAD = 2 |
static final int | NET_STATUS_NORMAL = 3 |
static final int | NET_STATUS_GOOD = 4 |
static final int | NET_STATUS_VERY_GOOD = 5 |
static final int | RECORD_STATE_NONE = 0 |
static final int | RECORD_STATE_READY = 1 |
static final int | RECORD_STATE_RUNNING = 2 |
static final int | CDN_STATE_NONE = 0 |
static final int | CDN_STATE_READY = 1 |
static final int | CDN_STATE_RUNNING = 2 |
static final int | MAX_RESOLUTION_360p = 0 |
static final int | MAX_RESOLUTION_720p = 1 |
static final int | MAX_RESOLUTION_1080p = 2 |
static final int | CUSTOM_ROLE_NONE = 0 |
static final int | CUSTOM_ROLE_0 = 1<<12 |
static final int | CUSTOM_ROLE_1 = 1<<13 |
static final int | CUSTOM_ROLE_2 = 1<<14 |
static final int | CUSTOM_ROLE_3 = 1<<15 |
static final int | CUSTOM_STATE_NONE = 0 |
static final int | CUSTOM_STATE_0 = 1<<12 |
static final int | CUSTOM_STATE_1 = 1<<13 |
static final int | CUSTOM_STATE_2 = 1<<14 |
static final int | CUSTOM_STATE_3 = 1<<15 |
类似音视频频道的概念,可以通过频道号加入此频道,从而进行音视频通话
|
inlinestatic |
创建 JCMediaChannel 对象
JCMediaChannel 的所有接口函数,如无特殊说明,都建议在主线程调用
client | JCClient 对象 |
mediaDevice | JCMediaDevice 对象 |
callback | JCMediaChannelCallback 对象,用于回调相关通知 |
JCClient、JCMediaDevice、JCMediaChannelCallback 任意参数为空就会抛出异常 |
|
inlinestatic |
销毁 JCMediaChannel 对象
该方法为同步调用,需要等待 JCMediaChannel 实例资源释放后才能执行其他操作,调用此方法后,你将无法再使用 JCMediaChannel 的其它方法和回调。
我们 不建议 在 JCSDK 的回调中调用此方法销毁 JCMediaChannel 对象,有可能会出现崩溃。
如需在销毁后再次创建 JCMediaChannel 实例,需要等待 destroy 方法执行结束后再创建实例。
|
abstract |
获得频道 Uri
不管加入频道时使用的是不是 uri 模式,都能获取到频道 Uri
|
abstract |
|
abstract |
获取服务器唯一频道ID
|
abstract |
获得频道密码
|
abstract |
获得频道号
|
abstract |
返回频道标题
|
abstract |
返回自己的频道状态
|
abstract |
获得频道中的所有成员
|
abstract |
获取本地音频数据是否在上传
|
abstract |
获取本地视频数据是否在上传
|
abstract |
获取音频是否输出
本地没有音频输出的话,就听不到频道内其他成员的声音了
|
abstract |
获取屏幕共享渲染标识
|
abstract |
获取开启屏幕共享的用户标识
|
abstract |
获取视频录制状态
|
abstract |
获得cdn推流状态
|
abstract |
|
abstract |
|
abstract |
|
abstract |
|
abstract |
开启/关闭发送本地音频流
调用该方法可开启或关闭发送本地音频流。开启后,频道成员将听见本端声音;关闭后,频道成员将听不见本端声音
初始化 JCMediaChannel 时,默认设置关闭本地音频流。如果想要在加入频道的时候就让频道内其他成员听见本端声音,可以在调用 join 加入频道前设置
该方法在频道内和频道外均可调用,且在离开频道后该设置仍然有效。也就是说这一次设置了开启发送本地音频流,那么在下一次加入频道时默认会开启发送本地音频流
频道中也可调用此方法开启或关闭发送本地音频流,服务器会更新状态并同步给其他频道成员
频道中调用此方法不影响接收远端音频
enable | 开启/关闭发送本地音频流
|
|
abstract |
开启/关闭发送本地视频流
调用该方法可开启或关闭发送本地视频流。开启后,频道成员将可以看见本端视频画面;关闭后,频道成员将看不见本端视频画面
初始化 JCMediaChannel 时,默认设置发送本地视频流。如果想要在加入频道的时候就让频道内其他成员看见本端视频画面,可以在调用 join 加入频道前设置
该方法在频道内和频道外均可调用,且在离开频道后该设置仍然有效。也就是说这一次设置了关闭发送本地视频流,那么在下一次加入频道时默认会关闭发送本地音频流
频道中也可调用此方法开启或关闭发送本地视频流,服务器会更新状态并同步给其他频道成员
频道中调用此方法不影响接收远端视频
enable | 开启/关闭发送本地视频流
|
|
abstract |
开启/关闭音频输出
该方法可实现本地静音功能。关闭时听不到频道内其他成员的声音,不影响其他成员;开启时可以听到其他成员声音
初始化 JCMediaChannel 时,默认设置开启音频输出功能。如果想要在加入频道的时候听不见其他成员的声音,可以在调用 @join 加入频道前设置
该方法可以关闭或重新开启音频输出功能,在频道内和频道外均可调用,且在离开频道后仍然有效,也就是说这一次设置了关闭音频输出,那么下一次加入频道时也是默认关闭音频输出
enable | 开启/关闭音频输出
|
|
abstract |
请求频道中其他用户的视频流
当 pictureSize 为 PICTURESIZE_NONE 时表示关闭请求
建议使用 startVideo 方法代替
participant | JCMediaChannelParticipant 频道中其他成员对象 |
pictureSize | 视频请求的尺寸类型:
|
|
abstract |
请求屏幕共享的视频流
当 pictureSize 为 PICTURESIZE_NONE 表示关闭请求
screenUri | 屏幕分享uri |
pictureSize | 视频请求尺寸类型,参见:
|
|
abstract |
开启/关闭Cdn推流
enable | 开启/关闭Cdn推流
|
keyInterval | 推流关键帧间隔(毫秒),当 enable 为 true 时有效,有效值需要>=1000 |
|
abstract |
开启/关闭视频录制
enable | 开启/关闭视频录制
|
recordParam | RecordParam 录制参数,当 enable 为 true 时,可以更改由 join 时传入的录制参数,不需更改则填 null |
|
abstract |
开启/关闭屏幕分享
在频道中调用此方法才有效
enable | 开启/关闭屏幕分享
|
screenShareParam | 屏幕分享参数,当 enable 为 true 时有效,传 null 表示使用媒体引擎的默认值,详情见 ScreenShareParam |
|
abstract |
|
abstract |
获取统计信息
以Json字符串形式返回,其中包含 "Config"、"Network"、"Transport"、"Participants" 4个键值,示例如下:
{
"Config": "Video Config:\r\n SRTP: off \r\n Codec: H264-SVC \r\n Payload: 125 \r\n Bitrate: 1000 \r\n Framerate: 24 \r\n Resolution: 640x352 \r\n FEC: on|124|123 \r\n FIR: off \r\n Key Interval: 0 \r\n Repeat: 0 \r\n NACK: off \r\n RTX: off \r\n TMMBR: off \r\n RPSI: off \r\n Small NALU: on \r\n ARS: off \r\n BR Min: 10 \r\n BR Max: 2000 \r\n FR Min: 1 \r\n FR Max: 30 \r\n Res. Ctrl: off \r\n Res. Mode: 0 \r\n Fr Ctrl: off \r\n CPU Load Ctrl: off \r\n Target: 80 \r\n Bw Efficient: off \r\n Error Conceal: off \r\n Enhance color: off \r\n Boost bright: off \r\n Boost contrast: off \r\n RTP Ext: CVO \r\n Render Name: N\/A \r\n",
"Network": "Server(-176574541330799):\r\n4466(1): BWE(4592|1231) IN(A:0;)\r\n\r\n",
"Transport": "Local: 100.306884891:44795\r\nRemote: 120:14243\r\n\r\nLastPaths: 120,120\r\n\r\nPath: 120 [tcp]\r\n Step1:Delay\/Loss(S\/R): 55\/0\/0\r\n Cost: 65** (best: 40)\r\nPath: 151 [udp]\r\n Step1:Delay\/Loss(S\/R): 43\/0\/0\r\n Cost: 132\r\nPath: 105 [tcp]\r\n Step1:Delay\/Loss(S\/R): 55\/0\/0\r\n Cost: 142\r\nPath: 100 [tcp]\r\n Step1:Delay\/Loss(S\/R): 43\/0\/0\r\n Cost: 144\r\n",
"Participants": [{
"4466": "Video Sending Stats:\r\n Packets: 0 \r\n Capture Fr: 24 \r\n FPS\/IDR: 0\/0 \r\n Resolution: 640x352[0|0|0] \r\n Bitrate\/Setrate:0\/1000 \r\n QP: 0 \r\n FecPrecent: 20\r\nBe Subscribed Stats:\r\n Audio: true\r\n Video: [0|0|0|0]\r\n Screen: [0|0|0|0]\r\n"
}]
}
|
abstract |
设置频道自定义属性
property | 自定义属性 |
|
abstract |
获取频道自定义属性
|
abstract |
发送消息
此接口调用成功后,消息接收方会收到 onMessageReceive 回调,通过此回调可以获取消息的文本类型和文本内容
type | 消息类型 |
content | 消息内容,不能为空,并且当 toUserId 不为 null 时,content 不能大于 4k |
toUserId | 接收者id,null则发给频道所有人员 |
|
abstract |
发送指令
name | 指令名 |
param | 指令参数 |
|
abstract |
邀请Sip用户
一般用于对接落地网关等
userId | 一般为号码 |
sipParam | SipParam 参数对象 |
|
abstract |
设置自定义角色
customRole | 自定义角色 |
participant | JCMediaChannelParticipant 对象,传 null 表示自己 |
|
abstract |
获得自定义角色
|
abstract |
设置自定义状态
customState | 自定义状态 |
participant | JCMediaChannelParticipant 对象,传 null 表示自己 |
|
abstract |
获得自定义状态
|
abstract |
|
abstract |
发送命令给推流或录制器
发送命令给推流时,只有在频道中并且推流状态为 CDN_STATE_READY 才生效
发送命令给录制器时,只有在频道中并且录制状态为 RECORD_STATE_READY 才生效
command | 命令字符串 |
|
abstract |
设置自身视频宽高比
enable | 是否开启自身视频宽高比
|
ratio | 视频宽高比 |
|
abstract |
启动频道成员的屏幕分享视频渲染
频道成员开启屏幕分享时,调用此方法可获得屏幕分享渲染对象 JCMediaDeviceVideoCanvas
renderType | 渲染模式:
|
pictureSize | 视频请求的尺寸类型:
|
|
abstract |
停止屏幕分享视频渲染
|
abstract |
获得自身 JCMediaChannelParticipant 对象
|
static |
不渲染
|
static |
最小尺寸
|
static |
小尺寸
|
static |
大尺寸
|
static |
最大尺寸
|
static |
空闲状态
|
static |
加入中
|
static |
已加入
|
static |
离开中
|
static |
普通成员
|
static |
PSTN成员
|
static |
Webrtc成员
|
static |
录制器成员(录制和推流),该类型成员不会上报给上层应用
|
static |
静音
|
static |
无声音
|
static |
低
|
static |
中
|
static |
高
|
static |
无
|
static |
非常差
|
static |
差
|
static |
一般
|
static |
好
|
static |
非常好
|
static |
无法进行视频录制
|
static |
可以开启视频录制
|
static |
视频录制中
|
static |
无法进行Cdn推流
|
static |
可以开启Cdn推流
|
static |
Cdn推流中
|
static |
最大分辨率 360p
|
static |
最大分辨率 720p
|
static |
最大分辨率 1080p
|
static |
无自定义角色
|
static |
自定义角色0
|
static |
自定义角色1
|
static |
自定义角色2
|
static |
自定义角色3
|
static |
无自定义状态
|
static |
自定义状态0
|
static |
自定义状态1
|
static |
自定义状态2
|
static |
自定义状态3
boolean com.juphoon.cloud.JCMediaChannel.volumeChangeNotify = false |
是否通知成员音量变化,默认不通知