Skip to content
This repository was archived by the owner on Aug 30, 2024. It is now read-only.

Commit 7d1d550

Browse files
4thlabsmhelf-dolby
andauthored
Audio Devices nodes and documentation (#82)
* Audio Devices nodes and documentation * Tiny documentation fixes Co-authored-by: Monika <monika.helfer@dolby.com>
1 parent d6ff26a commit 7d1d550

22 files changed

+296
-14
lines changed
File renamed without changes.

docs/documentation/sdk/started.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[!include[Readme](../../../Readme.md)]

docs/documentation/sdk/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- name: Getting Started
2+
href: started.md

docs/documentation/started.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/documentation/toc.yml

Lines changed: 0 additions & 6 deletions
This file was deleted.

docs/documentation/unity/toc.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
- name: Plugin
2+
href: unity.md
3+
- name: Visual Scripting
4+
href: visualscripting.md

docs/documentation/unity.md renamed to docs/documentation/unity/unity.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Unity Plugin
1+
# Plugin
22

33
The Dolby.io Communications Plugin for Unity is available in the Unity store and requires the Unity package manager to be added to your project. This document describes how to add the .NET SDK to Unity and initialize the SDK.
44

@@ -82,7 +82,7 @@ public class MyScript : MonoBehaviour
8282
<img style="padding:25px 0" src="~/images/unity_3.png" width="400px">
8383
</div>
8484

85-
3. Make sure that the SDK is initialized and that you can call SDK methods. For more information, see the the [Getting Started](./started.md) guide and [reference](/documentation/api/DolbyIO.Comms.Services.html) documentation.
85+
3. Make sure that the SDK is initialized and that you can call SDK methods. For more information, see the the [Getting Started](../sdk/started.md) guide and [reference](/documentation/api/DolbyIO.Comms.Services.html) documentation.
8686

8787
## MacOS application entitlements
8888

docs/documentation/visualscripting.md renamed to docs/documentation/unity/visualscripting.md

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Unity Visual Scripting
1+
# Visual Scripting
22

33
Visual Scripting in Unity allows creating logic for games or applications without writing code, using visual, node-based graphs. The Dolby.io Communications Plugin for Unity provides nodes that allow using .NET SDK functionalities in Unity Visual Scripting 2021. The plugin can be used with Visual Scripting and C# scripting at the same time. This document describes the available nodes and events.
44

5-
Before using the plugin for visual scripting, make sure that you added the .NET SDK to Unity and initialized the SDK using the [Initializing] procedure.
5+
Before using the plugin for visual scripting, make sure that you added the .NET SDK to Unity and initialized the SDK using the [Initializing](./unity.md#initialization) procedure.
66

77
## Visual Scripting Nodes
88

@@ -99,6 +99,39 @@ Allows getting objects of all participants who are present at a conference.
9999
Parameters:
100100
- **Participant Ids**: A list of participant IDs that causes returning only the objects of the listed participants.
101101

102+
### Get Audio Devices
103+
104+
Allows getting available audio devices.
105+
106+
<div style="text-align:center">
107+
<img style="padding:25px 0" src="~/images/nodes/audio-devices.png" width="250px">
108+
</div>
109+
110+
Parameters:
111+
- **Direction**: The [direction](xref:DolbyIO.Comms.DeviceDirection) of the devices.
112+
113+
### Set Audio Input Device
114+
115+
Allows setting the audio input device.
116+
117+
<div style="text-align:center">
118+
<img style="padding:25px 0" src="~/images/nodes/audio-input.png" width="250px">
119+
</div>
120+
121+
Parameters:
122+
- **Audio Device**: The [AudioDevice](xref:DolbyIO.Comms.AudioDevice) to set.
123+
124+
### Set Audio Output Device
125+
126+
Allows setting the audio output device.
127+
128+
<div style="text-align:center">
129+
<img style="padding:25px 0" src="~/images/nodes/audio-output.png" width="250px">
130+
</div>
131+
132+
Parameters:
133+
- **Audio Device**: The [AudioDevice](xref:DolbyIO.Comms.AudioDevice) to set.
134+
102135
## The Visual Scripting Events
103136

104137
### On Conference Status Updated Event
@@ -133,6 +166,22 @@ Emitted when an active speaker has [changed](xref:DolbyIO.Comms.Services.Confere
133166
<img style="padding:25px 0" src="~/images/nodes/event-active-speaker.png" width="250px">
134167
</div>
135168

169+
### On Audio Device Added Event
170+
171+
Emitted when an audio device is [added](xref:DolbyIO.Comms.Services.MediaDeviceService.Added).
172+
173+
<div style="text-align:center">
174+
<img style="padding:25px 0" src="~/images/nodes/event-audio-added.png" width="250px">
175+
</div>
176+
177+
### On Audio Device Changed Event
178+
179+
Emitted when the active audio device has [changed](xref:DolbyIO.Comms.Services.MediaDeviceService.Changed).
180+
181+
<div style="text-align:center">
182+
<img style="padding:25px 0" src="~/images/nodes/event-audio-changed.png" width="250px">
183+
</div>
184+
136185
## Examples
137186
### Joining a Conference
138187

23.2 KB
Loading

docs/images/nodes/audio-input.png

19.8 KB
Loading

0 commit comments

Comments
 (0)