IGenvidClient

class genvidClient.IGenvidClient()

Genvid クライアントは、leaf サービスで通信を処理します。

属性

genvidClient.IGenvidClient.composeTimeMS

Compose サービスの予測時間 (ミリ秒)。

タイプ: 数値

genvidClient.IGenvidClient.delayOffset

遅延オフセット。

タイプ: 数値

genvidClient.IGenvidClient.lastComposeTimeMS

Compose サービスが受け取った公式時間 (ミリ秒)。

タイプ: 数値

genvidClient.IGenvidClient.streamLatencyMS

ストリーム遅延 (ミリ秒)。

タイプ: 数値

genvidClient.IGenvidClient.streamTimeMS

現在のストリーム時間 (ミリ秒)。

タイプ: 数値

genvidClient.IGenvidClient.videoAspectRatio

ビデオのアスペクト比を保持するメンバー変数 (例。videoWidth/videoHeight の結果)。

このメンバーは、WebGL オーバーレイとビデオプレイヤーを一致させるのに役立ちます。

タイプ: 数値

genvidClient.IGenvidClient.videoElem

ビデオプレイヤーがロードされた後、videoElemId の最終 HTMLElement。

タイプ: HTMLElement | undefined

genvidClient.IGenvidClient.videoElemId

ビデオ要素の一意の識別子 (変更予定)。

タイプ: 文字列 | 未定義

genvidClient.IGenvidClient.videoPlayer

ビデオプレイヤー

タイプ: player.IVideoPlayer() | 未定義

genvidClient.IGenvidClient.videoTimeMS

ビデオプレイヤーの予測時間 (ミリ秒)。

タイプ: 数値

メソッド

genvidClient.IGenvidClient.close()

Genvid サービスから GenvidClient を切断する。

戻り値:void
genvidClient.IGenvidClient.onAuthenticated(onAuthenticatedCallback)

認証時に呼び出すコールバックを指定する。

引数:
  • onAuthenticatedCallback(success) –
    param success:ブール値
    戻り値:void
戻り値:

void
genvidClient.IGenvidClient.onDisconnect(callback)

websocket が閉じた時に呼び出すコールバックを指定する。

引数:
  • callback() –
    戻り値:void
戻り値:

void
genvidClient.IGenvidClient.onDraw(callback)

オーバーレイ描画時に呼び出すコールバックを指定する。

引数:
戻り値:

void
genvidClient.IGenvidClient.onNotificationsReceived(callback)

通知を受け取った時に呼び出すコールバックを指定する。

引数:
戻り値:

void
genvidClient.IGenvidClient.onStreamsReceived(callback)

ストリームを受け取った時に呼び出すコールバックを指定する。

引数:
戻り値:

void
genvidClient.IGenvidClient.onVideoPlayerReady(callback)

ライブ配信サービスのビデオプレイヤーを作成し、ライブ配信の準備が完了した時に呼び出すコールバックを指定する。

引数:
  • callback(elem) –
    param elem:HTMLElement
    戻り値:void
戻り値:

void
genvidClient.IGenvidClient.reconnect(newInfo, newURI, newToken)

指定したトークンで websocket を指定した URI に再接続します。

引数:
戻り値:

void
genvidClient.IGenvidClient.sendEvent(object)

Genvid Services イベントシステムにイベントを送信する。

引数:
戻り値:

void
genvidClient.IGenvidClient.sendEventObject(object)

Genvid Services イベントシステムにイベントを送信する。このメソッドがオブジェクトをキー値ペアの配列に変換し、システムに送信する。

引数:
  • object – 任意 オブジェクトがキー値の配列に解凍され、Genvid イベントシステムに送信される。
戻り値:

void
genvidClient.IGenvidClient.start()

データライブ配信の開始に使用する。

戻り値:void