Recording API

From DocuWiki
Revision as of 15:40, 25 February 2014 by 0oqb9d (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The 247 Platform allows you to record live content while streaming it, ensuring a fast turnover of content from Live to On Demand.


setRecordingType

Sets the recording type used, if ether recording the highest quality video or record all the published streams.

Request URL

http://console.247platform.com/api/recording/setrecordingtype/[video id]?recordingType=[Recording Type String]&sessionId=[Session ID]&userId=[Client Id] 

Params

  • 'recordingType', (required), Ether 'highest' or 'all'.

Response

{
  "response":{
     "message":"recording method changed to highest",
     "code":"200",
     "isOk":true
  },
  "code":"200"
}

Errors

  • InvalidSelection (code 400), The recordingType provided is not as required.
  • AuthenticationRequired (code 400), Authentication is required but not provided.
  • ResourceNotFound (code 404), One or more of the required params where not passed.


Status

Returns the list of recordings for a given video.

Request URL

http://console.247platform.com/api/recording/status/[video id]?sessionId=[Session ID]&userId=[Client Id] 

Response

{
  "response":{
     "recordings":{
        "17":{
           "id":"17",
           "created":"2013-07-08 12:52:31",
           "started":"2013-07-08 12:52:31",
           "finished":"2013-07-08 14:41:58",
           "serverId":"4",
           "applicationName":"origin",
           "videoId":"2661",
           "videoFormatId":"1",
           "clientId":"42",
           "recordingStatusId":"4",
           "recordingStreamName":"2c-bc6-live-7",
           "smilId":"7",
           "recordingStatusTitle":"Complete",
           "isError":"0",
           "isComplete":"1"
        },
        "16":{
           "id":"16",
           "created":"2013-07-08 12:52:30",
           "started":"2013-07-08 12:52:30",
           "finished":"2013-07-08 14:41:52",
           "serverId":"4",
           "applicationName":"origin",
           "videoId":"2661",
           "videoFormatId":"1",
           "clientId":"42",
           "recordingStatusId":"4",
           "recordingStreamName":"2c-bc6-live-1",
           "smilId":"1",
           "recordingStatusTitle":"Complete",
           "isError":"0",
           "isComplete":"1"
        },
        "15":{
           "id":"15",
           "created":"2013-07-08 12:51:17",
           "started":"2013-07-08 12:51:18",
           "finished":"0000-00-00 00:00:00",
           "serverId":"4",
           "applicationName":"origin",
           "videoId":"2661",
           "videoFormatId":"1",
           "clientId":"42",
           "recordingStatusId":"10",
           "recordingStreamName":"2c-bc6-live-7",
           "smilId":"7",
           "recordingStatusTitle":"Preparing to process Recording",
           "isError":"0",
           "isComplete":"0"
        }
     },
     "code":"200",
     "isOk":true
  },
  "code":"200"
}

Errors

  • AuthenticationRequired (code 400), Authentication is required but not provided.
  • ResourceNotFound (code 404), One or more of the required params where not passed.


Start

Request URL

http://console.247platform.com/api/recording/start/[video id]?sessionId=[Session ID]&userId=[Client Id] 

Response

{
  "response":{
     "message":"Attempted to start recording",
     "recordObject":[
        {
           "videoId":"2663",
           "videoFormatId":"1",
           "clientId":42,
           "recordingStatusId":3,
           "created":"2013-07-08 17:19:00",
           "serverId":"4",
           "applicationName":"origin",
           "smilId":"3",
           "recordingStreamName":"2c-bc8-live-3",
           "started":"2013-07-08 17:19:01",
           "id":28,
           "status":{
              "id":"3",
              "title":"Recording",
              "isError":"0",
              "isComplete":"0"
           },
           "uniqueIdentifier":"2c-bc8"
        }
     ],
     "code":"200",
     "isOk":true
  },
  "code":"200"
} 

Errors

Stop

Request URL

http://console.247platform.com/api/recording/stop/[video id]?sessionId=[Session ID]&userId=[Client Id]&recordingId=[Recording Id]

Params

  • `recordingId` (Integer), The recording Id you wish to stop

Response

Errors