shared/com.mediasfu.sdk.consumers

Package-level declarations

Types

data class AddVideosGridOptions(val mainGridStreams: List<Stream>, val altGridStreams: List<Stream>, val numRows: Int, val numCols: Int, val actualRows: Int, val lastRowCols: Int, val removeAltGrid: Boolean, val parameters: AddVideosGridParameters)

Options for adding participants to the video grid.

AddVideosGridParameters

interface AddVideosGridParameters

Parameters required by addVideosGrid to keep UI state in sync with the engine.

AudioCardRenderInput

data class AudioCardRenderInput(val stream: Stream, val participant: Participant, val displayName: String, val eventType: EventType, val parameters: AddVideosGridParameters)

Context passed to custom audio card builders.

AudioDecibels

data class AudioDecibels(val name: String, var averageLoudness: Double)

Represents audio decibel information for a participant.

AutoAdjustException

class AutoAdjustException(message: String, cause: Throwable? = null) : Exception

Exception thrown when auto adjust fails.

AutoAdjustOptions

data class AutoAdjustOptions(val n: Int, val eventType: Any?, val shareScreenStarted: Boolean, val shared: Boolean)

Options for adjusting layout ratios based on active participants and event context.

CalculateRowsAndColumnsException

class CalculateRowsAndColumnsException(message: String, cause: Throwable? = null) : Exception

Exception thrown when calculating rows and columns fails.

CalculateRowsAndColumnsOptions

data class CalculateRowsAndColumnsOptions(val n: Int)

Options for calculating the number of rows and columns in a grid layout.

ChangeVidsOptions

data class ChangeVidsOptions(val screenChanged: Boolean = false, val parameters: ChangeVidsParameters)

Options for changing video streams.

ChangeVidsParameters

interface ChangeVidsParameters : DispStreamsParameters, ProcessConsumerTransportsParameters, ResumePauseStreamsParameters, ResumePauseAudioStreamsParameters

Parameters used for changing video streams based on various conditions.

CheckGridOptions

data class CheckGridOptions(val rows: Int, val cols: Int, val actives: Int)

Options for checking the grid configuration.

CheckGridResult

data class CheckGridResult(val removeAltGrid: Boolean, val numToAdd: Int, val numRows: Int, val numCols: Int, val remainingVideos: Int, val actualRows: Int, val lastRowCols: Int)

Result of grid configuration check.

CheckPermissionException

class CheckPermissionException(message: String, cause: Throwable? = null) : Exception

Exception thrown when checking permission fails.

CheckPermissionOptions

data class CheckPermissionOptions(val audioSetting: String, val videoSetting: String, val screenshareSetting: String, val chatSetting: String, val permissionType: String)

Options for checking permission based on specific settings.

CheckPermissionType

typealias CheckPermissionType = suspend (CheckPermissionOptions) -> Int

CheckScreenShareOptions

data class CheckScreenShareOptions(val parameters: CheckScreenShareParameters)

Options for the checkScreenShare function.

CheckScreenShareParameters

interface CheckScreenShareParameters : StopShareScreenParameters, RequestScreenShareParameters

CheckScreenShareType

fun interface CheckScreenShareType

CloseAndResizeOptions

data class CloseAndResizeOptions(val producerId: String, val kind: String, val parameters: CloseAndResizeParameters)

Options for the closeAndResize function.

CloseAndResizeParameters

interface CloseAndResizeParameters : ReorderStreamsParameters, PrepopulateUserMediaParameters, RePortParameters

Parameters for the closeAndResize function.

CompareActiveNamesOptions

data class CompareActiveNamesOptions(val restart: Boolean = false, val parameters: CompareActiveNamesParameters)

Options for the compareActiveNames function.

CompareActiveNamesParameters

interface CompareActiveNamesParameters : TriggerParameters

Parameters required for comparing active names.

CompareScreenStatesOptions

data class CompareScreenStatesOptions(val restart: Boolean = false, val parameters: CompareScreenStatesParameters)

Options for comparing screen states.

CompareScreenStatesParameters

interface CompareScreenStatesParameters : TriggerParameters

Parameters for comparing screen states.

ComponentSizes

data class ComponentSizes(val mainWidth: Double, val mainHeight: Double, val otherWidth: Double, val otherHeight: Double)

Component size configuration.

ConnectIpsException

class ConnectIpsException(message: String, cause: Throwable? = null) : Exception

Exception thrown when connecting to IPs fails.

ConnectIpsOptions

data class ConnectIpsOptions(val consumeSockets: List<Map<String, SocketManager>>, val remIP: List<String>, val apiUserName: String, val apiKey: String? = null, val apiToken: String, val newProducerMethod: suspend (NewPipeProducerOptions) -> Unit? = null, val closedProducerMethod: suspend (ProducerClosedOptions) -> Unit? = null, val joinConsumeRoomMethod: suspend (JoinConsumeRoomOptions) -> Result<Map<String, Any?>>? = null, val parameters: ConnectIpsParameters)

Options for connecting IPs and managing socket connections.

ConnectIpsParameters

interface ConnectIpsParameters

Parameters interface for connecting IPs and managing socket connections.

ConnectIpsResult

data class ConnectIpsResult(val consumeSockets: List<Map<String, SocketManager>>, val roomRecvIPs: List<String>)

Result of connecting to remote IPs.

ConnectLocalIpsException

class ConnectLocalIpsException(message: String, cause: Throwable? = null) : Exception

Exception thrown when connecting to local IPs fails.

ConnectLocalIpsOptions

