💡

This microservice supports Authentication Bearer.

Other projects also include some wrapped interfaces, which are relatively easier to use, such as the sourceObject and projectObject in the folder MediaHub API.

object data structure

An example for source object 1330964624299921408

{
  "objectId": "1330964624299921408",
  "updateTimestamp": 1737368296128,
  "createTimestamp": 1737368294560,
  "objectType": 1,
  "owner": {
    "groups": [
      "912e7d871b294c23b0c9912924b2adca"
    ],
    "users": [
      "8ae334ca560cd17001561fc64f75005e"
    ]
  },
  "admin": {  // No essential difference in business logic compared to "owner"
    "groups": [],
    "users": []
  },
  "origin": "tvu-search",
  "objectName": "Timecode_1hour_24fps_HD.ts",
  "attributes": [
    {
      "attrValue": [
        "us-east-1"
      ],
      "attrName": "region"
    }
  ],
  "features": [
    {
      "feature": "takelive"
    },
    {
      "feature": "rec"
    },
    {
      "feature": "livepreview"
    }
  ],
  "description": "",
  "location": []
}

object types

objectType	Object Type Name	Definition
1	Source	A source which can be routed to a destination object and/or recorded
2	Destination	an output from TVU
3	VOD	A video file which was not created by recording
4	Media	A video file that is generated by recording a Source Object
5	Event	A reference to a portion of a Source Object
6	Clip	A reference to a portion of a Media Object
7	Schedule
8	Collection
9	Template
12	Program
13	Story
14	Person	(internal)
15	Project	a collection of MediaHub Destination（internal)

tangible data structure

An example for a tangible whose type is a shared memory

{
  "tangibleType": "SHM",
  "distinction": "RemoteUncompressedShm",
  "createTimestamp": 1737456612533,
  "tangibleId": "de31a1e7d41f4d5a92a4800e325472aa",
  "tangibleName": "input_generic_decoder_38f328ee79ec4e42b887dd3964ac79ed",
  "extraInfo": {    
    "Type": "SHM",
    "SubType": "uncompressed_shm_server",
    "TangibleId": "de31a1e7d41f4d5a92a4800e325472aa",
    
    "VideoShm": "Vde31a1e7d41f4d5a92a4800e325472aa",
    "TvuLiveShm": "SHMDde31a1e7d41f4d5a92a4800e325472aa",
    
    "CreateTimestamp": 1737456612468,
    "FromTangibleId": null,
    "Huan": "huan:mx::::generic_decoder:de31a1e7d41f4d5a92a4800e325472aa",
    "PoolId": null,
    "ProcessId": "de31a1e7d41f4d5a92a4800e325472aa",
    "BoxId": "47f485d9634a47fa905f6dfe86e69957",
    "Region": "us-east-1",
    "Vendor": 1,
    "Version": 2,
    "Zone": "us-east-1a"
  }
}

An Object can bind with multiple tangibles. Those attributes of tangible can be used to differentiate them tangibleType/distinction/SubType.
Their enumeration values list below:

template:
{
    "tangibleType": {
        "distinction": [
            "SubType"
        ]
    }
}

{
    "SHM": {
        "LocalMiscShm": [
            "issp_decoder",
            "srt_decoder",
            "udp_decoder",
            "hls_decoder",
            "rtsp_decoder",
            "rtmp_decoder",
            "file_decoder",
            "generic_decoder",
            "grid_decoder",
            "rtmp_push_decoder",
            "pack_decoder",
            "external_decoder",
            "rtsp_push_decoder",
            "headlessr_decoder",
            "bridge_client",
            "local_misc_shm"
        ],
        "LocalUncompressedShm": [
            "ndi_decoder",
            "sdi_decoder",
            "sdiin",
            "zoom_decoder",
            "rtil_decoder",
            "youtube_decoder",
            "switcher",
            "white_balance",
            "scope",
            "frame_rate_converter",
            "uncompressed_shm_client",
            "local_uncompressed_shm"
        ],
        "LocalCompressedShm": [
            "encoder",
            "local_compressed_shm",
            "compressed_shm_client"
        ],
        "RemoteUncompressedShm": [
            "uncompressed_shm_server",
            "remote_uncompressed_shm"
        ],
        "RemoteCompressedShm": [
            "compressed_shm_server",
            "remote_compressed_shm"
        ],
        "LocalMpegTsShm": [
            "mpegts_receiver",
            "mpegts_shm_client",
            "local_mpegts_shm"
        ],
        "RemoteMpegTsShm": [
            "mpegts_transmitter",
            "mpegts_shm_server",
            "remote_mpegts_shm"
        ],
        "BridgeShm": [
            "bridge_shm",
            "bridge_server"
        ]
    },
    "WEBRTC": [
        "webrtc_encoder"
    ],
    "RTIL": [
        "rtil_encoder"
    ],
    "Processor": [
        "blackframe_detector_termprocessor",
        "sdr2hdr_interprocessor",
        "hdr2sdr_interprocessor"
    ]
}

tangible types of Source Object

X
T
NDI
HLS
ZOOM
YOUTUBE
TIKTOK
Ext
ISSP
UDP
SDI
RTSP
RTSPPULL
RTMPPUSH
RTMP
SRTCALLER(=SRT)
SRTLISTENER
LocalFile
ProMPEG
SHM
RTIL
WEBRTC
HTML
MXL

Object API

object data structure#

object types#

tangible data structure#

tangible types of Source Object#

object data structure

object types

tangible data structure

tangible types of Source Object