发送字幕
更新时间:2025-04-08 17:48:53

发送字幕

请求方法

PUT

请求地址

/ctrl/meetings/{meetingNumber}/barrage

请求参数

参数 参数类型 数据类型 是否必需 描述
meetingNumber path string 会议号
receiver body BarrageReceiver结构体 发送对象
position body string 字幕显示位置,可选:top(画面顶部),medium(画面中部),bottom(画面底部)
content body string 字幕内容
duration body int 显示时长,单位秒(不限时传值-1)
fontSize body int 字体大小,可选:32, 34(默认), 36, 40, 44
fontColor body string 字体颜色,传值为统一了色号后的HEX格式。可选:白色(#FFFFFF)、黄色(#FFA51E)、蓝色(#006CE6)、红色(#F54849)、黑色(#1A1A1A)
backgroundColor body string 背景颜色,传值为统一了色号后的HEX格式。可选:红色(#F54849)、黄色(#FFA51E)、蓝色(#006CE6)、黑色(#1A1A1A)、透明(传空值)

BarrageReceiver结构体 参数

参数 数据类型 是否必需 描述
host bool 字幕发送对象为主持人
attendee bool 字幕发送对象为与会者
audience bool 字幕发送对象为观众

HTTP状态码

返回值 描述
200 操作成功
400 客户端传参异常
401 鉴权失败
404 找不到请求的资源
500 服务端异常

请求消息示例

PUT /ctrl/meetings/10000/barrage HTTP/1.1
{
    "receiver":{
        "host":true,
        "attendee":true,
        "audience":false
    },
    "position":"top",
    "content":"123",
    "duration":30,
    "fontSize":34,
    "fontColor":"#FFFFFF",
    "backgroundColor":"#1A1A1A"
}

响应消息示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ret": 0,
    "bizCode": 900200
}
本页目录