data class ConnectLocalIpsOptions(val socket: SocketManager?, val newProducerMethod: suspend (LocalNewProducerOptions) -> Unit? = null, val closedProducerMethod: suspend (LocalProducerClosedOptions) -> Unit? = null, val receiveAllPipedTransportsMethod: suspend (ReceiveAllPipedTransportsOptions) -> Unit? = null, val parameters: ConnectLocalIpsParameters)

Options for connecting local IPs and managing socket connections.

ConnectLocalIpsParameters

interface ConnectLocalIpsParameters

Parameters interface for connecting local IPs and managing socket connections.

ConnectRecvTransportOptions

data class ConnectRecvTransportOptions(val consumer: WebRtcConsumer?, val consumerTransport: WebRtcTransport?, val remoteProducerId: String, val serverConsumerTransportId: String, val nsock: SocketManager, val parameters: ConnectRecvTransportParameters)

Options for connecting the receiving transport.

ConnectRecvTransportParameters

interface ConnectRecvTransportParameters

Parameters for connecting the receiving transport.

ConnectSendTransportAudioException

class ConnectSendTransportAudioException(message: String, cause: Throwable? = null) : Exception

Exception thrown when connecting audio send transport fails.

ConnectSendTransportAudioOptions

data class ConnectSendTransportAudioOptions(val stream: MediaStream?, val parameters: ConnectSendTransportAudioParameters, val audioConstraints: Map<String, Any>? = null, val targetOption: String = "all")

Options for connecting audio send transports.

ConnectSendTransportAudioParameters

interface ConnectSendTransportAudioParameters : ResumeSendTransportAudioParameters, CreateSendTransportParameters

Parameters interface for connecting audio send transports.

ConnectSendTransportOptions

data class ConnectSendTransportOptions(val option: String, val parameters: ConnectSendTransportParameters, val audioConstraints: Map<String, Any>? = null, val videoConstraints: Map<String, Any>? = null, val targetOption: String = "all")

Options for connecting send transport.

ConnectSendTransportParameters

interface ConnectSendTransportParameters : ConnectSendTransportAudioParameters, ConnectSendTransportVideoParameters, ConnectSendTransportScreenParameters

ConnectSendTransportScreenException

class ConnectSendTransportScreenException(message: String, cause: Throwable? = null) : Exception

Exception thrown when connecting screen send transport fails.

ConnectSendTransportScreenOptions

data class ConnectSendTransportScreenOptions(val stream: MediaStream?, val parameters: ConnectSendTransportScreenParameters, val targetOption: String = "all")

Options for connecting screen send transports.

ConnectSendTransportScreenParameters

interface ConnectSendTransportScreenParameters : CreateSendTransportParameters

Parameters interface for connecting screen send transports.

ConnectSendTransportVideoException

class ConnectSendTransportVideoException(message: String, cause: Throwable? = null) : Exception

Exception thrown when connecting video send transport fails.

ConnectSendTransportVideoOptions

data class ConnectSendTransportVideoOptions(val videoParams: ProducerOptionsType? = null, val parameters: ConnectSendTransportVideoParameters, val videoConstraints: Map<String, Any>? = null, val targetOption: String = "all")

Options for connecting video send transports.

ConnectSendTransportVideoParameters

interface ConnectSendTransportVideoParameters : ResumeSendTransportVideoParameters, CreateSendTransportParameters

Parameters interface for connecting video send transports.

ConsumeResponse

data class ConsumeResponse(val id: String, val producerId: String, val kind: String, val rtpParameters: Map<String, Any>, val serverConsumerId: String = "")

Response from consume socket event.

ConsumerResumeOptions

data class ConsumerResumeOptions(val stream: MediaStream?, val consumer: WebRtcConsumer?, val kind: String, val remoteProducerId: String, val parameters: ConsumerResumeParameters, val nsock: SocketManager)

Configuration options for the consumerResume function.

ConsumerResumeParameters

interface ConsumerResumeParameters : PrepopulateUserMediaParameters

Parameters for handling the resumption of audio and video streams in a media session.

ConsumerTransportInfo

data class ConsumerTransportInfo(val consumerTransport: WebRtcTransport?, val serverConsumerTransportId: String, val producerId: String, val consumer: WebRtcConsumer?, val socket: SocketManager?)

Consumer transport info for managing receive transports.

ControlMediaAdapter

typealias ControlMediaAdapter = suspend (participant: Participant, mediaType: String) -> Result<Unit>

ControlMediaOptions

data class ControlMediaOptions(val participantId: String, val participantName: String, val type: String, val socket: SocketManager?, val coHostResponsibility: List<CoHostResponsibility>, val participants: List<Participant>, val member: String, val islevel: String, val showAlert: ShowAlert? = null, val coHost: String, val roomName: String)

Options for controlling media in a room.

CreateSendTransportException

class CreateSendTransportException(message: String, cause: Throwable? = null) : Exception

Exception thrown when creating send transport fails.

CreateSendTransportOptions

data class CreateSendTransportOptions(val option: String, val parameters: CreateSendTransportParameters, val audioConstraints: Map<String, Any>? = null, val videoConstraints: Map<String, Any>? = null)

Options for creating WebRTC send transports.

CreateSendTransportParameters

interface CreateSendTransportParameters : SendTransportSessionParameters

Contract describing the mutable parameters required to create WebRTC send transports.

CustomAudioCardBuilder

typealias CustomAudioCardBuilder = (AudioCardRenderInput) -> MediaSfuUIComponent

