shared/com.mediasfu.sdk.methods.recording_methods

Package-level declarations

Types

CaptureCanvasStreamOptions

typealias CaptureCanvasStreamOptions = com.mediasfu.sdk.methods.whiteboard_methods.CaptureCanvasStreamOptions

CaptureCanvasStreamParameters

typealias CaptureCanvasStreamParameters = com.mediasfu.sdk.methods.whiteboard_methods.CaptureCanvasStreamParameters

CaptureCanvasStreamType

typealias CaptureCanvasStreamType = com.mediasfu.sdk.methods.whiteboard_methods.CaptureCanvasStreamType

CheckPauseStateOptions

data class CheckPauseStateOptions(val recordingMediaOptions: String, val recordingVideoPausesLimit: Int, val recordingAudioPausesLimit: Int, val pauseRecordCount: Int, val showAlert: ShowAlert?)

Options for checking if recording can be paused.

CheckPauseStateType

typealias CheckPauseStateType = suspend (CheckPauseStateOptions) -> Boolean

CheckResumeStateOptions

data class CheckResumeStateOptions(val recordingMediaOptions: String, val recordingVideoPausesLimit: Int, val recordingAudioPausesLimit: Int, val pauseRecordCount: Int)

Options for checking if recording can be resumed.

CheckResumeStateType

typealias CheckResumeStateType = suspend (CheckResumeStateOptions) -> Boolean

ConfirmRecordingOptions

data class ConfirmRecordingOptions(val parameters: ConfirmRecordingParameters)

Class encapsulating options for confirming recording.

ConfirmRecordingParameters

interface ConfirmRecordingParameters

Class for recording parameters used in confirming recording settings.

ConfirmRecordingType

typealias ConfirmRecordingType = suspend (ConfirmRecordingOptions) -> Unit

Type alias for confirm recording function.

LaunchRecordingOptions

data class LaunchRecordingOptions(val updateIsRecordingModalVisible: UpdateIsRecordingModalVisible, val isRecordingModalVisible: Boolean, val showAlert: ShowAlert? = null, val stopLaunchRecord: Boolean, val canLaunchRecord: Boolean, val recordingAudioSupport: Boolean, val recordingVideoSupport: Boolean, val updateCanRecord: UpdateCanRecord, val updateClearedToRecord: UpdateClearedToRecord, val recordStarted: Boolean, val recordPaused: Boolean, val localUIMode: Boolean)

Options for launching a recording.

LaunchRecordingType

typealias LaunchRecordingType = (LaunchRecordingOptions) -> Unit

Type alias for the launch recording function.

RecordingUtils

object RecordingUtils

Utility helpers for recording lifecycle cleanup and state resets.

RecordPauseTimerOptions

data class RecordPauseTimerOptions(val stop: Boolean = false, val isTimerRunning: Boolean, val canPauseResume: Boolean, val showAlert: ShowAlert?)

Options for controlling the recording timer, allowing pause and resume actions.

RecordPauseTimerType

typealias RecordPauseTimerType = (RecordPauseTimerOptions) -> Boolean

Type alias for the recordPauseTimer function.

RecordResumeTimerOptions

data class RecordResumeTimerOptions(val parameters: RecordResumeTimerParameters)

RecordResumeTimerParameters

interface RecordResumeTimerParameters : PrepopulateUserMediaParameters

RecordResumeTimerType

typealias RecordResumeTimerType = suspend (RecordResumeTimerOptions) -> Boolean

RecordStartTimerOptions

data class RecordStartTimerOptions(val parameters: RecordStartTimerParameters)

RecordStartTimerParameters

interface RecordStartTimerParameters

RecordStartTimerType

typealias RecordStartTimerType = suspend (RecordStartTimerOptions) -> Unit

RecordUpdateTimerOptions

data class RecordUpdateTimerOptions(var recordElapsedTime: Int, val recordStartTime: Long, val updateRecordElapsedTime: UpdateRecordElapsedTime, val updateRecordingProgressTime: UpdateRecordingProgressTime)

Options for updating the recording timer.

RecordUpdateTimerType

typealias RecordUpdateTimerType = (RecordUpdateTimerOptions) -> Unit

StartRecordingOptions

data class StartRecordingOptions(val parameters: StartRecordingParameters)

Options for starting recording.

StartRecordingParameters

interface StartRecordingParameters : CaptureCanvasStreamParameters, RePortParameters, RecordStartTimerParameters, RecordResumeTimerParameters

Parameters required for starting the recording.

StartRecordingType

typealias StartRecordingType = suspend (StartRecordingOptions) -> Boolean?

Type definition for StartRecording function.

StopRecordingOptions

data class StopRecordingOptions(val parameters: StopRecordingParameters)

Options for stopping recording.

StopRecordingParameters

interface StopRecordingParameters

Parameters required to stop the recording.

StopRecordingType

typealias StopRecordingType = suspend (StopRecordingOptions) -> Unit

Type definition for StopRecording function.

UpdateBooleanState

typealias UpdateBooleanState = (Boolean) -> Unit

UpdateCanRecord

typealias UpdateCanRecord = (Boolean) -> Unit

UpdateClearedToRecord

typealias UpdateClearedToRecord = (Boolean) -> Unit

Type definitions for launch recording callbacks.

UpdateIsRecordingModalVisible

typealias UpdateIsRecordingModalVisible = (Boolean) -> Unit

UpdateRecordElapsedTime

typealias UpdateRecordElapsedTime = (Int) -> Unit

UpdateRecordingOptions

data class UpdateRecordingOptions(val parameters: UpdateRecordingParameters)

Options for the updateRecording function, containing recording parameters.

UpdateRecordingParameters

interface UpdateRecordingParameters : RePortParameters, RecordResumeTimerParameters

Parameters required for updating the recording state, implementing several interfaces for managing recording and timer state, and providing abstract getters for flexible and detailed recording configurations.

UpdateRecordingProgressTime

typealias UpdateRecordingProgressTime = (String) -> Unit

UpdateRecordingType

typealias UpdateRecordingType = suspend (UpdateRecordingOptions) -> Unit

Type definition for the update recording function.

Functions

checkPauseState

suspend fun checkPauseState(options: CheckPauseStateOptions): Boolean

checkResumeState

suspend fun checkResumeState(options: CheckResumeStateOptions): Boolean

confirmRecording

suspend fun confirmRecording(options: ConfirmRecordingOptions)

Confirms the recording based on the provided parameters.

launchRecording

fun launchRecording(options: LaunchRecordingOptions)

Launches the recording process based on various conditions and updates the UI accordingly.

recordPauseTimer

fun recordPauseTimer(options: RecordPauseTimerOptions): Boolean

Controls the recording timer by allowing pause and resume actions.

recordResumeTimer

suspend fun recordResumeTimer(options: RecordResumeTimerOptions): Boolean

recordStartTimer

suspend fun recordStartTimer(options: RecordStartTimerOptions)

recordUpdateTimer

fun recordUpdateTimer(options: RecordUpdateTimerOptions)

startRecording

suspend fun startRecording(options: StartRecordingOptions): Boolean?

Starts the recording process, managing different states and actions based on recording options.

startTimer

suspend fun RecordResumeTimerOptions.startTimer(): Boolean

stopRecording

suspend fun stopRecording(options: StopRecordingOptions)

Stops the recording process, managing different states and actions based on current recording status.

updateRecording

suspend fun updateRecording(options: UpdateRecordingOptions)

Updates the recording based on the given parameters, managing recording start, pause, and resume states, as well as providing alerts for required conditions.