room/com.ntt.skyway.room.member/LocalRoomMember

LocalRoomMember

abstract class LocalRoomMember : RoomMember

LocalRoomMemberの操作を行うクラス。

Inheritors

LocalP2PRoomMember

LocalSFURoomMember

Properties

val id: String

このRoomMemberのID。

metadata

val metadata: String?

このRoomMemberのMetadata。

name

val name: String?

このRoomMemberの名前。

onLeftHandler

var onLeftHandler: () -> Unit?

このRoomMemberが退出した時に発火するハンドラ。

onMetadataUpdatedHandler

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

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

onPublicationListChangedHandler

var onPublicationListChangedHandler: () -> Unit?

このRoomMemberのPublicationの数が変化した時に発火するハンドラ。

onPublicationSubscribedHandler

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

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

onPublicationUnsubscribedHandler

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

PublicationをUnsubscribeした時に発火するハンドラ。

onStreamPublishedHandler

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

StreamをPublishした時に発火するハンドラ。

onStreamUnpublishedHandler

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

StreamをUnpublishした時に発火するハンドラ。

onSubscriptionListChangedHandler

var onSubscriptionListChangedHandler: () -> Unit?

このRoomMemberのSubscriptionの数が変化した時に発火するハンドラ。

publications

val publications: List<RoomPublication>

このRoomMemberのPublication一覧。

room

val room: Room

このRoomMemberが所属するRoom。

side

open override val side: Member.Side

常にMember.Side.LOCALを返します。

state

val state: Member.State

このRoomMemberの状態。

subscriptions

val subscriptions: List<RoomSubscription>

このRoomMemberのSubscription一覧。

Functions

hashCode

open override fun hashCode(): Int

leave

suspend fun leave(): Boolean

Roomから退室します。

publish

open suspend fun publish(localStream: LocalStream, options: RoomPublication.Options? = null): RoomPublication?

LocalStreamをpublishします。既にpublish中のStreamは指定することができません。 Room.onStreamPublishedHandlerが発火します。

suspend fun subscribe(publication: RoomPublication, options: RoomSubscription.Options? = null): RoomSubscription?

publicationをsubscribeします。 Room.onPublicationSubscribedHandlerが発火します。

suspend fun subscribe(publicationId: String, options: RoomSubscription.Options? = null): RoomSubscription?

unpublish

open suspend fun unpublish(publication: RoomPublication): Boolean

LocalStreamをunpublishします。 Room.onStreamUnpublishedHandlerが発火します。

unsubscribe

suspend fun unsubscribe(subscription: Subscription): Boolean

RoomPublicationをsubscribeします。 Room.onPublicationUnsubscribedHandlerが発火します。

suspend fun unsubscribe(subscriptionId: String): Boolean

updateMetadata

suspend fun updateMetadata(metadata: String): Boolean

Metadataを更新します。