CustomMiniCardBuilder

typealias CustomMiniCardBuilder = (MiniCardRenderInput) -> MediaSfuUIComponent

CustomVideoCardBuilder

typealias CustomVideoCardBuilder = (VideoCardRenderInput) -> MediaSfuUIComponent

DisconnectSendTransportAudioException

class DisconnectSendTransportAudioException(message: String, cause: Throwable? = null) : Exception

Exception thrown when audio send transport disconnection fails.

DisconnectSendTransportAudioOptions

data class DisconnectSendTransportAudioOptions(val parameters: DisconnectSendTransportAudioParameters)

Options for disconnecting audio send transport.

DisconnectSendTransportAudioParameters

interface DisconnectSendTransportAudioParameters

Parameters interface for disconnecting audio send transport.

DisconnectSendTransportAudioType

typealias DisconnectSendTransportAudioType = suspend (DisconnectSendTransportAudioOptions) -> Unit

DisconnectSendTransportScreenException

class DisconnectSendTransportScreenException(message: String, cause: Throwable? = null) : Exception

Exception thrown when screen send transport disconnection fails.

DisconnectSendTransportScreenOptions

data class DisconnectSendTransportScreenOptions(val parameters: DisconnectSendTransportScreenParameters)

Options for disconnecting screen send transport.

DisconnectSendTransportScreenParameters

interface DisconnectSendTransportScreenParameters

Parameters interface for disconnecting screen send transport.

DisconnectSendTransportVideoException

class DisconnectSendTransportVideoException(message: String, cause: Throwable? = null) : Exception

Exception thrown when video send transport disconnection fails.

DisconnectSendTransportVideoOptions

data class DisconnectSendTransportVideoOptions(val parameters: DisconnectSendTransportVideoParameters)

Options for disconnecting video send transport.

DisconnectSendTransportVideoParameters

interface DisconnectSendTransportVideoParameters

Parameters interface for disconnecting video send transport.

DisconnectSendTransportVideoType

typealias DisconnectSendTransportVideoType = suspend (DisconnectSendTransportVideoOptions) -> Unit

DispStreamsOptions

data class DispStreamsOptions(val lStreams: List<Stream>, val ind: Int, val auto: Boolean = false, val chatSkip: Boolean = false, val forChatCard: Any? = null, val forChatID: Any? = null, val parameters: DispStreamsParameters, val breakRoom: Int = -1, val inBreakRoom: Boolean = false)

Options for displaying streams.

DispStreamsParameters

interface DispStreamsParameters

GeneratePageContentOptions

data class GeneratePageContentOptions(val page: Int, val parameters: GeneratePageContentParameters, val breakRoom: Int = -1, val inBreakRoom: Boolean = false)

Options for generating page content.

GeneratePageContentParameters

interface GeneratePageContentParameters : DispStreamsParameters

Parameters used for generating page content for a specific user interface page.

GetEstimateOptions

data class GetEstimateOptions(val n: Int, val parameters: GetEstimateParameters)

Options for the getEstimate function.

GetEstimateParameters

interface GetEstimateParameters

Parameters interface for calculating grid estimates

GetPipedProducersAltOptions

data class GetPipedProducersAltOptions(val community: Boolean = false, val nsock: SocketManager, val islevel: String, val parameters: GetPipedProducersAltParameters)

Options for retrieving piped producers (alternative version).

GetPipedProducersAltParameters

interface GetPipedProducersAltParameters : SignalNewConsumerTransportParameters

Parameters for getting piped producers (alternative version).

GetProducersPipedOptions

data class GetProducersPipedOptions(val nsock: SocketManager, val islevel: String, val parameters: GetProducersPipedParameters)

Options for retrieving piped producers.

GetProducersPipedParameters

interface GetProducersPipedParameters : SignalNewConsumerTransportParameters

Parameters for getting piped producers.

GetVideosException

class GetVideosException(message: String, cause: Throwable? = null) : Exception

Exception thrown when getting videos fails.

GetVideosOptions

data class GetVideosOptions(val participants: List<Participant>, val allVideoStreams: List<Stream>, val oldAllStreams: List<Stream>, val adminVidID: String? = null, val updateAllVideoStreams: (List<Stream>) -> Unit, val updateOldAllStreams: (List<Stream>) -> Unit)

Options for retrieving and processing video streams.

GridSizes

data class GridSizes(val gridWidth: Int, val gridHeight: Int, val altGridWidth: Int, val altGridHeight: Int)

Grid size configuration.

JoinConsumeRoomOptions

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

Options for joining a consume room.

LocalNewProducerOptions

data class LocalNewProducerOptions(val producerId: String, val islevel: String, val nsock: SocketManager, val parameters: ConnectLocalIpsParameters)

Options for new producer event (local connections).

LocalProducerClosedOptions

data class LocalProducerClosedOptions(val remoteProducerId: String, val parameters: ConnectLocalIpsParameters)

Options for producer closed event (local connections).

Message

data class Message(val sender: String = "", val content: String = "", val timestamp: Long = 0, val group: Boolean = false, val message: String = "")

Data class representing a message.

MiniCardRenderInput

data class MiniCardRenderInput(val stream: Stream?, val participant: Participant, val displayName: String, val showVideo: Boolean, val eventType: EventType, val parameters: AddVideosGridParameters)

Context passed to custom mini-card builders.

MixStreamsException

class MixStreamsException(message: String, cause: Throwable? = null) : Exception

Exception thrown when mixing streams fails.

MixStreamsOptions

