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

Room

abstract class Room

Roomの操作を行うクラス。

Inheritors

P2PRoom

SFURoom

Types

Type

enum Type : Enum<Room.Type>

Roomの種別。

Properties

val id: String

このRoomのID。

localRoomMember

val localRoomMember: LocalRoomMember?

このRoom内にこのSDKから参加しているLocalRoomMember。

members

val members: List<RoomMember>

このRoom内のRoomMember一覧。

metadata

val metadata: String?

このRoomのMetadata。

name

val name: String?

このRoomのname。

onClosedHandler

var onClosedHandler: () -> Unit?

このRoomが閉じられた時に発火するハンドラ。

onErrorHandler

var onErrorHandler: (Exception) -> Unit?

各種イベントでエラーが起きた時に発火するハンドラ。

onMemberJoinedHandler

var onMemberJoinedHandler: (member: RoomMember) -> Unit?

このRoomにMemberが入室した時に発火するハンドラ。

onMemberLeftHandler

var onMemberLeftHandler: (member: RoomMember) -> Unit?

このRoomからMemberが退出した時に発火するハンドラ。

onMemberListChangedHandler

var onMemberListChangedHandler: () -> Unit?

このRoom内のMemberの数が変更された時に発火するハンドラ。

onMemberMetadataUpdatedHandler

var onMemberMetadataUpdatedHandler: (member: RoomMember, metadata: String) -> Unit?

このRoom内のMemberのMetadataが更新された時に発火するハンドラ。

onMetadataUpdatedHandler

var onMetadataUpdatedHandler: (metadata: String) -> Unit?

このRoomのMetadataが更新された時に発火するハンドラ。

onPublicationDisabledHandler

var onPublicationDisabledHandler: (publication: RoomPublication) -> Unit?

PublicationがDisableになった時に発火するハンドラ。

onPublicationEnabledHandler

var onPublicationEnabledHandler: (publication: RoomPublication) -> Unit?

このRoom内のPublicationがEnableになった時に発火するハンドラ。

onPublicationListChangedHandler

var onPublicationListChangedHandler: () -> Unit?

このRoom内のPublicationの数が変更された時に発火するハンドラ。

onPublicationMetadataUpdatedHandler

var onPublicationMetadataUpdatedHandler: (publication: RoomPublication, metadata: String) -> Unit?

PublicationのMetadataが更新された時に発火するハンドラ。

onPublicationSubscribedHandler

var onPublicationSubscribedHandler: (subscription: RoomSubscription) -> Unit?

StreamがSubscribeされた時に発火するハンドラ。 Subscriptionにはまだstreamがsetされていない可能性があります。

onPublicationUnsubscribedHandler

var onPublicationUnsubscribedHandler: (subscription: RoomSubscription) -> Unit?

StreamがUnsubscribeされた時に発火するハンドラ。

onStreamPublishedHandler

var onStreamPublishedHandler: (publication: RoomPublication) -> Unit?

このRoomにStreamがPublishされた時に発火するハンドラ。

onStreamUnpublishedHandler

var onStreamUnpublishedHandler: (publication: RoomPublication) -> Unit?

このRoomにStreamがUnpublishされた時に発火するハンドラ。

onSubscriptionListChangedHandler

var onSubscriptionListChangedHandler: () -> Unit?

SubscriptionのList変わった時に発火するハンドラ。

publications

val publications: List<RoomPublication>

このRoom内のPublicationの一覧。

state

val state: Channel.State

このRoomの状態。

subscriptions

val subscriptions: List<RoomSubscription>

このRoom内のSubscriptionの一覧。

type

abstract val type: Room.Type

このRoomの種別。

Functions

suspend fun close(): Boolean

Roomを閉じます。 onClosedHandlerが発火します。

dispose

fun dispose()

Roomを破棄します。破棄されたRoomではイベントが発火しなくなります。またRoom内のRoomMember、RoomPublication、RoomSubscriptionも破棄されます。

join

abstract suspend fun join(memberInit: RoomMember.Init): LocalRoomMember?

Roomに入室します。 onMemberJoinedHandlerが発火します。

leave

suspend fun leave(member: RoomMember): Boolean

指定したメンバーをRoomから退室させます。 onMemberLeftHandlerが発火します。

updateMetadata

suspend fun updateMetadata(metadata: String): Boolean

metadataを更新します。 onMetadataUpdatedHandlerが発火します。