Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos #93

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ The definition for the group called *groupname* is in the file
`groups/groupname.json`; it does not contain the group name, which makes
it easy to copy or link group definitions. You may use subdirectories:
a file `groups/teaching/networking.json` defines a group called
*teching/networking*.
*teaching/networking*.

Every group definition file contains a JSON directory. All fields are
optional, but unless you specify at least one user definition (`op`,
Expand Down
22 changes: 12 additions & 10 deletions README.PROTOCOL
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ The `join` message requests that the sender join or leave a group:
```

When the sender has effectively joined the group, the peer will send
a 'joined' message of kind 'join'; it may then send a 'joined' message of
kind 'change' at any time, in order to inform the client of a change in
a `joined` message of kind `join`; it may then send a `joined` message of
kind `change` at any time, in order to inform the client of a change in
its permissions or in the recommended RTC configuration.

```javascript
Expand Down Expand Up @@ -135,8 +135,8 @@ A peer must explicitly request the streams that it wants to receive.
```

The field `request` is a dictionary that maps the labels of requested
streams to a list containing either 'audio', or one of 'video' or
'video-low'. The empty key `''` serves as default. For example:
streams to a list containing either `audio`, or one of `video` or
`video-low`. The empty key `''` serves as default. For example:

```javascript
{
Expand All @@ -146,6 +146,7 @@ streams to a list containing either 'audio', or one of 'video' or
'': ['audio', 'video']
}
}
```

## Pushing streams

Expand All @@ -159,11 +160,11 @@ A stream is created by the sender with the `offer` message:
replace: id,
source: source-id,
username: username,
sdp: sdp,
sdp: sdp
}
```

If a stream with the same id exists, then this is a renegotation;
If a stream with the same id exists, then this is a renegotiation;
otherwise this message creates a new stream. If the field `replace` is
not empty, then this request additionally requests that an existing stream
with the given id should be closed, and the new stream should replace it;
Expand All @@ -178,8 +179,8 @@ a JSEP session description). Galène will interpret the `nack`,
accordingly.

The sender may either send a single stream per media section in the SDP,
or use rid-based simulcasting. In the latter case, it should send two
video streams, one with rid 'h' and high throughput, and one with rid 'l'
or use _rid-based_ simulcasting. In the latter case, it should send two
video streams, one with _rid_ `h` and high throughput, and one with _rid_ `l`
and throughput limited to roughly 100kbit/s.

The receiver may either abort the stream immediately (see below), or send
Expand Down Expand Up @@ -214,10 +215,11 @@ restart by sending a `renegotiate` message:
```

At any time after answering, the client may change the set of streams
being offered by sending a 'requestStream' request:
being offered by sending a `requestStream` request:

```javascript
{
type: 'answerStream'
type: 'requestStream'
id: id,
request: [audio, video]
}
Expand Down
2 changes: 1 addition & 1 deletion group/group_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ func TestGroup(t *testing.T) {
}

if public := GetPublic(); len(public) != 1 || public[0].Name != "group/subgroup" {
t.Errorf("Expeced group/subgroup, got %v", public)
t.Errorf("Expected group/subgroup, got %v", public)
}

Expire()
Expand Down