data class MixStreamsOptions(val alVideoStreams: List<Stream>, val nonAlVideoStreams: List<Stream>, val refParticipants: List<Participant>)

Options for mixing video and audio streams with participants.

NewPipeProducerOptions

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

Options for handling new pipe producer events.

OnScreenChangesOptions

data class OnScreenChangesOptions(val changed: Boolean = false, val parameters: OnScreenChangesParameters)

Options for handling screen changes.

OnScreenChangesParameters

interface OnScreenChangesParameters : ReorderStreamsParameters

Parameters for handling screen changes.

PrepopulateUserMediaOptions

data class PrepopulateUserMediaOptions(val name: String, val parameters: PrepopulateUserMediaParameters)

Configuration options for the prepopulateUserMedia function.

PrepopulateUserMediaParameters

interface PrepopulateUserMediaParameters

Parameters for the prepopulateUserMedia function.

ProcessConsumerTransportsAudioOptions

data class ProcessConsumerTransportsAudioOptions(val consumerTransports: List<ConsumerTransportInfo>, val lStreams: List<Stream>, val parameters: ProcessConsumerTransportsAudioParameters)

Options for processing consumer transports audio.

ProcessConsumerTransportsAudioParameters

interface ProcessConsumerTransportsAudioParameters

Parameters for processing consumer transports audio.

ProcessConsumerTransportsException

class ProcessConsumerTransportsException(message: String, cause: Throwable? = null) : Exception

Exception thrown when an error occurs during processing of consumer transports.

ProcessConsumerTransportsOptions

data class ProcessConsumerTransportsOptions(val consumerTransports: List<ConsumerTransportInfo>, val lStreams_: List<Stream>, val parameters: ProcessConsumerTransportsParameters)

Options for processing consumer transports.

ProcessConsumerTransportsParameters

interface ProcessConsumerTransportsParameters

Parameters interface for processing consumer transports.

ProducerClosedOptions

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

Options for handling producer closed events.

ReadjustOptions

data class ReadjustOptions(val n: Int, val state: Int, val parameters: ReadjustParameters)

Options for the readjust function.

ReadjustParameters

interface ReadjustParameters : PrepopulateUserMediaParameters

Parameters for readjusting the layout.

ReceiveAllPipedTransportsOptions

data class ReceiveAllPipedTransportsOptions(val community: Boolean, val nsock: SocketManager, val parameters: ConnectLocalIpsParameters)

Options for receiving all piped transports.

ReceiveAllPipedTransportsParameters

interface ReceiveAllPipedTransportsParameters : GetPipedProducersAltParameters

Parameters for receiving all piped transports.

ReceiveRoomMessagesOptions

data class ReceiveRoomMessagesOptions(val socket: SocketManager?, val roomName: String, val updateMessages: (List<Message>) -> Unit)

Options for receiving room messages.

ReorderStreamsException

class ReorderStreamsException(message: String, cause: Throwable? = null) : Exception

Exception thrown when reordering streams fails.

ReorderStreamsOptions

data class ReorderStreamsOptions(val add: Boolean, val screenChanged: Boolean, val parameters: ReorderStreamsParameters, val streams: List<Stream> = emptyList())

Options for reordering streams.

ReorderStreamsParameters

interface ReorderStreamsParameters

Parameters interface for reordering streams.

RePortOptions

data class RePortOptions(val restart: Boolean = false, val parameters: RePortParameters)

Options for the rePort function.

RePortParameters

interface RePortParameters : TriggerParameters, CompareScreenStatesParameters, CompareActiveNamesParameters

Parameters for re-porting screen states and active names.

RePortType

typealias RePortType = suspend (RePortOptions) -> Unit

RequestPermissionAudioType

typealias RequestPermissionAudioType = suspend () -> Boolean?

RequestPermissionCameraType

typealias RequestPermissionCameraType = suspend () -> Boolean

Parameters for switching user video device (alternative implementation).

RequestScreenCapturePermissionType

typealias RequestScreenCapturePermissionType = suspend () -> Map<String, Any?>?

Callback type for requesting screen capture permission. Returns a Map containing "resultCode" (Int) and "data" (platform Intent) on success, or null if permission was denied or not available.

RequestScreenShareOptions

data class RequestScreenShareOptions(val parameters: CheckScreenShareParameters)

Options for requesting screen sharing.

RequestScreenShareParameters

interface RequestScreenShareParameters

Parameters required for requesting screen sharing.

RequestScreenShareType

fun interface RequestScreenShareType

ResumePauseAudioStreamsOptions

data class ResumePauseAudioStreamsOptions(val breakRoom: Int? = null, val inBreakRoom: Boolean? = null, val parameters: ResumePauseAudioStreamsParameters)

Options for resuming/pausing audio streams.

ResumePauseAudioStreamsParameters

interface ResumePauseAudioStreamsParameters : ProcessConsumerTransportsAudioParameters

Parameters for resuming/pausing audio streams based on breakout rooms.

ResumePauseStreamsException

class ResumePauseStreamsException(message: String, cause: Throwable? = null) : Exception

Exception thrown when resume/pause streams fails.

ResumePauseStreamsOptions

data class ResumePauseStreamsOptions(val parameters: ResumePauseStreamsParameters, val socket: SocketManager? = null)

Options for resuming and pausing streams.

ResumePauseStreamsParameters

interface ResumePauseStreamsParameters

Parameters interface for resuming and pausing streams.

ResumeSendTransportAudioOptions

