Home / Docs Center / Device API Reference / webrtcStream RelayHeartbeat

webrtcStream RelayHeartbeat

Device API Reference · Encoder WebRTC Playback

Project: Device Interface Document (New Version) | page_id: 1338

Brief Description:

  • After a WebRTC stream relay request is made, a heartbeat needs to be sent; the heartbeat interval is 20s

Request URL:
- /xsw/api/webrtc/relayHeart

Request Method:
- POST

URL Parameters:

Parameter Name Required Type Description
streamPath Yes string Stream name, for example channel 1 is hlsram/live0

Return Example

  {
        "code": 0,
        "msg": ""
  }

Return Parameter Description

Parameter Name Type Description
code int Status code. 0 means success, other values mean failure
msg string Failure information

Notes

  • After calling the api/webrtc/relay interface, you need to call this interface as well. During playback, request it once every 20s; if there is no request for 1 minute, the relay data will be disconnected
Didn't find what you need?Contact us,Talk to our engineers directly.

Request a Quote

Fill in the form and we will get back with a quote and proposal within 1 business day.

Click "Generate inquiry email" to open your mail client with the body pre-filled. If no mail client is configured, click "Copy" and paste it into webmail — recipient: sunshiyang@xstrive.com.