shared/io.dyte.core.socket.events.payloadmodel.outbound

Package-level declarations

Types

@Serializable

data class Codec(var kind: String? = null, var mimeType: String? = null, var payloadType: Int? = null, var clockRate: Int? = null, var channels: Int? = null, var rtcpFeedback: List<CodecRtcpFeedback>? = null, var parameters: CodecParameters? = null, var preferredPayloadType: Int? = null)

CodecParameters

@Serializable

data class CodecParameters(var xGoogleStartBitrate: Int? = null, var apt: Int? = null, var profileId: Int? = null, var packetizationMode: Int? = null, var levelAsymmetryAllowed: Int? = null, var profileLevelId: String? = null)

CodecRtcpFeedback

@Serializable

data class CodecRtcpFeedback(var type: String? = null, var parameter: String? = null)

CreateWebRTCTransportPayloadRequestModel

@Serializable

data class CreateWebRTCTransportPayloadRequestModel(val forceTcp: Boolean, val producing: Boolean, val consuming: Boolean)

request for OutboundMeetingEventType.CREATE_WEB_RTC_TRANSPORT

DtlsParameters

@Serializable

data class DtlsParameters(var fingerprints: List<Fingerprint>? = null, var role: String? = null)

Fingerprint

@Serializable

data class Fingerprint(var algorithm: String? = null, var value: String? = null)

HeaderExtension

@Serializable

data class HeaderExtension(var kind: String? = null, var uri: String? = null, var preferredId: Int? = null, var id: Int? = null, var preferredEncrypt: Boolean? = null, var encrypt: Boolean? = null, var direction: String? = null)

IceCandidate

@Serializable

data class IceCandidate(var foundation: String? = null, var ip: String? = null, var port: Int? = null, var priority: Int? = null, var protocol: String? = null, var type: String? = null, var tcpType: String? = null)

IceParameters

@Serializable

data class IceParameters(var iceLite: Boolean? = null, var password: String? = null, var usernameFragment: String? = null)

JoinRoomPayloadRequestModel

@Serializable

data class JoinRoomPayloadRequestModel(var device: Device? = null, var displayName: String? = null, var rtpCapabilities: RouterCapabilitiesModel? = null, var isLegacy: Boolean = false, var audioMuted: Boolean = false)

request for OutboundMeetingEventType.JOIN_ROOM

RoomState

@Serializable

data class RoomState(val displayTitle: String = "", val peers: List<WebSocketMeetingPeerUser> = emptyList(), val lockedMode: Boolean = false, val roomUUID: String = "", val config: RoomStateConfig = RoomStateConfig(), val plugins: List<RoomStatePlugin> = emptyList(), val roomName: String = "", val currentPeerId: String? = null)

RoomStateAccess

@Serializable

data class RoomStateAccess(val mic: String = "NOT_ALLOWED", val webcam: String = "NOT_ALLOWED", val screenShare: String = "NOT_ALLOWED", val plugins: String = "NOT_ALLOWED")

RoomStateConfig

@Serializable

data class RoomStateConfig(val joinRestrictions: List<String> = emptyList(), val access: RoomStateAccess = RoomStateAccess())

RoomStatePlugin

@Serializable

data class RoomStatePlugin(val id: String, val staggered: Boolean, val enabledBy: String? = null, val stores: List<String>, val aclAccessRemovedUsers: List<String>, val aclAccessGrantedUsers: List<String>, val aclType: String)

RouterCapabilitiesModel

@Serializable

data class RouterCapabilitiesModel(val codecs: List<Codec>? = null, val headerExtensions: List<HeaderExtension>? = null) : BasePayloadModel

response for OutboundMeetingEventType.GET_ROUTER_RTP_CAPABILITIES

WebRtcCreateTransportModel

@Serializable

data class WebRtcCreateTransportModel(var id: String? = null, var iceParameters: IceParameters? = null, var iceCandidates: List<IceCandidate>? = null, var dtlsParameters: DtlsParameters? = null, var producing: Boolean? = null) : BasePayloadModel

response for OutboundMeetingEventType.CREATE_WEB_RTC_TRANSPORT

WebSocketJoinRoomModel

@Serializable

data class WebSocketJoinRoomModel(val waitlisted: Boolean = false, val peers: List<WebSocketMeetingPeerUser> = emptyList(), val waitlistedPeers: List<WebSocketWaitlistedPeer> = emptyList(), val requestToJoinPeersList: List<WebSocketJoinStageRequestedPeer> = emptyList(), val startedAt: String? = null, val pinnedPeerId: String? = null, val stageStatus: WebSocketStageStatus = WebSocketStageStatus.OFF_STAGE) : BasePayloadModel

response for OutboundMeetingEventType.JOIN_ROOM

WebSocketJoinStageRequestedPeer

@Serializable

data class WebSocketJoinStageRequestedPeer(val id: String, val userId: String? = null, val requestToJoinType: WebSocketRequestToJoinType = WebSocketRequestToJoinType.REQUEST_TO_PRESENT, val name: String? = null)

WebSocketRoomStateModel

@Serializable

data class WebSocketRoomStateModel(val roomState: RoomState = RoomState()) : BasePayloadModel

response for OutboundMeetingEventType.GET_ROOM_STATE

WebSocketWaitlistedPeer

@Serializable

data class WebSocketWaitlistedPeer(val id: String, val name: String? = null)