data class ResumeSendTransportAudioOptions(val parameters: ResumeSendTransportAudioParameters)

Options for resuming send transport audio.

ResumeSendTransportAudioParameters

interface ResumeSendTransportAudioParameters : PrepopulateUserMediaParameters

Parameters for resuming send transport audio.

ResumeSendTransportAudioType

typealias ResumeSendTransportAudioType = suspend (ResumeSendTransportAudioOptions) -> Unit

ResumeSendTransportVideoOptions

data class ResumeSendTransportVideoOptions(val parameters: ResumeSendTransportVideoParameters)

Options for resuming send transport video.

ResumeSendTransportVideoParameters

interface ResumeSendTransportVideoParameters : PrepopulateUserMediaParameters

Parameters for resuming send transport video.

ReUpdateInterOptions

data class ReUpdateInterOptions(val name: String, val add: Boolean = false, val force: Boolean = false, val average: Double = 127.0, val parameters: ReUpdateInterParameters)

Options for re-updating interactions.

ReUpdateInterParameters

interface ReUpdateInterParameters : OnScreenChangesParameters, ReorderStreamsParameters

Parameters for re-updating interactions and stream layouts.

ScreenState

data class ScreenState(val mainScreenPerson: String? = null, val mainScreenProducerId: String? = null, val mainScreenFilled: Boolean = false, val adminOnMainScreen: Boolean = false, val mainScreenVidCon: Any? = null, val updateMainWindow: Boolean = false, val mainHeightWidth: Double = 0.0, val isWideScreen: Boolean = false, val localStreamVideo: Any? = null)

Represents the state of a screen/participant.

SendTransportSessionParameters

interface SendTransportSessionParameters

Shared state required by both create/connect transport flows.

SignalNewConsumerTransportException

class SignalNewConsumerTransportException(message: String, cause: Throwable? = null) : Exception

Custom exception for signal new consumer transport operations.

SignalNewConsumerTransportGetVideosOptions

data class SignalNewConsumerTransportGetVideosOptions(val parameters: SignalNewConsumerTransportParameters)

Options for getting videos in SignalNewConsumerTransport.

SignalNewConsumerTransportOptions

data class SignalNewConsumerTransportOptions(val producerId: String, val islevel: String, val socket: SocketManager, val parameters: SignalNewConsumerTransportParameters)

Options for signaling a new consumer transport.

SignalNewConsumerTransportParameters

interface SignalNewConsumerTransportParameters

Parameters required for signaling a new consumer transport. Includes consumer resume functionality for post-consume flow.

SignalNewConsumerTransportReorderStreamsOptions

data class SignalNewConsumerTransportReorderStreamsOptions(val streams: List<Any>, val parameters: SignalNewConsumerTransportParameters)

Options for reordering streams in SignalNewConsumerTransport.

StartShareScreenException

class StartShareScreenException(message: String, cause: Throwable? = null) : Exception

Exception thrown when starting screen sharing fails.

StartShareScreenOptions

data class StartShareScreenOptions(val parameters: StartShareScreenParameters, val targetWidth: Int? = null, val targetHeight: Int? = null, val mediaProjectionData: Map<String, Any?>? = null)

Options for starting screen sharing.

StartShareScreenParameters

interface StartShareScreenParameters

Parameters interface for starting screen sharing.

StopShareScreenOptions

data class StopShareScreenOptions(val parameters: StopShareScreenParameters)

StopShareScreenParameters

interface StopShareScreenParameters : DisconnectSendTransportScreenParameters, ReorderStreamsParameters, PrepopulateUserMediaParameters

StopShareScreenType

typealias StopShareScreenType = suspend (StopShareScreenOptions) -> Unit

StreamSuccessAudioOptions

data class StreamSuccessAudioOptions(val stream: MediaStream, val parameters: StreamSuccessAudioParameters, val audioConstraints: Map<String, Any>? = null)

Options for stream success audio.

StreamSuccessAudioParameters

interface StreamSuccessAudioParameters : CreateSendTransportParameters, ConnectSendTransportAudioParameters

Parameters for stream success audio handling.

StreamSuccessAudioSwitchOptions

data class StreamSuccessAudioSwitchOptions(val stream: MediaStream, val parameters: StreamSuccessAudioSwitchParameters, val audioConstraints: Map<String, Any>? = null)

Options for stream success audio switch.

StreamSuccessAudioSwitchParameters

interface StreamSuccessAudioSwitchParameters : ConnectSendTransportAudioParameters, PrepopulateUserMediaParameters

Parameters for stream success audio switch handling.

StreamSuccessAudioType

typealias StreamSuccessAudioType = suspend (StreamSuccessAudioOptions) -> Unit

StreamSuccessScreenOptions

data class StreamSuccessScreenOptions(val stream: MediaStream?, val parameters: StreamSuccessScreenParameters)

Options for stream success screen handling.

StreamSuccessScreenParameters

interface StreamSuccessScreenParameters : CreateSendTransportParameters, ConnectSendTransportScreenParameters, DisconnectSendTransportScreenParameters, StopShareScreenParameters

Parameters for stream success screen handling.

StreamSuccessVideoOptions

data class StreamSuccessVideoOptions(val stream: MediaStream?, val parameters: StreamSuccessVideoParameters, val videoConstraints: Map<String, Any>? = null)

Options for stream success video.

StreamSuccessVideoParameters

interface StreamSuccessVideoParameters : CreateSendTransportParameters, ConnectSendTransportVideoParameters, ResumeSendTransportVideoParameters, PrepopulateUserMediaParameters

