SkyWayContext

object SkyWayContext

アプリケーション内でSkyWayの利用に関する設定を行うクラス。

Types

Link copied to clipboard
data class Analytics(domain: String?, secure: Boolean?)
Link copied to clipboard
data class Error(message: String)
Link copied to clipboard
data class IceParams(domain: String?, version: Int?, secure: Boolean?)
Link copied to clipboard
data class Options(authToken: String, logLevel: Logger.LogLevel, webRTCLog: Boolean, enableHardwareCodec: Boolean, audioSource: Int?, rtcApi: SkyWayContext.RtcApi?, iceParams: SkyWayContext.IceParams?, signaling: SkyWayContext.Signaling?, analytics: SkyWayContext.Analytics?, rtcConfig: SkyWayContext.RtcConfig?, sfu: SkyWayContext.Sfu?, token: SkyWayContext.Token?)

SkyWayの利用に関する設定。

Link copied to clipboard
data class RtcApi(domain: String?, secure: Boolean?)
Link copied to clipboard
data class RtcConfig(timeout: Int?, policy: SkyWayContext.TurnPolicy?)

WebRTC通信に関する設定。

Link copied to clipboard
data class Sfu(domain: String?, version: Int?, secure: Boolean?)
Link copied to clipboard
data class Signaling(domain: String?, secure: Boolean?)
Link copied to clipboard
data class Token(tokenReminderTimeSec: Int?)
Link copied to clipboard
enum TurnPolicy : Enum<SkyWayContext.TurnPolicy>

TURNの利用に関する設定。TURN_ONLYにすると必ずTURNの利用を試みます。

Functions

Link copied to clipboard
fun _updateRtcConfig(rtcConfig: SkyWayContext.RtcConfig)

RtcConfigを更新します。 このAPIは内部向けのものであり、サポート対象外です

Link copied to clipboard
fun dispose()

SkyWayの利用を終了します。 以降全ての操作はできなくなり、各インスタンスからイベントが発火しなくなります。 再度SkyWayを利用する場合はsetupを実行してください。

Link copied to clipboard
fun findPlugin(name: String): Plugin?

登録されているPluginを探します。

Link copied to clipboard
fun onFatalError(message: String)
Link copied to clipboard
fun onReconnectStart()
Link copied to clipboard
fun onReconnectSuccess()
Link copied to clipboard
fun onTokenExpired()
Link copied to clipboard
fun onTokenRefreshingNeeded()
Link copied to clipboard
fun registerPlugin(plugin: Plugin)

Pluginを登録します。Botの利用に対応します。

Link copied to clipboard
suspend fun setup(context: Context, option: SkyWayContext.Options, onErrorHandler: (error: SkyWayContext.Error) -> Unit? = null): Boolean

SkyWayの利用を開始します。 既に開始している場合はログを出力し、何も行いません。 Optionを変更したい場合は一度disposeを行ってから再度実行してください。

Link copied to clipboard
fun updateAuthToken(authToken: String): Boolean

AuthTokenを更新します。

Properties

Link copied to clipboard
var isSetup: Boolean = false
Link copied to clipboard
var onErrorHandler: (error: SkyWayContext.Error) -> Unit? = null

SkyWayの利用中に致命的なエラーが起きた場合に発火するハンドラ。 初期化時の認証の失敗や、ネットワークが切断され回復不能となった場合などに発火します。

Link copied to clipboard
var onReconnectStartHandler: () -> Unit? = null

SkyWayの利用中にネットワークの瞬断などが原因で再接続処理が開始した時に発火するハンドラ。

Link copied to clipboard
var onReconnectSuccessHandler: () -> Unit? = null

SkyWayの再接続処理が完了した時に発火するハンドラ。

Link copied to clipboard
var onTokenExpiredHandler: () -> Unit? = null

SkyWayのトークンの有効期限が切れた時に発火するハンドラ。

Link copied to clipboard
var onTokenRefreshingNeededHandler: () -> Unit? = null

SkyWayのトークンの更新が必要な時に発火するハンドラ。

Link copied to clipboard
val plugins: MutableList<Plugin>

登録されているPluginの一覧。

Link copied to clipboard
const val version: String