Upgrade to Pro — share decks privately, control downloads, hide ads and more …

agoraのドキュメントはまずここから読め!

ミカイ
January 27, 2021

 agoraのドキュメントはまずここから読め!

開催日:1/28(木)
社内勉強会

ミカイ

January 27, 2021
Tweet

More Decks by ミカイ

Other Decks in Programming

Transcript

  1. clientClient
 const client = AgoraRTC.createClient ({: mode:"live" , codec:"vp8", ;

    }) : クライアントオブジェクトを作成します。 カジュアルな言い方をすると配信するチャンネルを作成するメソッドです。 AgoraRTCは、AgoraWebSDK(開発キット)で呼び出すことができるすべてのメソッドのエ ントリポイント(一番最初に実行することになっている箇所 )となります。 ドキュメントはこちら
  2. client.init
 client.init(appID, : function (){ : ... : }) :

    clientClientで作成したオブジェクトを初期化します。 
 カジュアルな言い方をするとチャンネルの初期設定ですね。 
 ゲーム機本体があってもボタン押さないと機能しないのと同じ原理ですね笑 
 
 appIDはagoraに必要なIDとなり、こちらをセットする必要があるので事前に登録してください 
 
 ドキュメントはこちら

  3. client.join
 client.join(token,channel,uid, : function (uid) { : : }) :

    チャネルに参加します。カジュアルな言い方をすると見たいyoutubeチャンネルにアクセス すると行った感じです。tokenは一定時間だけ有効なパスワード、uidは配信中のみ発行さ れる自動IDというイメージです。
 メソッドが成功した場合は第四引数のfunctionが発火します。 
 
 ドキュメントはこちら

  4. createStream
 const stream = AgoraRTC.createStream ({: audio: true, : video:

    true, : screen: false, : }) : clientと同様、stream(配信)もオブジェクトを作成します。カジュアルに例えるとyoutubeの配 信を作る感じですね。
 
 基本的な設定は音(audio)、カメラ(video)、screen(PC画面)の有無設定を行います。通常の ビデオ通話であれば上記のブール値になります。 
 ドキュメントはこちら

  5. stream.init
 stream.init( : function (){ : ... : }) :

    client.initと同様、作成したcreateStreamを初期化します。 
 カジュアルな言い方をすると配信の初期化ですね。 
 
 client.initと違い、引数何もセットする必要がなく、init()の関数が実行されます。 
 
 ドキュメントはこちら