Parameters for stream success video handling.

StreamSuccessVideoType

typealias StreamSuccessVideoType = suspend (StreamSuccessVideoOptions) -> Unit

SwitchUserAudioOptions

data class SwitchUserAudioOptions(val parameters: SwitchUserAudioParameters, val audioPreference: String, val audioConstraints: Map<String, Any>? = null)

Options for switching user audio device.

SwitchUserAudioParameters

interface SwitchUserAudioParameters : StreamSuccessAudioSwitchParameters

Parameters for switching user audio device.

SwitchUserAudioType

typealias SwitchUserAudioType = suspend (SwitchUserAudioOptions) -> Unit

SwitchUserVideoAltOptions

data class SwitchUserVideoAltOptions(val videoPreference: String, val checkoff: Boolean, val parameters: SwitchUserVideoAltParameters)

Options for switching user video device (alternative method).

SwitchUserVideoAltParameters

interface SwitchUserVideoAltParameters : StreamSuccessVideoParameters

SwitchUserVideoAltType

typealias SwitchUserVideoAltType = suspend (SwitchUserVideoAltOptions) -> Unit

SwitchUserVideoOptions

data class SwitchUserVideoOptions(val videoPreference: String, val checkoff: Boolean = false, val parameters: SwitchUserVideoParameters)

Options for switching user video device.

SwitchUserVideoParameters

interface SwitchUserVideoParameters : StreamSuccessVideoParameters

Parameters for switching user video device.

SwitchUserVideoType

typealias SwitchUserVideoType = suspend (SwitchUserVideoOptions) -> Unit

TriggerException

class TriggerException(message: String, cause: Throwable? = null) : Exception

Exception thrown when trigger fails.

TriggerOptions

data class TriggerOptions(val refActiveNames: List<String>, val parameters: TriggerParameters)

Options for triggering screen updates.

TriggerParameters

interface TriggerParameters

Parameters interface for trigger functionality.

UpdateMiniCardsGridOptions

data class UpdateMiniCardsGridOptions(val rows: Int, val cols: Int, val defal: Boolean, val actualRows: Int)

Grid recalculation payload used when syncing with the Compose display layer.

UpdateParticipantAudioDecibelsOptions

data class UpdateParticipantAudioDecibelsOptions(val name: String, val averageLoudness: Double, val audioDecibels: MutableList<AudioDecibels>, val updateAudioDecibels: (List<AudioDecibels>) -> Unit)

Options for updating the audio decibels of a participant.

UpdateParticipantAudioDecibelsType

typealias UpdateParticipantAudioDecibelsType = (UpdateParticipantAudioDecibelsOptions) -> Unit

Type definition for updating participant audio decibels.

VideoCardRenderInput

data class VideoCardRenderInput(val stream: Stream, val participant: Participant, val displayName: String, val eventType: EventType, val forceFullDisplay: Boolean, val showControls: Boolean, val showInfo: Boolean, val doMirror: Boolean, val parameters: AddVideosGridParameters)

Context passed to custom video card builders.

Functions

addVideosGrid

suspend fun addVideosGrid(options: AddVideosGridOptions)

Adds participants to the video grid layout with 100% parity to the React and Flutter SDKs.

autoAdjust

suspend fun autoAdjust(options: AutoAdjustOptions): Result<List<Int>>

Mirrors the React autoAdjust heuristic with 100% parity. Returns two integers whose sum is 12 representing the split between the primary and secondary grids.

calculateRowsAndColumns

fun calculateRowsAndColumns(options: CalculateRowsAndColumnsOptions): Result<List<Int>>

changeVids

suspend fun changeVids(options: ChangeVidsOptions)

Changes the video streams on the screen based on the provided options and parameters.

checkGrid

fun checkGrid(options: CheckGridOptions): CheckGridResult

Checks the grid configuration and calculates various parameters based on the number of rows, columns, and active elements.

checkPermission

suspend fun checkPermission(options: CheckPermissionOptions): Int

Checks the permission based on the provided settings.

checkScreenShare

suspend fun checkScreenShare(options: CheckScreenShareOptions)

Checks and manages screen sharing status, initiating or stopping screen share actions based on conditions.

closeAndResize

suspend fun closeAndResize(options: CloseAndResizeOptions)

Manages the closing and resizing of streams within a media session, adapting the layout and updating participant and stream information as needed.

compareActiveNames

suspend fun compareActiveNames(options: CompareActiveNamesOptions)

Compares the current activeNames list with the prevActiveNames list and triggers an action if there are any differences.

compareScreenStates

suspend fun compareScreenStates(options: CompareScreenStatesOptions)

Compares the current screenStates list with the prevScreenStates list and triggers actions if there are differences.

connectIps

suspend fun connectIps(options: ConnectIpsOptions): Result<ConnectIpsResult>

Connects to multiple remote IPs to manage socket connections for media consumption.

connectLocalIps

suspend fun connectLocalIps(options: ConnectLocalIpsOptions): Result<Unit>

Connects to a local socket and manages socket events for media consumption.

connectLocalSendTransportAudio

suspend fun connectLocalSendTransportAudio(options: ConnectSendTransportAudioOptions): Result<Unit>

Connects the local send transport for audio by producing audio data.

connectLocalSendTransportScreen

suspend fun connectLocalSendTransportScreen(stream: MediaStream?, parameters: ConnectSendTransportScreenParameters): Result<Unit>

Connects the local send transport for screen sharing by producing screen data.

connectLocalSendTransportVideo

