API Call Examples And Instructions

Create a SourceObject (identity for the source)

Create a SourceObject to represent the input source (e.g., a TVU Pack)

API: createSourceObject

API documentation issues and suggestions:

sourceType 都有哪些值可选？

boxPoolId 表示什么？

url 都支持哪些媒体类型？

返回的字段都表示什么也可简要说明下

eg:

Response:

{
    "errorCode": "0x0",
    "errorInfo": "success",
    "async": false,
    "result": {
        "objectId": "1470429396778225664",
        "objectName": "Caleb Test Video",
        "tangibleId": "55524c204558544c0000019c41223736",
        "tangibleInfo": "{\"id\":\"05ec3a2647df41729b4ee71fcdd5e161\",\"name\":\"Caleb Test Video\",\"peerId\":\"55524c204558544c0000019c41223736\",\"type\":\"Ext\",\"status\":\"1\",\"ip\":null,\"port\":null,\"timeStamp\":\"1770619287353\",\"times\":null,\"livePeerId\":null,\"livePeerName\":null,\"resourceId\":null,\"remark\":null,\"platform\":\"1002\",\"version\":null,\"url\":\"[https://mma-video-new.s3.us-east-1.amazonaws.com/export/testrrswed_n3Uq.mp4](https://mma-video-new.s3.us-east-1.amazonaws.com/export/testrrswed_n3Uq.mp4)\",\"available\":\"0\",\"batteryInfo\":null,\"bookmarks\":null,\"tokenStatus\":null,\"gridLivePeerId\":null,\"gridLivePeerName\":null,\"postion\":0,\"metaData\":null,\"isRelay\":null,\"build\":null,\"ext\":null,\"portAggregate\":null,\"portAggregateWeb\":null,\"releaseStr\":null,\"fs\":null,\"ei\":null,\"cameraStatus\":null,\"latency\":null,\"bitrate\":null,\"addrList\":null,\"userBookmarkDevice\":null,\"parentBookmarkDevice\":null}",
        "objectType": 1,
        "url": "https://mma-video-new.s3.us-east-1.amazonaws.com/export/testrrswed_n3Uq.mp4"
    }
}

Start recording with STT + Face enabled

Trigger recording by creating an event with ingest settings

API: Create slug with ingest settings

STT (transcription): "speechTranscription": 1

Face recognition (vision): "faceDetection": 1

API documentation issues and suggestions:

补全参数字段说明，虽然部分可以有名字看出含义。

eg:

Response:

{
    "errorCode": "0x0",
    "errorInfo": "success",
    "result": {
        "id": "3903980ed9ad439b993d72288ff23750",
        "deleteFlag": 0,
        "createTime": 1770619504000,
        "updateTime": 1770619504000,
        "peerId": "55524c204558544c0000019c41223736",
        "gridLinkMetadata": "CALEB TEST 0209_3",
        "globalGridMetadata": null,
        "sourceName": null,
        "sourceType": null,
        "endTime": 1770620504000,
        "externalId": null,
        "repeatId": "",
        "executeRepeatId": null,
        "slug": "PSN-423_0209_3-CALEB TEST 0209_3",
        "title": "PSN-423_0209_3",
        "report": null,
        "color": 0,
        "operationRepeatParam": null,
        "objectId": "1470429396778225664",
        "slugObjectId": "1470430386214539264",
        "insertTime": 1770619522847,
        "startTimeCode": null,
        "endTimeCode": null,
        "slugAdvanced": {
            "id": "c265e0b09238488195a38bd3319efc01",
            "deleteFlag": 0,
            "createTime": 1770619523363,
            "updateTime": 1770619523363,
            "slugId": "3903980ed9ad439b993d72288ff23750",
            "livePreview": null,
            "gridDistribution": null,
            "recording": 1,
            "speechTranscription": 1,
            "faceDetection": 1,
            "transcriberInfo": null,
            "peerId": null,
            "instanceId": null,
            "userId": "48b56585cbab495f8efe381e19074ce2",
            "sourceResolution": null,
            "status": 0,
            "sourceObjectId": "1470429396778225664",
            "sourceId": "55524c204558544c0000019c41223736",
            "groupId": "a8f42e664ea74331811292b8763673c5"
        },
        "slugRecord": null,
        "thumbnailPath": null,
        "userId": "48b56585cbab495f8efe381e19074ce2",
        "groupId": "a8f42e664ea74331811292b8763673c5",
        "ingestFile": 0,
        "type": 0,
        "repeatAssociatedId": "3903980ed9ad439b993d72288ff23750",
        "obj": null,
        "tags": null,
        "noController": false
    }
}

