Janus服务器《二》--Transport 模块的API

最新推荐文章于 2025-02-28 10:30:00 发布
最新推荐文章于 2025-02-28 10:30:00 发布
阅读量1.1k 收藏 2
点赞数
分类专栏： janus 流媒体 文章标签： webrtc
原文链接：https://janus.conf.meetecho.com/docs/rest.html
版权
本文档详细介绍了Janus服务器的RESTful和WebSockets接口，包括创建会话、处理事件、发送消息、协商WebRTC连接等操作。Janus支持多种通信方式，并统一使用JSON消息进行交互。WebSockets接口提供更高效的双向通信，避免HTTP的并发和长连接问题。在事件处理方面，HTTP使用长连接订阅，而WebSocket自动订阅并推送事件。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

  官方关于JanusRESTful、WebSockets等传输模块的API说明的文档的翻译。

  从Janus的V0.0.6开始就实现了REST、WebSockets、RabbitMQ、MQTT、Nanomsg及UnixSockets接口用于和janus服务器进行交互。（这些通信方式均是可选的，都需要第三方库的支持）。所有这些接口统一使用json消息进行通信。

  其它接口和Rest接口在以下两处有少许差异：
《1》、访问特定session及handle时；
《2》、部分的通知处理机制；

在这里插入图片描述

1、REST接口

1.1、总体概括

  Janus有三个层级的路径（Endpoint: 访问一个API要有一个确定的地址，这个地址即路径, 又称"终点"）
《1》、服务根路径（server root）：你可以使用POST方法请求该路径去创建一个Janus会话（session）。默认根路径是/janus，可以通过配置文件修改。
《2》、会话路径（session endpoint）：[例如:/janus/12345678 ,后面的ID标识是步骤1返回的 。] 我们可以使用GET或POST方法。GET方法是 长连接，用于来自插件的event和message传输。POST方法用于创建插件句柄（plugin handle）或操作步骤1生成的janus 会话；
《3》、插件句柄路径（plugin handle endpoint）: [例如：/janus/12345678/987654 ，既是在步骤2的session ID后添加handle ID] 仅仅可使用POST方法给插件发送消息或协商信息，或操作插件句柄。GET方法用于将和该插件相关的所有event通知给对应的session。

详细介绍看1.2-1.4部分。

  你可以发送message和请求到上面提到的三种路径，所有message都含有以下三个变量，其它变量根据message不同而不同：

  • janus: 请求或事件的类型，如“create”,“attach”,"message"等。
  • transaction: 随机字符串，用于个客户端识别来自服务器的message（因为所有message是异步的）
  • error: 错误信息，包含“code”及“reason”两部分；
    例子

{
      "janus" : "error",
      "transaction" : "a1b2c3d4"
      "error" : {
              "code" : 458
              "reason" : "Could not find session 12345678"
      }
}

在这里插入图片描述

1.2、 服务器根路径（server root）

   默认的根路径是/janus，可通过janus.jcf配置文件更改。该路径只用于创建新的janus 会话（session），通过将{janus:“create”}信息POST到该路径来实现创建。
原文：
在这里插入图片描述

例子：
在这里插入图片描述

1.3 、会话路径（session endpoint）

  一旦创建了一个janus会话那么一个新的路径就被创建，该新路径由根路径及会话ID构成，比如：/janus/12345678。
janus会话路径可用以下两种方式使用：
《1》、使用无参数的GET请求该路径，请求后发送的是长连接，该长连接用于获取来自该会话的事件通知及信息通知；
《2》、用POST方式发送json消息用于和会话交互，如创建一个绑定到某个插件的新句柄或者销毁一个句柄。
在这里插入图片描述

《1.1》、长连接仅用于触发与你发送的消息相关的插件事件。（和上面矛盾说也可消息通知矛盾，弄懂后再区分）。事件通知的格式如下

janus: "event"
sender: 插件句柄的唯一数字ID，在POST方法创建插件句柄的响应信息中；
transaction:可选。要么是和你之前发送的请求有关，要么为空（此时意味着这是一个由插件自己发送的事件）
plugindata：一个json对象，包含以下信息
   plugin: 插件的名字，如janus.plugin.echotest
   data: 每个插件特有的一些信息