suspend fun connectLocalSendTransportVideo(stream: MediaStream?, track: MediaStreamTrack?, encodings: List<RtpEncodingParameters>, codecOptions: ProducerCodecOptions?, parameters: ConnectSendTransportVideoParameters): Result<Unit>

Connects the local send transport for video by producing video data.

connectRecvTransport

suspend fun connectRecvTransport(options: ConnectRecvTransportOptions)

Establishes a connection for the receiving transport to consume media from a remote producer and resumes the consumer stream.

connectSendTransport

suspend fun connectSendTransport(options: ConnectSendTransportOptions)

Connects send transport for audio, video, or screen based on the specified option.

connectSendTransportAudio

suspend fun connectSendTransportAudio(options: ConnectSendTransportAudioOptions): Result<Unit>

Connects the send transport for audio by producing audio data and updating the local audio producer and transport.

connectSendTransportScreen

suspend fun connectSendTransportScreen(options: ConnectSendTransportScreenOptions): Result<Unit>

Connects the send transport for screen sharing by producing screen data and updating the local screen producer and transport.

connectSendTransportVideo

suspend fun connectSendTransportVideo(options: ConnectSendTransportVideoOptions): Result<Unit>

Connects the send transport for video by producing video data and updating the local video producer and transport.

consumerResume

suspend fun consumerResume(options: ConsumerResumeOptions)

Handles the resumption of a media stream (either audio or video) by managing the socket connections, updating the UI, and reordering streams as necessary.

controlMedia

suspend fun controlMedia(options: ControlMediaOptions)

Controls media for a participant in a room by sending a controlMedia event to the server.

createSendTransport

suspend fun createSendTransport(options: CreateSendTransportOptions): Result<Unit>

Creates a WebRTC send transport for media transmission.

defaultLocalNewProducer

suspend fun defaultLocalNewProducer(options: LocalNewProducerOptions)

Default implementation for handling new producer events (local connections). This is a placeholder that should be replaced with actual implementation.

defaultLocalProducerClosed

suspend fun defaultLocalProducerClosed(options: LocalProducerClosedOptions)

Default implementation for handling producer closed events (local connections). This is a placeholder that should be replaced with actual implementation.

defaultReceiveAllPipedTransports

suspend fun defaultReceiveAllPipedTransports(options: ReceiveAllPipedTransportsOptions)

Default implementation for receiving all piped transports. This is a placeholder that should be replaced with actual implementation.

disconnectLocalSendTransportAudio

suspend fun disconnectLocalSendTransportAudio(options: DisconnectSendTransportAudioOptions): Result<Unit>

Disconnects the local send transport for audio by pausing the local audio producer and notifying the server.

disconnectLocalSendTransportScreen

suspend fun disconnectLocalSendTransportScreen(options: DisconnectSendTransportScreenOptions): Result<Unit>

Disconnects the local send transport for screen sharing by closing the local screen producer and notifying the server.

disconnectLocalSendTransportVideo

suspend fun disconnectLocalSendTransportVideo(options: DisconnectSendTransportVideoOptions): Result<Unit>

Disconnects the local send transport for video by closing the local video producer and notifying the server.

disconnectSendTransportAudio

suspend fun disconnectSendTransportAudio(options: DisconnectSendTransportAudioOptions): Result<Unit>

Disconnects the send transport for audio by pausing the audio producer and notifying the server.

disconnectSendTransportScreen

suspend fun disconnectSendTransportScreen(options: DisconnectSendTransportScreenOptions): Result<Unit>

Disconnects the send transport for screen sharing by closing the screen producer and notifying the server.

disconnectSendTransportVideo

suspend fun disconnectSendTransportVideo(options: DisconnectSendTransportVideoOptions): Result<Unit>

Disconnects the send transport for video by closing the video producer and notifying the server.

dispStreams

suspend fun dispStreams(options: DispStreamsOptions)

Displays streams in the UI based on the provided options using parity logic.

generatePageContent

suspend fun generatePageContent(options: GeneratePageContentOptions)

Generates the content for a specific page based on the provided options.

getEstimate

fun getEstimate(options: GetEstimateOptions): List<Int>

Calculates the optimal grid layout dimensions based on the number of participants and various display parameters.

getPipedProducersAlt

suspend fun getPipedProducersAlt(options: GetPipedProducersAltOptions)

Retrieves piped producers and signals new consumer transport for each retrieved producer.

getProducersPiped

suspend fun getProducersPiped(options: GetProducersPipedOptions)

Retrieves piped producers and signals new consumer transport for each retrieved producer.

getVideos

suspend fun getVideos(options: GetVideosOptions): Result<Unit>

Processes and updates video streams by filtering out the admin's video stream.

hasListener

fun hasListener(socket: SocketManager, eventName: String): Boolean

Checks if a socket has a listener registered for the given event.

mixStreams

suspend fun mixStreams(options: MixStreamsOptions): Result<List<Any>>

Mixes video and audio streams and participants based on specified parameters.

onScreenChanges

suspend fun onScreenChanges(options: OnScreenChangesOptions)

Handles screen changes and adjusts the display settings based on event type and screen sharing status.

prepopulateUserMedia

suspend fun prepopulateUserMedia(options: PrepopulateUserMediaOptions)

Populates the main media grid state based on the media activity of the participant.

processConsumerTransports

suspend fun processConsumerTransports(options: ProcessConsumerTransportsOptions): Result<Unit>

Processes consumer transports to pause or resume video streams based on provided stream lists.

processConsumerTransportsAudio

