SkyWay Android SDK/com.ntt.skyway.core/SkyWayContext

SkyWayContext

object SkyWayContext

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

Types

data class Error(val message: String)

data class Options(val logLevel: Logger.LogLevel = Logger.LogLevel.INFO, val webRTCLog: Boolean = false, val enableHardwareCodec: Boolean = true, val audioSource: Int? = null, val audioInputSampleRate: Int? = null, val audioOutputSampleRate: Int? = null, val useHardwareAcousticEchoCanceler: Boolean = true, val useHardwareNoiseSuppressor: Boolean = true, val rtcApi: SkyWayContext.RtcApi? = null, val iceParams: SkyWayContext.IceParams? = null, val signaling: SkyWayContext.Signaling? = null, val analytics: SkyWayContext.Analytics? = null, val rtcConfig: SkyWayContext.RtcConfig? = null, val sfu: SkyWayContext.Sfu? = null, val token: SkyWayContext.Token? = null)

SkyWayの利用に関する設定。

data class RtcConfig(val timeout: Int? = null, val policy: SkyWayContext.TurnPolicy? = null)

WebRTC通信に関する設定。

data class Token(val tokenReminderTimeSec: Int? = null)

enum TurnPolicy : Enum<SkyWayContext.TurnPolicy>

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

Properties

var isSetup: Boolean

var onErrorHandler: (error: SkyWayContext.Error) -> Unit?

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

onReconnectStartHandler

var onReconnectStartHandler: () -> Unit?

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

onReconnectSuccessHandler

var onReconnectSuccessHandler: () -> Unit?

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

onTokenExpiredHandler

var onTokenExpiredHandler: () -> Unit?

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

onTokenRefreshingNeededHandler

var onTokenRefreshingNeededHandler: () -> Unit?

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

val plugins: MutableList<Plugin>

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

const val version: String

Functions

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

fun findPlugin(name: String): Plugin?

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

fun registerPlugin(plugin: Plugin)

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

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

suspend fun setup(context: Context, authToken: String, option: SkyWayContext.Options = Options()): Boolean

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

suspend fun setupForDev(context: Context, appId: String, secretKey: String, option: SkyWayContext.Options = Options()): Boolean

注意！このメソッドは、クイックスタートなどアプリの動作を確認する際に利用するためのものです。認証情報の漏洩を防ぐため、このメソッドをリリース版アプリで利用することは控えてください。 SkyWayの利用を開始します。

updateAuthToken

fun updateAuthToken(authToken: String): Boolean

AuthTokenを更新します。