SkyWay Android SDK/com.ntt.skyway.room/RoomSubscription

RoomSubscription

interface RoomSubscription

RoomSubscriptionの操作を行うクラス。

Types

data class Options(val preferredEncodingId: String? = null)

Subscribe時の設定。

Properties

abstract val contentType: Stream.ContentType

このRoomSubscriptionのStream.ContentType。

abstract val id: String

このRoomSubscriptionのID。

onCanceledHandler

abstract var ~~onCanceledHandler~~: () -> Unit?

subscribeがキャンセルされた際に発火するハンドラ。

onConnectionStateChangedHandler

abstract var onConnectionStateChangedHandler: (state: String) -> Unit?

メディア通信の状態が変化した際に発火するハンドラ。

onStreamAttachedHandler

abstract var onStreamAttachedHandler: (stream: RemoteStream) -> Unit?

RemoteStreamが付与された際に発火するハンドラ。

preferredEncodingId

abstract val preferredEncodingId: String

このRoomSubscriptionの優先エンコーディングID。

abstract val publication: RoomPublication

このRoomPublicationに対するRoomPublication。

abstract val room: Room

このRoomSubscriptionが所属するRoom。

abstract val state: Subscription.State

このRoomSubscriptionの状態。

abstract val stream: RemoteStream?

このRoomSubscriptionのStream。 LocalRoomMember.subscribeの返り値でSubscriptionを入手した場合、入手時点で値がsetされています。その他、イベントの発火によってSubscriptionを取得した場合、まだ値がsetされていない可能性があります。

abstract val subscriber: RoomMember?

このRoomSubscriptionのSubscriber。

Functions

abstract suspend fun ~~cancel~~(): Boolean

publishを中止します。 onCanceledHandlerが発火します。

changePreferredEncoding

abstract suspend fun changePreferredEncoding(preferredEncodingId: String): Boolean

subscribeを中止します。

abstract fun ~~getStats~~(): WebRTCStats?