suspend fun processConsumerTransportsAudio(options: ProcessConsumerTransportsAudioOptions)

Adjusts the audio state of consumer transports based on provided streams.

readjust

suspend fun readjust(options: ReadjustOptions)

Adjusts the layout parameters based on the current state, participant count, and event type.

receiveAllPipedTransportsImpl

suspend fun receiveAllPipedTransportsImpl(nsock: SocketManager, community: Boolean = false, roomName: String, member: String, getPipedProducersAlt: suspend (GetPipedProducersAltOptions) -> Unit)

Receives all piped transports for a specific room and member by requesting piped producers at different levels.

receiveRoomMessages

suspend fun receiveRoomMessages(options: ReceiveRoomMessagesOptions)

Retrieves messages from a specified room using a socket connection.

reorderStreams

suspend fun reorderStreams(options: ReorderStreamsOptions): Result<Unit>

Reorders video streams based on the provided parameters and options.

rePort

suspend fun rePort(options: RePortOptions)

Re-ports the screen states and active names for the main screen in a conference or event session.

requestScreenShareImpl

suspend fun requestScreenShareImpl(socket: SocketManager?, showAlert: (message: String, type: String, duration: Int) -> Unit?, localUIMode: Boolean, targetResolution: String, targetResolutionHost: String, startShareScreen: suspend (Any, Int, Int) -> Unit, parameters: Any)

Internal implementation of requestScreenShare with parameters inline. This is a simplified version that will be replaced with full implementation.

resumeLocalSendTransportAudio

suspend fun resumeLocalSendTransportAudio(options: ResumeSendTransportAudioOptions)

Resumes the local send transport for audio by resuming the local audio producer.

resumeLocalSendTransportVideo

suspend fun resumeLocalSendTransportVideo(options: ResumeSendTransportVideoOptions)

Resumes the local send transport for video by resuming the local video producer if available.

resumePauseAudioStreams

suspend fun resumePauseAudioStreams(options: ResumePauseAudioStreamsOptions)

Resumes or pauses audio streams for participants based on breakout room status and event type.

resumePauseStreams

suspend fun resumePauseStreams(options: ResumePauseStreamsOptions): Result<Unit>

Resumes or pauses video streams based on active participants and display names.

resumeSendTransportAudio

suspend fun resumeSendTransportAudio(options: ResumeSendTransportAudioOptions)

Resumes the send transport for audio and updates the UI and audio producer state accordingly.

resumeSendTransportVideo

suspend fun resumeSendTransportVideo(options: ResumeSendTransportVideoOptions)

Resumes the video send transport and updates related UI state.

reUpdateInter

suspend fun reUpdateInter(options: ReUpdateInterOptions)

Updates the layout or content of the media streams based on user activity, screen share, or conference settings.

signalNewConsumerTransport

suspend fun signalNewConsumerTransport(options: SignalNewConsumerTransportOptions): Result<Unit>

Signals a new consumer transport to start consuming media from a producer.

startShareScreen

suspend fun startShareScreen(options: StartShareScreenOptions): Result<Unit>

Starts the screen sharing process.

stopShareScreen

suspend fun stopShareScreen(options: StopShareScreenOptions)

Stops the screen sharing process and updates various states and UI elements accordingly.

streamSuccessAudio

suspend fun streamSuccessAudio(options: StreamSuccessAudioOptions)

Manages the setup and successful transition of audio streaming.

streamSuccessAudioSwitch

suspend fun streamSuccessAudioSwitch(options: StreamSuccessAudioSwitchOptions)

Manages switching to a new audio stream, updating the audio producer, local streams, and UI state as necessary.

streamSuccessScreen

suspend fun streamSuccessScreen(options: StreamSuccessScreenOptions)

streamSuccessVideo

suspend fun streamSuccessVideo(options: StreamSuccessVideoOptions)

Manages the setup and successful transition of video streaming.

switchUserAudio

suspend fun switchUserAudio(options: SwitchUserAudioOptions)

Switches the user's audio input to the specified device.

switchUserVideo

suspend fun switchUserVideo(options: SwitchUserVideoOptions)

Toggles or switches the video stream based on user preferences and permission checks.

switchUserVideoAlt

suspend fun switchUserVideoAlt(options: SwitchUserVideoAltOptions)

Switches video input devices by facing mode (front/back camera).

trigger

suspend fun trigger(options: TriggerOptions): Result<Unit>

Triggers screen updates and layout adjustments based on active participants. Emits "updateScreenClient" to notify the backend/server about the current layout.

updateMicLevel

fun updateMicLevel(audioProducer: WebRtcProducer?, updateAudioLevel: (Double) -> Unit)

Updates the microphone audio level periodically.

updateMiniCardsGridImpl

suspend fun updateMiniCardsGridImpl(rows: Int, cols: Int, defal: Boolean, actualRows: Int, gridSizes: GridSizes, paginationDirection: String, paginationHeightWidth: Double, doPaginate: Boolean, componentSizes: ComponentSizes, eventType: String, updateGridRows: (Int) -> Unit, updateGridCols: (Int) -> Unit, updateAltGridRows: (Int) -> Unit, updateAltGridCols: (Int) -> Unit, updateGridSizes: (GridSizes) -> Unit)

Internal implementation of updateMiniCardsGrid. This function calculates and updates the grid dimensions for mini cards display.

updateParticipantAudioDecibels

fun updateParticipantAudioDecibels(options: UpdateParticipantAudioDecibelsOptions)

Updates the audio decibels for a participant.