Skip to content
Ayame Web SDK
TypeScript HTML JavaScript
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows
dist
src
test
.esdoc.json
.eslintrc.js
.gitignore
.npmignore
CHANGES.md
LICENSE
README.md
package.json
rollup.config.js
tsconfig.json
yarn.lock

README.md

ayame-web-sdk

npm version License Actions Status

Web SDK for WebRTC Signaling Server Ayame

動作確認環境

  • Chrome 77.0.3865.90
  • Chrome Canary 79.0.3933.0
  • Safari 13.0.1 (14608.2.11.1.11)
  • Firefox 69.0.2
  • Microsoft Edge Beta 78.2.0.276.11

サンプル

OpenAyame/ayame-web-sdk-samples にサンプルコードを用意しています。

API ドキュメント

API ドキュメントは以下の URL を参照してください。

https://openayame.github.io/ayame-web-sdk/index.html

CDN で利用する

以下のURL を

<script src="https://unpkg.com/@open-ayame/ayame-web-sdk@19.9.0/dist/ayame.min.js"></script>

のように指定すると、npm などを経由せず簡単に Ayame を利用することができます。

unpkg

https://unpkg.com/@open-ayame/ayame-web-sdk@19.9.0/dist/ayame.min.js

jsdelivr

https://cdn.jsdelivr.net/npm/@open-ayame/ayame-web-sdk@19.9.0/dist/ayame.min.js

双方向送受信接続する

const conn = Ayame.connection('wss://example.com/ws', 'test-room');
const startConn = async () => {
    const mediaStream = await navigator.mediaDevices.getUserMedia({audio: true, video: true});
    await conn.connect(mediaStream);
    conn.on('disconnect', (e) => console.log(e));
    conn.on('addstream', (e) => {
        document.querySelector('#remote-video').srcObject = e.stream;
    });
    document.querySelector('#local-video').srcObject = stream;
};
startConn();

送信のみ(sendonly) で接続する

const conn = Ayame.connection('wss://example.com/ws', 'test-room');
conn.options.video.direction = 'sendonly';
conn.options.audio.direction = 'sendonly';
const startConn = async () => {
    const mediaStream = await navigator.mediaDevices.getUserMedia({audio: true, video: true});
    await conn.connect(mediaStream);
    conn.on('disconnect', (e) => console.log(e));
    conn.on('addstream', (e) => {
        document.querySelector('#remote-video').srcObject = e.stream;
    });
    document.querySelector('#local-video').srcObject = mediaStream;
};
startConn();

受信のみ(recvonly) で接続する

const conn = Ayame.connection('wss://example.com/ws', 'test-room');
conn.options.video.direction = 'recvonly';
conn.options.audio.direction = 'recvonly';
const startConn = async () => {
    await conn.connect(null);
    conn.on('disconnect', (e) => console.log(e));
    conn.on('addstream', (e) => {
        document.querySelector('#remote-video').srcObject = e.stream;
    });
};
startConn();

コーデックを H.264 指定で接続する

const conn = Ayame.connection('wss://example.com/ws', 'test-room');
conn.options.video.codec = 'H264';
const startConn = async () => {
    const mediaStream = await navigator.mediaDevices.getUserMedia({audio: true, video: true});
    await conn.connect(mediaStream);
    conn.on('disconnect', (e) => console.log(e));
    conn.on('addstream', (e) => {
        document.querySelector('#remote-video').srcObject = e.stream;
    });
    document.querySelector('#local-video').srcObject = mediaStream;
};
startConn();

datachannel でデータを送受信する

const startConn = async () => {
  const conn = Ayame.connection('wss://example.com/ws', 'test-room');
  conn.on('data', (e) => {
      console.log('data received: ',e.data);
      });
  await conn.connect(null);
};
const sendData = (data) => {
  conn.sendData(data);
};

ライセンス

Apache License 2.0

Copyright 2019, Shiguredo Inc, Kyoko Kadowaki (kdxu)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

開発について

Ayame Web SDK はオープンソースソフトウェアですが、開発についてはオープンではありません。 そのためコメントやプルリクエストを頂いてもすぐには採用はしません。

まずは Discord にてご連絡ください。

Discord

ベストエフォートで運用しています。

https://discord.gg/mDesh2E

You can’t perform that action at this time.