InitialUploadRequest (JSON)
The body of a POST GameClip upload request.
InitialUploadRequest
The InitialUploadRequest object has the following specification.
| Member | Type | Description |
|---|---|---|
| greatestMomentId | string | The string ID for the text to use as the name for the clip. This is managed and localized in the config file for the title by the developer of the title. |
| userCaption | string | Optional. Alternate user-entered name for game clip up to a maximum length of 250 characters. |
| sessionRef | string | Optional. Game session reference during which the recording was done. |
| dateRecorded | DateTime | The time the recording was started, in UTC. Marshalled as a string in ISO 8601 format (see Date and Time Formats for more information). |
| durationInSeconds | 32-bit unsigned integer | The length of the clip in seconds. |
| expectedBlocks | 32-bit unsigned integer | Optional. Number of blocks into which file will be divided. Omit if file will be transmitted in a single request. |
| fileSize | 32-bit unsigned integer | File size in bytes of the video that will be uploaded. |
| type | GameClipType Enumeration | The type of clip, marshaled as a string value of the enumeration that is comma-delimited. |
| source | GameClipSource Enumeration | Specifies how the clip was sourced, marshaled as a string value of the enumeration. |
| visibility | GameClipVisibility Enumeration | Specifies the visibility of the game clip once it is published in the system. |
| titleData | string | Optional. Property bag for title-specific properties associated with this clip. Stored and returned as-is. Title developers can use this field to persist their own metadata about a clip. |
| titleData | string | Optional. Property bag for console-specific properties associated with this clip. Stored and returned as-is. Console Platform can use this field to persist their own metadata about a clip. |
| systemProperties | string | Optional. Property bag for console-specific properties associated with this clip. Stored and returned as is. Console Platform can use this field to persist their own metadata about a clip. |
| usersInSession | array of string | Optional. A list of the users in the current session. |
| thumbnailSource | ThumbnailSource Enumeration | Optional. The source of the thumbnail. |
| thumbnailOffsetMillseconds | 32-bit signed integer | Specifies the offset (in milliseconds) for offset generated thumbnails. Only specified when thumbnailSource is set to Offset. |
| savedByUser | Boolean value | Optional. Sets the clip to be saved to the user's quota instead of FIFO storage. Defaults to false. |
Sample JSON syntax
{
"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
}