admin/os-webrtc-janus
1
0
Fork 0
mirror of https://github.com/Misterblue/os-webrtc-janus.git synced 2026-08-14 00:47:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md.

Browse Source 
Bump version.
This commit is contained in:
Robert Adams
2025-01-09 17:35:55 +00:00
parent 3ba2504674
commit a0fb143868
7 changed files with 187 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Janus/WebRtcJanusService.csproj
+3 -3
View File
@@ -2,7 +2,7 @@
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<Version>1.1.1</Version>
<Version>1.1.2</Version>
<PreserveCompilationContext>false</PreserveCompilationContext>
<OutputType>Library</OutputType>
<GenerateAssemblyInfo>false</GenerateAssemblyInfo>
@@ -28,7 +28,7 @@
<TieredCompilationQuickJit>false</TieredCompilationQuickJit>
<UseCommonOutputDirectory>True</UseCommonOutputDirectory>
<AppendTargetFrameworkToOutputPath>False</AppendTargetFrameworkToOutputPath>
<Version>1.1.1</Version>
<Version>1.1.2</Version>
<AppendRuntimeIdentifierToOutputPath>False</AppendRuntimeIdentifierToOutputPath>
<OutputPath>../../../bin/</OutputPath>
<RegisterForComInterop>False</RegisterForComInterop>
@@ -52,7 +52,7 @@
<TieredCompilationQuickJit>false</TieredCompilationQuickJit>
<UseCommonOutputDirectory>True</UseCommonOutputDirectory>
<AppendTargetFrameworkToOutputPath>False</AppendTargetFrameworkToOutputPath>
<Version>1.1.1</Version>
<Version>1.1.2</Version>
<AppendRuntimeIdentifierToOutputPath>False</AppendRuntimeIdentifierToOutputPath>
<OutputPath>../../../bin/</OutputPath>
<RegisterForComInterop>False</RegisterForComInterop>
README.md
+164 -1
View File
@@ -1,6 +1,42 @@
# os-webrtc-janus
Addon-module for OpenSimulator to provide webrtc voice using Janus-gateway.
Addon-module for [OpenSimulator] to provide webrtc voice support
using Janus-gateway.
For an explanation of background and architecture,
this project was presented at the
[OpenSimulator Community Conference] 2024
in the presentation
[WebRTC Voice for OpenSimulator](https://www.youtube.com/watch?v=nL78fieIFYg).
This addon works by taking viewer requests for voice service and
using a separate, external [Janus-Gateway WebRTC server].
This can be configured to allow local region spatial voice
and grid-wide group and spatial voice. See the sections below.
For running that separate Janus server, check out
[os-webrtc-janus-docker] which has instructions for running
Janus-Gateway on Linux and Windows WSL using Docker.
Instructions for:
- [Building into OpenSimulator](#Building): Build OpenSimulator with WebRTC voice service
- [Configuring Simulator for Voice Services](#Configure_Simulator)
- [Configuring Robust Grid Service](#Configure_Robust)
- [Configure Standalone Region](#Configure_Standalone)
- [Managing Voice Service](#Managing_Voice) (console commands, etc)
<a id="Building"></a>
## Building Plugin into OpenSimulator
`os-webrtc-janus` is integrated as a source build into [OpenSimulator].
It uses the [OpenSimulator] addon-module feature which makes the
build as easy as cloning the `os-webrtc-janus` sources into the
[OpenSimulator] source tree, running the build configuration script,
and then building OpenSimulator.
The steps are:
```
# Get the OpenSimulator sources
@@ -23,3 +59,130 @@ mkdir bin/config
cp addon-modules/os-webrtc-janus/os-webrtc-janus.ini bin/config
```
These building steps create several `.dll` files for `os-webrtc-janus`
in `bin/WebRtc*.dll`. Some adventurous people have found that, rather
than building the [OpenSimulator] sources, you can just copy the `.dll`s
into an existing `/bin` directory. Just make sure the `WebRtc*.dll` files
were built on the same version of [OpenSimulator] you are running.
<a id="Configure_Simulator"></a>
## Configure a Region for Voice
The last step in [Building](#Building) copied `os-webrtc-janus.ini` into
the `bin/config` directory. [OpenSimulator] reads all the `.ini` files
in that directory so this copy operation adds the configuration for `os-webrtc-janus`
and this is what needs to be configured for the simulator and region.
The sample `.ini` file has two sections: `[WebRtcVoice]` and `[JanusWebRtcVoice]`.
The `WebRtcVoice` section configures the what services the simulator uses
for WebRtc voice. The `[JanusWebRtcVoice]` section configures any connection
the simulator makes to the Janus server. The latter section is only updated
if this simulator is using a local Janus server for spatial voice.
The values for `SpatialVoiceService` and `NonSpatialVoiceService` point
either directly to a Janus service or to a Robust grid server that is providing
the grid voice service. Both these options are in the sample `os-webrtc-janus.ini`
file and the proper one should be uncommented.
The viewer makes requests for either spatial voice (used in the region and parcels)
or non-spatial voice (used for group chats or person-to-person voice conversations).
`os-webrtc-janus` allows these two types of voice connections to be handled by
different voice services. Thus there are two different configurations:
- all voice service is provided by the grid (both spatial and non-spatial point to a robust service), and
- the region simulator provides a local Janus server for region spatial voice while the grid service is used for group chats
#### Grid Only Voice Services
The most common configuration will be for a simulator that uses the grid supplied
voice services. For this configuration, `os-webrtc-janus.ini` would look like:
```
[WebRtcVoice]
Enabled = true
SpatialVoiceService = WebRtcVoice.dll:WebRtcVoiceServiceConnector
NonSpatialVoiceService = WebRtcVoice.dll:WebRtcVoiceServiceConnector
WebRtcVoiceServerURI = ${Const|PrivURL}:${Const|PrivatePort}
```
This directs both spatial and non-spatial voice to the grid service connector
and `WebRtcVoiceServerURI` points to the configured Robust grid service.
This is no need for a `[JanusWebRtcVoice]` section because all that is handled by the grid services.
#### Local Simulator Janus Service
In a grid setup, there might be a need for a single simulator/region to use its own
Janus server for either privacy or to off-load the grid voice service.
In this configuration, spatial voice is directed to the local Janus service
while the non-spatial voice goes to the grid services to allow grid wide group
chat and region independent person-to-person chat.
This is done with a `os-webrtc-janus.ini` that looks like:
```
[WebRtcVoice]
Enabled = true
SpatialVoiceService = WebRtcJanusService.dll:WebRtcJanusService
NonSpatialVoiceService = WebRtcVoice.dll:WebRtcVoiceServiceConnector
WebRtcVoiceServerURI = ${Const|PrivURL}:${Const|PrivatePort}
[JanusWebRtcVoice]
JanusGatewayURI = http://janus.example.org:14223/voice
APIToken = APITokenToNeverCheckIn
JanusGatewayAdminURI = http://janus.example.org/admin
AdminAPIToken = AdminAPITokenToNeverCheckIn
```
Notice that, since the simulator has its own Janus service, it must configure the
connection parameters to access that Janus service. The details of running and
configuring a Janus service is provided at [os-webrtc-janus-docker] but, the configuration
here needs to specify the URI to address the Janus server and the API keys
to allow this simulator access to its interfaces. The example above
contains just sample entries.
<a id="Configure_Robust"></a>
## Configure Robust Server for WebRTC Voice
For the grid services side, `os-webrtc-janus` is configured as an additional module
in the Robust OpenSimulator server. The additions to `Robust.ini` are:
```
...
[ServiceList]
...
VoiceServiceConnector = "${Const|PrivatePort}/WebRtcVoice.dll:WebRtcVoiceServerConnector"
...
[WebRtcVoice]
Enabled = true
SpatialVoiceService = WebRtcJanusService.dll:WebRtcJanusService
NonSpatialVoiceService = WebRtcJanusService.dll:WebRtcJanusService
[JanusWebRtcVoice]
JanusGatewayURI = http://janus.example.org:14223/voice
APIToken = APITokenToNeverCheckIn
JanusGatewayAdminURI = http://janus.example.org/admin
AdminAPIToken = AdminAPITokenToNeverCheckIn
...
```
This adds `VoiceServiceConnector` to the list of services presented by this Robust server
and adds the WebRtcVoice configuration that says to do both spatial and non-spatial voice
using the Janus server, and the configuration for the Janus server itself.
It is possible to configure multiple Robust service to distribute the load of services
and a Robust server that only has `VoiceServiceConnector` in its ServiceList is possible.
<a id="Configure_Standalone"></a>
## Configure Standalone Region
<a id="Managing_Voice"></a>
## Managing Voice (Console commands)
[SecondLife WebRTC Voice]: https://wiki.secondlife.com/wiki/WebRTC_Voice
[OpenSimulator]: http://opensimulator.org
[OpenSimulator Community Conference]: https://conference.opensimulator.org
[os-webrtc-janus]: https://github.com/Misterblue/os-webrtc-janus
[Janus-Gateway WebRTC server]: https://janus.conf.meetecho.com/
[os-webrtc-janus-docker]: https://github.com/Misterblue/os-webrtc-janus-docker
VERSION
+1 -1
View File
@@ -1 +1 @@
1.1.1
1.1.2
WebRtcVoice/WebRtcVoice.csproj
+3 -3
View File
@@ -2,7 +2,7 @@
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<Version>1.1.1</Version>
<Version>1.1.2</Version>
<PreserveCompilationContext>false</PreserveCompilationContext>
<OutputType>Library</OutputType>
<GenerateAssemblyInfo>false</GenerateAssemblyInfo>
@@ -28,7 +28,7 @@
<TieredCompilationQuickJit>false</TieredCompilationQuickJit>
<UseCommonOutputDirectory>True</UseCommonOutputDirectory>
<AppendTargetFrameworkToOutputPath>False</AppendTargetFrameworkToOutputPath>
<Version>1.1.1</Version>
<Version>1.1.2</Version>
<AppendRuntimeIdentifierToOutputPath>False</AppendRuntimeIdentifierToOutputPath>
<OutputPath>../../../bin/</OutputPath>
<RegisterForComInterop>False</RegisterForComInterop>
@@ -52,7 +52,7 @@
<TieredCompilationQuickJit>false</TieredCompilationQuickJit>
<UseCommonOutputDirectory>True</UseCommonOutputDirectory>
<AppendTargetFrameworkToOutputPath>False</AppendTargetFrameworkToOutputPath>
<Version>1.1.1</Version>
<Version>1.1.2</Version>
<AppendRuntimeIdentifierToOutputPath>False</AppendRuntimeIdentifierToOutputPath>
<OutputPath>../../../bin/</OutputPath>
<RegisterForComInterop>False</RegisterForComInterop>
WebRtcVoiceRegionModule/WebRtcVoiceRegionModule.csproj
+3 -3
View File
@@ -2,7 +2,7 @@
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<Version>1.1.1</Version>
<Version>1.1.2</Version>
<PreserveCompilationContext>false</PreserveCompilationContext>
<OutputType>Library</OutputType>
<GenerateAssemblyInfo>false</GenerateAssemblyInfo>
@@ -28,7 +28,7 @@
<TieredCompilationQuickJit>false</TieredCompilationQuickJit>
<UseCommonOutputDirectory>True</UseCommonOutputDirectory>
<AppendTargetFrameworkToOutputPath>False</AppendTargetFrameworkToOutputPath>
<Version>1.1.1</Version>
<Version>1.1.2</Version>
<AppendRuntimeIdentifierToOutputPath>False</AppendRuntimeIdentifierToOutputPath>
<OutputPath>../../../bin/</OutputPath>
<RegisterForComInterop>False</RegisterForComInterop>
@@ -52,7 +52,7 @@
<TieredCompilationQuickJit>false</TieredCompilationQuickJit>
<UseCommonOutputDirectory>True</UseCommonOutputDirectory>
<AppendTargetFrameworkToOutputPath>False</AppendTargetFrameworkToOutputPath>
<Version>1.1.1</Version>
<Version>1.1.2</Version>
<AppendRuntimeIdentifierToOutputPath>False</AppendRuntimeIdentifierToOutputPath>
<OutputPath>../../../bin/</OutputPath>
<RegisterForComInterop>False</RegisterForComInterop>
WebRtcVoiceServiceModule/WebRtcVoiceServiceModule.csproj
+3 -3
View File
@@ -2,7 +2,7 @@
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<Version>1.1.1</Version>
<Version>1.1.2</Version>
<PreserveCompilationContext>false</PreserveCompilationContext>
<OutputType>Library</OutputType>
<GenerateAssemblyInfo>false</GenerateAssemblyInfo>
@@ -28,7 +28,7 @@
<TieredCompilationQuickJit>false</TieredCompilationQuickJit>
<UseCommonOutputDirectory>True</UseCommonOutputDirectory>
<AppendTargetFrameworkToOutputPath>False</AppendTargetFrameworkToOutputPath>
<Version>1.1.1</Version>
<Version>1.1.2</Version>
<AppendRuntimeIdentifierToOutputPath>False</AppendRuntimeIdentifierToOutputPath>
<OutputPath>../../../bin/</OutputPath>
<RegisterForComInterop>False</RegisterForComInterop>
@@ -52,7 +52,7 @@
<TieredCompilationQuickJit>false</TieredCompilationQuickJit>
<UseCommonOutputDirectory>True</UseCommonOutputDirectory>
<AppendTargetFrameworkToOutputPath>False</AppendTargetFrameworkToOutputPath>
<Version>1.1.1</Version>
<Version>1.1.2</Version>
<AppendRuntimeIdentifierToOutputPath>False</AppendRuntimeIdentifierToOutputPath>
<OutputPath>../../../bin/</OutputPath>
<RegisterForComInterop>False</RegisterForComInterop>
os-webrtc-janus.ini
+10 -5
View File
@@ -1,24 +1,29 @@
[WebRtcVoice]
Enabled=true
; Module to use for spatial WebRtcVoice
; The following is for a Janus service just for spatial voice for this region. Config in [JanusWebRtcVoice]
SpatialVoiceService = WebRtcJanusService.dll:WebRtcJanusService
; Module to use for non-spatial WebRtcVoice
; The following is for a grid spatial voice service for this region. Link is WebRtcVoiceServiceURI
; SpatialVoiceService=WebRtcVoice.dll:WebRtcVoiceServiceConnector
; Module to use for non-spatial WebRtcVoice. Local voice service. Config in [JanusWebRtcVoice]
NonSpatialVoiceService = WebRtcJanusService.dll:WebRtcJanusService
; URL for the grid service that is providing the WebRtcVoiceService
; The following is for a grid non-spatial voice service. For groups and IMs. Link is WebRtcVoiceServiceURI
; NonSpatialVoiceService=WebRtcVoice.dll:WebRtcVoiceServiceConnector
; URL for the grid service that is providing the WebRtcVoiceService. Used by WebRtcVoiceServiceConnector.
WebRtcVoiceServerURI = ${Const|PrivURL}:${Const|PrivatePort}
; Debugging: output to log file messages sent and received from the viewer
; Debugging: output to log file messages sent and received from the viewer. Very verbose.
MessageDetails = false
[JanusWebRtcVoice]
; URI to access the Janus Gateway
JanusGatewayURI = http://janus.example.org/janus
JanusGatewayURI = http://janus.example.org:14223/voice
; APIKey to access the Janus Gateway. Must be set to the same value as the Janus Gateway.
APIToken = APITokenToNeverCheckIn
; URI to access the admin port on Janus Gateway
JanusGatewayAdminURI = http://janus.example.org/admin
; APIKey to access the admin port on the Janus Gateway. Must be set to the same value as the Janus Gateway.
AdminAPIToken = AdminAPITokenToNeverCheckIn
; Debugging: output to log file messages sent and received from Janus
; Debugging: output to log file messages sent and received from Janus. Very verbose.
MessageDetails = false