Skip to content

Commit

Permalink
Readme update and remove completed inline todos
Browse files Browse the repository at this point in the history
  • Loading branch information
Aniketh01 committed Aug 10, 2020
1 parent 767c6be commit 37cda70
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ specifically DASH (ABR) streaming over the new generation protocol - QUIC and HT
`protocol`: This directory contain an asyncio based implementation of quic protocol using aioquic library.
Most of the code is inspired by the library itself and being directly modified from it.

`client`: This directory contain all the client implementation classes which are referenced and used at the main entry point of the code.

`adaptive`: This directory contain the adaptive bitrate algorithm implementation for the project.

`script`: This directory contain the script related to the creation of frames and segments from video file
Expand Down Expand Up @@ -38,6 +40,17 @@ $ python3 setup.py install --user

### Usage:

**Client**

- H3 only support client
```
python3 player.py https://localhost:4433/10 --ca-certs tests/pycacert.pem --output-dir=. --include -v
```

- QUIC only support client
```
python3 player.py https://localhost:4433/ --ca-certs tests/pycacert.pem --output-dir=. --include --legacy-quic -v
```

**Server**

Expand Down
5 changes: 0 additions & 5 deletions player.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,6 @@ def save_session_ticket(ticket: SessionTicket) -> None:
with open(args.session_ticket, "wb") as fp:
pickle.dump(ticket, fp)

#TODO: Transport: client run() function should be central here
#TODO: Transport: The main() function should be here which takes configuration params and args
#TODO: Transport: quic only and https (with h3) only schemes should be supported with an arg switch or configs.
#TODO: Streaming: ABR functionality usage should be handled here.
#TODO: Streaming: ABR algorithm selection should be handled here using an arg switch or configs.

async def run(
configuration: QuicConfiguration,
Expand Down

0 comments on commit 37cda70

Please # to comment.