> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# InitialUploadRequest (JSON)

> InitialUploadRequest (JSON)

# InitialUploadRequest (JSON)

POST GameClip 上传请求的正文。

## InitialUploadRequest

InitialUploadRequest 对象具有以下规范。

| 成员 | 类型 | 说明 |
| - | - | - |
| **greatestMomentId** | string | 用作剪辑名称的文本的字符串 ID。由游戏开发者在游戏的配置文件中管理和本地化。 |
| **userCaption** | string | 可选。用户输入的游戏剪辑备用名称,最大长度为 250 个字符。 |
| **sessionRef** | string | 可选。录制期间所在的游戏会话引用。 |
| **dateRecorded** | DateTime | 开始录制的时间,采用 UTC。以 ISO 8601 格式的字符串编排(有关详细信息,请参阅 [Date and Time Formats](https://www.w3.org/TR/NOTE-datetime))。 |
| **durationInSeconds** | 32 位无符号整数 | 剪辑的时长(以秒为单位)。 |
| **expectedBlocks** | 32 位无符号整数 | 可选。文件将被划分成的块数。如果文件将在单个请求中传输,则省略。 |
| **fileSize** | 32 位无符号整数 | 将要上传的视频的文件大小(以字节为单位)。 |
| **type** | [GameClipType 枚举](https://devdocs.xbox.com/zh-CN/reference/live/rest/enums/gvr-enum-gamecliptypes.md) | 剪辑类型,以逗号分隔的枚举字符串值形式编排。 |
| **source** | [GameClipSource 枚举](https://devdocs.xbox.com/zh-CN/reference/live/rest/enums/gvr-enum-gameclipsource.md) | 指定剪辑的来源方式,以枚举的字符串值形式编排。 |
| **visibility** | [GameClipVisibility 枚举](https://devdocs.xbox.com/zh-CN/reference/live/rest/enums/gvr-enum-gameclipvisibility.md) | 指定游戏剪辑在系统中发布后的可见性。 |
| **titleData** | string | 可选。与此剪辑关联的特定于游戏属性的属性包。按原样存储并返回。游戏开发者可以使用此字段来持久化他们自己关于剪辑的元数据。 |
| **titleData** | string | 可选。与此剪辑关联的特定于主机属性的属性包。按原样存储并返回。主机平台可以使用此字段来持久化他们自己关于剪辑的元数据。 |
| **systemProperties** | string | 可选。与此剪辑关联的特定于主机属性的属性包。按原样存储并返回。主机平台可以使用此字段来持久化他们自己关于剪辑的元数据。 |
| **usersInSession** | string 数组 | 可选。当前会话中的用户列表。 |
| **thumbnailSource** | [ThumbnailSource 枚举](https://devdocs.xbox.com/zh-CN/reference/live/rest/enums/gvr-enum-thumbnailsource.md) | 可选。缩略图的来源。 |
| **thumbnailOffsetMillseconds** | 32 位有符号整数 | 指定偏移生成的缩略图的偏移量(以毫秒为单位)。仅当 **thumbnailSource** 设置为 Offset 时指定。 |
| **savedByUser** | 布尔值 | 可选。设置剪辑保存到用户的配额中而不是 FIFO 存储中。默认为 false。 |

## JSON 语法示例

```json theme={null}
{
   "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
 }
    
```

## 另请参阅

##### 父主题

[JavaScript 对象表示法 (JSON) 对象参考](https://devdocs.xbox.com/zh-CN/reference/live/rest/json/atoc-xboxlivews-reference-json)


## Related topics

- [ThumbnailSource Enumeration](https://devdocs.xbox.com/reference/live/rest/enums/gvr-enum-thumbnailsource.md)
- [Enumeração ThumbnailSource](https://devdocs.xbox.com/pt-BR/reference/live/rest/enums/gvr-enum-thumbnailsource.md)
- [ThumbnailSource 列舉](https://devdocs.xbox.com/zh-TW/reference/live/rest/enums/gvr-enum-thumbnailsource.md)
- [Enumeración ThumbnailSource](https://devdocs.xbox.com/es/reference/live/rest/enums/gvr-enum-thumbnailsource.md)
- [ThumbnailSource 枚举](https://devdocs.xbox.com/zh-CN/reference/live/rest/enums/gvr-enum-thumbnailsource.md)