Prepare the track for subscription. This is an optional state that instructs the SDK to perform any necessary setup steps, so that the track can be subscribed to quickly when it's needed.

Subscribed

@Serializable

class Subscribed<T> : Update<T> , SubscriptionStateUpdate

Subscribe to this track.

SubscriptionProfile

@Serializable(with = ProfileSerializer::class)

data class SubscriptionProfile(id: String?) : Update<SubscriptionProfile>

SubscriptionProfileSettings

typealias SubscriptionProfileSettings = MediaSubscriptionSettings

The subscription settings that dictate how to receive media from all the remote participants with this particular profile.

SubscriptionProfileSettingsUpdate

typealias SubscriptionProfileSettingsUpdate = MediaSubscriptionSettingsUpdate

Update to subscription profile settings.

SubscriptionSettings

@Serializable

data class SubscriptionSettings

The subscription settings that dictate how to receive media from a remote participant.

SubscriptionSettingsUpdate

@Serializable

data class SubscriptionSettingsUpdate(profile: Update<SubscriptionProfile>?, media: Update<MediaSubscriptionSettingsUpdate>?) : Update<SubscriptionSettingsUpdate> , SubscriptionStateUpdate

Update to subscription settings.

SubscriptionState

@Serializable

enum SubscriptionState : Enum<SubscriptionState>

The state of a given subscription.

SubscriptionStateUpdate

interface SubscriptionStateUpdate

The state of a given subscription.

Unsubscribed

@Serializable

class Unsubscribed<T> : Update<T> , SubscriptionStateUpdate

Unsubscribe from this track.

VideoReceiveSettings

@Serializable

data class VideoReceiveSettings

Receive settings for video tracks.

VideoReceiveSettingsMaxQuality

@Serializable

enum VideoReceiveSettingsMaxQuality : Enum<VideoReceiveSettingsMaxQuality>

VideoReceiveSettingsUpdate

@Serializable

data class VideoReceiveSettingsUpdate(maxQuality: Update<VideoMaxQualityUpdate>?) : Update<VideoReceiveSettingsUpdate>

Update for receive settings for video tracks.

VideoSubscriptionSettings

@Serializable

data class VideoSubscriptionSettings

Subscription settings for video medias, containing the desired subscription state and the settings with which the media will be received.

VideoSubscriptionSettingsUpdate

@Serializable

data class VideoSubscriptionSettingsUpdate(subscriptionState: Update<SubscriptionState>?, receiveSettings: Update<VideoReceiveSettingsUpdate>?) : Update<VideoSubscriptionSettingsUpdate>

Update for subscription settings for video medias, containing the desired subscription state and the settings with which the media will be received.

Properties

base

val <SubscriptionProfile> SubscriptionProfile.base: SubscriptionProfile