Application

Get a full state of the application

GET http://recording_server:9000/api/app/state

Returns you a full state of Direct Take in JSON format.

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully returned

{
  "Sources": [],
  "Destinations": [],
  "Channels": [],
  "EncodingPresets": [ ]
}

Get available Conversion Settings values

GET http://recording_server:9000/api/app/conversion-lists

Returns lists of available values for all the conversion settings

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully returned

[
  "VideoFormats",
  [
    "Original",
    "PAL",
    "NTSC",
    "HD720",
    "FullHD",
    "UHD"
  ],
  "FrameRates",
  [
    "Original",
    "23.98",
    "24",
    "25",
    "29.97",
    "30",
    "50",
    "59.94",
    "60"
  ],
  "Interlaces",
  [
    "Default",
    "Field1First",
    "Field2First",
    "Progressive",
    "Inverse",
    "OneField",
    "DeinterlaceF1",
    "DeinterlaceF2"
  ],
  "AudioSampleRates",
  [
    "Original",
    "48000",
    "44100"
  ],
  "AudioChannels",
  [
    "Original",
    "1",
    "2",
    "4",
    "8",
    "16"
  ],
  "AudioBits",
  [
    "Original",
    "16",
    "32"
  ]
]

Set the Conversion Settings

PUT http://recording_server:9000/api/app/conversion-config

Headers

Name	Type	Description
Authorization	string	API Token

Request Body

Name	Type	Description
AudioBit	string	Sets the bit depth of the audio
AudioChannel	string	Sets the number of audio channels
AudioSampleRate	string	Sets the audio sample rate
Interlace	string	Sets the interlacing type
FrameRate	string	Sets the frame rate
VideoFormat	string	Sets the video format
IsEnabled	boolean	Sets if the conversion is enabled

200 Successfully set

Get the Conversion Settings

GET http://recording_server:9000/api/app/conversion-config

Returns a conversion setting parameters currently in use

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully returned

{
  "IsEnabled": true,
  "VideoFormat": "FullHD",
  "FrameRate": "30",
  "Interlace": "Progressive",
  "AudioSampleRate": "Original",
  "AudioChannel": "Original",
  "AudioBit": "Original"
}

Get the Preferences

GET http://recording_server:9000/api/app/settings

Returns you the Preferences settings in JSON format

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully returned

{
  "LogFolder": "D:\\Direct Take",
  "PreviewRefresh": 0,
  "LoadLastSession": true,
  "PreviewStretch": false,
  "AlwaysShowStatistics": true,
  "AlwaysShowAudioMeters": true,
  "StartAtStartup": false,
  "IsNotificationAdmin": false,
  "OpenAsync": false
}

Update the Preferences

PUT http://recording_server:9000/api/app/settings

Sets one or several parameters in Preferences

Headers

Name	Type	Description
Authorization	string	API Token

Request Body

Name	Type	Description
OpenAsync	boolean	Check if input network streams are valid
StartAtStartup	boolean	Start Direct Take at the PC startup
AlwaysShowAudioMeters	boolean	Shows audio meters always
AlwaysShowStatistics	boolean	Shows recording statistics always
PreviewStretch	boolean	Sets preview to stretch to fill the preview control
LoadLastSession	boolean	Indicates whether the app loads the last session at startup
PreviewRefresh	integer	A refresh rate of a preview
LogFolder	string	Path to a folder to keep the logs

200 Successfully returned

Start a New Project

PUT http://recording_server:9000/api/app/new

Resets the current session of Direct Take

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully reset

Save a Project

PUT http://recording_server:9000/api/app/save

Saves the current project to a DTProj file

Headers

Name	Type	Description
Authorization	string	API Token

Request Body

Name	Type	Description
Path	string	path to a target file

200 Successfully saved

Load a Project

PUT http://recording_server:9000/api/app/load

Loads a project from a DTProj file

Headers

Name	Type	Description
Authorization	string	API Token

Request Body

Name	Type	Description
Path	string	path to a target file

200 Successfully loaded

Get current resources

GET http://recording_server:9000/api/app/resources

Returns the actual state of CPU, RAM, and disks

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully returned

[
  "CurrentCPU",
  3.671431541442871,
  "TotalCPU",
  2.904,
  "CurrentRAM",
  11.581671218387783,
  "TotalRAM",
  15.865303039550781,
  "DiskInfo",
  [
    {
      "Key": "C:",
      "Value": "69.38%"
    },
    {
      "Key": "D:",
      "Value": "91.10%"
    }
  ]
]

Get information about the synchronous recording

GET http://recording_server:9000/api/app/sync

Returns the state of the synchronous recording

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully returned

{
  "IsSyncRecording": true,
  "IsSyncRecordingPause": false
}

Get information about scheduling

GET http://recording_server:9000/api/app/schedule

Returns recording schedule parameters

Headers

Name	Type	Description
Authorization	string	API Token

200 Successfully returned

{
  "IsEnabled": true,
  "StartTime": "12:00:00",
  "StopTime": "14:00:00",
  "ScheduleType": "All channels"
}

Set scheduling parameters

PUT http://recording_server:9000/api/app/schedule

Specifies recording schedule. If both start and stop times are null, disables the scheduling

Headers

Name	Type	Description
Authorization	string	API Token

Request Body

Name	Type	Description
IsEnabled	boolean	Indicates whether the scheduling is turned on
StartTime	string	Time to start the recording in hh:mm format
StopTime	string	Time to stop the recording in hh:mm format
ScheduleType	string	Sets the mode of schedule: If "All channels" then the schedule is implemented for all the channels; If "In-sync only" then the schedule is implemented only for the synchronous recording.

200 Successfully set

Get a message state

GET http://recording_server:9000/api/app/dialog

When Direct Take requires user confirmation, it shows a dialog message. This method returns you a state of the message.

Headers

Name	Type	Description
Authorization	string	API Token

200

{
  "IsDialog": true, // if 'true' then there is a message presented. 'false' means no message available.
  "DialogContent": "message content",
  "Buttons": "Yes_No" // "Yes_No" means there are 2 actions available ("OK", and "Cancel"), otherwise it is only "OK"
}

Take an action for the message

PUT http://recording_server:9000/api/app/dialog/{action}

If a message is shown, you should take an action to continue the normal work of Direct Take. This method takes the action.

Query Parameters

Name	Type	Description
{action}	String	Use "ok" to confirm the action or continue, otherwise, use "cancel"

Headers

Name	Type	Description
Authorization	string	API Token

200 Success