X-Link API Document

English

简体中文

English

简体中文

Appearance

Request history flow ​

  1. Video playback: Users can play historical video streams according to the list of videos returned

  2. Video download: Need to set the isDownload of the request parameter to true and call at the same timeGet the upload progress interfaceGet the upload progress of the device, and then call the video download interface to download the file to the local when it reaches 100

  3. Video playback and record download cannot operate the same channel on the same device

API info

Url: /web_api/v1/media/history_video ​

Method: GET ​

Content-Type:x-www-form-urlencoded ​

Request parameter ​

fieldtyperequireddesc
vehicleNostringYesPlat No.
channelNointegerYesChannel number
isSubCodeboolNoWhether it is a substream
startTimeintegerYesStart time,UTC timestamp
endTimeintegerYesEnd time,UTC timestamp
mediaTypeintegerNoMedia type 0: audio and video,1: audio,2: video
storageTypeintegerNoStorage type 1: primary storage,2 Dr Storage
playTypeintegerNoPlayback mode 0; Normal playback; l: fast forward playback :2: key frame fast back; 3: key frame playback; 4: Single-frame upload
speedintegerNoDouble speed 0: invalid, 1:1x, 2:2x, 3:4x, 4:8x, 5:16x
isDownloadboolNoWhether to download, if not download, do not need to generate mp4

Response Data ​

fieldtypedesc
zlmStreamIDstringPlay stream ID
zlmTalkStreamIDstringIntercom stream ID, which is used to push intercom streams
rtmpstringRTMP pull stream URL
rtmpsstringRTMP encrypted pull URL
rtspstringRTSP pull URL
rtspsstringRTSP encrypted pull URL
httpFlvstringHTTP-FLV pulls the URL
httpFlvsstringHTTP-FLV encrypts the pull URL
wsFlvstringwebsocket pulling URL
wsFlvsstringwebsocket encrypts the pull URL
webRTCstringwebRTC Pulls the URL
webRTCsstringwebRTC Encrypts the pull URL
talkWebRTCstringwebRTC Encrypts the pull URL
talkWebRTCsstringIntercom push stream URL(encrypted)

Exampleample ​

Request example ​

url
http://localhost:8080/web_api/v1/media/history_video?vehicleNo=13000000005&channelNo=1&isSubCode=true&startTime=1699026825&endTime=1699028383&mediaType=0&storageType=0&playType=0&speed=1&_t=1699065906071
http://localhost:8080/web_api/v1/media/history_video?vehicleNo=13000000005&channelNo=1&isSubCode=true&startTime=1699026825&endTime=1699028383&mediaType=0&storageType=0&playType=0&speed=1&_t=1699065906071

Response example ​

json
{
    "hdr":{
        "code":200
    },
    "data":{
        "zlmStreamID":"7296322783548543480",
        "zlmTalkStreamID":"",
        "rtmp":"rtmp://localhost:7206/play/7296322783548543480",
        "rtmps":"rtmps://localhost:7206/play/7296322783548543480",
        "rtsp":"rtsp://localhost:7207/play/7296322783548543480",
        "rtsps":"rtsps://localhost:7207/play/7296322783548543480",
        "httpFlv":"http://localhost:7205/play/7296322783548543480.live.flv",
        "httpFlvs":"https://localhost:443/play/7296322783548543480.live.flv",
        "wsFlv":"ws://localhost:7205/play/7296322783548543480.live.flv",
        "wsFlvs":"wss://localhost:443/play/7296322783548543480.live.flv",
        "webRTC":"http://localhost:7205/index/api/webrtc?app=play&stream=7296322783548543480&type=play",
        "webRTCs":"https://localhost:443/index/api/webrtc?app=play&stream=7296322783548543480&type=play",
        "talkWebRTC":"",
        "talkWebRTCs":""
    }
}
{
    "hdr":{
        "code":200
    },
    "data":{
        "zlmStreamID":"7296322783548543480",
        "zlmTalkStreamID":"",
        "rtmp":"rtmp://localhost:7206/play/7296322783548543480",
        "rtmps":"rtmps://localhost:7206/play/7296322783548543480",
        "rtsp":"rtsp://localhost:7207/play/7296322783548543480",
        "rtsps":"rtsps://localhost:7207/play/7296322783548543480",
        "httpFlv":"http://localhost:7205/play/7296322783548543480.live.flv",
        "httpFlvs":"https://localhost:443/play/7296322783548543480.live.flv",
        "wsFlv":"ws://localhost:7205/play/7296322783548543480.live.flv",
        "wsFlvs":"wss://localhost:443/play/7296322783548543480.live.flv",
        "webRTC":"http://localhost:7205/index/api/webrtc?app=play&stream=7296322783548543480&type=play",
        "webRTCs":"https://localhost:443/index/api/webrtc?app=play&stream=7296322783548543480&type=play",
        "talkWebRTC":"",
        "talkWebRTCs":""
    }
}

After success,how to play ​

If use H5 ,If you want it to be simple, you can directly use flvjs to play, and the user can query the usage method
Currently, webrtc play is being used here, with a delay about 700ms for public network testing. If needed, JSSDK can be provided in the future Xgplayer flv The usage document click to view