jsep: 可选，包含和客户端进行WeRTC PeerConnection协商的JSEP SDP（offer或answer）信息。

例子：


{
       "janus" : "event",
       "sender" : 1815153248,
       "transaction" : "sBJNyUhH6Vc6",
       "plugindata" : {
               "plugin": "janus.plugin.echotest",
               "data" : {
                       "echotest" : "event",
                       "result" : "ok"
               }
       },
}

在这里插入图片描述

  长连接默认30秒超时，因此如果在30秒内没有事件通知则keep-alive信息会被发送用于保活。


{
        "janus" : "keepalive",
}

   长连接默认每次返回一个事件，如果你需要每次返回多个事件的话，可以通过在GET请求后面带maxev参数，例如：


GET http://host:port/janus/<sessionid>?maxev=5

返回消息结构如下
在这里插入图片描述

   在销毁一个会话前最好先确定该会话管理的所有插件句柄已经被销毁。如果没有的话服务器会先自动进行插件句柄销毁操作，但是可能会有一些意想不到的问题发生。
   如果一个会话长时间没有和客户端交互的话也会被自动销毁，这个超时时间session_timeout在janus.jcfg中进行配置，到时间后会触发time事件。如果有配置reclaim_session_timeout变量，那么我们可以在规定时间内使用claim请求来重新使用会话。
在这里插入图片描述

1.4、 插件句柄路径（the plugin handle endpint）

   一旦使用会话路径创建了一个新的插件句柄，那么一个新的插件路径就在服务器端被创建。该路径的组成格式：

root path/session id/plugin handle id

例子：
 /janus/12345678/98765432

  插件句柄用于和插件通信相关的所有事情，如发送消息，协商绑定到插件的webrtc连接等等。
   你需要使用POST方法发送带有{janus:“message”}变量的json消息。该json消息可能含有jsep变量，因为和webrtc协商相关的消息也是通过该路径发送的。
  注意：
     如果你发送的消息中带有jsep信息，则服务器会认为你是要进行PeerConnection协商，这意味着空的jsep或非法的jsep信息会导致整个消息请求失败。因此如果你不是进行协商的话就不要带上jsep变量。
在这里插入图片描述

例子：

静音
{
      "janus" : "message",
      "transaction" : "sBJNyUhH6Vc6",
      "body" : {
              "audio" : false
      }
}

带JSEP的静音消息(offer)
{
      "janus" : "message",
      "transaction" : "sBJNyUhH6Vc6",
      "body" : {
              "audio" : false
      },
      "jsep" : {
              "type" : "offer",
              "sdp" : "v=0\r\no=[..more sdp stuff..]"
      }
}

  注意不论你因任何理由而想禁止trickle ICE那么你需要在json消息中添加变量{“trickle”: false}来显式告诉服务器。（推荐使用trickle ICE，janus默认使用trickle ICE）。
如果你要使用trickle方式来挑选ICE候选那么可使用专门的消息。这个专门消息janus字段值为“trickle”，可能有三种类型：

  • 单独一条trickle 候选；
  • 一组trickle候选；
  • 空trickle候选或者"completed"值，用于标志通知结束。
一条：
{
      "janus" : "trickle",
      "transaction" : "hehe83hd8dw12e",
      "candidate" : {
              "sdpMid" : "video",
              "sdpMLineIndex" : 1,
              "candidate" : "..."
      }
}

一组：
{
      "janus" : "trickle",
      "transaction" : "hehe83hd8dw12e",
      "candidates" : [
              {
                      "sdpMid" : "video",
                      "sdpMLineIndex" : 1,
                      "candidate" : "..."
              },
              {
                      "sdpMid" : "video",
                      "sdpMLineIndex" : 1,
                      "candidate" : "..."
              },
              [..]
      ]
}

