https://github.com/ossrs/srs-sip
The SIP demo application for SRS GB28181.
https://github.com/ossrs/srs-sip
Last synced: over 1 year ago
JSON representation
The SIP demo application for SRS GB28181.
- Host: GitHub
- URL: https://github.com/ossrs/srs-sip
- Owner: ossrs
- License: mit
- Created: 2022-02-19T06:11:27.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T02:52:58.000Z (about 2 years ago)
- Last Synced: 2024-05-22T03:43:51.287Z (about 2 years ago)
- Language: Go
- Homepage: https://ossrs.net/lts/zh-cn/docs/v5/doc/gb28181
- Size: 122 KB
- Stars: 22
- Watchers: 4
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SRS-SIP
## Usage
Pre-requisites:
- Go 1.23+
- Node 20+
Then run
```
git clone https://github.com/ossrs/srs-sip
cd srs-sip
./build.sh
```
If on Windows
```
./build.bat
```
Run the program:
```
./objs/srs-sip
```
Use docker
```
docker run -id -p 1985:1985 -p 5060:5060 -p 8025:8025 -p 9000:9000 -p 5060:5060/udp -p 8000:8000/udp --name srs-sip --env CANDIDATE=your_ip ossrs/srs-sip:alpha
```
## Sequence
1. 注册流程
```mermaid
sequenceDiagram
Device ->> SRS-SIP : 1. Register
SRS-SIP ->> Device : 2. 401
Device ->> SRS-SIP : 3. Register
SRS-SIP ->> Device : 4. 200 OK
```
2. 播放视频流程
Player、SRS-SIP、SRS Server和GB28181 Device的交互图如下：
```mermaid
sequenceDiagram
Player ->> SRS-SIP : 1. Play Request(with id)
SRS-SIP ->> SRS : 2. Publish Request(with ssrc and id)
SRS ->> SRS-SIP : 3. Response(with port)
SRS-SIP ->> Device : 4. Invite(with port)
Device ->> SRS-SIP : 5. 200 OK
SRS-SIP ->> Player : 6. 200 OK(with url)
Device -->> SRS : Media Stream
Player ->> SRS : 7. Play
SRS -->> Player : Media Stream
Player ->> SRS-SIP : 8. Stop Request
SRS-SIP ->> SRS : 9. Unpublish Request
SRS-SIP ->> Device : 10. Bye
```
1. 通过SRS-SIP提供的API接口`/srs-sip/v1/invite`，Player主动发起播放请求，携带设备的通道ID
2. SRS-SIP向SRS发起推流请求，携带SSRC和ID，SSRC是设备推流时RTP里的字段
3. SRS响应推流请求，并返回收流端口。目前SRS仅支持TCP单端口模式，在配置文件`stream_caster.listen`中配置
4. SRS-SIP通过GB28181协议向设备发起`Invite`请求，携带SRS的收流端口及SSRC
5. 设备响应成功
6. SRS-SIP响应成功，携带URL，用于播放
7. Player通过返回的URL进行拉流播放
8. Player停止播放
9. SRS-SIP通知SRS停止收流
10. SRS-SIP通过设备停止推流
## API 接口
- 请求与响应数据格式为JSON
- 所有响应的统一结构为：
```json
{
"code": 0,
"data": {}
}
```
错误响应示例：
```
{
"code": 500,
"data": {
"msg": "error message"
}
}
```
### 接口列表
暂无，请参考demo。