API

Client APIを使って、独自のソフトウェアからルームを操作できます。

APIアドオンを使うと、ルームのWebSocket Client APIが利用できるようになります。お使いのソフトウェアは、プレゼンリモコンを持った発表者と同じようにルームに参加し、スライドの切り替え、発表者タイマーの操作、レーザーポインターの移動、ホストへのメッセージ送信を行います。

利用できる機能

スライド操作

次へと前へに加え、プレゼンテーションアプリが対応していれば、最初へ、最後へ、指定スライドへの移動、ブラックアウトも使えます。

タイマー操作

開始、停止、リセット、1分・2分・5分の加算と減算、5分から20分のプリセット、最大999分までの任意の時間設定に対応しています。

レーザーポインター

ホストの共有画面上でレーザーポインターを動かします。

ホストへのメッセージ

最大1000文字のメモを送信できます。

プラン	API
Presenter、Studio HD、Studio 4K	アドオンを購入
Studio 8K、Enterprise	標準で含まれます

専用のアプリ画面はありません。ご自身のコードから利用します。

サインインしてから、https://cliqer.io/addons/apiを開きます。

週単位、月単位、年単位、または1回限りから選べます。初期状態では年単位が選択されています。

ライセンスのすべてのシートでAPIが利用できるようになります。詳しくはシート単位の課金をご覧ください。

ホストのライセンスにAPIアドオンが含まれているか、ライセンスがStudio 8KまたはEnterpriseである必要があります。

WebSocketの説明に従ってルームに接続します。

スライド、タイマー、ポインター、メッセージのコマンドを送信します。タイマーコマンドを使うには、ホストがお使いの接続からのクリックを許可している必要があります。

https://cliqer.io/dash/team/api-keysで発行するチームAPIキーは、RESTエンドポイント向けの別機能で、Studio 8KとEnterpriseで利用できます。ルームのソケットには接続できません。

APIがない場合、ソケットはエラーapi_not_in_planを返してコマンドを拒否します。

上限を超えると、ソケットはrate_limitedを返します。

APIアドオン

料金と購入手続き。

WebSocketリファレンス

すべてのメッセージ、フィールド、エラー。

すべてのアドオン

どのプランで何を購入できるか、シート単位の課金について。

Designer

独自のレイアウトで発表者ビューをデザインします。

Church

Cliqer Studio の聖書・歌詞タイトル。