ZLMediaKit

https://zlmediakit.github.io/ZLMediaKit/
Admin
ZLMediaKit is a high-performance streaming media server framework built on C++11 that supports...
Tokens:4,479
Snippets:51
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### WebRTC Pusher Proxy Request Examples

Source: https://zlmediakit.github.io/ZLMediaKit/webrtc/USAGE.html

Examples for pushing existing streams to WebRTC targets.

```bash
# 将RTSP流推送到WHIP服务器
curl -X POST "http://127.0.0.1/index/api/addStreamPusherProxy" \
  -d "secret=your_secret" \
  -d "schema=rtsp" \
  -d "vhost=__defaultVhost__" \
  -d "app=live" \
  -d "stream=test" \
  -d "dst_url=webrtc://target.server.com:80/live/target_stream?signaling_protocols=0"

# 将RTSP流推送到P2P房间
curl -X POST "http://127.0.0.1/index/api/addStreamPusherProxy" \
  -d "secret=your_secret" \
  -d "schema=rtsp" \
  -d "vhost=__defaultVhost__" \
  -d "app=live" \
  -d "stream=test" \
  -d "dst_url=webrtc://signaling.server.com:3000/live/room_stream?signaling_protocols=1%26peer_room_id=target_room_id"
```

--------------------------------

### WebRTC Stream Proxy Request Examples

Source: https://zlmediakit.github.io/ZLMediaKit/webrtc/USAGE.html

Examples for creating WebRTC pull proxies using WHIP/WHEP or P2P modes.

```bash
# WHIP/WHEP 模式拉流
curl -X POST "http://127.0.0.1/index/api/addStreamProxy" \
  -d "secret=your_secret" \
  -d "vhost=__defaultVhost__" \
  -d "app=live" \
  -d "stream=test" \
  -d "url=webrtc://source.server.com:80/live/source_stream?signaling_protocols=0"

# P2P 模式拉流
curl -X POST "http://127.0.0.1/index/api/addStreamProxy" \
  -d "secret=your_secret" \
  -d "vhost=__defaultVhost__" \
  -d "app=live" \
  -d "stream=test" \
  -d "url=webrtc://signaling.server.com:3000/live/source_stream??signaling_protocols=1%26peer_room_id=target_room_id"
```

--------------------------------

### Run ZLMediaKit Docker Container

Source: https://zlmediakit.github.io/ZLMediaKit

Starts a ZLMediaKit container from the master branch with standard port mappings.

```bash
# 此镜像为github action 持续集成自动编译推送，跟代码(master分支)保持最新状态
docker run -id -p 1935:1935 -p 8080:80 -p 8443:443 -p 8554:554 -p 10000:10000 -p 10000:10000/udp -p 8000:8000/udp -p 9000:9000/udp zlmediakit/zlmediakit:master
```

--------------------------------

### Run ZLMediaKit Docker Container with PyMKUI

Source: https://zlmediakit.github.io/ZLMediaKit

Starts a ZLMediaKit container from the master_py branch, which includes the PyMKUI web management interface.

```bash
# 此镜像为github action 持续集成自动编译推送，跟代码(master分支)保持最新状态, 并开启了pymkui后台管理系统，支持web管理界面
docker run -id -p 1935:1935 -p 8080:80 -p 8443:443 -p 8554:554 -p 10000:10000 -p 10000:10000/udp -p 8000:8000/udp -p 9000:9000/udp zlmediakit/zlmediakit:master_py
```

--------------------------------

### Build Docker Image from Source

Source: https://zlmediakit.github.io/ZLMediaKit

Executes the build script to create a custom Docker image.

```bash
bash build_docker_images.sh
```

--------------------------------

### Configure OBS for SRT Publishing

Source: https://zlmediakit.github.io/ZLMediaKit/srt/srt.html

Use the streamid parameter to specify the path and publishing mode for OBS.

```text
srt://192.168.1.105:9000?streamid=#!::r=live/test,m=publish
```

--------------------------------

