Skip to content

Commit

Permalink
Merge pull request #40 from skyway/update/api-reference-url
Browse files Browse the repository at this point in the history
Update API reference URL
  • Loading branch information
yuki-uchida authored May 11, 2023
2 parents 39270d7 + dbfb134 commit e39cdef
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README-en.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ If you found the exciting use cases, let us know!

## How to Use

[API Reference](http://35.200.46.204)
[API Reference](https://skyway.github.io/skyway-webrtc-gateway)

[samples](https://github.com/skyway/skyway-webrtc-gateway/tree/master/samples)

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ WebRTC Engineを自由に操作できることで、その用途は無限に広

## How to Use

[API Reference](http://35.200.46.204)
[API Reference](https://skyway.github.io/skyway-webrtc-gateway)

[Tutorial](https://github.com/skyway/skyway-webrtc-gateway/tree/master/docs/tutorial.md)

Expand Down
12 changes: 6 additions & 6 deletions docs/release_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ When an user release her end-user-program, the program needs to access some API

エンドユーザプログラムの終了時には、WebRTC Gatewayで割り当てられているいくつかのリソースを開放してください。

- [DataConnection Release API](http://35.200.46.204/#/2.data/data_connection_close)
- [MediaConnection Release API](http://35.200.46.204/#/3.media/media_connection_close)
- [PeerObject Release API](http://35.200.46.204/#/1.peers/peer_destroy)
- [DataConnection Release API](https://skyway.github.io/skyway-webrtc-gateway/#/2.data/data_connection_close)
- [MediaConnection Release API](https://skyway.github.io/skyway-webrtc-gateway/#/3.media/media_connection_close)
- [PeerObject Release API](https://skyway.github.io/skyway-webrtc-gateway/#/1.peers/peer_destroy)

It doesn't have to call these APIs, because they are automatically closed when P2P links which use the resources.
If the program access to the releasing APIs, they would return error codes, but it's ok to ignore the errors.
Expand All @@ -17,6 +17,6 @@ DataConnectionやMediaConnetionの終了時、これらが内部的に使用し
既に開放済みの場合、これらのAPIへのアクセスはエラーを返しますが、無視して問題ありません。
* 但し、開放したもののDataConnetionやMediaConnectionで利用していないポートに関しては、以下のAPIにアクセスし手動で開放する必要があります。

- [Media Port Release API](http://35.200.46.204/#/3.media/streams_delete)
- [RTCP Port Release API](http://35.200.46.204/#/3.media/media_rtcp_delete)
- [Data Port Release API](http://35.200.46.204/#/2.data/data_delete)
- [Media Port Release API](https://skyway.github.io/skyway-webrtc-gateway/#/3.media/streams_delete)
- [RTCP Port Release API](https://skyway.github.io/skyway-webrtc-gateway/#/3.media/media_rtcp_delete)
- [Data Port Release API](https://skyway.github.io/skyway-webrtc-gateway/#/2.data/data_delete)
2 changes: 1 addition & 1 deletion release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
- 通話を繰り返すことによりメモリ使用量が増加してしまう問題を修正
- `Peer`インスタンスを生成するとき、`+`などの記号を含む`Peer ID`を引数に指定した場合、指定した`Peer ID`と異なる`Peer ID`が割り当てられる問題を修正
- [SkyWay Peer Authentication](https://github.com/skyway/skyway-peer-authentication-samples) に対応
- [API Referenceの更新](http://35.200.46.204/)
- [API Referenceの更新](https://skyway.github.io/skyway-webrtc-gateway/)

## [v0.2.1](https://github.com/skyway/skyway-webrtc-gateway/releases/tag/0.2.1)

Expand Down

0 comments on commit e39cdef

Please sign in to comment.