使用者處理回調的請求參數及相關樣本 - ApsaraVideo Live

本文介紹使用者處理回調的請求參數及相關樣本。

請求參數

參數	類型	是否必選	描述
CasterId	String	否	導播間ID。若類型為OperateCallback、RuntimeErrorCallback時，必須輸入該參數。若類型為EpisodeGroupCallback時，可選擇性輸入改參數。
EventType	String	是	事件類型。 OperateCallback：操作回調。 RuntimeErrorCallback：執行階段錯誤回調。 EpisodeGroupCallback：輪播台回調。 ShowListDTSCallback : 播單類型，當前節目播放時間進度回調。
EventMessage	EventMessage	是	事件資訊。具體欄位請參見EventMessage。

EventMessage

EventType為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	否	描述資訊。

EventType為EpisodeGroupCallback時。
參數
類型
是否必選
描述
ProgramId
String
是
輪播單ID。
EpisodeId
String
是
節目ID。
Code
String
否
狀態代碼。
Message
String
否
描述資訊。

EventType為ShowListDTSCallback時。

參數	類型	是否必選	描述
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"
}