Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
svenpaulsen committed Sep 25, 2022
1 parent 25d74be commit bfd16b2
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
8 changes: 7 additions & 1 deletion Playgrounds/macOS.playground/Contents.swift
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,11 @@ try room.sendMessage(data: yourMessage)
//: ### Transient Suppression
//:
//: When enabled, the transient suppressor will try to detect and attenuate keyboard clicks.
//:
//: ### Automatic Gain Control (AGC)
//:
//: When enabled, the gain controller will bring the input audio signal to an appropriate range when it's either too loud
//: or too quiet.

// Create a new APM settings struct
let audioConfig: OdinApmConfig = .init(
Expand All @@ -301,7 +306,8 @@ let audioConfig: OdinApmConfig = .init(
high_pass_filter: true,
pre_amplifier: true,
noise_suppression_level: OdinNoiseSuppressionLevel_Moderate,
transient_suppressor: true
transient_suppressor: true,
gain_controller: true
)

// Update the APM settings of the room
Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,8 @@ let audioConfig: OdinApmConfig = .init(
high_pass_filter: true,
pre_amplifier: true,
noise_suppression_level: OdinNoiseSuppressionLevel_Moderate,
transient_suppressor: true
transient_suppressor: true,
gain_controller: true
)

// Update the APM settings of the room
Expand Down Expand Up @@ -312,6 +313,10 @@ When enabled, the preamplifier will boost the signal of sensitive microphones by

When enabled, the transient suppressor will try to detect and attenuate keyboard clicks.

### Automatic Gain Control (AGC)

When enabled, the gain controller will bring the input audio signal to an appropriate range when it's either too loud or too quiet.

### User Data

Every peer has its own user data, which is a byte array (`[UInt8]`). This data is synced automatically, which allows storing of arbitrary information for each individual peer and even globally for the room if needed. Peers can update their own user data at any time, even before joining a room to specify the initial user data value. For convenience, we're providing a set of helper functions in `OdinCustomData` to handle user data conversion:
Expand Down

0 comments on commit bfd16b2

Please sign in to comment.