Publication

interface Publication

Publicationの操作を行うクラス。

Types

Link copied to clipboard
data class Options(val metadata: String? = null, val codecCapabilities: List<Codec>? = null, val encodings: List<Encoding>? = null, val isEnabled: Boolean? = null)

Publish時の設定。

Link copied to clipboard

Publicationの状態。 enable/disableは有効/無効。CANCELEDはPublish終了後の状態です。

Properties

Link copied to clipboard
abstract val channel: Channel

このPublicationが所属するChannel

Link copied to clipboard

このPublicationのコーデック一覧。

Link copied to clipboard

このPublicationのContentType

Link copied to clipboard
abstract val encodings: List<Encoding>

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

Link copied to clipboard
abstract val id: String

このPublicationのID。

Link copied to clipboard
abstract val metadata: String

このPublicationのMetadata。

Link copied to clipboard
abstract var onConnectionStateChangedHandler: (state: String) -> Unit?

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

Link copied to clipboard
abstract var onDisabledHandler: () -> Unit?

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

Link copied to clipboard
abstract var onEnabledHandler: () -> Unit?

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

Link copied to clipboard
abstract var onMetadataUpdatedHandler: (metadata: String) -> Unit?

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

Link copied to clipboard
abstract var onSubscribedHandler: (subscription: Subscription) -> Unit?

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

Link copied to clipboard

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

Link copied to clipboard
abstract var onUnpublishedHandler: () -> Unit?

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

Link copied to clipboard
abstract var onUnsubscribedHandler: (subscription: Subscription) -> Unit?

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

Link copied to clipboard
abstract val origin: Publication?

このPublicationのOrigin。

Link copied to clipboard
abstract val publisher: Member

このPublicationのPublisher。

Link copied to clipboard
abstract val state: Publication.State

このPublicationの状態。

Link copied to clipboard
abstract val stream: Stream?

このPublicationのStream。

Link copied to clipboard

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

Functions

Link copied to clipboard
abstract suspend fun cancel(): Boolean

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

Link copied to clipboard
abstract suspend fun disable(): Boolean

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

Link copied to clipboard
abstract suspend fun enable(): Boolean

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

Link copied to clipboard
abstract fun getStats(remoteMemberId: String): WebRTCStats?
Link copied to clipboard
abstract fun replaceStream(stream: LocalStream): Boolean

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

Link copied to clipboard
abstract fun updateEncodings(encodings: List<Encoding>): Boolean

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

Link copied to clipboard
abstract suspend fun updateMetadata(metadata: String): Boolean

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