Package-level declarations

Types

Link copied to clipboard
class ConfigLayout(val type: ConfigLayoutGrid? = null, val priority: ConfigLayoutPriority? = null, val gridSize: Int? = null)

How participants are arranged in a recording, HLS stream or livestream. A field left null takes the server's default.

Link copied to clipboard

The arrangement of a ConfigLayout.

Link copied to clipboard

Who a ConfigLayout puts in the main spot.

Link copied to clipboard

Whether a recording or HLS stream carries video.

Link copied to clipboard

The output orientation of a recording or HLS stream.

Link copied to clipboard

The output quality of a recording or HLS stream.

Link copied to clipboard

The background theme of a recording, HLS stream or livestream.

Link copied to clipboard
class HLSConfig(val layout: ConfigLayout? = null, val theme: ConfigTheme? = null, val mode: ConfigMode? = null, val quality: ConfigQuality? = null, val orientation: ConfigOrientation? = null)

How an HLS stream looks, for Room.startHLS. A field left null takes the server's default.

Link copied to clipboard
class HLSUrl

The URLs of a playable HLS stream, delivered with HLSState.HLS_PLAYABLE.

Link copied to clipboard
class LivestreamConfig(val layout: ConfigLayout? = null, val theme: ConfigTheme? = null, val recording: LivestreamRecordingConfig? = null)

How an RTMP livestream looks, for Room.startLivestream. A field left null takes the server's default.

Link copied to clipboard
class LivestreamOutput(var url: String, var streamKey: String)

One RTMP destination for Room.startLivestream. Pass one per platform you want to stream to.

Link copied to clipboard

Whether a livestream is recorded as well, for LivestreamConfig.

Link copied to clipboard

Tells you where a history batch sits in the replay, delivered alongside it on PubSubMessageListener.onOldMessagesReceived.

Link copied to clipboard
class PubSubMessageDropInfo(val droppedCount: Int)

How much was lost, delivered on PubSubMessageListener.onMessageDrop. It reports only the topic that listener subscribed to.

Link copied to clipboard
class PubSubPublishOptions(val persist: Boolean = false, val sendOnly: Array<String>? = null)

Decides who receives a message and whether late joiners still see it. Pass one to Room.PubSub.publish; passing none broadcasts the message to every subscriber and keeps nothing.

Link copied to clipboard
class PubSubSubscribeOptions(val oldMessageLimit: Int? = null, val realtimeOverflow: RealtimeOverflow = RealtimeOverflow.QUEUE, val maxQueue: Int? = null, val newMessageLimit: Int? = null)

Bounds how much history a subscription replays and how fast live messages reach it. Pass one to Room.PubSub.subscribe; passing none replays the whole history at the server's own pace.

Link copied to clipboard

Policy for live pubsub messages that arrive faster than they can be delivered; set on PubSubSubscribeOptions.realtimeOverflow.

Link copied to clipboard
class RecordingConfig(val layout: ConfigLayout? = null, val theme: ConfigTheme? = null, val mode: ConfigMode? = null, val quality: ConfigQuality? = null, val orientation: ConfigOrientation? = null)

How a cloud recording looks, for Room.startRecording. A field left null takes the server's default.

Link copied to clipboard
class VideoEffectsConfig(val pipeline: VideoEffectsConfig.Pipeline = Pipeline.LEGACY, val framing: VideoEffectsConfig.Framing = Framing(), val lighting: VideoEffectsConfig.Lighting = Lighting(), val style: VideoEffectsConfig.Style = Style(), val filter: VideoEffectsConfig.Filter = Filter(), val extra: Map<String, Any> = emptyMap())

Turns camera effects on: auto-framing, low-light correction, a stylised look and a colour grade.