租户设置直播租户级配置 - UpdateSmartLiveUserConfig

project_id

是

String

项目ID，获取方法请参考获取项目ID。

X-Auth-Token

否

String

用户Token。使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取。

响应消息头中X-Subject-Token的值。

Authorization

否

String

使用AK/SK方式认证时必选，携带的鉴权信息。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。

格式为(YYYYMMDD'T'HHMMSS'Z')。

X-Project-Id

否

String

使用AK/SK方式认证时必选，携带项目ID信息。

live_exit_config

否

LiveExitConfig object

直播任务退出配置

live_event_callback_config

否

LiveEventCallBackConfig object

直播事件HTTPS回调通知配置

live_notify_config

否

LiveNotifyConfigReq object

直播通知配置。通过短信，邮件，站内信通知用户直播中断。用户可在华为云消息中心配置接受者信息

max_live_duration

否

Integer

参数解释：

最大直播时长。单位小时。

此数值配置为n，则标识起播后n小时后触发停止直播逻辑。

当前数值最大为168（一周），特殊的，0表示不限时。

约束限制：

停止直播逻辑配置为立即停止则直播停止误差在5分钟之内。其他逻辑则加上处理时长。

默认取值：

不设置则表示不限时。

取值范围：

0~168

auto_stop_mode

否

String

参数解释：

自动停止直播模式。

• FORCE_EXIT：立即强制停止，不做其他逻辑处理。

• SEGMENT_END:等待段落结束停止。

• SCENE_END：等待场景结束停止。

• SCRIPT_END：等待剧本结束停止。

约束限制：

不涉及

默认取值：

不设置则表示FORCE_EXIT。

max_exception_waiting_duration

否

Integer

参数解释：

最大异常等待时长。单位分钟。

此数值配置为n，则标识检测到异常n分钟后触发立即停止直播逻辑。

当前数值最大为60（1小时），特殊的，0表示不限时。

约束限制：

不涉及

默认取值：

不设置则为系统默认值，当前为3分钟，默认值可能会根据服务运行状态进行少许调整。

取值范围：

0~60

live_event_type_callback_url

否

String

参数解释：

直播事件回调地址，为https地址。

约束限制：

不涉及。

取值范围：

字符长度0-2048位。

默认取值：

不涉及。

auth_type

否

String

参数解释：

认证类型。

约束限制：

不涉及。

取值范围：

• NONE：URL中自带认证。

• MSS_A：HMACSHA256签名模式，在URL中追加参数hwSecret、hwTime。

• MSS_A_HEAD：HMACSHA256签名模式，参数hwSecret、hwTime放置在Head中。

• MEITUAN_DEFAULT：仅用于美团平台调用回调使用。

取值方式：hwSecret=hmac_sha256(Key, URI（live_event_callback_url）+ hwTime)&hwTime=hex(timestamp)

取值方式：x-hw-mss-secret=hmac_sha256(Key, URI（live_event_callback_url）+ hwTime)

x-hw-mss-time=hex(timestamp)

默认取值：

NONE

key

否

String

参数解释：

密钥Key。

约束限制：

不涉及。

取值范围：

字符长度0-32位。

默认取值：

不涉及。

callback_event_type

否

Array of strings

参数解释：

回调的直播事件类型列表。

约束限制：

不涉及。

取值范围：

当前仅支持如下取值：

• SHOOT_SCRIPT_SWITCH：剧本段落切换事件。

• RTMP_STREAM_STATE_CHANGE：RTMP链接发生变化回调事件。

• REPLY_COMMAND_FINISH：回复播放完成通知。

回调事件结构体定义：

• event_type：事件类型。

• message：事件描述。

  • SHOOT_SCRIPT_SWITCH事件回调定义如下：

    {
      "event_type":  "SHOOT_SCRIPT_SWITCH",
      "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"scene_script_name\":\"商品1\",\"shoot_script_sequence_no\":\"2\",\"shoot_script_title\":\"段落2\"}"
    }

  • RTMP_STREAM_STATE_CHANGE回调定义如下：

    {
      "event_type":  "RTMP_STREAM_STATE_CHANGE",
      "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"output_url\":\"rtmp://xxx/xx/xx\",\"stream_key\":\"xxxxx\",\"state\":\"CONNECTED\"}"
    }

    其中state取值：CONNECTING链路连接中；CONNECTED链路已连接；DISCONNECTED链路已断开，RECONNECTING链路重连中；END联络不再重连，链路已结束。

  • REPLY_COMMAND_FINISH回调定义如下：

    {
      "event_type":  "REPLY_COMMAND_FINISH",
      "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"reply_id\":\"e87104f76d7546ce8a46ac6b04c49c3c"}"
    }

action

否

String

确认操作。

• add: 增加。

• del: 删除。

• replace：替换。

notify_events

否

Array of strings

参数解释：

启用通知事件列表。

约束限制：

不涉及

默认取值：

无。

X-Request-Id

String

请求ID。

error_code

String

错误码。

error_msg

String

错误描述。

error_code

String

错误码。

error_msg

String

错误描述。

error_code

String

错误码。

error_msg

String

错误描述。

200

成功。

400

请求传参异常，包含错误码及对应描述。

401

未鉴权或鉴权失败。

500

内部服务错误。