开启字幕

POST

/rsc/api/v3/user/sessions/{sessionId}/subtitle/actions/start

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

sessionId

string

必需

示例值:

Header 参数

x-endpoint-id

string

操作人端点Id

必需

示例值:

Body 参数application/json

subtitleInfo

object (SubtitleInfoForm)

字幕内容

必需

text

string

字幕内容

必需

<= 300 字符

textSize

integer

必需

字幕文字大小, 0-小/1-中/2-大

>= 0<= 2

textColor

object (ColorForm)

字幕文字颜色

必需

backgroundColor

object (ColorForm)

字幕背景颜色

必需

textLocation

integer

必需

字幕文字位置，0-上左/1上中/2上右/3中左/4中中/5中右/6下左/7下中/8下右

>= 0<= 8

displayModel

integer

必需

字幕显示模式， 0-从左到右滑动/1-从右到左滑动/2-固定

>= 0<= 2

示例

{
    "subtitleInfo": {
        "text": "XkYVieN4!d]uHE9AIfH)&X4grJ1p26p7ow9g1fm6DyVZRJFgiqb@tZm9UX1yE!N)cAXl*#$CbVL2gu[k^hitEUXvT^8#9GMcu[h!aP)2*bMlbx73t)j%bhFhVt$Pi*cBO5LzntsJyuyDg0hBK%0SyI*ZinDP]5X^$2oQpWbooQZy3FnWGDFW1FbcApVRwa3rTYs1KqY&XRMkFk*dhez4diAIWkxgG9JOj4rz]#CAX9p",
        "textSize": 1,
        "textColor": {
            "a": 0.2166411,
            "r": 163,
            "g": 35,
            "b": 58
        },
        "backgroundColor": {
            "a": 1.3966531681212,
            "r": 38,
            "g": 167,
            "b": 62
        },
        "textLocation": 2,
        "displayModel": 0
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST '/rsc/api/v3/user/sessions/{{sessionId}}/subtitle/actions/start' \
--header 'x-endpoint-id: {{endpointId}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "subtitleInfo": {
        "text": "XkYVieN4!d]uHE9AIfH)&X4grJ1p26p7ow9g1fm6DyVZRJFgiqb@tZm9UX1yE!N)cAXl*#$CbVL2gu[k^hitEUXvT^8#9GMcu[h!aP)2*bMlbx73t)j%bhFhVt$Pi*cBO5LzntsJyuyDg0hBK%0SyI*ZinDP]5X^$2oQpWbooQZy3FnWGDFW1FbcApVRwa3rTYs1KqY&XRMkFk*dhez4diAIWkxgG9JOj4rz]#CAX9p",
        "textSize": 1,
        "textColor": {
            "a": 0.2166411,
            "r": 163,
            "g": 35,
            "b": 58
        },
        "backgroundColor": {
            "a": 1.3966531681212,
            "r": 38,
            "g": 167,
            "b": 62
        },
        "textLocation": 2,
        "displayModel": 0
    }
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

{}

获取第三方网关信息

停止字幕