streampack-core/io.github.thibaultbee.streampack.core.streamers.single

Package-level declarations

Types

typealias AudioConfig = AudioCodecConfig

The single streamer audio configuration.

class AudioOnlySingleStreamer(context: Context, audioInputMode: StreamerPipeline.AudioInputMode = CALLBACK, endpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), dispatcherProvider: IDispatcherProvider = DispatcherProvider()) : ISingleStreamer, IAudioSingleStreamer

A ISingleStreamer implementation for audio only (without video).

IAudioSingleStreamer

interface IAudioSingleStreamer : IAudioStreamer<AudioConfig> , ISingleStreamer

An audio single Streamer

ISingleStreamer

interface ISingleStreamer : IOpenableStreamer

A single Streamer that is agnostic to the underlying implementation (either with coroutines or callbacks).

IVideoSingleStreamer

interface IVideoSingleStreamer : IVideoStreamer<VideoConfig> , ISingleStreamer

A video single streamer.

SingleStreamer

class SingleStreamer(context: Context, audioInputMode: StreamerPipeline.AudioInputMode = StreamerPipeline.AudioInputMode.CALLBACK, endpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), defaultRotation: Int = context.displayRotation, surfaceProcessorFactory: ISurfaceProcessorInternal.Factory = DefaultSurfaceProcessorFactory(), dispatcherProvider: IDispatcherProvider = DispatcherProvider()) : ISingleStreamer, IAudioSingleStreamer, IVideoSingleStreamer

A ISingleStreamer implementation for both audio and video.

VideoConfig

typealias VideoConfig = VideoCodecConfig

The single streamer video configuration.

VideoOnlySingleStreamer

class VideoOnlySingleStreamer(context: Context, endpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), defaultRotation: Int = context.displayRotation, surfaceProcessorFactory: ISurfaceProcessorInternal.Factory = DefaultSurfaceProcessorFactory(), dispatcherProvider: IDispatcherProvider = DispatcherProvider()) : ISingleStreamer, IVideoSingleStreamer

A ISingleStreamer implementation for video only (without audio).

Properties

withAudio

val ISingleStreamer.withAudio: Boolean

withVideo

val ISingleStreamer.withVideo: Boolean

Functions

AudioOnlySingleStreamer

suspend fun AudioOnlySingleStreamer(context: Context, audioSourceFactory: IAudioSourceInternal.Factory = MicrophoneSourceFactory(), audioInputMode: StreamerPipeline.AudioInputMode = CALLBACK, endpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), dispatcherProvider: IDispatcherProvider = DispatcherProvider()): AudioOnlySingleStreamer

Creates a AudioOnlySingleStreamer with a default audio source.

audioVideoMediaProjectionSingleStreamer

@RequiresApi(value = 29)

suspend fun audioVideoMediaProjectionSingleStreamer(context: Context, mediaProjection: MediaProjection, audioInputMode: StreamerPipeline.AudioInputMode = StreamerPipeline.AudioInputMode.CALLBACK, endpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), defaultRotation: Int = context.displayRotation, surfaceProcessorFactory: ISurfaceProcessorInternal.Factory = DefaultSurfaceProcessorFactory(), dispatcherProvider: IDispatcherProvider = DispatcherProvider()): SingleStreamer

Creates a SingleStreamer with the screen as video source and audio playback as audio source.

cameraSingleStreamer

@RequiresPermission(value = "android.permission.CAMERA")

suspend fun cameraSingleStreamer(context: Context, cameraId: String = context.defaultCameraId, audioSourceFactory: IAudioSourceInternal.Factory? = MicrophoneSourceFactory(), audioInputMode: StreamerPipeline.AudioInputMode = StreamerPipeline.AudioInputMode.CALLBACK, endpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), defaultRotation: Int = context.displayRotation, surfaceProcessorFactory: ISurfaceProcessorInternal.Factory = DefaultSurfaceProcessorFactory(), dispatcherProvider: IDispatcherProvider = DispatcherProvider()): SingleStreamer

Creates a SingleStreamer with the camera as video source and an audio source (by default, the microphone).

cameraVideoOnlySingleStreamer

@RequiresPermission(value = "android.permission.CAMERA")

suspend fun cameraVideoOnlySingleStreamer(context: Context, cameraId: String = context.defaultCameraId, endpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), defaultRotation: Int = context.displayRotation, surfaceProcessorFactory: ISurfaceProcessorInternal.Factory = DefaultSurfaceProcessorFactory(), dispatcherProvider: IDispatcherProvider = DispatcherProvider()): VideoOnlySingleStreamer

Creates a VideoOnlySingleStreamer with the camera as video source and no audio source.

setConfig

@RequiresPermission(value = "android.permission.RECORD_AUDIO")

suspend fun SingleStreamer.setConfig(audioConfig: AudioConfig, videoConfig: VideoConfig)

Configures both video and audio settings. It is the first method to call after a SingleStreamer instantiation. It must be call when both stream and audio and video capture are not running.

SingleStreamer

suspend fun SingleStreamer(context: Context, audioSourceFactory: IAudioSourceInternal.Factory, videoSourceFactory: IVideoSourceInternal.Factory, audioInputMode: StreamerPipeline.AudioInputMode = StreamerPipeline.AudioInputMode.CALLBACK, endpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), defaultRotation: Int = context.displayRotation, surfaceProcessorFactory: ISurfaceProcessorInternal.Factory = DefaultSurfaceProcessorFactory(), dispatcherProvider: IDispatcherProvider = DispatcherProvider()): SingleStreamer

Creates a SingleStreamer with an audio source and a video source.

videoMediaProjectionSingleStreamer

suspend fun videoMediaProjectionSingleStreamer(context: Context, mediaProjection: MediaProjection, audioSourceFactory: IAudioSourceInternal.Factory? = MicrophoneSourceFactory(), audioInputMode: StreamerPipeline.AudioInputMode = StreamerPipeline.AudioInputMode.CALLBACK, endpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), defaultRotation: Int = context.displayRotation, surfaceProcessorFactory: ISurfaceProcessorInternal.Factory = DefaultSurfaceProcessorFactory(), dispatcherProvider: IDispatcherProvider = DispatcherProvider()): SingleStreamer

Creates a SingleStreamer with the screen as video source and an audio source (by default, the microphone).

videoMediaProjectionVideoOnlySingleStreamer

suspend fun videoMediaProjectionVideoOnlySingleStreamer(context: Context, mediaProjection: MediaProjection, endpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), defaultRotation: Int = context.displayRotation, surfaceProcessorFactory: ISurfaceProcessorInternal.Factory = DefaultSurfaceProcessorFactory(), dispatcherProvider: IDispatcherProvider = DispatcherProvider()): VideoOnlySingleStreamer

Creates a VideoOnlySingleStreamer with the screen as video source and no audio source.

VideoOnlySingleStreamer

suspend fun VideoOnlySingleStreamer(context: Context, videoSourceFactory: IVideoSourceInternal.Factory, endpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), defaultRotation: Int = context.displayRotation, surfaceProcessorFactory: ISurfaceProcessorInternal.Factory = DefaultSurfaceProcessorFactory(), dispatcherProvider: IDispatcherProvider = DispatcherProvider()): VideoOnlySingleStreamer

Creates a VideoOnlySingleStreamer with a default video source.