SIPML5 项目使用教程

2026-01-16 10:37:53作者：冯梦姬Eddie

1. 项目的目录结构及介绍

SIPML5 是一个基于 HTML5 和 WebRTC 的 SIP 客户端开源项目。以下是该项目的目录结构及其简要介绍：

sipml5/
├── css/
│   └── style.css
├── images/
│   └── ...
├── js/
│   ├── SIPml-api.js
│   ├── SIPml-api.min.js
│   └── ...
├── index.html
├── README.md
└── LICENSE

css/：包含项目的样式文件，如 style.css。
images/：包含项目所需的各种图像资源。
js/：包含项目的 JavaScript 文件，其中 SIPml-api.js 和 SIPml-api.min.js 是核心 API 文件。
index.html：项目的入口文件，用于启动 SIP 客户端。
README.md：项目的说明文档，包含项目的基本信息和使用指南。
LICENSE：项目的许可证文件，SIPML5 使用 BSD-3-Clause 许可证。

2. 项目的启动文件介绍

项目的启动文件是 index.html，它负责加载必要的资源并初始化 SIP 客户端。以下是 index.html 文件的关键部分：

<!DOCTYPE html>
<html>
<head>
    <title>SIPML5 Client</title>
    <link rel="stylesheet" href="css/style.css">
</head>
<body>
    <script src="js/SIPml-api.js"></script>
    <script>
        // 初始化 SIP 引擎
        SIPml.initEngine();
    </script>
</body>
</html>

<link rel="stylesheet" href="css/style.css">：加载样式文件。
<script src="js/SIPml-api.js"></script>：加载核心 API 文件。
<script>SIPml.initEngine();</script>：初始化 SIP 引擎。

3. 项目的配置文件介绍

SIPML5 的配置主要通过 JavaScript 代码在 index.html 中进行。以下是一个典型的配置示例：

SIPml.initEngine({
    realm: 'example.com',
    impi: 'username',
    impu: 'sip:username@example.com',
    password: 'password',
    display_name: 'Display Name'
});