Receive ingest callbacks (progress + complete)

TVU will send callbacks for progress and completion.

API: register webhook

eg:

Response:

{
    "errorCode": "0x0",
    "errorInfo": "no errror"
}

Query recording for preview

Use SourceObject to find the low-res recording for preview.

API: mediafile search

eg:

Response:

{
    "errorCode": 0,
    "errorInfo": "succ",
    "result": {
        "list": [
            {
                "sourceObjectId": "1470429396778225664",
                "mediaObjectId": "1470431274907865088",
                "previewMediaPath": {
                    "path": "http://mma-video-new.s3.us-east-1.amazonaws.com/mp4/FFFFFFF000393000/55524C204558544C0000019C41223736/260209-06-48-41-718/1/rt.mpd",
                    "duration": 0,
                    "fileSize": 0,
                    "startTimestamp": 1770619733100,
                    "endTimestamp": 0
                },
                "highResMediaPath": {
                    "path": "http://mma-video-new.s3.us-east-1.amazonaws.com/ts/FFFFFFF000393000/55524C204558544C0000019C41223736/260209-06-48-41-718/1/play.m3u8",
                    "duration": 0,
                    "fileSize": 0,
                    "startTimestamp": 1770619733100,
                    "endTimestamp": 0
                },
                "thumbnailPath": "http://mma.tvunetworks.com/api/imgbed/v1/202602/ts/FFFFFFF000393000/00-FFFFFFF000393000-AB56F5FB5CEA8E3F/1770619734135/play.jpg",
                "mediaFileType": 0
            }
        ],
        "size": 1,
        "total": 1
    }
}

List user recordings

Fetch recordings under a user/account scope.

API: user recordings

eg:

Response:

{
    "errorCode": 0,
    "errorInfo": "succ",
    "result": {
        "list": [
            {
                "sourceObjectId": "1470429396778225664",
                "mediaObjectId": "1470431274907865088",
                "previewMediaPath": {
                    "path": "http://mma-video-new.s3.us-east-1.amazonaws.com/mp4/FFFFFFF000393000/55524C204558544C0000019C41223736/260209-06-48-41-718/1/rt.mpd",
                    "duration": 0,
                    "fileSize": 0,
                    "startTimestamp": 1770619733100,
                    "endTimestamp": 0
                },
                "highResMediaPath": {
                    "path": "http://mma-video-new.s3.us-east-1.amazonaws.com/ts/FFFFFFF000393000/55524C204558544C0000019C41223736/260209-06-48-41-718/1/play.m3u8",
                    "duration": 0,
                    "fileSize": 0,
                    "startTimestamp": 1770619733100,
                    "endTimestamp": 0
                },
                "thumbnailPath": "http://mma.tvunetworks.com/api/imgbed/v1/202602/ts/FFFFFFF000393000/00-FFFFFFF000393000-AB56F5FB5CEA8E3F/1770619734135/play.jpg",
                "mediaFileType": 0
            }
        ],
        "size": 1,
        "total": 1
    }
}

Extract the expected content

Use SourceObject to create an export job for the selected recording (hi-res or proxy based on use case).

API: export

This is a polling interface. The same parameters can be called multiple times until the final status (success/failure) is reached.

1000 <= errorCode < 1005: InProgress

errorCode = 1005: Finished

errorCode > 1005: Failure

eg:

Response 1:

{
    "errorCode": 1000,
    "errorMsg": "task created successfully",
    "isDryrun": false,
    "timeWait": 3000,
    "videoPath": "",
    "baseVideoPath": "",
    "metadataJsonPath": "",
    "baseMetadataJsonPath": "",
    "fileSize": 0,
    "videoDuration": 0,
    "thumbnailInfo": {
        "url": "",
        "width": "",
        "height": ""
    },
    "videoInfo": {
        "url": "",
        "type": "",
        "bitrate": "",
        "width": "",
        "height": "",
        "framerate": "",
        "duration": ""
    }
}

Response 2:

{
    "errorCode": 1005,
    "errorMsg": "Work Finish",
    "isDryrun": false,
    "timeWait": 0,
    "videoPath": "https://mma-video-new.s3.us-east-1.amazonaws.com/export/caleb_test_0209_02.mp4",
    "baseVideoPath": "https://mma-video-new.s3.us-east-1.amazonaws.com/export/caleb_test_0209_02.mp4",
    "metadataJsonPath": "",
    "baseMetadataJsonPath": "",
    "fileSize": 9014232,
    "videoDuration": 65414,
    "thumbnailInfo": {
        "url": "",
        "width": "",
        "height": ""
    },
    "videoInfo": {
        "url": "https://mma-video-new.s3.us-east-1.amazonaws.com/export/caleb_test_0209_02.mp4",
        "type": "",
        "bitrate": "",
        "width": "",
        "height": "",
        "framerate": "",
        "duration": "65414"
    }
}

Get persons detected

Use SourceObject to query person for search and timecode-based usage.

API: transcription

eg:

Response:

{
    "errorCode": 0,
    "errorInfo": "succ",
    "result": {
        "data": [
            {
                "peer_id": "FFFFFFF000393000",
                "timestamp": 1770619733251,
                "start_ts": 1770619733251,
                "end_ts": 1770619735251,
                "text": "People that tune in the Murphy and Yuri...",
                "words": [
                    {
                        "start_time": 1770619733251,
                        "end_time": 1770619733351,
                        "word": "People"
                    }
                ],
                "lang": "en",
                "speaker_tag": -1
            }
        ],
        "size": 1,
        "total": 1
    }
}

Get persons appearance timeline

API: person

eg:

Response:

{
    "errorCode": 0,
    "errorInfo": "succ",
    "result": {
        "list": [
            {
                "name": "",
                "groupId": "a8f42e664ea74331811292b8763673c5",
                "personIdList": [
                    "1770619744134mkjwf7bb"
                ],
                "thumbnailPath": "FFFFFFF000393000_1770619739507.jpg",
                "thumbnailAllPath": "https://mma.tvunetworks.com/api/imgbed/v1/vision/FFFFFFF000393000_1770619739507.jpg",
                "timestamp": 1770619772206,
                "position": {
                    "height": 277,
                    "left": 1326,
                    "top": 164,
                    "width": 197
                }
            }
        ],
        "size": 1,
        "total": 1
    }
}

Get persons appearance timeline (Track)

API: person track/appearance

eg:

Response:

{
    "errorCode": 0,
    "errorInfo": "succ",
    "result": {
        "list": [
            {
                "name": "",
                "groupId": "a8f42e664ea74331811292b8763673c5",
                "personId": [
                    "1770619744134mkjwf7bb"
                ],
                "trackList": [
                    [
                        1770619763100,
                        1770619800568
                    ]
                ],
                "totalTrackDuration": 37468
            }
        ],
        "size": 2,
        "total": 2
    }
}

Query slug

API: slug info

eg:

Delete slug

API: deleteSlug

id: The value of the id parameter in the returned result when Start recording with STT + Face enabled

eg:

Ingest Integration Workflow

API Call Examples And Instructions#

Create a SourceObject (identity for the source)#

Start recording with STT + Face enabled#

Receive ingest callbacks (progress + complete)#

Query recording for preview#

List user recordings#

Extract the expected content#

Get persons detected#

Get persons appearance timeline#

Get persons appearance timeline (Track)#

Query slug#

Delete slug#

API Call Examples And Instructions

Create a SourceObject (identity for the source)

Start recording with STT + Face enabled

Receive ingest callbacks (progress + complete)

Query recording for preview

List user recordings

Extract the expected content

Get persons detected

Get persons appearance timeline

Get persons appearance timeline (Track)

Query slug

Delete slug