### POST /index/api/listWebrtcRooms

Source: https://zlmediakit.github.io/ZLMediaKit/webrtc/USAGE.html

Lists all active WebRTC Peer session information.

```APIDOC
## POST /index/api/listWebrtcRooms

### Description
Lists all active WebRTC Peer session information.

### Method
POST

### Endpoint
/index/api/listWebrtcRooms

### Parameters
#### Request Body
- **secret** (string) - Required - Interface access key
```

--------------------------------

### POST /index/api/addStreamProxy

Source: https://zlmediakit.github.io/ZLMediaKit/webrtc/USAGE.html

Creates a WebRTC pull stream proxy using either WHIP/WHEP or WebSocket P2P signaling.

```APIDOC
## POST /index/api/addStreamProxy

### Description
Creates a WebRTC pull stream proxy. Supports WHIP/WHEP (signaling_protocols=0) or WebSocket P2P (signaling_protocols=1).

### Method
POST

### Endpoint
/index/api/addStreamProxy

### Parameters
#### Request Body
- **secret** (string) - Required - Interface access key
- **vhost** (string) - Optional - Virtual host name, defaults to __defaultVhost__
- **app** (string) - Required - Application name
- **stream** (string) - Required - Stream ID
- **url** (string) - Required - WebRTC source URL
```

--------------------------------

### WebRTC Configuration in config.ini

Source: https://zlmediakit.github.io/ZLMediaKit/webrtc/USAGE.html

Defines the signaling port, ICE settings, and TURN server parameters for WebRTC operations.

```ini
[rtc]
#webrtc 信令服务器端口
signalingPort=3000
#STUN/TURN服务器端口
icePort=3478
#STUN/TURN端口是否使能TURN服务
enableTurn=1

#TURN服务分配端口池
portRange=50000-65000

#ICE传输策略：0=不限制(默认)，1=仅支持Relay转发，2=仅支持P2P直连
iceTransportPolicy=0

#STUN/TURN 服务Ice密码
iceUfrag=ZLMediaKit
icePwd=ZLMediaKit
```

--------------------------------

### Publish SRT Stream with FFmpeg

Source: https://zlmediakit.github.io/ZLMediaKit/srt/srt.html

Command to push a TS file to the ZLMediaKit server using SRT.

```bash
ffmpeg -re -stream_loop -1 -i test.ts -c:v copy -c:a copy -f mpegts srt://192.168.1.105:9000?streamid=#!::r=live/test,m=publish
```

--------------------------------

### Configure VLC for SRT Playback

Source: https://zlmediakit.github.io/ZLMediaKit/srt/srt.html

Set the streamid in VLC preferences and use the base URL for playback.

```text
#!::r=live/test
```

```text
srt://192.168.1.105:9000
```

--------------------------------

### POST /index/api/addStreamPusherProxy

Source: https://zlmediakit.github.io/ZLMediaKit/webrtc/USAGE.html

Creates a WebRTC push stream proxy to send an existing stream to a WebRTC target server.

```APIDOC
## POST /index/api/addStreamPusherProxy

### Description
Creates a WebRTC push stream proxy to send an existing stream to a WebRTC target server.

### Method
POST

### Endpoint
/index/api/addStreamPusherProxy

### Parameters
#### Request Body
- **secret** (string) - Required - Interface access key
- **schema** (string) - Required - Source stream protocol (e.g., rtmp, rtsp)
- **vhost** (string) - Required - Virtual host name
- **app** (string) - Required - Application name
- **stream** (string) - Required - Source stream ID
- **dst_url** (string) - Required - WebRTC target push URL
```

--------------------------------

### Play SRT Stream with FFplay

Source: https://zlmediakit.github.io/ZLMediaKit/srt/srt.html

Command to pull and play an SRT stream from the server.

```bash
ffplay -i srt://192.168.1.105:9000?streamid=#!::r=live/test
```

--------------------------------

### POST /index/api/listWebrtcRoomKeepers

Source: https://zlmediakit.github.io/ZLMediaKit/webrtc/USAGE.html

