Create

Create a new recording task.

This action requires a request with an active account.

Tokens

This action requires the following tokens:

  • recordtask-create

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
source URL   Source live stream URL for this recording schedule. Either this or livestream should be set
sourceproxy URL   Source proxy for this recording schedule; used when connecting to source
livestream Hash   If given, hash of the livestream to record
start DateTime   If given, the task will not start until this date/time, otherwise it will start as soon as possible
end DateTime   If given, the task will automatically stop recording at this time. If not given, the recording will continue until one stops it by hand
title String  

Title used for the items that are created after each recording. Can use the following characters which will automatically be replaced:

  • %a: abbreviated textual representation of the day (e.g. Mon, Tue, etc.)
  • %A: full textual representation of the day (e.g. Monday, Tuesday, etc.)
  • %d, %e: day of the month with (%d) and without (%e) leading zero.
  • %b: abbreviated textual representation of the month (e.g. Jan, Feb, etc.)
  • %B: full textual representation of the month (e.g. January, February, etc.)
  • %m: month as integer, with leading zero
  • %y, %Y: year with two (%y) or four (%Y) digits
  • %H, %k: hour with (%H) or without (%k) leading zero in numeric format; 24-hour
  • %I, %l: hour with (%I) or without (%l) leading zero in numeric format; 12-hour
  • %M: minutes as integer, with leading zero
  • %p, %P: upper- (%p) or lower- (%P) -case AM / PM
  • %S: seconds as integer, with leading zero
  • %%: a literal %

If no title is given, the following will be taken, in order, if available:

  • livestream-name (%d-%m-%Y %H:%M:%S)
  • livestream-hash (%d-%m-%Y %H:%M:%S)
  • Live recording (%d-%m-%Y %H:%M:%S)

(note the last option has the hard-coded text ‘Live recording’)

If a live recording is interrupted while recording, every item except for the first one will have ‘ (#)’ behind its title, where # is the index of the recording, starting with 2.

description String   Description for the item that is created after recording
protected Boolean   Whether items created with this task will be protected. If not set will default to the value of the livestream or false if no livestream provided
author String   Author for the item that is created after recording
copyright String   Copyright for the item that is created after recording
keywords String   Keywords for the item that is created after recording; separate by a comma
categories String   Categories for the item that is created after recording; hashes separated by a comma

Output

This action produces the following output on success:

An object containing the following fields:

Name Type Description
id Hash ID of this record task
source String The source of this record task
sourceproxy String The proxy for the source
livestream

The live stream of this record task

The value of this field is an object containing the following fields:

Name Type Description
id Hash Livestream ID
title String Title of the live stream
description String Description of the live stream
type Label The type of this livestream; for available livestream types, refer to the documentation of the Livestream command
title String Title for created items
description String Description for created items
author String Author for created items
copyright String Copyright for created items
keywords

Keywords for created items

The value of this field is an array containing zero or more elements, each one being one String: One keyword

categories

Categories for created items

The value of this field is an array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
id Hash Category ID
name String The name of this category
protected Boolean Whether items created with this schedule will be protected
start DateTime Date and time this task will start
end DateTime Date and time this task will end
status String Status of this record task; one of queued, running, pauserequested, paused, resumerequested, completed, stoprequested, canceled, cancelrequested, failed
statusreason String If the task failed, a reason why it failed
datecreated DateTime When this record task has been created
datestarted DateTime If known, when this record task has been started; is always set if the current status is not queued
datestopped DateTime If known, when this record task has stopped; is always set if the current status is completed, canceled or failed

Errors

This action will always return one of the default status codes.