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

Commit 02c9e92

Browse files
authored
Updated documentation generation (#80)
* Reworked Documentation generation * Updated Readme links
1 parent d52c919 commit 02c9e92

File tree

6 files changed

+18
-15
lines changed

6 files changed

+18
-15
lines changed

Readme.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ dotnet add package DolbyIO.Comms.Sdk
3737

3838
#### 1. Initialize the SDK
3939

40-
Initialize the SDK using the secure authentication method that uses a token in the application. For the purpose of this application, use a [client access token](https://docs.dolby.io/communications-apis/docs/overview-developer-tools#client-access-token) generated from the Dolby.io dashboard. Use the following code to initialize the SDK using the [DolbyIOSDK.InitAsync](https://api-references.dolby.io/comms-sdk-dotnet/documentation/api/DolbyIO.Comms.DolbyIOSDK.html#DolbyIO_Comms_DolbyIOSDK_InitAsync_System_String_DolbyIO_Comms_RefreshTokenCallBack_) method:
40+
Initialize the SDK using the secure authentication method that uses a token in the application. For the purpose of this application, use a [client access token](https://docs.dolby.io/communications-apis/docs/overview-developer-tools#client-access-token) generated from the Dolby.io dashboard. Use the following code to initialize the SDK using the [DolbyIOSDK.InitAsync](https://api-references.dolby.io/comms-sdk-dotnet/api/DolbyIO.Comms.DolbyIOSDK.html#DolbyIO_Comms_DolbyIOSDK_InitAsync_System_String_DolbyIO_Comms_RefreshTokenCallBack_) method:
4141

4242
```cs
4343
using DolbyIO.Comms;
@@ -58,7 +58,7 @@ catch (DolbyIOException e)
5858
}
5959
```
6060

61-
**NOTE:** The SDK is fully asynchronous, and all methods can throw the [DolbyIOException](https://api-references.dolby.io/comms-sdk-dotnet/documentation/api/DolbyIO.Comms.DolbyIOException.html).
61+
**NOTE:** The SDK is fully asynchronous, and all methods can throw the [DolbyIOException](https://api-references.dolby.io/comms-sdk-dotnet/api/DolbyIO.Comms.DolbyIOException.html).
6262

6363
#### 2. Register event handlers
6464

@@ -82,7 +82,7 @@ _sdk.Conference.ParticipantAdded = new ParticipantAddedEventHandler
8282

8383
A session is a connection between the client application and the Dolby.io backend. When opening a session, you should provide a name. Commonly, this is the name of the participant who established the session. The session can remain active for the whole lifecycle of your application.
8484

85-
To open a new session, use the [Session.OpenAsync](https://api-references.dolby.io/comms-sdk-dotnet/documentation/api/DolbyIO.Comms.Services.SessionService.html#DolbyIO_Comms_Services_SessionService_OpenAsync_DolbyIO_Comms_UserInfo_) method as in the following example:
85+
To open a new session, use the [Session.OpenAsync](https://api-references.dolby.io/comms-sdk-dotnet/api/DolbyIO.Comms.Services.SessionService.html#DolbyIO_Comms_Services_SessionService_OpenAsync_DolbyIO_Comms_UserInfo_) method as in the following example:
8686

8787
```cs
8888
try
@@ -102,7 +102,7 @@ catch (DolbyIOException e)
102102

103103
A conference is a multi-person call where participants exchange audio with one another. To distinguish between multiple conferences, you should assign a conference alias or name. When multiple participants join a conference of the same name using a token of the same Dolby.io application, they will be able to meet in a call.
104104

105-
To create and join a conference, use the [Conference.CreateAsync](hhttps://api-references.dolby.io/comms-sdk-dotnet/documentation/api/DolbyIO.Comms.Services.ConferenceService.html#DolbyIO_Comms_Services_ConferenceService_CreateAsync_DolbyIO_Comms_ConferenceOptions_) and [Conference.JoinAsync](https://api-references.dolby.io/comms-sdk-dotnet/documentation/api/DolbyIO.Comms.Services.ConferenceService.html#DolbyIO_Comms_Services_ConferenceService_JoinAsync_DolbyIO_Comms_Conference_DolbyIO_Comms_JoinOptions_) methods as in the following example:
105+
To create and join a conference, use the [Conference.CreateAsync](hhttps://api-references.dolby.io/comms-sdk-dotnet/api/DolbyIO.Comms.Services.ConferenceService.html#DolbyIO_Comms_Services_ConferenceService_CreateAsync_DolbyIO_Comms_ConferenceOptions_) and [Conference.JoinAsync](https://api-references.dolby.io/comms-sdk-dotnet/api/DolbyIO.Comms.Services.ConferenceService.html#DolbyIO_Comms_Services_ConferenceService_JoinAsync_DolbyIO_Comms_Conference_DolbyIO_Comms_JoinOptions_) methods as in the following example:
106106

107107
```cs
108108
try
@@ -121,11 +121,11 @@ catch (DolbyIOException e)
121121
}
122122
```
123123

124-
If the conference already exists, the SDK returns [Conference](https://api-references.dolby.io/comms-sdk-dotnet/documentation/api/DolbyIO.Comms.Conference).
124+
If the conference already exists, the SDK returns [Conference](https://api-references.dolby.io/comms-sdk-dotnet/api/DolbyIO.Comms.Conference).
125125

126126
#### 5. Leave the conference
127127

128-
To leave the conference, use the [Conference.LeaveAsync](https://api-references.dolby.io/comms-sdk-dotnet/documentation/api/DolbyIO.Comms.Services.ConferenceService.html#DolbyIO_Comms_Services_ConferenceService_LeaveAsync) method, as in the following example:
128+
To leave the conference, use the [Conference.LeaveAsync](https://api-references.dolby.io/comms-sdk-dotnet/api/DolbyIO.Comms.Services.ConferenceService.html#DolbyIO_Comms_Services_ConferenceService_LeaveAsync) method, as in the following example:
129129

130130
```cs
131131
try
@@ -140,7 +140,7 @@ catch (DolbyIOException e)
140140

141141
#### 6. Close the session and dispose of the SDK
142142

143-
After leaving the conference, close the session and dispose the SDK using the [Session.CloseAsync](https://api-references.dolby.io/comms-sdk-dotnet/documentation/api/DolbyIO.Comms.Services.SessionService.html#DolbyIO_Comms_Services_SessionService_CloseAsync) and [DolbyIOSDK.Dispose](https://api-references.dolby.io/comms-sdk-dotnet/documentation/api/DolbyIO.Comms.DolbyIOSDK.html#DolbyIO_Comms_DolbyIOSDK_Dispose) methods.
143+
After leaving the conference, close the session and dispose the SDK using the [Session.CloseAsync](https://api-references.dolby.io/comms-sdk-dotnet/api/DolbyIO.Comms.Services.SessionService.html#DolbyIO_Comms_Services_SessionService_CloseAsync) and [DolbyIOSDK.Dispose](https://api-references.dolby.io/comms-sdk-dotnet/api/DolbyIO.Comms.DolbyIOSDK.html#DolbyIO_Comms_DolbyIOSDK_Dispose) methods.
144144

145145
```cs
146146
try
File renamed without changes.

docs/docfx.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"src": "../"
1010
}
1111
],
12-
"dest": "documentation/api",
12+
"dest": "api",
1313
"disableGitFeatures": false,
1414
"disableDefaultFilter": false,
1515
"filter": "filterConfig.yml"
@@ -19,8 +19,8 @@
1919
"content": [
2020
{
2121
"files": [
22-
"documentation/api/**.yml",
23-
"documentation/api/index.md"
22+
"api/**.yml",
23+
"api/index.md"
2424
]
2525
},
2626
{

docs/documentation/toc.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
- name: Overview
2-
href: index.md
31
- name: Getting Started
42
href: started.md
53
- name: Unity Plugin
64
href: unity.md
75
- name: Unity Visual Scripting
86
href: visualscripting.md
9-
- name: Api Reference
10-
href: api/toc.yml

docs/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Dolby.io Communications .NET SDK
2+
3+
The Dolby.io Communications .NET SDK allows creating high-quality applications for conferencing, streaming, and collaborating. With the .NET SDK you can easily integrate the HD Dolby Voice experience, including spatial audio and shared scenes, into game engines and virtual spaces.
4+
5+
The SDK depends on the C++ SDK for core functions and supports the same functionalities for client applications as the C++ SDK.

docs/toc.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
- name: .NET SDK Documentation
22
href: documentation/
3-
homepage: documentation/index.md
3+
homepage: documentation/started.md
4+
- name: Api Reference
5+
href: api/

0 commit comments

Comments
 (0)