全部产品
阿里云办公

添加回调

更新时间:2018-06-27 19:15:48

描述

用户回调通知接口,请按照如下格式处理回调请求。

请求参数

参数 类型 是否必选 描述
CasterId String 导播间Id。
若类型为OperateCallback、RuntimeErrorCallback时,必须输入该参数。
若类型为EpisodeGroupCallback时,可选择性输入改参数。
EventType String 事件类型
OperateCallback:操作回调
RuntimeErrorCallback:运行时错误回调
EpisodeGroupCallback:轮播台回调
EventMessage EventMessage 事件信息

EventMessage(OperateCallback、RuntimeErrorCallback)

参数 类型 是否必选 描述
RequestId String 请求ID,OperateCallback:操作回调时必输
SceneId String 场景ID,涉及场景事件,指定关联场景ID
LayoutId String 布局ID,涉及布局事件,指定关联布局ID
ResourceId String 资源ID,涉及视频源事件,指定关联视频源ID
ComponentId String 组件ID,涉及组件事件,指定关联组件ID
Code String 状态码
Message String 描述信息

EventMessage(EpisodeGroupCallback)

参数 类型 是否必选 描述
ProgramId String 轮播单ID
EpisodeId String 节目ID
Code String 状态码
Message String 描述信息

状态码说明

状态码 文字说明
Success 成功
StreamInterrupt 实时流或文件被异常终止
CanvasStreamInterrupt canvas流异常终止
AudioResampleFailed 音频重采样失败
AudioAddFailed 音频源添加失败
AudioDelFailed 音频源删除失败
AudioStreamTypeInvalid 音频流类型解析错误
VideoTypeInvalid 图层类型解析错误
VideoVisibleInvalid 图层元素是否可见解析错误
VideoTransparencyInvalid 图层元素透明度值解析错误
VideoEffectInvalid 图层元素特效值解析错误
VideoWidthInvalid 图层元素宽度归一化比例解析错误
VideoPositionReferInvalid 图层元素参考坐标轴解析错误
VideoStreamTypeInvalid 媒体类型(实时流/文件)解析错误
VideoRepeatNumInvalid 点播文件重复次数解析错误
VideoStreamAddFailed 添加实时流失败
ImageOpenFailed 图片打开失败
ImageGetDecodeInfoFailed 图片获取解码信息失败
ImageDecodeFailed 图片解码失败
TextInvalid 文字解析失败
TextFontInvalid 文字字体名解析错误
TextSizeInvalid 文字大小归一化值解析错误
TextBorderWidthInvalid 文字边框宽度归一化值解析错误
CanvasLoadFailed canvas 流加载失败
SideOutputUrlInvalid 旁路输出打开失败

示例

请求示例

操作回调

  1. {
  2. "CasterId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  3. "EventType": "OperateCallback",
  4. "EventMessage": {
  5. "RequestId": "26A96B9A-A201-4EC3-8E43-CB92E68FA132",
  6. "SceneId": "35716B9A-A201-4EC3-8E43-CB92E68F1635",
  7. "ComponentId": "06196B9A-A201-4EC3-8E43-CB92E68F1634",
  8. "Code": "ImageOpenFailed",
  9. "Message": "Fail to open image: http://XXXX/XXXX.jpg"
  10. }
  11. }

运行时异常回调

  1. {
  2. "CasterId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  3. "EventType": "RuntimeErrorCallback",
  4. "EventMessage": {
  5. "Code": "StreamInterrupt",
  6. "Message": "Failed to open stream: rtmp://DOMAIN/APP/STREAM"
  7. }
  8. }