Lists all registered signaling servers.

```APIDOC
## POST /index/api/listWebrtcRoomKeepers

### Description
Lists all registered signaling servers.

### Method
POST

### Endpoint
/index/api/listWebrtcRoomKeepers

### Parameters
#### Request Body
- **secret** (string) - Required - Interface access key
```

--------------------------------

### POST /index/api/getWebrtcProxyPlayerInfo

Source: https://zlmediakit.github.io/ZLMediaKit/webrtc/USAGE.html

Retrieves connection information and status for a WebRTC proxy player.

```APIDOC
## POST /index/api/getWebrtcProxyPlayerInfo

### Description
Retrieves connection information and status for a WebRTC proxy player.

### Method
POST

### Endpoint
/index/api/getWebrtcProxyPlayerInfo

### Parameters
#### Request Body
- **secret** (string) - Required - Interface access key
- **key** (string) - Required - Proxy player identifier
```

--------------------------------

### POST /index/api/addWebrtcRoomKeeper

Source: https://zlmediakit.github.io/ZLMediaKit/webrtc/USAGE.html

Adds a WebRTC room to a specified signaling server to maintain room connectivity.

```APIDOC
## POST /index/api/addWebrtcRoomKeeper

### Description
Adds a WebRTC room to a specified signaling server to maintain room connectivity.

### Method
POST

### Endpoint
/index/api/addWebrtcRoomKeeper

### Parameters
#### Request Body
- **secret** (string) - Required - Interface access key
- **server_host** (string) - Required - Signaling server host address
- **server_port** (integer) - Required - Signaling server port
- **room_id** (string) - Required - Room ID, checked for uniqueness by the signaling server
```

--------------------------------

### WebRTC Pusher Proxy URL Format

Source: https://zlmediakit.github.io/ZLMediaKit/webrtc/USAGE.html

URL formats for pushing streams to WebRTC targets via WHIP or P2P.

```text
# HTTP
webrtc://target_server:port/app/stream_id?signaling_protocols=0
   
# HTTPS (暂未实现)
webrtcs://target_server:port/app/stream_id?signaling_protocols=0
```

```text
# WebSocket 
webrtc://signaling_server:port/app/stream_id?signaling_protocols=1&peer_room_id=target_room
# WebSocket Secure
webrtcs://signaling_server:port/app/stream_id?signaling_protocols=1&peer_room_id=target_room
```

--------------------------------

### WebRTC WHIP/WHEP URL Format

Source: https://zlmediakit.github.io/ZLMediaKit/webrtc/USAGE.html

Standard HTTP signaling protocol URL format for SFU mode.

```text
# HTTP
webrtc://server_host:server_port/app/stream_id?signaling_protocols=0
   
# HTTPS (暂未实现）
webrtcs://server_host:server_port/app/stream_id?signaling_protocols=0
```

--------------------------------

### WebRTC WebSocket P2P URL Format

Source: https://zlmediakit.github.io/ZLMediaKit/webrtc/USAGE.html

Custom signaling protocol URL format for P2P mode.

```text
# WebSocket
webrtc://signaling_server_host:signaling_server_port/app/stream_id?signaling_protocols=1&peer_room_id=target_room_id
   
# WebSocket Secure (暂未实现)
webrtcs://signaling_server_host:signaling_server_port/app/stream_id?signaling_protocols=1&peer_room_id=target_room_id
```

--------------------------------

### POST /index/api/delWebrtcRoomKeeper

Source: https://zlmediakit.github.io/ZLMediaKit/webrtc/USAGE.html

Deletes a specified signaling server room keeper.

```APIDOC
## POST /index/api/delWebrtcRoomKeeper

### Description
Deletes a specified signaling server room keeper.

### Method
POST

### Endpoint
/index/api/delWebrtcRoomKeeper

### Parameters
#### Request Body
- **secret** (string) - Required - Interface access key
- **room_key** (string) - Required - Unique identifier for the room keeper
```
Tokens:
Raw