shared/com.mediasfu.sdk.consumers.socket_receive_methods

Package-level declarations

Types

data class CreateDeviceClientOptions(val rtpCapabilities: Any?)

Options for creating a device client.

data class JoinConRoomOptions(val socket: SocketManager, val roomName: String, val islevel: String, val member: String, val sec: String, val apiUserName: String)

Options for joining a consumption room.

JoinConsumeRoomOptions

data class JoinConsumeRoomOptions(val remoteSock: SocketManager, val apiToken: String, val apiUserName: String, val parameters: JoinConsumeRoomParameters)

Options for the joinConsumeRoom function.

JoinConsumeRoomParameters

interface JoinConsumeRoomParameters

Parameters required by the joinConsumeRoom function.

NewPipeProducerOptions

data class NewPipeProducerOptions(val producerId: String, val islevel: String, val nsock: SocketManager, val parameters: NewPipeProducerParameters)

Options for the newPipeProducer function.

NewPipeProducerParameters

interface NewPipeProducerParameters : SignalNewConsumerTransportParameters

Parameters for the newPipeProducer function.

ProducerClosedOptions

data class ProducerClosedOptions(val remoteProducerId: String, val parameters: ProducerClosedParameters)

Options for the producerClosed function.

ProducerClosedParameters

interface ProducerClosedParameters

Parameters for the producerClosed function.

ReceiveAllPipedTransportsOptions

data class ReceiveAllPipedTransportsOptions(val nsock: SocketManager, val parameters: Any)

Options for ReceiveAllPipedTransports.

ResponseJoinRoom

data class ResponseJoinRoom(val success: Boolean = false, val rtpCapabilities: Any? = null)

Response from joining a room.

Functions

joinConRoom

suspend fun joinConRoom(options: JoinConRoomOptions): ResponseJoinRoom

Joins a consumption room using the provided socket connection.

joinConsumeRoom

suspend fun joinConsumeRoom(options: JoinConsumeRoomOptions): ResponseJoinRoom

Joins a consumption room, initiates a media Device if necessary, and sets up piped transports for streaming.

newPipeProducer

suspend fun newPipeProducer(options: NewPipeProducerOptions)

Initiates a new pipe producer by signaling a new consumer transport and updating display settings.

producerClosed

suspend fun producerClosed(options: ProducerClosedOptions)

Handles the closure of a producer identified by its remote producer ID. This function updates the consumer transports and triggers close-and-resize operations.