Call/Share

1) EndQuickShare  (结束会前投屏)

接口支持最低版本号:3.10.160

此接口同步返回调用结果 (推荐使用5.7.8 StopShare 接口)

request

{
    "jsonrpc":"2.0",
    "id":"xxx",
    "method":"Call/Share",
    "params":{
	"action":"EndQuickShare",
        "meeting_type":"castMeeting"
    }
}

response

{
    "jsonrpc":"2.0",
    "method":"Call/Share",
    "id":"xxx",
    "result":{
        "error_code":0,
        "action":"EndQuickShare",
        "message":""
    }
}

2) CancelQuickShare  (取消会前投屏)

接口支持最低版本号:3.10.160

此接口同步返回调用结果 (推荐使用5.7.8 StopShare 接口)

request

{
    "jsonrpc":"2.0",
    "id":"xxx",
    "method":"Call/Share",
    "params":{
	"action":"CancelQuickShare",
        "meeting_type":"castMeeting"
    }
}

response

{
    "jsonrpc":"2.0",
    "method":"Call/Share",
    "id":"xxx",
    "result":{
        "error_code":0,
        "action":"CancelQuickShare",
        "message":""
    }
}

3) StartWindowShare  (开启窗口共享)

接口支持最低版本号:3.11.170

此接口同步返回调用结果 (推荐使用5.7.7 StartShare 接口)

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Share",
    "params": {
        "action": "StartWindowShare",
        "action_params": {
            "share_voice": true, // 同时共享桌面声音
            "fluency_first": true, // 视频流畅度优先
            "select_index": 0 // 可选,窗口索引,默认共享桌面
        }
    }
}

response

{
    "jsonrpc":"2.0",
    "method":"Call/Share",
    "id":"xxx",
    "result":{
        "error_code":0,
        "action":"StartWindowShare",
        "message":""
    }
}

4) StopWindowShare  (结束窗口共享)

接口支持最低版本号:3.11.170

此接口同步返回调用结果 (推荐使用5.7.8 StopShare 接口)

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Share",
    "params": {
        "action": "StopWindowShare"
    }
}

response

{
    "jsonrpc":"2.0",
    "method":"Call/Share",
    "id":"xxx",
    "result":{
        "error_code":0,
        "action":"StopWindowShare",
        "message":""
    }
}

5) OpenShareGuide  (打开投屏说明)

接口支持最低版本号:3.13.190

此接口同步返回调用结果

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Share",
    "params": {
        "action": "OpenShareGuide",
    }
}

response

{
    "jsonrpc":"2.0",
    "method":"Call/Share",
    "id":"xxx",
    "result":{
        "error_code":0,
        "action":"OpenShareGuide",
        "message":""
    }
}

6) CloseShareGuide  (关闭投屏说明)

接口支持最低版本号:3.13.190

此接口同步返回调用结果

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Share",
    "params": {
        "action": "CloseShareGuide",
    }
}

response

{
    "jsonrpc":"2.0",
    "method":"Call/Share",
    "id":"xxx",
    "result":{
        "error_code":0,
        "action":"CloseShareGuide",
        "message":""
    }
}

7) StartShare  (启动共享)

接口支持最低版本号:3.13.190

此接口同步返回调用结果

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Share",
    "params": {
        "action": "StartShare",
        "action_params":{
            "share_type": int, // 共享类型,必须,参考如下 share_type 定义
            "share_voice": bool, // 同时共享声音,可选,share_type = 0|1 时有效
            "fluency_first": bool, // 视频流畅度优先,可选,share_type = 0 时有效
            "select_index": int, // 窗口索引,可选,默认共享桌面,share_type = 0 时有效
            "device_id": str // 采集设备ID,可选,默认使用第一个采集设备,share_type = 1 时有效
        }
    }
}
share_type 共享类型
0 共享本地窗口
1 共享采集设备

response

{
    "jsonrpc":"2.0",
    "method":"Call/Share",
    "id":"xxx",
    "result":{
        "error_code":0,
        "action":"StartShare",
        "message":""
    }
}

8) StopShare  (停止共享)

接口支持最低版本号:3.13.190

此接口同步返回调用结果

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Share",
    "params": {
        "action": "StopShare"
    }
}

response

{
    "jsonrpc":"2.0",
    "method":"Call/Share",
    "id":"xxx",
    "result":{
        "error_code":0,
        "action":"StopShare",
        "message":""
    }
}
下载 Call/Share.pdf
Copyright(C)2023 HFBangFu Inc. All Rights Reserved 皖ICP备12017563号-5