PUT
/
streaming
/
streams
/
{stream_id}
/
clip_recording
Create clip
curl --request PUT \
  --url https://api.gcore.com/streaming/streams/{stream_id}/clip_recording \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "start": 1716559200,
  "duration": 60,
  "expiration": 1716562860
}'
{
  "id": "d7bsli54p8n4",
  "created_at": "2024-01-05T20:15:00.000Z",
  "vod_required": true,
  "video_id": 459857,
  "renditions": [
    "media_1_360",
    "media_2_468",
    "media_3_720",
    "media_4_1080"
  ],
  "hls_master": "https://CID.domain.com/rec/12345_330031/rec_d7bsli54p8n4_qsid42_master.m3u8",
  "mp4_master": "https://CID.domain.com/rec/12345_330031/rec_d7bsli54p8n4_qsid42_master.mp4",
  "start": 1716559200,
  "duration": 60,
  "expiration": 1716562860
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

​
stream_id
integer
required

Stream ID

Body

application/json
​
duration
integer
required

Requested segment duration in seconds to be cut. Please, note that cutting is based on the idea of instantly creating a clip, instead of precise timing. So final segment may be:

  • Less than the specified value if there is less data in the DVR than the requested segment.
  • Greater than the specified value, because segment is aligned to the first and last key frames of already stored fragment in DVR, this way -1 and +1 chunks can be added to left and right. Duration of cutted segment cannot be greater than DVR duration for this stream. Therefore, to change the maximum, use "dvr_duration" parameter of this stream.
​
start
integer

Starting point of the segment to cut. Unix timestamp in seconds, absolute value. Example: 24.05.2024 14:00:00 (GMT) is Unix timestamp = 1716559200 If a value from the past is specified, it is used as the starting point for the segment to cut. If the value is omitted, then clip will start from now.

​
expiration
integer

Expire time of the clip via a public link. Unix timestamp in seconds, absolute value. This is the time how long the instant clip will be stored in the server memory and can be accessed via public HLS/MP4 links. Download and/or use the instant clip before this time expires. After the time has expired, the clip is deleted from memory and is no longer available via the link. You need to create a new segment, or use vod_required: true attribute. If value is omitted, then expiration is counted as +3600 seconds (1 hour) to the end of the clip (i.e. unix timestamp = + + 3600). Allowed range: 1m <= expiration <= 4h. Example: 24.05.2024 14:00:00 (GMT) + 60 seconds of duration + 3600 seconds of expiration = 24.05.2024 15:01:00 (GMT) is Unix timestamp = 1716562860

​
vod_required
boolean
default:true

Indicates if video needs to be stored also as permanent VOD

Response

Successful

​
duration
integer
required

Requested segment duration in seconds to be cut. Please, note that cutting is based on the idea of instantly creating a clip, instead of precise timing. So final segment may be:

  • Less than the specified value if there is less data in the DVR than the requested segment.
  • Greater than the specified value, because segment is aligned to the first and last key frames of already stored fragment in DVR, this way -1 and +1 chunks can be added to left and right. Duration of cutted segment cannot be greater than DVR duration for this stream. Therefore, to change the maximum, use "dvr_duration" parameter of this stream.
​
id
string
required

ID of the clip

​
start
integer

Starting point of the segment to cut. Unix timestamp in seconds, absolute value. Example: 24.05.2024 14:00:00 (GMT) is Unix timestamp = 1716559200 If a value from the past is specified, it is used as the starting point for the segment to cut. If the value is omitted, then clip will start from now.

​
expiration
integer

Expire time of the clip via a public link. Unix timestamp in seconds, absolute value. This is the time how long the instant clip will be stored in the server memory and can be accessed via public HLS/MP4 links. Download and/or use the instant clip before this time expires. After the time has expired, the clip is deleted from memory and is no longer available via the link. You need to create a new segment, or use vod_required: true attribute. If value is omitted, then expiration is counted as +3600 seconds (1 hour) to the end of the clip (i.e. unix timestamp = + + 3600). Allowed range: 1m <= expiration <= 4h. Example: 24.05.2024 14:00:00 (GMT) + 60 seconds of duration + 3600 seconds of expiration = 24.05.2024 15:01:00 (GMT) is Unix timestamp = 1716562860

​
created_at
string

Creation date and time. Format is date time in ISO 8601

​
vod_required
boolean
default:true

Indicates if video needs to be stored as VOD

​
video_id
integer

ID of the created video if vod_required=true

​
renditions
string[]

List of available rendition heights

​
hls_master
string

Link to HLS .m3u8 with immediate clip. The link retains same adaptive bitrate as in the stream for end viewers. For additional restrictions, see the description of parameter "mp4_master".

​
mp4_master
string

Link to MP4 with immediate clip. The link points to max rendition quality. Request of the URL can return:

  • 200 OK – if the clip exists.
  • 404 Not found – if the clip did not exist or has already ceased to exist.
  • 425 Too early – if recording is on-going now. The file is incomplete and will be accessible after start+duration time will come.