Data Model #

unfinishedUploadData #

Object

未上傳完成的檔案資訊

範例 #

const data = {
  uploadId: 'Lky4bevAmKbt05jpgWWnhtilF.zrMAp',
  filename: 'demo.mp4',
  targetUid: 'news-1',
  objectKey: 'static-vod/2023-02/18/928cce48-b5e9-c4a50f695566.mp4',
  type: 'video/mp4',
  size: 20929597,
  prettySize: '20.9 MB',
  progress: 33.3,
  uploaded: 4, 
  total: 12,
  createdAt: '2023-02-18 23:10:01',
}

屬性 #

• uploadId: String, S3 upload id, 主要為Web component內部使用
• objectKey: String, S3上傳的位置
• targetUid: String, 同prepareUpload method的targetUid設定, 若init時未設定將會為default字串
• filename: String, 原始檔案名稱
• type: String, 檔案類型
• size: Number, 檔案大小(bytes)
• prettySize: String, 易讀的檔案大小, 單位將自行變動, 例如: 395KB, 10.3MB, 1.5GB
• progress: Number, 上傳進度百分比
• uploaded: Number, 已經上傳的檔案片段數
• total: Number, 總計的上傳檔案片段數(每個片段為5MB)
• createdAt: String, 發起上傳的時間, 格式為YYYY-MM-DD HH:mm:ss

uploadStatus #

Object

S3大檔分段上傳的進度資訊物件

範例 #

const data = {
  stage: 'uploadChunks',
  uploaded: 4,
  total: 12,
  progress: 33.3
}

屬性 #

• stage: String/null, 上傳階段, 以下為各種階段的值
  • init: 初始化
  • setupMultiPartUploadId: 設定Multipart UploadId
  • checkUploadedChunks: 確認已上傳片段
  • uploadChunks: 開始上傳切片
  • completed: 合併檔案切片, 上傳完成
  • cleanup: 清除client端暫存的檔案資訊
• uploaded: Number, 已上傳的片段數量
• total: Number, 檔案總片段數量
• progress: Number, 上傳進度百分比

mediaConvertJob #

Object

串流影片轉檔任務資訊物件

範例 #

const data = {
  id: 'string',
  errorCode: null,
  errorMessage: null,
  status: 'COMPLETE',
  createdAt: '2023-01-05 21:30:00',
  finishAt: '2023-01-05 21:33:00',
  startAt: '2023-01-05 21:30:02',
  submitAt: '2023-01-05 21:30:02',
  jobPercentComplete: 30,
  outputQuality: [
    {durationInMs: 125, heightInPx: 1280, widthInPx: 720},
    {durationInMs: 125, heightInPx: 854, widthInPx: 480},
  ],
  indexM3u8Path: 'streaming-vod/2023-01/05/foobar.m3u8',
  captureImagePath: 'streaming-vod/output/demo_20230217_000344/capture.0000000.jpg',
  outputFolderPath: 'treaming-vod/2023-01/05/',
  indexM3u8Url: 'https://foobar.cloudfront.net/streaming-vod/2023-01/05/foobar.m3u8',
  captureImageUrl: 'https://foobar.cloudfront.net/streaming-vod/output/demo_20230217_000344/capture.0000000.jpg',
}

屬性 #

• id: String, Media Convert Job Id
• errorCode: String/undefined, Media Convert Job錯誤代碼, 有錯誤時才會有此屬性
• errorMessage: String/undefined, Media Convert Job錯誤訊息, 有錯誤時才會有此屬性
• status: String, Media Convert Job狀態, 以下為所有的狀態值
  • SUBMITTED: 已提交轉檔
  • PROGRESSING: 轉檔中
  • COMPLETE: 轉檔完成(成功)
  • CANCELED: 轉檔已被取消
  • ERROR: 轉檔失敗
• createdAt: String/null, Job建立時間(格式為: YYYY-MM-DD HH:mm:ss)
• startAt: String/null, 開始轉檔時間(格式為: YYYY-MM-DD HH:mm:ss)s)
• submitAt: String/null, 提交轉檔時間(格式為: YYYY-MM-DD HH:mm:ss)
• finishAt: String/null, 轉檔結束時間(格式為: YYYY-MM-DD HH:mm:ss)
• jobPercentComplete: Number/null, 進度百分比(只有轉檔中才有進度, 非轉檔中此值為null)
• outputQuality: 輸出品質物件陣列, 輸出品質物件屬性如下
  • durationInMs: Number, 影片時間長度
  • heightInPx: Number, 影片高(pixel)
  • widthInPx: Number, 影片寬(pixel)
• indexM3u8Path: String, 主要m3u8檔案s3路徑
• captureImagePath: String, 影片截圖圖片s3路徑
• indexM3u8Url: String, 主要m3u8 Cloudfront網址
• captureImageUrl: String, 影片截圖圖片Cloudfront網址