云导播回调信息说明

本文介绍用户处理回调的请求参数及相关示例。

请求参数

参数

类型

是否必选

描述

CasterId

String

导播间ID。

  • 若类型为OperateCallback、RuntimeErrorCallback时,必须输入该参数。

  • 若类型为EpisodeGroupCallback时,可选择性输入改参数。

EventType

String

事件类型。

  • OperateCallback:操作回调。

  • RuntimeErrorCallback:运行时错误回调。

  • EpisodeGroupCallback:轮播台回调。

  • ShowListDTSCallback : 播单类型,当前节目播放时间进度回调。

EventMessage

EventMessage

事件信息。具体字段请参见EventMessage

EventMessage

  • EventTypeOperateCallback、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

    描述信息。

  • EventTypeEpisodeGroupCallback时。

    参数

    类型

    是否必选

    描述

    ProgramId

    String

    轮播单ID。

    EpisodeId

    String

    节目ID。

    Code

    String

    状态码。

    Message

    String

    描述信息。

  • EventTypeShowListDTSCallback时。

    参数

    类型

    是否必选

    描述

    ProgressTime

    String

    当前播放节目的进度时间,单位:ms。

    ShowId

    String

    当前节目的Showid。

    Duration

    String

    当前节目的总时长。

    ShowName

    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

旁路输出打开失败。

示例

操作回调

 {
    "CasterId": "16A96B9A-F203-4EC5-8E43-CB92E68F****",
    "EventType": "OperateCallback",
    "EventMessage": {
        "RequestId": "26A96B9A-A201-4EC3-8E43-CB92E68FA132",
        "SceneId": "35716B9A-A201-4EC3-8E43-CB92E68F****",
        "ComponentId": "06196B9A-A201-4EC3-8E43-CB92E68F****",
        "Code": "ImageOpenFailed",
        "Message": "Fail to open image: http://XXXX/XXXX.jpg"
    }
}

运行时异常回调

{
    "CasterId": "16A96B9A-F203-4EC5-8E43-CB92E68F****",
    "EventType": "RuntimeErrorCallback",
    "EventMessage": {
      "Code": "StreamInterrupt",
      "Message": "Failed to open stream: rtmp://DOMAIN/APP/STREAM"
    }
}

播放时间进度回调

{
  "EventMessage": {
    "ProgressTime": "116796",
    "ShowId": "9ef1db9d-5e24-4e5f-b161-8a2429d9b882",
    "Duration": "396847",
    "ShowName": "test.mp4"
  },
  "EventType": "ShowListDTSCallback",
  "ResponseTime": 1663731128684,
  "CasterId": "3761c920-dfa6-40c7-a79c-2886b1493996"
}