结束：
{
      "janus" : "trickle",
      "transaction" : "hehe83hd8dw12e",
      "candidate" : {
              "completed" : true
      }
}

  当服务端收到一个异步消息时会马上回复一个{janus:ack}消息，然后等消息处理好之后再通过长连接以事件的机制通知客户端。值得注意的是，如果是进行webrtc的协商则一个回复你的OFFER信息的ANSWER信息不会像你预期的那样通过同一个transaction（传输）传回。插件根据其内部逻辑可能不会给你回复ANSWER，直到它内部的某些状态发生改变。
在这里插入图片描述

1.5、 WebRTC相关的事件

  janus为每一个与PeerConnection有关的插件提供了向外部报告其状态的机制。包含以下几种事件。

  • webrtcup: ICE和DTLS成功并且Janus已经正确的建立了和用户或应用的PeerConnection；
  • media : Jauns正在通过PeerConnection接受音频或视频；
  • slowlink: Janus通过PeerConnection报告发送端或接受端的链路问题；
  • handup: PeerConnection被janus或客户端关闭；
    在这里插入图片描述

例子

 一个PeerConnection创建好了：
{
        "janus" : "webrtcup",
        session_id: <the session identifier>,
        sender: <the handle identifier>
}

第一个音频包被janus接受或者音频包中断后有重新接受到

{
        "janus" : "media",
        session_id: <the session identifier>,
        sender: <the handle identifier>,
        "type" : "audio",
        "receiving" : true
}

因为一些原因janus接收不到音频包
{
        "janus" : "media",
        "session_id" : <the session identifier>,
        "sender" : <the handle identifier>
        "type" : "audio",
        "receiving" : false
}

Janus报告媒体发送问题（用户在上一秒发送了太多NACK包
{
        "janus" : "slowlink",
        "session_id" : <the session identifier>,
        "sender" : <the handle identifier>
        "uplink" : true,  /// 从Janus的视角
        "nacks" : <number of NACKs in the last second>
}）

2、WebSockets接口

  WebSocket为双向通信提供了更高效的方式，推荐在Janus使用这种传输方式，它能避免HTTP 并发所带来的超负荷及HTTP长连接所带来的的额外花销。
使用该方式和Janus通信是必须指定称为“janus-protocol”的子协议，例如：

var websocket = new WebSocket('ws://1.2.3.4:8188', 'janus-protocol');

   WebSockets使用的概念和流程和上面介绍的HTTP的是一样的，如创建会话，绑定到插件并与之交互等等。
  不同之处在于当使用WebSockets作为传输方式时，有些信息，如异步信息需要在http消息的基础上添加一些标志。

例如attach消息

HTTP方式：
{
      "janus" : "attach",
      "plugin" : "<the plugin's unique package name>",
      "transaction" : "<random string>"
}

WebSockets方式
{
      "janus" : "attach",
      "session_id" : <the session identifier>,            // 新添加！
      "plugin" : "<the plugin's unique package name>",
      "transaction" : "<random string>"
}

插件句柄消息

{
      "janus" : "message",
      "session_id" : <the session identifier>,        // 新添!
      "handle_id" : <the handle identifier>,        // 新添!
      "transaction" : "sBJNyUhH6Vc6",
      "body" : {
              "audio" : false
      }
}

  大概规律是与会话有关的消息多添加会话ID，和插件句柄有关的消息添加会话ID及插件句柄ID。

  在使用Websocket时keep-alive信息与http方式有很大不同，WebSocket有专门的保活信息

{
      "janus" : "keepalive",
      "session_id" : <the session identifier>,
      "transaction" : "sBJNyUhH6Vc6"
}

在这里插入图片描述

  Websocket和HTTP的最后一点不同是事件通知推送的机制。HTTP使用长连接，这意味着你需要显式的订阅信息，然后在接收到事件后得马上从新订阅该事件。WebSocket则不需要订阅，因为一旦你创建了一个会话，这个通信通道会自动订阅与这个会话有关的事件，所有事件都通过同一个Websock被接受。
在这里插入图片描述

