lib/live.hms.video.sdk.models

Package-level declarations

Types

enum DegradationPreference : Enum<DegradationPreference>

data class FrameworkInfo(val framework: AgentType, val frameworkSdkVersion: String? = null, val frameworkVersion: String? = null, val isPrebuilt: Boolean)

HMSBrowserRecordingState

data class HMSBrowserRecordingState(val running: Boolean, val error: HMSException?, val startedAt: Long?, val stoppedAt: Long?, val initialising: Boolean = false, val state: HMSRecordingState)

Details on whether the room is being recorded by a browser client bot.

HMSConfig

data class HMSConfig @JvmOverloads constructor(val userName: String, val authtoken: String, var metadata: String = "", var captureNetworkQualityInPreview: Boolean = false, val initEndpoint: String = cDefaultInitEndpoint)

Information about which call to join, under what name and the authentication for it.

HMSHLSConfig

data class HMSHLSConfig(val meetingURLVariants: List<HMSHLSMeetingURLVariant>? = null, val hmsHlsRecordingConfig: HMSHlsRecordingConfig? = null)

Configuration for HLS streaming. Information about which meeting url to stream and whether to start or stop.

HMSHLSMeetingURLVariant

data class HMSHLSMeetingURLVariant(val meetingUrl: String? = null, val metadata: String = "")

HMSHLSPlaylistType

enum HMSHLSPlaylistType : Enum<HMSHLSPlaylistType>

HMSHlsRecordingConfig

data class HMSHlsRecordingConfig(val singleFilePerLayer: Boolean, val videoOnDemand: Boolean)

Configuration for recording HLS.

HmsHlsRecordingState

data class HmsHlsRecordingState(val running: Boolean?, val startedAt: Long?, val hlsRecordingConfig: HMSHlsRecordingConfig?, val error: HMSException?, val state: HMSRecordingState)

HMSHLSStreamingState

data class HMSHLSStreamingState(val running: Boolean, val variants: ArrayList<HMSHLSVariant>?, val error: HMSException?, val state: HMSStreamingState)

HMSHLSTimedMetadata

data class HMSHLSTimedMetadata(val payload: String, val duration: Long)

HMSHLSVariant

data class HMSHLSVariant(val hlsStreamUrl: String?, val meetingUrl: String?, val metadata: String?, val startedAt: Long?, val updatedAt: Long?, state: BeamStreamingStates?, val playlistType: HMSHLSPlaylistType?)

HMSLocalPeer

class HMSLocalPeer : HMSPeer

HMSMessage

data class HMSMessage

Class for retrieving the attributes of a group(HMSRole based ) or peer-to-peer message

HMSMessageRecipient

class HMSMessageRecipient

Class to denote the intended recipient(s) of the message

HMSMessageSendResponse

data class HMSMessageSendResponse(val timestamp: Long, val messageId: String? = "")

HMSPeer

abstract class HMSPeer

HMSPeer is the object returned by 100ms SDKs that contains all information about a user.

HMSPeerType

enum HMSPeerType : Enum<HMSPeerType>

HMSRecordingConfig

data class HMSRecordingConfig(val meetingUrl: String? = null, val rtmpUrls: List<String>, val record: Boolean, val resolution: HMSRtmpVideoResolution? = null)

Configuration for rtmp recording. Information about what to record/stream, where to broadcast and whether to start or stop.

HMSRemotePeer

class HMSRemotePeer : HMSPeer

HMSRemovedFromRoom

data class HMSRemovedFromRoom(val reason: String, val peerWhoRemoved: HMSPeer?, val roomWasEnded: Boolean)

The notification that will be sent when someone is forced removed from the room by another person.

HMSRoleChangeRequest

data class HMSRoleChangeRequest

HMSRoom

data class HMSRoom

A room is returned on successful connection. This contains references to HMSPeer, HMSTrack and everything you need to render a live a/v app

HMSRtmpStreamingState

data class HMSRtmpStreamingState(val running: Boolean, val error: HMSException?, val startedAt: Long?, val stoppedAt: Long?, var state: HMSStreamingState)

Details on the RTMPs streaming state.

HMSServerRecordingState

data class HMSServerRecordingState(val running: Boolean, val error: HMSException?, val startedAt: Long?, val state: HMSRecordingState)

Details on whether the room is being recorded by the server.

HMSSpeaker

data class HMSSpeaker

Layer

enum Layer : Enum<Layer>

PeerListIterator

class PeerListIterator(peerListIteratorOptions: PeerListIteratorOptions?)

PeerListIteratorOptions

data class PeerListIteratorOptions(val byGroupName: String? = null, val byRoleName: String? = null, val byPeerIds: ArrayList<String>? = null, val limit: Int = 10)