InitialUploadRequest (JSON)
POST GameClip 上傳要求的本文。InitialUploadRequest
InitialUploadRequest 物件具有下列規格。| 成員 | 類型 | 描述 |
|---|---|---|
| greatestMomentId | string | 要作為短片名稱之文字的字串識別碼。此項目由遊戲開發人員在遊戲的設定檔中管理及當地語系化。 |
| userCaption | string | 選擇性。使用者為遊戲短片輸入的替代名稱，長度上限為 250 個字元。 |
| sessionRef | string | 選擇性。錄製期間的遊戲工作階段參考。 |
| dateRecorded | DateTime | 開始錄製的時間，以 UTC 表示。以 ISO 8601 格式的字串進行封送處理 (如需詳細資訊，請參閱日期和時間格式)。 |
| durationInSeconds | 32 位元不帶正負號的整數 | 短片的長度 (以秒為單位)。 |
| expectedBlocks | 32 位元不帶正負號的整數 | 選擇性。檔案將分割成的區塊數目。如果檔案將以單一要求傳輸，請省略此項目。 |
| fileSize | 32 位元不帶正負號的整數 | 將上傳之影片的檔案大小 (以位元組為單位)。 |
| type | GameClipType 列舉 | 短片的類型，以逗號分隔的列舉字串值進行封送處理。 |
| source | GameClipSource 列舉 | 指定短片的來源方式，以列舉的字串值進行封送處理。 |
| visibility | GameClipVisibility 列舉 | 指定遊戲短片在系統中發佈後的可見度。 |
| titleData | string | 選擇性。與此短片相關聯之遊戲特定屬性的屬性包。依原樣儲存及傳回。遊戲開發人員可以使用此欄位保存他們自己關於短片的中繼資料。 |
| titleData | string | 選擇性。與此短片相關聯之主機特定屬性的屬性包。依原樣儲存及傳回。主機平台可以使用此欄位保存他們自己關於短片的中繼資料。 |
| systemProperties | string | 選擇性。與此短片相關聯之主機特定屬性的屬性包。依原樣儲存及傳回。主機平台可以使用此欄位保存他們自己關於短片的中繼資料。 |
| usersInSession | string 陣列 | 選擇性。目前工作階段中的使用者清單。 |
| thumbnailSource | ThumbnailSource 列舉 | 選擇性。縮圖的來源。 |
| thumbnailOffsetMillseconds | 32 位元帶正負號的整數 | 指定以位移產生之縮圖的位移 (以毫秒為單位)。只有在 thumbnailSource 設定為 Offset 時才指定。 |
| savedByUser | 布林值 | 選擇性。將短片設定為儲存至使用者的配額，而非 FIFO 儲存體。預設值為 false。 |
範例 JSON 語法
{
"greatestMomentId": "123abc",
"userCaption": "OMG Look at this!",
"sessionRef": "4587552a-a5ad-4c4c-a787-5bc5af70e4c9",
"dateRecorded": "2012-12-23T11:08:08Z",
"durationInSeconds": 27,
"expectedBlocks": 7,
"fileSize": 1234567,
"type": "MagicMoment, Achievement",
"source": "Console",
"visibility": "Default",
"titleData": "{ 'Boss': 'The Invincible' }",
"systemProperties": "{ 'Id': '123456', 'Location': 'C:\\videos\\123456.mp4' }",
"thumbnailSource": "Offset",
"thumbnailOffsetMillseconds": 20000,
"savedByUser": false
}