com.pexip.sdk.media.coroutines.Util.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk-media Show documentation
A set of classes and interfaces to help with establishing a media connection.
The newest version!
/*
 * Copyright 2022-2023 Pexip AS
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.pexip.sdk.media.coroutines

import com.pexip.sdk.media.AudioDevice
import com.pexip.sdk.media.AudioDeviceManager
import com.pexip.sdk.media.CameraVideoTrack
import com.pexip.sdk.media.LocalMediaTrack
import com.pexip.sdk.media.MediaConnection
import com.pexip.sdk.media.VideoTrack
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.channels.awaitClose
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.SharingStarted
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.callbackFlow
import kotlinx.coroutines.flow.stateIn
import kotlin.coroutines.resume
import kotlin.coroutines.resumeWithException
import kotlin.coroutines.suspendCoroutine

/**
 * Converts this [LocalMediaTrack] capturing state to a [Flow].
 *
 * @return a flow of changes to capturing state
 */
public fun LocalMediaTrack.getCapturing(): Flow = callbackFlow {
    val listener = LocalMediaTrack.CapturingListener(::trySend)
    registerCapturingListener(listener)
    awaitClose { unregisterCapturingListener(listener) }
}

/**
 * Converts this [LocalMediaTrack] capturing state to a [StateFlow].
 *
 * @return a state flow of changes to capturing state
 */
public fun LocalMediaTrack.capturingIn(
    scope: CoroutineScope,
    started: SharingStarted,
): StateFlow = getCapturing().stateIn(scope, started, capturing)

/**
 * Attempts to switch a camera to the specified one or to the opposite one.
 *
 * @param deviceName a name of the camera to switch to, null to switch to opposite camera
 * @return true if the switched camera is front-facing, false otherwise
 * @throws SwitchCameraException if the operation failed
 */
public suspend fun CameraVideoTrack.switchCamera(deviceName: String? = null): String =
    suspendCoroutine {
        val callback = object : CameraVideoTrack.SwitchCameraCallback {

            override fun onSuccess(deviceName: String) {
                it.resume(deviceName)
            }

            override fun onFailure(error: String) {
                it.resumeWithException(SwitchCameraException(error))
            }
        }
        when (deviceName) {
            null -> switchCamera(callback)
            else -> switchCamera(deviceName, callback)
        }
    }

/**
 * Converts this [MediaConnection] to a main remote video track [Flow].
 *
 * @return a flow of main remote video track changes
 */
public fun MediaConnection.getMainRemoteVideoTrack(): Flow = callbackFlow {
    val listener = MediaConnection.RemoteVideoTrackListener(::trySend)
    registerMainRemoteVideoTrackListener(listener)
    awaitClose { unregisterMainRemoteVideoTrackListener(listener) }
}

/**
 * Converts this [MediaConnection] to a main remote video track [StateFlow].
 *
 * @return a state flow of main remote video track
 */
public fun MediaConnection.mainRemoteVideoTrackIn(
    scope: CoroutineScope,
    started: SharingStarted,
): StateFlow = getMainRemoteVideoTrack().stateIn(scope, started, mainRemoteVideoTrack)

/**
 * Converts this [MediaConnection] to a presentation remote video track [Flow].
 *
 * @return a flow of presentation remote video track changes
 */
public fun MediaConnection.getPresentationRemoteVideoTrack(): Flow = callbackFlow {
    val listener = MediaConnection.RemoteVideoTrackListener(::trySend)
    registerPresentationRemoteVideoTrackListener(listener)
    awaitClose { unregisterPresentationRemoteVideoTrackListener(listener) }
}

/**
 * Converts this [MediaConnection] to a presentation remote video track [StateFlow].
 *
 * @return a flow of presentation remote video track
 */
public fun MediaConnection.presentationRemoteVideoTrackIn(
    scope: CoroutineScope,
    started: SharingStarted,
): StateFlow =
    getPresentationRemoteVideoTrack().stateIn(scope, started, presentationRemoteVideoTrack)

/**
 * Converts this [AudioDeviceManager] to available audio devices [Flow].
 *
 * @return a flow of available audio devices changes
 */
public fun AudioDeviceManager.getAvailableAudioDevices(): Flow> = callbackFlow {
    val listener = AudioDeviceManager.OnAvailableAudioDevicesChangedListener(::trySend)
    registerOnAvailableAudioDevicesChangedListener(listener)
    awaitClose { unregisterOnAvailableAudioDevicesChangedListener(listener) }
}

/**
 * Converts this [AudioDeviceManager] to available audio devices [StateFlow].
 *
 * @param scope the coroutine scope in which sharing is started
 * @param started the strategy that controls when sharing is started and stopped
 * @return a state flow of available audio devices
 */
public fun AudioDeviceManager.availableAudioDevicesIn(
    scope: CoroutineScope,
    started: SharingStarted,
): StateFlow> =
    getAvailableAudioDevices().stateIn(scope, started, availableAudioDevices)

/**
 * Converts this [AudioDeviceManager] to selected audio device [Flow].
 *
 * @return a flow of selected audio device changes
 */
public fun AudioDeviceManager.getSelectedAudioDevice(): Flow = callbackFlow {
    val listener = AudioDeviceManager.OnSelectedAudioDeviceChangedListener(::trySend)
    registerOnSelectedAudioDeviceChanged(listener)
    awaitClose { unregisterOnSelectedAudioDeviceChanged(listener) }
}

/**
 * Converts this [AudioDeviceManager] to selected audio device [StateFlow].
 *
 * @param scope the coroutine scope in which sharing is started
 * @param started the strategy that controls when sharing is started and stopped
 * @return a state flow of selected audio device
 */
public fun AudioDeviceManager.selectedAudioDeviceIn(
    scope: CoroutineScope,
    started: SharingStarted,
): StateFlow = getSelectedAudioDevice().stateIn(scope, started, selectedAudioDevice)