shared

shared/com.mediasfu.sdk.methods.stream_methods/ClickVideoParameters

ClickVideoParameters

interface ClickVideoParameters : DisconnectSendTransportVideoParameters, StreamSuccessVideoParameters, ConnectSendTransportParameters

Parameters for ClickVideo function.

Properties

adminOnMainScreen

abstract val adminOnMainScreen: Boolean

adminRestrictSetting

abstract val adminRestrictSetting: Boolean

abstract val allowed: Boolean

allVideoStreams

abstract val allVideoStreams: List<Stream>

annotateScreenStream

abstract val annotateScreenStream: Boolean

abstract val aParams: ProducerOptionsType?

abstract val audioAlreadyOn: Boolean

abstract val audioDecibels: List<AudioDecibels>

abstract val audioOnlyRoom: Boolean

abstract override val audioParams: ProducerOptionsType?

abstract val audioProducer: WebRtcProducer?

abstract val audioSetting: String

abstract val canvasStream: MediaStream?

abstract val chatSetting: String

checkMediaPermission

abstract val checkMediaPermission: Boolean

checkPermission

abstract val checkPermission: CheckPermissionType

connectSendTransportAudio

abstract override val connectSendTransportAudio: suspend (ConnectSendTransportAudioOptions) -> Unit

connectSendTransportScreen

abstract override val connectSendTransportScreen: suspend (ConnectSendTransportScreenOptions) -> Unit

connectSendTransportVideo

abstract override val connectSendTransportVideo: suspend (ConnectSendTransportVideoOptions) -> Unit

createSendTransport

abstract override val createSendTransport: suspend (CreateSendTransportOptions) -> Unit

currentFacingMode

abstract val currentFacingMode: String

abstract val defAudioID: String

abstract val defScreenID: String

abstract val defVideoID: String

abstract val device: WebRtcDevice?

disconnectSendTransportVideo

abstract val disconnectSendTransportVideo: DisconnectSendTransportVideoType

abstract val eventType: EventType

extendedRtpCapabilities

abstract val extendedRtpCapabilities: OrtcUtils.ExtendedRtpCapabilities?

forceFullDisplay

abstract val forceFullDisplay: Boolean

abstract val frameRate: Int

hasCameraPermission

abstract val hasCameraPermission: Boolean

abstract val hostLabel: String

abstract override val islevel: String

abstract val isWideScreen: Boolean

abstract val keepBackground: Boolean

localAudioProducer

abstract val localAudioProducer: WebRtcProducer?

localProducerTransport

abstract override var localProducerTransport: WebRtcTransport?

localScreenProducer

abstract val localScreenProducer: WebRtcProducer?

abstract val localSocket: SocketManager?

abstract override val localStream: MediaStream?

localStreamAudio

abstract override val localStreamAudio: MediaStream?

localStreamScreen

abstract val localStreamScreen: MediaStream?

localStreamVideo

abstract override val localStreamVideo: MediaStream?

localTransportCreated

abstract var localTransportCreated: Boolean

abstract val localUIMode: Boolean

localVideoProducer

abstract val localVideoProducer: WebRtcProducer?

abstract val lockScreen: Boolean

mainHeightWidth

abstract val mainHeightWidth: Double

mainScreenFilled

abstract val mainScreenFilled: Boolean

mainScreenPerson

abstract val mainScreenPerson: String

abstract override val member: String

abstract val micAction: Boolean

abstract val oldAllStreams: List<Stream>

onAutoApplyBackground

open val onAutoApplyBackground: suspend (VirtualBackground, MediaStream) -> Unit?

Callback to automatically apply a saved background when camera turns on. This is called when keepBackground=true and selectedBackground is set. Matches React behavior: when user has a saved background and turns on camera, the background is automatically applied to the new stream.

abstract val params: ProducerOptionsType?

abstract override val participants: List<Participant>

prepopulateUserMedia

abstract val prepopulateUserMedia: suspend (PrepopulateUserMediaOptions) -> Unit

producerTransport

abstract override var producerTransport: WebRtcTransport?

recordingMediaOptions

abstract val recordingMediaOptions: String

abstract val recordPaused: Boolean

abstract val recordResumed: Boolean

abstract val recordStarted: Boolean

abstract val recordStopped: Boolean

remoteScreenStream

abstract val remoteScreenStream: List<Stream>

abstract val reorderStreams: suspend (add: Boolean, screenChanged: Boolean) -> Unit

requestPermissionCamera

abstract val requestPermissionCamera: RequestPermissionCameraType

resumeSendTransportAudio

open val resumeSendTransportAudio: suspend (ResumeSendTransportAudioOptions) -> Unit

resumeSendTransportVideo

abstract override val resumeSendTransportVideo: suspend (ResumeSendTransportVideoOptions) -> Unit

abstract override val roomName: String

routerRtpCapabilities

abstract val routerRtpCapabilities: RtpCapabilities?

rtpCapabilities

abstract val rtpCapabilities: RtpCapabilities?

screenForceFullDisplay

abstract val screenForceFullDisplay: Boolean

abstract val screenId: String?

abstract val screenParams: ProducerOptionsType?

abstract val screenProducer: WebRtcProducer?

screenshareSetting

abstract val screenshareSetting: String

selectedBackground

open val selectedBackground: VirtualBackground?

abstract val shared: Boolean

shareScreenStarted

abstract val shareScreenStarted: Boolean

abstract override val showAlert: ShowAlert?

abstract override val socket: SocketManager?

streamSuccessVideo

abstract val streamSuccessVideo: StreamSuccessVideoType

transportCreated

