Live Jobs
GET Live Jobs#
Get all live jobs.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/livejobs |
| Headers | Authorization |
| Parameters | version, projectId, search, pageIndex, pageSize |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | string | "1" | Shows the version of API |
| {projectId} | Yes | Guid | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the id of the project |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string | 1 | Shows the version of API |
| Project Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the project id of API |
| Search | Yes | string | "string" | Shows the livejob that contain that particular string |
| PageIndex | No | integer($int32) | 1 | Enter the page index, from which page you want to see live jobs |
| PageSize | No | integer($int32) | 10 | Enter how many pages you want to list from page index you selected |
Request body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "id": 0, "name": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "status": "string", "description": "string", "filePath": "string", "insertDate": "2021-11-04T15:12:19.222Z", "startDateTime": "2021-11-04T15:12:19.222Z", "endDateTime": "2021-11-04T15:12:19.222Z" } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}
| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Return a list of live jobs | |
| id | integer($int32) | 0 | Returns the id of live job |
| name | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Returns the name of live job as guid. |
| key | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Returns the stream key of live job as guid. |
| status | string | "Live" | Returns the status of the live job. |
| description | string | "string" | Returns the endpoint of the bucket. |
| filePath | string | "string" | Returns the filepath where livejob puts chunks in. |
| insertDate | DateTime | "2021-11-04T15:12:19.222Z" | Returns the inserted date time of live job. |
| startDateTime | DateTime | "2021-11-04T15:12:19.222Z" | Returns the startDateTime date time of live job. |
| endDateTime | DateTime | "2021-11-04T15:12:19.222Z" | Returns the endDateTime date time of live job. |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
POST Live Job#
Create a new live job.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/livejobs |
| Headers | Authorization |
| Parameters | projectId, version |
| Body | {jobTemplateId, destination, description, cdnDistribution, input{}, filePath, serverType, inputClass, callbackUrl } |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | string | 1 | Shows the version of API |
| {projectId} | Yes | Guid | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Shows the project Id |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| version | Yes | string | v1 | Shows the version of API |
| projectId | Yes | string($Guid) | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Id of the project |
Request body#
{ "jobTemplateId": 0, "destination": "string", "description": "string", "bucket": "string", "cdnDistribution": true, "input": { "filePath": "string", "serverType": 0, "inputClass": 0, "callbackUrl": "string" }}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| jobTemplateId | Yes | int | 10 | Sends the job template id |
| destination | Yes | string | "string" | Sends the destination in a bucket where chunck files will be saved |
| description | No | string | "string" | Sends the destination in a bucket where chunck files will be saved |
| bucket | Yes | string | "string" | Sends bucket name for the live job |
| cdnDistribution | No | bool | true | Sends the value of CDN enable or disable for the specific live job |
| filePath | Yes | string | "string" | Sends the filepath of the live job for the stream |
| serverType | Yes | bool | true | Sends the selected server type (SRT, RTMP or HLS) |
| inputClass | Yes | bool | 1 | Sends the input class for the stream (Single or Standard) |
| callbackUrl | No | string | "string" |
Responses#
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "name": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "destination": "string", "description": "string", "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "status": 0, "startDateTime": "2021-11-04T16:39:58.966Z", "endDateTime": "2021-11-04T16:39:58.966Z", "jobTemplateId": 0, "argoResourceName": "string", "resourceName": "string", "bucket": "string", "cdnDistribution": true, "rtmpServer": "string", "webSocketConnection": "string", "cdn": "string", "storageMasterFile": "string", "outputManifests": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "input": { "filePath": "string", "serverType": 0, "serverTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "inputClass": 0, "inputClassOptions": [ { "id": 0, "value": "string", "enabled": true } ], "callbackUrl": "string" }, "statistics": { "width": 0, "height": 0, "framerate": 0, "videoDataRate": 0, "videoCodecId": 0, "audioDataRate": 0, "audioSampleRate": 0, "audioSampleSize": 0, "audioCodecId": 0, "audioChannels": 0, "stereo": true, "encoder": "string" } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns the result of created live job | |
| name | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Returns the name of live job as guid. |
| key | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Returns the stream key of live job as guid. |
| destination | string | "string" | Returns the destination in a bucket where chunck files will be saved |
| description | string | "string" | Returns the destination in a bucket where chunck files will be saved |
| projectId | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | Returns the project id of the created live job as guid. |
| status | string | "Live" | Returns the status of the live job. |
| startDateTime | DateTime | "2021-11-04T15:12:19.222Z" | Returns the startDateTime date time of live job. |
| endDateTime | DateTime | "2021-11-04T15:12:19.222Z" | Returns the endDateTime date time of live job. |
| jobTemplateId | int | 10 | Returns the job template id |
| argoResourceName | string | "string" | |
| resourceName | string | "string" | |
| bucket | string | "string" | Returns bucket name for the live job |
| cdnDistribution | bool | true | Returns the value of CDN enable or disable for the specific live job |
| rtmpServer | string | "rtmp://127.0.0.1/live/streamKey" | Returns the URL of the rtmp server for the stream key |
| webSocketConnection | string | "wss://127.0.0.1/live/streamKey" | Returns the URL of the web socket connection for the stream key |
| cdn | string | "string" | Returns the URL of the CDN for the stream key |
| storageMasterFile | string | "string" | Returns the URL of the master file where its saved in storage for the stream key |
| input | array[object] | Returns the object of input for the live stream | |
| filePath | string | "string" | Returns the filepath where livejob puts chunks in. |
| serverType | string | "string" | Returns which server type you choose for the specific live job |
| serverTypeOptions | array[object] | Returns the object of server type options (RTMP,SRT,HLS) | |
| id | string | "string" | Returns the id of the server type option |
| value | string | "string" | Returns the value of the server type (RTMP, SRT or HLS) |
| enabled | string | "string" | Returns the enabled value (true or false) option for the server type |
| inputClass | string | "string" | Returns which input class you choose for the specific live job |
| inputClassOptions | array[object] | Returns the object of input class options (Single or Standard) | |
| id | string | "string" | Returns the id of the input class option |
| value | string | "string" | Returns the value of the input class (Single or Standard) |
| enabled | string | "string" | Returns the enabled value (true or false) option for the input class |
| callbackUrl | string | "string" | |
| statistics | string | "string" | Returns the video statistics that play with that live job |
| tags | string | "string" | Returns the pricing tags for the created live job |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 400 Bad Request
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
GET Output Job#
Get all live encoding output jobs.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/livejobs/outputs |
| Headers | Authorization |
| Parameters | version, projectId |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | Guid | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the id of project |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string | v1 | Shows the version of API |
| Project Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the project id of API |
| LiveJobId | Yes | integer($int32) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the id of the live job |
Request body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "liveJobId": 0, "outputId": 0, "progress": 0, "status": 0, "lockKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "counter": 0, "encoderId": 0 } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}
| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns a list of live encoding output jobs | |
| liveJobId | integer($int32) | 0 | Returns the id of the live job |
| outputId | integer($int32) | 0 | Returns the id of output live job |
| progress | integer($int32) | 0 | Returns the progress of the live encoding output job |
| status | integer($int32) | 0 | Returns the status of the live job |
| lockKey | Guid | "f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6" | Returns the lock key |
| encoderId | integer($int32) | 0 | Returns the id of the encoder |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
POST Encoding#
Start Encoding or Stop it.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/livejobs/{streamKey} |
| Headers | Authorization |
| Parameters | version, projectId, streamKey |
| Body | {online, startDateTime, finishDateTime} |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | Guid | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Shows the project Id |
| {streamKey} | Yes | Guid | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Shows the stream key of the stream |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| version | Yes | string | v1 | Shows the version of API |
| projectId | Yes | string($Guid) | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Id of the project |
| streamKey | Yes | string($Guid) | 3e2afa71-af4c-4a4a-e0fc-08d91af53721 | Shows the stream key of the stream |
Request body#
{ "online": true, "startDateTime": "2022-01-28T23:33:39.961Z", "finishDateTime": "2022-01-28T23:33:39.961Z"}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| online | Yes | bool | true | Sends true if live job is online or false if live job is offline |
| startDateTime | Yes | DateTime | "2022-01-29T15:12:19.222Z" | Sends the start time for live cut |
| finishDateTime | Yes | DateTime | "2022-01-29T15:12:19.222Z" | Sends the finished time for live cut |
Responses#
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "online": true, "playBackPathURL": "string" }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns the result of created live job | |
| online | bool | true | Returns true if live job is online or false otherwise |
| playBackPathURL | string | "string" | Returns the path for playback |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
GET Live Job#
Get live job.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/livejobs/{id} |
| Headers | Authorization |
| Parameters | version, projectId,id |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | Guid | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the id of project |
| {id} | Yes | Guid | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the id of the live job |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string | v1 | Shows the version of API |
| Project Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the project id of API |
| Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the id of the live job |
Request body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "name": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "destination": "string", "description": "string", "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "status": 0, "startDateTime": "2021-11-02T16:17:30.371Z", "endDateTime": "2021-11-02T16:17:30.371Z", "jobTemplateId": 0, "argoResourceName": "string", "resourceName": "string", "bucket": "string", "cdnDistribution": true, "rtmpServer": "rtmp://serverIP/live/", "webSocketConnection": "wss://serverIP/websocketplay/streamKey", "cdn": "string", "storageMasterFile": "https://example.com/test/master_file.m3u8", "outputManifests": { "additionalProp1": "https://example.com/test/240p/index.m3u8" }, "input": { "filePath": "string", "serverType": 0, "serverTypeOptions": [ { "id": 0, "value": "string", "enabled": true } ], "inputClass": 0, "inputClassOptions": [ { "id": 0, "value": "string", "enabled": true } ], "callbackUrl": "string" }, "statistics": { "width": 0, "height": 0, "framerate": 0, "videoDataRate": 0, "videoCodecId": 0, "audioDataRate": 0, "audioSampleRate": 0, "audioSampleSize": 0, "audioCodecId": 0, "audioChannels": 0, "stereo": true, "encoder": "string" } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}
| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns the requested live job | |
| name | Guid | "f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6" | Returns the name of the live job |
| key | Guid | "f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6" | Returns the stream key of the live job |
| destination | string | "string" | Returns the bucket destination of the live job |
| description | string | "string" | Returns the description of the live job |
| projectId | Guid | "f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6" | Returns the project id of the live job |
| status | integer($int32) | 0 | Returns the status of the live job |
| startDateTime | date | 2021-11-02T16:23:07.180Z | Returns the date when that live job has started |
| endDateTime | date | 2021-11-02T16:23:07.180Z | Returns the date when that live job has ended |
| jobTemplateId | integer($int32) | 0 | Returns the id of the template used |
| resourceName | string | "string" | Returns the resource name of the live job |
| bucket | string | "string" | Returns the bucket name of the live job |
| cdnDistribution | bool | false | If CDN is enabled will return true otherwise will return false |
| rtmpServer | string | "rtmp://serverIP/live/" | Return the endpoint to start live streaming |
| webSocketConnection | string | "wss://serverIP/websocketplay/streamKey" | Return the web socket endpoint to view live streaming |
| cdn | string | 'CDN Endpoint' | Return the CDN endpoint of the live job |
| storageMasterFile | string | "example.com/master_file.m3u8" | Returns the storage endpoint for the live job master file |
| outputManifests | array[] | Returns the endpoints for output manifests | |
| additionalProp1 | string | "string" | Returns the endpoint of the output manifest for that specific quality |
| input | object | Returns the input information about the live job | |
| filePath | string | "string" | Returns the file path of the live job |
| serverType | integer($int32) | 0 | Returns the id of the type of server selected |
| serverTypeOptions | array[object] | Returns all server type options | |
| id | integer($int32) | 0 | Returns the id of the server option |
| value | string | "string" | eturns the id of the server option |
| enabled | bool | false | Returns false if the option is not selected or true if the option is selected |
| inputClass | integer($int32) | 0 | Returns the id of the type of input class selected |
| serverTypeOptions | array[object] | Returns all input class type options | |
| id | integer($int32) | 0 | Returns the id of the input class option |
| value | string | "string" | Returns the id of the input class option |
| enabled | bool | false | Returns false if the option is not selected or true if the option is selected |
| statistics | array[object] | Returns all statistics | |
| width | integer($int32) | 0 | Returns the width of the video |
| height | integer($int32) | 0 | Returns the height of the video |
| framerate | integer($int32) | 0 | Returns the framerate of the live stream |
| videoDataRate | integer($int32) | 0 | Returns the video data rate of the live stream |
| videoCodecId | integer($int32) | 0 | Returns the codec of the video in live stream |
| audioDataRate | integer($int32) | 0 | Returns the audio data rate of the live stream |
| audioSampleRate | integer($int32) | 0 | Returns the audio sample data rate of the live stream |
| audioSampleSize | integer($int32) | 0 | Returns the size of the audio sample |
| audioCodecId | integer($int32) | 0 | Returns the codec of the audio in live stream |
| audioChannels | integer($int32) | 0 | Returns the number of audio channels |
| stereo | bool | false | Returns true if the live stream has stereo otherwise false |
| encoder | string | "string" | Returns the name of the encoder |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
GET Live Job Timings#
Get all live job timings
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/livejobs/{id}/timings |
| Headers | Authorization |
| Parameters | version, projectId, id, outputId, pageIndex, pageSize |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | Guid | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the id of project |
| {id} | Yes | Guid | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the name of the live job |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| Project Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the project id of API |
| Id | No | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the name id of the live job |
| OutputId | No | integer($int32) | 1 | Enter the id of the a specific output |
| PageIndex | No | integer($int32) | 1 | Enter the page index, from which page you want to see live jobs |
| PageSize | No | integer($int32) | 10 | Enter how many pages you want to list from page index you selected |
Request body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "status": "string", "childStatus": "string", "startDateTime": "2022-04-01T08:08:23.769Z", "messageComment": "string" } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}
| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns a list of live templates | |
| status | string | "string" | Returns the status of the live job e.g. live or offline |
| childStatus | string | "string" | Returns the action of the live job at that moment |
| startDateTime | date | 2021-11-02T16:23:07.180Z | Returns the date of the taken timming |
| messageComment | string | "string" | Returns content of the timming |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
GET Statistics#
Get Live job statistics.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/livejobs/{id}/stats |
| Headers | Authorization |
| Parameters | version, projectId,id |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | Guid | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the id of project |
| {id} | Yes | Guid | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the id of the live job |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| Project Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the project id of API |
| Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the id of the live job |
Request body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "width": 0, "height": 0, "framerate": 0, "videoDataRate": 0, "videoCodecId": 0, "audioDataRate": 0, "audioSampleRate": 0, "audioSampleSize": 0, "audioCodecId": 0, "audioChannels": 0, "stereo": true, "encoder": "string" } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns a list of live templates | |
| width | integer($int32) | 0 | Returns the width of the video |
| height | integer($int32) | 0 | Returns the height of the video |
| framerate | integer($int32) | 0 | Returns the framerate of the live stream |
| videoDataRate | integer($int32) | 0 | Returns the video data rate of the live stream |
| videoCodecId | integer($int32) | 0 | Returns the codec of the video in live stream |
| audioDataRate | integer($int32) | 0 | Returns the audio data rate of the live stream |
| audioSampleRate | integer($int32) | 0 | Returns the audio sample data rate of the live stream |
| audioSampleSize | integer($int32) | 0 | Returns the size of the audio sample |
| audioCodecId | integer($int32) | 0 | Returns the codec of the audio in live stream |
| audioChannels | integer($int32) | 0 | Returns the number of audio channels |
| stereo | bool | false | Returns true if the live stream has stereo otherwise false |
| encoder | string | "string" | Returns the name of the encoder |
| resultInfo | object | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns the page index, from which page you want to see the requested data |
| pageSize | integer($int32) | 0 | Returns how many pages you want to list from page index you selected |
| totalPages | integer($int32) | 0 | Returns the total number of pages |
| hasNextPage | bool | true | Returns the next page of paginated data |
| hasPreviousPage | bool | true | Returns the previous page of paginated data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found