Skip to content

Commit 7fbfb97

Browse files
authored
Update README.md
1 parent 4703e8a commit 7fbfb97

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -270,11 +270,11 @@ stream->AttachVolumeControl(volumeControl);
270270
stream->AttachMuteControl(muteControl);
271271
```
272272
273-
Furthermore, all `AddXXX()` methods have overloads that allows you to specify custom parameters or provide manually created object. The latter is useful if you want to use your own subclass instead of default implementation.
273+
Furthermore, all `AddXXX()` methods have overloads that allow you to specify custom parameters or provide manually created object. The latter is useful if you want to use your own subclass.
274274
275275
### Tracing
276276
277-
Disable tracing to syslog:
277+
By default, the library traces all operations to syslog. To disable it, construct tracer with Noop mode:
278278
279279
```cpp
280280
auto tracer = std::make_shared<aspl::Tracer>(aspl::Tracer::Mode::Noop);
@@ -283,7 +283,7 @@ auto context = std::make_shared<aspl::Context>(tracer);
283283
// pass context to all objects
284284
```
285285

286-
Provide custom tracer:
286+
You can provide custom tracer implementation:
287287

288288
```cpp
289289
class MyTracer : public aspl::Tracer
@@ -297,6 +297,8 @@ protected:
297297

298298
auto tracer = std::make_shared<MyTracer>();
299299
auto context = std::make_shared<aspl::Context>(tracer);
300+
301+
// pass context to all objects
300302
```
301303

302304
## Object model
@@ -449,11 +451,11 @@ Currently unsupported control object types:
449451
* AudioSoloControl
450452
* AudioTalkbackControl
451453

452-
If you need one of these, you can either implement it on your side, or submit a patch.
454+
If you need one of these, you can either implement it on your side, or submit a pull request.
453455

454456
To implement a new object type on your side, you need to derive Object class and manually implement dynamic dispatch methods (HasProperty, IsPropertySettable, etc.).
455457

456-
To prepare a patch that adds support for a new object type, you also need to derive Object class, but instead of implementing dynamic dispatch by hand, provide a JSON file with properties description. The internal code generation framework (see below) will do the rest of the job.
458+
To prepare a patch that adds support for a new object type, you also need to derive Object class, but instead of implementing dynamic dispatch by hand, provide a JSON file with properties description. The internal code generation framework (see below) will do the rest of the job for you.
457459

458460
## Apple documentation
459461

@@ -534,4 +536,4 @@ The library is licensed under [MIT](LICENSE).
534536

535537
This library is mostly written from scratch, but is inspired by and borrows some pieces from "SimpleAudio" and "NullAudio" plugins from [newer](https://developer.apple.com/documentation/coreaudio/building_an_audio_server_plug-in_and_driver_extension) and [older](https://github.com/HelmutJ/CocoaSampleCode/tree/master/UserLandDriverReference) Apple documentation.
536538

537-
Apple examples are licensed under [MIT](LICENSE.apple2020) and [Apple MIT](LICENSE.apple2012) licenses.
539+
Apple examples are licensed under ["MIT"](LICENSE.apple2020) and ["Apple MIT"](LICENSE.apple2012) licenses.

0 commit comments

Comments
 (0)