3、获取Janus服务器的信息

  Janus的info路径可用于janus服务相关信息的查询。这些信息包括服务器版本号、一些可选属性是否支持（IPV6或Data Channel等）、配置了哪些插件等。GET请求路径为：[http://ip:8088/janus/info]，返回信息举例如下。
在这里插入图片描述

4、参考

《1》、RESTful, WebSockets, RabbitMQ, MQTT, Nanomsg and UnixSockets API

WebRTC笔记之二十：Janus信令交互流程
草上爬的博客
01-15 4232
Janus包含三种类型的节点： 1.根节点 server root （可配置，默认是/janus）,只能在该节点中创建janus会话 2.会话节点 session endpoint （例如/janus/12345678） 3.插件handle节点 plugin handle endpoint （例如/janus/12345678/98765432），插件handle节点会被添加到会话中 会话节点用来处理与会话相关的消息，插件handle节点用来处理与插件相关的消息，一个会话节点中可以管理多个插件handle
janus-cloud:API代理方法为Janus WebRTC服务器提供集群解决方案
05-03
Janus-cloud Janus-cloud是Janus API代理，用于创建基于Python3的Janus WebRTC服务器集群，因此可以将其部署在任何平台上。 客户端和原始Janus服务器之间将部署一个Back-to-Back API代理。 一方面，WebRTC客户端通过Janus的原始API与Janus-cloud代理通信，就像与真正的Janus服务器一样。 另一方面，Janus-cloud代理会根据客户端的行为将请求转发到群集中的后端Janus服务器。 Janus-cloud代理仅负责API（信令）处理，而媒体流仍留给Janus服务器进行中继，以便客户端可以直接与后端Janus服务器建立PeerConnections，而无需Janus-cloud参与。 在这种情况下，可以将Janus-cloud代理视为WebRTC信号服务器，而将原始的Janus服务器降级为WebRTC媒体服
janus对webRTC封装的api相关属性，方法的说明：
weixin_42471170的博客
03-10 2427
1.JavaScript API的核心是Janus对象。 第一次在页面中使用该对象时，需要对其进行初始化。可以使用init对象的静态方法来完成此操作，该方法接受以下选项： debug: 是否应在JavaScript控制台上启用调试，以及在什么级别上进行调试 true或"all"：启用所有调试器（Janus.trace，Janus.debug，Janus.log，Janus.warn，Janus.error） 数组（例如["trace", "warn"]）：仅启用选定的调试器（允许的令牌：跟踪，调试，
调用硅基流动API生成图像：使用DeepSeek-AI的Janus-Pro-7B模型（该模型限免）
最新发布
m0_72606784的博客
02-28 805
硅基流动是一个提供多种AI模型接口的平台，允许开发者通过简单的API调用来使用先进的AI技术。通过硅基流动，用户可以轻松地集成如Janus-Pro-7B这样的高级模型到自己的应用或服务中。Janus-Pro-7B是DeepSeek-AI开发的一个基于深度学习的图像生成模型。该模型能够根据输入的文本描述生成高质量的图像，广泛应用于艺术创作、广告设计、游戏开发等领域。通过硅基流动API调用DeepSeek-AI的Janus-Pro-7B模型，开发者可以轻松地将先进的图像生成技术集成到自己的应用中。
janus：Janus是伪造的Rest API服务器
02-05
## Janus Janus是一个伪造的rest api服务器，可以用于各种目的，包括前端应用程序开发，测试等。 产品特点 易于配置和使用。 支持所有http方法和REST资源。 支持CORS。 基本身份验证支持 在所有平台上均可用。 安装 获取二进制分布 您可以从下载最新的二进制发行版 从源代码构建 应该在系统中安装 （需要1.4+版本）。 确保已正确安装Go，包括设置 。 go get -u github.com/jijeshmohan/janus 怎么跑 要运行janus，请转到任何目录并创建一个名为config.json的json文件。 这定义了服务器需要公开的REST端点
探索Janus：一个强大的假REST API服务器
gitblog_00847的博客
08-29 872
探索Janus：一个强大的假REST API服务器 janusJanus is a fake rest api server项目地址:https://gitcode.com/gh_mirrors/janus2/janus 在现代软件开发中，前后端分离的架构越来越流行。为了支持这种架构，一个高效、易用的假REST API服务器变得至关重要。今天，我们要介绍的就是这样一个工具——Janus。 项目介...
janus：用Go编写的API网关
01-30
注意：该项目处于维护模式。 将会修复一些错误，但没有功能开发。 用Go编写的API网关 这是一个轻量级的API网关和管理平台，使您可以控制谁访问API，何时访问API以及访问方式。 Janus还将记录有关您的用户如何与您的API交互以及何时出错的详细分析。 要构建当前开发版本的master，需要Go 1.9或更高版本。 Janus在linux/amd64 ， linux/i386 ， linux/arm64 ， darwin/i386 ， darwin/amd64 ， windows/i386和windows/amd64上得到正式支持。 为什么选择贾努斯？ 在古代罗马宗教和神话中，Janus（/ dˈeɪnəs /;拉丁语：Ianus，发音为[ˈjaː.nus]）是起点，大门，转折，时间，门道，段落和结尾的神。 由于他展望未来和过去，通常被描绘成有两张面Kong。 我们认为以盖茨之神的名字命名这个项目会很好 :grinning_face_with_smiling_eyes: 什么是API网关？ API网关位于您的应用程序和/或服务的前面，并管理对服务的授权，访问控制和吞吐量限
（音视频开发）WebRTC进阶流媒体服务器开发-多人互动架构
Linuxhus的博客
07-27 2667
一：多人互动架构方案 （一）WebRTC回顾，两层含义： 1.WebRTC是google开源的流媒体客户端，可以进行实时通讯，主要应用于浏览器之间进行实时通讯，也可以单独编译在自己的应用中 2.WebRTC也是一套规范，只对客户端做了定义，如何进行媒体协商、通信流程...;对于服务端，比如信令服务端、中继服务，并没有在WebRTC中定义，由厂商定义;对于多人互动方案也没有定义 （二）3种框架进行多人互动 Mesh方案：从WebRTC客户端演变过来，多人互动--->变为多个1V1通讯，
一文学会快速搭建Janus服务端
m0_72843152的博客
11-28 897
由于本文主要是搭建简单的sip，所以只需要关注janus.js， settings.js，siptest.html，siptest.js，在启动窗口可以看到后端为http请求的服务端口为8088，将settings.js中的server改为本机的8088端口即可，如果需要集成到自己的项目中，也只需要对这几个文件进行修改。janus安装完成以后，是安装在/opt/janus目录的， 进入目录后可以看到组成结构，其中，Janus的执行文件在bin文件夹中，配置在etc/janus文件夹中。
WebRTC流媒体服务器Janus介绍
川流不息
03-31 4568
前言 WebRTC实现了基于网页的视频会议，标准是WHATWG 协议，可通过简单的API为浏览器和移动应用程序提供实时通信（RTC）功能。WebRTC组件已经过优化，可以最好地满足此目的。借助WebRTC，用户可以在基于开放标准的应用程序中添加实时通信功能。它支持在同级之间发送视频，语音和通用数据，从而使开发人员能够构建功能强大的语音和视频通信解决方案。该技术可在所有现代浏览器以及所有主要平台的本机客户端上使用。 WebRTC背后的技术被实现为一个开放的Web标准，并在所有主要浏览器中均以常规JavaSc
【Janus服务器搭建】：实时通信服务的部署与优化秘籍
Janus服务器是基于WebRTC协议的媒体服务器，旨在处理实时的音频、视频和数据通信。作为开源项目，Janus由WebRTC支持者提出并持续发展，已逐渐成为实时通信领域的热门选择。 在深入探讨Janus服务器的高级配置和应用...
前端模块化揭秘：Vue3与Janus客户端融合的终极指南
随着前端技术的快速发展，Vue3引入的Composition API为组件化和逻辑复用提供了新的思路，而Janus客户端则为实时通信提供了强大的支持。本文首先概述了前端模块化与Vue3的关系，深入探讨了Composition API的基础知识...
janus-client:javascript库，用于实现对janus服务器的websocket接口
04-28
与Janus WebRTC网关进行会议 实现Janus WebRTC网关的WebSocket接口的子集的Node.js客户端。 注意：目前，它仅支持videoroom插件。 设置janus客户端 var JanusClient = require ( 'janus-videoroom-client' ) . Janus ; 建立与Janus WebSocket API的连接 1.创建客户 未经身份验证 var client = new JanusClient ( { url : 'ws://localhost:8188' } ) ; 基于令牌的身份验证 var client = new JanusClient ( { url : 'ws://localhost:8188' , token : 'yourToken' } ) ; 静态秘密认证 var clien
janus原理介绍
11-20
janus的架构、基本原理等介绍，适合初学者能对janus有个基本认识
Janus系列文章三 API使用指南 VideoRoom创建新的视频房
wangxudongx的专栏
06-05 2817
Janus系列文章三 API使用指南 VideoRoom APIJanus API 通讯协议分类Janus API 的会话和事务机制事务会话Janus API 使用流程使用videoroom插件创建一个新的视频房示例建立用户会话附加到插件创建一个新的视频房相关文章 这是一个为 Janus 实现视频会议 SFU（选择性转发单元）的插件，即音频/视频路由器。这意味着该插件实现了一个虚拟会议室，同行可以随时加入和离开。这个房间基于发布/订阅模式。每个对等点都可以发布他/她自己的实时音频/视频提要：此提要成为其他
Janus API Gateway
weixin_34100227的博客
03-13 505
为什么80%的码农都做不了架构师？>>> ...
Janus启用日志与事件和Amin-API请求
农家小舍
09-24 838
文章目录Janus配置修改Janus日志使用admin-API事件Janus源码分析文章列表 Janus配置修改 Janus的很多配置都是在配置文件janus.jcfg中设定的。 Janus日志 要启动Janus日志功能，只需设定日志文件即可（在general子项中）： log_to_file = “./log/janus.log” # 设定日志文件名 debug_level = 5 # 设定日志（调试）的级别 使用admin-API admin-API是Janus中的控制API，通过它可以获取很多J
Janus API Gateway 常见问题解决方案
gitblog_00258的博客
11-15 360
Janus API Gateway 常见问题解决方案 janus An API Gateway written in Go 项目地址: https://gitcode.com/gh_mirrors/jan/janus ...
janus-pro-7b
02-04
### Janus-Pro-7B 技术概述 #### 技术文档与特性 Janus-Pro-7B 是一款先进的多模态预训练模型，具备强大的图像生成能力。该模型不仅能够理解复杂的自然语言指令，还能根据这些指令生成高质量的图片[^1]。 此模型拥有约70亿参数量，在架构设计上采用了最新的Transformer结构改进版本，使得其在处理复杂任务时表现优异。特别是在GenEval和DPG-Bench视觉生成评估中，Janus-Pro-7B展示了卓越的能力，总体准确率达到了80%，显著超越其他同类模型如Transfusion（63%）、SD3-Medium（74%）以及DALL-E 3（67%）。这表明Janus-Pro-7B具有更高的理解和执行精度[^2]。 为了方便开发者测试和部署，官方提供了在线演示平台，用户可以通过访问指定链接体验模型的功能并获取更多技术细节。 ```python import requests def get_model_info(): url = "https://huggingface.co/spaces/deepseek-ai/Janus-Pro-7B" response = requests.get(url) if response.status_code == 200: print("成功连接到Janus-Pro-7B演示页面") else: print(f"无法访问资源, 错误码:{response.status_code}") get_model_info() ``` #### 应用场景 由于出色的性能指标，Janus-Pro-7B适用于多种应用场景： - **创意辅助工具**：帮助设计师快速构思设计方案； - **虚拟形象创建**：用于构建个性化的头像或游戏角色； - **教育领域应用**：作为教学辅助手段，增强学生的学习兴趣； - **广告营销素材生产**：自动生成符合品牌调性的宣传材料。 通过上述介绍可以看出，无论是从技术创新还是实际用途来看，Janus-Pro-7B都展现出了巨大的潜力和发展前景。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值