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

RoomPublication

RoomPublicationの操作を行うクラス。

Types

data class Options(val metadata: String? = null, val codecCapabilities: List<Codec>? = null, val encodings: List<Encoding>? = null, val isEnabled: Boolean? = null, val maxSubscribers: Int = 10)

Publish時の設定。

Properties

codecCapabilities

val codecCapabilities: List<Codec>

このRoomPublicationが所属するRoom。

contentType

val contentType: Stream.ContentType

このRoomPublicationのStream.ContentType。

encodings

val encodings: List<Encoding>

このRoomPublicationのエンコーディング設定一覧。詳しい設定例については開発者ドキュメントの大規模会議アプリを実装する上での注意点をご覧ください

val id: String

このRoomPublicationのID。

metadata

val metadata: String

このRoomPublicationのMetadata。

onConnectionStateChangedHandler

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

メディア通信の状態が変化した際に発火するハンドラ。 stateは、以下の文字列が渡されます。

onDisabledHandler

var onDisabledHandler: () -> Unit?

このRoomPublicationの通信が一時停止された時に発火するハンドラ。 Publication.disableが実行された時に発火します。

onEnabledHandler

var onEnabledHandler: () -> Unit?

このRoomPublicationの通信が有効になった時に発火するハンドラ。 Publication.enableが実行された時に発火します。

onMetadataUpdatedHandler

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

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

onSubscribedHandler

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

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

onSubscriptionListChangedHandler

var onSubscriptionListChangedHandler: () -> Unit?

このRoomPublicationに対するSubscriptionの数が変更された時に発火するハンドラ。

onUnpublishedHandler

var ~~onUnpublishedHandler~~: () -> Unit?

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

onUnsubscribedHandler

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

このRoomPublicationのUnsubscribeされた時に発火するハンドラ。

publisher

val publisher: RoomMember?

このRoomPublicationのPublisher。

room

val room: Room

このRoomPublicationが所属するRoom。

state

val state: Publication.State

このRoomPublicationの状態。

stream

val stream: Stream?

このRoomPublicationのStream。

subscriptions

val subscriptions: List<RoomSubscription>

このRoomPublicationに対するSubscriptionの一覧。

Functions

cancel

suspend fun ~~cancel~~(): Boolean

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

disable

suspend fun disable(): Boolean

通信を一時停止します。 onDisabledHandlerが発火します。また、入室しているChannelに対してChannel.onPublicationDisabledHandlerが発火します。

enable

suspend fun enable(): Boolean

通信を開始します。disableによって停止していた場合は再開します。 onEnabledHandlerが発火します。また、入室しているChannelに対してChannel.onPublicationEnabledHandlerが発火します。

getStats

fun ~~getStats~~(remoteMemberId: String): WebRTCStats?

hashCode

open override fun hashCode(): Int

replaceStream

fun replaceStream(stream: LocalStream): Boolean

送信するStreamを変更します。

updateEncodings

fun updateEncodings(encodings: List<Encoding>): Boolean

通信に利用するエンコードを変更します。 onEnabledHandlerが発火します。また、入室しているChannelに対してChannel.onPublicationEnabledHandlerが発火します。