abstract override var transportCreated: Boolean

transportCreatedAudio

abstract val transportCreatedAudio: Boolean

transportCreatedVideo

abstract val transportCreatedVideo: Boolean

updateAdminOnMainScreen

abstract val updateAdminOnMainScreen: (Boolean) -> Unit

abstract val updateAllowed: (Boolean) -> Unit

updateAudioAlreadyOn

abstract val updateAudioAlreadyOn: (Boolean) -> Unit

updateAudioLevel

abstract val updateAudioLevel: (Double) -> Unit

updateAudioParams

abstract val updateAudioParams: (ProducerOptionsType?) -> Unit

updateAudioProducer

abstract val updateAudioProducer: (WebRtcProducer?) -> Unit

updateDefAudioID

abstract val updateDefAudioID: (String) -> Unit

updateDefScreenID

abstract val updateDefScreenID: (String) -> Unit

updateDefVideoID

abstract val updateDefVideoID: (String) -> Unit

updateExtendedRtpCapabilities

abstract val updateExtendedRtpCapabilities: (OrtcUtils.ExtendedRtpCapabilities?) -> Unit?

updateLocalAudioProducer

abstract val updateLocalAudioProducer: (WebRtcProducer?) -> Unit?

updateLocalProducerTransport

abstract override val updateLocalProducerTransport: (WebRtcTransport?) -> Unit?

updateLocalScreenProducer

abstract val updateLocalScreenProducer: (WebRtcProducer?) -> Unit?

updateLocalStream

abstract override val updateLocalStream: (MediaStream?) -> Unit

updateLocalStreamAudio

abstract val updateLocalStreamAudio: (MediaStream?) -> Unit

updateLocalStreamScreen

abstract val updateLocalStreamScreen: (MediaStream?) -> Unit

updateLocalStreamVideo

abstract override val updateLocalStreamVideo: (MediaStream?) -> Unit

updateLocalTransportCreated

open val updateLocalTransportCreated: (Boolean) -> Unit

updateLocalVideoProducer

abstract val updateLocalVideoProducer: (WebRtcProducer?) -> Unit?

updateMainGridStream

abstract val updateMainGridStream: (List<MediaSfuUIComponent>) -> Unit

updateMainHeightWidth

abstract val updateMainHeightWidth: (Double) -> Unit

updateMainScreenFilled

abstract val updateMainScreenFilled: (Boolean) -> Unit

updateMainScreenPerson

abstract val updateMainScreenPerson: (String) -> Unit

updateMainWindow

abstract val updateMainWindow: Boolean

updateMicAction

abstract val updateMicAction: (Boolean) -> Unit

updateParticipants

abstract val updateParticipants: (List<Participant>) -> Unit

updateProducerTransport

abstract override val updateProducerTransport: (WebRtcTransport?) -> Unit

updateRequestIntervalSeconds

abstract val updateRequestIntervalSeconds: Int

updateScreenForceFullDisplay

abstract val updateScreenForceFullDisplay: (Boolean) -> Unit

updateScreenProducer

abstract val updateScreenProducer: (WebRtcProducer?) -> Unit

updateShowAlert

abstract val updateShowAlert: (ShowAlert?) -> Unit

updateTransportCreated

abstract override val updateTransportCreated: (Boolean) -> Unit

updateTransportCreatedAudio

abstract val updateTransportCreatedAudio: (Boolean) -> Unit

updateTransportCreatedVideo

abstract val updateTransportCreatedVideo: (Boolean) -> Unit

updateUpdateMainWindow

abstract override val updateUpdateMainWindow: (Boolean) -> Unit

updateUserDefaultAudioInputDevice

abstract val updateUserDefaultAudioInputDevice: (String) -> Unit

updateUserDefaultVideoInputDevice

abstract val updateUserDefaultVideoInputDevice: (String) -> Unit

updateVideoAction

abstract val updateVideoAction: (Boolean) -> Unit

updateVideoAlreadyOn

abstract override val updateVideoAlreadyOn: (Boolean) -> Unit

updateVideoParams

abstract val updateVideoParams: (ProducerOptionsType?) -> Unit

updateVideoProducer

abstract val updateVideoProducer: (WebRtcProducer?) -> Unit

updateVideoRequestState

abstract val updateVideoRequestState: (String) -> Unit

userDefaultAudioInputDevice

abstract val userDefaultAudioInputDevice: String

userDefaultVideoInputDevice

abstract override val userDefaultVideoInputDevice: String

abstract val vidCons: VidCons

abstract override val videoAction: Boolean

abstract override val videoAlreadyOn: Boolean

abstract val videoParams: ProducerOptionsType?

abstract val videoProducer: WebRtcProducer?

videoRequestState

abstract val videoRequestState: String?

videoRequestTime

abstract val videoRequestTime: Long?

abstract val videoSetting: String

abstract val virtualStream: Any?

abstract val vParams: ProducerOptionsType?

whiteboardEnded

abstract val whiteboardEnded: Boolean

whiteboardStarted

abstract val whiteboardStarted: Boolean

abstract val youAreCoHost: Boolean

Functions

getUpdatedAllParams

abstract override fun getUpdatedAllParams(): ClickVideoParameters

prepopulateUserMedia

abstract suspend fun prepopulateUserMedia(options: Map<String, Any>): Result<Unit>

updateLocalVideoProducer

abstract fun updateLocalVideoProducer(producer: WebRtcProducer?)

updateUpdateMainWindow

abstract fun updateUpdateMainWindow(update: Boolean)

updateVideoProducer

abstract fun updateVideoProducer(producer: WebRtcProducer?)