shared

shared/com.mediasfu.sdk.methods.recording_methods/StartRecordingParameters

StartRecordingParameters

interface StartRecordingParameters : CaptureCanvasStreamParameters, RePortParameters, RecordStartTimerParameters, RecordResumeTimerParameters

Parameters required for starting the recording.

Properties

abstract val activeNames: List<String>

adminOnMainScreen

abstract val adminOnMainScreen: Boolean

allVideoStreams

abstract val allVideoStreams: List<Stream>

annotateScreenStream

abstract val annotateScreenStream: Boolean

abstract override val audioAlreadyOn: Boolean

abstract val audioDecibels: List<AudioDecibels>

abstract val canPauseResume: Boolean

abstract val canRecord: Boolean

abstract val canvasStream: MediaStream?

compareActiveNames

abstract val compareActiveNames: suspend (CompareActiveNamesOptions) -> Unit

compareScreenStates

abstract val compareScreenStates: suspend (CompareScreenStatesOptions) -> Unit

confirmedToRecord

abstract val confirmedToRecord: Boolean

connectSendTransportScreen

open val connectSendTransportScreen: suspend (ConnectSendTransportScreenOptions) -> Unit

createSendTransport

open val createSendTransport: suspend (CreateSendTransportOptions) -> Unit

abstract val defScreenID: String

abstract val device: WebRtcDevice?

abstract val endReport: Boolean

abstract val eventType: Any?

extendedRtpCapabilities

abstract val extendedRtpCapabilities: OrtcUtils.ExtendedRtpCapabilities?

forceFullDisplay

abstract val forceFullDisplay: Boolean

abstract val islevel: String

abstract val isTimerRunning: Boolean

abstract val isWideScreen: Boolean

abstract val keepBackground: Boolean

abstract val lastUpdate: Int?

localProducerTransport

abstract var localProducerTransport: WebRtcTransport?

localScreenProducer

abstract val localScreenProducer: WebRtcProducer?

abstract override val localSocket: SocketManager?

abstract val localStream: MediaStream?

localStreamScreen

abstract val localStreamScreen: MediaStream?

localStreamVideo

abstract val localStreamVideo: MediaStream?

localTransportCreated

abstract var localTransportCreated: Boolean

abstract val localUIMode: Boolean

mainHeightWidth

abstract val mainHeightWidth: Double

mainScreenFilled

abstract val mainScreenFilled: Boolean

mainScreenPerson

abstract val mainScreenPerson: String

abstract val member: String

abstract val nForReadjust: Int?

abstract val oldAllStreams: List<Stream>

abstract val params: ProducerOptionsType?

abstract val participants: List<Any>

prevActiveNames

abstract val prevActiveNames: List<String>

prevScreenStates

abstract override val prevScreenStates: List<ScreenState>

producerTransport

abstract var producerTransport: WebRtcTransport?

recordChangeSeconds

abstract val recordChangeSeconds: Int

recordElapsedTime

abstract val recordElapsedTime: Int

recordingDisplayType

abstract val recordingDisplayType: String

recordingMediaOptions

abstract val recordingMediaOptions: String

recordingVideoOptimized

abstract val recordingVideoOptimized: Boolean

abstract override val recordPaused: Boolean

abstract override val recordResumed: Boolean

recordResumeTimer

abstract val recordResumeTimer: RecordResumeTimerType

abstract override val recordStarted: Boolean

recordStartTime

abstract val recordStartTime: Long?

recordStartTimer

abstract val recordStartTimer: RecordStartTimerType

abstract override val recordStopped: Boolean

abstract val recordTimerJob: Job?

recordUpdateTimer

abstract val recordUpdateTimer: RecordUpdateTimerType

remoteScreenStream

abstract val remoteScreenStream: List<Stream>

abstract val rePort: RePortType

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?

abstract override val screenStates: List<Any>

abstract val shapes: List<WhiteboardShape>

abstract val shared: Boolean

shareScreenStarted

