Sign in
Option > Record > Instant

Start a record

Try to instantly start a recording of the first stream meant to be recorded, on the first given storage machine.

NOTE: this process is oversimplified. It assumes that only the best quality stream is meant to be recorded and that it will be sent to the first given storage machine only.

post/1/videos/{channel}/options/recording/instant

Path parameters

channelinteger required

The unique identifier (ID) of the channel to request.

Query parameters

account_idinteger required

Account identifier

The account identifier

Request body

auto_stopboolean required

The auto_stop field is required

diffusion_atinteger nullable

The diffusion at time start

diffusion_ends_atinteger nullable

The diffusion end time is required when auto_stop is enabled

file_pathstring nullable

a strict string (no HTML/PHP tags or HTML entities allowed)

fragment_durationinteger required

The fragment duration is required and must be at least 1 second.

fragment_numberinteger nullable
namestring required

The record name is required

selected_storage_idinteger required

The storage machine id is required.

Example request

{
  "file_path": "\"Hello world ! 😊\"",
  "name": "\"Hello world ! 😊\""
}

Response

Created

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

Example response

{
  "result": "success"
}

Changes

No recorded changes to this endpoint across all 3 revisions of this API.