abstract val shareScreenStarted: Boolean

abstract override val showAlert: ShowAlert?

abstract override val socket: SocketManager?

abstract val startReport: Boolean

transportCreated

abstract var transportCreated: Boolean

abstract val trigger: suspend (TriggerOptions) -> Unit

updateAdminOnMainScreen

abstract val updateAdminOnMainScreen: (Boolean) -> Unit

updateCanPauseResume

abstract val updateCanPauseResume: (Boolean) -> Unit

updateCanRecord

abstract val updateCanRecord: UpdateBooleanState

updateCanvasStream

abstract val updateCanvasStream: (MediaStream?) -> Unit

updateClearedToRecord

abstract val updateClearedToRecord: UpdateBooleanState

updateDateState

abstract val updateDateState: Int?

updateDefScreenID

abstract val updateDefScreenID: (String) -> Unit

updateEndReport

abstract val updateEndReport: UpdateBooleanState

updateExtendedRtpCapabilities

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

updateIsRecordingModalVisible

abstract val updateIsRecordingModalVisible: UpdateBooleanState

updateIsTimerRunning

abstract val updateIsTimerRunning: (Boolean) -> Unit

updateLocalProducerTransport

open val updateLocalProducerTransport: (WebRtcTransport?) -> Unit?

updateLocalScreenProducer

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

updateLocalStream

abstract val updateLocalStream: (MediaStream?) -> Unit

updateLocalStreamScreen

abstract val updateLocalStreamScreen: (MediaStream?) -> Unit

updateLocalTransportCreated

open val updateLocalTransportCreated: (Boolean) -> 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

updatePrevActiveNames

abstract val updatePrevActiveNames: (List<String>) -> Unit

updatePrevScreenStates

abstract val updatePrevScreenStates: (List<ScreenState>) -> Unit

updateProducerTransport

open val updateProducerTransport: (WebRtcTransport?) -> Unit

updateRecordElapsedTime

abstract val updateRecordElapsedTime: (Int) -> Unit

updateRecordingProgressTime

abstract override val updateRecordingProgressTime: (String) -> Unit

updateRecordPaused

abstract val updateRecordPaused: UpdateBooleanState

updateRecordResumed

abstract val updateRecordResumed: UpdateBooleanState

updateRecordStarted

abstract val updateRecordStarted: UpdateBooleanState

updateRecordStartTime

abstract val updateRecordStartTime: (Long?) -> Unit

updateRecordTimerJob

abstract val updateRecordTimerJob: (Job?) -> Unit

updateScreenForceFullDisplay

abstract val updateScreenForceFullDisplay: (Boolean) -> Unit

updateScreenProducer

abstract val updateScreenProducer: (WebRtcProducer?) -> Unit

updateScreenStates

abstract val updateScreenStates: (List<ScreenState>) -> Unit

updateShowAlert

abstract val updateShowAlert: (ShowAlert?) -> Unit

updateStartReport

abstract val updateStartReport: UpdateBooleanState

updateTransportCreated

open val updateTransportCreated: (Boolean) -> Unit

updateUpdateMainWindow

abstract val updateUpdateMainWindow: (Boolean) -> Unit

useImageBackground

abstract val useImageBackground: Boolean

userRecordingParams

abstract val userRecordingParams: UserRecordingParams

abstract override val videoAlreadyOn: Boolean

abstract val virtualStream: Any?

abstract val webRtcDevice: WebRtcDevice?

whiteboardEnded

abstract override val whiteboardEnded: Boolean

whiteboardStarted

abstract override val whiteboardStarted: Boolean

Functions

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

getUpdatedAllParams

abstract override fun getUpdatedAllParams(): StartRecordingParameters

Method to retrieve updated parameters.

updateLastUpdate

abstract fun updateLastUpdate(lastUpdate: Int?)

updateNForReadjust

abstract fun updateNForReadjust(nForReadjust: Int)

updateUpdateDateState

abstract fun updateUpdateDateState(timestamp: Int?)